Professional Documents
Culture Documents
Modbus on Ethernet
applicom international
Copyright © 1989-2002 applicom international.
Table of contents
1. Description of Modbus on Ethernet 1
General.................................................................................................................................1
applicomIO® functionalities ...............................................................................................2
8. Status 43
General...............................................................................................................................43
applicomIO status ..............................................................................................................44
General
The Modbus on Ethernet protocol is used to connect Modbus remote input/output devices on an
Ethernet TCP/IP network.
The Modbus on Ethernet protocol uses the TCP or UDP layers to carry Modbus messaging based
on the Modicon "Open Modbus/TCP Specifications" which can be obtained from the site:
http://www.modbus.org.
See also:
- in the knowledge base:
1 : TCP/IP appendix
Speeds supported:
Auto/10/100 Mbits
Connector type:
RJ45
Protocols supported:
TCP
UDP
Devices supported:
max. 127 devices
Equipment type: "Generic Modbus"
Modbus Scanner:
Polling of inputs in "cyclic" mode per period multiple of 10 ms
Polling of outputs in "cyclic" or "cyclic and on value change" mode per period
multiple of 10 ms
Total size of inputs/outputs: 14 kilobytes at the most
applicomIO® console
Automatic detection of devices present on the network
Diagnostic of the applicomIO® configuration
On line access to devices not configured
Management of the equipment library is carried out in the "Equipment library" area.
The equipment library can be used to insert manually 1 a new "Generic Modbus" device in the
configuration.
Voir également :
- in this manual:
1 : Manual Configuration
applicomIO® 2.2 Modbus Ethernet Using the Modbus on Ethernet equipment library • 3
3. Using Modbus on Ethernet
network detection
Detection of equipment on the Modbus on Ethernet network is carried out in the "Network
detection" 2 area.
You can then define an IP address range to be detected by entering start and end addresses.
During network detection, you can stop the detection of devices at any time by pressing "cancel"
Other device types: They are represented by: In this case only the IP
address is specified. These devices were not recognized as Modbus devices, although
connected to the network. You cannot add this type of device to the configuration.
See also:
- in this manual:
TCP/IP protocol configuration
- in the documentation:
2 : Configuration : ‘Network detection’ tab
3 : Implementation : Initialization
See also:
- in this manual:
Ethernet configuration
TCP/IP protocol configuration
Ethernet configuration
® Interface serial
applicom
number
IEEE
(in hexadecimal)
address
00 AO 91 xx xx xx
Figure 1
00 AO 91 00 4E 84
Figure 2
"General" tab
IP address of the applicom channel
Area of 4 bytes entered in decimal notation with decimal point representing the
Internet address or IP address 1 of the applicomIO® board channel.
IP address of the gateway
IP address of a machine which can perform routing 2 to another network (internal or
external).
Subnetwork mask
Used to define the addresses 3 to be routed by the gateway 2.
Value "0.0.0.0" to "255.255.255.255"; "255.255.255.0" by default.
See also:
- in the knowledge base:
1 : TCP/IP appendix: IP address
2 : TCP/IP appendix: Gateway
3 : TCP/IP appendix: Subnetwork mask
4 : TCP/IP appendix: TCP Time-Out
General configuration
Device designation
Topic name
Enables the OPC and DDE servers to access the variables of this device. For further
details refer to the "DDE and OPC servers" manual.
Number
Number of the applicomIO® device to be chosen in the list of devices not configured.
Value from 0 to 127.
Network properties
IP address
IP address of the partner device.
The complete address in TCP/IP includes an IP address and a port number (TCP
Port), the port number being used to identify the application using the connection.
Generally the port number is predefined by the PLC manufacturer.
Transport protocol
Used to choose between TCP transport protocol and UDP transport protocol.
Destination port
Port on the targeted equipment that the applicomIO® master must connect to. The
values can range from 1 to 65535.
Remark concerning the source port: This source port contains the port number of the
applicomIO® master which will be used by the target device for its response. When
UDP transport protocol is selected, the source port is automatically set to 0.
Description
Provides help on the selected field.
Unit identifier
On TCP/IP, the "Slave address" field of the Modbus protocol is replaced by a "Unit
identifier" byte which can be used to communicate via bridge or gateway type
devices using a single IP address and supporting several independent end devices.
This number is linked to the applicom® device number if the "Link the parameters"
box is checked.
Value : from 1 to 255, 1 by default
See also:
- in this manual:
1 : Configuration of outputs
This tab defines the exchange blocks used by the Modbus master to read the inputs of the device.
Syntax
This syntax allows you to define the address and the exchange type: 0xxxxx for the
internal bits, 1xxxxx for the input bits, 4xxxxx for the internal words, 3xxxxx for the
input words (where xxxxx is the data address, e.g.:400004).
Period
Refresh period 3 for this exchange block 2. The value must be a multiple of 10 ms.
The zero period (0) chained the refresh of the bloc.
Value: from 0 to 65530, 10 by default.
Root name
Allows you to define a root of the item 1 name to create new OPC/DDE tags.
The items are created automatically with this root.
OPC/DDE type
Defines the variable type corresponding to the default item 1 in OPC/DDE for this
exchange block.
This tab defines the exchange blocks used by the Modbus master to write the outputs of the device.
Syntax
This syntax allows you to define the address and the exchange type: 0xxxxx for the
internal bits, 4xxxxx for the internal words, (where xxxxx is the data address,
e.g.:400004).
The Modbus function code 4 will depend on the used syntax.
Number
Number of data items of the specified type to write.
Value for words : from 1 to 127, 1 by default.
Value for bits : from 1 to 2040, 1 by default.
Mode
Defines the refresh mode of the exchange block.
The modes are: "Cyclic" or "Cyclic and on change of value".
In "Cyclic" mode, the outputs are refreshed at a fixed period for this exchange
block.
In "Cyclic and on change of value" mode, refresh is carried out at a fixed period and
also on change of status.
Period
Refresh period 3 for this exchange block in cyclic mode. The value must be a
multiple of 10 ms.
Value: from 10 to 65530, 500 by default
Root name
Allows you to define a root of the item 1 name to create new OPC/DDE tags.
The items are created automatically with this root.
OPC/DDE type
Defines the variable type corresponding to the default item 1 in OPC/DDE for this
exchange block.
Add a new PCI-ETHIO applicomIO® board 1 with the menu command "Description / Add a board"
or with the button
The library contains only one device. This is a generic device which can be used for any Modbus on
Ethernet device that you want to add to your configuration.
After correctly configuring the applicomIO® master (choosing it an IP address), two configuration 1,2
methods are available:
Automatic configuration
Your applicomIO® board is already connected to the Ethernet and the IP addresses of your
devices are correctly configured.
Manual Configuration
Your applicomIO® board is not yet linked to the Ethernet, but you know the characteristics
of the devices to be configured.
See also:
- in this manual:
1 : Automatic configuration
2 : Manual Configuration
Activate network scanning 1 with the menu command "Network/Read network configuration..." or
with the button.
A message may be displayed asking whether you want to reinitialize the applicomIO® interface
before starting the detection.
As soon as network detection starts, the scanning starts for the whole IP address range.
The equipment detected can be included in the configuration with the menu command
“Network/Insert in the configuration” or with the button.
The devices can also be included individually, by Drag&Drop, from the "Network detection” tab to
the configuration area.
See also:
- in this manual:
1 : Automatic detection of equipment present
When a device is inserted in the configuration, the "General configuration" tab of the "Generic
Modbus" 1 device is automatically displayed.
In manual configuration mode, you must specify the device IP address, whereas in automatic
mode, the IP address is already completed.
You must then define exchange blocks 2,3 for each device, for the inputs/outputs ("Input" and
"Output" tab) irrespective of the configuration mode.
To add this new device to the configuration, press "OK".
You can add up to 128 devices.
See also:
- in this manual:
1 : Modbus on Ethernet device properties
- in the knowledge base:
2 : Purpose of an Exchange block
3 : Configuring the period of an Exchange block
In the "configuration area", display the properties of the Modbus on Ethernet master by double
clicking on the Ethernet node
Configure the channel by double clicking on the TCP/IP node (or by pressing the SPACE bar) in the
configuration tree
You can now modify the master IP address, the gateway IP address and the network mask.
See also:
- in this manual:
1 : Properties of the Modbus on Ethernet master
After configuring the Modbus on Ethernet master, adding and configuring the devices of your
network, you can download your configuration into the board with the "PcInitIO" 1 command.
This command can be executed in the console with the menu command "File/Board initialization"
or with the button of the main toolbar on the console.
See also:
- in the documentation:
1 : Initialization
On line actions
This feature allows you to read or write 1 data in a Modbus on Ethernet device connected to your
network even if this device is not included in the configuration in the applicomIO® console.
See also:
- in the knowledge base:
1 : Online action on the Modbus on Ethernet network: Description
After configuring the Modbus on Ethernet master, adding and configuring the devices of your
network and downloading your configuration in the board, the statuses of all devices can be tested
with the diagnostic tool 1.
Start this tool with the menu command “Protocol/Diagnostic…” or with the button.
See also:
- in the documentation:
1 : Implementation: Tests and diagnostics
The Modbus on Ethernet channel diagnostic information can be displayed by selecting the MULTI-
MSG ETH channel.
All devices in the configuration are visualized by a LED corresponding to the applicomIO® device
number. The LED may be red or green depending on the device error status.
This screen is used to display the exchange statuses regarding the TCP/IP layer.
IP address
IP address of the applicomIO® master on this channel.
Gateway
IP address of the gateway.
The addresses are those configured in the "General" tab of the TCP/IP node.
See also:
- in this manual:
1 : TCP tab
2 : IP tab
Passive connections
Number of passive connections.
Active connections
Number of active connections.
Current connections
Number of current connections.
Bytes received
Number of bytes received
Bytes transmitted
Number of bytes transmitted.
Retries on time-out
Number of retries on reception of a time-out.
Packets received
Number of packets received
Packets transmitted
Number of packets transmitted
Errors
Number of IP errors.
Requests
Number of requests.
Requests / s
Number of requests per second.
Useful bytes
Number of useful data bytes.
Useful bytes / s
Number of useful data bytes per second.
Requests in error
Number of requests in error.
View the diagnostic information on a device in the configuration by selecting the node which
corresponds to the device:
Requests
Number of requests.
Requests / s
Number of requests per second.
Useful bytes
Number of useful data bytes.
Useful bytes / s
Number of useful data bytes per second.
Connections
Number of connections created for this device.
Time-out errors
The information available for an exchange block can be viewed by selecting the exchange block in
the tree.
Period ms
Exchange block refresh period in milliseconds.
Function
Exchange type.
Mode
Exchange mode. Either "Cyclic" or "Cyclic and Change Of State".
Nr Var
Number of variables read or written.
Address
Variable address in the equipment.
Status
General
The "General Status" column corresponds to the statuses you may obtain irrespective of the field
bus used.
The "Protocol Status" column corresponds to the additional statuses related to the field bus used.
Status Definition
General Protocol
0 No anomaly detected.
The function was properly executed.
1 Unknown function.
The requested function is not supported.
2 Bad address.
The address for the variable that you are soliciting is incorrect.
Additional information:
Messaging on TCP/IP Ethernet: Returned by the coupler of the destination device.
Access to a variable with a bad address or a number exceeding the PLC area.
3 Bad data.
Additional information:
Frame content inconsistent.
4 Inaccessible data.
Additional information:
The physical address does not exist, module does not exist or protected data.
32 Indicates that the parameters passed to the functions are not correct (eg: Number of
requested variables too large)