FS 8704 03 - ModbusTCP
FS 8704 03 - ModbusTCP
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8704-03 ModbusTCP
TABLE OF CONTENTS
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 3 of 16
1 MODBUS/TCP DESCRIPTI ON
The Modbus TCP Driver allow the FieldServer to transfer data to and from devices over either RS-232 or RS-485
using Modbus TCP Protocol. The Modbus TCP driver uses port 502. The driver was developed for Modbus
Application Protocol Specification V1.1a" from Modbus-IDA. The specification can be found at www.modbus.org.
The FieldServer can emulate either a Server or Client.
The information that follows describes how to expand upon the factory defaults provided in the configuration files
included with the FieldServer.
There are various register mapping models being followed by various vendors. To cover all these models
FieldServer uses the following three Models
Modicon_5digit – Use this format where addresses are defined in 0xxxx, 1xxxx, 3xxxx or 4xxxx format. A
maximum of 9999 registers can be mapped of each type. This is FieldServer driver’s default format.
ADU –Application Data Unit address. Use this format where addresses of each type are defined in the
range 1-65536
PDU –Protocol Data unit address. Use this format where addresses of each type are defined in the range
0-65535.
The key difference between ADU and PDU is for example if Address_Type is ADU and address is 1, the driver will
poll for register 0. If Address_Type is PDU, the driver will poll for address 1.
Note 1: If vendor document shows addresses in extended Modicon (i.e. 6 digit) format like 4xxxxx then consider
these addresses as xxxxx (omit the first digit) and use either ADU or PDU
Note 2: The purpose of providing 3 different ways of addressing the Modbus registers is to allow the user to
choose the addressing system most compatible with the address list being used. At the protocol level, the same
protocol specification is used for all three with the exception of the limited address range for Modicon_5digit.
Part # Description
2
Modbus/TCP Server, e.g. Quantum PLC
Modbus/TCP Host Node, e.g. Intellution Fix, Wondereware Intouch, GE Cimplicity, Quantum PLC
3
(Master).
1
This cable is necessary for connection to the driver. It is shipped with the FieldServer and not separately with the driver.
2
If FieldServer used as Modbus/TCP Client.
3
If FieldServer used as Modbus/TCP Server
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 4 of 16
3 HARDWARE CONNECTIONS
PLC
Ethernet Interface
SITE FS-8915-10
ETHERNET
FS-8915-10
(408)-262-2299
FIELDSERVER
MODBUS TCP
CONNECTION DIAGRAM
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 5 of 16
Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary
to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data.
Section Title
Data_Arrays
Column Title Function Legal Values
Up to 15 alphanumeric
Data_Array_Name Provide name for Data Array
characters
Example
// Data Arrays
Data_Arrays
Data_Array_Name , Data_Array_Format , Data_Array_Length
DA_AI_01 , Float , 200
DA_AO_01 , Float , 200
DA_DI_01 , Bit , 200
DA_DO_01 , Bit , 200
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 6 of 16
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The
information that follows describes how to expand upon the factory defaults provided in the configuration files
included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate
with a Modbus TCP Server.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable
the FieldServer for Modbus TCP communications, the driver independent FieldServer buffers need to be declared
in the “Data Arrays” section, the destination device addresses need to be declared in the “Client Side Nodes”
section, and the data required from the Servers needs to be mapped in the “Client Side Map Descriptors” section.
Details on how to do this can be found below.
Note that * indicates an optional parameter, with the bold legal value being the default.
Section Title
Connections
Column Title Function Legal Values
Adapter Specify which adapter this protocol uses N1
Protocol Specify protocol used Modbus/TCP
Poll Delay* Time interval between polls 0-32000 s, 0.05 s.
Example:
Connections
Adapter , Protocol , Poll_Delay
N1 , Modbus/TCP , 0.05s
Section Title
Nodes
Column Title Function Legal Values
Up to 32 alphanumeric
Node_Name Provide name for Node
characters
Node_ID Station Address of Remote Server Node 1 – 255
Protocol Specify protocol used Modbus/TCP
Adapter Specify which adapter this protocol uses N1
Valid IP address, e.g.
IP_address IP address of client PLC
192.168.1.13
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 7 of 16
4 If this parameter is not specified the default function codes will be FC 05 (Single_Coil) and FC 06 (Single_Register). Refer to Error! Reference
source not found. for more information.
5 Optional for Modicon 5 digit devices
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 8 of 16
6
Optional only for Modicon_5digit addressing, and only if Single writes do not need to be forced
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 9 of 16
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 10 of 16
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The
information that follows describes how to expand upon the factory defaults provided in the configuration files
included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate
with a Modbus TCP Client.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable
the FieldServer for Modbus TCP communications, the driver independent FieldServer buffers need to be declared
in the “Data Arrays” section, the FieldServer virtual Node(s) needs to be declared in the “Server Side Nodes”
section, and the data to be provided to the clients needs to be mapped in the “Server Side Map Descriptors”
section. Details on how to do this can be found below.
Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.
Section Title
Connections
Column Title Function Legal Values
Adapter Specify which adapter this protocol uses. N1
Protocol Specify protocol used Modbus/TCP
Example:
Connections
Adapter , Protocol
N1 , Modbus/TCP
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 11 of 16
Section Title
Nodes
Column Title Function Legal Values
Up to 32 alphanumeric
Node_Name Provide name for node
characters
Node_ID Node ID of physical server node 1 – 255 (Optional)
Protocol Specify protocol used Modbus/TCP
7 ADU,PDU, -,
Address_Type* Specify Register Mapping Model
Modicon_5digit
No_Response,
Set the FieldServer response to the Modbus TCP Client Old_Data,
Node_Offline_Response when the Server Node supplying the data has gone Zero_Data,
offline FFFF_Data,
Refer to Appendix A.1
Note that for this protocol, the IP address for the FieldServer is configured using the "I" menu option on the
Remote User Interface.
Example
7
Optional for Modicon 5 digit devices
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 12 of 16
8
Optional only for Modicon_5digit addressing, and only if Single writes do not need to be forced
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 13 of 16
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 14 of 16
In systems where data is being collected from multiple Server Nodes and made available on a FieldServer
configured as a Modbus TCP Server, when a Server Node goes offline the default behavior of the FieldServer would
be to stop responding to polls for this data. This might not be what the user wants. Various options exist making it
possible to signal that the data quality has gone bad without creating error conditions in systems sensitive to the
default option.
The following options can be configured under the Node parameter, Node_Offline_Response, to set the response
of the FieldServer to the Modbus TCP Client when the Server Node supplying the data is offline:
No_Response - this is the default option. The FieldServer simply does not respond when the
corresponding Server Node is offline.
Old_Data - The FieldServer will respond, but with the last known value of the data. This maintains the
communication link in an active state, but may hide the fact that the Server Node is offline.
Zero_Data - The FieldServer will respond, but with the data values set to zero. If the user normally expects
non-zero values, this option will signal the offline condition without disrupting communications.
FFFF_Data - The FieldServer will respond, but with the data values set to FFFF (hex). If the user normally
expects other values, this option will signal the offline condition without disrupting communications.
When configured as a Server this parameter can force a desired exception response as follows:
Nodes
Node_Name ,Node_ID ,Protocol , Node_Offline_Response , Port
DEV11 , 11 , Modbus/TCP , No_Response ,-
DEV12 , 12 , Modbus/TCP , Old_Data ,-
DEV15 , 15 , Modbus/TCP , Zero_Data ,-
DEV16 , 16 , Modbus/TCP , FFFF_Data ,-
DEV17 , 17 , Modbus/TCP , Exception_4. ,-
DEV18 , 18 , Modbus/TCP , Gateway_Path_Unavailable ,-
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 15 of 16
Appendix B. Reference
If Node parameter Address_Type is set as ADU or PDU, then Data_Type must be specified as follows
When a Modbus address range is specified, a particular Data Type is implied. The defaults are as follows:
For pure write operations where the function = Wrbc or Wrbx, the driver defaults to using Function Codes 15 and
16 (Multiple writes). To force the driver to use Function Codes 5 and 6 (Single Writes), manipulate the Data_Type
parameter as follows:
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8704-03 Modbus TCP Driver Manual Page 16 of 16
Add a parameter to the Modbus client side Map Descriptor called Data_Type.
If Data_Type is specified as Single_Register and Function as Wrbc or Wrbx, then a Modbus poll with FC 6 will be
generated.
Logically Single Register implies a length of 1, thus the length is limited to 1 in the driver.
When using the driver as a Modbus master, the function RDBC allows read/write capability with Register and Coil
data types. If defaults are used, then Function codes 5 and 6 (Single Writes) are used to write data back to the
registers being read, regardless of data length being read. To enavle If multiple writes (FC 15 and 16) it is
necessary to specify the Node_Type parameter in the Client Side Nodes Section and set it to Block_Mode. Block
writes of length 1 are currently all that is supported.
Message Description/Action
MB_TCP:#01 FYI. Server This message is printed when the TCP frame contains more bytes than a single
response extra bytes Modbus_TCP message but insufficient extra bytes to form a second complete Modbus
ignored. Cnt=%d %#x message. There is no explanation for the 'padding' bytes, but since the Driver ignores
MB_TCP:#02 FYI. the extra bytes and processes the complete message correctly, the message can be
Master poll extra bytes ignored. The driver prints this message once. It is suppressed on subsequent
ignored. Cnt=%d %#x occurrences.
The driver has detected enough bytes in the TCP frame for two complete Modbus_TCP
MB_TCP:#03 Err. TCP
messages. The second message is ignored. If this is a problem, re-configure the
Frame has multiple
remote node so that only one Modbus_TCP message is contained in a single TCP
MB_TCP messages.
frame. The driver prints this message once. It is suppressed on subsequent
Ignored 2nd
occurrences
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com