Difference between revisions of "Modbus TCP"
From Zenitel Wiki
Lennert.werf (talk | contribs) |
Lennert.werf (talk | contribs) |
||
| Line 58: | Line 58: | ||
** The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0 | ** The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0 | ||
** The next two bytes are the value being written to this register: \x02 (Value 2 sets bit #1 and resets all the rest) | ** The next two bytes are the value being written to this register: \x02 (Value 2 sets bit #1 and resets all the rest) | ||
| + | |||
| + | ===Example: Station in conversation=== | ||
| + | Program an event: | ||
| + | * Owner Type: Station with UDP 8 | ||
| + | * Event Type: 44 - Conversation | ||
| + | * When Change To: ON | ||
| + | * Action string: EDO 1 "\0\x01\0\0\0\x06\x02\x06%dfmt(%op(%1.phy,+,50000),X,4)\0\x04" | ||
| + | In this specific case the meaning of the bytes is: | ||
| + | * \0\x01 - Transaction Identifier; 2 bytes | ||
| + | * \0\0 - Protocol Identifier; 2 bytes; always '0' for Modbus TCP | ||
| + | * \0\x06 - Length Field; 2 bytes; Number of remaining bytes in this frame | ||
| + | * \x02 - Unit Identifier; 1 byte; Slave Address (255 if not used) | ||
| + | * \x06 - Function code; 1 byte; Function codes as in other variants - 6: Write single register | ||
| + | * %dfmt(%op(%1.dir,+,50000),X,4)\0\x04 - Data bytes; the data used for the function code - For this specific function code this is 4 bytes, 2 bytes to address the register and 2 bytes for the data to be written. | ||
| + | ** The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0 | ||
| + | ** The next two bytes are the value being written to this register: \x04 (Value 4 sets bit #2 and resets all the rest) | ||
| + | |||
| + | ===Example: Station ends conversation=== | ||
| + | Program an event: | ||
| + | * Owner Type: Station with UDP 8 | ||
| + | * Event Type: 44 - Conversation | ||
| + | * When Change To: OFF | ||
| + | * Action string: EDO 1 "\0\x01\0\0\0\x06\x02\x06%dfmt(%op(%1.phy,+,50000),X,4)\0\x01" | ||
| + | In this specific case the meaning of the bytes is: | ||
| + | * \0\x01 - Transaction Identifier; 2 bytes | ||
| + | * \0\0 - Protocol Identifier; 2 bytes; always '0' for Modbus TCP | ||
| + | * \0\x06 - Length Field; 2 bytes; Number of remaining bytes in this frame | ||
| + | * \x02 - Unit Identifier; 1 byte; Slave Address (255 if not used) | ||
| + | * \x06 - Function code; 1 byte; Function codes as in other variants - 6: Write single register | ||
| + | * %dfmt(%op(%1.dir,+,50000),X,4)\0\x01 - Data bytes; the data used for the function code - For this specific function code this is 4 bytes, 2 bytes to address the register and 2 bytes for the data to be written. | ||
| + | ** The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0 | ||
| + | ** The next two bytes are the value being written to this register: \x01 (Value 1 sets bit #0 and resets all the rest) | ||
| + | |||
Notes: | Notes: | ||
\x is the [[Character escape codes|escape code]] to indicate that the following value is hexadecimal; 0 should be send as \0 | \x is the [[Character escape codes|escape code]] to indicate that the following value is hexadecimal; 0 should be send as \0 | ||
[[Category:3rd party integration]] | [[Category:3rd party integration]] | ||
Revision as of 09:07, 10 October 2023
|
The implementation described in this article is an example of how the event handler could be used to generate output compatible with Modbus TCP. Different PLC's or Scada systems will most likely need a different implementation. It is possible to write a script in the event handler with which ICX-AlphaCom can report status information, but it is impossible to use Modbus TCP to send commands to ICX-AlphaCom. |
Contents
Introduction
Modbus TCP is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation as lower layers already provide checksum protection.
|
|
Modbus TCP is not the same as Modbus over TCP/IP, which includes a checksum in the payload. |
For background information on Modbus and its different variants please see the Modbus article in Wikipedia. Modbus is often used for data communication with PLC's.
AlphaCom and the Modbus TCP protocol
AlphaCom can send out status information in the Modbus TCP protocol via an EDO-port.
- In AlphaPro, Exchange & System > Serial Ports, select an available EDIO port, for instance EDIO 1
- Set Port Type = TCP/IP client
- Enter the IP address of the PLC to connect to
- Enter the Port number which is used by the Modbus TCP protocol, by default 502.
Modbus TCP protocol - AlphaPro programming
The exact meaning of databytes will depend on the specific installation and PLC used. This article gives an example of an implementation for a real installation, please modify as appropriate for the actual requirement. In this example the AlphaCom sends status information about each intercom station to a PLC, which uses this information for visualisation. The status is coded in a single byte, where each bit has a specific meaning.
- Bit #0: Intercom station is OK and ready for use
- Bit #1: Faulty line or faulty station
- Bit #2: Intercom station in conversation
In this example the information is written to specific registers in the PLC, 1 register for each intercom station. The PLC registers to use are from 50001 and up, related to the physical number 1 and up for the intercom stations.
Example: Station OK and ready for use
Program an event:
- Owner Type: Station with UDP 8
- Event Type: 13 - Faulty station line
- When Change To: OFF
- Action string: EDO 1 "\0\x01\0\0\0\x06\x02\x06%dfmt(%op(%1.phy,+,50000),X,4)\0\x01"
In this specific case the meaning of the bytes is:
- \0\x01 - Transaction Identifier; 2 bytes
- \0\0 - Protocol Identifier; 2 bytes; always '0' for Modbus TCP
- \0\x06 - Length Field; 2 bytes; Number of remaining bytes in this frame
- \x02 - Unit Identifier; 1 byte; Slave Address (255 if not used)
- \x06 - Function code; 1 byte; Function codes as in other variants - 6: Write single register
- %dfmt(%op(%1.dir,+,50000),X,4)\0\x01 - Data bytes; the data used for the function code - For this specific function code this is 4 bytes, 2 bytes to address the register and 2 bytes for the data to be written.
- The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0
- The next two bytes are the value being written to this register: \x01 (Value 1 sets bit #0 and resets all the rest)
Example: Station line error
Program an event:
- Owner Type: Station with UDP 8
- Event Type: 13 - Faulty station line
- When Change To: ON
- Action string: EDO 1 "\0\x01\0\0\0\x06\x02\x06%dfmt(%op(%1.phy,+,50000),X,4)\0\x02"
In this specific case the meaning of the bytes is:
- \0\x01 - Transaction Identifier; 2 bytes
- \0\0 - Protocol Identifier; 2 bytes; always '0' for Modbus TCP
- \0\x06 - Length Field; 2 bytes; Number of remaining bytes in this frame
- \x02 - Unit Identifier; 1 byte; Slave Address (255 if not used)
- \x06 - Function code; 1 byte; Function codes as in other variants - 6: Write single register
- %dfmt(%op(%1.dir,+,50000),X,4)\0\x02 - Data bytes; the data used for the function code - For this specific function code this is 4 bytes, 2 bytes to address the register and 2 bytes for the data to be written.
- The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0
- The next two bytes are the value being written to this register: \x02 (Value 2 sets bit #1 and resets all the rest)
Example: Station in conversation
Program an event:
- Owner Type: Station with UDP 8
- Event Type: 44 - Conversation
- When Change To: ON
- Action string: EDO 1 "\0\x01\0\0\0\x06\x02\x06%dfmt(%op(%1.phy,+,50000),X,4)\0\x04"
In this specific case the meaning of the bytes is:
- \0\x01 - Transaction Identifier; 2 bytes
- \0\0 - Protocol Identifier; 2 bytes; always '0' for Modbus TCP
- \0\x06 - Length Field; 2 bytes; Number of remaining bytes in this frame
- \x02 - Unit Identifier; 1 byte; Slave Address (255 if not used)
- \x06 - Function code; 1 byte; Function codes as in other variants - 6: Write single register
- %dfmt(%op(%1.dir,+,50000),X,4)\0\x04 - Data bytes; the data used for the function code - For this specific function code this is 4 bytes, 2 bytes to address the register and 2 bytes for the data to be written.
- The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0
- The next two bytes are the value being written to this register: \x04 (Value 4 sets bit #2 and resets all the rest)
Example: Station ends conversation
Program an event:
- Owner Type: Station with UDP 8
- Event Type: 44 - Conversation
- When Change To: OFF
- Action string: EDO 1 "\0\x01\0\0\0\x06\x02\x06%dfmt(%op(%1.phy,+,50000),X,4)\0\x01"
In this specific case the meaning of the bytes is:
- \0\x01 - Transaction Identifier; 2 bytes
- \0\0 - Protocol Identifier; 2 bytes; always '0' for Modbus TCP
- \0\x06 - Length Field; 2 bytes; Number of remaining bytes in this frame
- \x02 - Unit Identifier; 1 byte; Slave Address (255 if not used)
- \x06 - Function code; 1 byte; Function codes as in other variants - 6: Write single register
- %dfmt(%op(%1.dir,+,50000),X,4)\0\x01 - Data bytes; the data used for the function code - For this specific function code this is 4 bytes, 2 bytes to address the register and 2 bytes for the data to be written.
- The first two bytes are the register address, %dfmt(%op(%1.dir,+,50000),X,4)\0
- The next two bytes are the value being written to this register: \x01 (Value 1 sets bit #0 and resets all the rest)
Notes: \x is the escape code to indicate that the following value is hexadecimal; 0 should be send as \0