Modbus POE ETH Relay (B)

From Waveshare Wiki
Jump to: navigation, search
Modbus POE ETH Relay (B)
Modbus POE ETH Relay (B).jpg

RS485
{{{name2}}}

{{{name3}}}

{{{name4}}}

{{{name5}}}

Overview

  • This product is an industrial 8-ch relay module controlled via Ethernet port, adopts Modbus RTU/Modbus TCP protocols, supports PoE power supply, also comes with an ABS rail-mount case. The Modbus POE ETH Relay is very easy to use. Due to its fast communication, stability, reliability, and safety, it is an ideal choice for industrial control equipments and/or applications with high communication requirements.

Electrical Safety Precautions

  • This product must be operated and used by professional electricians or technical personnel. During use, please ensure electrical safety and take measures to prevent leakage and insulation.
  • Before installing, maintaining, or replacing relay equipment, be sure to turn off the power and unplug the plug.
  • Do not attempt to disassemble relay equipment to avoid damaging the equipment or causing the risk of electric shock.
  • Please install and place the relay equipment product properly. Do not use it in damp, overheated, or flammable environments to avoid safety incidents caused by improper installation or use.

Parameters

Power Supply PoE Ethernet Port, DC 5.5*2.1 Power Port Or Power Supply Screw Terminal (7~36V)
Communication Interface PoE Ethernet Port, Support IEEE 802.3af Standard
Relay Channels 8 Channels
Touch Contact 1NO, 1NC
Touch Contact Load ≤10A 250V AC  Or  ≤10A 30V DC
Digital Input 8DI, 5~36V, Passive Input/Active Input (NPN or PNP)
Built-in Bidirectional Optocoupler
Modbus Protocol Modbus RTU Protocol Or Modbus TCP Protocol

Indicator Description

Indicator Description
RUN The network port operation indicator, when the network port is working normally, will output a square wave with a period of 2 seconds
STA MCU indicator, blinks when MCU is working normally
TXD Transmitting indicator, light on when transmitting data
RXD Receiving indicator, light on when receiving data
Network port green indicator Green indicator is on when TCP connection is established, used to determine if the module has established a communication link with the host computer software
Network port yellow indicator Data status indicator, blinking when transmitting data

Primary Functions

Supports reading digital input by sending Modbus RTU protocol commands, and can control relay output based on input.
Modbus-POE-ETH-Relay-B-details-3.jpg

Wiring Description

Modbus-POE-ETH-Relay-B-3.jpg
Connect the Modbus POE ETH Relay (B) to the LAN via a network cable and power it via the 7~36V power port or power it via POE.

  • DI1-DI8 is the 8-channel signal input terminal, and DGND is the ground signal. COM is the common terminal for the input signal, it can be NC(Not Connected), connected to the positive or negative of the power supply, directly powered from the power supply or connected to an independent power supply.
  • NC: dry contact passive input.
  • Connect to the power supply positive: low active, NPN wet contact active input, voltage: 5V-30V DC.
  • Connect to the power supply negative: high active, PNP wet contact active input.

Digital Input Wiring

2024-07-19 181714.png

Passive Dry Contact Wiring

  • Passive dry contact input:

Modbus RTU Relay (D) Dry01.png

Active Wet Contact Wiring

  • Active wet contact NPN input

Modbus RTU IO 8CH Wiring Diagram02.png

  • Active wet contact PNP input

Modbus RTU IO 8CH Wiring Diagram03.png

Software Installation

Vircom can be used for configuring device IP and other parameters, as well as creating virtual serial ports. If the virtual serial port functionality is not needed, you can simply download the installation-free version of the configuration software.

Driver installation requires decompression, double-click the software to install, if the virtual serial port in Vircom is not displayed, then reboot and check again.

Example

TCP Communication Test

Software Preparation

Host Computer Setting

After connecting to the Modbus POE ETH Relay, connect it to the network. Run the Vircom software, (The computer on which Vircom is installed must be on the same LAN as the module.).
The operation is shown below:

  • ① Click Device
  • ② Click Auto Search
  • ③ Software search recognizes Modbus POE ETH Relay devices connected to the LAN.
  • ④ Select the device, and then click Edit Device or directly double click the searched device.
  • ⑤ Set up the device parameters.
    • Click the "Local IP" button to identify the computer's IP address, change the "IP Address" to a static address, and note that the static IP address entered is not used by other devices and needs to be on the same LAN as the computer.
    • The operating mode is TCP server. The serial port setting defaults to 115200 and cannot be modified.
    • The "Convert Protocol" in the Advanced settings, the default setting is "None", that is, you select modbus rtu protocol. If you use Modbus_TCP protocol, you can select "modbus tcp protocol".
  • ⑥ After setting, click Modify Setting.
  • ⑦ Click Restart Dev. After restarting the module, the new setting takes effect.

As shown below:
Modbus-POE-ETH-Relay-Vircom-setting.jpg
The last step is to click "Modify Settings" to save the settings and take effect.

TCP Communication Test

  • Open the serial debugging assistant window, select TCPClient for the port number, modify the remote IP and port number according to the above Vircom settings, click the "Connect" button to connect to the TCP server, the green light of the network port will light up after successful connection.

Modbus-POE-ETH-Relay-TCP-Test-01.jpg

  • Clicking on multiple strings will open multiple string-sending windows, and clicking on the corresponding functions will send the corresponding commands.
  • Please refer to the development agreement for detailed Development Protocol.

Virtual Serial Port Testing

The SSCOM2 in the diagram communicates directly with the TCP and serial port server. In order to allow users to communicate with the serial port server using their existing serial port software, a virtual serial port needs to be added between the user program and the serial port server. As shown in the diagram, Vircom and the user program run on the same computer. Vircom virtualizes a COM port that corresponds to the serial port server. When the user program opens the COM communication, it can send data to the user's serial port device through the Vircom serial port server. The following steps demonstrate this operation:
Click on "Serial Port Management" on the Vircom main interface.

  • Click on "Add" and select to add COM2. Note that COM5 is a COM port that does not exist on the computer originally.
  • After that, go to the device management and double-click on the device that needs to be bound to COM2. As shown in the diagram, select COM2 from the "Virtual Serial Port" list in the top left corner. Then click on "Modify Settings" and then click on "Restart Device".

RS485 TO ETH (B) Manual 103.png

  • Return to the main Vircom interface. You can see that COM2 is already connected to the device with IP 192.168.1.200. At this point, you can use COM2 to communicate instead of SSCOM2.

RS485 TO ETH (B) Manual 104.png

  • Open it on your computer, open the corresponding port number, set the baud rate to 115200, click Multi-String to open the Multi-String Send window, and click the corresponding function to send the corresponding command.

Modbus-POE-ETH-Relay-VIRCOM-Test-01.jpg

MODBUS TCP Test

By default, data is transparently transmitted using the Modbus RTU protocol. If you need to implement Modbus TCP to RTU conversion, you need to select the conversion protocol as "Modbus TCP Protocol" in the device settings dialog, as shown in the diagram below. In this case, the device port automatically changes to 502. Users can connect their Modbus TCP tool to the IP of the serial port server on port 502, and the Modbus TCP commands they send will be converted to RTU commands and outputted through the serial port.

For example, if the server's Ethernet port receives a Modbus TCP command of 00 00 00 00 00 06 01 05 00 00 FF 00 (to turn on the first relay), the host controller will receive the Modbus RTU command of 01 05 00 00 FF 00 8C 3A.
RS485 TO ETH (B) Manual 050.png

  • Click on "More advanced options..." Select the Modbus gateway type as a non-storage Modbus gateway.
Note: The default Modbus gateway type is storage type, which will automatically send query commands several times, which may cause the master chip not to respond, and the query commands will not be affected. Therefore, you need to set it as Multi-host non-storage type.

Modbus-POE-ETH-Relay-Vircom-setting-non-storage.jpg

  • Open the Sscom software, click on the Import ini button in the Multiple String Sender column, and select the Modbus tcp.ini file to import.

If the error "A component named HEX0 already exists" is displayed, close the software and reopen it. Then close the software and reopen it, then re-import the file.
Modbus poe eth relay 6.png

  • After successful import, the following is displayed, click on the corresponding function to send the corresponding command.

Modbus poe eth relay 7.png

  • Please refer to the Modbus TCP protocol section later for more details on Modbus TCP conversion.

WEB Configuration

Using Vircom, you can search and configure device parameters in different network segments. For Web configuration, you must first ensure that the computer and the serial server are in the same IP segment, and you need to know the IP address of the serial server in advance. But web configuration can be done on any computer without Vircom.
1. Enter the IP address of the serial server in the browser, such as http://192.168.1.200
RS232 b Manual 0051.jpg
2. Enter password in "Password": There is no login password set by default in the factory, you can enter a password at will, and click the Login button to log in. After setting the password to log in, the settings at "Modify webpage login password" will take effect:
RS232 b Manual 00512.jpg
3. The serial server parameters can be modified on the web page that appears. For the relevant parameters, please refer to Table 4 for the meaning of the parameters.
4. After modifying the parameters, click the "Submit" button.
5. If the configuration web page files are overwritten during the configuration and downloading of MQTT and Jetson Modbus firmware, causing the configuration web page to be inaccessible, please follow these steps to re-download the web page files:

Web-config-tool.png

For more details, please refer to Ethernet Module User Manual

Demo Example

Raspberry Pi

Connect the Raspberry Pi and the ModBus POE ETHG Relay module to the same LAN.
Open the Raspberry Pi terminal and run the program by entering the following command. 

sudo apt-get install unzip
wget https://files.waveshare.com/upload/e/e0/Modbus_POE_ETH_Relay_Code.zip
unzip Modbus_POE_ETH_Relay_Code.zip
cd Modbus_POE_ETH_Relay_Code

#modbus rtu protocol
vi modbus_rtu.py  #Change the IP address and port number according to the actual situation
sudo python3 modbus_rtu.py

#modbus tcp protocol
vi modbus_tcp.py  #Change the IP address and port number according to the actual situation
sudo python3 modbus_tcp.py
Note: To run this demo, you need to modify the demo file to change the IP address and port number to the actual IP address and port number of the ModBus POE ETHG Relay.

Modbus RTU Development Protocol

Function Code

Function Code Description
01 Read Relay Status
02 Read Input Status
03 Read Register
05 Write Single Relay
06 Set Single Register
0F Write All Relays
10 Set Multiple Registers

Register Address Introduction

Address (HEX) Address Storage Contents Register Value Permission Modbus Function Code
0x0000
……
0x0007		 1~8 Channels relay address 0xFF00: relay on;
0x0000: relay off;
0x5500: relay flips;
 Read/Write 0x01,0x05,0x0F
0x00FF Operate All Relays 0xFF00: All relays on;
0x0000: All relays off;
0x5500: All relays flip		 Write 0x05
0x0100
……
0x0107		 1~8 Channels relay flip address 0xFF00: Relay flips
0x0000: All relays not change
Write 0x05,0x0F
0x01FF All relys fip 0xFF00: All relays flip
0x0000: All relays not change		 Write 0x05
0x0200
……
0x0207		 1~8 channels relay flash on Delay time: data*100ms
Value: 0x0007; Delay time: 7*100MS = 700MS		 Write 0x05
0x0400
……
0x0407		 1~8 channels relay flash off Delay time: data*100ms
Value: 0x0007; Delay time: 7*100MS = 700MS		 Write 0x05
1x0000
……
1x0007		 1~8 channels relay input address 0~8 input channel status Read 0x02
4x1000
……
4x1007		 1~8 channels relay control mode 0x0000~0x0002 Read/Write 0x03,0x06,0x10
4x4000 Device Address Directly store Modbus address
Device address: 0x0001		 Read 0x03
4x8000 Software Version Converting to decimal and shifting the decimal point two places to the left indicates the software version.
0x0064 = 100 = V1.00		 Read 0x03

Control Single Relay

Send code: 01 05 00 00 FF 00 8C 3A

Field Description Note
01 Device Address Fixed 0x01
05 05 Command Control Relays
00 00 Address The register address of the relay to be controlled: 0x0000 - 0x0008
FF 00 Command 0xFF00: Relay on
0x0000: Relay off
0x5500: Relay flip
8C 3A CRC16 CRC16 checksum of the first 6 bytes of data

Return code: 01 05 00 00 FF 00 8C 3A

Field Description Note
01 Device Address Fixed 0x01
05 05 Command Control Relays
00 00 Address The register address of the relay to be controlled: 0x0000-0x0008
FF 00 Command 0xFF00: Relay on
0x0000: Relay off
0x5500: Relay flips
8C 3A CRC16 CRC16 checksum of the first 6 bytes of data

Example 

[No.1 Adress Device]:

No.0 relay on: 01 05 00 00 FF 00 8C 3A
No.0 relay off: 01 05 00 00 00 00 CD CA
No.1 relay on: 01 05 00 01 FF 00 DD FA
No.1 relay off: 01 05 00 01 00 00 9C 0A
No.2 relay on: 01 05 00 02 FF 00 2D FA
No.2 relay off: 01 05 00 02 00 00 6C 0A
No.3 relay on: 01 05 00 03 FF 00 7C 3A
No.3 relay off: 01 05 00 03 00 00 3D CA
No.0 relay flips: 01 05 00 00 55 00 F2 9A
No.1 relay flips: 01 05 00 01 55 00 A3 5A
No.2 relay flips: 01 05 00 02 55 00 53 5A
No.3 relay flips: 01 05 00 03 55 00 02 9A

Control All Relays

Send: 01 05 00 FF FF 00 BC 0A

Field Description Note
01 Device Address Fixed 0x01
05 05 Command Control Relays
00 FF Address Fixed 0x00FF
FF 00 Command 0xFF00: Relay on;
0x0000: Relay off
0x5500: Relay flips
BC 0A CRC16 CRC16 checksum of the first 6 bytes of data

Receive: 01 05 00 FF FF 00 BC 0A

Field Description Note
01 Device Address Fixed 0x01
05 05 Command Control relays
00 FF Address Fixed 0x00FF
FF 00 Command 0xFF00: Relay on;
0x0000: Relay off;
0x5500: Relay flips
BC 0A CRC16 CRC16 checksum of the first 6 bytes of data

Example [No.1 Adress Device]:

All relays on: 01 05 00 FF FF 00 BC 0A
All relays off: 01 05 00 FF 00 00 FD FA
All relays flip: 01 05 00 FF 55 00 C2 AA

Read Relay Status

Send: 01 01 00 00 00 08 3D CC

Field Description Note
01 Device Address Fixed 0x01
01 01 Command Query relay status
00 00 Start Address Relay start address, 0x0000-0x0008
00 08 Relay Number Maximum number of relays cannot be exceeded
3D CC CRC16 CRC16 checksum of the first 6 bytes of data

Receive: 01 01 01 00 51 88

Field Description Note
01 Device Address Fixed 0x01
01 01 Command Query relay status
01 Bytes Numbers Returns all bytes of the status message.
00 Queried Status Returned Relay Status
Bit0: initial relay status;
Bit1: next relay status;
And so on, with zero free bits at the high end of the scale.
8C 35 CRC16 CRC16 checksum of the first 6 bytes of data

Example: 

[No.1 Adress Device]:

Send: 01 01 00 00 00 08 3D CC   //Query all relays
Receive: 01 01 01 00 51 88         //All relays off
Send: 01 01 00 02 00 01 5C 0A   //Query No.2 relay
Receive: 01 01 01 01 90 48         //No.1 relay on
Send: 01 01 00 01 00 03 2D CB   //Query No.1, 2, 3 relay status
Receive: 01 01 01 05 91 8B         //No.1, 3 relay on, No.2 relay off

Write Relay Status

Send: 01 0F 00 00 00 08 01 FF BE D5

Field Description Note
01 Device Address Fixed 0x01
0F 0F Command Write relay status
00 00 Relay Initial address Relay initial address: 0x0000-0x0008
00 08 Relay Numbers Write relay numbers
01 Bytes Numbers The status bytes numbers
FF Relay Status Bit0: initial relay status;
Bit1: Next relay status;
And so on, with zero free bits at the high end of the scale.
BE D5 CRC16 CRC16 checksum of the first 6 bytes of data

Receive: 01 0F 00 00 00 01 94 0B

Field Description Note
01 Device Address Fixed 0x01
0F 0F Command Control all registers
00 00 Address The initial address of relays
00 08 Relay Numbers Write relay numbers
54 0D CRC16 CRC16 checksum of the first 6 bytes of data

Example 

[No.1 Adress Device]:

All relays on: 01 0F 00 00 00 08 01 FF BE D5
All relays off: 01 0F 00 00 00 08 01 00 FE 95
0-1 on; 3-7 off: 01 0F 00 00 00 08 01 03 BE 94
No. 1,2,3 relay on: 01 0F 00 01 00 03 01 07 F3 55

Relay Flash ON/OFF

Send: 01 05 02 00 00 07 8D B0

Field Description Note
01 Device Address Fixed 0x01
05 05 Command Single control command
02 Command 02: Flash on; 04: Flash off
00 Relay Address Relay address to be controlled: 0x00~0x08
00 07 Intervals Delay time: data*100ms
Value: 0x0007, Delay time: 7*100MS = 700MS
8D B0 CRC16 CRC16 checksum of the first 6 bytes of data

Receive: 01 05 02 00 00 07 8D B0

Field Description Note
01 Device Address Fixed 0x01
05 05 Command Single control command
02 Command 02: Flash on; 04: Flash off
00 Relay Address Relay address to be controlled: 0x00~0x08
00 07 Intervals Delay time: data*100ms
Value: 0x0007, Delay time: 7*100MS = 700MS
8D B0 CRC16 CRC16 checksum of the first 6 bytes of data

Note: The maximum time interval of flashing ON/OFF: 0x7FFF

Example 

[No.1 Adress Device]: 

No.0 relay flash on: 01 05 02 00 00 07 8D B0  //700MS = 7*100MS = 700MS
No.1 relay flash on: 01 05 02 01 00 08 9C 74  //800MS
No.0 relay flash off: 01 05 04 00 00 05 0C F9  //500MS
No.1 relay flash off: 01 05 04 01 00 06 1D 38  //600MS

Read Input Status

Send: 01 02 00 00 00 08 79 CC

Field Description Note
01 Device Address Fixed 0x01
02 02 Command Read input status command
00 00 Input initial address Input initial address, 0x0000-0x0008
00 08 Register numbers Number of input channels to be read, not to exceed the maximum number of input channels
79 CC CRC16 CRC16 checksum of the first 6 bytes of data

Receive: 01 02 01 00 A1 88

Field Description Note
01 Device Address Fixed 0x01
02 02 Command Read input status
01 Bytes Numbers Returns all bytes of the status message
00 Queried Status Returned input status
Bit0: initial input channels status
Bit1: the status of the next channel
And so on, with zero free bits at the high end of the scale.
A1 88 CRC16 CRC16 checksum of the first 6 bytes of data

Example: 

[No.1 Adress Device]:

Send: 01 02 00 00 00 08 79 CC    //Query all input channels
Receive: 01 01 01 00 51 88          //Inputs are all untriggered
Send: 01 02 00 00 00 08 79 CC    //Query all input channels
Receive: 01 02 01 41 61 B8          //1, 7 channel input trigger, the rest of the channel is not triggered 
Send: 01 02 00 01 00 02 A8 0B    //Query 1,2,3 input channel
Receive: 01 02 01 05 61 8B          //1,2 channels input triggered, 2 channels not triggered

Read Relay Control Mode

Send: 01 03 10 00 00 08 40 CC

Field Description Note
01 Device Address Fixed 0x01
03 03 Command Read Holding Register
10 00 Register Initial Address 0x1000 - 0x1007 corresponds to 1~8 input channels
00 08 Register Numbers Read register numbers, up to 8 channels
40 CC CRC16 CRC16 checksum of the first 6 bytes of data

Receive: 01 03 10 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 E4 59

Field Description Note
01 Device Address Fixed 0x01
03 03 Command Read Holding Register
10 Bytes Numbers Returns all bytes of the status message
00 00
……
00 00
 Control Mode Indicates 1 - 8 relay control modes, 0x0000~0x0002 indicates three control modes
0x0000: Normal mode, directly control the relay with commands
0x0001: Linkage mode, Relay status is the same as the corresponding input channel status;
0x0002: Flip mode, input channel input a pulse corresponding to the relay state flip once
0x0002: Jump mode, the input channel level jumps once and the corresponding relay state flips once.
E4 59 CRC16 CRC16 checksum of the first 6 bytes of data

Example 

[No.1 Adress Device]: 

Read No.1-8 relay control mode: 01 03 10 00 00 08 40 CC 
Read No.1 relay control mode: 01 03 10 00 00 01 80 CA
Read No.2 relay control mode: 01 03 10 01 00 01 D1 0A
Read No.3-5号 relay control mode: 01 03 10 02 00 03 A0 CB

Set Single Realy Control Mode

Send: 01 06 10 00 00 01 4C CA

Field Description Note
01 Device Address Fixed 0x01
06 06 Command 写单个寄存器指令
10 00 寄存器起始地址 0x1000 - 0x1007对应1~8通道继电器控制模式
00 01 控制模式 表示1 - 8 继电器控制模式，0x0000~0x0002表示三种控制模式
0x0000：正常模式，继电器受指令直接控制；
0x0001：联动模式，继电器状态和对应输入通道状态一致；
0x0002：翻转模式，输入通道输入一个脉冲对应的继电器状态翻转一次
4C CA CRC16 前6字节数据的CRC16校验和

返回码： 01 06 10 00 00 01 4C CA

字段 含义 备注
01 设备地址 固定0x01
06 06指令 写单个寄存器指令
10 00 寄存器起始地址 0x1000 - 0x1007对应1~8通道继电器控制模式
00 01 控制模式 继电器控制模式，0x0000~0x0002表示三种控制模式
4C CA CRC16 前6字节数据的CRC16校验和

示例[1号地址设备]: 

设置1继电器为联动模式 : 01 06 10 00 00 01 4C CA
设置2继电器为翻转模式 : 01 06 10 01 00 02 5D 0B

设置多继电器控制模式

发送码：01 10 10 00 00 08 10 00 01 00 01 00 01 00 01 00 01 00 01 00 01 00 01 7C B1

字段 含义 备注
01 设备地址 固定0x01
10 写多寄存器指令
10 00 寄存器起始地址 0x1000 - 0x1007对应1~8通道继电器控制模式
00 08 寄存器数量 设置寄存器数量，最多8个通道
10 字节数量 设置输出字节数
00 01
……
00 01
 控制模式 表示1 - 8 继电器控制模式，0x0000~0x0003表示四种控制模式
0x0000：正常模式，继电器受指令直接控制；
0x0001：联动模式，继电器状态和对应输入通道状态一致；
0x0002：翻转模式，输入通道输入一个脉冲对应的继电器状态翻转一次
0x0003：跳变模式，输入通道输入状态改变一次对应的继电器状态翻转一次
7C B1 CRC16 前6字节数据的CRC16校验和

注意:除了联动模式外，其他模式都同时支持通过指令控制继电器。
返回码： 01 10 10 00 00 08 C5 0F

字段 含义 备注
01 设备地址 固定0x01
10 写多寄存器指令
10 00 寄存器起始地址 0x1000 - 0x1007对应1~8通道继电器控制模式
00 08 寄存器数量 设置寄存器数量，最多8个通道
C5 0F CRC16 前6字节数据的CRC16校验和

示例[1号地址设备]:

设置1-8通道继电器为联动模式: 01 10 10 00 00 08 10 00 01 00 01 00 01 00 01 00 01 00 01 00 01 00 01 7C B1
设置3-5通道继电器为翻转模式: 01 10 10 02 00 03 06 00 02 00 02 00 02 4A 4B

读取软件版本指令

发送码：01 03 80 00 00 01 AD CA

字段 含义 备注
01 设备地址 固定0x01
03 03指令 读保持寄存器
80 00 指令寄存器 0x8000为读取软件版本
00 01 字节数 固定0x0001
AD CA CRC16 前 6 字节数据的 CRC16 校验和

返回码：01 03 02 00 64 B9 AF

字段 含义 备注
01 设备地址 固定0x01
03 03指令 读保持寄存器
02 字节数 返回字节数
00 64 软件版本 转为十进制然后小数点左移两位即表示软件版本
0x0064 = 100 = V1.00
F0 B8 CRC16 前 6 字节数据的 CRC16 校验和

示例：

发送：01 03 80 00 00 01 AD CA
返回：01 03 02 00 C8 B9 D2       //0x00C8 = 200 =V2.00
Retrieved from "https://www.waveshare.com/w/index.php?title=Modbus_POE_ETH_Relay_(B)&oldid=88901"