Modbus POE ETH Relay 16CH

From Waveshare Wiki
Jump to: navigation, search

Overview

Modbus POE ETH Relay 16CH
Modbus RTU Relay 16CH

Dual Ethernet relay module
{{{name2}}}

{{{name3}}}

{{{name4}}}

{{{name5}}}

{{{name6}}}

  • This product is an industrial grade dual Ethernet ports controlled 16-ch relay module, adopts Modbus RTU/Modbus TCP protocols, supports PoE power supply, also comes with ABS housing design. This relay module 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 should be operated and used by professional electricians or technical personnel. During use, please ensure electrical safety and take protective measures such as anti-leakage and insulation.
  • Before installing, maintaining, or replacing relay equipment, make sure to turn off the power and unplug the device.
  • Do not attempt to dismantle relay equipment to avoid damaging the device or risking electric shock.
  • Please properly install and place the relay equipment. Avoid using it in damp, overly hot, or flammable environments to prevent safety accidents due to improper installation or use.

Specifications

Power Supply PoE network port, DC 5.5*2.1 power connector or terminal block (7~36V)
Communication Interface PoE network port, supports IEEE 802.3af standard
Relay Channels 16 Channels
Contact Form 1NO 1NC
Contact Load ≤10A 250V AC 或 ≤10A 30V DC
Modbus Protocol Modbus RTU protocol or Modbus TCP protocol

Indicator Light Description

Indicator Status description
RUN indicator Ethernet port running indicator, outputs a square wave with a period of 2 seconds when the Ethernet port working normally.
STA indicator MCU indicator, blinking when the MCU working normally.
TXD indicator Send indicator, lights up when sending data.
RXD indicator Receive indicator, lights up when receiving data.
Green light on left Ethernet port Lights up when port 1 connected to the Ethernet
Green light on right Ethernet port Lights up when port 2 connected to the Ethernet
Yellow light on left Ethernet port The yellow indicator will be on when TCP connection is established, which can be used to determine whether the module has established a communication link with the host software
Yellow light on right Ethernet port Data activity indicator, when data is transmitted through the Ethernet port, the yellow indicator changes its state, which can be used to determine if there is data transmission

Hardware Connection

800px-Modbus-POE-ETH-Relay-C-details-21.png

  • Connect the module to the LAN via a network cable, and supply power through 7~36V power port or the POE. Both Ethernet ports are functionally the same and can be used for network port communication and cascading.

Module Parameter Configuration

The module needs to set the module parameters before communication, such as IP address, serial port format, Modbus protocol, etc. There are two modes of setting parameters: Vircom software configuration and web configuration.
Vircom software configuration allows for setting more parameters, but requires software installation. Web configuration does not require installation, but you need to know the IP address first, and the configuration parameters are few. It is recommended to use Virom for configuration.
Note:
1. The configuration can be done in any way, and it is recommended to use Virom software for first test.
2. It is recommended to modify only the IP address for the first configuration, other parameters are not recommended to be modified. The serial port parameters must be the default parameters; modifying the serial port parameters will result in no communication.
3. The module supports both Modbus RTU and Modbus TCP protocols. In the Advanced Settings -> Transfer Protocol, you can choose “None”, which means the Modbus RTU protocol. It is not recommended to modify during the first configuration.
4. The selected Modbus TCP protocol must be configured using the Virom software and set to a non-storage Modbus gateway, otherwise the communication will not be normal.

Virom Software Mode Configuration

General Settings

Connect the module to the hardware and 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 as follows:

  • Click Device
  • Click Auto Search
  • The software searches for and identifies devices connected to the LAN
  • Select the device, and then click Edit Device or double-click the searched device directly
  • Set the working parameters of the device:
    • Click the "Local IP" button to identify the IP address of the computer, modify the "IP address" to a static assigned address, and note that the static IP address entered is not used by other devices, and it needs to be on the same LAN as the computer.
    • The working mode is TCP server. The serial port setting is 115200 by default and cannot be modified.
    • The "Transfer Protocol" in "Advanced Settings" defaults to "None", which means using the Modbus RTU protocol; if you select "Modbus TCP protocol", then use the Modbus TCP protocol for communication.
  • Once the settings are complete, click Modify Setting
  • Click Restart Dev, wait for the module to restart, and the new settings will take effect.

Note: It is recommended to modify only the IP address for the first configuration, and do not modify other parameters.
See the figure below for details:
Modbus-POE-ETH-Relay-Vircom-setting.jpg

Protocol Setting

Note: It is recommended to use the default Modbus RTU protocol for the first configuration and no modifications are needed.
Although the module transmits data through the network port, it supports two Modbus protocols: Modbus RTU and Modbus TCP. By default, data is transparently transmitted, i.e. using the Modbus RTU protocol.
The "Transfer Protocol" in the "Advanced Settings" can be set to Modbus TCP protocol. In this case, the Modbus RTU protocol of the main controller will be converted to the Modbus TCP protocol and transmitted through the network port.
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.
RS485 TO ETH (B) Manual 050.png

  • If set to Modbus TCP protocol, it also needs to be set to a non-storage Modbus network port. Click on "More Advanced Settings..." and 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 controller 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

Virtual Serial Port Setting

The module transmits data through a network port (TCP/UDP protocol). In order to enable users to communicate even with developed serial port software, a virtual serial port needs to be added. If not needed, this part can be skipped.
First, install the virtual serial driver Virtual serial port driver, and run Vircom and the user program 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 & Device Management" on the Vircom main interface, then click "Add" and select to add COM2 (Among them, COM2 is the newly emerging COM port on the computer).
1000px-Modbus poe eth relay 3.png

  • Then enter the device management and double-click 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 Setting" and then click on "Restart Device".

RS485 TO ETH (B) Manual 103.png

  • Return to the main interface of Vircom. It can be seen that COM2 has been connected to the device whose IP is 192.168.1.200. In this case, the virtual serial port COM2 can be used instead of the network port for communication.

RS485 TO ETH (B) Manual 104.png

WEB Configuration

Using Vircom, you can search for 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. (Different products have different web interfaces, which can be switched between Chinese and English)
1. Enter the IP address of the serial server in the browser, such as http://192.168.1.200 to open the following web page
Modbus-POE-ETH-Relay-16CH-web.png
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 Web Login Key" will take effect:
WEB配置页面.jpg
3. The serial server parameters can be modified on the web page that appears.
4. After modifying the parameters, click the "Submit" button.
Attention: The system has added webpage settings function by default when it leaves the factory. If the configuration interface page file is overwritten and the webpage cannot be opened, the webpage file needs to be downloaded again.
Please refer to RS485 TO ETH (B) Manual

Example Demonstration

The demo shows how the following two software operate.
SSCOM serial port debugging assistant is more convenient to operate, free of installation, and more convenient for complete display and analysis of instructions, but the disadvantage is that the data is not intuitive.
Modbus Poll software is directly operated on the register, and the data display is more convenient to observe, but the disadvantage is that the instruction is not displayed completely, so you need to be familiar with the Modbus register operation.
You can test using any method. It is recommended to use the SSCOM serial port debugging assistant software for the first test.

SSCOM Serial Port Debugging Assistant

  • 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, select ModbusCRC16 if you need to add the check. 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 b 2.png
Click Multi-Char to open the Send Multi-Char window, the default display is the Modbus RTU command, and there is no CRC check, select ModbusCRC16 if you need to add the check. Click on the function to send the corresponding command.

  • The default configuration is Modbus RTU command. If set to Modbus TCP command, the command needs to be changed. *Click on the Import ini button in the Send Multi-Char 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 re-import the file.
Modbus poe eth relay 6.png

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

Note: Modbus tcp does not require CRC checksum, select None for checksum.
Modbus poe eth relay 7.png

  • For detailed Modubs commands, please see the development protocol.

Modbus Poll Software

  • The serial port software is not convenient to observe the data, you can choose Modbus Poll software to read the data. Download and install the Modbus Poll software.
  • Open the software, select Setup->Read/Write Definition, select the actual device address for Slave ID, select 01 Read Coils function code for Function, and change Quantity to 16 channels. Click OK to confirm.

600px-Modbus-POE-ETH-Relay-16CH-1.png

  • Select Connection->Connect..., select Modbus RTU/ASCII Over TCP/IP for Connection, select RTU for Mode, and enter the correct IP address and port number. Click OK to connect.

Modbus-POE-ETH-Relay-6.jpg

  • After the connection is normal, you can check the current relay status. Select the corresponding channel, then double-click the status value to pop up the send page. Choose On or Off, then Click Send to control the relay opening and closing.

Modbus-RTU-Relay-C-2.png

Modbus RTU Development Protocol

Function Code Introduction

Function Code Description Note
01 Read coil status Read relay status
03 Read holding register Read the address and version
05 Write single coil Write single relay
06 Write single register Set the baud rate and address
0F Write multiple coils Write all relays

Register Address Introduction

Address (HEX) Address storage content Register value Permission Modbus Function Code
0x0000
……
0x000F
Channel 1~16 relay address 0xFF00: relay on
0x0000: relay off
0x5500: relay toggle
Read/Write 0x01, 0x05, 0x0F
0x00FF Control all relays 0xFF00: all relays on
0x0000: all relays off
0x5500: all relays toggle
Write 0x05
0x0100
……
0x010F
Channel 1~16 relay toggle 0xFF00: relay toggle
0x0000: relay unchanged
Write 0x05, 0x0F
0x01FF All relays toggle 0xFF00: all relays toggle
0x0000: all relays unchanged
Write 0x05
0x0200
……
0x020F
Channel 1~16 relay flash on Interval time: data*100ms
Value: 0x0007, Interval time: 7*100MS = 700MS
Write 0x05
0x0400
……
0x040F
Channel 1~16 relay flash off Interval time: data*100ms
Value: 0x0007, Interval time: 7*100MS = 700MS
Write 0x05
4x4000 Device Address Directly store Modbus address
Device address: 0x0001
Read 0x03
4x8000 Software Version Converting to decimal and then shifting the decimal point two places to the left will represent the software version
0x0064 = 100 = V1.00
Read 0x03

Modbus RTU Command Introduction

Control Single Relay

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

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
05 05 Command Relay control
00 00 Address The register address of the relay to be controlled, 0x0000-0x000F
FF 00 Command 0xFF00: relay on;
0x0000: relay off;
0x5500: relay toggle
8C 3A CRC16 The 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 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
05 05 Command Relay control
00 00 Address The register address of the relay to be controlled, 0x0000-0x000F
FF 00 Command 0xFF00: relay on;
0x0000: relay off;
0x5500: relay toggle
8C 3A CRC16 The CRC16 checksum of the first 6 bytes of data

For example: [Address 1 device]:

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

Control All Relays

Send code: 01 05 00 FF FF 00 BC 0A

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
05 05 Command Relay control
00 FF Address Fixed 0x00FF
FF 00 Command 0xFF00: relay on;
0x0000: relay off;
0x5500: relay toggle
BC 0A CRC16 The CRC16 checksum of the first 6 bytes of data

Return code: 01 05 00 FF FF 00 BC 0A

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
05 05 Command Relay control
00 FF Address Fixed 0x00FF
FF 00 Command 0xFF00: relay on;
0x0000: relay off;
0x5500: relay toggle
BC 0A CRC16 The CRC16 checksum of the first 6 bytes of data

For example: [Address 1 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 toggle: 01 05 00 FF 55 00 C2 AA

Read Relay Status

Send code: 01 01 00 00 00 10 3D C6

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
01 01 Command Query relay status
00 00 Relay Start Address The register address of the relay, 0x0000 - 0x000F
00 10 Relay Number The number of relays to be read, which must not exceed the maximum number of relays
3D C6 CRC16 The CRC16 checksum of the first 6 bytes of data

Receive code: 01 01 02 00 00 B9 FC

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
01 01 Command Query relay status
02 Byte Number The number of all bytes of the returned status information
00 00 Query status Received relay status
The relay state is in small-endian format, with low bytes first and high bytes last
Bit0: the first relay status;
Bit1: the second relay status;
And so on, with the idle high bit being zero
B9 FC CRC16 The CRC16 checksum of the first 6 bytes of data

For example: [Address 1 device]

Send: 01 01 00 00 00 10 3D C6       //Query all relays
Receive: 01 01 02 00 00 B9 FC       //All relays off
Send: 01 01 00 01 00 03 2D CB       //Query relays 1, 2, 3 status
Receive: 01 01 01 05 91 8B          //Relays 1 and 3 are on, relay 2 is off
Send: 01 01 00 04 00 0C 7D CE       //Query relays 4-15
Receive: 01 01 02 0F 00 BC 0C       //Relays 4-7 are on, relays 8-15 are off

Write Relay Status

Send code: 01 0F 00 00 00 10 02 FF FF E3 90

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
0F 0F Command Write relay status
00 00 Relay Start Address The register address of the relay to be controlled, 0x0000 - 0x000F
00 10 Relay Number The number of relays to be operated, which must not exceed the maximum number of relays
02 Byte Number The byte number of the status
FF FF Relay status The relay state is in small-endian format, with low bytes first and high bytes last
Bit0: the first relay status;
Bit1: the second relay status;
And so on, with the idle high bit being zero
E3 90 CRC16 The CRC16 checksum of the first 6 bytes of data

Receive code: 01 0F 00 00 00 10 54 07

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
0F 0F Command Control all registers
00 00 Relay Start Address The register address of the relay to be controlled, 0x0000 - 0x0008
00 10 Relay Number The number of relays to be operated
54 07 CRC16 The CRC16 checksum of the first 6 bytes of data

For example: [Address 1 device]

All relays on: 01 0F 00 00 00 10 02 FF FF E3 90
All relays off: 01 0F 00 00 00 10 02 00 00 E2 20
0-1 on; 3-15 off: 01 0F 00 00 00 10 02 03 00 E2 D0

Relay Flash ON/OFF Command

Send code: 01 05 02 00 00 07 8D B0

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
05 05 Command Single control command
02 Flash on flash off 02: flash on, 04: flash off
00 Relay Address The address of the relay to be controlled, 0x00~0x0F
00 07 Interval Time The interval time: data*100ms
Value: 0x0007, Interval time: 7*100MS = 700MS
The maximum setting for the flash-on flash-off time is 0x7FFF
8D B0 CRC16 The CRC16 checksum of the first 6 bytes of data

Receive code: 01 05 02 00 00 07 8D B0

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
05 05 Command Single control command
02 Flash on flash off 02: flash on, 04: flash off
00 Relay Address The address of the relay to be controlled, 0x00~0x0F
00 07 Interval Time The interval time: data*100ms
Value: 0x0007, Interval time: 7*100MS = 700MS
The maximum setting for the flash-on flash-off time is 0x7FFF
8D B0 CRC16 The CRC16 checksum of the first 6 bytes of data

For example: [Address 1 device]

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

Read Software Version Command

Send code: 01 03 80 00 00 01 AD CA

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
03 03 Command Read the software version and device address
80 00 Software version register 0x4000: read the device address, 0x8000: read software version
00 01 Byte Number Fixed 0x0001
AD CA CRC16 The CRC16 checksum of the first 6 bytes of data

Receive code: 01 03 02 01 2C B8 09

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
03 03 Command Read the software version and device address
02 Byte Number The number of bytes returned
01 2C Software Version Converting to decimal and then shifting the decimal point two places to the left will represent the software version


0x012C = 300 = V3.00

B8 09 CRC16 The CRC16 checksum of the first 6 bytes of data

For example:

Send: 01 03 80 00 00 01 AD CA
Receive: 01 03 02 01 2C B8 09       //0x012C = 300 =V3.00

Exception Function Code

When the received command is incorrect or the device is abnormal, an exception response will be returned in the following format:

Receive: 01 85 03 02 91

Field Description Note
01 Device Address 0x00 indicates the broadcast address, 0x01-0xFF indicates the device address
85 Exception Function Code Exception function code = Request function code + 0x80
03 Byte Number Exception Code
02 91 CRC16 The CRC16 checksum of the first 6 bytes of data

An exception code is a single-byte value that indicates the type of error. Several commonly used exception codes defined by the Modbus protocol:

Exception Code Name Description
0x01 Illegal Function The requested function code is not supported
0x02 Illegal Data Address The requested data address is incorrect
0x03 Illegal Data Value The requested data value or operation cannot be executed
0x04 Server Failure Server equipment failure
0x05 Response The request has been received and is being processed
0x06 Device Busy The device is currently busy and cannot perform the requested operation

Modbus TCP Development Protocol

Here is a brief introduction to Modbus TCP and Modbus RTU protocol conversion using the above commands to open the first relay as an example.

  • Modbus RTU command: 01 05 00 00 FF 00 8C 3A
Field Description Note
01 Device Address Fixed 0x01
05 05 Command Relay control
00 00 Address The register address of the relay to be controlled, 0x00, that is, the first relay
FF 00 Command 0xFF00: Relay on
8C 3A CRC16 The CRC16 checksum of the first 6 bytes of data
  • Modbus TCP command: 00 00 00 00 00 06 01 05 00 00 FF 00
Field Description Note
00 00 Message Label Both be 0x00
00 00 modbus Label Must both be 0, which means this is Modbus communication
00 06 Byte Length Indicates the number of all bytes that follow, followed by 6 bytes
01 Device Address Fixed 0x01
05 05 Command Relay control
00 00 Address The register address of the relay to be controlled, 0x00, that is, the first relay
FF 00 Command 0xFF00: Relay on

By comparing the commands above, we can observe that to convert a Modbus RTU command to Modbus TCP protocol, the CRC check is removed, and the command is prefixed with five 0x00 bytes followed by a byte representing the length.

Advanced Applications - MQTT Connected Cloud Platform

Resources

Demo

Softwares

Related Resources

FAQ

 Answer:
  • To restore the setting parameters of the network port, you need to disassemble the shell, use tweezers to short the pad under the DEF silk screen for more than 5s, and the module will be reset to the IP of 192.168.1.254.
    Modbus-POE-ETH-Relay-Reload.jpg


 Answer:

Operating temperature: -15℃ ~ 70℃

{{{5}}}


Support




Technical Support

If you need technical support or have any feedback/review, please click the Submit Now button to submit a ticket, Our support team will check and reply to you within 1 to 2 working days. Please be patient as we make every effort to help you to resolve the issue.
Working Time: 9 AM - 6 PM GMT+8 (Monday to Friday)