HMS Anybus X-gateway Modbus-TCP User Manual

+$/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

Connecting Devices

TM

E-mail: [e-mail]

Web: www.anybus.com

User Manual

Anybus® X-gateway Modbus-TCP

Modbus-TCP

Doc.Id. SCM-1200-114

Rev. 1.00

Important User Information

This document is intended to provide a good understanding of the functionality offered by the Anybus X-gateway
Modbus-TCP - Modbus-TCP. The reader of this document is expected to be familiar with high level software de­sign, 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 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
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 de­scribed 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 prod­uct. 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 - Modbus-TCP User Manual

Copyright© HMS Industrial Networks AB

June 2011 Doc Id SCM-1200-114

Rev 1.00

Doc.Id. SCM-1200-114

Table of Contents

Table of Contents

Preface About This Document ..................................................................... 5

Related Documents..................................................................................................................... 5

Document History ...................................................................................................................... 5

Conventions & Terminology..................................................................................................... 6

Sales and Support ........................................................................................................................ 7

Chapter 1 Getting Started ................................................................................. 8

Chapter 2 Anybus X-gateway for Modbus-TCP - Modbus-TCP ..................... 9

Introduction ................................................................................................................................. 9

Features.......................................................................................................................................10

Configuring the Modbus-TCP Network ............................................................................... 10

Functional Overview ................................................................................................................ 11

Data Exchange........................................................................................................................... 12

Control/Status Word................................................................................................................ 13

Live List ...................................................................................................................................... 14

Chapter 3 About the Anybus X-gateway Modbus-TCP ..................................15

External View ............................................................................................................................ 15

Mounting the X-gateway ..........................................................................................................16

DIN-rail Mounting.......................................................................................................... 16

Wall Mounting................................................................................................................. 17

Status LEDs ............................................................................................................................... 18

USB Connector.......................................................................................................................... 19

Modbus-TCP Connectors (Network 1)................................................................................. 19

Modbus-TCP Connectors (Network 2)................................................................................. 19

Power Connector ...................................................................................................................... 20

Chapter 4 SD Card Functionality ....................................................................21

General Advice and Guidelines .............................................................................................. 21

Starting Up ................................................................................................................................. 21

Easy Backup ............................................................................................................................... 22

Simple Configuration Copy ..................................................................................................... 22

Easy Replacement ..................................................................................................................... 22

SD Card Synchronization Failure ........................................................................................... 23

Chapter 5 Modbus-TCP Functions for Network 2..........................................24

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

Chapter 6 Modbus-TCP Functions for Network 1 ......................................... 25

Chapter 7 Network Configuration .................................................................. 26

General Information ................................................................................................................. 26

Introduction ............................................................................................................................... 27

Overview..................................................................................................................................... 28

Home................................................................................................................................29

Configuration ............................................................................................................................. 30

Authentication .................................................................................................................. 30

Modbus Client (Network 2) ............................................................................................. 31

Modbus Servers ................................................................................................................. 32

Modbus-TCP (Network 1 Server Interface)....................................................................... 35

Tools........................................................................................................................................... 37

X-gateway Management .................................................................................................... 37

Backup and Restore .......................................................................................................... 37

Mapping Overview ............................................................................................................ 38

Transaction Monitor ......................................................................................................... 39

Appendix A Technical Specification .................................................................. 40

Protective Earth (PE) Requirements...................................................................................... 40

Power Supply ............................................................................................................................. 40

Environmental Specification ................................................................................................... 40

Temperature...................................................................................................................... 40

Relative Humidity............................................................................................................. 40

EMC (CE) Compliance ............................................................................................................ 41

Appendix B Anybus IPconfig Tool .................................................................... 42

Appendix C Copyright Notices .......................................................................... 43

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

P. About This Document

For more information, documentation etc., please visit the HMS website, www.anybus.com.

P.1 Related Documents

Document Author

Modbus Application Protocol Specification V1.1B Modbus Organization

P.2 Document History

Summary of Recent Changes ( ... 1.00)

Preface

Change Page(s)

- -

- -

- -

Revision List

Revision Date Author(s) Chapter(s) Description

1.00 2011-06-28 KaD - First official release

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

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

About This Document P-6

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

P.4 Sales and Support

Sales Support

HMS Sweden (Head Office)

E-mail: [e-mail] E-mail: [e-mail]

Phone: +46 (0) 35 - 17 29 56 Phone: +46 (0) 35 - 17 29 20

Fax: +46 (0) 35 - 17 29 09 Fax: +46 (0) 35 - 17 29 09

Online: Online: www.anybus.com

HMS North America

E-mail: [e-mail] E-mail: [e-mail]

Phone: +1-312 - 829 - 0601 Phone: [phone]

Toll Free: +1-888-8-Anybus Toll Free: +1-888-8-Anybus

Fax: [phone] Fax: [phone]

Online: Online: www.anybus.com

HMS Germany

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: [phone]

Fax: [phone] Fax: [phone]

Online: www.anybus.de Online: www.anybus.de

HMS Japan

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: [phone]

Fax: [phone] Fax: [phone]

Online: www.anybus.jp Online: www.anybus.jp

HMS China

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: [phone]

Fax: [phone] Fax: [phone]

Online: www.anybus.cn Online: www.anybus.cn

HMS Italy

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: [phone]

Fax: [phone] Fax: [phone]

Online: www.anybus.it Online: www.anybus.it

HMS France

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: [phone]

Fax: [phone] Fax: [phone]

Online: www.anybus.fr Online: www.anybus.fr

HMS UK & Eire

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: +46 (0) 35 - 17 29 20

Fax: [phone] Fax: +46 (0) 35 - 17 29 09

Online: www.anybus.co.uk Online: www.anybus.com

HMS Denmark

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: +46 (0) 35 - 17 29 20

Fax: [phone] Fax: +46 (0) 35 - 17 29 09

Online: www.anybus.com Online: www.anybus.com

HMS India

E-mail: [e-mail] E-mail: [e-mail]

Phone: [phone] Phone: +46 (0) 35 - 17 29 20

Fax: [phone] Fax: +46 (0) 35 - 17 29 09

Online: www.anybus.com Online: www.anybus.com

About This Document P-7

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

Doc.Id. SCM-1200-114

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 Network 1 (the controlling network, where the X-gateway
acts as a server) and Network 2 (the controlled network, where the X-gateway acts as a client).

Perform the following steps when installing the module:

1. Mount the module. See “Mounting the X-gateway” on page 16 for details.

2. Connect the X-gateway to the Network 2. See “External View” on page 15.

3. Connect the power cable and apply power.

4. Access the configuration web pages.

• Connect a PC to the Network 2 (see “External View” on page 15) and open a web browser.
Enter the IP address of the X-gateway and access the configuration web pages. If the IP ad­dress of the X-gateway is unknown, use the Anybus IPconfig tool to find it. See “Anybus IP­config Tool” on page 42.

Chapter 1

• Configure the Network 2 client interface. See “Modbus Client (Network 2)” on page 31.

• Set up all Modbus servers and transactions using the configuration web pages. See “Modbus
Servers” on page 32 and “Network Configuration” on page 26.

• Configure the Network 1 server interface. See “Modbus-TCP (Network 1 Server Interface)”
on page 35.

5. Configure the Modbus-TCP client (PLC) on Network 1. See “Configuring the Modbus-TCP
Network” on page 10.

6. Connect the X-gateway to the Modbus-TCP (slave) network. See “External View” on page 15.

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

Chapter 2

Device Level with Modbus-TCP Slaves

Control Network

Master

(e.g. PLC)

Slave

Slave

Slave

Slave

Slave Slave

Slave

Slave

Anybus X-gateway

Modbus-TCP

Modbus-TCP

Master

Control
Network
Slave

2. Anybus X-gateway for Modbus-TCP - Modbus-TCP

2.1 Introduction

The Anybus X-gateway Modbus-TCP is a series of network gateways, used to provide a seamless con­nection between a Modbus-TCP network and a controlling network. This particular product connects a
Modbus-TCP network to another Modbus-TCP network. In order to avoid confusion, the controlling
network will be called Network 1, and the network that is controlled will be called Network 2.

The X-gateway enables the master of Network 1 to control Network 2. These X-gateways makes it pos­sible 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 communica­tion solution used all over the world by lead­ing manufacturers of industrial automation
products. Each module offers Modbus-TCP
master connectivity to one of these industrial
networks: EtherNet/IP, Modbus-TCP,
PROFINET, Modbus RTU, EtherCAT, CC­Link, ControlNet, CANopen, DeviceNet
and PROFIBUS DP-V1.

No proprietary configuration software is
needed. All necessary configuration is made
via the built-in web interface.

The Modbus-TCP server interface (the Net­work 1 interface) is configured with a stand­ard engineering tool of the PLC. No programming is required.

The X-gateway transmits I/O data transparently between the two networks.

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Anybus X-gateway for Modbus-TCP - Modbus-TCP 10

2.2 Features

Anybus X-gateways for Modbus-TCP act as intelligent links between two industrial networks. On Net­work 2, they function as clients (masters) while they function as servers (slaves) on Network 1. The im­plementation is based on the Anybus NP30 ASIC technology.

2.3 Configuring the Modbus-TCP Network

The Anybus X-gateway is a Modbus-TCP server (slave) on Network 1. The general settings for the serv­er interface are configured using the configuration web pages (see “Modbus-TCP (Network 1 Server In­terface)” on page 35). All data transfers must be configured using the Modbus-TCP 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 Modbus-TCP available on the market. The
choice of tool depends on the application and the Modbus-TCP client of Network 1.

An application note, describing how to configure an Anybus Modbus-TCP server interface with RS
Logix and RS Networx, is available on the support pages for the Anybus X-gateway Modbus-TCP ­Modbus-TCP module at ‘www.anybus.com’.

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

Anybus X-gateway for Modbus-TCP - Modbus-TCP 11

Industrial network

Modbus-TCP network

Anybus Modbus-TCP

Master Interface

Anybus network

slave interface

2.4 Functional Overview

Internally, the X-gateway consists of an intelligent gateway platform: an Anybus Modbus-TCP client in­terface for Network 2 and an Anybus Modbus-TCP server interface for Network 1. The two interfaces
are interconnected through the intelligent gateway platform, which basically forwards data from one net­work 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.

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

Anybus X-gateway for Modbus-TCP - Modbus-TCP 12

Industrial Network InterfaceModbus-TCP Network Interface

Industrial network

Modbus-TCP network

Data To

the Modbus-TCP

Network

Data From

the Modbus-TCP

Network

Data From

the Modbus-TCP

Network

Data to

the Modbus-TCP

Network

Status Word

Control Word

2.5 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 two Modbus-TCP networks.

Each buffer holds a maximum of 256 bytes of data. The first two bytes in either direction can be dedi­cated for control/status information, and another eight bytes of data coming from Network 2 can fea­ture a live list.

Through the dedicated control word, the client on Network 1 starts/stops the exchange of data on Net­work 2, and also resets the X-gateway if needed. The client on Network 1 can see the status of Network
2 in the corresponding status word. The live list feature gives the client on Network 1 the opportunity
to continuously see and monitor the status of each individual transaction on Network 2.

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 settings in the configuration web pages.

The available control/status functionality is described below. Also note that the terminology and defi­nitions used for different types of data vary greatly between different networking systems. All data trans­ported through the Anybus X-gateway for Modbus-TCP - Modbus-TCP is simply referred to as ‘I/O
data’ in this document.

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114

Anybus X-gateway for Modbus-TCP - Modbus-TCP 13

2.6 Control/Status Word

The Control/Status word is optional and disabled by default. It can be enabled/disabled when config­uring the Modbus-TCP network via the configuration web pages. See “Modbus-TCP (Network 1 Server
Interface)” on page 35.

The Control word is a 16-bit word (uint16) used by Network 1 to control the Anybus X-gateway and
subsequently also Network 2. If enabled, it is always mapped to the first two bytes of the output data
area.

Bit Value Description

0 (Least signifi­cant bit)

10-

2-7 Set to zero Unused
8-15 Set to zero Unused

The Status word is a 16-bit word used by the X-gateway to report its current actual status to Network 1.
If enabled, it is mapped to the first two bytes of the input data area.

Bit Value Description

0 (Least signifi­cant bit)

1-7 (reserved) Unused
8-15 (reserved) Unused

0 Puts the X-gateway in idle state
1 Puts the X-gateway in run state

1 Reboot the X-gateway

0 The X-gateway is in idle state
1 The X-gateway is in run state

Anybus X-gateway for Modbus-TCP - Modbus-TCP
Doc.Rev. 1.00

Doc.Id. SCM-1200-114