This section describes the configuration of the EtherNet/IP Device (CIP) to the controller.
For further information about EtherNet/IP (CIP), refer to the www.odva.org website.
See Adding an EtherNet Manager.
EtherNet/IP Device Configuration
To configure the EtherNet/IP device parameters, double-click Ethernet > EthernetIP in the Devices tree.
The following dialog box is displayed:
The EtherNet/IP configuration parameters are defined as:
oInstance:
Number referencing the input or output Assembly.
oSize:
Number of channels of an input or output Assembly.
The memory size of each channel is 2 bytes that stores the value of an %IWx or %QWx object, where x is the channel number.
For example, if the Size of the Output Assembly is 20, it represents that there are 20 input channels (IW0...IW19) addressing %IWy...%IW(y+20-1), where y is the first available channel for the Assembly.
|
Element |
Admissible Controller Range |
EcoStruxure Machine Expert Default Value |
|
|---|---|---|---|
|
Output Assembly |
Instance |
150...189 |
150 |
|
Size |
2...40 |
20 |
|
|
Input Assembly |
Instance |
100...149 |
100 |
|
Size |
2...40 |
20 |
|
You can generate an EDS file to facilitate configuring EtherNet/IP cyclic data exchanges.
To generate the EDS file:
|
Step |
Action |
|---|---|
|
1 |
In the Devices tree, right-click the EthernetIP node and choose the Export as EDS command from the context menu. |
|
2 |
Modify the default file name and location as required. |
|
3 |
Click Save. |
NOTE: The Major Revision and Minor Revision objects in the EDS file are used to ensure uniqueness of the EDS file. The values of these objects do not reflect the actual controller revision level.
The EDS file is generated automatically in the "/usr/Eip" directory within the controller when an application is downloaded, or at start-up when a boot application exists, according to the parameters above.
NOTE: The EDS file is generated when the control network is working correctly on the controller (cable connected and the IP address is acquired).
EthernetIP Slave I/O Mapping Tab
Variables can be defined and named in the EthernetIP Slave I/O Mapping tab. Additional information such as topological addressing is also provided in this tab.
For further generic descriptions, refer to I/O Mapping Tab Description.
The table below describes the EthernetIP Slave I/O Mapping configuration:
|
Channel |
Type |
Default Value |
Description |
||
|---|---|---|---|---|---|
|
Input |
IW0 |
WORD |
- |
Command word of controller outputs (%QW) |
|
|
IWxxx |
|||||
|
Output |
QW0 |
WORD |
- |
State of controller inputs (%IW) |
|
|
QWxxx |
|||||
The number of words depends on the size parameter configured in EtherNet/IP Device Configuration.
Output means OUTPUT from Originator controller (= %IW for the controller).
Input means INPUT from Originator controller (= %QW for the controller).
To access a target device, open a connection (global name used by EtherNet/IP protocol level) which can include several sessions that send requests.
One explicit connection uses one session (a session is a TCP or UDP connection.
One I/O connection uses 2 sessions.
The following table shows the EtherNet/IP connections limitations:
|
Characteristic |
Maximum |
|---|---|
|
Explicit connections |
8 (Class 3) |
|
I/O connections |
1 (Class 1) |
|
Connections |
8 |
|
Sessions |
16 |
|
Simultaneous requests |
32 |
The controller supports the following objects:
|
Object class |
Class ID |
Cat. |
Number of Instances |
Effect on Interface Behavior |
|---|---|---|---|---|
|
01 hex |
1 |
1 |
Supports the reset service |
|
|
02 hex |
1 |
1 |
Explicit message connection |
|
|
04 hex |
2 |
2 |
Defines I/O data format |
|
|
06 hex |
|
1 |
- |
|
|
37 hex |
|
2 |
Allows to exchange EDS file |
|
|
44 hex |
|
1 |
- |
|
|
F5 hex |
1 |
1 |
TCP/IP configuration |
|
|
F6 hex |
1 |
1 |
Counter and status information |
Identity Object (Class ID = 01 hex)
The following table describes the class attributes of the Identity Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
01h |
Implementation revision of the Identity Object |
|
2 |
Get |
Max Instances |
UINT |
01h |
The largest instance number |
|
3 |
Get |
Number of Instances |
UINT |
01h |
The number of object instances |
|
4 |
Get |
Optional Instance Attribute List |
UINT, UINT [ ] |
00h |
The first 2 bytes contain the number of optional instance attributes. Each following pair of bytes represents the number of other optional instance attributes. |
|
6 |
Get |
Max Class Attribute |
UINT |
07h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
07h |
The largest instance attributes value |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
05 |
Reset (1) |
Initializes EtherNet/IP component (controller reboot) |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
(1) Reset Service description:
When the Identity Object receives a Reset request, it:
odetermines whether it can provide the type of reset requested
oresponds to the request
oattempts to perform the type of reset requested
The Reset common service has one specific parameter, Type of Reset (USINT), with the following values:
|
Value |
Type of Reset |
|---|---|
|
0 |
Reboots the controller. NOTE: This value is the default value if this parameter is omitted. |
|
1 |
Reset Warm. |
|
2 |
Not supported. |
|
3...99 |
Reserved |
|
100...199 |
Vendor specific |
|
200...255 |
Reserved |
The following table describes the Instance attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Vendor ID |
UINT |
243h |
Schneider Automation ID |
|
2 |
Get |
Device type |
UINT |
0Eh |
Controller |
|
3 |
Get |
Product code |
UINT |
805h |
Controller product code |
|
4 |
Get |
Revision |
Struct of USINT, USINT |
- |
Product revision of the controller (1) Equivalent to the 2 low bytes of controller version |
|
5 |
Get |
Status |
WORD (1) |
- |
See definition in the table below |
|
6 |
Get |
Serial number |
UDINT |
- |
Serial number of the controller XX + 3 LSB of MAC address |
|
7 |
Get |
Product name |
Struct of USINT, STRING |
- |
Example: TM258LD42DT. |
(1) Mapped in a WORD:
oMSB: minor revision (second USINT)
oLSB: major revision (first USINT)
Example: 0205h means revision V5.2.
Status Description (Attribute 5):
|
Bit |
Name |
Description |
|---|---|---|
|
0 |
Owned |
Unused |
|
1 |
Reserved |
- |
|
2 |
Configured |
TRUE indicates the device application has been reconfigured. |
|
3 |
Reserved |
- |
|
4...7 |
Extended Device Status |
o0: self-testing or undetermined o1: firmware update in progress o2: at least one invalid I/O connection error detected o3: no I/O connections established o4: non-volatile configuration invalid o5: non recoverable error detected o6: at least one I/O connection in RUNNING state o7: at least one I/O connection established, all in idle mode o8: reserved o9...15: unused |
|
8 |
Minor Recoverable Error |
TRUE indicates the device detected an error, which, under most circumstances, is recoverable. This type of event does not lead to a change in the device state. |
|
9 |
Minor Unrecoverable Error |
TRUE indicates the device detected an error, which, under most circumstances, is not recoverable. This type of event does not lead to a change in the device state. |
|
10 |
Major Recoverable Error |
TRUE indicates the device detected an error, which requires the device to report an exception and enter into the HALT state. This type of event leads to a change in the device state, but, under most circumstances, is recoverable. |
|
11 |
Major Unrecoverable Error |
TRUE indicates the device detected an error, which requires the device to report an exception and enter into the HALT state. This type of event leads to a change in the device state, but, under most circumstances, is not recoverable. |
|
12...15 |
Reserved |
- |
Message Router Object (Class ID = 02 hex)
The following table describes the class attributes of the Message Router Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
01h |
Implementation revision of the Message Router Object |
|
2 |
Get |
Max Instances |
UINT |
01h |
The largest instance number |
|
3 |
Get |
Number of Instance |
UINT |
01h |
The number of object instances |
|
4 |
Get |
Optional Instance Attribute List |
Struct of UINT, UINT [ ] |
20 |
The first 2 bytes contain the number of optional instance attributes. Each following pair of bytes represents the number of other optional instance attributes (from 100 to 119). |
|
5 |
Get |
Optional Service List |
UINT |
00h |
The number and list of any implemented optional services attribute (0: no optional services implemented) |
|
6 |
Get |
Max Class Attribute |
UINT |
07h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
119 |
The largest instance attributes value |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
The following table describes the Instance attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Description |
|---|---|---|---|---|---|
|
1 |
Get |
Implemented Object List |
Struct of UINT, UINT [ ] |
- |
Implemented Object list. The first 2 bytes contain the number of implemented objects. Each two bytes that follow represent another implemented class number. This list contains the following objects: oIdentity oMessage Router oAssembly oConnection Manager oParameter oFile Object oModbus oPort oTCP/IP oEthernet Link |
|
2 |
Get |
Number available |
UINT |
20h |
Maximum number of concurrent CIP (Class1 or Class 3) connections supported |
|
100 |
Get |
Total incoming Class1 packets received during the last second |
UINT |
- |
Total number of incoming packets received for all implicit (Class1) connections during the last second |
|
101 |
Get |
Total outgoing Class1 packets sent during the last second |
UINT |
- |
Total number of outgoing packets sent for all implicit (Class1) connections during the last second |
|
102 |
Get |
Total incoming Class3 packets received during the last second |
UINT |
- |
Total number of incoming packets received for all explicit (Class 3) connections during the last second |
|
103 |
Get |
Total outgoing Class3 packets sent during the last second |
UDINT |
- |
Total number of outgoing packets sent for all explicit (Class 3) connections during the last second |
|
104 |
Get |
Total incoming unconnected packets received during the last second |
UINT |
- |
Total number of incoming unconnected packets received during the last second |
|
105 |
Get |
Total outgoing unconnected packets sent during the last second |
UINT |
- |
Total number of outgoing unconnected packets sent during the last second |
|
106 |
Get |
Total incoming EtherNet/IP packets received during the last second |
UINT |
- |
Total unconnected Class1 or Class 3 packets received during the last second |
|
107 |
Get |
Total outgoing EtherNet/IP packets sent during the last second |
UINT |
- |
Total unconnected Class1 or Class 3 packets sent during the last second |
|
108 |
Get |
Total incoming Class1 packets received |
UINT |
- |
Total number of incoming packets received for all implicit (Class1) connections |
|
109 |
Get |
Total outgoing Class1 packets sent |
UINT |
- |
Total number of outgoing packets sent for all implicit (Class1) connections |
|
110 |
Get |
Total incoming Class3 packets received |
UINT |
- |
Total number of incoming packets received for all explicit (Class 3) connections. This number includes the packets that would be returned if an error had been detected (listed in the next two rows). |
|
111 |
Get |
Total incoming Class3 packets Invalid Parameter Value |
UINT |
- |
Total number of incoming Class 3 packets that targeted a non-supported service/class/instance/attribute/member |
|
112 |
Get |
Total incoming Class3 packets Invalid Format |
UINT |
- |
Total number of incoming Class 3 packets that had an invalid format |
|
113 |
Get |
Total outgoing Class3 packets sent |
UINT |
- |
Total number of packets sent for all explicit (Class 3) connections |
|
114 |
Get |
Total incoming unconnected packets received |
UINT |
- |
Total number of incoming unconnected packets. This number includes the packets that would be returned if an error had been detected (listed in the next two rows). |
|
115 |
Get |
Total incoming unconnected packets Invalid Parameter Value |
UINT |
- |
Total number of incoming unconnected packets that targeted a non-supported service/class/instance/attribute/member |
|
116 |
Get |
Total incoming unconnected packets Invalid Format |
UINT |
- |
Total number of incoming unconnected packets that had an invalid format |
|
117 |
Get |
Total outgoing unconnected packets sent |
UINT |
- |
Total number of all unconnected packets sent |
|
118 |
Get |
Total incoming EtherNet/IP packets |
UINT |
- |
Total unconnected, Class 1, or Class 3 packets received |
|
119 |
Get |
Total outgoing EtherNet/IP packets |
UINT |
- |
Total unconnected, Class 1, or Class 3 packets sent |
Assembly Object (Class ID = 04 hex)
The following table describes the class attributes of the Assembly Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
2 |
Implementation revision of the Assembly Object |
|
2 |
Get |
Max Instances |
UINT |
189 |
The largest instance number |
|
3 |
Get |
Number of Instances |
UINT |
2 |
The number of object instances |
|
4 |
Get |
Optional Instance Attribute List |
Struct of: UINT UINT [ ] |
1 4 |
The first 2 bytes contain the number of optional instance attributes. Each following pair of bytes represents the number of other optional instance attributes. |
|
5 |
Get |
Optional Service List |
UINT |
00h |
The number and list of any implemented optional services attribute (0: no optional services implemented) |
|
6 |
Get |
Max Class Attribute |
UINT |
07h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
04h |
The largest instance attributes value |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
|
10 |
Set Attribute Single |
Modifies the value of the specified attribute |
|
18 |
Get Member |
Reads a member of an Assembly object instance |
|
19 |
Set Member |
Modifies a member of an Assembly object instance |
Instances Supported
Output means OUTPUT from Originator controller (= %IW for the controller).
Input means INPUT from Originator controller (= %QW for the controller).
The controller supports 2 Assemblies:
|
Name |
Instance |
Data Size |
|---|---|---|
|
Controller Output (%IW) |
Configurable: must be between 100 and 149 |
2...40 words |
|
Controller Input (%QW) |
Configurable: must be between 150 and 189 |
2...40 words |
NOTE: The Assembly object binds together the attributes of multiple objects so that information to or from each object can be communicated over a single connection. Assembly objects are static.
The Assemblies in use can be modified through the parameter access of the network configuration tool (RSNetWorx). The controller needs to recycle power to register a new Assembly assignment.
The following table describes the Instance attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Description |
|---|---|---|---|---|---|
|
1 |
Get |
Number of Member Object List |
UINT |
2...40 |
Always 1 member for the controller |
|
2 |
Get |
Member List |
ARRAY of Struct |
- |
Array of 1 structure where each structure represents one member |
|
3 |
Get/Set |
Instance Data |
ARRAY of Byte |
- |
Data Set service only available for Controller output |
|
4 |
Get |
Instance Data Size |
UINT |
4...80 |
Size of data in byte |
Member list content:
|
Name |
Data Type |
Value |
Type of Reset |
|---|---|---|---|
|
Member data size |
UINT |
4...40 |
Member data size in bits |
|
Member path size |
UINT |
6 |
Size of the EPATH (see table below) |
|
Member path |
EPATH |
- |
EPATH to the Member |
EPATH is:
|
Word |
Value |
Semantic |
|---|---|---|
|
0 |
2004 hex |
Class 4 |
|
1 |
24xx hex |
Instance xx where xx is the instance value (example: 2464 hex = instance 100). |
|
2 |
30 hex |
Attribute 3 |
Connection Manager Object (Class ID = 06 hex)
The following table describes the class attributes of the Assembly Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
2 |
Implementation revision of the Connection Manager Object |
|
2 |
Get |
Max Instances |
UINT |
189 |
The largest instance number |
|
3 |
Get |
Number of Instances |
UINT |
2 |
The number of object instances |
|
4 |
Get |
Optional Instance Attribute List |
Struct of: UINT UINT [ ] |
- |
The number and list of the optional attributes. The first word contains the number of attributes to follow and each following word contains another attribute code. Following optional attributes include: ototal number of incoming connection open requests othe number of requests rejected because of the non-conforming format of the Forward Open othe number of requests rejected because of insufficient resources othe number of requests rejected because of the parameter value sent with the Forward Open othe number of Forward Close requests received othe number of Forward Close requests that had an invalid format othe number of Forward Close requests that could not be matched to an active connection othe number of connections that have timed out because the other side stopped producing, or a network disconnection occurred |
|
6 |
Get |
Max Class Attribute |
UINT |
07h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
08h |
The largest instance attributes value |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all instance attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
|
4E |
Forward Close |
Closes an existing connection |
|
52 |
Unconnected Send |
Sends a multi-hop unconnected request |
|
54 |
Forward Open |
Opens a new connection |
The following table describes the Instance attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Description |
|---|---|---|---|---|---|
|
1 |
Get |
Open Requests |
UINT |
- |
Number of Forward Open service requests received |
|
2 |
Get |
Open Format Rejects |
UINT |
- |
Number of Forward Open service requests which were rejected due to invalid format |
|
3 |
Get |
Open Resource Rejects |
ARRAY of Byte |
- |
Number of Forward Open service requests which were rejected due to lack of resources |
|
4 |
Get |
Open Other Rejects |
UINT |
- |
Number of Forward Open service requests which were rejected for reasons other than invalid format or lack of resources |
|
5 |
Get |
Close Requests |
UINT |
- |
Number of Forward Close service requests received |
|
6 |
Get |
Close Format Requests |
UINT |
- |
Number of Forward Close service requests which were rejected due to invalid format |
|
7 |
Get |
Close Other Requests |
UINT |
- |
Number of Forward Close service requests which were rejected for reasons other than invalid format |
|
8 |
Get |
Connection Timeouts |
UINT |
- |
Total number of connection timeouts that have occurred in connections controlled by this Connection Manager |
File Object (Class ID = 37 hex)
The following table describes the class attributes of the File Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
1 |
Implementation revision of the File Object |
|
2 |
Get |
Max Instances |
UINT |
C9h |
The largest instance number |
|
3 |
Get |
Number of Instances |
UINT |
2 |
The number of object instances |
|
6 |
Get |
Max Class Attribute |
UINT |
20h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
0Bh |
The largest instance attributes value |
|
32 |
Get |
Instance List |
- |
- |
Returns information on all configured instances including Instance Number, Instance Name and Instance File Name |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
Instance Code
The File object provides download functionality for the EDS and EDS Icon files. The following instances of the File object are implemented:
oInstance C8 hex returns an uncompressed version of the EDS text file. The instance name attribute is returned as "EDS and Icon Files". The file name attribute returns "M258xxx.eds" where M258xxx is the exact reference of the controller. The contents of the EDS file are adjusted dynamically by the controller. The connection data sizes in the EDS file are adjusted to reflect the actual standard Assembly instance sizes.
oInstance C9 hex returns a compressed version of the device EDS icon file. The instance name is returned as "Related EDS and Icon Files". The file name attribute returns "M258xxx.gz" where M258xxx is the exact reference of the controller. This is zip encoded file containing only one file: M258xxx.ico. The file is encoded with the ZLIB compression file format. ZLIB is a free, general purpose, legally unencumbered, loss-less compression library. The specifications are available from the Internet Engineering Task Force (http://www.ietf.org).
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
0E |
Get Attribute Single |
Returns the value of the specified instance attribute |
|
4B |
Initiate Upload |
Start uploading process. Request contains the Maximum File Size the Client can accept on Upload. Response contains the actual File Size, which will never be more than the Maximum File Size and the Transfer Size, which is the number of bytes transferred with each Upload Transfer request. |
|
4F |
Upload Transfer |
Upload another section of file data. Request contains the Transfer Number, which is incremented with each subsequent transfer. Response contains the matching Transfer Number, Transfer Type, File Data, and for the last transfer, the Checksum word. Transfer Type indicates if this is the first, intermediate or last packet, if it is the only packet, or if the transfer should be aborted. |
The following table describes the Instance Attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Description |
|---|---|---|---|---|---|
|
1 |
Get |
State |
USINT |
- |
One of the following: o0: non existent o1: file empty - file should not have any content until it is downloaded from the remote client. When set, File name, Revision, Checksum and File Save Flag values have no meaning, and File Size is 0. o2: file loaded - file contents are pre-loaded by the application (file size > 0) or file data has been downloaded and stored into the non-volatile memory area o3: upload initiated o4: download initiated o5: upload in progress o6: download in progress o7: storing to non-volatile area is in progress |
|
2 |
Get |
Instance Name |
STRING |
- |
Unique Name assigned to the File Object Instance. For the C8 hex instance, it is "EDS and Icon Files". For the C9 hex instance, it is "Related EDS and Icon Files". |
|
3 |
Get |
Instance Format Revision |
UINT |
- |
Revision number assigned for this instance by the application, to differentiate between different file formats. |
|
4 |
Get |
File Name |
STRING |
- |
Unique name for File Storage |
|
5 |
Get |
File Revision |
USINT |
Major Minor |
File Revision is updated every time file content is changed. |
|
6 |
Get |
File Size |
UDINT |
- |
File Size in bytes |
|
7 |
Get |
File Checksum |
UINT |
- |
Two’s complement of the 16 bit sum of all bytes |
|
8 |
Get |
Invocation Method |
USINT |
- |
Defines what should happen after the file is downloaded. Possible options include: o0: No Action o2: Power Cycle, etc. |
|
9 |
Get |
File Save Parameters |
BYTE |
- |
If bit 1 is set, the file should be explicitly saved to non-volatile storage after download is complete. |
|
10 |
Get |
File Type |
USINT |
- |
o0: Read/Write access o1: Read Only access |
|
11 |
Get |
File Encoding Format |
UINT |
- |
o0: no encoding o1: encoded using ZLIB |
Modbus Object (Class ID = 44 hex)
The Modbus object provides an additional method to access the Modbus table data. A single explicit request will either read or write 1 or more contiguous registers. An additional Pass-through service allows the user to specify an actual Modbus message data.
The following table describes the class attributes of the Modbus Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
1 |
Implementation revision of the Modbus Object |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
Instance Codes
Only instance 1 is supported.
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
4B |
Read Digital Inputs |
Returns the value of one or several contiguous Digital Input registers |
|
4C |
Read Coils |
Returns the value of one or several contiguous Coils |
|
4E |
Read Holding Registers |
Returns the value of one or several contiguous Holding Registers |
|
4F |
Write Coils |
Updates the value of one or several contiguous Coils |
|
50 |
Write Holding Registers |
Updates the value of one or several contiguous Holding Registers |
NOTE: The Read Register service requires 4 bytes of data: the first word contains the starting register address and the second word contains the number of registers to read. The Write service request requires the same 4 bytes, followed by the actual data.
The Modbus Pass-through service indicates a specific Modbus function. The translation function will not perform any Indian conversion on the request or response data. Both request and response contain 1 byte of the Modbus Function code followed by the Modbus message data, including a sub-function code if present.
TCP/IP Interface Object (Class ID = F5 hex)
This object maintains link specific counters and status information for an Ethernet 802.3 communications interface.
The following table describes the class attributes of the TCP/IP Interface Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
1 |
Implementation revision of the TCP/IP Interface Object |
|
2 |
Get |
Max Instances |
UINT |
1 |
The largest instance number |
|
3 |
Get |
Number of Instance |
UINT |
1 |
The number of object instances |
|
6 |
Get |
Max Class Attribute |
UINT |
07h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
06h |
The largest instance attributes value |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
Instance Codes
Only instance 1 is supported.
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all instance attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified instance attribute |
The following table describes the Instance Attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Description |
|---|---|---|---|---|---|
|
1 |
Get |
Status |
DWORD |
Bit level |
o0: The interface configuration attribute has not been configured. o1: The interface configuration contains a valid configuration. o2...15: Reserved. |
|
2 |
Get |
Configuration Capability |
DWORD |
Bit level |
o0: BOOTP Client o1: DNS Client o2: DHCP Client o3: DHCP-DNS capable o4: interface configuration set table All other bits are reserved and set to 0. |
|
3 |
Get |
Configuration |
DWORD |
Bit level |
o0: The interface configuration is valid. o1: The interface configuration is obtained with BOOTP. o2: The interface configuration is obtained with DHCP. o3: reserved o4: DNS Enable All other bits are reserved and set to 0. |
|
4 |
Get |
Physical Link |
UINT |
Path size |
Number of 16 bits word in the element Path |
|
Padded EPATH |
Path |
Logical segments identifying the physical link object. The path is restricted to one logical class segment and one logical instance segment. The maximum size is 12 bytes. |
|||
|
5 |
Get |
Interface configuration |
UDINT |
IP Address |
- |
|
UDINT |
Network Mask |
- |
|||
|
UDINT |
Gateway Address |
- |
|||
|
UDINT |
Primary Name |
- |
|||
|
UDINT |
Secondary Name |
0: no secondary name server address has been configured. Otherwise, the name server address shall be set to a valid Class A, B, or C address. |
|||
|
STRING |
Default Domain Name |
ASCII characters. Maximum length is 48 characters. Padded to an even number of characters (pad not included in length). 0: no Domain Name is configured |
|||
|
6 |
Get |
Host Name |
STRING |
- |
ASCII characters. Maximum length is 64 characters. Shall be padded to an even number of characters (pad not included in length). 0: no Host Name is configured |
Ethernet Link Object (Class ID = F6 hex)
This object provides the mechanism to configure a TCP/IP network interface device.
The following table describes the class attributes of the Ethernet Link Object:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Details |
|---|---|---|---|---|---|
|
1 |
Get |
Revision |
UINT |
2 |
Implementation revision of the Ethernet Link Object |
|
2 |
Get |
Max Instances |
UINT |
1 |
The largest instance number |
|
3 |
Get |
Number of Instances |
UINT |
1 |
The number of object instances |
|
6 |
Get |
Max Class Attribute |
UINT |
07h |
The largest class attributes value |
|
7 |
Get |
Max Instance Attribute |
UINT |
03h |
The largest instance attribute value |
The following table describes the Class Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all class attributes |
|
0E |
Get Attribute Single |
Returns the value of the specified attribute |
Instance Codes
Only instance 1 is supported.
The following table describes the Instance Services:
|
Service Code (hex) |
Name |
Description |
|---|---|---|
|
01 |
Get Attribute All |
Returns the value of all instance attributes |
|
10 |
Set Attribute Single |
Modifies the value of the specified attribute |
|
0E |
Get Attribute Single |
Returns the value of the specified instance attribute |
The following table describes the Instance Attributes:
|
Attribute ID |
Access |
Name |
Data Type |
Value |
Description |
|---|---|---|---|---|---|
|
1 |
Get |
Interface Speed |
UDINT |
- |
Speed in Mbps (10 or 100) |
|
2 |
Get |
Interface Flags |
DWORD |
Bit level |
o0: link status o1: half/full duplex o2...4: negotiation status o5: manual setting / requires reset o6: local hardware error detected All other bits are reserved and set to 0. |
|
3 |
Get |
Physical Address |
ARRAY of 6 USINT |
- |
This array contains the MAC address of the product. Format: XX-XX-XX-XX-XX-XX |
