User Manual, Anybus Communicator for EtherNet/IP

User Manual
Anybus® Communicator™ for EtherNet/IP
Doc. ID HMSI
Rev. 4.00
Connecting DevicesTM
HALMSTAD • CHICAGO • KARLSRUHE • TOKYO • BEIJING • MILANO • MULHOUSE • COVENTRY • PUNE • COPENHAGEN
HMS Industrial Networks
Mailing address: Box 4126, 300 04 Halmstad, Sweden
Visiting address: Stationsgatan 37, Halmstad, Sweden
E-mail: info@hms-networks.com
Web: www.anybus.com
Important User Information
This document contains a general introduction as well as a description of the technical features provided by the
Anybus Communicator, including the PC-based configuration software.
The reader of this document is expected to be familiar with PLC and software design, as well as communication
systems in general. The reader is also expected to be familiar with the Microsoft Windows operating system.
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. EtherNet/IP CONFORMANCE TESTED™ is a certification mark of ODVA.
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.
Anybus Communicator for EtherNet/IP
Copyright© HMS Industrial Networks AB
Doc. ID
Table of Contents
Table of Contents
Important User Information
Liability .......................................................................................................................................... 1
Intellectual Property Rights............................................................................................................... 1
Trademark Acknowledgements ........................................................................................................ 1
Preface
About This Document
Related Documents.................................................................................................................................. 9
Document History ................................................................................................................................... 9
Conventions & Terminology................................................................................................................ 10
Glossary ................................................................................................................................................... 10
Sales and Support ................................................................................................................................... 10
Chapter 1
About the Anybus Communicator for
EtherNet/IP
External View ......................................................................................................................................... 12
Status LEDs ............................................................................................................................................ 13
Hardware Installation ............................................................................................................................ 14
Software Installation .............................................................................................................................. 15
Anybus Configuration Manager ..................................................................................................... 15
Chapter 2
Basic Operation
General..................................................................................................................................................... 16
Data Exchange Model ........................................................................................................................... 17
Memory Map................................................................................................................................. 17
Data Exchange Example.............................................................................................................. 18
Sub-network Protocol ........................................................................................................................... 19
Protocol Modes............................................................................................................................... 19
Protocol Building Blocks ................................................................................................................ 19
Master Mode ................................................................................................................................. 20
Generic Data Mode ....................................................................................................................... 21
DF1 Master Mode ........................................................................................................................ 21
EtherNet/IP ........................................................................................................................................... 22
General.......................................................................................................................................... 22
Data Types.................................................................................................................................... 22
Memory Layout ............................................................................................................................. 23
Modbus/TCP.......................................................................................................................................... 24
General.......................................................................................................................................... 24
Addressing Modes.......................................................................................................................... 24
Supported Exception Codes............................................................................................................ 24
Modbus Addressing Mode.............................................................................................................. 25
Anybus Addressing Mode.............................................................................................................. 26
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
IV
Chapter 3
File System
General..................................................................................................................................................... 27
File System Overview ............................................................................................................................ 28
System Files............................................................................................................................................. 28
Chapter 4
FTP Server
General..................................................................................................................................................... 29
FTP Connection Example (Windows Explorer)............................................................................... 30
Chapter 5
Telnet Server
General..................................................................................................................................................... 31
General Commands ............................................................................................................................... 32
Diagnostic Commands .......................................................................................................................... 33
File System Operations.......................................................................................................................... 33
Chapter 6
Basic Network Configuration
General Information.............................................................................................................................. 36
Ethernet Configuration File (‘ethcfg.cfg’) .......................................................................................... 37
General.......................................................................................................................................... 37
IP Access Control .................................................................................................................................. 39
On/Offline Configuration.................................................................................................................... 40
Anybus IPconfig (HICP) ...................................................................................................................... 41
Chapter 7
Web Server
General..................................................................................................................................................... 42
Authorization .......................................................................................................................................... 43
Content Types......................................................................................................................................... 44
Chapter 8
Server Side Include (SSI)
Functions ................................................................................................................................................. 46
Changing SSI output.............................................................................................................................. 55
SSI Output String File .................................................................................................................. 55
Temporary SSI Output change ....................................................................................................... 56
Chapter 9
E-mail Client
General..................................................................................................................................................... 57
E-mail Definitions.................................................................................................................................. 58
Chapter 10
Navigating the Anybus Configuration Manager
Main Window ......................................................................................................................................... 59
Pull-down Menu ............................................................................................................................ 60
Toolbar Icons ................................................................................................................................. 63
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
V
Chapter 11
Basic Settings
Fieldbus Settings..................................................................................................................................... 64
ABC Parameters ..................................................................................................................................... 65
Sub-network Parameters ....................................................................................................................... 67
Chapter 12
Nodes
General..................................................................................................................................................... 68
Adding & Managing Nodes.................................................................................................................. 68
Node Parameters.................................................................................................................................... 68
Master Mode and Generic Data Mode........................................................................................... 68
Chapter 13
Transactions
General..................................................................................................................................................... 69
Adding & Managing Transactions ....................................................................................................... 70
Transaction Parameters (Master Mode).............................................................................................. 71
Parameters (Query & Broadcast)................................................................................................... 71
Parameters (Response).................................................................................................................... 73
Transaction Parameters (Generic Data Mode).................................................................................. 73
Produce-Transactions ..................................................................................................................... 73
Consume-Transactions ................................................................................................................... 74
Transaction Editor ................................................................................................................................. 75
Chapter 14
Frame Objects
General..................................................................................................................................................... 76
Adding and Editing Frame Objects .................................................................................................... 76
Constant Objects (Byte, Word, Dword)............................................................................................. 77
Limit Objects (Byte, Word, Dword) ................................................................................................... 78
Data Object ............................................................................................................................................. 79
Variable Data Object ............................................................................................................................. 79
Checksum Object ................................................................................................................................... 81
Chapter 15
Commands
General..................................................................................................................................................... 82
Adding & Managing Commands ......................................................................................................... 82
Pull-Down Menu........................................................................................................................... 83
Toolbar Icons ................................................................................................................................. 83
The Command Editor ........................................................................................................................... 84
General.......................................................................................................................................... 84
Basic Navigation ........................................................................................................................... 84
Pull-down Menu ............................................................................................................................ 85
Editing a Command ...................................................................................................................... 86
Example: Specifying a Modbus-RTU Command in Master Mode ................................................. 87
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
VI
Chapter 16
DF1 Protocol Mode
General..................................................................................................................................................... 88
ABC Parameters ..................................................................................................................................... 89
Sub-network Parameters ....................................................................................................................... 90
Node Parameters.................................................................................................................................... 91
Services .................................................................................................................................................... 91
Available Services .......................................................................................................................... 92
Integrity Check ....................................................................................................................................... 93
Read Diagnostics .................................................................................................................................... 93
Read Data ................................................................................................................................................ 94
Write Data ............................................................................................................................................... 94
Chapter 17
Sub-network Monitor
Chapter 18
Node Monitor
General..................................................................................................................................................... 96
Navigating the Node Monitor.............................................................................................................. 97
Pull-Down Menu........................................................................................................................... 98
Toolbar Icons ................................................................................................................................. 99
Chapter 19
Data Logger
General................................................................................................................................................... 100
Operation............................................................................................................................................... 100
Configuration ........................................................................................................................................ 101
Chapter 20
Configuration Wizards
General................................................................................................................................................... 102
Selecting a Wizard Profile ................................................................................................................... 102
Wizard - Modbus RTU Master .......................................................................................................... 103
Chapter 21
Control and Status Registers
General................................................................................................................................................... 104
Handshaking Procedure ............................................................................................................... 104
Data Consistency ......................................................................................................................... 105
Status Register Contents (Gateway to Control System)................................................................. 106
General Information..................................................................................................................... 106
Status Codes in Master Mode and DF1 Master Mode................................................................. 106
Status Code in Generic Data Mode ............................................................................................. 107
Control Register Contents (Control System to Gateway).............................................................. 108
General Information..................................................................................................................... 108
Control Codes in Master Mode and DF1 Master Mode............................................................... 108
Control Codes in Generic Data Mode .......................................................................................... 108
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
VII
Chapter 22
CIP Object Implementation
General................................................................................................................................................... 109
Identity Object, Class 01h................................................................................................................... 110
General Information..................................................................................................................... 110
Class Attributes .......................................................................................................................... 110
Instance Attributes....................................................................................................................... 110
Message Router, Class 02h.................................................................................................................. 111
General Information..................................................................................................................... 111
Class Attributes .......................................................................................................................... 111
Instance Attributes....................................................................................................................... 111
Assembly Object, Class 04h ............................................................................................................... 112
General Information..................................................................................................................... 112
Class Attributes .......................................................................................................................... 112
Instance 64h (100) Attributes ..................................................................................................... 112
Instance 96h (150) Attributes ..................................................................................................... 112
Instance C6h (198) Attributes (Heartbeat Input-Only) ............................................................... 113
Instance C7h (199) Attributes (Heartbeat, Listen-Only)............................................................. 113
DLR Object, Class 47h........................................................................................................................ 113
General Information..................................................................................................................... 113
Class Attributes .......................................................................................................................... 114
Instance Attributes, Instance 01h................................................................................................. 114
Capability Flags .......................................................................................................................... 114
QoS Object, Class 48h ........................................................................................................................ 114
General Information..................................................................................................................... 114
Class Attributes .......................................................................................................................... 115
Instance Attributes, Instance 01h................................................................................................. 115
Diagnostic Object, Class AAh............................................................................................................ 116
General Information..................................................................................................................... 116
Class Attributes .......................................................................................................................... 116
Instance Attributes, Instance 01h................................................................................................. 116
Parameter Data Input Mapping Object, Class B0h ........................................................................ 117
General Information..................................................................................................................... 117
Class Attributes .......................................................................................................................... 117
Instance Attributes, Instance 01h................................................................................................. 117
Parameter Data Output Mapping Object, Class B1h ..................................................................... 118
General Information..................................................................................................................... 118
Class Attributes .......................................................................................................................... 118
Instance Attributes, Instance 01h................................................................................................. 118
Port Object, Class F4h ........................................................................................................................ 119
General Information..................................................................................................................... 119
Class Attributes .......................................................................................................................... 119
Instance Attributes, Instance 02h................................................................................................. 119
TCP/IP Interface Object, Class F5h ................................................................................................ 120
General Information..................................................................................................................... 120
Class Attributes .......................................................................................................................... 120
Instance Attributes....................................................................................................................... 120
Ethernet Link Object, Class F6h ....................................................................................................... 121
General Information..................................................................................................................... 121
Class Attributes .......................................................................................................................... 121
Instance Attributes....................................................................................................................... 122
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
VIII
Chapter 23
Advanced Fieldbus Configuration
General................................................................................................................................................... 123
Mailbox Editor...................................................................................................................................... 123
Appendix A Parameter Data Initialization (Explicit Data)
General................................................................................................................................................... 124
Add a Mailbox Message ...................................................................................................................... 124
Mapping Input Parameter Data to EtherNet/IP ............................................................................ 125
Mapping Output Parameter Data to EtherNet/IP......................................................................... 127
Appendix B Connector Pin Assignments
Ethernet Connector ............................................................................................................................. 129
Power Connector ................................................................................................................................. 129
PC Connector ....................................................................................................................................... 130
Sub-network Interface ......................................................................................................................... 131
General Information..................................................................................................................... 131
Bias Resistors (RS485 Only)....................................................................................................... 131
Termination (RS485 & RS422 Only) ....................................................................................... 131
Connector Pinout (DB9F) ........................................................................................................... 131
Typical Connection (RS485)........................................................................................................ 132
Typical Connection (RS422 & 4-Wire RS485) ......................................................................... 132
Typical Connection (RS232)........................................................................................................ 132
Appendix C Technical Specification
Mechanical Properties.......................................................................................................................... 133
Electrical Characteristics ..................................................................................................................... 133
Environmental Characteristics ........................................................................................................... 133
Regulatory Compliance ....................................................................................................................... 134
Appendix D Troubleshooting
Appendix E ASCII Table
Appendix F Copyright Notices
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
Preface
About This Document
For more information, documentation etc., please see www.anybus.com
Related Documents
Document name
ABC-EIP Installation Leaflet
DF1 Protocol and Command Set - Reference Manual, 1770-6.5.16, October 1996
Open Modbus/TCP Specification, Release 1.0
RFC 821
RFC 1918
ENIP Specifications
Author
HMS
Allen-Bradley
Schneider Electric
Network Working Group
Network Working Group
ODVA
Document History
Revision List
Revision
2.00
2.01
2.02
2.03
2.04
3.00
3.01
Date
2006-03-27
2006-12-22
2008-02-08
2008-11-03
2009-04-24
2011-02-01
2011-09-30
Author
PeP
PeP
PeP
HeS
KeL
KaD
KaD
3.02
4.00
4.10
2011-11-15 KaD
2012-06-08 KaD
Feb 2014 SDa
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Chapter
All
All
2, 8, A
1
All
All
All
Description
1st release
Misc. minor corrections
Minor update
Minor update
Misc. minor corrections and updates
Misc. corrections, new template and DF1 functionality
Misc corrections and updates, new Anybus Configuration Manager
name
P, 2, 3, 6, 8 Minor corrections and updates
P, 8, 22
Minor updates
Multiple
Added 2-ports version
Doc.ID: SCM-1200-096
About This Document P-10
Conventions & Terminology
The following conventions are used throughout this document:
•
Numbered lists provide sequential steps
•
Bulleted lists provide information, not procedural steps
•
The term ‘user’ refers to the person or persons responsible for installing the Anybus Communicator in a network.
•
The term ‘ABC’ refers to the Anybus Communicator.
•
Hexadecimal values are written in the format 0xNNNN, where NNNN is the hexadecimal value.
•
Decimal values are represented as NNNN where NNNN is the decimal value
•
As in all communication systems, the terms “input” and “output” can be ambiguous, because
their meaning depend on which end of the link is being referenced. The convention in this document is that “input” and “output” are always being referenced to the master/scanner end of the
link.
Glossary
Term
Meaning
Anybus® Communicator™
EIP
EtherNet/IP
Broadcaster
A protocol specific node in the sub-network scan that hold transactions destined to all nodes
Command
A protocol specific transaction.
Configuration
List of configured nodes with transactions on the sub-network
Fieldbus
The network to which the communicator is connected.
Frame
Higher level series of bytes forming a complete telegram on the sub-network
Monitor
A tool for debugging the Anybus Communicator and the network connections
Node
A device in the scan-list that defines the communication with a slave on the sub-network
Scan list
List of configured slaves with transactions on the sub-network
The network that logically is located on a subsidiary level with respect to the fieldbus and to
sub-network
which the Anybus Communicator acts as a gateway
A generic building block that is used in the sub-network scan-list and defines the data that is
Transaction
sent out the sub-network
Fieldbus Control System Fieldbus master
Higher Level Network
In this case, Ethernet (including EtherNet/IP and Modbus/TCP)
Network
Fieldbus
ABC
Sales and Support
For contact information and support, please refer to the contact and support pages at
www.anybus.com/support
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 1
1. About the Anybus Communicator for
EtherNet/IP
The Anybus Communicator for EtherNet/IP acts as a gateway between virtually any serial application
protocol and an EtherNet/IP-based network. Integration of industrial devices is enabled with no loss
of functionality, control and reliability, both when retro-fitting to existing equipment as well as when
setting up new installations.
EtherNet/IP Scanner
(e.g a PLC)
EtherNet/IP Scanner
(e.g a PLC)
(Ethernet)
(Ethernet)
HMI
PC
C / web
eb
b / SCADA
SC
HMI
PC
C / web
eb
b / SCADA
SC
INVERTER
INVERTER
PC configuration
and monitoring
PC configuration
and monitoring
Multi-drop up to 31 nodes
Serial communication
device
Serial communication devices
Single-Node Serial Sub Network
Multi-Node Serial Sub Network
sub-network
The Anybus Communicator can address up to 31 nodes, and supports the following physical standards:
•
RS-232
•
RS-422
•
RS-485
Ethernet Interface
Ethernet connectivity is provided through the patented Anybus technology; a proven industrial communication solution used all over the world by leading manufacturers of industrial automation products.
•
EtherNet/IP group 2 and 3 server
•
Modbus/TCP slave functionality
•
Server Side Include (SSI) functionality
•
Web server and E-mail client capabilities
•
FTP & Telnet servers
•
10/100 Mbit/s, twisted pair
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
About the Anybus Communicator for EtherNet/IP 12
1.1 External View
For wiring and pin assignments, see “Connector Pin Assignments” on page 129.
A: Ethernet Connectors
These connectors are used to connect the Anybus Communicator to the network.
B
See also...
- “Ethernet Connector” on page 129
A
B: Status LEDs
See also...
- “Status LEDs” on page 13
C: PC-connector
C
This connector is used to connect the gateway to a PC for
configuration and monitoring purposes.
D
F
See also...
- “PC Connector” on page 130
E
D: Sub-network Connector
This connector is used to connect the gateway to the serial
sub-network.
See also...
- “Sub-network Interface” on page 131
E: Power Connector
This connector is used to apply power to the gateway.
See also...
- “Power Connector” on page 129
F: DIN-rail Connector
The DIN-rail mechanism connects the gateway to PE (Protective Earth).
See also...
- “Hardware Installation” on page 14
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
About the Anybus Communicator for EtherNet/IP 13
1.2 Status LEDs
#
1 - Module Status
(only relevant for an EtherNet (/IP connection)
2 - Network Status
(only relevant for an EtherNet (/IP connection)
State
Off
Green
Green, flashing
Red
Red, flashing
Alternating Red/Green
Off
Green
Green, flashing
3 - Link
4 - Activity
5 - Subnet Statusa
Red
Red, flashing
Alternating Red/Green
Off
Green
Off
Green
Off
Green, flashing
Green
Red
6 - Device Status
Off
Alternating Red/Green
Green
Green, flashing
Red
Red, flashing
Status
No power
Controlled by a scanner in run state
Not configured, or scanner in idle state
Major fault (unrecoverable)
Minor fault (recoverable)
Self-test
No IP address (or no power)
Online, EtherNet/IP connection(s) established
Online, no EtherNet/IP connections established
Duplicate IP address detected, fatal error
One or more connections timed out
Self-test
No link (or no power)
Connected to an ethernet network
No ethernet activity (or no power)
Receiving or transmitting ethernet packet
(no power)
Running correctly, but one or more transaction error(s) have occurred
Running
Transaction error/timeout or subnet
stopped
(no power)
Invalid or missing configuration
Initializing
Running
1
2
3
4
5
6
Bootloader modeb
If the Device Status LED is flashing in a
sequence starting with one or more red
flashes, please note the sequence pattern
and contact HMS support.
a. This LED shows green when all transactions have been active at least once. This
includes any transactions using “change of state” or “change of state on trigger”. If
a timeout occurs on a transaction, this LED will show red.
b. The gateway is in bootloader mode, and firmware must be restored in order for it to
work properly. Start up the Anybus Configuration Manager and connect to the Anybus Communicator. Select Tools/Options/ABC. Click Factory Restore to restore
firmware. See “Tools” on page 61.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
About the Anybus Communicator for EtherNet/IP 14
1.3 Hardware Installation
Perform the following steps to install the Anybus Communicator module:
1. Snap the gateway on to the DIN-rail.
The DIN-rail mechanism works as follows:
1
To snap the ABC on, first press it downwards (1) to compress the spring
in the DIN-rail mechanism, then push it against the DIN-rail as to make
it snap on (2)
2
1
To snap the ABC off, push it downwards (1) and pull it out from the DINrail (2), as to make it snap off from the DIN-rail
2
2. Connect the gateway to an Ethernet network.
3. Connect the gateway to the serial sub-network.
4. Connect the gateway to the PC via the configuration cable.
5. Connect the power cable and apply power.
6. Start the Anybus Configuration Manager program on the PC.
(The Anybus Configuration Manager software will automatically attempt to detect the serial port.
If unsuccessful, select the correct port manually in the “Port”-menu)
7. Configure the gateway using the Anybus Configuration Manager and download the
configuration.
8. Set up the EtherNet/IP communication according to the gateway configuration.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
About the Anybus Communicator for EtherNet/IP 15
1.4 Software Installation
1.4.1 Anybus Configuration Manager
System requirements
•
Pentium 133 MHz or higher
•
650 MB of free space on the hard drive
•
32 MB RAM
•
Screen resolution of 800x600 (16 bit colour) or higher
•
Microsoft Windows™ 2000 / XP / Vista / 7 (32 bit)
•
Internet Explorer 4.01 SP1 or newer
Installation
•
Anybus Communicator resource CD
Insert the CD and follow the on-screen instructions. If the installation does not start automatically, right-click on the CD-drive icon and select Explore. Execute ‘setup.exe’ and follow the onscreen instructions.
•
From website
Download and execute the self-extracting .exe-file from the HMS website (www.anybus.com).
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 2
2. Basic Operation
2.1 General
The Anybus Communicator is designed to exchange data between a serial sub-network and a higher level
network. Unlike most other similar devices, the Anybus Communicator has no fixed protocol for the
sub-network, and consequently can be configured to handle almost any form of serial communication.
The gateway can issue serial telegrams cyclically, on change of state, or based on trigger events issued by
the control system in the higher level network (i.e. the fieldbus master or PLC). It can also monitor certain aspects of the sub-network communication and notify the higher level network when data has
changed.
An essential part of the Anybus Communicator package is the Anybus Configuration Manager, a Windows™ application that is used to supply the gateway with a description of the sub-network protocol.
No programming skills are required; instead, a visual protocol description system is used to specify the
various parts of the serial communication.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID SCM-1200-096
Basic Operation 17
2.2 Data Exchange Model
Internally, data exchanged on the sub-network and on
the higher level network all resides in the same memory.
ABC Internal Memory
This means that in order to exchange data with the subnetwork, the higher level network simply reads and
writes data to the memory locations specified using the
Anybus Configuration Manager. The very same memory locations can then be exchanged on the sub-network.
Input Data (512 bytes)
Higher Level Network
•
Output Data
(512 bytes)
Subnetwork
The internal memory buffer is divided into three areas,
based on function:
Input Data
(512 bytes)
This area can be read by the higher level network, the web server and the E-mail client.
(Data representation on the higher level network is described later in this chapter).
•
General Data
Output Data (512 bytes)
This area can be read/written to by the higher
level network, the web server and the E-mail client.
(Data representation on the higher level network is described later in this chapter).
•
General Data (up to 1024 bytes)
This area cannot be accessed from the higher level network, but can be used for transfers
between individual nodes on the sub-network, or as a general “scratch pad” for data. The actual
size of this area depends on the amount of data that is exchanged on the sub-network. The gateway can handle up to 1024 bytes of general data.
2.2.1 Memory Map
When building the sub-network configuration using the Anybus Configuration Manager, the different
areas described above are mapped to the memory locations (addresses) specified below.
Input Data
0x000
Output Data
0x200
Subnetwork:
Fieldbus:
E-mail Client:
SSI:
Read/Write
Read Only
Read Only
Read Only
0x1FF
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Subnetwork:
Fieldbus:
E-mail Client:
SSI:
0x3FF
General Data
0x400
Read Only
Read/Write
Read Only
Read/Write
Subnetwork:
Fieldbus:
E-mail Client:
SSI:
Read/Write
-
0x???
Doc.ID SCM-1200-096
Basic Operation 18
2.2.2 Data Exchange Example
In the following example, a temperature regulator on the sub-network exchanges information with a
PLC on the higher level network, via the internal memory buffers in the Anybus Communicator.
PLC (EtherNet/IP Scanner)
PLC Memory (Inputs)
PLC Memory (Outputs)
Actual Temperature
Temperature Setpoint
EtherNet/IP
The PLC Memory associated with
the ABC is exchanged;
Data from the Input Data area is copied to
PLC Input Memory, and PLC Output
Memory is copied to the Output Data
area.
The PLC exchange data between the internal
PLC memory and the slaves (in this case the
ABC) on the EtherNet/IP network.
ABC
Input Data
Output Data
0x000
Actual Temperature
General Data
0x200
0x400
Temperature Setpoint
(not used in this example)
0x3FF
The ABC copies the Output Register of
the Temperature Regulator to the InputData area.
The ABC copies the TemperatureSetpoint from the Output Data area to
the Input Register in the TemperatureRegulator.
Output Register
Input Register
Actual Temperature
Temperature Setpoint
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
0x???
Subnetwork
0x1FF
Serial Device - Temperature Regulator
The Temperature Regulator has two
registers, holding the Setpoint Temperature
and the Actual Temperature respectively.
Doc.ID SCM-1200-096
Basic Operation 19
2.3 Sub-network Protocol
2.3.1 Protocol Modes
The Anybus Communicator features three distinct operating modes for sub-network communication:
‘Master Mode’, ‘DF1 Master Mode’ and ‘Generic Data Mode’. Note that the protocol mode only specifies the basic communication model, not the actual sub-network protocol.
•
Master Mode
In this mode, the gateway acts as a master on the sub-network, and the serial communication is
query-response based. The nodes on the network are not permitted to issue messages unless first
addressed by the gateway .
For more information about this mode, see “Master Mode” on page 20.
•
DF1 Master Mode
In this mode, the gateway acts as a master on the sub-network, using the DF1 protocol. The serial
communication is query-response based. For more information about this mode, see “DF1 Protocol Mode” on page 88.
•
Generic Data Mode
In this mode, there is no master-slave relationship between the sub-network nodes and the gateway; any node on the sub-network, including the gateway, may spontaneously produce or consume messages.
For more information about this mode, see “Generic Data Mode” on page 21.
2.3.2 Protocol Building Blocks
The following building blocks are used in Anybus Configuration Manager to describe the sub-network
communication. How these blocks apply to the three protocol modes is described later in this document.
•
Node
A ‘node’ represents a single device on the sub-network. Each node can be associated with a
number of transactions, see below.
•
Transaction
A ‘transaction’ represents a complete serial telegram, and consists of a number of frame objects
(see below). Each transaction is associated with a set of parameters controlling how and when to
use it on the sub-network.
•
Commands
A ‘command’ is simply a predefined transaction stored in a list in the Anybus Configuration Manager. This simplifies common operations by allowing transactions to be stored and reused.
•
Frame Object
‘Frame objects’ are low level entities used to compose a transaction (see above). A frame object
can represent a fixed value (a constant), a range of values (limit objects), a block of data or a calculated checksum.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID SCM-1200-096
Basic Operation 20
2.3.3 Master Mode
In this mode, the communication is based on a query-response scheme; when the gateway issues a query
on the sub-network, the addressed node is expected to issue a response. Nodes are not permitted to issue
responses/messages spontaneously, i.e. without first receiving a query.
There is, however, one exception to this rule; the broadcaster. Most protocols offer some way of broadcasting messages to all nodes on the network, without expecting them to respond to the broadcasted
message. This is also reflected in the gateway, which features a dedicated broadcaster node.
Control System
Gateway
Subnetwork Devices
In Master Mode, Anybus Configuration Manager comes pre-loaded with the most commonly used
Modbus RTU commands, which can be conveniently reached by right-clicking on a node in the Anybus
Configuration Manager and selecting ‘Insert New Command’. Note, however, that this in no way
prevents other protocols based on the same query-response message-scheme from also being implemented.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID SCM-1200-096
Basic Operation 21
2.3.4 Generic Data Mode
In this mode, there is no master-slave relationship between the nodes on the sub-network and the gateway. Any node (including the gateway) may spontaneously produce or consume a message. Nodes are
not obliged to respond to messages, nor do they need to wait for a query in order to send a message.
Control System
Gateway
Subnetwork Devices
In the figure above, the Anybus Communicator ‘consumes’ data ‘produced’ by a node on the sub-network. This ‘consumed’ data can then be accessed from the higher level network. This also works the
other way around; the data received from the higher level network is used to ‘produce’ a message on the
sub-network, for ‘consumtion’ by a node.
2.3.5 DF1 Master Mode
Please refer to “DF1 Protocol Mode” on page 88.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID SCM-1200-096
Basic Operation 22
2.4 EtherNet/IP
2.4.1 General
EtherNet/IP is based on the Control and Information Protocol (CIP), which is also the application layer
for DeviceNet and ControlNet. The Anybus Communicator acts as a Group 2 or 3 server on the
EtherNet/IP network.
Input and output data is accessed using I/O connections or explicit messages towards the assembly object and the parameter input/output mapping objects.
See also...
•
“CIP Object Implementation” on page 109
2.4.2 Data Types
The input and output data hold two types of data; I/O data and parameter data. I/O data is exchanged
on change of value, and can be accessed using I/O connections towards the assembly object.
Parameter data can be accessed acyclically via the parameter input and output mapping objects. Note,
however, that each instance attribute within these objects must be created manually using the Anybus
Configuration Manager. For more information see “Parameter Data Initialization (Explicit Data)” on
page 124.
See also...
•
“Assembly Object, Class 04h” on page 112
•
“Parameter Data Input Mapping Object, Class B0h” on page 117
•
“Parameter Data Output Mapping Object, Class B1h” on page 118
•
“Fieldbus Settings” on page 64
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID SCM-1200-096
Basic Operation 23
2.4.3 Memory Layout
I/O sizes are specified using the Anybus Configuration Manager and correlate to the Anybus Communicator memory as follows:
Example:
I/O Sizes for the gateway set to the following values:
IO Size In= 256 bytes (0x0100)
IO Size Out= 128 bytes (0x0080)
Resulting memory layout:
Input Data
0x000
Output Data
0x200
General Data
0x400
I/O Data (Output)
I/O Data (Input)
0x27F
0x280
(Cannot be accessed
from EtherNet/IP)
0x0FF
0x100
Parameter Data (Output)
Parameter Data (Input)
0x1FF
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
0x3FF
0x???
Doc.ID SCM-1200-096
Basic Operation 24
2.5 Modbus/TCP
2.5.1 General
The Modbus/TCP protocol is an implementation of the standard Modbus protocol running on top of
TCP/IP. The built-in Modbus/TCP server provides access to the input and output data areas via a subset of the functions defined in the Modbus/TCP specification.
The server supports up to 8 simultaneous connections and communicates over TCP port 502. For detailed information regarding the Modbus/TCP protocol, consult the Open Modbus Specification.
2.5.2 Addressing Modes
The Anybus Communicator features two different modes of operation regarding the Modbus communication:
•
Modbus Addressing Mode (Default)
In this mode, the input and output data areas are mapped to different function codes.
Note that coil addressing is not possible in this mode.
See also...
- “Modbus Addressing Mode” on page 25
•
Anybus Addressing Mode
Compared to Modbus Addressing Mode, this mode allows data to be addressed in a more flexible
way. Note however that several function codes can be used to access the same data in the gateway. While this may appear confusing at first, it allows data to be manipulated in ways not possible in Modbus Addressing Mode (e.g. it is possible to manipulate individual bits of a register by
accessing coils associated with the same memory location).
See also...
- “Anybus Addressing Mode” on page 26
2.5.3 Supported Exception Codes
Code
0x01
0x02
0x03
Name
Illegal function
Illegal data address
Illegal data value
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Description
The function code in the query is not supported
The data address received in the query is outside the initialized memory area
The data in the request is illegal
Doc.ID SCM-1200-096
Basic Operation 25
2.5.4 Modbus Addressing Mode
Supported Function Codes
The following function codes can be used in this mode:
Modbus Function
Function Code Associated with Area
Read Holding Registers 3
Output Data area
(0x200...0x3FF)
Read Input Registers
4
Input Data area
(0x000....0x1FF)
Write Single Register
6
Output Data area
(0x200...0x3FF)
Force Multiple Registers 16
Mask Write Register
Read/Write Registers
22
23
No. of I/Os or Data Points per Command
1 - 125 registers
1 - 125 registers
1 register
1 - 800 registers
1 register
125 registers read / 100 registers write
Input Register Map
The input data area is mapped to input registers as follows:
Register #
1
2
3
4
5
6
...
255
256
Memory Location in the gateway
0x000... 0x001
0x002... 0x003
0x004... 0x005
0x006... 0x007
0x008... 0x009
0x00A... 0x00B
...
0x1FC... 0x1FD
0x1FE... 0x1FF
Comments
Each register corresponds to two bytes in the input
data area.
Holding Register Map
The output data area is mapped to holding registers as follows:
Register #
1
2
3
4
5
6
...
255
256
Memory Location in the gateway
0x200... 0x201
0x202... 0x203
0x204... 0x205
0x206... 0x207
0x208... 0x209
0x20A... 0x20B
...
0x3FC... 0x3FD
0x3FE... 0x3FF
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Comments
Each register corresponds to two bytes in the output data area.
Doc.ID SCM-1200-096
Basic Operation 26
2.5.5 Anybus Addressing Mode
Supported Function Codes
The following function codes can be used in this mode:
Modbus Function
Read Coil
Read Input Discretes
Read Holding Registers
Read Input Registers
Write Coil
Write Single Register
Force Multiple Coils
Force Multiple Registers
Mask Write Register
Read/Write Registers
Function Code
1
2
3
4
5
6
15
16
22
23
Associated with Area(s)
No. of I/Os or Data Points per Command
Input and Output Data Area 1 - 2000 bits
(0x000... 0x3FF)
1 - 2000 bits
1 - 125 registers
1 - 125 registers
Output Data Area (0x200... 1 bit
0x3FF)
1 register
1 - 800 bits
1 - 100 registers
1 register
Input and Output Data Area 125 registers read/100 registers write
(0x000... 0x3FF)
Coil & Register Map
The input and output data areas are mapped to coils and registers as follows:
Register #
1
2
3
4
...
255
256
257
...
1024
1025
1026
1027
1028
...
1279
1280
Coil #
1... 16
17... 32
33... 48
49... 64
...
4065... 4080
4081... 4096
4097... 4112
...
16369... 16384
16385... 16400
16401... 16416
16417... 16432
16433... 16448
...
20449... 20464
20465... 20480
Memory Location in ABC
0x000... 0x001
0x002... 0x003
0x004... 0x005
0x006... 0x007
...
0x1FC... 0x1FD
0x1FE... 0x1FF
Area
Input Data area
Comments
-
-
-
(reserved)
0x200... 0x201
0x202... 0x203
0x204... 0x205
0x206... 0x207
...
0x3FC... 0x3FD
0x3FE... 0x3FF
Output Data area
-
Note 1: The table above applies to all function codes.
Note 2: Coils are mapped MSB first, i.e. coil 0 corresponds to bit 15 of register 0.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID SCM-1200-096
Chapter 3
3. File System
3.1 General
General
The Anybus Communicator features a built-in file system, which is used to store information such as
web files, network communication settings, e-mail messages etc.
Storage Areas
The file system consists of the different storage areas:
•
Non-volatile area (approx. 1.4 Mb)
This section is intended for static files such as web files, configurations files etc.
•
Volatile area (approx. 1 Mb)
This area is intended for temporary storage; data placed here will be lost in case of power loss or
reset.
Conventions
•
‘\’ (backslash) is used as a path separator
•
A ‘path’ originates from the system root and as such must begin with a ‘\’
•
A ‘path’ must not end with a ‘\’
•
Names may contain spaces (‘ ‘) but must not begin or end with one.
•
Names may not contain the following characters: ‘\ / : * ? “ < > |’
•
Names cannot be longer than 48 characters (plus null termination)
•
A path cannot be longer than 256 characters (filename included)
•
The maximum number of simultaneously open files is 40
•
The maximum number of simultaneously open directories is 40
Important Note:
The non-volatile storage is located in FLASH memory. Each FLASH segment can be erased approximately 100 000 times.
The following operations will erase one or more FLASH segments:
•
Deleting, moving or renaming a file or directory
•
Writing or appending data to an existing file
•
Formatting the file system
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
File System 28
3.2 File System Overview
(admin root)
(user root)
user
ip_accs.cfg
ssi_str.cfg
http.cfg
pswd
ethcfg.cfg
onoffln.cfg
(protected)
sys_pswd.cfg
email
RAM
(volatile, optional)
email_1.cfg
.
.
.
email_10.cfg
pswd
(protected)
ad_pswd.cfg
email
email_1.cfg
.
.
.
email_10.cfg
3.3 System Files
The file system contains a set of files used for system configuration. These files, known as “system files”,
are regular ASCII files that can be altered using a standard text editor (such as the Notepad in Microsoft
Windows™). Note that some of these files may also be altered by the gateway itself, e.g. when using SSI
(see “Server Side Include (SSI)” on page 45).
The format of the system files are based on the concept of ‘keys’, where each ‘key’ can be assigned a
value, see example below.
Example:
[Key1]
value of key1
[Key2]
value of key2
The exact format of each system file is described in detail later in this document.
The contents of the above files can be redirected:
Example:
In this example, the contents will be loaded from the file ‘here.cfg’.
[file path]
\i\put\it\over\here.cfg
Note: Any directory in the file system can be protected from web access by placing the file web-accs.cfg
in the directory, see “Authorization” on page 43.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 4
4. FTP Server
4.1 General
The built-in FTP server provides a way to access the file system using a standard FTP client.
The following port numbers are used for FTP communication:
•
TCP, port 20 (FTP data port)
•
TCP, port 21 (FTP command port)
Security Levels
The FTP server features two security levels; admin and normal.
•
Normal level users
The root directory will be ‘\user’.
•
Admin level users
The root directory will be ‘\’, i.e. the user has unrestricted access to the file system.
User Accounts
The user accounts are stored in two files, which are protected from web access:
•
‘\user\pswd\sys_pswd.cfg’
This file holds the user accounts for normal level users.
•
‘\pswd\ad_pswd.cfg’
This file holds the user accounts for admin level users.
File Format:
The format of these files are as follows:
Username1:Password1
Username2:Password2
Username3:Password3
Note 1: If no valid user accounts have been defined, the gateway will grant admin level access to all users. In such cases, the FTP accepts any username/password combination, and the root directory will be
‘\’.
Note 2: The FTP server shares user accounts with the Telnet server.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
FTP Server 30
4.2 FTP Connection Example (Windows Explorer)
The built-in FTP client in Windows Explorer can easily be used to access the file system as follows:
1. Open the Windows Explorer by right-clicking on the ‘Start’ button and selecting ‘Explore’.
2. In the address field, type FTP://<user>:<password>@<address>
- Substitute <address> with the IP address of the Anybus Communicator
- Substitute <user> with the username
- Substitute <password> with the password
3. Press enter. The Explorer will now attempt to connect to the gateway using the specified settings.
If successful, the built in file system is displayed in the Explorer window.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 5
5. Telnet Server
5.1 General
The built-in Telnet server provides a way to access the file system using a standard Telnet client. The
server communicates through TCP port 23.
Security Levels
Just like the FTP server, the Telnet server features two security levels; admin and normal.
•
Normal level users
The root directory will be ‘\user’.
•
Admin level users
The root directory will be ‘\’, i.e. the user has unrestricted access to the file system.
User Accounts
The Telnet server shares user accounts with the FTP server. If no valid user accounts have been defined,
the gateway will grant admin level access to all users. In such case, no login is required, and the root directory will be ‘\’.
For more information, see “User Accounts” on page 29
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Telnet Server 32
5.2 General Commands
admin
•
Syntax
admin
•
Description
Provided that the user can supply a valid admin username/password combination, this command
provides admin access rights to normal level users.
exit
•
Syntax
exit
•
Description
This command closes the Telnet session.
help
•
Syntax
help [general|diagnostic|filesystem]
•
Description
If no argument is specified, the following menu will be displayed.
General commands:
help
version
exit
- Help with menus
- Display version information
- Exit station program
Also try ‘help [general|diagnostic|filesystem]’
version
•
Syntax
version
•
Description
This command will display version information, serial number and MAC ID of the Ethernetmodule, in the Communicator.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Telnet Server 33
5.3 Diagnostic Commands
arps
•
Syntax
arps
•
Description
Display ARP stats and table
iface
•
Syntax
iface
•
Description
Display net interface stats
routes
•
Syntax
routes
•
Description
Display IP route table
sockets
•
Syntax
sockets
•
Description
Display socket list
5.4 File System Operations
For commands where filenames, directory names or paths shall be given as an argument the names can
be written directly or within quotes. For names including spaces the filenames must be surrounded by
quotes. It is also possible to use relative pathnames using ‘.’, ‘\’ and ’..’
append
•
Syntax
append [file] [“The line to append”]
•
Description
Appends a line to a file.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Telnet Server 34
cd
•
Syntax
cd [path]
•
Description
Changes current directory.
copy
•
Syntax
copy [source] [destination]
•
Description
This command creates a copy of the source file at a specified location.
del
•
Syntax
del [file]
•
Description
Deletes a file.
dir
•
Syntax
dir [path]
•
Description
Lists the contents of a directory. If no path is given, the contents of the current directory is listed.
df
•
Syntax
df
•
Description
Displays filesystem info.
format
•
Syntax
format
•
Description
Formats the filesystem. This is a privileged command and can only be called in administration
mode.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Telnet Server 35
md
•
Syntax
md [directory]
•
Description
Creates a directory. If no path is given, the directory is created in the current directory.
mkfile
•
Syntax
mkfile [filename]
•
Description
Creates an empty file.
move
•
Syntax
move [source] [destination]
•
Description
This command moves a file or directory from the source location to a specified destination.
rd
•
Syntax
rd [directory]
•
Description
Removes a directory. The directory can only be removed if it is empty.
ren
•
Syntax
ren [old name] [new name]]
•
Description
Renames a file or directory.
type
•
Syntax
type [filename]
•
Description
Types the contents of a file.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 6
6. Basic Network Configuration
6.1 General Information
The Anybus Communicator offers two modes of operation regarding the network settings:
•
Settings specified in Anybus Configuration Manager
When valid settings have been specified in Anybus Configuration Manager
(‘TCP/IP Settings’ = enabled), then these are the settings the gateway will use.
When settings have been specified in Anybus Configuration Manager, the contents of the system
file ‘ethcfg.cfg’ will be ignored completely, causing the following behavior:
- DNS services will not be available
- Domain and Host name cannot be set
- E-mail services will not be available
- Network settings received via HICP or DCP) will be lost in the event of a power loss or a
reset.
•
Settings specified in ‘ethcfg.cfg’
If no settings are specified in Anybus Configuration Manager (i.e. ‘TCP/IP Settings’ = disabled),
the gateway will use the settings stored in the system file ‘ethcfg.cfg’.
If this file is missing, the gateway will attempt to retrieve the settings via DHCP or HICP for 30
seconds. If no configuration has been received within this period, the gateway will halt and indicate an error on the on-board LEDs.
EtherNet/IP
The TCP/IP settings can be accessed from EtherNet/IP through the TCP/IP Interface Object.
See also...
•
“TCP/IP Interface Object, Class F5h” on page 120
DHCP/BootP
The Anybus Communicator can retrieve the TCP/IP settings from a DHCP or BootP server. If no
DHCP server is found, the gateway will default to its current settings (i.e. those in ‘\ethcfg.cfg’).
If no current settings are available (i.e. ‘ethcfg.cfg’ is missing, or contains invalid settings), the gateway
will halt and indicate an error on the on-board status LEDs (the network configuration may however
still be accessed via HICP, see “Anybus IPconfig (HICP)” on page 41.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Basic Network Configuration 37
6.2 Ethernet Configuration File (‘ethcfg.cfg’)
6.2.1 General
To exist on the network, the Anybus Communicator needs a valid TCP/IP configuration. These settings
are stored in the system file ‘\ethcfg.cfg’. Note that if TCP/IP settings are enabled in Anybus Configuration Manager, then the IP address, gateway and subnet settings in ethcfg.cfg will be overwritten every
time the module is restarted. All other settings are unaffected.
Parametera
IP address
Subnet mask
Gateway address
DHCP/BOOTP
0.0.0.0
0.0.0.0
0.0.0.0
OFF
Comm1
auto
Comm2
auto
HICP Password
“” (empty string)
SMTP address
SMTP username
SMTP password
DNS1 address
DNS2 address
Domain name
Host name
Mcast TTL
Mcast Alloc Control
Mcast Num Mcast
Mcast Start Addr
802.1Q Enable
“” (empty string)
“” (empty string)
“” (empty string)
0.0.0.0
0.0.0.0
“” (empty string)
“” (empty string)
1
0
1
0
0
DSCP Urgent
DSCP Scheduled
DSCP High
DSCP Low
DSCP Explicit
55
47
43
31
27
Default
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Description/Comment
DHCP/BOOTP
Value: Meaning:
ON
Enabled
OFF
Disabled
Comm1, settings for port 1
Value: Meaning:
auto
Auto negotiation will be used
100FDX Forces port 1 of the module to operate only at 100 Mbit, full-duplex
100HDX Forces port 1 of the module to operate only at 100 Mbit, half -uplex
10FDX Forces port 1 of the module to operate only at 10 Mbit, full-duplex
10HDX Forces port 1 of the module to operate only at 10 Mbit, half-duplex
Comm2, settings for port 2
Value: Meaning:
auto
Auto negotiation will be used
100FDX Forces port 2 of the module to operate only at 100 Mbit, full-duplex
100HDX Forces port 2 of the module to operate only at 100 Mbit, half -duplex
10FDX Forces port 2 of the module to operate only at 10 Mbit, full-duplex
10HDX Forces port 2 of the module to operate only at 10 Mbit, half-duplex
SMTP login/server settings.
Username and password are only necessary if required by the server.
Primary and secondary DNS.
Required for resolving host names.
Default domain name for not fully qualified host names (Max. 48 char.)
Host name (Max. 64 char.)
Multicast Time-To-Live
Multicast address allocation
Number of IP multicast addresses
Starting multicast address
Enable 802.1Q
Value: Meaning:
1
Enabled
0
Disabled
Priority for CIP transport class 1 messages of different categories.
Priority for CIP UCMM and CIP class 3 messages.
Doc.ID: SCM-1200-096
Basic Network Configuration 38
Parametera
Select ACD
Default
Description/Comment
1
ACD activityb
0
Enable Address Conflict Detection
Value: Meaning:
1
Enabled
0
Disabled
State of Address Conflict Detection activity.
Remote MACb
00:00:00:00:00:00 MAC address of the remote node for which an address conflict is detected.
Retrieved from the ARP PDU.
0
Address Resolution Protocol, Protocol Data Unit.
ARP PDUb
a. When used in the configuration file, a parameter must be enclosed by brackets.
b. Read-only parameter. Used to e.g. detect why a restart was required.
The settings in this file may also be affected by...
•
EtherNet/IP (See “EtherNet/IP” on page 36).
•
HICP (See “Anybus IPconfig (HICP)” on page 41)
•
SSI (See “Server Side Include (SSI)” on page 45)
See also...
•
“FTP Server” on page 29
•
“Fieldbus Settings” on page 64
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Basic Network Configuration 39
6.3 IP Access Control
It is possible to specify which IP addresses are permitted to connect to the Anybus Communicator. This
information is stored in the system file ‘\ip_accs.cfg’.
File Format:
[Web]
xxx.xxx.xxx.xxx
•
Nodes listed here may access the web server
[FTP]
xxx.xxx.xxx.xxx
•
Nodes listed here may access the FTP server
[Modbus/TCP]
xxx.xxx.xxx.xxx
•
Nodes listed here may access the gateway via Modbus/TCP
[EtherNet/IP]
xxx.xxx.xxx.xxx
•
Nodes listed here may access the gateway via EtherNet/IP
[All]
xxx.xxx.xxx.xxx
•
Fallback setting, used by the gateway when one or several of the
keys above are omitted
Note: ‘*’ may be used as a wildcard to select IP series.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Basic Network Configuration 40
6.4 On/Offline Configuration
By default, the On/Offline indication is triggered by the link status. Other triggering options can however be specified in the optional system file ‘\onoffln.cfg’, which should be placed in the module root
and looks as follows:
•
File Format:
[ON/OFF-line trigger]
Modbus
Values: ‘Link’ (default), ‘EIP’, ‘Modbus’ or a combination
•
Timeout Value
Range: 1... 65535 (default = 1).
[Timeout]
10
[Commands]
3, 16, 23
On/Offline trigger source
A value of 10 equals 1000 ms.
•
Commands (Optional)
Selects what Modbus commands that must be
received during the timeout period.
[ON-line method]
1
If the keyword ‘ALL’ is given (default), the On/
Offline functionality will trigger on all Modbus
commands.
•
Online method (Optional)
Defines how to handle data in the OUT I/O area
when going from Offline to Online.
If “1” (default), “old data” is restored
If “2”, “Offline” data is kept until overwritten by
master.
The contents of this file can be redirected by placing the line ‘[File path]’ on the first row, and a file path
on the second.
File example:
[File path]
\my_settings\on-off-line_configuration.cfg
In this example, the settings described above will be loaded from the file ‘\my_settings\on-offline_configuration.cfg’.
Note 1: The keys ‘[Timeout]’ and ‘[Commands]’ shall only be given if the On/Offline Trigger value is
set to ‘Modbus’.
Note 2: The settings in this file will be ignored if the application has issued the mailbox message
MB_ON_OFF_LINE_CONFIG. See “Advanced Fieldbus Configuration” on page 123.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Basic Network Configuration 41
6.5 Anybus IPconfig (HICP)
The Anybus Communicator supports the HICP protocol used by the Anybus IPconfig utility from
HMS, which can be downloaded free of charge from the HMS website. This utility may be used to configure the network settings of any Anybus product connected to the network. Note that if successful,
this will replace the settings currently stored in the configuration file (‘ethcfg.cfg’).
Upon starting the program, the network
is scanned for Anybus products. The network can be rescanned at any time by
clicking ‘Scan’. In the list of detected devices, the gateway will appear as ‘ABCEIP’. To alter its network settings, double-click on its entry in the list.
A window will appear, containing the IP
configuration and password settings.
Validate the new settings by clicking ‘Set’,
or click ‘Cancel’ to abort.
Optionally, the configuration may be
protected from unauthorized access by a password. To enter a password, click on the ‘Change password’
checkbox, and enter the password under ‘New password’. When protected, any changes in the configuration requires that the user supplies a valid password.
When done, click ‘Set’. The new IP configuration will now be stored in the configuration file (‘ethcfg.cfg’).
Note that if ‘TCP/IP Settings’ has been enabled in the Anybus Configuration Manager, any settings received via HICP will be lost in the event of a power loss or reset.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 7
7. Web Server
7.1 General
The Anybus Communicator features a flexible web server with SSI capabilities. The built-in web pages
can be customized to fit a particular application and allow access to I/O data and configuration settings.
The web server communicates through port 80.
See also...
•
“Server Side Include (SSI)” on page 45
•
“IP Access Control” on page 39
Protected Files
For security reasons, the following files are protected from web access:
•
Files located in ‘\user\pswdcfg\pswd’
•
Files located in ‘\pswd’
•
Files located in a directory which contains a file named ‘web_accs.cfg’
Default Web Pages
The Anybus Communicator contains a set of virtual files which can be used when building a web page
for configuration of network parameters. These virtual files can be overwritten (not erased) by placing
files with the same name in the root of disc 0.
This makes it possible to, for example, replace the HMS logo by uploading a new logo named ‘\logo.jpg’.
It is also possible to make links from a web page to the virtual configuration page. In such case the link
shall point to ‘\config.htm’.
These virtual files are:
\index.htm
\config.htm
\configform.htm
\configform2.htm
\store.htm
\logo.jpg
\configuration.gif
\boarder.bg.gif
\boarder_m_bg.gif
\index.htm
l
\eth_stat.html
\cip_stat.html
\ip_config.shtm
\smtp_config.shtm
\style.css
\arrow_red.gif
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
-
Points to the
Configuration
Configuration
Configuration
Configuration
HMS logo
Configuration
picture
picture
Points to the
Configuration
Configuration
Configuration
Configuration
HMS logo
Configuration
contents of config.htm
frame page
form page
form page
store page
picture
contents of config.htm
frame page
form page
form page
store page
picture
Doc.ID: SCM-1200-096
Web Server 43
7.2 Authorization
Directories can be protected from web access by placing a file called ‘web_accs.cfg’ in the directory to
protect. This file shall contain a list of users that are allowed to access the directory and its subdirectories.
File Format:
Username1:Password1
Username2:Password2
...
UsernameN:PasswordN
[AuthName]
(message goes here)
•
List of approved users.
•
Optionally, a login message can be specified by including the
key [AuthName]. This message will be displayed by the web
browser upon accessing the protected directory.
The list of approved users can optionally be redirected to one or several other files.
Example:
In this example, the list of approved users will be loaded from the files ‘here.cfg’ and ‘too.cfg’.
[File path]
\i\put\it\over\here.cfg
\i\actually\put\some\of\it\over\here\too.cfg
[AuthName]
Yeah. Whatsda passwoid?
Note that when using this feature, make sure to put the user/password files in a directory that is protected from web access, see “Protected Files” on page 42.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Web Server 44
7.3 Content Types
By default, the following content types are recognized by their file extension:
Content Type
text/html
image/gif
image/jpeg
image/x-png
application/x-javascript
text/plain
application/x-zip-compressed
application/octet-stream
text/vnd.wap.wml
application/vnd.wap.wmlc
image/vnd.wap.wbmp
text/vnd.wap.wmlscript
application/vnd.wap.wmlscriptc
text/xml
application/pdf
File Extension
*.htm, *.html, *.shtm
*.gif
*.jpeg, *.jpg, *.jpe
*.png
*.js
*.bat, *.txt, *.c, *.h, *.cpp, *.hpp
*.zip
*.exe, *.com
*.wml
*.wmlc
*.wbmp
*.wmls
*.wmlsc
*.xml
*.pdf
It is possible to configure/reconfigure the reported content types, and which files that shall be scanned
for SSI. This is done in the system file ‘\http.cfg’.
File Format:
[FileTypes]
FileType1:ContentType1
FileType2:ContentType2
...
FileTypeN:ContentTypeN
[SSIFileTypes]
FileType1
FileType2
...
FileTypeN
Note: Up to 50 content types and 50 SSI file types may be specified in this file.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.ID: SCM-1200-096
Chapter 8
Server Side Include (SSI)
General
Server Side Include (from now on referred to as SSI) functionality enables dynamic content to be used
on web pages and in e-mail messages.
SSI are special commands embedded in the source document. When the Anybus module encounters
such a command, it will execute it, and replace it with the result (when applicable).
Syntax
The ‘X’s below represents a command opcode and parameters associated with the command.
<?--#exec cmd_argument=’XXXXXXXXXXXXXXXXXXXXXX’-->
Example
The following example causes a web page to display the Ethernet Mac ID of the module:
<HTML>
<HEAD><TITLE>SSI Test</TITLE></HEAD>
<BODY>
The Ethernet Mac ID of the Anybus module is:
<?--#exec cmd_argument=’DisplayMacID’-->
</BODY>
</HTML>
Resulting webpage:
The Ethernet Mac ID of the ABC is: 00:30:11:78:9A:BC
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 46
Functions
DisplayMacID
This function returns the MAC ID in format xx:xx:xx:xx:xx:xx.
Syntax:
<?--#exec cmd_argument=’DisplayMacId’-->
DisplaySerial
This function returns the serial number of the Anybus module.
Syntax:
<?--#exec cmd_argument=’DisplaySerial’-->
DisplayFWVersion
This function returns the main firmware revision of the Anybus module.
Syntax:
<?--#exec cmd_argument=’DisplayFWVersion’-->
DisplayBLVersion
This function returns the bootloader firmware revision of the Anybus module.
Syntax:
<?--#exec cmd_argument=’DisplayBLVersion’-->
DisplayIP
This function returns the currently used IP address.
Syntax:
<?--#exec cmd_argument=’DisplayIP’-->
DisplaySubnet
This function returns the currently used Subnet mask.
Syntax:
<?--#exec cmd_argument=’DisplaySubnet’-->
DisplayGateway
This function returns the currently used Gateway address.
Syntax:
<?--#exec cmd_argument=’DisplayGateway’-->
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 47
DisplayDNS1
This function returns the address of the primary DNS server.
Syntax:
<?--#exec cmd_argument=’DisplayDNS1’-->
DisplayDNS2
This function returns the address of the secondary DNS server.
Syntax:
<?--#exec cmd_argument=’DisplayDNS2’-->
DisplayHostName
This function returns the hostname.
Syntax:
<?--#exec cmd_argument=’DisplayHostName’-->
DisplayDomainName
This function returns the default domain name.
Syntax:
<?--#exec cmd_argument=’DisplayDomainName’-->
DisplayDhcpState
This function returns whether DHCP/BootP is enabled or disabled.
Syntax:
<?--#exec cmd_argument=’DisplayDhcpState( "Output when ON", "Output when OFF"
)’-->
DisplayDhcpSupport
This function returns ‘Arg1’ if it’s enabled and ‘Arg2’ if it’s disabled.
Syntax:
<?--#exec cmd_argument=’DisplayDhcpSupport( "Arg1", "Arg2" )’-->
DisplayEmailServer
This function returns the currently used SMTP server address.
Syntax:
<?--#exec cmd_argument=’DisplayEmailServer’-->
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 48
DisplaySMTPUser
This function returns the username used for SMTP authentication.
Syntax:
<?--#exec cmd_argument=’DisplaySMTPUser’-->
DisplaySMTPPswd
This function returns the password used for SMTP authentication.
Syntax:
<?--#exec cmd_argument=’DisplaySMTPPswd’-->
DisplayStationName
This function returns the PROFINET Station Name.
Syntax:
<?--#exec cmd:argument=’DisplayStationName’-->
DisplayStationType
This function returns the PROFINET Station Type.
Syntax:
<?--#exec cmd:argument=’DisplayStationType’-->
DisplayVendorID
This function returns the PROFINET Vendor ID.
Syntax:
<?--#exec cmd:argument=’DisplayVendorId’-->
DisplayDeviceID
This function returns the PROFINET DeviceID.
Syntax:
<?--#exec cmd:argument=’DisplayDeviceId’-->
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 49
StoreEtnConfig
Note: This function cannot be used in e-mail messages.
This SSI function stores a passed IP configuration in the configuration file ‘ethcfgIP.cfg’.
Syntax:
<?--#exec cmd_argument=’StoreEtnConfig’-->
Include this line in a HTML page and pass a form with new IP settings to it.
Accepted fields in form:
SetIp
SetSubnet
SetGateway
SetEmailServer
SetDhcpState - value "on" or "off"
SetDNS1
SetDNS2
SetHostName
SetDomainName
SetSMTPUser
SetSMTPPswd
Default output:
Invalid IP address!
Invalid Subnet mask!
Invalid Gateway address!
Invalid IP address or Subnet mask!
Invalid Email Server IP address!
Invalid DHCP state!
Invalid DNS1!
Invalid DNS2!
Configuration stored correctly.
Failed to store configuration.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 50
GetText
Note: This function cannot be used in e-mail messages.
This SSI function gets the text from an object and stores it in the OUT area.
Syntax:
<?--#exec cmd_argument=’GetText( "ObjName", OutWriteString ( offset ), n )’-->
ObjName- Name of object.
offset - Specifies the offset from the beginning of the OUT area.
n
- Specifies maximum number of characters to read (Optional)
Default output:
Success
Failure
- Write succeeded
- Write failed
printf
This SSI function includes a formatted string, which may contain data from the Anybus IN/OUT area,
on a web page. The formatting of the string is equal to the standard C function printf().
Syntax:
<?--#exec cmd_argument=’printf("String to write", Arg1, Arg2, ..., ArgN)’-->
Like the standard C function printf() the "String to write" for this SSI function contains two types of
objects: Ordinary characters, which are copied to the output stream, and conversion specifications, each
of which causes conversion and printing of the next successive argument to printf. Each conversion
specification begins with the character % and ends with a conversion character. Between the % and the
conversion character there may be, in order:
•
Flags (in any order), which modify the specification:
+
(space)
0
#
which specifies left adjustment of the converted argument in its field.
which specifies that the number will always be printed with a sign
if the first character is not a sign, a space will be prefixed.
for numeric conversions, specifies padding to the field with leading zeroes.
which specifies an alternate output form. For o, the first digit will be zero. For x or
X, 0x or 0X will be prefixed to a non-zero result. For e, E,f, g and G, the output
will always have a decimal point; for g and G, trailing zeros will not be removed.
•
A number specifying a minimum field width. The converted argument will be printed in a field
at least this wide, and wider if necessary. If the converted argument has fewer characters than the
field width it will be padded on the left (or right, if left adjustment has been requested) to make
up the field width. The padding character is normally space, but can be 0 if the zero padding flag
is present.
•
A period, which separates the field width from the precision.
•
A number, the precision, that specifies the maximum number of characters to be printed from a
string, or the number of digits to be printed after the decimal point for e, E, or F conversions,
or the number of significant digits for g or G conversion, or the minimum number of digits to
be printed for an integer (leading 0s will be added to make up the necessary width)
•
A length modifier h, l (letter ell), or L. "h" Indicates that the corresponding argument is to be
printed as a short or unsigned short; "l" indicates that the argument is along or unsigned long.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 51
The conversion characters and their meanings are shown below. If the character after the % is not a conversion character, the behavior is undefined.
Character
d, i
o
x, X
u
c
s
f
e, E
g, G
%
Argument type, Converted to
byte, short; decimal notation (For signed representation. Use signed argument)
byte, short; octal notation (without a leading zero).
byte, short; hexadecimal notation (without a leading 0x or 0X), using abcdef for 0x or ABCDEF for
0X.
byte, short; decimal notation.
byte, short;single character, after conversion to unsigned char.
char*; characters from the string are printed until a "\0" is reached or until the number of characters
indicated by the precision have been printed
float; decimal notation of the form [-]mmm.ddd, where the number of d’s is specified by the precision. The default precision is 6; a precision of 0 suppresses the decimal point.
float; decimal notation of the form [-]m.dddddd e+-xx or[-]m.ddddddE+-xx, where the number of d’s
specified by the precision. The default precision is 6; a precision of 0 suppresses the decimal point.
float; %e or %E is used if the exponent is less than -4 or greater than or equal to the precision; otherwise %f is used. Trailing zeros and trailing decimal point are not printed.
no argument is converted; print a %
The arguments that can be passed to the SSI function printf are:
Argument
InReadSByte(offset)
InReadUByte(offset)
InReadSWord(offset)
InReadUWord(offset)
InReadSLong(offset)
InReadULong(offset)
InReadString(offset)
InReadFloat(offset)
OutReadSByte(offset)
OutReadUByte(offset)
OutReadSWord(offset)
OutReadUWord(offset)
OutReadSLong(offset)
OutReadULong(offset)
OutReadString(offset)
OutReadFloat(offset)
MbReadSByte(id)
MbReadUByte(id)
MbReadSWord(id)
MbReadUWord(id)
MbReadSLong(id)
MbReadULong(id)
MbReadString(id)
MbReadFloat(id)
CipReadSByte(class, inst, attr)
CipReadUByte(class, inst, attr)
CipReadSWord(class, inst, attr)
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Description
Read a signed byte from position offset in the IN area
Read an unsigned byte from position offset in the IN area
Read a signed word from position offset in the IN area
Read an unsigned word from position offset in the IN area
Read a signed longword from position offset in the IN area
Read an unsigned longword from position offset in the IN area
Read a string (char*) from position offset in the IN area
Read a floating point (float) value from position offset in the IN area
Read a signed byte from position offset in the OUT area
Read an unsigned byte from position offset in the OUT area
Read a signed word (short) from position offset in the OUT area
Read an unsigned word (short) from position offset in the OUT area
Read a signed longword (long) from position offset in the OUT area
Read an unsigned longword (long) from position offset in the OUT area
Read a null-terminated string from position offset in the OUT area
Read a floating point (float) value from position offset in the OUT area
Read a signed byte (short) from the application via the mailbox interface
Read an unsigned byte (short) from the application via the mailbox interface
Read a signed word from the application via the mailbox interface
Read an unsigned word from the application via the mailbox interface
Read a signed longword from the application via the mailbox interface
Read an unsigned longword from the application via the mailbox interface
Read a null-terminated string from the application via the mailbox interface
Read a floating point (float) value from the application via the mailbox
interface
Read a signed byte from a CIP-object
Read an unsigned byte from a CIP-object
Read a signed word from a CIP-object
Doc. ID: SCM-1200-096
Server Side Include (SSI) 52
Argument
CipReadUWord(class, inst, attr)
CipReadSLong(class, inst, attr)
CipReadULong(class, inst, attr)
CipReadFloat(class, inst, attr)
CipReadShortString(class, inst, attr)
CipReadString(class, inst, attr)
CipReadUByteArray(class, inst, attr)
CipReadUWordArray(class, inst, attr)
CipReadULongArray(class, inst, attr)
Description
Read an unsigned word from a CIP-object
Read a signed longword from a CIP-object
Read an unsigned longword from a CIP-object
Read a floating point value from a CIP-object
Read a short string from a CIP-object
Read a null-terminated string from a CIP-object
Read an unsigned byte-array from a CIP-object
Read an unsigned word-array from a CIP-object
Read an unsigned longword-array from a CIP-object
scanf
Note: This function cannot be used in e-mail messages.
This SSI function reads a string passed from an object in a HTML form, interprets the string according
to the specified in-format, and stores the result in the OUT area according to the passed arguments. The
formatting of the string is equal to the standard C function call scanf()
Syntax:
<?--#exec cmd_argument=’scanf( "ObjName", "format", Arg1, ..., ArgN), ErrVal1,
..., ErrvalN’-->
ObjName
format
Arg1 - ArgN
ErrVal1 -ErrValN
- The name of the object with the passed data string
- Specifies how the passed string shall be formatted
- Specifies where to write the data
- Optional; specifies the value/string to write in case of an error.
Character Input, Argument Type
d
Decimal number; byte, short
i
Number, byte, short. The number may be in octal (leading 0(zero)) or hexadecimal (leading 0x
or 0X)
o
Octal number (with or without leading zero); byte, short
u
Unsinged decimal number; unsigned byte, unsigned short
x
Hexadecimal number (with or without leading 0x or 0X); byte, short
c
Characters; char*. The next input characters (default 1) are placed at the indicated spot. The
normal skip over white space is suppressed; to read the next non-white space character, use
%1s.
s
Character string (not quoted); char*, pointing to an array of characters large enough for the
string and a terminating "\0" that will be added.
e, f, g
Floating-point number with optional sign, optional decimal point and optional exponent; float*
%
Literal %; no assignment is made.
The conversion characters d, i, o, u and x may be preceded by l (letter ell) to indicate that a pointer to
‘long’ appears in the argument list rather than a ‘byte’ or a ‘short’
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 53
The arguments that can be passed to the SSI function scanf are:
Argument
OutWriteByte(offset)
OutWriteWord(offset)
OutWriteLong(offset)
OutWriteString(offset)
OutWriteFloat(offset)
MbWriteByte(id)
MbWriteWord(id)
MbWriteLong(id)
MbWriteString(id)
MbWriteFloat(id)
CipWriteByte(class, inst, attr)
CipWriteWord(class, inst, attr)
CipWriteLong(class, inst, attr)
CipWriteFloat(class, inst, attr)
Description
Write a byte to position offset in the OUT area
Write a word to position offset in the OUT area
Write a long to position offset in the OUT area
Write a string to position offset in the OUT area
Write a floating point value to position offset in the OUT area
Write a byte to the application via the mailbox interface
Write a word to the application via the mailbox interface
Write a longword to the application via the mailbox interface
Write a string to the application via the mailbox interface
Write a floating point value to the application via the mailbox interface
Write a byte value to a CIP-object
Write a word value to a CIP-object
Write a longword to a CIP-object
Write a floating point value to a CIP-object
Default output:
Write succeeded
Write failed
IncludeFile
This SSI function includes the contents of a file on a web page.
Syntax:
<?--#exec cmd_argument=’IncludeFile( "File name" )’-->
Default output:
Success
Failure
- <File content>
- Failed to open <filename>
SaveToFile
Note: This function cannot be used in e-mail messages.
This SSI function saves the contents of a passed form to a file. The passed name/value pair will be written to the file "File name" separated by the "Separator" string. The [Append|Overwrite] parameter determines if the specified file shall be overwritten, or if the data in the file shall be appended.
Syntax:
<?--#exec cmd_argument=’SaveToFile( "File name", "Separator",[Append|Overwrite] )’-->
Default output:
Success
Failure
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
- Form saved to file
- Failed to save form
Doc. ID: SCM-1200-096
Server Side Include (SSI) 54
SaveDataToFile
Note: This function cannot be used in e-mail messages.
This SSI function saves the data of a passed form to a file. The “Object name” parameter is optional, if
specified, only the data from that object will be stored. If not, the data from all objects in the form will
be stored.
The [Append|Overwrite] parameter determines if the specified file shall be overwritten, or if the data
in the file shall be appended.
Syntax:
<?--#exec cmd_argument=’SaveDataToFile( "File name", "Object name",[Append|Overwrite] )’-->
Default output:
Success
Failure
- Form saved to file
- Failed to save form
DisplayRemoteUser
Note: This function cannot be used in e-mail messages.
This SSI function returns the user name on an authentication session.
Syntax:
<?--#exec cmd_argument=’DisplayRemoteUser’-->
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 55
Changing SSI output
There are two methods of changing the output strings from SSI functions:
1. Changing SSI output defaults by creating a file called "\ssi_str.cfg" containing the output strings
for all SSI functions in the system.
2. Temporary changing the SSI output by calling the SSI function "SsiOutput()".
SSI Output String File
If the file "\ssi_str.cfg" is found in the filesystem and the file is correct according to the specification
below, the SSI functions will use the output strings specified in this file instead of the default strings.
The files shall have the following format:
[StoreEtnConfig]
Success: "String to use on success"
Invalid IP: "String to use when the IP address is invalid"
Invalid Subnet: "String to use when the Subnet mask is invalid"
Invalid Gateway: "String to use when the Gateway address is invalid"
Invalid Email server: "String to use when the SMTP address is invalid"
Invalid IP or Subnet: "String to use when the IP address and Subnet mask does
not match"
Invalid DNS1: "String to use when the primary DNS cannot be found"
Invalid DNS2: "String to use when the secondary DNS cannot be found"
Save Error: "String to use when storage fails"
Invalid DHCP state: "String to use when the DHCP state is invalid"
[scanf]
Success: "String to use on success"
Failure: "String to use on failure"
[IncludeFile]
Failure: "String to use when failure"1
[SaveToFile]
Success: "String to use on success"
Failure: "String to use on failure"1
[SaveDataToFile]
Success: “String to use on success”
Failure: “String to use on failure”1
[GetText]
Success: “String to use on success”
Failure: “String to use on failure”
The contents of this file can be redirected by placing the line ‘[File path]’ on the first row, and a file path
on the second.
Example:
[File path]
\user\ssi_strings.cfg
In this example, the settings described above will be loaded from the file ‘user\ssi_strings.cfg’.
1. ‘%s’ includes the filename in the string
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Server Side Include (SSI) 56
Temporary SSI Output change
The SSI output for the next called SSI function can be changed with the SSI function “SsiOutput()”.
The next called SSI function will use the output according to this call. Thereafter the SSI functions will
use the default outputs or the outputs defined in the file ‘\ssi_str.cfg’. The maximum size of a string is
128 bytes.
Syntax:
<?--#exec cmd_argument=’SsiOutput( "Success string", "Failure string" )’-->
Example:
This example shows how to change the output strings for a scanf SSI call.
<?--#exec cmd_argument=’SsiOutput ( "Parameter1 updated", "Error" )’-->
<?--#exec cmd_argument="scanf( "Parameter1", "%d", OutWriteByte(0) )’-->
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 9
9. E-mail Client
9.1 General
The built-in e-mail client can send predefined e-mail messages based on trigger-events in input and output data areas. The client supports SSI, however note that some SSI functions cannot be used in e-mail
messages (specified separately for each SSI function).
See also...
•
“Server Side Include (SSI)” on page 45
Server Settings
The Anybus Communicator needs a valid SMTP server configuration in order to be able to send e-mail
messages. These settings are stored in the system file ‘\ethcfg.cfg’.
See also...
•
“Ethernet Configuration File (‘ethcfg.cfg’)” on page 37
Event-Triggered Messages
As mentioned previously, the e-mail client can send predefined messages based on events in the input
and output data areas. In operation, this works as follows:
1. The trigger source is fetched from a specified location
2. A logical AND is performed between the trigger source and a mask value
3. The result is compared to a reference value
4. If the result is true, the e-mail is sent to the specified recipient(s).
Which events that shall cause a particular message to be sent, is specified separately for each message.
For more information, see “E-mail Definitions” on page 58.
Note that the input and output data areas are scanned twice per second, i.e. to ensure that an event is
detected by the gateway, it must be present longer than 0.5 seconds.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
E-mail Client 58
9.2 E-mail Definitions
The e-mail definitions are stored in the following two directories:
•
‘\user\email’
This directory holds up to 10 messages which can be altered by normal level FTP users.
•
‘\email’
This directory holds up to 10 messages which can be altered by admin level FTP users.
E-mail definition files must be named ‘email_1.cfg’, ‘email_2.cfg’... ‘email_10.cfg’ in order to be properly
recognized by the gateway.
File Format:
[Register]
Area, Offset, Type
[Register Match]
Value, Mask, Operand
[To]
recipient
[From]
sender
[Subject]
subject line
[Headers]
Optional extra headers
[Message]
message body
Key
Area
Offset
Type
Value
Mask
Operand
To
From
Subject
Headers
Message
Value
Scanned for SSI
Source area. Possible values: ‘IN’ (Input Data area) or ‘OUT’ (Output Data area) No
Source offset, written in decimal or hexadecimal.
Source data type. Possible values are ‘byte’, ‘word’, and ‘long’
Used as a reference value for comparison.
Mask value, applied on the trigger source prior to comparison (logical AND).
Possible values are ‘<‘, ‘=’ or ‘>’
E-mail recipient
Yes
Sender e-mail address
E-mail subject. One line only.
Optional; may be used to provide additional headers.
The actual message.
Note: Hexadecimal values must be written with the prefix ‘0x’ in order to be recognized by the Anybus
Communicator.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 10
10. Navigating the Anybus Configuration Manager
10.1 Main Window
The main window in the Anybus Configuration Manager can be divided into 4 sections as follows:
A
C
B
D
•
A: Pull-down Menus & Tool Bar
The second drop-down menu from the left will change depending on the current context. The Tool Bar provides
quick access to the most frequently used functions.
•
This menu entry is expanded
B: Navigation Section
Sub-entries
This section is the main tool for selecting and altering different levels of the sub-network configuration.
Entries preceded by a ‘+’ holds further configuration parameters or ‘sub menus’. To gain access to these parameters, the entry must be expanded by clicking ‘+’.
This menu entry holds additional
sub-entries / parameters
There are three main levels in the navigation window,
namely Fieldbus, ABC and sub-network.
Right-clicking on entries in this section brings out additional selections related to that particular entry.
•
C: Parameter Section
This section holds a list of parameters or options related to
the currently selected entry in the Navigation Section.
The parameter value may be specified either using a selection box or manually, depending on the parameter itself.
Values can be specified in decimal form (e.g. ‘42’), or in
hexadecimal format (e.g. ‘0x2A’).
•
Parameter Section
D: Information Section
This section holds information related to the currently selected parameter.
Information Section
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Navigating the Anybus Configuration Manager 60
10.1.1 Pull-down Menu
File
This menu features the following entries:
•
New
Create a new configuration.
See also “Configuration Wizards” on page 67.
•
Open...
Open a previously created configuration.
•
Save
Save the current configuration.
•
Save As...
Save the current configuration under a new name.
•
Print...
Send details about the current configuration to a printer.
•
Properties...
This brings out the following window:
Item
Select a Name for the
Configuration
Download Password(6)
Upload Password(6)
Description
A name for the configuration
may be entered here
These fields can be used to
password-protect the configuration in the gateway.
CAUTION: Always keep a copy of the password
in a safe place. A lost password cannot be retrieved!
•
Exit
Close the Anybus Configuration Manager.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Navigating the Anybus Configuration Manager 61
Tools
This menu features the following entries:
•
Port
This entry selects the COM-port used
for the configuration of the gateway.
•
Upload configuration from ABC
Upload the configuration from the
gateway to the Anybus Configuration
Manager.
•
Download configuration to ABC
Download the current configuration
into the gateway.
•
Start Logging
Start the Data Logger (see “Data Logger” on page 100).
Note that when the Data Logger is active, this menu entry is changed to ‘Stop Logging’.
•
Options
This will bring out the following window:
Item
Warning on Delete
Description
A confirmation dialog is displayed each
time something is deleted.
Warning on unsaved
A confirmation dialog is displayed when
data
closing the Anybus Configuration Manager with unsaved data.
Show Wizard when
The Wizard is displayed each time a new
“New” menu is selected configuration is created.
Language next time the Selects which language to use. The new
program is launched
setting will be active the next time the program is launched.
Selecting the ‘ABC’-tab will reveal additional properties:
Item
Size of logbuffer
Firmware Download
Factory Restore
Block Configuration
Create Error log
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Description
By default, the Data Logger can log up to
512 entries in each direction. If necessary,
it is possible to specify a different number
of entries (valid settings range from
1...512). Click ‘Apply’ to validate the new
settings. See also “Data Logger” on page
100.
Download firmware to the embedded fieldbus interface.
Warning: Use with caution.
Restores the gateway firmware to it’s original state (does not affect the embedded
fieldbus interface).
When selected, the downloaded configuration will not be executed by the gateway.
Warning: Use with caution.
Creates an error log file
Doc. ID: SCM-1200-096
Navigating the Anybus Configuration Manager 62
View
This menu features the following entries:
•
Toolbar
This entry enables/disables the toolbar icons at the top of the
main window.
•
Status Bar
This entry enables/disables the status bar at the bottom of the
main window.
Help
This menu features the following entries:
•
Contents
Display the table of contents of the online help
system.
Note: At the time of writing, no online help system exists.
•
Search For Help On...
Search for a particular topic in the online help system.
Note: At the time of writing, no online help system exists.
•
About...
Display general information about the gateway and the current build of Anybus Configuration
Manager.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Navigating the Anybus Configuration Manager 63
10.1.2 Toolbar Icons
The toolbar features icons for the most commonly used functions.
•
New, Open & Save
See “File” on page 60.
•
New
Open
Save
Upload from ABC & Download to ABC
See “Tools” on page 61.
Upload
•
Download
Up one Level
Clicking on this icon will move the selection in the navigation section.
•
Cut, Copy, Paste, Delete, Insert
These icons are used for common editing functions in the navigation section.
•
Up one Level
Cut
Copy
Paste
Delete
Insert
Connect
Clicking on this icon will cause the Anybus Configuration Manager to attempt to
connect to the gateway.
•
Connect
Disconnect
Clicking on this icon will cause the Anybus Configuration Manager to disconnect
from the gateway.
•
Disconnect
Start Logging & Stop Logging
See “Tools” on page 61 & “Data Logger” on page 100.
Start Log.
•
Stop Log.
sub-network Monitor
Clicking on this icon will launch the sub-network Monitor
(see “Sub-network Monitor” on page 95).
•
Sub-Network
Monitor
Add Command
This icon is used to add commands to the currently selected node.
•
Add Command
Add Mailbox
(Advanced functionality, see “Mailbox Editor” on page 123)
Add Mailbox
•
Add Node & Add Broadcaster
These icons are used to add nodes to the configuration.
Node
•
Node Monitor
Clicking on this icon will launch the Node Monitor (see “Node Monitor” on
page 96)
•
Broadcaster
Node Monitor
Add Transaction(s)
These icons are used to add transactions to the currently selected node.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Add
Transactions
Add
Transaction
Doc. ID: SCM-1200-096
Chapter 11
11. Basic Settings
11.1 Fieldbus Settings
(Select ‘Fieldbus’ in the Navigation Section to gain access to the parameters described in this section).
General
During start-up the fieldbus interface of the Anybus Communicator is initialized to fit the configuration
created in the Anybus Configuration Manager. Optionally, some initialization parameters can be set
manually to provide better control over how the data shall be treated by the gateway.
Fieldbus Settings
To be able to participate on the network, the following settings must be correctly made:
•
Fieldbus Type
Anybus Configuration Manager supports a wide range of
networking systems. Make sure this parameter is set to
“EtherNet/IP 2Port”.
•
Modbus Address Mode
Enabled - Use Modbus Address Mode
Disabled - Use Anybus Address Mode
See also “Modbus/TCP” on page 24
•
Communicator IP-address, Gateway, Subnet Mask
Fieldbus Type
See “Basic Network Configuration” on page 36.
•
TCP/IP Settings
Enabled - Use settings in Anybus Configuration Manager
Disabled - Use settings stored in ‘ethcfg.cfg’
See also “Basic Network Configuration” on page 36
I/O Sizes
These parameters specify how data from the internal memory buffer will be exchanged over EtherNet/IP. This can either be handled
automatically based on the sub-network configuration, or it can be
specified manually.
•
IO Sizes
Automatic
All data will be represented as I/O Data on EtherNet/IP.
•
User defined
Additional parameter properties appear; ‘IO Size In’ and ‘IO Size Out’. The specified amount,
starting at address 0x0000 of the respective memory buffers, will be reserved for and represented
as I/O Data. The remainder will be reserved for Parameter Data.
See also “EtherNet/IP” on page 22
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
65
11.2 ABC Parameters
(Select ‘ABC’ in the Navigation Section to gain access to the parameters
described in this section).
Interface
Currently, only serial communication is supported.
Status / Control Word
(See “Control and Status Registers” on page 104).
Value
Description
Enabled
Enable the Control and Status Registers. The ‘Data Valid’-bit in the Control Register must
be set to start the sub-network communication.
Enabled but no startup lock
This setting is similar to ‘Enabled’, except that the control system is not required to set the
‘Data Valid’-bit to start the sub-network communication.
Disabled
This setting completely disables the Control and Status Registers.
Module Reset
This parameter specifies how the gateway will behave in the event of a fatal error.
Value
Description
Enabled
The gateway will be restarted, and no error will be indicated to the user.
Disabled
The gateway will halt and indicate an error.
Protocol Mode
This parameter specifies which protocol mode to use for the sub-network.
Value
Description
Generic Data Mode
This mode is primarily intended for Produce & Consume-based protocols, where there are
no Master-Slave relationship between the gateway and the nodes on the sub-network.
Master Mode
This mode is intended for ‘Query & Response’-based protocols, where a single Master
exchanges data with a number of Slaves.
DF1
This mode is intended for the DF1 protocol. The Anybus Communicator can only be configured as a Master with half-duplex communication.
Note: This is the only mode available if you intend to configure an ABC module for DF1.
See also “Protocol Modes” on page 18.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
66
Statistics
The Transmit- and Receive Counters indicate how many transactions that have successfully been exchanged on the sub-network. This feature is primarily intended for debugging purposes.
•
Receive Counter Location
Specifies the location of the Receive Counter in the internal memory buffer.
•
Transmit Counter Location
Specifies the location of the Transmit Counter in the internal memory buffer.
Both counters are enabled by setting ‘Statistics’ to ‘Enabled’.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
67
11.3 Sub-network Parameters
(To gain access to the parameters described in this section, select ‘sub-network’ in the Navigation Section).
Communication
These parameters specify the actual communication settings used for the sub-network.
Parameter
Description
Master Mode and Generic Mode
Bit rate (baud rate)
Selects the bit rate
1200
2400
4800
9600
19200
35700
38400
57600
Data bits
Selects the number of data bits
7, 8
Parity
Selects the parity mode
None, Odd, Even
Physical standard
Selects the physical interface type
RS232, RS422, RS485
Start bits
Number of start bits.
1
Stop bits
Number of stop bits.
1, 2
Start- and End Character
Note: These parameters are only available in Generic Data Mode.
Start and end characters are used to indicate the beginning and end of a serial message. For example, a
message may be initiated with <ESC> and terminated with <LF>. In this case, the Start character would
be 0x1B (ASCII code for <ESC>) and the End character 0x0A (ASCII code for <LF>)
Parameter
Description
Valid settings
End Character Value
End character for the message, ASCII
0x00 - 0xFF
Use End Character
Determines if the End character shall be used or not
Enable / Disable
Start Character Value
Start character for the message, ASCII
0x00 - 0xFF
Use Start Character
Determines if the Start character shall be used or not
Enable / Disable
Timing (Message Delimiter)
The parameters in this category differs slightly between the different protocol modes.
•
Master Mode
The Message Delimiter specifies the time that separates two messages in steps of 10ms. If set to
0 (zero), the gateway will use the standard Modbus delimiter of 3.5 characters (the actual number
of ms will be calculated automatically based on the currently used communication settings).
•
Generic Data Mode
The Message Delimiter specifies the time that separates two messages in steps of 10µs.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc.Id. SCM-1200-096
Chapter 12
12. Nodes
12.1 General
In Anybus Configuration Manager, a node represents a single device on the network. While the gateway
doesn’t feature a scanlist in the traditional sense, all nodes, and their transactions, will be processed in
the order they have been defined in the Anybus Configuration Manager.
The maximum number of nodes that can be created in the Anybus Configuration Manager is 31.
12.2 Adding & Managing Nodes
(Right-click on ‘Sub Network’ in the Navigation Section to gain access to these functions)
Function
Description
Paste
Paste a node from the clipboard
sub-network Monitor
Launch the subnet monitor ( “Sub-network Monitor” on
page 95)
Add Node
Add a node to the configuration
Add Broadcastera
Add a broadcaster node to the configuration
Load Node
Add a previously saved node
sub-network Status...
View diagnostic information about the sub-network
a. This function is only available in Master Mode.
12.3 Node Parameters
12.3.1 Master Mode and Generic Data Mode
(To gain access to the parameters described in this section, select a node
in the Navigation Section).
Parameter
Description
Slave Address
The value entered here may be used to set the node address in
certain commands.
For more information, see “The Command Editor” on page 84.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 13
13. Transactions
13.1 General
As mentioned previously, transactions are representations of the actual serial telegrams exchanged on
the serial sub-network. While the gateway doesn’t feature a scanlist in the traditional sense, all nodes, and
their transactions, will be processed in the order they have been defined in the Anybus Configuration
Manager.
Transactions are handled slightly differently in the three protocol modes:
•
Master Mode
For regular nodes, transactions always come in pairs; a query and a response. The query is issued
by the gateway, while responses are issued by the slaves on the sub-network. The Broadcaster
can only send transactions.
•
Generic Data Mode
Transactions can be added as desired for both directions. Transactions sent to the sub-network
are called ‘Transaction Produce’, and transactions issued by other nodes are called ‘Transaction
Consume’.
•
DF1 Master Mode
Please refer to “DF1 Protocol Mode” on page 88.
Theoretically, the gateway supports up to 150 transactions. The actual number may however be less depending on the memory requirements of the defined transactions.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Transactions 70
13.2 Adding & Managing Transactions
(Right-click on a node in the Navigation Section to gain access to these functions)
Function
Description
Cut
Cut a node to the clipboard
Copy
Copy a node to the clipboard
Insert
Insert a node from the clipboard
Delete
Delete a node
Node Monitor
Add Transaction(s)
Launch the node monitor ( “Node Monitor” on page 96)
a
On regular nodes, this adds a Query and a Response.
The two transactions will be grouped in order to
increase readability.
On the Broadcaster, a single transaction will be added.
Add Transaction Consumeb Add a ‘Consume’-transaction
Add transaction Produceb
Add a ‘Produce’-transaction
Add Command
Add predefined transactions to the node
Insert New Node
Insert a new node above the currently selected one
Save Node
Save the selected node
Insert from File
Insert a previously saved node above the currently
selected node
Rename
To increase readability, each node can be given a
unique name using this function
a. Only available in Master Mode
b. Only available in Generic Data Mode
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Transactions 71
13.3 Transaction Parameters (Master Mode)
13.3.1 Parameters (Query & Broadcast)
(To gain access to these parameters, select a Query- or Broadcast- transaction in the Navigation Section)
Parameter
Description
Minimum time between
broadcasts (10 ms)
This parameter specifies how long the gateway shall wait after transmitting a broadcast transaction before processing the next entry in the scanlist. The value should be set high enough to
allow the slave devices time to finish the handling of the broadcast.
The entered value is multiplied by 10. For instance, an entered value of 5 results in 50 ms.
Note: This setting is only relevant for the Broadcaster node.
Offline options for fieldbus
This parameter specifies the action to take for this transaction if the higher level network goes
offline. This affects the data that is sent to the sub-network.
• Clear - The data destined for the slave-devices is cleared (set to zero)
• Freeze - The data destined for the slave-device is frozen
• NoScanning -The updating of the sub-network is stopped
Offline options for subnetwork
This parameter specifies the action to take for this transaction if the sub-network goes offline.
This affects the data that is reported to the control system.
• Clear - Data is cleared (0) on the higher level network if the sub-network goes offline
• Freeze - Data is frozen on the higher level network if the sub-network goes offline
Reconnect time (10 ms) This parameter specifies how long the gateway shall wait before attempting to reconnect a disconnected node. A node will be disconnected in case the maximum number of retries (below)
has been reached.
The entered value is multiplied by 10. For instance, an entered value of 5 results in 50 ms.
Note: This setting is not relevant for the Broadcaster node.
Retries
This parameter specifies how many times a timeout may occur in sequence before the node is
disconnected.
Timeout time (10 ms)
This parameter specifies how long the gateway will wait for a response from a node. If this time
is exceeded, the gateway will retransmit the Query until the maximum number of retries (see
above) has been reached.
Trigger byte address
This parameter specifies the location of the trigger byte in internal memory (only relevant when
‘Update mode’ is set to ‘Change of state on trigger’).
Update mode
This parameter is used to specify when the transaction shall be sent to the slave:
The entered value is multiplied by 10. For instance, an entered value of 5 results in 50 ms.
Valid settings range from 0x200... 0x3FF and 0x400... 0xNNN
• Cyclically
The transaction is issued cyclically at the interval specified in the ‘Update time’ parameter.
• On data change
The data area is polled for changes at the time interval defined by Update time. A transaction is issued when a change in data is detected.
• Single shot
The Query is issued once at start up.
• Change of state on trigger
The Query is issued when the trigger byte value has changed. This feature enables the
control system to notify the gateway when to issue a particular Query. To use this feature
correctly, the control system must first update the data area associated with the Query/
transaction, then increase the trigger byte by one. The location of the trigger byte is specified by the ‘Trigger byte address’ parameter.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Transactions 72
Parameter
Description
Update time (10 ms)
This parameter specifies how often the transaction will be issued in steps of 10 ms (only relevant when ‘Update mode’ is set to ‘Cyclically’).
The entered value is multiplied by 10. For instance, an entered value of 5 results in 50 ms.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Transactions 73
13.3.2 Parameters (Response)
(To gain access to these parameters, select a Response-transaction in the Navigation Section)
Parameter
Description
Trigger byte
This parameter is used to enable/disable the trigger functionality for the response. If
enabled, the gateway will increase the trigger byte by one when the gateway receives new
data from the sub-network. This can be used to notify the control system of the updated
data.
The location of the trigger byte is specified by the ‘Trigger byte address’ parameter below.
Trigger byte address
This parameter specifies the location of the trigger byte in the internal memory buffer.
Valid settings range from 0x000... 0x1FF and 0x400... 0xNNN
13.4 Transaction Parameters (Generic Data Mode)
13.4.1 Produce-Transactions
(To gain access to these parameters, select a Produce Transaction in the Navigation Section)
Parameter
Description
Offline options for fieldbus
This parameter specifies the action to take for this transaction if the higher level network
goes offline. This affects the data that is sent to the sub-network.
• Clear
Data is cleared (0) on the sub-network if the higher level network goes offline
• Freeze
Data is frozen on the sub-network if the higher level network goes offline
• NoScanning
Stop subnet scanning for this transaction if the higher level network goes offline
Update mode
The update mode for the transaction:
• Cyclically
The transaction is sent cyclically at the interval specified in the ‘Update Time’-parameter.
• On data change
The data area is polled for changes at the time interval defined by Update time. A
transaction is issued when a change in data is detected.
• Single shot
The transaction is sent once at startup.
• Change of state on trigger
The transaction is sent when the trigger byte has changed. This feature enables the
control system to notify the gateway when to issue a particular transaction. To use this
feature correctly, the control system must first update the data area associated with
the transaction, then increase the trigger byte by one. The location of the trigger byte
is specified by the ‘Trigger byte address’ parameter.
Update time (10 ms)
This parameter specifies how often the transaction will be issued in steps of 10ms (only
relevant when ‘Update mode’ is set to ‘Cyclically’).
The entered value is multiplied by 10. For instance, an entered value of 5 results in 50 ms.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Transactions 74
Parameter
Trigger byte address
Description
This parameter specifies location of the trigger byte in the internal memory buffer.
If ‘Update mode’ is set to ‘Change of state on trigger’, the memory location specified by
this parameter is monitored by the gateway. Whenever the trigger byte is updated, the
gateway will produce the transaction on the sub-network.
This way, the control system can instruct the gateway to produce a specific transaction on
the sub-network by updating the corresponding trigger byte.
The trigger byte should be incremented by one for each activation. Please note that the
trigger byte address must be unique to each transaction. It can not be shared by two or
more transactions.
Note: This parameter has no effect unless the ‘Update mode’ parameter is set to ‘Change
of state on trigger’.
Valid settings range from 0x200... 0x3FF and 0x400... 0xNNN
13.4.2 Consume-Transactions
(To gain access to these parameters, select a Consume Transaction in the Navigation Section)
Parameter
Description
Offline options for sub-network
This parameter specifies the action to take for this transaction if the sub-network goes
offline. This affects the data that is sent to the higher level network.
• Clear
Data is cleared (0) on the higher level network if the sub-network goes offline
• Freeze
Data is frozen on the higher level network if the sub-network goes offline
Offline timeout time (10 ms) This parameter specifies the maximum allowed time between two incoming messages in
steps of 10ms. If this time is exceeded, the sub-network is considered to be offline. A
value of 0 disables this feature, i.e. the sub-network can never go offline.
The entered value is multiplied by 10. For instance, an entered value of 5 results in 50 ms.
Trigger byte
• Enable
Enables the trigger byte. The location of the trigger byte must be specified in the ‘Trigger byte address’ (below).
The trigger byte value will be increased each time a valid transaction has been consumed by the gateway.
The trigger byte will also be increased if the offline option is set to “Clear” and the
offline timeout time value is reached.
This feature enables the control system to be notified each time new data has been
consumed on the sub-network.
• Disable
Disables the trigger byte functionality.
Trigger byte address
This parameter specifies the location of the trigger byte in the internal memory buffer.
Valid settings range from 0x000... 0x1FF and 0x400... 0xNNN.
Please note that the trigger byte address must be unique to each transaction. It can not be
shared by two or more transactions.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Transactions 75
13.5 Transaction Editor
The Transaction Editor can be used to edit the individual frame objects of a transaction. The same settings are also available in the parameter section of the main window, however the Transaction Editor
presents the frame objects in a more visual manner.
Frame
Objects
To edit the value of a parameter, click on it and enter a new value using the keyboard. When editing
transactions which are based on predefined commands, certain parts of the transaction may not be editable.
The File menu features the following entries:
•
Apply Changes
This will save any changes and exit to the main
window.
•
Exit
Exit without saving.
Example:
The transaction created in this example are built up as follows:
The first byte holds the STX (0x02) followed by two bytes specifying the length of the data field
(in this case 8). The next 8 bytes are data and since this is a ‘query’-transaction, the data is to be
fetched from the Output Area which starts at address location 0x202. No swapping will be performed on the data. This is followed by a two-byte checksum. The checksum calculation starts
with the second byte in the transaction.
The transaction ends with a byte constant, the ETX (0x03).
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 14
14. Frame Objects
14.1 General
Each transaction consists of Frame Objects which makes up the serial telegram frame. Each Frame Object specifies how the gateway shall interpret or generate a particular part of the telegram.
There are 5 types of frame objects, which are described in detail later in this chapter:
•
Constant Objects
•
Limit Objects
•
Data Objects
•
Variable Data Objects
•
Checksum Objects
Example:
The following Transaction consists of several frame objects; three constants, a data object, and
a checksum object.
Transaction
Constant
Constant
Variable Length Data
Checksum
Constant
14.2 Adding and Editing Frame
Objects
To add a frame object to a Transaction, right-click on the Transaction in the Navigation Section and select one of the entries in the
menu that appears.
The entry called ‘Transaction Editor’ will launch the Transaction
Editor, which is used to edit transactions and frame objects in a
more visual manner. For more information, see “Transaction Editor” on page 75.
To edit parameters associated with a particular frame object, select
the frame object in the Navigation Section. The settings for that
frame object will be displayed in the Parameter Section.
Data Object, Parameters
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
It is also possible to edit the frame objects in a transaction in a
more visual manner using the Transaction Editor, see “Transaction Editor” on page 75
Doc. ID: SCM-1200-096
Frame Objects 77
14.3 Constant Objects (Byte, Word, Dword)
Constant Objects have a fixed value and come in three sizes:
•
Byte
8 bits
•
Word
16 bits
•
Dword
32 bits
Constants are handled differently depending on the direction of the transaction:
•
Produce/Query Transactions
The gateway will send the value as it is without processing it.
•
Consume/Response Transactions
The gateway will check if the received byte/word/dword matches the specified value. If not, the
message will be discarded.
To set the value of the object, select it in the Navigation Section and enter the desired value in the Parameter section.
Parameter
Description
Value
Constant value
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Frame Objects 78
14.4 Limit Objects (Byte, Word, Dword)
Limit Objects have a fixed range and come in three sizes:
•
Byte
8 bits
•
Word
16 bits
•
Dword
32 bits
Limit Objects are handled differently depending on the direction of the transaction:
•
Produce/Query Transactions
This object shall not be used for such transactions (value will be undefined).
•
Consume/Response Transactions
The gateway will check if the received byte/word/dword fits inside the specified boundaries. If
not, the message will be discarded.
There are 3 types of interval objects:
•
Byte
8 bit interval
•
Word
16 bit interval
•
Dword
32 bit interval
To set the range of the object, select it in the Navigation Section and enter the desired range in the Parameter section as follows:
Parameter
Description
Maximum Value
This is the largest allowed value for the range.
Range:0x00... 0xFFh(byte)
0x0000... 0xFFFFh(word)
0x00000000... 0xFFFFFFFFh(dword)
Note: Value must be larger than the Minimum Value (below)
Minimum Value
This is the smallest allowed value for the range.
Range:0x00... 0xFEh(byte)
0x0000... 0xFFFEh(word)
0x00000000... 0xFFFFFFFEh(dword)
Note: Value must be less than the Maximum Value (above)
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Frame Objects 79
14.5 Data Object
Data Objects are used to represent raw data as follows:
•
Produce/Query Transactions
The specified data block is forwarded from the higher level network to the sub-network.
•
Consume/Response Transactions
The specified data block is forwarded from the sub-network to the higher level network.
To specify the properties of the object, select it in the Navigation Section and enter the desired settings
in the Parameter section as follows:
Parameter
Description
Byte Swapping
• No Swapping
No swapping is performed on the data
• Swap 2 bytes
A, B, C, D becomes B, A, D, C
• Swap 4 bytes
A, B, C, D becomes D, C, B, A
Data Length
The length of the data block, in bytes. In case of a Response or Consume transaction, incoming messages where the data size differs from the value specified here will be discarded. Maximum data length allowed for one frame is 300 bytes.
Data Location
The location of the data block in the internal memory buffer
14.6 Variable Data Object
Note: Only one Variable Data Object is permitted for each transaction.
This object is similar to the Data Object, except that it has no predefined length. Instead, an End or
Length-character specifies the size of the data block as follows:
(Variable Data Object)
Data
Data of arbitrary length
•
(Variable Data Object)
0x00
End Character
0x04
Length Character
Data
4 bytes of data
Produce/Query Transactions
The specified data block will be forwarded from the higher level network to the sub-network.
The control system must supply an End- or Length-character in order for the gateway to know
the size of the data block.
The End- or Length-character itself may either be forwarded to the sub-network or discarded.
•
Consume/Response Transactions
The specified data block is forwarded from the sub-network to the higher level network. The
End- or Length-character will be generated by the gateway automatically (if applicable).
The End- or Length-character itself may either be forwarded to the higher level network or discarded.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Frame Objects 80
To specify the properties of the object, select it in the Navigation Section enter the desired settings in
the Parameter section as follows:
Parameter
Byte Swapping
Description
• No Swapping
No swapping will be performed on the data
• Swap 2 bytes
A, B, C, D becomes B, A, D, C
• Swap 4 bytes
A, B, C, D becomes D, C, B, A
Fill unused bytes
• Enableda
Fill unused data with the value specified in ‘Filler byte’.
• Disabled
Don’t fill
Filler byte
Filler byte value. Only used if ‘Fill unused bytes’ has been enabled.
Data Location
The offset in the internal memory buffer where the data shall be read from / written to
Object Delimiter
• Length Character
Length character is visible in the internal memory buffer but not on the sub-network
• Length Character Visible
The length character is visible both in the internal memory buffer and on the sub-network.
• End Character
The end character is visible in the internal memory buffer but not on the sub-network.
• End Character Visible
The end character is visible both in the internal memory buffer and on the sub-network
• No Charactera
No End- or Length-character is generated in the internal memory buffer.
End Character Value
End Character valueb
Maximum Data Length
The maximum allowed length (in bytes) of the variable data object. If the actual length of the
data exceeds this value, the message will be discarded. The value must not exceed 300 bytes,
which is the maximum data length allowed for one frame.
a. Only relevant for Consume/Response transactions
b. Only used if ‘Object Delimiter’ is set to ‘End Character’ or ‘End Character Visible’
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Frame Objects 81
14.7 Checksum Object
Most serial protocols features some way of verifying that the data has not been corrupted during transfer. The Checksum Object calculates and includes a checksum in a transaction.
Parameter
Description
Error Check Start byte This parameter specifies the byte offset in the transaction to start checksum calculations on
Error Check Type
This parameter specifies which type of algorithm to use:
• CRC (2 bytes)
CRC-16 with 0xA001 polynome (Modbus RTU standard)
• LRC (1 byte)
All bytes are added together as unsigned 8-bit values. The 2’s complement of the result will
be used as a checksum.
• XOR (1 byte)
All bytes are logically XOR:ed together. The resulting byte will be used as a checksum.
• ADD (1 byte)
All bytes are added together as unsigned 16-bit values. The lowest 8 bits in the result will be
used as a checksum.
• AddInvASCII (2 bytes)
All bytes are added together as unsigned 8-bit values. The lowest 8 bits in the result are
inversed and used as a checksum, represented as hexadecimal ASCII (2 bytes).
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 15
15. Commands
This information is only valid for master mode and generic mode. For DF1 master mode, please refer
to “Services” on page 91.
15.1 General
As mentioned previously, commands are actually predefined transactions that can be stored and reused.
Just like regular transactions, commands consist of frame objects and are representations of the actual
serial telegrams exchanged on the serial sub-network.
Adding a command to a node actually results in (a) transaction(s) being added according to the directions
specified in the command. The frame objects in such a transaction may retrieve their values not only
from parameters in the parameter section, but also from other sources such as the ‘SlaveAddress’-parameter (see “Node Parameters” on page 68). In such case, the parameters in the parameter section will
be greyed out and cannot be edited directly.
In Master Mode, Anybus Configuration Manager comes preloaded with commands for most common
Modbus RTU functions. Additional commands can easily be added using the Command Editor (see
“The Command Editor” on page 84). For DF1 Master Mode, see “Services” on page 91. In Generic
Data Mode, no predefined commands exist, but custom ones may be implemented as desired.
15.2 Adding & Managing Commands
To add a command to a node, right-click on the node in the Navigation Section and select ‘Add Command’.
A list of commands will appear:
Select the desired command in the list, and select ‘Add Command’
in the ‘Command’-menu. The specified command will be added
to the node.
Just like other transactions, the frame objects of added command
may be edited in the Navigation/Parameter Section or using the
Transaction Editor. Note however that certain frame objects may
be locked for editing.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Commands 83
15.2.1 Pull-Down Menu
File
This menu features the following entries:
•
Select
Add the currently selected Command to the node.
•
Exit
Exit without adding a command to the node.
Command
This menu is used to manage the commands in the list:
•
Add Command
Add a custom command to the list, and open the
new command in the Command Editor.
See also “The Command Editor” on page 84.
•
Edit Command
Edit the currently selected command using the
Command Editor.
See also “The Command Editor” on page 84.
•
Delete Command
Delete the currently selected command from the list. Note that some commands are fixed and
cannot be deleted.
15.2.2 Toolbar Icons
The toolbar features icons for the most commonly used functions.
•
Add Command
(Same as ‘Add Command’ in the ‘Command’-menu).
Add Command
•
Edit Command
(Same as ‘Edit Command’ in the ‘Command’-menu).
Edit Command
•
Delete Command
(Same as ‘Delete Command’ in the ‘Command’-menu).
Delete Command
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Commands 84
15.3 The Command Editor
15.3.1 General
The Command Editor is used to define new commands and edit existing ones. This makes it possible
to build a library of commands, which can be stored and reused at a later stage.
Note that the Command Editor is somewhat protocol-dependent in the sense that certain frame objects
may not be deleted or altered.
The examples in this section use Master Mode. The procedures involved are similar in Generic Data
Mode, but without the limitations imposed by the Modbus RTU protocol.
15.3.2 Basic Navigation
Open the Command Editor by selecting ‘Edit Command’ or ‘Add Command’ from the ‘Command’menu.
A
B
D
E
C
A: Pull-down Menu
See “Pull-down Menu” on page 85.
B: Name of Command
Actual name of the command, in text form.
C: Command Transactions
This section holds the actual transactions associated with the command. This can either be a query-response pair, or a single transaction, depending on the protocol mode etc.
D: Command ID
This can be used as desired when building the command, e.g. to specify the function code.
E: Other Settings
Setting
Allow Broadcasting
Produce
Consume
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Description
Specifies if it is allowed to broadcast the command (only relevant in Master Mode)
The command is producing data (Generic Data Mode only)
The command is consuming data (Generic Data Mode only)
Doc. ID: SCM-1200-096
Commands 85
15.3.3 Pull-down Menu
File
This menu features the following entries:
•
Apply Changes
Save changes and exit to the main window.
•
Exit
Exit without saving.
Column
The functions in this menu alters the structure of the command.
•
Append Column
Add another column to the command.
•
Insert Column
Insert a column at the selected position.
•
Delete Command
Delete the column at the selected position.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Commands 86
15.3.4 Editing a Command
As mentioned previously, the transaction section in the Command Editor represents the actual transactions associated with the command. Each column represents a frame object within the transaction.
Each column features four rows with the following parameters:
•
Query/Response/Produce/Consume
The upper right cell indicates the direction of the transaction.
•
DisplayName
Each column can be named so that the different parts of the command appears in a more user
friendly manner when editing its settings in the Transaction Editor or in the Parameter Section
of the Main Window.
•
ObjectType
This row specifies the type of frame object that shall be used for the column.
•
Value
This row specifies where the frame object shall retrieve its value/settings.
Value
Description
Depend
This setting is only relevant for Responses in Master Mode.
The value will be retrieved from the corresponding part of the ‘Query’-transaction.
Id
The value will be retrieved from the ‘Command ID’-setting (see “Basic Navigation” on page
84).
User
The settings associated with the object can be edited by the user.
[SlaveAddress] The value will be retrieved from the ‘SlaveAddress’-parameter (see “Node Parameters” on
page 68).
(other settings) Other settings are no longer supported.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Commands 87
15.3.5 Example: Specifying a Modbus-RTU Command in Master Mode
In the following example, a Modbus-RTU command is created in Master Mode. In Modbus-RTU, a
transaction always feature the following parts:
•
Slave Address (1 byte)
•
Function Code (1 bytes)
•
A data field
•
CRC (CRC-16)
Furthermore, each command always consists of a query and a response.
•
Example Query
Query
•
1
2
3
4
DisplayName Slave Address
Function
Data
Checksum
Object Type
Byte Object
Byte Object
Data Object
Checksum Object
Value
[SlaveAddress]
ID
User
User
The value of this byte
constant will be set
using the ‘SlaveAddress’ parameter (see
“Node Parameters” on
page 68).
The value of this byte
constant will be set
using the ‘Command
ID’-field.
The size and location
of the data associated
with this object is
determined by the
user.
The checksum type
etc can be selected by
the user. By default,
this is set to match the
Modbus-RTU standard.
2
3
4
DisplayName Slave Address
Function
Data
Checksum
Object Type
Byte Object
Byte Object
Data Object
Checksum Object
Value
[SlaveAddress]
ID
User
Depend
This value is linked to
the ‘SlaveAddress’
parameter in the
parameter window.
The value of this byte
constant will be set
using the ‘Command
ID’-field.
The size and location
of the data associated
with this object is
determined by the
user.
This object will
retrieve its settings
from the corresponding object in the
Query.
Example Response
Response
1
By default, the Modbus-RTU-specific frame objects are already in place, and a data object is inserted
between the function code and the CRC. These objects cannot be moved or deleted, however it is possible to add additional objects between the function code and the CRC as desired.
Name the new command by entering its name in the ‘Command Name’-field, and enter a suitable function code in the ‘Command ID’-field. If the command is allowed to be broadcasted, check the ‘Allow
Broadcasting’-checkbox.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 16
16. DF1 Protocol Mode
This mode makes it possible to let the Anybus Communicator act as a DF1 protocol master on the subnetwork.
16.1 General
In DF1 master mode, communication is based on ‘services’. A ‘service’ represents a set of commands
and operations on the sub-network, that is predefined in the Anybus Communicator. Each service is
associated with a set of parameters controlling how and when to use it on the sub-network.
The communication is based on a query-response scheme, where the gateway issues a query on the subnetwork. The addressed node on the sub-network is expected to issue a response to that query. Nodes
are not permitted to issue responses spontaneously, i. e. without first receiving a query.
Control System
Gateway
Subnetwork Devices
In DF1 Master Mode, Anybus Configuration Manager comes preloaded with a number of services, that
can be selected by the user. The actual DF1 commands, that perform the services during runtime, are
predefined in the Anybus Communicator. The configuration of the services is performed by right-clicking on a node in the Anybus Configuration Manager and selecting ‘Add Command’.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
DF1 Protocol Mode 89
16.2 ABC Parameters
(Select ‘ABC’ in the Navigation Section to gain access to the parameters
described in this section).
Interface
Currently, only serial communication is supported.
Status / Control Word
(See “Control and Status Registers” on page 104).
Value
Description
Enabled
Enable the Control and Status Registers. The ‘Data Valid’-bit in the Control Register must
be set to start the sub-network communication.
Enabled but no startup lock
This setting is similar to ‘Enabled’, except that the control system is not required to set the
‘Data Valid’-bit to start the sub-network communication.
Disabled
This setting completely disables the Control and Status Registers.
Module Reset
This parameter specifies how the gateway will behave in the event of a fatal error.
Value
Description
Enabled
The gateway will be restarted, and no error will be indicated to the user.
Disabled
The gateway will halt and indicate an error.
Protocol Mode
This parameter specifies which protocol mode to use for the sub-network.
Value
Description
DF1
This mode is intended for the DF1 protocol. The Anybus Communicator can only be configured as a Master with half-duplex communication.
Note: This is the only mode available if you intend to configure an ABC module for DF1.
See also “Protocol Modes” on page 18.
Statistics
The Transmit- and Receive Counters indicate how many transactions that have successfully been exchanged on the sub-network. This feature is primarily intended for debugging purposes.
•
Receive Counter Location
Specifies the location of the Receive Counter in the internal memory buffer.
•
Transmit Counter Location
Specifies the location of the Transmit Counter in the internal memory buffer.
Both counters are enabled by setting ‘Statistics’ to ‘Enabled’.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
DF1 Protocol Mode 90
16.3 Sub-network Parameters
(To gain access to the parameters described in this section, select ‘sub-network’ in the Navigation Section).
Communication
These parameters specify the actual communication settings used for the sub-network.
Parameter
Description
Valid Settings
Bit rate (baud rate)
Selects the bit rate
2400
4800
9600
19200
38400 (Default)
Data bits
Selects the number of data bits
8
Parity
Selects the parity mode
None, Odd, Even
Physical standard
Selects the physical interface type
RS232, RS422, RS485
Start bits
Number of start bits.
Stop bits
Number of stop bits.
1
DF1 Settings
Parameter
Master Node Address
Poll time, active slaves (10 ms)
Description
Node address of the master, valid values: 0 - 254, default 1
Determines how often the slave shall be polled in steps of 10 ms, default 100 msa
Poll time, inactive slaves (10 ms) Determines how often the slave shall be polled in steps of 10 ms, default 1000 msb
a. The default value is given as 10 in the parameter window. Each change of 10 ms either increases or decreases
this value by 1, i.e. 9 represents a poll time of 90 ms and 11 represents a poll time of 110 ms.
b. The default value is given as 100 in the parameter window. Each change of 10 ms either increases or decreases
this value by 1, i.e. 99 represents a poll time of 990 ms and 101 represents a poll time of 1010 ms.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
DF1 Protocol Mode 91
16.4 Node Parameters
To gain access to the parameters described in this section, select a node
in the navigation section. For more information about nodes, see
“Nodes” on page 68.
Parameter
Checksum
Description
Selects the type of checksum on the network.
Slave Address
Type
The value entered here sets the node address.
The PLC type of the slave
Valid Settings
BCC
CRC (default)
0-254
PLC-5
SLC500
MicroLogix
16.5 Services
Services are commands that can be stored and reused. The user configures each slave with services that
can be issued from the master. A total of 50 services are allowed.
The Anybus Communicator supports a selection of DF1 commands. When the gateway is going to execute a service, it automatically chooses the appropriate DF1 command(s) that are used to perform the
service on the selected DF1 node type.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
DF1 Protocol Mode 92
16.5.1 Available Services
Right click on the node, and choose Add Command.
A pop-up window will show the four different services that are available:
•
Integrity check
•
Read diagnostics
•
Read data
•
Write data
A maximum of 50 services in total (for all nodes) can
be selected.
The predefined services can be configured to suit the
application. Select a service to show the parameters.
General Configuration Parameters
These parameters are common to all services, but the settings
are individual to each instance of a service.
General:
Parameter
Offline options for
fieldbus
Offline options for
sub-network
Update mode
Description
The action to take for this service
if the fieldbus goes offline. This
option affects the data that is sent
out to the sub-network.
The action to take for this service
if the sub-network goes offline.
This option affects the data that is
reported to the fieldbus master.
The update mode for this service
Valid settings
Clear
Freeze
Noscanning
Clear
Freeze
Cyclically
On data change
Single shot
Change of state
on trigger
Timing:
Parameter
Retries
Timeout time (10 ms)
Description
The number of times to resend this service before the node is disconnected
The time to wait before resending this service (in steps of 10 ms)a
Default
3
1000 ms
Update time (10 ms)
The minimum time between two services of this kind (in steps of 10 ms)a
1000 ms
a. The default value is given as 100 in the parameter window. Each change of 10 ms either increases or decreases
this value by 1, i.e. 99 represents a poll time of 990 ms and 101 represents a poll time of 1010 ms.
Trigger:
Parameter
Request Trigger byte
address
Response Trigger byte
Response Trigger byte
address
Description
The memory location of the trigger byte this service uses for updates on trigger
byte changes
Enables/disables the trigger byte
The memory location of the trigger byte this service uses for updates on trigger
byte changes
Valid settings range from 0x200... 0x3FF and 0x400... 0xNNN
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Default
0x05FF
Disabled
0x05FF
Doc. ID: SCM-1200-096
DF1 Protocol Mode 93
16.6 Integrity Check
This service checks that a node is up and running correctly. A telegram is sent to the node. The node
mirrors and returns the telegram. No configuration is needed, apart from the general parameters, common to all services.
16.7 Read Diagnostics
This service reads diagnostic information from the module.
Command parameters
The command parameter Size decides the amount of data that can be read. The size is given in bytes
which means that it always has to be an even number as only whole elements can be read from the slave.
One bit/integer element is 2 bytes and one float element is 4 bytes. The range of the size differs, depending on node type:
Size range (in bytes)
PLC-5
1-26
SLC500
1-28
MicroLogix
1-26
Data options:
Parameter
Byte swap
Data length
Offset
Description
Determines if the data shall be swapped
Valid settings
No byte swap
Swap words
Swap double words
The number of bytes, read from the DF1 network, to write to the area determined ≤ Size
by the Offset parameter
The offset in the internal memory buffer in the module, where the data shall be
read. See “Memory Map” on page 16
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
DF1 Protocol Mode 94
16.8 Read Data
This service is used to read data from the nodes in the sub-network.
Command Parameters
Parameter
Description
Element Number The element number of the data file to be accessed within the slave.
File number
File type
Size
Valid settings
PLC-5: 0-999
SLC500: 0-255
MicroLogix: 0-255
The file number of the data file to be accessed.
PLC-5: 3, 7, 8, 10-999
SLC500: 3, 7, 8, 10-255
MicroLogix: 3, 7, 8, 10-255
The file type of the data to be accessed.
Integer
Bit
Float
The number of bytes to read from the slave. One bit/integer element is PLC-5: 2-240
2 bytes and one float element is 4 bytes. The parameter must have an SLC500: 2-236
even value as only whole elements can be read from the slave.
MicroLogix: 2-242
Data Options
Parameter Description
Byte swap Determines if the data shall be swapped.
Valid settings
No byte swap
Swap words
Swap double words
Data length The number of bytes, read from the DF1 network, to write to the area determined ≤ Size
by the Offset parameter
Offset
The offset in the internal memory buffer in the module, where the data shall be
read. See “Memory Map” on page 16.
Note: If the control and status registers are enabled (default), first available data
location will be: Input area 0x002, Output area 0x202.
16.9 Write Data
This service is used to write data to the nodes in the sub-network. The parameters to be configured are
the same as for the service Read Data. The only difference is that data is read from the internal memory
buffer in the Anybus Communicator and written to the sub-network bus, instead of being written to the
internal memory buffer.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 17
17. Sub-network Monitor
General
The sub-network Monitor is intended to simplify configuration and troubleshooting of the sub-network.
Its main function is to display the data allocated for sub-network communication and detect if any area
has been allocated twice (i.e if a collision has occurred).
All configured nodes, and their transactions, are listed in the middle of the screen (B). Selecting and deselecting single transactions makes it possible to view any combination of allocated data.
Note: The sub-network monitor has a negative influence on the overall performance of the gateway.
Therefore the monitor functionality should be used with care.
Operation
A
B
C
A: Start Network & Stop Network Icons
These icons controls the sub-network activity. To stop all sub-network
activity, click on the red light. To start the sub-network again, click on
the green light.
Start
Stop
B: Nodes / Transactions
To view data blocks associated with a transaction, select the transaction in the list. The corresponding data will then appear in the Monitor Section (C).
C: Monitor Section
This section visualizes how data is allocated in the Input, Output and General Data areas.
Color
White
Yellow
Blue
Red
Grey
Green
Meaning
Not allocated.
Data allocated by a Response or Consume transaction.
Data allocated by a Query or Produce transaction
Collision; area has been allocated more than once.
Reserved (illustrates memory consumption, area can be allocated if necessary)
Data allocated by Trigger byte, Transmit/Receive Counter, or Control/Status Registers.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 18
18. Node Monitor
18.1 General
The Node Monitor can provide valuable information when setting up the communication with the subnetwork, by allowing individual commands to be issued manually, and monitoring the response (if applicable). It also provides an overview of the memory used by a particular node.
Note: The node monitor has a negative influence on the overall performance of the gateway, i.e. it
should be used only when necessary.
The Node Monitor behaves somewhat differently in the three protocol modes:
•
Master Mode and DF1 Master Mode
The selected Command (Query Transaction) or Service is sent to the sub-network. The response
to the Query can be monitored in the Response Section.
Command Section (Query)
Subnetwork
Response Section
•
Generic Data Mode
The selected command (Transaction Produce) is sent to the sub-network. It is not possible to
monitor any responses etc. generated by other nodes.
Command Section (Produce)
Subnetwork
(Not used)
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Node Monitor 97
18.2 Navigating the Node Monitor
A
B
C
D
A: Pull-down Menu & Toolbar Icons
See “Pull-Down Menu” on page 98 and “Toolbar Icons” on page 99.
B: Command Section
This section holds the currently selected command. The individual frame objects in the command can be edited in a similar way as in the Transaction and Command Editors.
C: Response Section (Master Mode and DF1 Master Mode only)
This section holds the response to the selected Command.
D: Monitor Section
This section displays the data associated with the node. Areas in dark grey are reserved for the
Status & Control Registers, and areas displayed in light grey represent the data that is used by the
node.
The data displayed in this section will be refreshed based on the refresh-icons in the toolbar. For
more information, see “Toolbar Icons” on page 99.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Node Monitor 98
18.2.1 Pull-Down Menu
File
There is only one entry in this menu:
•
Exit
This will close the Node Monitor. Note however that if the node has
been disabled using ‘Stop Node’ (see below), it will not resume data
exchange until enabled again using ‘Start node’.
Node
This menu controls the data exchange for the node. This feature can
help isolate problems associated with a particular node.
•
Start Node
Enable the transactions associated with the node.
•
Stop Node
Disable the transactions associated with the node.
Command
This menu is used to specify and issue a command manually.
•
Select Command
Select a command to be sent to the sub-network.
•
Send Command
Send the specified command to the sub-network.
Columns
This menu specifies the number of columns in the Monitor
Section.
•
Free
The number of columns depends on the width of the window.
•
8 Multiple
The number of columns will be fixed to 8.
View
This menu specifies the data representation in the Monitor Section.
•
Hex
Display the data in hexadecimal format.
•
Decimal
Display the data in decimal format.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Node Monitor 99
18.2.2 Toolbar Icons
The toolbar features icons for the most commonly used functions.
•
Start Node & Stop Node
These icons corresponds to the functions in the ‘Node’-menu.
See also “Node” on page 98.
•
Start
Stop
Select
Send
Stop
Resume
Select Command & Send Command
These icons corresponds to the functions in the ‘Command’-menu.
See also “Command” on page 98.
•
Resume Refresh & Stop Refresh
When enabled, the data displayed in the Monitor Section will be refreshed cyclically. When disabled, i.e. stopped, the data will have to be
refreshed manually using the ‘Refresh’-icon (see below).
•
Refresh
When clicking on this icon, the data displayed in the Monitor Section will be refreshed.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Refresh
Doc. ID: SCM-1200-096
Chapter 19
19. Data Logger
19.1 General
This feature allows the sub-network traffic to be logged into a buffer for examination. This may provide
valuable information when debugging the lowest levels of the sub-network communication.
Note that the logger function is part of the gateway itself and is separate from the Anybus Configuration
Manager. This means that logging can be performed even if the gateway is physically disconnected from
the PC running the Anybus Configuration Manager.
19.2 Operation
Start & Stop Logging
•
Start logging
Select ‘Start Logging’ in the ‘Tools’-menu. Anybus Configuration Manager will then prompt for
the desired mode of operation, see below.
•
Stop logging
Select ‘Stop Logging’ in the ‘Tools’-menu. This will open the log-window, see below.
Modes of Operation
Select the desired mode of operation and click ‘OK’ to start logging data.
•
Log until full
Data will be logged until the log-buffer is full.
•
Log continuously
Data will be logged continuously until logging is
stopped by clicking ‘Stop Logging’. The log-buffer
will contain the most recent data.
Log Window
The logged data is displayed in hexadecimal, decimal and ASCII format for both directions. The time between the log-entries is displayed in a separate column.
The data may optionally be saved in ASCII text format by
clicking ‘Create Text file’.
Click ‘Close’ to exit.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Data Logger 101
19.3 Configuration
By default, the log-buffer can hold 512 bytes of data in each
direction. To specify a different size for the buffer, select
‘Options’ in the ‘Tools’-menu.
A window with various settings will appear. Select the ‘ABC’tab, and enter the desired number of buffer entries under
‘Size of logbuffer’ (valid settings range from 1...512).
Click ‘Apply’ to validate the new settings.
Click ‘OK’ to exit.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 20
20. Configuration Wizards
20.1 General
When creating a new sub-network configuration, the Anybus Configuration Manager provides a choice
between starting out with a blank configuration, or using a predefined template, a.k.a a wizard.
The wizard automatically creates a sub-network configuration based on information supplied by the user, i.e the user simply has to “fill in the blanks”. Note however that this will only work when the subnetwork fits the wizard profile; in all other cases the ‘Blank Configuration’ option must be used.
20.2 Selecting a Wizard Profile
The following window appears each time the Anybus Configuration Manager is started, or upon selecting the ‘New’ entry in the ‘File’-menu (unless it has been disabled in the ‘Options’-menu, see “Tools”
on page 61).
Currently, the following wizards are available:
•
ABCC ExtLink Wizard
This wizard is intended for use with the Anybus-CompactCom Modbus-RTU fieldbus communication
adapter.
•
Wizard - Modbus RTU Master
This option is suitable for Modbus RTU-based networks.
See also “Wizard - Modbus RTU Master” on page 103.
•
Blank Configuration
This option creates an empty configuration.
Highlight the desired wizard and click ‘OK’ to continue.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Configuration Wizards 103
20.3 Wizard - Modbus RTU Master
This wizard can be used to create a Modbus-RTU-based network configuration based on certain information about the sub-network. The online help system explains each configuration step in detail.
•
Important Notes:
Many OEM devices do not fully comply with the Modbus standard. For example, they may implement a variation of this standard or be limited to the use of specific Modbus commands other
than the ones used by this wizard. In all cases, the user should consult the documentation of the
devices that shall be used on the sub-network for information about their serial communication
requirements, and if necessary contact the manufacturer of the device to obtain further information about the serial communication protocol.
In the event that the wizard doesn’t handle a particular Modbus command required by a device,
it is possible to specify this command manually as a transaction in the Anybus Configuration
Manager.
Using this wizard involves the following steps:
Step 1: Communicator Type
Select ‘EtherNet/IP’.
Click ‘Next’ to continue.
Tip: It is possible to return to a previous
menu at any time without losing any settings by clicking ‘Previous’.
Step 1a: I/O Sizes
Specify the sizes of the input and output
data areas.
Click ‘Next’ to continue.
See also...
•
“EtherNet/IP” on page 22
•
“I/O Sizes” on page 64
Step 2: Physical Settings
Select the physical properties of the subnetwork.
Click ‘Next’ to continue.
Steps 3 - 6
Consult the online help system for further information.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 21
21. Control and Status Registers
21.1 General
The Control and Status Registers are disabled by default, but can be enabled using the Anybus Configuration Manager (see “Status / Control Word” on page 65). These registers form an interface for exchanging status information between the sub-network and the fieldbus control system.
The main purpose of these registers is to...
•
Report sub-network related problems to the fieldbus control system
•
Ensure that only valid data is exchanged in both directions
•
Enable the fieldbus control system to start/stop data exchange with selected nodes on the subnetwork
If enabled, these registers occupy the first two bytes in the input and output data areas (0x000-0x001 and
0x200-0x201 respectively), which means they can be accessed from the fieldbus just like any other data
in these areas.
Note: Internally, these registers are stored in Motorola-format (i.e. MSB first). If the higher level network uses a different byte order, the upper and lower bytes will appear swapped.
21.1.1 Handshaking Procedure
A special handshaking procedure, which is illustrated in the two flowcharts below, must be followed
when accessing these registers to ensure that both parts receive proper information.
Read Status Register
Write to Control Register
Start
Start
CR_HS_CONFIRM=
SR_HS_SEND?
No
Yes
SR_HS_CONFIRM=
CR_HS_SEND?
Yes
Read Status Register
Write to Control Register
Set CR_HS_CONFIRM
to SR_HS_SEND
Toggle CR_HS_SEND
Done
Done
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
No
Doc. ID: SCM-1200-096
Control and Status Registers 105
21.1.2 Data Consistency
The ‘Data Valid’-bits in the Control and Status Registers are used to ensure data consistency during startup and fieldbus offline/online transitions.
If the ‘Status / Control Word’-parameter in Anybus Configuration Manager is set to ‘Enabled’, the gateway will wait for the fieldbus control system to set the ‘Data Valid’-bit in the Control Register before it
starts exchanging data on the sub-network.
If the same parameter is set to ‘Disabled’ or ‘Enabled but no startup lock’, communication will start as
soon as the fieldbus goes online.
State Machine
The fieldbus network participation can be described using a state machine as described below.
A: Offline (No data exchange)
1. Clear the ‘Data Valid’-bit in the Control Register.
2. Write initial data to the Output Area
according to the sub-network configuration.
A
Start
Offline
(no data exchange)
3. Wait until the fieldbus control system
and the gateway are online on the fieldbus network, and shift to state B.
B
Online
(not yet exchanging data)
B: Online (Not yet exchanging data)
4. Wait until the ‘Data Valid’-bit in the
Status Register is cleared by the gateway.
5. Set the ‘Data Valid’-bit in the Control
Register.
C
Online
(exchanging data)
6. When the ‘Data Valid’-bit in the Status
Register is set by the gateway, shift to
state C.
7. If the gateway goes offline on the fieldbus, shift to state A.
C: Online (Exchanging data)
Exchanging valid data in both directions.
If the gateway goes offline on the fieldbus, shift to state A.
Note: The gateway cannot spontaneously clear the ‘Data Valid’-bit in the Status Register.
Latency
The ‘Data Valid’-bit in the Status Register may in some cases be delayed. This latency can be caused by
a missing node or a bad connection to a node with a long timeout value assigned to it.
Therefore, the fieldbus control system should not wait for this bit to be set before communicating with
the sub-network devices; it should be considered as an aid for the fieldbus control system to know when
all data has been updated.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Control and Status Registers 106
21.2 Status Register Contents (Gateway to Control System)
21.2.1 General Information
The Status Register is (if enabled) located at 0x000-0x001 and constitutes a bit-field as follows:
bit(s)
Name
Description
15
Send
(SR_HS_SEND)
These bits control the handshaking towards the fieldbus control system.
14
Confirm
(SR_HS_CONFIRM)
See also...
- “Handshaking Procedure” on page 104
- “Control Register Contents (Control System to Gateway)” on page 108
13
Data Valid
(Master Mode and DF1
Master Mode Only)
This bit is set when all transactions have been executed successfully at least once.
Once set, it will not change.
1:Data Valid
0:Data not Valid
Note: This bit is not used in Generic Data Mode.
12... 8 Status Code
This field holds the last status report from the gateway.
7... 0
See also...
- “Status Codes in Master Mode and DF1 Master Mode” on page 106
- “Status Code in Generic Data Mode” on page 107
Data
Note: Internally, this is treated as a Motorola-format word (i.e. MSB first). If the higher level network
uses a different byte order, the upper and lower bytes will appear swapped.
21.2.2 Status Codes in Master Mode and DF1 Master Mode
(This table is valid only in Master Mode and DF1 Master Mode).
Code
Condition
Type
Data
Description
0x00
Retransmission
Counter Updated
Warning
Counter
The number of retransmissions on the subnetwork has increased. If this problem persists, this may eventually trigger a Single- or
Multiple Node(s) Missing condition.
0x01
Single Node Missing
Error
Slave address
A single node is missing.
0x02
Multiple Nodes Missing
Error
Number of nodes Multiple nodes are missing.
0x03
Buffer Overrun
Warning
Slave address
A node returned more data than expected.
0x04
Other Error
Error
Slave address
Undefined error
0x1F
No Error
Warning
-
No errors
Note: Conditions of type ‘Error’ will eventually be followed by a ‘No Error’ condition when the cause
has been resolved. Conditions of type ‘Warning’ are however considered informational and may not necessarily be followed by a ‘No Error’ condition later on.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Control and Status Registers 107
21.2.3 Status Code in Generic Data Mode
(This table is valid only in Generic Data Mode).
Code
Condition
Type
Data
Description
0x00
Invalid Transaction
Counter Updated
Error
Counter
The number of invalid transactions (i.e. received transactions which doesn’t match any of the consume-transactions
defined in the sub-network configuration) has increased.
0x01
Frame Error
Warning
-
End character is enabled, but a message delimiter timeout
occurs prior to receiving it.
0x02
Offline Timeout
Counter Updated
Error
Counter
The of number of timed out consume-transactions has
increased.
See also...
- “Consume-Transactions” on page 74 (Offline timeout
time)
0x03
Buffer Overrun
Warning
-
A node returned more data than expected - or - the gateway was unable to finish processing a message prior to
receiving a new one.
0x04
Other Error
Error
-
Undefined error
0x1F
No Error
Warning
-
No errors
Note: Conditions of type ‘Error’ will eventually be followed by a ‘No Error’ condition when the cause
no longer is detected. Conditions of type ‘Warning’ are however considered informational and may not
necessarily be followed by a ‘No Error’ condition later on.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Control and Status Registers 108
21.3 Control Register Contents (Control System to Gateway)
21.3.1 General Information
The Control Register is (if enabled) located at 0x200-0x201 and constitutes a bit-field as follows:
bit(s)
Name
Description
15
Confirm
(CR_HS_CONFIRM)
These bits control the handshaking towards the gateway.
14
Send
(CR_HS_SEND)
See also...
- “Handshaking Procedure” on page 104
- “Status Register Contents (Gateway to Control System)” on page 106
13
Data Valid
This bit controls data consistency (see “Data Consistency” on page 105).
1:Output Area valid; exchange data on the sub-network
0:Output Area not valid; do not exchange data on the sub-network
Note: This bit is only relevant if the Control/Status Registers are set as ‘Enabled’
12
Execute Command
If set, the specified command will be executed by the gateway (see below).
11... 8 Control Code
This field holds commands which can be executed by the gateway (see below).
7... 0
See also...
- “Control Codes in Master Mode and DF1 Master Mode” on page 108
- “Control Codes in Generic Data Mode” on page 108
Data
Note: Internally, this is treated as a Motorola-format word (i.e. MSB first). If the higher level network
uses a different byte order, the upper and lower bytes will appear to be swapped.
21.3.2 Control Codes in Master Mode and DF1 Master Mode
(This table is valid only in Master Mode and DF1 Master Mode).
Code
Instruction
Data
Description
0x00
Disable Node
Actual node address
Disables the specified node.
0x01
Enable Node
Actual node address
Enables a previously disabled node.
0x02
Enable Nodes
Actual number of nodes to enable
Enables the specified number of nodes, starting from the first node in the configuration.
Remaining nodes will be disabled.
21.3.3 Control Codes in Generic Data Mode
(No Control Codes are currently supported in this mode).
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Chapter 22
22. CIP Object Implementation
22.1 General
The following CIP-objects are implemented in this product:
Mandatory Objects
Object
Identity Object, Class 01h
Message Router, Class 02h
Assembly Object, Class 04h
Port Object, Class F4h
TCP/IP Interface Object, Class F5h
Ethernet Link Object, Class F6h
Page
110
111
112
119
120
121
Vendor Specific Objects
Object
Diagnostic Object, Class AAh
Parameter Data Input Mapping Object, Class B0h
Parameter Data Output Mapping Object, Class B1h
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Page
116
117
118
Doc. ID: SCM-1200-096
CIP Object Implementation 110
22.2 Identity Object, Class 01h
22.2.1 General Information
Object Description
Supported Services
Class services:
Get Attribute All
Get Attribute Single
Instance services:
Get Attribute All
Get Attribute Single
Reset
22.2.2 Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0001h
Description
Revision 1
Value
Default: 005Ah
Default: 000Ch
Default: 0054h
Description
HMS Industrial Networks AB
Communication Adapter
Anybus Communicator
Major fieldbus version
Minor fieldbus version
Device status, see table below
(set at production)
Name of product
22.2.3 Instance Attributes
#
1
2
3
4
Access
Get
Get
Get
Get
Name
Vendor ID
Device Type
Product Code
Revision
5
6
7
Get
Get
Get
Status
Serial Number
Product Name
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type
UINT
UINT
UINT
Struct of:
USINT
USINT
WORD
UDINT
SHORT_STRING
Serial number
Anybus Communicator
Doc. ID: SCM-1200-096
CIP Object Implementation 111
Device Status
bit(s)
0
1
2
3
4... 7
8
9
10
11
12... 15
Name
Module Owned
(reserved)
Configured
(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
Set for major recoverable faults
Set for major unrecoverable faults
(reserved)
22.3 Message Router, Class 02h
22.3.1 General Information
Object Description
Supported Services
Class services:
Instance services:
-
22.3.2 Class Attributes
-
22.3.3 Instance Attributes
-
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
CIP Object Implementation 112
22.4 Assembly Object, Class 04h
22.4.1 General Information
Object Description
This object provides access to the I/O Data in the input and output data areas in the Anybus Communicator.
See also...
•
“EtherNet/IP” on page 22
•
“Fieldbus Settings” on page 64
Supported Services
Class services:
Get Attribute Single
Instance services:
Get Attribute Single
Set Attribute Single
22.4.2 Class Attributes
#
1
2
Access
Get
Get
Name
Revision
Max Instance
Type
UINT
UINT
Value
0002h
-
Description
Revision 2
The highest initiated instance no.
22.4.3 Instance 64h (100) Attributes
This instance corresponds to I/O data (input) in the gateway.
Note: If the I/O input data size is set to 0 this instance will NOT be initialized.
#
3
Access
Get
Name
Data
Type
Array of BYTE
Value
-
Description
Data produced by the gateway
22.4.4 Instance 96h (150) Attributes
Note: If the I/O output data size is set to 0 this instance will NOT be initialized.
#
3
Access
Set
Name
Data
Type
Array of BYTE
Value
-
Description
Data consumed by the gatewaya
a. Rockwell Automation PLCs have the first four bytes consumed by a device defined as status information. This
behavior is specific to devices from Rockwell Automation and is not defined in the EtherNet/IP specification.
However, since all known PLCs are implemented this way, the Anybus Communicator adopts this behavior
and strips off the corresponding four bytes from the consumed data.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
CIP Object Implementation 113
22.4.5 Instance C6h (198) Attributes (Heartbeat Input-Only)
This instance is used as heartbeat for input-only connections, and does not carry any data.
22.4.6 Instance C7h (199) Attributes (Heartbeat, Listen-Only)
This instance is used as heartbeat for listen-only connections, and does not carry any data.
22.5 DLR Object, Class 47h
General Information
Object Description
Information about the Device Level Ring (DLR) can be read from this object. An Announced-based
ring participant is supported.
Note: The module will only act as an Announce-based DLR participant, not as a DLR ring supervisor.
Supported Services
Class services:
Get Attributes All
Get Attribute Single
Instance services:
Get Attributes All
Get Attribute Single
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
CIP Object Implementation 114
Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0002h
Instance Attributes, Instance 01h
#
Access
01h Get
Name
Network Topology
Type
USINT
Description
Gives network topology.
0 - Linear
1 - Ring
Gives network status.
0 - Normal
1 - Ring Fault
02h Get
Network Status
USINT
10h Get
Active Supervisor Address
12h Get
Capability Flags
Struct of:
UDINT
Supervisor IP address
Array of BYTE Supervisor MAC address
DWORD
Describes the DLR capabilities of the device, see below
Value: 01h
Capability Flags
Bit #
0
1
Name
Definition
Announce-based Ring Node Set if Announce frames are useda
Beacon-based Ring Node
Set if Beacon frames are useda
2-4
5
Reserved
Supervisor capable
6 - 31
Reserved
Set to zero
Set if device is supervisor capable. Set to 0 as this module is not supervisor
capable.
Set to zero
a. Either bit 0 or bit 1 shall be set.
22.6 QoS Object, Class 48h
General Information
Object Description
This object sets up QoS services for the module. Quality of service is the ability to provide different priority to different applications on a congested network in order to guarantee a cerain level of performance
to a data flow. In the absence of congestion QoS is not needed.
Supported Services
Class services:
Get Attribute All
Get Attribute Single
Instance services:
Get Attribute Single
Set Attribute Single
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
CIP Object Implementation 115
Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0001h
Instance Attributes, Instance 01h
#
Access
01h Set
Name
802.1Q Tag Enable
04h Set
DSCP Urgent
05h Set
DSCP Scheduled
06h Set
DSCP High
07h Set
DSCP Low
08h Set
DSCP Explicit
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type Description
USINT Enables or disables sending 802.1Q frames.
0 - Disabled (default)
1 - Enabled
USINT CIP transport class 1 messages with Urgent priority
Default: 55
USINT CIP transport class 1 messages with Sheduled priority
Default: 47
USINT CIP transport class 1 messages with High priority
Default: 43
USINT CIP transport class 1 messages with Low priority
Default: 31
USINT CIP UCMM and CIP class 3
Default: 27
Doc. ID: SCM-1200-096
CIP Object Implementation 116
22.7 Diagnostic Object, Class AAh
22.7.1 General Information
Object Description
This object groups diagnostic information for the fieldbus interface.
Supported Services
Class services:
Get Attribute All
Instance services:
Get Attribute Single
22.7.2 Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0001h
Description
Revision 1
22.7.3 Instance Attributes, Instance 01h
#
01h
02h
03h
04h
0Ah
0Fh
11h
12h
14h
Access
Get
Get
Get
Get
Get
Get
Get
Get
Get
Name
Module serial number
Vendor ID
Fieldbus Type
Module Software version
Module Type
IN cyclic I/O length
IN total length
OUT cyclic I/O length
OUT total length
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type
UDINT
UINT
UINT
UINT
UINT
UINT
UINT
UINT
UINT
Description
Serial number
Manufacturer Vendor ID
Fieldbus Type
Module software version
Module Type
Size of I/O Input area (in bytes)
Total number of IN bytes supported
Size of I/O Output area (in bytes)
Total number of OUT bytes supported
Doc. ID: SCM-1200-096
CIP Object Implementation 117
22.8 Parameter Data Input Mapping Object, Class B0h
22.8.1 General Information
Object Description
This object can be used to access input data acyclically, and is set up dynamically based on the Parameter
Data Mailbox initialization (see “Parameter Data Initialization (Explicit Data)” on page 124).
See also...
•
“EtherNet/IP” on page 22
•
“Fieldbus Settings” on page 64
•
“Parameter Data Output Mapping Object, Class B1h” on page 118
•
“Parameter Data Initialization (Explicit Data)” on page 124
Supported Services
Class services:
Get Attribute All
Instance services:
Get Attribute Single
22.8.2 Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0001h
Description
Revision 1
22.8.3 Instance Attributes, Instance 01h
Each attribute corresponds to a block of Input Data. Note that the size and location of each block must
be specified using the Anybus Configuration Manager.
For more information, see A-124 “Parameter Data Initialization (Explicit Data)”.
#
01h
02h
02h
02h
02h
02h
...
32h
Access
Get
Get
Get
Get
Get
Get
...
Get
Name
Data
Data
Data
Data
Data
Data
...
Data
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type
Array of USINT
Array of USINT
Array of USINT
Array of USINT
Array of USINT
Array of USINT
...
Array of USINT
Description
Mapped block if Input Data
Mapped block if Input Data
Mapped block if Input Data
Mapped block if Input Data
Mapped block if Input Data
Mapped block if Input Data
...
Mapped block if Input Data
Doc. ID: SCM-1200-096
CIP Object Implementation 118
22.9 Parameter Data Output Mapping Object, Class B1h
22.9.1 General Information
Object Description
This object can be used to access output data acyclically, and is set up dynamically based on the Parameter Data Mailbox initialization (see “Parameter Data Initialization (Explicit Data)” on page 124).
See also...
•
“EtherNet/IP” on page 22
•
“Fieldbus Settings” on page 64
•
“Parameter Data Input Mapping Object, Class B0h” on page 117
•
“Parameter Data Initialization (Explicit Data)” on page 124
Supported Services
Class services:
Get Attribute All
Instance services:
Get Attribute Single
Set Attribute Single
22.9.2 Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0001h
Description
Revision 1
22.9.3 Instance Attributes, Instance 01h
Each attribute corresponds to a block of output data. Note that the size and location of each block must
be specified using the Anybus Configuration Manager.
For more information, see “Parameter Data Initialization (Explicit Data)” on page 124
#
01h
02h
01h
02h
01h
02h
...
32h
Access
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
...
Get/Set
Name
Data
Data
Data
Data
Data
Data
...
Data
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type
Array of USINT
Array of USINT
Array of USINT
Array of USINT
Array of USINT
Array of USINT
...
Array of USINT
Description
Mapped block of Output Data
Mapped block of Output Data
Mapped block of Output Data
Mapped block of Output Data
Mapped block of Output Data
Mapped block of Output Data
...
Mapped block of Output Data
Doc. ID: SCM-1200-096
CIP Object Implementation 119
22.10 Port Object, Class F4h
22.10.1 General Information
Object Description
Supported Services
Class services:
Get Attribute All
Get Attribute Single
Instance services:
Get Attribute All
Get Attribute Single
22.10.2 Class Attributes
#
1
2
3
8
Access
Get
Get
Get
Get
Name
Revision
Max Instance
No. of instances
Entry Port
Type
UINT
UINT
UINT
UINT
Value
0001h
0002h
0001h
0002h
9
Get
All Ports
Array of STRUCT
{UINT; UINT;}
0000h 0000h
0000h 0000h
0004h 0002h
Description
Revision 1
2 is the highest instance number
1 instance is implemented
Returns the instance of the Port object that
describes the port.
Array of structure containing attributes 1 and
2 from each instance. Instance 1 is at byte
offset 4. Instance 2 is at byte offset 8, etc.
The 4 bytes at offset 0 shall be 0. (Default)
22.10.3 Instance Attributes, Instance 02h
#
1
2
3
4
8
Access
Get
Get
Get
Get
Get
Name
Port Type
Port Number
Port Object
Path Size
Path
Port Name
Node Address
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type
UINT
UINT
Struct of:
UINT
Padded EPATH
SHORT_STIRNG
Padded EPATH
Value
0004h
0002h
Comments
TCP/IP
Port 2
0002h
20 F5 24 01h
‘TCP/IP’
-
TCP class, Instance 1
Name of port
-
Doc. ID: SCM-1200-096
CIP Object Implementation 120
22.11 TCP/IP Interface Object, Class F5h
22.11.1 General Information
Object Description
This object groups TCP/IP-related settings.
See also...
•
“Basic Network Configuration” on page 36
•
“Fieldbus Settings” on page 64
Supported Services
Class services:
Get Attribute All
Get Attribute Single
Instance services:
Get Attribute All
Get Attribute Single
Set Attribute Single
22.11.2 Class Attributes
#
1
2
3
Access
Get
Get
Get
Name
Revision
Max Instance
No. of instances
Type
UINT
UINT
UINT
Value
0001h
0001h
0001h
Description
Revision 3
1 is the highest instance number
1 instance is implemented
22.11.3 Instance Attributes
#
1
2
Access
Get
Get
Name
Status
Configuration
Capability
Type
DWORD
DWORD
Value
00000001h
00000014h
Comments
Attribute #5 contains valid information.
Attribute #5 is settable
Capable of obtaining network configuration via
DHCP.
3
Get/Set
Configuration
Control
DWORD
-
Value:Meaning:
0 Configuration from non-volatile memory
2 Configuration from DHCP
4
Get
Port Object
Path Size
Path
Interface Configuration
IP Address
Subnet Mask
Gateway
Address
Name Server 1
Name Server 2
Domain Name
Host Name
Struct of:
UINT
0002h
Padded EPATH 20 F6 24 01h
Struct of:
2 words
Path to Ethernet Class, Instance 1
UDINT
UDINT
UDINT
-
IP address
Subnet mask
Gateway Address
UDINT
UDINT
STRING
STRING
-
Primary DNS
Secondary DNS
Default domain name
Host name
5
6
Get/Set
Get/Set
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
CIP Object Implementation 121
22.12 Ethernet Link Object, Class F6h
22.12.1 General Information
Object Description
This object groups diagnostic information for the Ethernet interface.
See also...
•
“Basic Network Configuration” on page 36
Supported Services
Class services:
Get Attribute All
Get Attribute Single
Instance services:
Get Attribute All
Get Attribute Single
22.12.2 Class Attributes
#
1
2
3
Access
Get
Get
Get
Name
Revision
Max Instance
No. of instances
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Type
UINT
UINT
UINT
Value
0001h
0001h
0001h
Description
Revision 1
2 is the highest instance number
2 instance is implemented
Doc. ID: SCM-1200-096
CIP Object Implementation 122
22.12.3 Instance Attributes
#
1
2
3
4
5
Access
Get
Get
Get
Get
Get
Name
Interface Speed
Interface Flags
Physical Address
Interface Counters
In Octets
In Ucast Packets
In NUcast Packets
In Discards
In Errors
Type
UDINT
DWORD
Array of 6 USINTS
Struct:
UDINT
UDINT
UDINT
UDINT
UDINT
Value
10 or 100
(MAC ID)
Comments
Actual ethernet interface speed
Physical network address
-
In Unknown Protos
Out Octets
Out Ucast Packets
Out NUcast Packets
Out Discards
Out Errors
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
-
Octets received on the interface
Unicast packets received on the interface
Non-unicast packets received on the interface
Inbound packets with unknown protocol
Inbound packets that contain errors (does not
include discards)
Inbound packets with unknown protocol
Octets sent on the interface
Unicast packets sent on the interface
Non-unicast packets sent on the interface
Outbound packets with unknown protocol
Outbound packets that contain errors (does
not include discards)
Media Counters
Alignment Errors
Struct:
UDINT
-
FCS Errors
UDINT
-
Single Collisions
UDINT
-
Multiple Collisions
USINT
-
SQE Test Errors
UDINT
Deferred Transmis- UDINT
sions
Late Collisions
UDINT
0
-
Excessive Collisions UDINT
-
MAC Transmit
Errors
Carrier Sense
Errors
UDINT
-
UDINT
-
Frame Too Long
UDINT
-
MAC Receive Errors UDINT
-
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Frames received that are not an integral
number of octets in length
Frames received that do not pass the FCS
check
Successfully transmitted frames which experienced exactly one collision
Successfully transmitted frames which experienced more than one collision
Frames for which first transmission attempt is
delayed because the medium is busy
Number of times a collision is detected later
than 512 bit-times into the transmission of a
packet
Frames for which a transmission fails due to
excessive collisions
Frames for which transmission fails due to an
internal MAC sublayer receive error
Times that the carrier sense condition was lost
or never asserted when attempted to transmit
a frame
Frames received that exceed the maximum
permitted frame size
Frames for which reception on an interface
fails due to an internal MAC sublayer receive
error
Doc. ID: SCM-1200-096
Chapter 23
23. Advanced Fieldbus Configuration
23.1 General
The fieldbus interface of the gateway consists of an embedded Anybus-S communication interface. Normally, the Anybus-S configuration settings are set up automatically by the gateway. However, advanced
users can configure the Anybus-S card for specific features. This chapter assumes that the reader is familiar with the Anybus-S and it’s application interface. For more information about the Anybus-S platform, consult the Anybus-S Parallel Design Guide.
The standard initialization parameters are determined by the sub-network configuration. Information
about the amount of input and output data used for sub-network communication is used by Anybus
Configuration Manager to create the configuration message that sets the sizes of the input and output
data areas in the Dual Port RAM of the embedded Anybus-S interface. It is possible to add fieldbus specific mailbox messages to customize the initialization. This is done in the Mailbox Editor, see below.
(A mailbox message is a HMS specific command structure used for low-level communication with an
Anybus-S interface. Consult the Anybus-S Parallel Design Guide and the fieldbus appendix for the desired fieldbus for further information.)
23.2 Mailbox Editor
To add a mailbox message to the configuration, right-click on
‘EndInit’ and select ‘Insert New Mailbox’.
A mailbox message consists of a Header section and a data section where the Header consists of 16 words (32 bytes) and the data
section consists of up to 128 words (256
bytes). All fields are editable except the Message information field that is fixed to 0x4002,
which means that only fieldbus specific mailbox messages can be entered here.
A
B
The mailbox message is presented as two columns; one contains header information (A),
the other one contains the message data (B).
To add message data, simply change the Data
size parameter in the header column (A), and
the corresponding number of bytes will appear in the message data column (B).
For more information about fieldbus specific mailbox messages, consult the separate Anybus-S Fieldbus
Appendix for the fieldbus you are using. For general information about the Anybus-S platform, consult
the Anybus-S Design Guide.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Appendix A
A. Parameter Data Initialization (Explicit Data)
A.1 General
The portion of the input and output data that is declared as parameter data cannot be accessed from the
network unless it has been properly initialized.
The purpose of this procedure is to specify which data blocks in the input and output data areas to associate with the instance attributes in the Parameter Data Input Mapping Object and the Parameter Data
Output Mapping Object.
To achieve this, it is required to set up two mailbox messages in the Mailbox Editor of the Anybus Configuration Manager. For more information about the Mailbox Editor, see “Mailbox Editor” on page
123.
A.2 Add a Mailbox Message
To add a mailbox message to the configuration, right-click on
‘EndInit’ and select ‘Insert New Mailbox’.
This causes the following window to appear:
This window, a.k.a. the Mailbox Editor, will be used in the
examples later in this chapter.
See also “Mailbox Editor” on
page 123.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Parameter Data Initialization (Explicit Data) 125
A.3 Mapping Input Parameter Data to EtherNet/IP
Example
In the following example, a total of 160 bytes of data will be mapped to the Parameter Data Input Mapping Object. The data is made up of 5 separate data blocks, each associated with a particular instance
attribute.
To achieve this, perform the following steps:
1. Add a new mailbox message to the configuration (see “Add a Mailbox Message” on page 124).
2. Change the ‘Command’-value in the mailbox header to 0084h.
3. Adjust the ‘Data Size’-value in the mailbox header (left column). In this example, the size shall
be set to 20 (0014h), since each mapped attribute occupies 4 bytes of mailbox data.
4. Specify the mapping locations for the attributes in the mailbox data section. As mentioned above,
each mapping entry needs 4 bytes; two bytes specifying the offset1 of the data block, followed by
two bytes which specify the length of the data block. Note that these values must be entered in big
endian (Motorola) format.
In this example, this gives us the following mailbox data:
Mailbox Data
Location
0x00
0x01
0x02
0x03
0x04
0x05
0x06
0x07
0x08
0x09
0x0A
0x0B
0x0C
0x0D
0x0E
0x0F
0x10
0x11
0x12
0x13
Data
0x00
0x00
0x00
0x20
0x00
0x40
0x00
0x40
0x00
0x80
0x00
0x10
0x00
0x90
0x00
0x20
0x00
0xF0
0x00
0x10
Attribute no.
Comments
1
Offset = 0000h
Size = 32 bytes
2
Offset = 0040h
Size = 64 bytes
3
Offset = 0080h
Size = 16 bytes
4
Offset = 0090h
Size = 32 bytes
5
Offset = 00F0h
Size = 16 bytes
As shown in the table above, the attributes are numbered in the order they are mapped, i.e. it is
possible to rearrange the attribute numbering by physically changing the mapping order in the
mailbox data.
5. To save the new mailbox, select ‘Apply changes’ in the ‘File’-menu.
1. The offset is specified from the start of the parameter data, not from the physical memory location in the
Anybus Communicator.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Parameter Data Initialization (Explicit Data) 126
Resulting Attribute Mapping
Input Data
0x000
Parameter Data
Input Mapping Object
I/O Data (Input)
Attributes:
IO Size In
(256 bytes)
#1 - Revision
Instance #1
Attributes:
#1 - Data
#2 - Data
#3 - Data
#4 - Data
#5 - Data
0x0FF
0x100
32 bytes
Offset 0x0000h
(not mapped)
64 bytes
16 bytes
32 bytes
(not mapped)
0x1FF
16 bytes
Offset 0x00FFh
Mailbox Editor Screenshot
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Parameter Data Initialization (Explicit Data) 127
A.4 Mapping Output Parameter Data to EtherNet/IP
Example
Mapping output data is similar to mapping input data; in the following example, a total of 144 bytes of
data will be mapped to the Parameter Data Output Mapping Object. The data is made up of 4 separate
blocks, each associated with a a particular instance attribute.
To achieve this, perform the following steps:
1. Add a new mailbox message to the configuration (see “Add a Mailbox Message” on page 124).
2. Change the ‘Command’-value in the mailbox header to 0085h.
3. Adjust the ‘Data Size’-value in the mailbox header (left column). In this example, the size shall
be set to 16 (0010h), since each mapped attribute occupies 4 bytes of mailbox data.
4. Specify the mapping locations for the attributes in the mailbox data section. As mentioned above,
each mapping entry needs 4 bytes; two bytes specifying the offset1 of the data block, followed by
two bytes which specify the length of the data block. Note that these values must be entered in big
endian (Motorola) format.
In this example, this gives us the following mailbox data:
Mailbox Data
Location
0x00
0x01
0x02
0x03
0x04
0x05
0x06
0x07
0x08
0x09
0x0A
0x0B
0x0C
0x0D
0x0E
0x0F
Data
0x00
0x20
0x00
0x10
0x00
0x50
0x00
0x20
0x00
0x70
0x00
0x20
0x00
0xD0
0x00
0x40
Attribute no.
Comments
1
Offset = 0020h
Size = 16 bytes
2
Offset = 0050h
Size = 32 bytes
3
Offset = 0070h
Size = 32 bytes
4
Offset = 00D0h
Size = 64 bytes
As shown in the table above, the attributes are numbered in the order they are mapped, i.e. it is
possible to rearrange the attribute numbering by physically changing the mapping order in the
mailbox data.
5. To save the new mailbox, select ‘Apply changes’ in the ‘File’-menu.
1. The offset is specified from the start of the parameter data, not from the physical memory location in the
Anybus Communicator.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Parameter Data Initialization (Explicit Data) 128
Resulting Attribute Mapping
Output Data
0x200
I/O Data (Output)
Parameter Data
Output Mapping Object
0x27F
0x280
Attributes:
#1 - Revision
(not mapped)
IO Size Out
(128 bytes)
Offset 0x0000h
16 bytes
Instance #1
(not mapped)
Attributes:
#1 - Data
#2 - Data
#3 - Data
#4 - Data
32 bytes
32 bytes
(not mapped)
64 bytes
(not mapped)
0x3FF
Offset 0x017Fh
Mailbox Editor Screenshot
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Appendix B
B. Connector Pin Assignments
B.1 Ethernet Connector
Pin
Signal
Housing
Cable Shield
1
TD+
2
TD-
3
RD+
4
Termination
5
Termination
6
RD-
7
Termination
8
Termination
1
8
B.2 Power Connector
Pin
Description
1
+24V DC
2
GND
1
2
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)
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Connector Pin Assignments 130
B.3 PC Connector
Configuration Cable Wiring
DP9F (PC)
RJ11 (ABC)
1
1
Ground
RS232 Rx
2
2
Ground
RS232 Tx
3
3
Rx
4
4
Tx
Ground
5
6
7
8
9
RJ11 (4P4C modular)1 : ABC
Pin
Description
1
Signal ground
2
3
RS232 Rx (Input)
4
RS232 Tx (Output)
4
3
2
1
DB9F : PC
Pin
Description
1
-
2
RS232 Rx (Input)
3
RS232 Tx (Output)
4
-
5
Signal Ground
6-9
-
5 (female) 1
9
6
1. The RJ11 (4P4C modular) is sometimes referred to as an RJ9.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Connector Pin Assignments 131
B.4 Sub-network Interface
B.4.1 General Information
The sub-network interface provides for RS232, RS422 and RS485 communications. Depending on the
configuration specified in the Anybus Configuration Manager, different signals are activated in the subnetwork connector.
B.4.2 Bias Resistors (RS485 Only)
When idle, RS485 enters an indeterminate state, which may cause the serial receivers to pick up noise
from the serial lines and interpret this as data. To prevent this, the serial lines should be forced into a
known state using pull-up and pull-down resistors, commonly known as bias resistors.
The bias resistors form a voltage divider, forcing the voltage between the differential pair to be higher
than the threshold for the serial receivers, typically >200mV.
Note that bias resistors shall only be installed on one node; installing bias resistors on several nodes may
compromise the signal quality on the network and cause transmission problems.
B.4.3 Termination (RS485 & RS422 Only)
To avoid reflections on the serial lines, it is important to properly terminate the sub-network by placing
termination resistors between the serial receivers near the end nodes.
The resistor value should ideally match the characteristic impedance of the cable, typically 100... 120R.
B.4.4 Connector Pinout (DB9F)
Pin
Description
RS232
RS422
RS485
1
2
+5V Output(100mA max)



RS232 Rx

3
RS232 Tx

4
(reserved)
RS485
5 (female) 1
a
5
Signal Ground
6
RS422 Rx +

7
RS422 Rx -

8
RS485 + /RS422 Tx+


9
RS485 - /RS422 Tx-


(housing)
Cable Shield






9
6
a. Connecting this signal directly to Protective Earth (PE) of other nodes may, in case of grounding loops etc., cause
damage to the on-board serial transceivers. It is therefore generally recommended to connect it only to Signal
Ground (if available) of other nodes.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Connector Pin Assignments 132
B.4.5 Typical Connection (RS485)
+5V
470R
RS485 +
RS485 +
120R
120R
RS485 -
RS485 470R
Signal
Ground
Signal
Ground
Node
RS485 +
RS485 -
Signal
Ground
Node
RS485 +
RS485 -
Signal
Ground
Node
RS485 +
RS485 -
Signal
Ground
Node
RS485 +
Anybus Communicator
RS485 -
Signal
Ground
Cable
Shield
End Node
B.4.6 Typical Connection (RS422 & 4-Wire RS485)
+5V
470R
RS422 Rx+
RS422 Tx+
120R
RS422 Rx-
RS422 Tx470R
470R
RS422 Tx+
RS422 Rx+
120R
RS422 Tx-
RS422 Rx470R
Signal
Ground
Signal
Ground
Cable
Shield
Anybus Communicator
Device
Note: Bias resistors are normally not needed on RS422, but may be required when using 4-wire RS485.
B.4.7 Typical Connection (RS232)
RS232 Tx
RS232 Rx
RS232 Rx
RS232 Tx
Signal
Ground
Signal
Ground
Cable
Shield
Anybus Communicator
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Device
Doc. ID: SCM-1200-096
Appendix C
C. Technical Specification
C.1 Mechanical Properties
Housing
Plastic housing with snap-on connection to DIN-rail, protection class IP20
Dimensions
120 mm x 75 mm x 27 mm, L x W x H (inches: 4.72” x 2.95” x 1.06”; L x W x H)
C.2 Electrical Characteristics
Power Supply
Power: 24V ± 10%
Power Consumption
Maximum power consumption is 280mA on 24V. Typically around 100mA
C.3 Environmental Characteristics
Relative Humidity
The product is designed for a relative humidity of 0 to 95% non-condensing
Temperature
Operating:
Non-operating:
±0°C to +55°C
-25°C to +85°C
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Technical Specification 134
C.4 Regulatory Compliance
EMC Compliance (CE)
This product is in accordance with the EMC directive 89/336/EEC, with amendments 92/31/EEC and
93/68/EEC through conformance with the following standards:
•
EN 50082-2 (1993)
EN 55011 (1990)Class A
•
EN 61000-6-2 (1999)
EN 61000-4-3 (1996)10V/m
EN 61000-4-6 (1996)10V/m(all ports)
EN 61000-4-2 (1995)±8kVAir Discharge
±4kVContact discharge
EN 61000-4-4 (1995)±2kVPower port
±1kVOther ports
EN 61000-4-5 (1995)±0.5kVPower ports (DM/CM)
±1kVSignal ports
UL/c-UL compliance
The certification has been documented by UL in file E214107.
Galvanic isolation on sub-network interface
•
EN 60950-1 (2001)
Pollution Degree 2
Material Group IIIb
250 VRMS or 250 VDCWorking voltage
500 VSecondary circuit transient rating
ODVA Compliance
This product works with EtherNet/IPTM
EtherNet/IP CONFORMANCE TESTED™ is a certification mark of ODVA.
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096
Appendix D
D. Troubleshooting
Problem
Solution
Problem during configuration Upload / Download.
•
Serial communication failed. Try again
•
The serial port may be in use by another application.
The Config Line “LED” turns red in the Anybus Configuration Manager.
The serial port seems to be available, but it is not possible
to connect to the gateway
Exit the Anybus Configuration Manager and close all
other applications including the ones in the system
tray.
Try again
•
Select another serial port
Try again
Poor performance
•
Right click ‘sub-network’ in the Navigation window and
select ‘sub-network Status’ to see status / diagnostic
information about the sub-network.
If the gateway reports very many retransmissions,
check your cabling and/or try a lower baud rate setting
for the sub-network (if possible).
•
Is the Subnet Monitor in the Anybus Configuration
Manager active?
The sub-network monitor has a negative influence on
the overall performance of the gateway, and should
only be used when necessary.
•
Is the Node Monitor in the Anybus Configuration Manager active?
The node monitor has a negative influence on the
overall performance of the gateway, and should only
be used when necessary.
No sub-network functionality
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
•
Use the ‘Data logger’-functionality to record the serial
data communication on the sub-network.
•
If no data is being transmitted, check the configuration
in Anybus Configuration Manager.
•
If no data is received, check the sub-network cables.
Also verify that the transmitted data is correct.
Doc. ID: SCM-1200-096
Appendix E
E. ASCII Table
x0
x1
x2
x3
x4
x5
x6
x7
x8
x9
xA
xB
xC
xD
xE
xF
BS
8
HT
9
LF
10
VT
11
FF
12
CR
13
SO
14
SI
15
FS
28
GS
29
RS
30
US
31
0x
NUL SOH STX ETX EOT ENQ ACK BEL
0
1
2
3
4
5
6
7
1x
DLE DC1 DC2 DC3 DC4 NAK SYN ETB CAN
16
17
18
19
20
21
22
23
24
EM
25
2x
(sp)
32
!
33
"
34
#
35
$
36
%
37
&
38
'
39
(
40
)
41
*
42
+
43
,
44
45
.
46
/
47
3x
0
48
1
49
2
50
3
51
4
52
5
53
6
54
7
55
8
56
9
57
:
58
;
59
<
60
=
61
>
62
?
63
4x
@
64
A
65
B
66
C
67
D
68
E
69
F
70
G
71
H
72
I
73
J
74
K
75
L
76
M
77
N
78
O
79
5x
P
80
Q
81
R
82
S
83
T
84
U
85
V
86
W
87
X
88
Y
89
Z
90
[
91
\
92
]
93
^
94
_
95
6x
`
96
a
97
b
98
c
99
d
100
e
101
f
102
g
103
h
104
i
105
j
106
k
107
l
108
m
109
n
110
o
111
7x
p
112
q
113
r
114
s
115
t
116
u
117
v
118
w
119
x
120
y
121
z
122
{
123
|
124
}
125
~
126
DEL
127
Anybus Communicator for EtherNet/IP
Doc.Rev. 4.00
SUB ESC
26
27
Doc. ID: SCM-1200-096
Appendix F
F. 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 Communicator for EtherNet/IP
Doc.Rev. 4.00
Doc. ID: SCM-1200-096