X-Gateway Modbus-TCP EtherNet IP user manual

X-Gateway Modbus-TCP EtherNet IP user manual
User Manual
®
Anybus X-gateway Modbus-TCP
EtherNet/IP
Doc.Id. HMSI-168-43
Rev. 1.11
Connecting DevicesTM
+$/067$'‡&+,&$*2‡.$5/658+(‡72.<2‡%(,-,1*‡0,/$12‡08/+286(‡&29(175<‡381(‡&23(1+$*(1
HMS Industrial Networks
Mailing address: Box 4126, 300 04 Halmstad, Sweden
Visiting address: Stationsgatan 37, Halmstad, Sweden
E-mail: [email protected]
Web: www.anybus.com
Important User Information
This document is intended to provide a good understanding of the functionality offered by the Anybus X-gateway
Modbus-TCP - EtherNet/IP. The reader of this document is expected to be familiar with high level software design,
and communication systems in general.
Liability
Every care has been taken in the preparation of this manual. 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 commitment 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 including 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
assume 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 described in this document. These intellectual property rights may include patents and pending patent applications
in the US and other countries.
Trademark Acknowledgements
Anybus ® is a registered trademark of HMS Industrial Networks AB. All other trademarks are the property of their
respective holders.
Warning:
This is a class A product. in a domestic environment this product may cause radio interference in
which case the user may be required to take adequate measures.
ESD Note: This product contains ESD (Electrostatic Discharge) sensitive parts that may be damaged if ESD
control procedures are not followed. Static control precautions are required when handling the product. Failure to observe this may cause damage to the product.
Warning:
DO NOT USE SD CARD OR USB CONNECTOR WHILE CIRCUIT IS LIVE UNLESS THE AREA IS
KNOWN TO BE FREE OF IGNITABLE CONCENTRATIONS OF FLAMMABLE GAS OR VAPORS.
Anybus X-gateway Modbus-TCP - EtherNet/IP User Manual
Rev 1.11
Copyright© HMS Industrial Networks AB
Nov 2012 Doc Id HMSI-168-43
Table of Contents
Preface
About This Document ..................................................................... 6
Related Documents..................................................................................................................... 6
Document History ...................................................................................................................... 6
Conventions & Terminology..................................................................................................... 7
Sales and Support ........................................................................................................................ 8
Chapter 1
Getting Started ................................................................................. 9
Chapter 2
Anybus X-gateway Modbus-TCP ...................................................10
Introduction ............................................................................................................................... 10
Features....................................................................................................................................... 11
Configuring the EtherNet/IP Network ................................................................................ 11
EtherNet/IP Electronic Data Sheet (EDS-file) ................................................................... 11
Functional Overview ................................................................................................................ 12
Data Exchange........................................................................................................................... 13
I/O Mapped Data ..................................................................................................................... 14
Parameter Data .......................................................................................................................... 14
Control/Status Word................................................................................................................ 14
Live List ...................................................................................................................................... 15
Transaction Status List ............................................................................................................. 16
Exception Code List ................................................................................................................. 17
Chapter 3
About the Anybus X-gateway Modbus-TCP ..................................18
External View ............................................................................................................................ 18
Mounting the X-gateway .......................................................................................................... 19
DIN-rail Mounting .......................................................................................................... 19
Wall Mounting................................................................................................................. 20
Status LEDs ............................................................................................................................... 21
EtherNet/IP Connectors......................................................................................................... 22
USB Connector.......................................................................................................................... 22
Modbus-TCP Connectors........................................................................................................ 22
Power Connector ...................................................................................................................... 23
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 4
SD Card Functionality.................................................................... 24
General Advice and Guidelines............................................................................................... 24
Starting Up.................................................................................................................................. 24
Easy Backup ............................................................................................................................... 25
Simple Configuration Copy ..................................................................................................... 25
Easy Replacement...................................................................................................................... 25
SD Card Synchronization Failure ........................................................................................... 26
Chapter 5
Modbus-TCP Functions................................................................. 27
Chapter 6
Network Configuration .................................................................. 28
General Information ................................................................................................................. 28
Introduction ............................................................................................................................... 29
Overview..................................................................................................................................... 30
Home................................................................................................................................ 31
Configuration ............................................................................................................................. 32
Authentication .................................................................................................................. 32
Modbus Client .................................................................................................................. 33
Modbus Servers................................................................................................................. 34
EtherNet/IP (Adapter Interface)...................................................................................... 37
Tools........................................................................................................................................... 38
X-gateway Management .................................................................................................... 38
Backup and Restore .......................................................................................................... 38
Mapping Overview ............................................................................................................ 39
Mapping Overview Example............................................................................................. 39
Transaction Monitor ......................................................................................................... 41
Chapter 7
CIP Objects .................................................................................... 42
General Information ................................................................................................................. 42
Identity Object (01h)................................................................................................................. 43
Message Router (02h) ............................................................................................................... 45
Assembly Object (04h) ............................................................................................................. 46
Connection Manager (06h) ...................................................................................................... 48
DLR Object (47h) ..................................................................................................................... 51
QoS Object (48h) ...................................................................................................................... 52
ADI Object (A2h) ..................................................................................................................... 53
Port Object (F4h) ...................................................................................................................... 55
TCP/IP Interface Object (F5h) .............................................................................................. 56
Ethernet Link Object (F6h) ..................................................................................................... 59
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
V
Appendix A Technical Specification .................................................................. 61
Protective Earth (PE) Requirements...................................................................................... 61
Power Supply ............................................................................................................................. 61
Environmental Specification ................................................................................................... 61
Temperature...................................................................................................................... 61
Relative Humidity............................................................................................................. 61
EMC (CE) Compliance ............................................................................................................ 62
Appendix B Anybus IPconfig Tool .................................................................... 63
Appendix C Copyright Notices .......................................................................... 64
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Preface
P. About This Document
For more information, documentation etc., please visit the HMS website, www.anybus.com.
P.1 Related Documents
Document
Modbus Application Protocol Specification V1.1B
The EtherNet/IP Specification, vol 1 & 2
Author
Modbus Organization
ODVA
P.2 Document History
Summary of Recent Changes (1.10... 1.11)
Change
Altered information to reflect changes in the EtherNet/IP (Adapter Interface) functionality
Page(s)
37
Revision List
Revision
1.00
1.01
1.10
1.11
Date
2011-04-26
2011-06-28
2012-11-21
2012-11-30
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Author(s)
KaD
KaD
KaD
KaD
Chapter(s)
4, 6, B
2, 3, 5, 6, B
6
Description
First official release
Added chapter 4, minor corrections and updates
Major update
Minor update
Doc.Id. HMSI-168-43
About This Document P-7
P.3 Conventions & Terminology
The following conventions are used throughout this manual:
•
Numbered lists provide sequential steps
•
Bulleted lists provide information, not procedural steps
•
The terms ‘Anybus’, ‘X-gateway’ or ‘module’ refers to the Anybus X-gateway module
•
Hexadecimal values are written in the format NNNNh, where NNNN is the hexadecimal value
•
A byte always consists of 8 bits
•
The terms ‘master’, ‘scanner’, ‘client’ and ‘controller’ will be used interchangeably to describe a
controlling unit on the network
•
The terms ‘slave’, ‘adapter’, ‘server’ and ‘device’ will be used interchangeably to describe units
that are controlled by controlling units on the network
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
About This Document P-8
P.4 Sales and Support
Sales
Support
HMS Sweden (Head Office)
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+46 (0) 35 - 17 29 56
Phone:
+46 (0) 35 - 17 29 20
Fax:
+46 (0) 35 - 17 29 09
Online:
Fax:
+46 (0) 35 - 17 29 09
Online:
www.anybus.com
HMS North America
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+1-312 - 829 - 0601
Phone:
+1-312-829-0601
Toll Free:
+1-888-8-Anybus
Toll Free:
+1-888-8-Anybus
Fax:
+1-312-629-2869
Fax:
+1-312-629-2869
Online:
www.anybus.com
Online:
HMS Germany
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+49 (0) 721-96472-0
Phone:
+49 (0) 721-96472-0
Fax:
+49 (0) 721-96472-10
Fax:
+49 (0) 721-96472-10
Online:
www.anybus.de
Online:
www.anybus.de
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+81 (0) 45-478-5340
Phone:
+81 (0) 45-478-5340
HMS Japan
Fax:
+81 (0) 45-476-0315
Fax:
+81 (0) 45-476-0315
Online:
www.anybus.jp
Online:
www.anybus.jp
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+86 (0) 10-8532-3183
Phone:
+86 (0) 10-8532-3023
HMS China
Fax:
+86 (0) 10-8532-3209
Fax:
+86 (0) 10-8532-3209
Online:
www.anybus.cn
Online:
www.anybus.cn
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+39 039 59662 27
Phone:
+39 039 59662 27
HMS Italy
Fax:
+39 039 59662 31
Fax:
+39 039 59662 31
Online:
www.anybus.it
Online:
www.anybus.it
HMS France
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+33 (0) 3 68 368 034
Phone:
+33 (0) 3 68 368 033
Fax:
+33 (0) 3 68 368 031
Fax:
+33 (0) 3 68 368 031
Online:
www.anybus.fr
Online:
www.anybus.fr
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+44 (0) 1926 405599
Phone:
+46 (0) 35 - 17 29 20
Fax:
+44 (0) 1926 405522
Fax:
+46 (0) 35 - 17 29 09
Online:
www.anybus.co.uk
Online:
www.anybus.com
HMS UK & Eire
HMS Denmark
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+45 (0) 22 30 08 01
Phone:
+46 (0) 35 - 17 29 20
Fax:
+46 (0) 35 17 29 09
Fax:
+46 (0) 35 - 17 29 09
Online:
www.anybus.com
Online:
www.anybus.com
E-mail:
[email protected]
E-mail:
[email protected]
Phone:
+91 (0) 20 40111201
Phone:
+46 (0) 35 - 17 29 20
Fax:
+91 (0) 20 40111105
Fax:
+46 (0) 35 - 17 29 09
Online:
www.anybus.com
Online:
www.anybus.com
HMS India
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 1
1. Getting Started
The purpose of this chapter is to give a short description on how to install the X-gateway and get it up
and running, transferring I/O data between the Modbus-TCP network and the EtherNet/IP (slave) network.
Perform the following steps when installing the module:
1. Mount the module. See “Mounting the X-gateway” on page 19 for details.
2. Connect the X-gateway to the Modbus-TCP network. See “External View” on page 18.
3. Connect the power cable and apply power.
4. Access the configuration web pages.
• Connect a PC to the Modbus-TCP network (see “External View” on page 18) and open a
web browser. Enter the IP address of the X-gateway and access the configuration web pages.
If the IP address of the X-gateway is unknown, start the Anybus IPconfig tool to find it. See
“Anybus IPconfig Tool” on page 63.
• Configure the Modbus-TCP client. See “Modbus Client” on page 33.
• Set up all Modbus servers and transactions using the configuration web pages. See “Modbus
Servers” on page 34 and “Network Configuration” on page 28.
• Configure the X-gateway adapter interface. See “EtherNet/IP (Adapter Interface)” on page
37.
5. Download the appropriate EDS file from www.anybus.com. See “EtherNet/IP Electronic Data
Sheet (EDS-file)” on page 11.
6. Configure the EtherNet/IP scanner. See “Configuring the EtherNet/IP Network” on page 11.
7. Connect the X-gateway to the EtherNet/IP (slave) network. See “External View” on page 18.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 2
2. Anybus X-gateway Modbus-TCP
2.1 Introduction
The Anybus X-gateway Modbus-TCP is a series of network gateways, used to provide a seamless connection between a Modbus-TCP network and a controlling network. This particular product connects a
Modbus-TCP network to an EtherNet/IP network. The X-gateway enables the master of the EtherNet/IP network to control the Modbus-TCP network. These X-gateways makes it possible to integrate
Modbus-TCP devices into almost any other PLC system and their supported networks.
The X-gateway is based on patented Anybus
technology, a proven industrial communication solution used all over the world by leading manufacturers of industrial automation
products. Each module offers Modbus-TCP
master connectivity to one of these industrial
networks: EtherNet/IP, ControlNet, CCLink, Modbus RTU, Modbus-TCP, EtherCAT, CANopen, PROFINET, DeviceNet
and PROFIBUS DP-V1.
No proprietary configuration software is
needed. All necessary configuration is made
via the built-in web interface.
Control Network
Master
(e.g. PLC)
Slave
Anybus X-gateway
Modbus-TCP
Slave
Slave
Slave
Control
Network
Slave
Modbus-TCP
Master
Slave
Slave
Slave
Slave
The EtherNet/IP fieldbus adapter interface
is configured with a standard device descrip- Device Level with Modbus-TCP Slaves
tion file (GSD/EDS) and the standard engineering tool of the PLC. No programming is required.
The X-gateway transmits I/O data transparently between the two networks.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 11
2.2 Features
Anybus X-gateways for Modbus-TCP act as intelligent links between two industrial networks. On the
Modbus-TCP network, they function as clients (masters) while they function as servers (slaves) on the
EtherNet/IP network. The implementation is based on the Anybus NP30 ASIC technology.
2.3 Configuring the EtherNet/IP Network
The Anybus X-gateway Modbus-TCP is an EtherNet/IP adapter (slave) on the EtherNet/IP network.
The general settings for the adapter interface are configured using the configuration web pages (see
“EtherNet/IP (Adapter Interface)” on page 37). All data transfers must be configured using the EtherNet/IP configuration tool. Please note that the size of the I/O data that can be read from and written
to the module is defined when configuring the X-gateway using the configuration web pages.
There are a number of different configuration tools for EtherNet/IP available on the market. The
choice of tool depends on the application and the EtherNet/IP scanner of the network. An .EDS file
for the adapter interface is available at ‘www.anybus.com’.
An application note, describing how to configure an Anybus EtherNet/IP slave interface with RS Logix
and RS Networx, is available on the support pages for the Anybus X-gateway Modbus-TCP - EtherNet/
IP module at ‘www.anybus.com’.
2.4 EtherNet/IP Electronic Data Sheet (EDS-file)
Each device in a EtherNet/IP network is associated with an Electronic Data Sheet (an EDS file), which
describes the implementation of the product. This file is used by the network configuration tool during
network configuration.
The latest version of the EDS file for the Anybus X-gateway EtherNet/IP interface can be downloaded
from the HMS website, ‘www.anybus.com’.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 12
2.5 Functional Overview
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Industrial network
Anybus network
slave interface
Anybus Modbus-TCP
Master Interface
Modbus-TCP network
Internally, the X-gateway consists of an intelligent gateway platform, an Anybus Modbus-TCP interface
and an Anybus EtherNet/IP (slave) interface. The Modbus-TCP interface and the Anybus EtherNet/
IP (slave) interface are interconnected through the intelligent gateway platform, which basically forwards
data from one network to the other and vice versa as shown below. This design allows almost any other
industrial network to be connected to a Modbus-TCP master on a separate Modbus-TCP network.
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 13
2.6 Data Exchange
Each of the two network interfaces exchanges data on its network through two buffers. The X-gateway
forwards the data between these buffers as shown below. Note that this process is separated from the
network data exchange. While the X-gateway ensures data consistency (where applicable), it does not
feature any built-in mechanisms for synchronization between the Modbus-TCP network and the EtherNet/IP network.
Modbus-TCP Network Interface
Data From
the Modbus-TCP
Network
Industrial Network Interface
Control Word
Data From
the Modbus-TCP
Network
Data to
the Modbus-TCP
Network
Industrial network
Modbus-TCP network
Status Word
Data To
the Modbus-TCP
Network
Each buffer holds a maximum of 256 bytes of data. The first two I/O mapped bytes in either direction
can be dedicated for control/status information, and another eight bytes of data coming from the Modbus-TCP network can feature a live list. Please note that the actual number of bytes that can be exchanged is highly network dependent.
Through the dedicated control word, the scanner on the EtherNet/IP network starts/stops the exchange of data on the Modbus-TCP network, and also resets the X-gateway if needed. The scanner on
the EtherNet/IP network can see the status of the Modbus-TCP network in the corresponding status
word. The live list feature gives the scanner on the EtherNet/IP network the opportunity to continuously see and monitor the status of each individual transaction on the Modbus-TCP network.
Two additional lists, transaction status and exception codes, retrievable from the module by the scanner
on the EtherNet/IP network, provides detailed error information about all transactions.
The amount of data that shall be exchanged, and the use of the control/status word and the live list, is
specified separately for each application. This means that even though up to 256 bytes of data can be
potentially forwarded to an interface, the amount of data that will actually be exchanged on that network
is determined by the Modbus-TCP settings and the limitations of the master side fieldbus.
The available control/status functionality is described below, as well as the live list and the transaction
status and exception code lists. Also note that the terminology and definitions used for different types
of data vary greatly between different networking systems.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 14
2.7 I/O Mapped Data
I/O mapped data is cyclic data, exchanged between the networks and/or devices at a high transfer rate.
It is associated with data that is continuously sent on the network.
2.8 Parameter Data
Parameter data is usually exchanged acyclically, to set or change parameters in devices before or during
normal process. Typical parameter data that can be retrieved from the module by the scanner of the EtherNet/IP network includes the transaction status list and the exception code list.
2.9 Control/Status Word
The Control/Status word is always retrievable using acyclical access. Optionally, the Control/Status
word can also be I/O mapped. If so, it is disabled by default. It can be enabled/disabled when configuring the EtherNet/IP network via the configuration web pages. See “EtherNet/IP (Adapter Interface)” on page 37.
For information about how to access the Control/Status word, either I/O mapped or using parameter
access, see “Mapping Overview” on page 38.
The Control word is a 16-bit word (uint16) used by the EtherNet/IP network to control the Anybus Xgateway and subsequently also the Modbus-TCP network.
Bit
0 (Least significant bit)
1
2-7
8-15
Value
0
1
Set to zero
Set to zero
Description
Puts the X-gateway in idle state
Puts the X-gateway in run state
A reboot of the X-gateway is triggered by a rising edge, i.e. a transition from 0 to 1
Unused
Unused
The Status word is a 16-bit word used by the X-gateway to report its current actual status to the EtherNet/IP network.
Bit
0 (Least significant bit)
1
Value
0
1
-
2-7
8-15
(reserved)
(reserved)
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Description
The X-gateway is in idle state
The X-gateway is in run state
This bit is reflecting the state of bit 1 in the control word
Either 0 or 1
Unused
Unused
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 15
2.10 Live List
The live list features the possibility for the EtherNet/IP network to retrieve a list containing the status
of every transaction on the Modbus-TCP network.
It is accessible using parameter access, and also I/O mapped by default. The I/O mapped live list can
be enabled/disabled when configuring the EtherNet/IP network settings. See “EtherNet/IP (Adapter
Interface)” on page 37. If the I/O mapped live list is enabled, it will occupy either byte 0-7 (control/
status word not enabled) or byte 2-9 (control/status word enabled and mapped to the first two bytes) in
the input data area.
All transactions and their places in the live list are also visible in the Transaction Monitor on the configuration web pages.
The live list consists of a bit array with 64 elements, where each bit corresponds to a transaction on the
Modbus-TCP network as in the table below.
Byte 7
Byte 6-1
Bit 63
Bit 62-56
Bit 55-8
Status of trans- Status of trans- ...
action no 63
action no 62-56
•
Byte 0
Bit 7
Bit 6 - 2
Bit 1
Bit 0
Status of trans- Status of trans- Status of trans- Status of transaction no 7
action no 6 - 2 action no 1
action no 0
Bit set to 1
Transaction successful.
•
Bit set to 0
Transaction not successful.
Note: the reason for the unsuccessful transaction can be found on the corresponding index in
the transaction status list.
The order of the transactions in the live list conforms to the order in which they are stored in the Modbus Server list.
Example
Consider the following configuration:
•
Server 1 : a total of 2 transactions
•
Server 2 : a total of 3 transactions
•
Server 3 : a total of 1 transaction
This scenario will produce a live list as follows (assuming that the transactions are successful):
Bit 63
-
Bit 62 - 6
-
0
0
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Bit 5
Server 3,
transaction 1
1
Bit 4
Server 2,
transaction 3
1
Bit 3
Server 2,
transaction 2
1
Bit 2
Server 2,
transaction 1
1
Bit 1
Server 1,
transaction 2
1
Bit 0
Server 1,
transaction 1
1
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 16
2.11 Transaction Status List
This list holds information about the transactions between the Modbus network and the module, from
the perspective of the module.
It is a list available from the module, which is possible to be retrieved acyclically (using parameter access)
by the EtherNet/IP network. It contains a byte array with 64 elements, where each byte contains a transaction status code as in the table below.
The indexes in the transaction status list correspond completely to the indexes in the transaction live list.
Byte 0
Byte 1
Byte 2-6
Byte 7
Byte 8 - 55
Status of trans- Status of trans- Status of trans- Status of trans- ...
action no 0
action no 1
action no 2-6
action no 7
Byte 56-62
Byte 63
Status of trans- Status of transaction no 56-62 action no 63
Transaction status codes
Transaction Status
Code
0
1
2
3
4
5
6
7
8
9
10
11
12
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Description
Running ok
Gateway idle
No link
Modbus exception
Timeout
Gateway disconnect
Server disconnect
Cannot connect
Modbus header error
Internal gateway error
No valid data
Stop sending data to Modbus server
Unconfigured transaction
Doc.Id. HMSI-168-43
Anybus X-gateway Modbus-TCP 17
2.12 Exception Code List
If Modbus transactions fail, the slaves can respond with an exception code. These can be found in the
exception code list available from the module, possible to be retrieved acyclically (using parameter access) by the EtherNet/IP network. It contains a byte array with 64 elements, where each byte contains
an transaction exception code as in the table below. The indexes in the exception code list correspond
completely to the indexes in the transaction live list.
Byte 0
Exception code
for transaction
no 0
Byte 1
Exception code
for transaction
no 1
Byte 2-6
Exception code
for transaction
no 2 - 6
Byte 7
Exception code
for transaction
no 7
Byte 8-55
Exception code
for transaction
no 8 - 55
Byte 56-62
Exception code
for transaction
no 56 - 62
Byte 63
Exception code
for transaction
no 63
Standard Modbus exception codes
Exception Code
00
01
02
03
04
05
06
08
0A
0B
Description
No error
Illegal function
Illegal data address
Illegal data value
Slave device failure
Acknowledge
Slave device busy
Memory parity error
Gateway path unavailable
Gateway target device failed to respond
Note: The exception codes found in the exception code list are only relevant if the corresponding transaction status codes equals 3: “Modbus exception”. See “Transaction Status List” on page 16 for more
information.
Note: If the slave responds with an exception code not in the list, refer to the documentation of the
slave for details.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 3
3. About the Anybus X-gateway Modbus-TCP
3.1 External View
•
•
A: Power Connector
This connector is used to apply power to the Xgateway. It is also possible to connect protective
earth (PE) to the power connector. See “Power
Connector” on page 23.
A
B
B: SD Card Slot
This slot adds the possibility to store and load configurations from an SD card. See “SD Card Functionality” on page 24.
C
D
•
C: USB Port
This port adds the possibility to connect a PC to the
X-gateway to perform firmware upgrades. See
“USB Connector” on page 22.
•
D: Status LEDs
See “Status LEDs” on page 21.
•
E: DIN-rail Connector
The DIN-rail mechanism fastens the X-gateway to
a DIN-rail and connects the module to protective
earth (PE). See “Mounting the X-gateway” on page
19.
•
E
F
F: EtherNet/IP Connectors
See “EtherNet/IP Connectors” on page 22.
G
•
G: Modbus-TCP Connectors
2-port switch with daisy-chain functionality. See
“Modbus-TCP Connectors” on page 22.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
About the Anybus X-gateway Modbus-TCP 19
3.2 Mounting the X-gateway
The Anybus X-gateway Modbus-TCP can be physically installed either by mounting it onto a DIN-rail
or, if installed in areas exposed to vibration, by mounting it on a wall for more stability.
3.2.1 DIN-rail Mounting
Make sure the DIN-rail fastening mechanism on the back of
the module is in a fixed and closed position, i. e. pushed all the
way up.
To mount the module, first hook it on to the DIN-rail (1),
then push it against the DIN-rail to make it snap on (2).
To unmount the module, a screwdriver is needed. Use the
screwdriver to push the DIN-rail fastening mechanism on the
back of the module down until it locks in a fixed and open position (1). Then unhook the module from the DIN-rail (2).
Note: Do not leave the module with the DIN-rail fastening
mechanism in a fixed and open position. This may eventually
wear the fastening mechanism out so it cannot be used efficiently. Be sure to push the DIN-rail fastening mechanism
back into the fixed and closed position after unmounting the
module.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
About the Anybus X-gateway Modbus-TCP 20
3.2.2 Wall Mounting
Use the wall mounting option if there is a need to place the X-gateway in an environment exposed to
vibration. This way of mounting the module offers more stability than the traditional DIN-rail mounting.
Note: The X-gateway should be fastened in a standing-up position, to ensure a constant air flow.
Note: When mounting the X-gateway to a wall using the wall mount option, do not forget to connect
the module to protective earth (PE) via the power connector. See “Power Connector” on page 23.
Mounting Instructions
Step
1
Description
Visual description
Open up the package containing the wall
mounting accessories.
- One metal frame
- Industrial velcro
- Four plastic vibration dampers
2
Remove the plastic protection from one
side of the velcro.
Attach the velcro to the metal frame.
Attach the four plastic vibration dampers
to the X-gateway, on the side that will face
the wall.
3
Remove the plastic protection from the
other side of the velcro.
4
Turn the X-gateway around, so that the
plastic vibration dampers face downwards.
Fasten the metal frame to the X-gateway
by pressing the frame firmly against the Xgateway, making the two velcro parts
attach to each other.
5
Attach the metal frame and the X-gateway
to a wall using screws and washers (not
enclosed).
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
About the Anybus X-gateway Modbus-TCP 21
3.3 Status LEDs
Note: A test sequence is performed on all LEDs during startup.
Note: An identification LED sequence can be performed on LEDs 1, 5 and 6 by clicking the “Wink
device” button in the X-gateway Management section in the web configuration interface.
X-gateway and Modbus-TCP Network LEDs
LED no
1 - Gateway Status
(GW)
State
Off
Alternating red/green
Flashing green
Green
Flashing red
Red
5 - SD card
Green
(SD)
Flashing red
6 - Modbus-TCP Status Off
(MTCP)
Green
7, 8 - Ethernet Link 1
(LA1), Ethernet Link 2
(LA2)
Flashing red
Red
Off
Flashing green
Flashing yellow
Status
Power off
Missing configuration
Idle
Running
Invalid configuration
Fatal error
Accessing SD card
Failure
Power off
Communicating with Modbus-TCP network
Transaction error or timeout
Fatal error
No link
Receiving/transmitting Ethernet packets
at 100 Mbit
Activity, receiving/transmitting Ethernet
packets at 10 Mbit
EtherNet/IP Network LEDs
LED no
2
3 - EtherNet/IP Network
Status
4- Module Status
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
State
Not used
Off
Green
Flashing green
Red
Flashing red
Off
Green
Flashing green
Red
Flashing red
Status
Power off or no IP address
Online, connection established
Online, no connection
Fatal error
Timeout
Power off
Controlled by a scanner in RUN state
Not configured, or scanner in IDLE state
Fatal error
Recoverable error
Doc.Id. HMSI-168-43
About the Anybus X-gateway Modbus-TCP 22
3.4 EtherNet/IP Connectors
Connectors for the EtherNet/IP network are found at the lower front of the module.
Pin no
1
2
3
6
4, 5, 7, 8
Housing
Description
TX+
TXRX+
RXNot connected
Shield
1
8
3.5 USB Connector
At the upper front of the module there is a USB connector used for firmware upgrades.
Pin no.
1
2
3
4
Housing
Description
+5V Input
USBDM (USB communication signals)
USBDP (USB communication signals)
Signal GND
Cable Shield
2
1
3
4
3.6 Modbus-TCP Connectors
The Modbus-TCP connectors are found at the bottom of the module.
Pin no.
1
2
3
4
5
6
7
8
Housing
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Description
TX+
TXRX+
Not connected
Not connected
RXNot connected
Not connected
Shield
1
8
Doc.Id. HMSI-168-43
About the Anybus X-gateway Modbus-TCP 23
3.7 Power Connector
Pin no.
1
2
3
Description
+24V DC
GND
PE (Protective Earth)
1
2
3
Notes:
•
•
Use 60/75 or 75×C copper (CU) wire only.
The terminal tightening torque must be between 5... 7 lbs-in (0.5... 0.8 Nm)
See also...
- “Power Supply” on page 61.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 4
4. SD Card Functionality
Using an SD card with the X-gateway adds the following features:
•
Easy backup.
Every applied change in the configuration will automatically be saved to the X-gateway and the
SD card. See “Easy Backup” on page 25.
•
Simple configuration copy.
Using the SD card, the configuration on one X-gateway can be copied to other X-gateways. See
“Simple Configuration Copy” on page 25.
•
Easy replacement.
If an X-gateway malfunctions during operation, a replacement module can easily be configured
by moving the SD card to the new module. See “Easy Replacement” on page 25.
A configuration on the X-gateway is saved automatically to the SD card in any of these two events:
•
A configuration is applied in the X-gateway Management section
•
A configuration is restored from a backup file
Important
The SD card acts as a master in the X-gateway. When an X-gateway is turned on with an SD card inserted, and that SD card contains a valid configuration file, the configuration on the SD card will always
overwrite any configuration on the X-gateway.
4.1 General Advice and Guidelines
Turn the power off before inserting or removing an SD card from the X-gateway.
Do not turn the X-gateway off while the SD LED indicates that the SD card is being accessed. Refer to
“Status LEDs” on page 17 for more information.
The X-gateway will not write any data to a write-protected SD card.
4.2 Starting Up
1. Format the SD card for the FAT file system using a PC. The X-gateway cannot use an unformatted SD card.
2. Make sure the SD card is empty and that it is not write-protected.
3. Turn the X-gateway off.
4. Insert the SD card into the SD card slot in the X-gateway.
5. Turn the X-gateway on.
6. Create the configuration. When finished, press the apply button in the X-gateway Management
section to reboot using the new configuration. During the reboot, the latest applied configuration
will automatically be copied and saved to the SD card.
7. Now, the SD card is synchronized with the X-gateway. Both the SD card and the X-gateway contain the latest applied configuration.
Every time a new configuration is applied in the X-gateway Management section, it is also copied to the
SD card to ensure synchronization.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
SD Card Functionality 25
4.3 Easy Backup
Every time a configuration change is applied in the X-gateway Management section using the configuration web pages, the configuration is saved both in the memory of the X-gateway and on the SD card.
This is the easiest way of keeping a continuously updated configuration backup.
4.4 Simple Configuration Copy
If a configuration on one X-gateway needs to be copied to one or more other X-gateways, it is easily
done using an SD card.
1. Turn the X-gateway running the desired configuration off.
2. Remove the SD card from the X-gateway containing the desired configuration and insert it into
another one.
Note 1: The firmware version must be the same or higher in the new X-gateway.
Note 2: The new X-gateway must support the same network type as the first X-gateway.
3. Turn the new X-gateway on. The new X-gateway will automatically start up using the configuration found on the SD card.
Important
If the configuration was protected by authentication information, the same information will be needed
to alter the configuration in the new X-gateway.
4.5 Easy Replacement
If an X-gateway malfunctions during operation, the SD card functionality makes it easy to get the application up and running again fast.
1. Turn the malfunctioning X-gateway off.
2. Replace the old X-gateway with a new one.
Note 1: The firmware version must be the same or higher in the new X-gateway.
Note 2: The new X-gateway must support the same network type as the old X-gateway.
3. Remove the SD card containing the configuration file from the old X-gateway and insert it into
the new one.
4. Turn the new X-gateway on. If the SD card contains a valid configuration file, the X-gateway will
automatically start up using the configuration found on the SD card.
Important
If the configuration was protected by authentication information, the same information will be needed
to alter the configuration in the new X-gateway.
Depending on the settings of the master network, the communication link between the X-gateway and
the master may no longer be valid. X-gateway settings that were configured from outside the configuration web pages will need to be set again.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
SD Card Functionality 26
4.6 SD Card Synchronization Failure
In the event of applying a configuration or restoring a configuration from a backup file, the SD card
synchronization can fail. There are many possible reasons for an SD card write failure:
•
The SD card is write-protected.
•
The configuration file on the SD card is write-protected.
•
The SD card memory is full.
•
The SD card file system is corrupt.
•
The SD card is damaged.
If the SD card write process fails, the reboot cycle of the X-gateway will halt. The GW LED will indicate
“invalid configuration” and the SD LED will indicate “failure”. See “Status LEDs” on page 17.
To eliminate the problem, follow the steps below:
1. Turn the X-gateway off.
2. Remove the SD card. Find the cause of the problem.
3. Insert an SD card.
Note: This SD card must not contain a configuration file. If it does, the configuration on the SD
card will overwrite the configuration on the X-gateway.
4. Turn the X-gateway on. The X-gateway will run the configuration that was applied or restored
when the SD card write process failed.
5. Apply the configuration in the X-gateway Management section to save the configuration to the
SD card.
6. Now, the SD card is synchronized with the X-gateway. Both the SD card and the X-gateway contain the latest applied configuration.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 5
5. Modbus-TCP Functions
The Modbus-TCP protocol is an implementation of the standard Modbus protocol, running on top of
TCP/IP. The same function codes and addressing model are used.
The Anybus X-gateway Modbus-TCP supports a subset of the functions described in the Modbus-TCP
specification.
Modbus-TCP transactions are normally transmitted and received on TCP port no. 502. The X-gateway
features the possibility to set TCP ports individually for each Modbus-TCP server.
For detailed information regarding the Modbus-TCP protocol, consult the Open Modbus-TCP Specification.
The Anybus X-gateway Modbus-TCP supports the following Modbus-TCP functions:
Function Code No. of Bits/Registersa
Read Coils
1
1-2000
Read Discrete Inputs
2
1-2000
Read Holding Registers
3
1-125
Read Input Registers
4
1-125
Write Single Coil
5
1
Write Single Register
6
1
Write Multiple Coils
15
1-1968
Write Multiple Registers
16
1-123
Read/Write Multiple Registers 23
1-125 read
1-121 write
Modbus Function
Direction
Associated with Buffer
Modbus to Gateway Input buffer
Gateway to Modbus Output buffer
Bidirectional
Input and output buffers
a. Please refer to the Modbus Application Protocol Specification V1.1B for more detailed information.
Modbus-TCP functions are used as important parts of transactions to Modbus-TCP servers. After configuring a server within the Modbus-TCP network, functions can be assigned to it by clicking the ‘Add
transaction’ button in the built-in web interface.
See also...
•
“Network Configuration” on page 28
•
“Modbus Servers” on page 34
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 6
6. Network Configuration
6.1 General Information
The Anybus X-gateway features built-in web pages for easy configuration. The web pages are all described in this chapter. To access the web configuration pages, the following system requirements need
to be met:
•
Internet Explorer 8.0 or 9.0
•
Javascript enabled
Note: Altering the configuration while the X-gateway is exchanging data between the two networks may
affect performance.
Note: Only one user at a time should be accessing the configuration web pages. If two or more users
make simultaneous changes to the configuration, the configuration saved last will overwrite other changes.
There are things to take into consideration when making the configuration.
•
Remember to apply the configuration in order for changes to take effect. See “X-gateway Management” on page 38. As soon as you have saved data to the configuration but not yet applied it,
you will see the box below at the top of the web pages:
•
A maximum of 64 Modbus-TCP servers can be added to the configuration.
•
A maximum of 64 transactions can be set up to the servers in the configuration.
•
Take care when choosing scan times for the transactions. The mimimum allowed scan time (ms)
is the total number of transactions multiplied by three and cannot be less than 10 ms.
•
Take care not to map too much data. The data limits are 256 bytes input data and 256 bytes output data, including optional control/status word and live list.
Anybus X-gateway Modbus-TCP - EtherNet/IP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 29
6.2 Introduction
To display the configuration and status web pages of the X-gateway, start a web browser and type the
IP address of the module in the address field.
The default IP address of the X-gateway is 192.168.0.100. To connect a computer to the X-gateway,
make sure that both the computer and the module are using the same subnet mask, e.g. 255.255.255.0.
Change the IP address of the computer to 192.168.0.X, where X is any number between 0 and 255 except 100.
If, for example, there is a DHCP server on the network, the IP address might be unknown. In that case,
use the Anybus IPconfig tool to find it. The Anybus IPconfig tool can be downloaded from www.anybus.com.
If a list of connected devices does not show automatically, press the scan button. Identify the IP address
of the X-gateway by its type ‘Anybus X-gateway Modbus-TCP’ or by its MAC address. The MAC address of the X-gateway can be found at the bottom of the module.
For additional information about the Anybus IPconfig tool, see “Anybus IPconfig Tool” on page 63.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 30
6.3 Overview
The configuration and status web pages are divided into three sections:
1
3
2
1. Headline Section
Shows the Anybus logo and the name of the product.
2. Navigation Section
All functionality is easily accessed from the different links. Every link and its corresponding functionality will be explained later in this chapter.
3. Content Section
Clicking a link will display its contents in the content section. A short text describing the functionality of the current page will be available at the top of the section.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 31
6.3.1 Home
The introductory window of the configuration and status web pages presents important error tracking
information, as well as general information and statistics.
Operation Mode
The table below shows the correlation between the operation modes of the Modbus-TCP network and
the EtherNet/IP network.
Modbus-TCP
(Network 2)
Run
Idle
EtherNet/IP (Network 1)
I/O data exchanged
No I/O data exchanged
Data is exchanged between the two net- The EtherNet/IP network exchanges no
works.
data. Data to the Modbus-TCP network is in
clear, freeze, safe value or stop state.
The Modbus-TCP network exchanges no No data is exchanged. Both networks, indedata. Data to the EtherNet/IP network is in pendently, are in clear, freeze, safe value or
clear or freeze state.
stop state.
In case of an error on the EtherNet/IP network, the following additional statuses may appear:
EtherNet/IP (Network 1)
Error
Shutdown
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Description
Class 1 connection error.
Duplicate IP address detected.
Unexpected error (the X-gateway needs a restart).
Doc.Id. HMSI-168-43
Network Configuration 32
6.4 Configuration
Please note that changes made to the configuration will not be used by the X-gateway until they have
been applied and saved. See “X-gateway Management” on page 38.
6.4.1 Authentication
Authentication can be enabled or disabled. If enabled, it is possible to set a username and password to
protect the configuration.
When choosing a username and a password, use only the valid characters shown below.
Item
Username
Password
Valid characters
A-Z, a-z, 0-9, _ (underscore). Max length: 13 characters.
A-Z, a-z, 0-9, _ (underscore). Max length: 12 characters.
Important Notice
Note that it is very important to save the authentication information. There is no way to retrieve a lost
username or password. If the authentication information is lost, the only way to restore the X-gateway
is to download new firmware via the USB interface. This will erase any configuration currently on the
module.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 33
6.4.2 Modbus Client
Configuration of the client side of the Modbus-TCP network. On this side, the X-gateway will act as a
Modbus-TCP client. To the right, in the “Actual” column, the currently used values can be seen.
Available IP Configuration Settings
Item
IP address
Subnet mask
Router IP address
DHCP
Anybus IPconfig
(HICP)
Description
If not set by DHCP (or HICP), set these values manually.
Enabled by default. When enabled, the X-gateway can obtain the TCP/IP settings dynamically
from the DHCP server of the Modbus-TCP network.
Enabled by default. When enabled, the TCP/IP settings for the Modbus-TCP network can be configured temporarily with the Anybus IPconfig tool. See “Anybus IPconfig Tool” on page 63.
Start-up Operation Mode
Value
Running
Idle
Description
The Modbus-TCP client starts to exchange data with the servers as soon as possible
after start-up.
The Modbus-TCP client does not exchange any data with the servers and waits for
instructions via the control word.
Action in Case of Irrecoverable Error
If the X-gateway encounters an irrecoverable error, there are two possible options.
Value
Shutdown
Restart
Description
The X-gateway will shut down. All LEDs will display red.
The X-gateway will restart.
When finished configuring the Modbus-TCP client, click ‘Save settings’. Note that the changes will not
take effect until they are applied in the X-gateway management section. See “X-gateway Management”
on page 38.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 34
6.4.3 Modbus Servers
The configuration of the servers on the Modbus-TCP network is made here. The X-gateway can handle
up to 64 different servers, and a maximum of 64 transactions distributed among those servers. It is possible to map up to 256 bytes of data in either direction, including control/status word and live list.
The global configuration limits box keeps track of the number of added transactions and the current
amount of I/O mapped input and output data. It also keeps track of the total amount of data in the
configuration (both I/O mapped and not I/O mapped data).
Add Server
Click ‘Add server’ to add a server to the configuration. Click ‘Edit’ to see and edit the settings:
Available editable settings:
Setting
Name
Server address
Protocol
Port
Description
While not required, renaming the server makes the configuration easier to comprehend. Note that it
is only possible to use uppercase and lowercase characters, numerals and underscore (_).
Default name is ‘New_Server’, followed by an incremental suffix.
Max length: 32 characters.
The IP address of the server.
TCP.
Default Modbus-TCP port is 502. If the server requires it, it is possible to change.
Value range: 0 - 65535.
When the server is configured, click ‘Ok’.
Note: When the server and its settings are configured, transactions must be added to the server. See
“Add Transactions” on page 35. At any time, it is possible to have only one server without specified
transactions.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 35
Add Transactions
Transactions represent the data that is read from/written to the servers of the Modbus-TCP network.
The global configuration limits box keeps track of the number of added transactions, the current minimum allowed scan time, and the current amount of I/O mapped data as well as total amount of data
(both I/O mapped and not I/O mapped data).
To add transactions, find the server in the server list and click ‘Transactions’. This presents a list of all
transactions configured for that server. Click ‘Add transaction’ to add a new default transaction to the
list and click ‘edit’.
See a description of the settings on the next page.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 36
Available settings
Setting
Function code
Description
The function code defines the purpose of the transaction.
Choose from the available different Modbus functions, see “Modbus-TCP Functions” on page 27.
Data encoding
Decides in what order the different bytes of the received/transmitted data shall be sent on the network.
Trigger
Only applicable for write transactions.
Cyclic.
On data change.
I/O mapped
Decides whether to map the data to the memory that is cyclically exchanged between the EtherNet/IP network and the Modbus-TCP network (I/O mapped data).
Name
While not required, renaming the transaction makes the configuration easier to comprehend. Note
that it is only possible to use uppercase and lowercase characters, numerals and underscore (_).
Default name is ‘New_Trans’, followed by an incrementing suffix.
Max length: 32 characters.
Timeout (ms)
The time span within which the server must return a response to the transaction.
If no response is received within the timeout period, the connection to the server will be closed.
If the connection to the server is closed, all transactions to that server will be affected.
Value range: 10 - 65535 (ms).
Scan time (ms)
The scan time defines how often the transaction shall be resent, e.g. the time cycle of a repeating
transaction.
Minimum scan time (ms) is calculated by multiplying the total number of transactions by three.
The minimum scan time will increase by adding more transactions.
Value range: 10 - 10000 (ms).
Unit ID
Only applicable for Modbus RTU servers. If the Modbus-TCP server functions as a router to Modbus RTU servers, it is possible to send transactions to a single Modbus RTU server using the unit
ID.
Value range: 0 - 247; 255.
If not communicating with a Modbus RTU server, use the value 255 (default).
Starting register/bit The starting Modbus server register or bit to write to/read from.
Value range: 1 - 65536.
Elements
The number of elements to write/read.
Value range: See “Modbus-TCP Functions” on page 27.
When EtherNet/IP
Note: Only available for I/O mapped write transactions.
(network 1) is not
Clear data to Modbus server: only zeros will be transmitted.
exchanging I/O data Freeze data to Modbus server: the data that was stored last will be repeated.
Write safe value: choose a specific value to transmit for every element (See safe element value
below).
Stop: no data will be transmitted to the Modbus server.
Data type
Write/read data either as two byte integers (uint16) or four byte integers (uint32).
Registers
The resulting amount of registers to write/read.
The calculation is based on the number of elements to read/write and the chosen data type.
Safe Element Value Note: Only available for write transactions.
A numeric value to send for every element if network 1 (EtherNet/IP) is not exchanging I/O data.
Startup-mode
Wait for data: all data for the transaction must have been sent from the EtherNet/IP network and
received by the X-gateway before the transaction is carried out.
Directly: the data is sent as soon as possible after start-up.
When finished editing the transaction, click ‘Ok’. All data resulting from configured transactions will be
mapped to the internal memory of the X-gateway. Read transactions will be mapped to the input area,
and write transactions will be mapped to the output area. See “Mapping Overview” on page 39 for more
information.
Note: The X-gateway needs to be restarted before any changes will take effect. See “X-gateway Management” on page 38.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 37
6.4.4 EtherNet/IP (Adapter Interface)
Configuration of the EtherNet/IP adapter interface of the X-gateway.
What is shown is the currently stored configuration, provided that all changes are saved and applied to
the X-gateway.
The column ‘Actual’ presents the settings that are currently used. These can be changed from the EtherNet/IP network during runtime, if ‘Comm settings from network’ is enabled. It is recommended to
permit the EtherNet/IP network to control the TCP/IP and Ethernet settings.
It is possible to override the TCP/IP and Ethernet settings set from the network by entering new values
in the Configured column and pressing “Save settings”.
Note that no changes will take effect until the configuration has been applied. See “X-gateway Management” on page 38.
Available settings for the EtherNet/IP network
Setting
Comm settings from network
IP address
Subnet mask
Gateway
DHCP
Ethernet settings link 1
Ethernet settings link 2
When Modbus-TCP (Network
2) error
Description
Enabled by default. This enables the X-gateway to obtain TCP/IP and Ethernet link settings from the EtherNet/IP network.
If not detected automatically, set these items manually.
If enabled, the X-gateway can obtain TCP/IP settings from a DHCP server.
Network speed and communication model.
The “Freeze data to master” option instructs the X-gateway to keep sending the latest
received data from the Modbus-TCP network to the EtherNet/IP scanner.
The “Clear data to master” option instructs the X-gateway to clear the input data area
and send only zeros to the EtherNet/IP scanner.
I/O mapped control/status word If enabled, the control/status word is mapped to the output/input area respectively. See
“I/O Mapped Data” on page 14.
I/O mapped live list
If enabled, the live list is mapped to the input area. See “Live List” on page 15.
Reserved bytes, read bit
0: dynamic.
transactions
1 - 128: The number of bytes that shall be reserved for bit transactions.
Reserved bytes, write bit
0: dynamic.
transactions
1 - 128: The number of bytes that shall be reserved for bit transactions.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 38
6.5 Tools
6.5.1 X-gateway Management
Apply changes
Permanently store changes made to the configuration and reboot, using the new configuration.
No changes made in the configuration will be permanently stored or used by the X-gateway until they
are applied by clicking ‘Apply’.
Before storing and rebooting, the X-gateway will validate the not yet stored configuration. If errors are
found, the X-gateway will produce an information message with instructions to correct the errors. The
X-gateway will not store an invalid configuration.
Reboot and undo changes
The X-gateway will be restarted. All changes made since the last configuration was loaded will be undone.
Undo changes
Undo all changes made since the last configuration was loaded.
Factory reset
Reset the X-gateway to completely remove the configuration currently stored in the module.
Wink device
Clicking the “Wink device” button will start a 15 second LED sequence on LEDs 1, 5 and 6 on the Xgateway. For identification purposes.
6.5.2 Backup and Restore
Backup the configuration that is currently used to file, or restore a previously saved configuration from
file.
It is not possible to backup or restore the configuration until all changes are either applied or undone.
See “X-gateway Management” on page 38.
Two things can happen when loading an old configuration:
•
Configuration valid:
The X-gateway will reboot and automatically use the previously stored configuration.
•
Configuration not valid:
The X-gateway will produce an error message. The chosen configuration will not be accepted or
loaded into memory.
Important Notice
Before loading a previously stored configuration, locate any authentication information associated with
it. If a valid configuration is loaded that is protected by a password, the X-gateway can not be reconfigured until the authentication information has been provided.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 39
6.5.3 Mapping Overview
This page provides a description of all data resulting from the transactions of the currently applied configuration. It is divided into two parts. The first part describes the X-gateway interface to the EtherNet/
IP network, and the second part all applied transactions on the Modbus-TCP network.
If needed, it is possible to print the configuration to paper. Click the printer symbol to the right on the
mapping overview page to access a printer friendly version of the mapping overview.
EtherNet/IP
The I/O mapped data will always be presented according to the following priority order:
•
Input data
Data from the Modbus-TCP network to the EtherNet/IP network.
- Status word (optional)
- Live list (optional)
- Input data (bit transactions will always be mapped first)
•
Output data
Data from the EtherNet/IP network to the Modbus-TCP network.
- Control word (optional)
- Output data (bit transactions will always be mapped first)
The parameter section data presents a detailed list of all data, including both the I/O mapped and the
not I/O mapped data, available acyclically from the X-gateway to the EtherNet/IP network. This list
also includes the transaction status and exception code lists, available for error identification.
- “Exception Code List” on page 16
- “Transaction Status List” on page 15
Modbus-TCP network
A detailed list of all Modbus servers and transactions in the configuration.
6.5.4 Mapping Overview Example
This example (illustrated on the next page) includes three transactions. The control/status word and the
live list are both I/O mapped. The I/O mapped data is presented in the input and output data box
charts.
- New_Trans1: an I/O mapped read/write transaction, reading eight bytes and writing 16
bytes.
- New_Trans2: an I/O mapped read transaction, reading 12 bytes.
- New_Trans3: a not I/O mapped write transaction, writing 6 bytes.
Note how this transaction is only visible in the parameter data.
In the parameter data box, all configured data is presented. Details for acyclically accessing control/status word, live list, exception and transaction status list, as well as both I/O mapped and not I/O mapped
data are available here.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 40
Mapping Overview Example
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Network Configuration 41
6.5.5 Transaction Monitor
The transaction monitor interface presents a detailed list of all transactions currently operating on the
Modbus-TCP network. The data is automatically updated, and it is possible to choose to view the data
either in decimal or in hexadecimal values. The time that has passed since the last update is visible at the
top of the transaction list. Every post in the list contains the following transaction information:
•
Server name and transaction name
•
The type of Modbus function chosen for the transaction
•
The size of the data read from or written to the Modbus-TCP network
•
The actual data read from or written to the Modbus-TCP network
•
The bit position of the transaction in the live list (also presented as byte.bit).
If there is a transaction error, an error message will appear instead of the data.
A red frame around the list indicates that the web browser has lost connection to the web server of the
X-gateway. If this happens, try reloading the page by clicking on “Transaction Monitor” in the menu to
the left.
Note: Viewing the transaction monitor may affect performance.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Chapter 7
7. CIP Objects
7.1 General Information
This chapter specifies the CIP-object implementation in the X-gateway. These objects can be accessed
from the network.
Mandatory Objects:
•
“Identity Object (01h)” on page 43
•
“Message Router (02h)” on page 45
•
“Assembly Object (04h)” on page 46
•
“Connection Manager (06h)” on page 48
•
“DLR Object (47h)” on page 51
•
“QoS Object (48h)” on page 52
•
“Port Object (F4h)” on page 55 (Optional)
•
“TCP/IP Interface Object (F5h)” on page 56
•
“Ethernet Link Object (F6h)” on page 59
Manufacturer Specific Objects:
•
“ADI Object (A2h)” on page 53
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 43
7.2 Identity Object (01h)
Object Description
-
Supported Services
Class:
Get_Attribute_Single
Get_Attributes_All
Instance:
Get_Attribute_Single
Set_Attribute_Single
Get_Attributes_All
Reset
Class Attributes
#
1
Name
Revision
Access
Get
Type
UINT
Value
0001h (Object revision)
Instance #1 Attributes
#
1
2
3
4
Name
Vendor ID
Device Type
Product Code
Revision
Access
Get
Get
Get
Get
5
6
Status
Serial Number
Get
Get
7 Product Name Get
11 Active language Set
12 Supported Lan- Get
guage List
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Type
UINT
UINT
UINT
Struct of:
{USINT, USINT}
WORD
UDINT
Value
005Ah (HMS Industrial Networks AB)
000Ch (Communications Adapter)
0050h (Anybus X-gateway Modbus-TCP)
Major and minor firmware revision
Unique serial number (assigned by HMS)
SHORT_STRING “Anybus X-gateway Modbus-TCP” (Name of product)
Struct of:
USINT
USINT
USINT
Array of:
Struct of:
USINT
USINT
USINT
Doc.Id. HMSI-168-43
CIP Objects 44
Device Status
Bit(s)
0
1
2
3
4... 7
8
9
Name
Module Owned
(reserved)
Configureda
(reserved)
Extended Device Status:
Value:Meaning:
0000b Unknown
0010b Faulted I/O Connection
0011b No I/O connection established
0100b Non-volatile configuration bad
0110b Connection in Run mode
0111b Connection in Idle mode
(other) (reserved)
Set for minor recoverable faults
Set for minor unrecoverable faults
10
Set for major recoverable faults
11
Set for major unrecoverable faults
(reserved)
12... 15
a. This bit shows if the product has other settings than “out-of-box”.
Service Details: Reset Service
There are two types of network reset requests on EtherNet/IP:
•
Type 0: ‘Power Cycling Reset’
This service emulates a power cycling of the module, and corresponds to Anybus reset type 0
(Power cycling).
•
Type 1: ‘Out of box reset’
This service sets a “out of box” configuration and performs a reset, and corresponds to Anybus
reset type 2 (Power cycling + factory default).
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 45
7.3 Message Router (02h)
Object Description
-
Supported Services
Class:
-
Instance:
-
Class Attributes
-
Instance Attributes
-
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 46
7.4 Assembly Object (04h)
Object Description
The Assembly object uses static assemblies and holds the Process Data sent/received by the host application. The default assembly instance IDs used are in the vendor specific range.
Supported Services
Class:
Get_Attribute_Single
Instance:
Get_Attribute_Single
Set_Attribute_Single
Class Attributes
#
1
2
Name
Revision
Max Instance
Access
Get
Get
Type
UINT
UINT
Value
0002h (Object revision)
(Highest instance number)
Instance C6h Attributes (Heartbeat, Input-Only)
This instance is used as heartbeat for Input-Only connections.
#
3
Name
Data
Access
Set
Type
N/A
Value
- (The data size of this attribute is zero)
Instance C7h Attributes (Heartbeat, Listen-Only)
This instance is used as heartbeat for listen-only connections.
#
3
Name
Data
Access
Set
Type
N/A
Value
- (The data size of this attribute is zero)
Instance 05h Attributes (Configuration Data)
Configuration Data that is sent through the ‘Forward_Open’-service will be written to this instance.
#
3
Name
Data
Access
Get/Set
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Type
N/A
Value
- (Configuration data written to the application when the forward
open command has the configuration data included)
Doc.Id. HMSI-168-43
CIP Objects 47
Instance C3h Attributes (Heartbeat, Input-Only Extended)
This instance is used as heartbeat for input-only extended connections, and does not carry any attributes.
If the connection times out, the module does not switch to the Error state.
Instance C4h Attributes (Heartbeat, Listen-Only Extended)
This instance is used as heartbeat for listen-only extended connections, and does not carry any attributes.
Instance 64h Attributes (Producing Instance)
#
3
Name
Produced Data
Access
Get
Type
Array of BYTE
Value
This data corresponds to the Write Process Data
Instance 96h Attributes (Consuming Instance)
#
3
Name
Consumed Data
Access
Set
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Type
Array of BYTE
Value
This data corresponds to the Read Process Data
Doc.Id. HMSI-168-43
CIP Objects 48
7.5 Connection Manager (06h)
Object Description
-
Supported Services
Class:
-
Instance:
Forward_Open
Forward_Close
Instance Descriptions
(No supported instance attributes)
Class 1 Connection Details
General
Class 1 connections are used to transfer I/O data, and can be established to instances in the Assembly
Object. Each Class 1 connection will establish two data transports; one consuming and one producing.
The heartbeat instances can be used for connections that shall only access inputs. Class 1 connections
use UDP transport.
•
Total number of supported Class 1 connections:
4
•
Max input connection size:
256 bytes
•
Max output connection size:
256 bytes
•
Supported API:
2... 3200 ms
•
T  O Connection type:
Point-to-point, Multicast
•
O  T Connection type:
Point-to-point
•
Supported trigger types:
Cyclic, COS
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 49
Connection Types
•
Exclusive-Owner connection
This type of connection controls the outputs of the Anybus module and does not depend on other connections.
•
- Max. no. of Exclusive-Owner connections:
1
- Connection point O  T:
Assembly Object, instance 64h (Default)
- Connection point T  O:
Assembly Object, instance 96h (Default)
Input-Only connection
This type of connection is used to read data from the Anybus module without controlling the
outputs. It does not depend on other connections.
- Max. no. of Input-Only connections:
Up to 41
- Connection point O  T:
Assembly Object, instance 03h (Default)
- Connection point T  O:
Assembly Object, instance 96h (Default)
Note: If an Exclusive-Owner connection has been opened towards the module and times out,
the Input-Only connection times out as well. If the Exclusive-Owner connection is properly
closed, the Input-Only connection remains unaffected.
•
Input-Only Extended connection
This connections functionality is the same as the standard Input-Only connection. However
when this connection times out it does not affect the state of the application.
- Max. no. of Input-Only connections:
Up to 4a
- Connection point O  T:
Assembly Object, instance 05h (Default)
- Connection point T  O:
Assembly Object, instance 96h (Default)
Note: If an Exclusive-Owner connection has been opened towards the module and times out,
the Input-Only connection times out as well. If the Exclusive-Owner connection is properly
closed, the Input-Only connection remains unaffected.
•
Listen-Only connection
This type of connection requires another connection in order to exist. If that connection (Exclusive-Owner or Input-Only) is closed, the Listen-Only connection will be closed as well.
•
- Max. no. of Listen-Only connections:
Up to 42
- Connection point O  T:
Assembly Object, instance 04h (Default)
- Connection point T  O:
Assembly Object, instance 96h (Default)
Listen-Only Extended connection
The functionality of this connection is the same as the standard Listen-Only connection. However when this connection times out it does not affect the state of the application.
•
- Max. no. of Listen-Only connections:
Up to 4b
- Connection point O  T:
Assembly Object, instance 07h (Default)
- Connection point T  O:
Assembly Object, instance 96h (Default)
Redundant-Owner connection
This connection type is not supported by the module.
1. Shared with Exclusive-Owner and Listen-Only connections
2. Shared with Exclusive-Owner and Input-Only connections
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 50
Class 3 Connection Details
•
Explicit message connection
Class 3 connections are used to establish connections towards the message router. Thereafter,
the connection is used for explicit messaging. Class 3 connections use TCP transport.
- No. of simultaneous Class 3 connections:
16
- Supported API:
2 - 10000 ms
- T  O Connection type:
Point-to-point
- O  T Connection type:
Point-to-point
- Supported trigger type:
Application
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 51
7.6 DLR Object (47h)
Object Description
-
Supported Services
Class:
Get_Attribute_Single
Get_Attributes_All
Instance:
Get_Attribute_Single
Set_Attribute_Single
Class Attributes
#
1
Name
Revision
Access
Get
Type
UINT
Value
0002h (Object revision)
Instance #1 Attributes
#
1
Name
Access
Network Topol- Get
ogy
2
Network Status Get
10 Active
Get
Supervisor
Address
12 Capability Flags Get
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Type
USINT
Value
Bit:Contents:
0 “Linear”
1 “Ring”
USINT
Bit:Contents:
0 “Normal” (N/A)
1 “Ring Fault”
2 “Unexpected Loop Detected”
3 “Partial Network Fault”
4 “Rapid Fault/Restore Cycle”
Struct of:
This attribute holds the IP address (IPv4) and/or the Ethernet Mac
{UDINT, Array of address of the active ring supervisor
6 USINTs}
DWORD
01h (Announce-based ring node)
Doc.Id. HMSI-168-43
CIP Objects 52
7.7 QoS Object (48h)
Object Description
-
Supported Services
Class:
Get_Attribute_Single
Get_Attributes_All
Instance:
Get_Attribute_Single
Set_Attribute_Single
Class Attributes
#
1
Name
Revision
Access
Get
Type
UINT
Value
0001h (Object revision)
Instance #1 Attributes
#
1
Name
802.1Q Tag
Enable
Access
Set
Type
USINT
4
DSCP Urgent
Set
USINT
5
Set
USINT
6
DSCP
Scheduled
DSCP High
Set
USINT
7
DSCP Low
Set
USINT
8
DSCP Explicit
Set
USINT
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Value
Enables or disables sending 802.1Q frames
Bit:Contents:
0 Disabled (Default)
1 Enabled
CIP transport Class 1 messages with priority Urgent
Default: 55
CIP transport Class 1 messages with priority Scheduled
Default: 47
CIP transport Class 1 messages with priority High
Default: 43
CIP transport Class 1 messages with priority Low
Default: 31
CIP UCMM and CIP Class 3
Default: 27
Doc.Id. HMSI-168-43
CIP Objects 53
7.8 ADI Object (A2h)
Object Description
-
Supported Services
Class:
Get_Attribute_Single
Instance:
Get_Attribute_Single
Set_Attribute_Single
Class Attributes
#
1
2
3
Name
Revision
Max Instance
Number of instances
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Access
Get
Get
Get
Type
UINT
UINT
UINT
Value
Object revision (Current value = 0001h)
Doc.Id. HMSI-168-43
CIP Objects 54
Instances Attributes
Each instance corresponds to an instance within the Application Data Object.
#
1
2
3
4
Name
Name
ABCC Data type
No. of elements
Descriptor
Access
Get
Get
Get
Get
Type
SHORT_STRING
USINT
USINT
USINT
Description
Parameter name (including length)
Data type of instance value
Number of elements of the specified data type
Bit field describing the access rights for this instance
Bit:Meaning:
0 Set = Get Access
1 Set = Set Access
Instance value
5
Valuea
Get/Set
6
Max valuea
Get
Determined by
attribute #2
7
Min valuea
Get
The minimum permitted parameter value
8
Default valuea
Get
The default parameter value
The maximum permitted parameter value
a. Converted to/from CIP standard by the module
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 55
7.9 Port Object (F4h)
Object Description
-
Supported Services
Class:
Get_Attributes_All
Get_Attribute_Single
Instance:
Get_Attributes_All
Get_Attribute_Single
Class Attributes
#
1
2
3
8
Name
Revision
Max Instance
Number of instances
Entry Port
Access
Get
Get
Get
Get
Type
UINT
UINT
UINT
UINT
9
Port Instance Info
Get
Array of:
Value
Object revision (Current value = 0001h)
Max. instance number
Number of ports
Returns the instance of the Port Object that describes the port
through which this request entered the device.
Array of structures containing instance attributes 1 and 2 from
each instance. The array is indexed by instance number, up to
the maximum number of instances. The value at index 1 (offset 0) and any non-instantiated instances will be zero.
Struct of:
UINT (Type)
Enumerates the type of port
UINT (Number) CIP port number associated with this port
Instance Attributes (Instance #1)
This instance reflects the properties associated with the Ethernet interface.
#
1
2
3
Name
Port Type
Port Number
Link Object
Access
Get
Get
Get
4
7
8
Port Name
Node Address
Port Node Range
Get
Get
Get
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Type
UINT
UINT
Struct of:
UINT
Padded EPATH
SHORT_STRING
Padded EPATH
Struct of:
UINT (Min.)
UINT (Max.)
Value
0h (default)
2h
2h
20 F5 24 01h
“EtherNet/IP”
-
Doc.Id. HMSI-168-43
CIP Objects 56
7.10 TCP/IP Interface Object (F5h)
Object Description
The object groups TCP/IP-related settings.
Supported Services
Class services:
Get_Attribute_All
Get_Attribute_Single
Instance services:
Get_Attribute_All
Get_Attribute_Single
Set_Attribute_Single1
Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0001h
Description
Revision 2
1. Support for this service can be disabled by implementing attribute #9 in the EtherNet/IP Host Object.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 57
Instance Attributes
#
1
Access
Get
Name
Status
Type
DWORD
Value
0000 0001h
0000 0002h
0000 0010h
2
Get
Configuration
Capability
DWORD
3
Get/Set
Configuration
Control
DWORD
0000 0016h
- or 0000 0006h
- or 0000 0026h
- or 0000 0036h
-
4
Get
Physical Link
Object
5
Get/Set
Interface
Configuration
6
8
9
Get/Set
Get/Set
Get/Set
Host Name
TTL Value
Mcast Config
Alloc Control
(reserved)
Num Mcast
10 Set
Mcast Start
Addr
SelectAcd
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Comments
Bit #: Meaning:
0:
Attribute #5 contains valid information from
DHCP or nonvolatile storage
1:
Attribute #5 contains valid information from
hardware settings
4:
Mcast pending
6:
AcdStatus. Set to 1 if an address conflict is
detected. Address conflict detection is
enabled/disabled in attribute #10.
Attribute #5 contains valid information from hardware settings.
Mcast pending
The ‘Configuration Settable’-bit (bit 4) in this
attribute reflects the value of instance attribute #9
in the EtherNet/IP Host Object.
The module is capable of resolving host names by
querying a DNS server
Value:Meaning:
0 Configuration from nonvolatile memory
2 Configuration from DHCP
Struct of:
UINT (Path size) 0002h
2 words
Padded EPATH
20 F6 24 03h Path to Ethernet Link Object, Instance 3
Struct of:
UDINT (IP)
IP address
UDINT (Mask)
Subnet mask
UDINT (GW)
Default gateway
UDINT (DNS1)
Primary DNS
UDINT (DNS2)
Secondary DNS
STRING (Domain)
Default domain
STRING
Host name of Anybus module
USINT
1
TTL value for EtherNet/IP multicast packets
Struct of:
USINT
0
Value:Meaning:
0 Use default allocation algorithm to
generate multicast addresses
1 Allocate multicast addresses according
to the values in the ‘Num Mcast’- and
‘Mcast Start Addr’-fields
USINT
0
Set to zero. Do not change
UINT
1
Number of multicast addresses to allocate for EtherNet/IP
UDINT
Starting multicast address from which to begin allocation
Bool
1
Value: Meaning:
0:
Disable ACD
1:
Enable ACD (default)
If ACD (address conflict detection) is
enabled, bit 6 in attribute #1 will be set if
an ACD conflict is detected. The Network
Status LED will also indicate a detected
conflict.
Doc.Id. HMSI-168-43
CIP Objects 58
# Access
11 Set
Name
Type
LastConflictDe- Struct of:
tected
AcdActivity
USINT
Value
-
RemoteMAC
ARRAY of 6 USINT -
ArpPdu
ARRAY of 28 USINT -
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Comments
ACD Diagnostic parameters related to the last conflict detected.
State of ACD activity when last conflict
detected
MAC address of remote node form the ARP
PDU in which a conflict was detected
Copy of the raw ARP PDU in which a conflict
was detected
Doc.Id. HMSI-168-43
CIP Objects 59
7.11 Ethernet Link Object (F6h)
Object Description
This object groups diagnostic information for the Ethernet interface.
Supported Services
Class services:
Get_Attribute_All
Get_Attribute_Single
Instance services:
Get_Attribute_All
Get_Attribute_Single
Set_Attribute_Single
Get_And_Clear
Class Attributes
#
1
2
3
Access
Get
Get
Get
Name
Revision
Max Instance
Number of
instances
Type
UINT
UINT
UINT
Value
3
3
3
Comments
Revision 3
Instance 3 is the max instance
3 instances
Name
Interface Speed
Interface Flags
Physical Address
Interface Control
Control Bits
Forced Interface
Speed
Type
UDINT
DWORD
Array of 6 USINTS
Struct:
WORD
UINT
Value
10 or 100
(MAC ID)
Comments
Actual Ethernet interface speed
See “Interface Flags” on page 60.
Physical network address
-
Interface Type
Interface Label
USINT
SHORT_STRING
-
Interface control bits
Speed at which the interface shall be forced to
operate. Returns ‘Object state Conflict’ if autonegotiation is enabled.
See “Interface Type” on page 60
See “Interface Label” on page 60
Instance Attributes
#
1
2
3
6
7
10
Access
Get
Get
Get
Get/Set
Get
Get
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
CIP Objects 60
Interface Flags
Bit
0
Name
Link status
Description
Indicates whether or not the Ethernet 802.3 communications interface is connected to an active network.
Value:Meaning:
0 Inactive link
1 Active link
1
Half/full duplex
Indicates the duplex mode currently in use.
Value:Meaning:
0 Half duplex
1 Full duplex
2 - 4 Negotiation Status
Indicates the status of link autonegotiation
Value:Meaning:
0 Autonegotiation in progress.
1 Autonegotiation and speed detection failed (using default values)
2 Autonegotiation failed but detected speed (using default duplex value)
3 Successfully negotiated speed and duplex.
4 Autonegotiation not attempted. Forced speed and duplex.
5
Manual Setting requires Reset Value:Meaning:
0 Interface can activate changes to link parameters during runtime
1 Reset is required in order for changes to have effect
6
Local Hardware Fault
Value:Meaning:
0 No local hardware fault detected
1 Local hardware fault detected
7-31 (reserved)
(ignore)
Interface Type
Instance
1
2
3
Value
2
2
1
Description
Twisted-pair
Twisted-pair
Internal interface
Interface Label
Instance
1
2
3
Value
Port 1
Port 2
Internal
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Appendix A
A. Technical Specification
A.1 Protective Earth (PE) Requirements
In order to achieve proper EMC behavior, the product must be connected to protective earth (PE) via
the DIN-rail connector. If the DIN-rail cannot be used, PE must be connected to the power connector.
HMS Industrial Networks does not guarantee proper EMC behavior unless these PE requirements are
fulfilled.
Note: Make sure the DIN-rail is properly connected to PE.
A.2 Power Supply
Supply Voltage
The X-gateway requires a regulated 24 V (20.4 V to 28.8 V) DC power source.
Power Consumption
The typical power consumption is 150 mA at 24 V.
A.3 Environmental Specification
A.3.1 Temperature
Operating
-25º to +70º Celsius
Non-operating
-40º to +85º Celsius
A.3.2 Relative Humidity
The product is designed for a relative humidity of 5% to 95% noncondensing.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Technical Specification 62
A.4 EMC (CE) Compliance
EMC compliance testing has been conducted according to the Electromagnetic Compatibility Directive
2004/108/EC. For more information please consult the EMC compliance document, see product/support pages for Anybus X-gateway Modbus-TCP at www.anybus.com.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Appendix B
B. Anybus IPconfig Tool
The X-gateway supports the HICP protocol used by the Anybus IPconfig tool and all Anybus products.
It is possible to see and alter the TCP/IP settings for the X-gateway manually by using the
IPconfig Tool.
At start-up, the IPconfig tool presents a list of
all Anybus products that are connected to the
network. The list can be refreshed by clicking
‘scan’. The X-gateway is identified in the list
by its type ‘Anybus X-gateway Modbus-TCP’
or by its MAC address (found at the bottom
of the module).
Right-clicking a row in the list makes it possible to either visit the web interface of the
product, or bring up the configuration window. Double-clicking a row also brings up the
configuration window.
In the configuration window the TCP/IP settings can be set or changed. Save the new settings by clicking ‘set’, or exit without saving by clicking ‘cancel’.
Note: the IPconfig tool provides the opportunity to set a username and a password. The X-gateway,
however, will not accept any configuration changes where the password has been altered.
Note: if the X-gateway configuration is protected by a password, it is not possible to alter the TCP/IP
settings.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Appendix C
C. Copyright Notices
This product includes software developed by Carnegie Mellon, the Massachusetts Institute of Technology, the University of California, and RSA Data Security:
*****************************************************************************
Copyright 1986 by Carnegie Mellon.
*****************************************************************************
Copyright 1983,1984,1985 by the Massachusetts Institute of Technology
*****************************************************************************
Copyright (c) 1988 Stephen Deering.
Copyright (c) 1982, 1985, 1986, 1992, 1993
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by Stephen Deering of Stanford University.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
•
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
•
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with the distribution.
•
Neither the name of the University nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' ANDANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*****************************************************************************
Copyright (C) 1990-2, RSA Data Security, Inc. All rights reserved.
License to copy and use this software is granted provided that it is identified as the "RSA Data Security, Inc. MD4
Message-Digest Algorithm" in all material mentioning or referencing this software or this function.
License is also granted to make and use derivative works provided that such works are identified as "derived from
the RSA Data Security, Inc. MD4 Message-Digest Algorithm" in all material mentioning or referencing the derived
work.
RSA Data Security, Inc. makes no representations concerning either the merchantability of this software or the
suitability of this software for any particular purpose. It is provided "as is" without express or implied warranty of
any kind.
These notices must be retained in any copies of any part of this documentation and/or software.
*****************************************************************************
Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All rights reserved.
License to copy and use this software is granted provided that it is identified as the "RSA Data Security, Inc. MD5
Message-Digest Algorithm" in all material mentioning or referencing this software or this function.
License is also granted to make and use derivative works provided that such works are identified as "derived from
the RSA Data Security, Inc. MD5 Message-Digest Algorithm" in all material mentioning or referencing the derived
work.
RSA Data Security, Inc. makes no representations concerning either the merchantability of this software or the
suitability of this software for any particular purpose. It is provided "as is" without express or implied warranty of
any kind.
These notices must be retained in any copies of any part of this documentation and/or software.
Anybus X-gateway Modbus-TCP
Doc.Rev. 1.11
Doc.Id. HMSI-168-43
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement