Anybus CompactCom 40 Modbus-TCP Installation and maintenance instructions

Anybus®CompactCom™40
Modbus-TCP ®Transparent Ethernet
NETWORK GUIDE
SCM-1202-022 1.1 ENGLISH

Important User Information
Liability
Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks AB of any
inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial
Networks AB, reserve the right to modify our products in line with our policy of continuous product development.
The information in this document is subject to change without notice and should not be considered as a commit-
ment by HMS Industrial Networks AB. HMS Industrial Networks AB assumes no responsibility for any errors that
may appear in this document.
There are many applications of this product. Those responsible for the use of this device must ensure that all the
necessary steps have been taken to verify that the applications meet all performance and safety requirements in-
cluding any applicable laws, regulations, codes, and standards.
HMS Industrial Networks AB will under no circumstances assume liability or responsibility for any problems that
may arise as a result from the use of undocumented features, timing, or functional side effects found outside the
documented scope of this product. The effects caused by any direct or indirect use of such aspects of the product
are undefined, and may include e.g. compatibility issues and stability issues.
The examples and illustrations in this document are included solely for illustrative purposes. Because of the many
variables and requirements associated with any particular implementation, HMS Industrial Networks AB cannot as-
sume responsibility for actual use based on these examples and illustrations.
Intellectual Property Rights
HMS Industrial Networks AB has intellectual property rights relating to technology embodied in the product de-
scribed in this document. These intellectual property rights may include patents and pending patent applications in
the USA and other countries.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1
Table of Contents Page
1 Preface ............................................................................................................................... 5
1.1 About this document ......................................................................................................5
1.2 Related Documents .......................................................................................................5
1.3 Document History ..........................................................................................................5
1.4 Document Conventions ..................................................................................................5
1.5 Document Specific Conventions......................................................................................6
1.6 Trademark Information ...................................................................................................7
2 About the Anybus CompactCom 40 Modbus-TCP ................................................. 8
2.1 General.........................................................................................................................8
2.2 Features .......................................................................................................................8
2.3 Transparent Ethernet .....................................................................................................8
3 Basic Operation............................................................................................................. 10
3.1 Software Requirements................................................................................................10
3.2 Device Customization................................................................................................... 11
3.3 Communication Settings...............................................................................................12
3.4 Diagnostics .................................................................................................................12
3.5 Network Data Exchange...............................................................................................12
4 Modbus-TCP Register Implementation ................................................................... 15
4.1 Holding Registers (4x)..................................................................................................15
4.2 Input Registers (3x)......................................................................................................15
4.3 Coils (0x).....................................................................................................................15
4.4 Discrete Inputs (1x)......................................................................................................15
5 Modbus-TCP Functions............................................................................................... 16
5.1 Read Coils ..................................................................................................................17
5.2 Read Discrete Inputs....................................................................................................17
5.3 Read Holding Registers................................................................................................17
5.4 Read Input Registers....................................................................................................18
5.5 Write Single Coil ..........................................................................................................18
5.6 Write Single Register....................................................................................................18
5.7 Write Multiple Coils ......................................................................................................18
5.8 Write Multiple Registers................................................................................................19
5.9 Read/Write Multiple Registers.......................................................................................19
5.10 Read Device Identification ............................................................................................19

Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1
Table of Contents
6 Transparent Ethernet ................................................................................................... 20
6.1 General Information .....................................................................................................20
6.2 Enabling Transparent Ethernet......................................................................................21
6.3 MAC Address Synchronization......................................................................................21
6.4 IP Configuration Synchronization ..................................................................................21
6.5 Routing Restrictions.....................................................................................................21
7 Firmware Upgrade ....................................................................................................... 23
8 Anybus Module Objects .............................................................................................. 24
8.1 General Information .....................................................................................................24
8.2 Anybus Object (01h) ....................................................................................................25
8.3 Diagnostic Object (02h) ................................................................................................27
8.4 Network Object (03h) ...................................................................................................28
8.5 Network Configuration Object (04h)...............................................................................29
8.6 Anybus File System Interface Object (0Ah) ....................................................................38
8.7 Network Ethernet Object (0Ch) .....................................................................................39
9 Host Application Objects ............................................................................................ 40
9.1 General Information .....................................................................................................40
9.2 Modbus Host Object (FAh)............................................................................................41
9.3 Ethernet Host Object (F9h) ...........................................................................................44
A Categorization of Functionality ................................................................................. 49
A.1 Basic...........................................................................................................................49
A.2 Extended.....................................................................................................................49
B Implementation Details................................................................................................ 50
B.1 SUP-Bit Definition ........................................................................................................50
B.2 Anybus State Machine .................................................................................................50
B.3 Application Watchdog Timeout Handling........................................................................50
C Secure HICP (Secure Host IP Configuration Protocol) ....................................... 51
C.1 General.......................................................................................................................51
C.2 Operation ....................................................................................................................51
D Technical Specification ............................................................................................... 52
D.1 Front View...................................................................................................................52
D.2 Functional Earth (FE) Requirements..............................................................................54
D.3 Power Supply ..............................................................................................................54
D.4 Environmental Specification..........................................................................................54
D.5 EMC Compliance.........................................................................................................54

Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1
Table of Contents
E Backward Compatibility .............................................................................................. 55
E.1 Initial Considerations....................................................................................................55
E.2 Hardware Compatibility ................................................................................................56
E.3 General Software.........................................................................................................60
E.4 Network Specific — Modbus-TCP .................................................................................62
F Copyright Notices ......................................................................................................... 64

This page intentionally left blank

Preface 5 (70)
1 Preface
1.1 About this document
This document is intended to provide a good understanding of the functionality offered by the
Anybus CompactCom 40 Modbus-TCP. The document describes the features that are specific
to Anybus CompactCom 40 Modbus-TCP. For general information regarding Anybus Compact-
Com, consult the Anybus CompactCom design guides.
The reader of this document is expected to be familiar with high level software design and com-
munication systems in general. The information in this network guide should normally be suffi-
cient to implement a design. However if advanced Modbus-TCP specific functionality is to be
used, in-depth knowledge of Modbus-TCP networking internals and/or information from the offi-
cial Modbus-TCP specifications may be required. In such cases, the persons responsible for
the implementation of this product should either obtain the Modbus-TCP specification to gain
sufficient knowledge or limit their implementation in such a way that this is not necessary.
For additional related documentation and file downloads, please visit the support website at
www.anybus.com/support.
1.2 Related Documents
Document Author Document ID
Anybus CompactCom 40 Software Design Guide HMS HMSI-216-125
Anybus CompactCom M40 Hardware Design Guide HMS HMSI-216-126
Anybus CompactCom B40 Design Guide HMS HMSI-27-230
Anybus CompactCom Host Application Implementation
Guide
HMS HMSI-27-334
Anybus CompactCom 40 Modbus-TCP Network Guide HMS SCM-1202-027
1.3 Document History
Version Date Description
1.0 2017-01-17 First release
1.1 2017-07-11 Added appendix on backward compatibility
Updated description of module status LED
1.4 Document Conventions
Ordered lists are used for instructions that must be carried out in sequence:
1. First do this
2. Then do this
Unordered (bulleted) lists are used for:
• Itemized information
• Instructions that can be carried out in any order
...and for action-result type instructions:
► This action...
➨leads to this result
Bold typeface indicates interactive parts such as connectors and switches on the hardware, or
menus and buttons in a graphical user interface.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Preface 6 (70)
Monospaced text is used to indicate program code and other
kinds of data input/output such as configuration scripts.
This is a cross-reference within this document: Document Conventions, p. 5
This is an external link (URL): www.hms-networks.com
This is additional information which may facilitate installation and/or operation.
This instruction must be followed to avoid a risk of reduced functionality and/or
damage to the equipment, or to avoid a network security risk.
Caution
This instruction must be followed to avoid a risk of personal injury.
WARNING
This instruction must be followed to avoid a risk of death or serious injury.
1.5 Document Specific Conventions
• The terms “Anybus” or “module” refers to the Anybus CompactCom module.
• The terms “host” or “host application” refer to the device that hosts the Anybus.
• Hexadecimal values are written in the format NNNNh or 0xNNNN, where NNNN is the hex-
adecimal value.
• A byte always consists of 8 bits.
• The terms “basic” and “extended” are used to classify objects, instances and attributes.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Preface 7 (70)
1.6 Trademark Information
Anybus®is a registered trademark of HMS Industrial Networks AB.
All other trademarks are the property of their respective holders.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

About the Anybus CompactCom 40 Modbus-TCP 8 (70)
2 About the
Anybus CompactCom 40 Modbus-TCP
2.1 General
The Anybus CompactCom 40 Modbus-TCP communication module provides instant Ethernet
and Modbus-TCP connectivity via the patented Anybus CompactCom host interface. Any de-
vice that supports this standard can take advantage of the features provided by the module, al-
lowing seamless network integration regardless of network type.
This network guide covers the Transparent Ethernet version of the product.
Transparent Ethernet has to be enabled during setup, or the device will appear as
an Anybus CompactCom 40 with full IT functionality. The IT functionality is
described in the network guide for the standard Anybus CompactCom 40.
IT functionality is not available when Transparent Ethernet is enabled.
The modular approach of the Anybus CompactCom 40 platform allows the CIP-object imple-
mentation to be extended to fit specific application requirements. Furthermore, the Identity Ob-
ject can be customized, allowing the end product to appear as a vendor-specific
implementation rather than a generic Anybus module.
This product conforms to all aspects of the host interface for Anybus CompactCom 40 modules
defined in the Anybus CompactCom 40 Hardware and Software Design Guides, making it fully
interchangeable with any other device following that specification. Generally, no additional net-
work related software support is needed, however in order to be able to take full advantage of
advanced network specific functionality, a certain degree of dedicated software support may be
necessary.
2.2 Features
• Transparent Ethernet
• Two Ethernet ports
• Ethernet connectors
• 10/100 Mbit, full/half duplex operation
• Modbus-TCP server/slave (up to 4 simultaneous connections)
• Max. read process data: 1536 bytes
• Max. write process data: 1536 bytes
• Max. process data (read + write, in bytes): 3072 bytes
• Customizable Identity Information
• Modular Device functionality
2.3 Transparent Ethernet
Transparent Ethernet offers the possibility for a host application, that includes an IT implemen-
tation (web pages, file system, a proprietary protocol etc.), to let the Anybus CompactCom han-
dle an industrial Ethernet protocol (in this case Modbus-TCP), without the need for extra
Ethernet ports.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

About the Anybus CompactCom 40 Modbus-TCP 9 (70)
Ethernet communication is routed straight to the host application system using an RMII inter-
face. The host application must include an Ethernet controller and a TCP/IP stack. Modbus-
TCP protocol messages will be routed to the Anybus CompactCom internal software. Please
note that the Transparent Ethernet functionality has to be enabled during startup by setting at-
tribute #16 (instance #1) in the Anybus Object.
16–bit parallell mode can not be used, as specific host application connector pins are reserved
for transparent Ethernet. Also TCP/UDP ports may be reserved, and can, in that case, not be
used for the transparent Ethernet communication.
See also ...
•Transparent Ethernet, p. 20
• Anybus CompactCom 40 Hardware Design Guide
•Anybus Object (01h), p. 25
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Basic Operation 10 (70)
3 Basic Operation
3.1 Software Requirements
No additional network support code needs to be written in order to support the Anybus Com-
pactCom 40 Modbus-TCP, however due to the nature of the Modbus-TCP networking system,
certain restrictions must be taken into account:
• The total number of ADIs that can be represented on the network depends on their size. By
default, ADIs with instance numbers 1...3839 can be accessed from the network, each with
a size of up to 32 bytes.
• ADI names, types and similar attributes cannot be accessed viaModbus-TCP. They are
however represented on the network through the built in web server.
• A network write access of an ADI mapped to process data will result in a corresponding
write access of the process data buffer of the Anybus CompactCom 40 Modbus-TCP.
• A network read access of an ADI, even if it is mapped to process data, will result in a corre-
sponding Get_Attribute command towards the application.
• Modbus-TCP reset requests are not supported.
• Up to 5 diagnostic instances (See Diagnostic Object) can be created by the host applica-
tion during normal conditions. An additional 6th instance may be created in event of a major
fault.
• Modbus-TCP in itself does not impose any specific timing demands when it comes to acy-
clic requests (i.e. requests towards instances in the Application Data Object), however it is
generally recommended to process and respond to such requests within a reasonable time
period (exactly what this means in practice depends on the implementation and the actual
installation).
• The use of advanced Modbus-TCP specific functionality may require in-depth knowledge
in Modbus-TCP networking internals and/or information from the official Modbus-TCP
specifications. In such cases, the people responsible for the implementation of this product
is expected either to obtain these specifications to gain sufficient knowledge or limit their
implementation is such a way that this is not necessary.
See also...
•Application Data (ADIs), p. 13
•Diagnostic Object (02h), p. 27
• Anybus CompactCom 40 Software Design Guide, “Application Data Object (FEh)”
For in depth information regarding the Anybus CompactCom software interface, consult the
Anybus CompactCom 40 Software Design Guide.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Basic Operation 11 (70)
3.2 Device Customization
3.2.1 Modbus-TCP Implementation
By default, a “Read Device Identification” request returns the following information:
Vendor Name “HMS”
Product Code: “Anybus CompactCom 40 Modbus-TCP”
Major Minor Rev.: The current firmware version of the product
Vendor URL: (no information returned by default)
Product Name: (no information returned by default)
Model Name: (no information returned by default)
User Application
Name:
(no information returned by default)
It is possible to customize this information by implementing the Modbus Host Object. See Mod-
bus Host Object (FAh), p. 41 for more information.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Basic Operation 12 (70)
3.3 Communication Settings
As with other Anybus CompactCom products, network related communication settings are
grouped in the Network Configuration Object (04h).
In this case, this includes...
Ethernet Interface
Settings
By default, the module is set to autonegotiate the physical link settings. It is,
however, possible to force the module to use a specific setting if necessary.
IP Settings These settings must be set properly in order for the module to be able to
participate on the network.
IP settings must be synchronized between the Anybus CompactCom 40 and the
host application.
The module supports DHCP, which may be used to retrieve the IP settings from a
DHCP-server automatically. DHCP is enabled by default, but can be disabled if
necessary.
Modbus-TCP
Connection Timeout
This setting specifies how long a Modbus-TCP connection may be idle before it is
closed by the module (default is 60 seconds).
Process Active
Timeout
This value specifies how long the module shall stay in the ‘PROCESS_ACTIVE’
state after receiving a Modbus-TCP request. SeeNetwork Configuration Object
(04h), p. 29 for more information.
Note: This value can be accessed from the Modbus registers.
Note: This value affects the behavior of the SUP-bit. See SUP-Bit Definition, p. 50.
See also...
Network Configuration Object (04h), p. 29 (Anybus Module Object)
Secure HICP (Secure Host IP Configuration Protocol), p. 51
3.4 Diagnostics
Each instance within the Diagnostic Object (02h) is represented on the network as a dedicated
entry in the Modbus register map (see Input Registers (3x), p. 15).
Note that since each entry corresponds directly to a specific diagnostic instance, it is possible to
have “empty” diagnostic entries in the register map (when read, such entries will return zeroes).
See also...
Input Registers (3x), p. 15
Diagnostic Object (02h), p. 27
3.5 Network Data Exchange
3.5.1 General
It is important to notice that various register areas might have different response times. Gener-
ally queries directed at the process data registers will be answered more quickly than those di-
rected at the ADI-related registers since the former are directly processed by the module itself
whereas the latter are forwarded to the application, which must respond before the module can
respond to the master. In the latter case this will influence the allowable timeout time for the
master to use for these registers.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Basic Operation 13 (70)
3.5.2 Application Data (ADIs)
As mentioned previously, the total number of ADIs that can be represented on the network de-
pends on their size. By default, ADIs with instance numbers 1...3839 can be accessed from the
network, each with a size of up to 32 bytes. It is possible to alter this ratio by changing the num-
ber of ADI indexing bits. See attribute #9, in the Modbus Host Object (FAh), p. 41.).
Example 1 (Default Settings)
In this example, attribute #9 in the Modbus Host Object (FAh) is set to its default value (04h).
Holding Register # ADI No.
1010h... 101Fh 1
1020h... 102Fh 2
1030h... 103Fh 3
1040h... 104Fh 4
... ...
FFE0h... FFEFh 3838
FFF0h... FFFFh 3839
Each ADI is represented using 16 Modbus registers, which means that up to 32 bytes of an ADI
can be accessed from the network.
Example 2 (Customized Implementation)
In this example, attribute #9 in the Modbus Host Object (FAh) is set to 05h.
Holding Register # ADI No.
1010h... 102Fh 1
1030h... 104Fh 2
1050h... 106Fh 3
1070h... 108Fh 4
... ...
FFB0h... FFCFh 1918
FFD0h... FFEFh 1919
Each ADI is represented using 32 Modbus registers, which means that up to 64 bytes of an ADI
can be accessed from the network.
3.5.3 Process Data
Modbus does not feature a dedicated cyclic data channel in the same sense as many other net-
works. In the Anybus CompactCom 40 implementation, process data can however still be ac-
cessed from the network via dedicated entries in the Modbus register map.
Process data can be accessed on a bit by bit basis (as Coils & Discrete Inputs) - or - as 16 bit
entities (Holding Registers & Input Registers).
For natural reasons, writing to the write process data register area has no effect, and reading un-
used register locations will return zeroes.
Example
Each 16-bit Modbus register contains 2 bytes from the process data at the corresponding ad-
dress, i.e. Modbus register N holds process data byte (N*2) in the low byte and (N*2 + 1) in the
high byte.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Basic Operation 14 (70)
Process Data Modbus Register
Byte Type Value Register Value Comment
0 UINT16 1234h 0 1234h -
1
2 UINT8 00h 1 FF00h Two bytes from the process data in one
register.
3 UINT8 FFh
4 UINT32 112233-
44h
2 3344h LSB
* A 32-bit type occupies two Modbus
* registers.
MSB
5
6 3 1122h
7
8 BOOL[3] 01h 4 0001h -
9 00h
10 01h 5 3401h -
11 UINT16 1234h
12 6 0012h High byte from unmapped process data
is set to zero.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Modbus-TCP Register Implementation 15 (70)
4 Modbus-TCP Register Implementation
4.1 Holding Registers (4x)
Range Contents Notes
0000h...02FFh Read Process Data (1536
bytes)
-
0300h...07FFh Reserved -
0800h...0AFFh Write Process Data (1536
bytes)
-
0B00h...0FFFh Reserved -
1000h...1002h Reserved -
1003h Process Active Timeout See Network Configuration Object (04h), p. 29
1004h Enter/Exit Idle Mode 0: Not Idle, >0: Idle
1005h...100Fh Reserved -
1010h...101Fh ADI Number 1 See Application Data (ADIs), p. 13
1020h...102Fh ADI Number 2
... ...
FFF0h...FFFFh ADI Number 3839
4.2 Input Registers (3x)
Range Contents Notes
0000h...02FFh Write Process Data -
0300h...07FFh Reserved -
0800h Diagnostic Event Count Number of pending diagnostic events.
There may be "gaps" between active diagnostic events.
Inactive diagnostic events return 0000h when read.
0801h Diagnostic Event #1 These registers corresponds to instances in the Diagnos-
tic Object (02h), see Diagnostic Object (02h), p. 27.
High byte = Severity
Low byte = Event Code
0802h Diagnostic Event #2
0803h Diagnostic Event #3
0804h Diagnostic Event #4
0805h Diagnostic Event #5
0806h Diagnostic Event #6
4.3 Coils (0x)
Range Contents Notes
0000h...2FFFh Read Process Data -
3000h...7FFFh Reserved -
4.4 Discrete Inputs (1x)
Range Contents Notes
0000h...2FFFh Write Process Data -
3000h...07FFh Reserved -
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Modbus-TCP Functions 16 (70)
5 Modbus-TCP Functions
The following Modbus-TCP functions are implemented in the module:
# Function
1 Read Coils
2 Read Discrete Inputs
3 Read Holding Registers
4 Read Input Registers
5Write Single Coil
6 Write Single Register
15 Write Multiple Coils
16 Write Multiple Registers
23 Read/Write Multiple Registers
43/14 Read Device Identification
Exception Codes:
Code Name Description
0x01 Illegal function The function code in the query is not supported
0x02 Illegal data address The data address received in the query is outside the initialized memory
area
0x03 Illegal data value The data in the request is illegal
See also...
Modbus Host Object (FAh), p. 41
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Modbus-TCP Functions 17 (70)
5.1 Read Coils
Function Code: 1
Register Type: 0x (Coils)
Details
This function is mapped to the Read Process data as follows:
Coil #
Process Data Byte
# Bit #
0000h 0000h 0
0001h 1
0002h 2
0003h 3
... ...
0007h 7
0008h 0001h 0
0009h 1
000Ah 2
000Bh 3
... ...
000Fh 7
... ... ...
2FF8h 05FFh 0
2FF9h 1
2FFAh 2
2FFBh 3
... ...
2FFFh 7
5.2 Read Discrete Inputs
Function Code: 2
Register Type: 1x (Discrete Inputs)
Details
This function is mapped to the Write Process data; the mapping is otherwise identical to that of
the “Read Coils” function described above.
5.3 Read Holding Registers
Function Code: 3
Register Type: 4x (Holding Registers)
Details
Mapped to Read- and Write Process Data, ADIs, and configuration registers. It is allowed to
read parts of a larger Anybus CompactCom data type; it is also allowed to read multiple ADIs
using a single request.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1

Modbus-TCP Functions 18 (70)
5.4 Read Input Registers
Function Code: 4
Register Type: 3x (Input Registers)
Details
Mapped to Write Process Data and diagnostic events.
5.5 Write Single Coil
Function Code: 5
Register Type: 0x (Coils)
Details
This function is mapped to the Read Process data, and the mapping is identical to that of the
“Read Coils” function described above.
5.6 Write Single Register
Function Code: 6
Register Type: 4x (Holding Registers)
Details
Mapped to Read- and Write Process Data, ADIs and configuration registers. ADIs must be writ-
ten as a whole, however the Process Data area accepts writes of any size.
5.7 Write Multiple Coils
Function Code: 15
Register Type: 0x (Coils)
Details
This function is mapped to the Read Process data, and the mapping is identical to that of the
“Read Coils” function described above.
Anybus®CompactCom™40 Modbus-TCP ®Transparent Ethernet Network Guide SCM-1202-022 1.1