90-9118-ABIC-EIP 1 56 ROHS SCM 1200 055

90-9118-ABIC-EIP 1 56 ROHS SCM 1200 055
Fieldbus Appendix
Anybus-IC EtherNet/IP
Doc.Id. SCM-1200-055
Rev 1.56
HMS Industrial Networks AB

Germany + 49 - 721 - 96472 - 0
Japan
+ 81 - 45 - 478 -5340
Sweden
+ 46 - 35 - 17 29 20
U.S.A.
+ 1 - 312 - 829 - 0601
France
+ 33 - 3 89 32 76 76
Italy
+ 39 - 347 - 00894 - 70
China
+ 86 - 10 - 8532 - 3183

[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
Table of Contents
Table of Contents
Preface
About This Document
How To Use This Document............................................................................................................. P-1
Important User Information............................................................................................................... P-1
Related Documents.............................................................................................................................. P-2
Document History ............................................................................................................................... P-2
Conventions & Terminology .............................................................................................................. P-3
Support................................................................................................................................................... P-3
Chapter 1
About the Anybus-IC EtherNet/IP
General....................................................................................................................................................1-1
Features ...................................................................................................................................................1-1
Fieldbus Conformance Notes .............................................................................................................1-1
Chapter 2
Basic Operation
General Information .............................................................................................................................2-1
Software Requirements ..................................................................................................................2-1
Electronic Data Sheet (EDS) .......................................................................................................2-1
Device Identity.......................................................................................................................................2-1
General Parameters ...............................................................................................................................2-2
SCI WD Timeout (#24) .............................................................................................................2-2
Status Indicators (Fieldbus Specific Output) ....................................................................................2-3
General.........................................................................................................................................2-3
Compliance Notes .........................................................................................................................2-3
Switches (Fieldbus Specific Input)......................................................................................................2-4
General.........................................................................................................................................2-4
Compliance Notes .........................................................................................................................2-4
EtherNet/IP Implementation .............................................................................................................2-5
General.........................................................................................................................................2-5
Fieldbus I/O ................................................................................................................................2-5
Explicit Data (Application Parameters) .......................................................................................2-5
Modbus/TCP Implementation ...........................................................................................................2-6
General Information......................................................................................................................2-6
Supported Function Codes .............................................................................................................2-6
Supported Exception Codes...........................................................................................................2-6
Register Map.................................................................................................................................2-7
Filesystem ...............................................................................................................................................2-8
General Information......................................................................................................................2-8
Filesystem Overview.......................................................................................................................2-9
System Files ..................................................................................................................................2-9
Table of Contents II
Chapter 3
Network Configuration
Physical Link Settings ...........................................................................................................................3-1
TCP/IP Settings ....................................................................................................................................3-1
IP Access Control..................................................................................................................................3-2
On/Off Line Configuration ................................................................................................................3-2
Anybus IPconfig (HICP)......................................................................................................................3-3
ARP Gleaning ........................................................................................................................................3-3
Chapter 4
FTP Server
General....................................................................................................................................................4-1
FTP Connection Example (Windows Explorer)..............................................................................4-2
Chapter 5
Telnet Server
General....................................................................................................................................................5-1
General Commands ..............................................................................................................................5-2
Diagnostic Commands .........................................................................................................................5-3
File System Operations.........................................................................................................................5-3
Chapter 6
Web Server
General....................................................................................................................................................6-1
Authorization .........................................................................................................................................6-2
Content Types........................................................................................................................................6-3
Chapter 7
Email Client
General....................................................................................................................................................7-1
Event-Triggered Messages ...................................................................................................................7-1
Email Definitions ..................................................................................................................................7-2
Chapter 8
Server Side Include (SSI)
General Information .............................................................................................................................8-1
Functions ................................................................................................................................................8-2
Changing SSI output .............................................................................................................................8-9
SSI Output String File .................................................................................................................8-9
Temporary SSI Output change ....................................................................................................8-10
Table of Contents III
Chapter 9
CIP Object Implementation
General Information .............................................................................................................................9-1
Identity Object (01h).............................................................................................................................9-2
General Information......................................................................................................................9-2
Class Attributes............................................................................................................................9-2
Instance #1 Attributes .................................................................................................................9-2
Service Details: Reset Service .........................................................................................................9-3
Message Router (02h) ...........................................................................................................................9-4
General Information......................................................................................................................9-4
Class Attributes............................................................................................................................9-4
Instance Attributes........................................................................................................................9-4
Assembly Object (04h) .........................................................................................................................9-5
General Information......................................................................................................................9-5
Class Attributes............................................................................................................................9-5
Instance 64h Attributes (Producing Instance).................................................................................9-5
Instance 96h Attributes (Consuming Instance) ..............................................................................9-5
Instance C6h Attributes (Heartbeat, Input-Only) .........................................................................9-5
Instance C7h Attributes (Heartbeat, Listen-Only) ........................................................................9-5
Connection Manager (06h) ..................................................................................................................9-6
General Information......................................................................................................................9-6
Instance Descriptions .....................................................................................................................9-6
Class 1 Connection Details ...........................................................................................................9-6
Class 3 Connection Details ...........................................................................................................9-7
TCP/IP Interface Object (F5h) ..........................................................................................................9-8
General Information......................................................................................................................9-8
Class Attributes............................................................................................................................9-8
Instance Attributes........................................................................................................................9-9
Ethernet Link Object (F6h) ...............................................................................................................9-10
General Information....................................................................................................................9-10
Class Attributes..........................................................................................................................9-10
Instance Attributes......................................................................................................................9-10
Interface Flags.............................................................................................................................9-11
Vendor Specific Objects.....................................................................................................................9-12
Chapter 10 Fieldbus Interface
General..................................................................................................................................................10-1
Application Connector Signals ..........................................................................................................10-1
RJ45 Pinout ..........................................................................................................................................10-1
Typical Implementation......................................................................................................................10-2
FastJack Connectors ...........................................................................................................................10-2
Table of Contents IV
Chapter 11 Fieldbus Specific Parameters
General..................................................................................................................................................11-3
Serial Number (Parameter #141) ..............................................................................................11-3
FB Status (Parameter #100) .....................................................................................................11-3
MAC address (Parameter #116) ...............................................................................................11-4
DIP switch SSC (Parameter #104) ...........................................................................................11-4
Communication Settings ....................................................................................................................11-5
IP address cfg (Parameter #103) ................................................................................................11-5
IP address act (Parameter #105)................................................................................................11-5
Subnet mask cfg (Parameter #106) ............................................................................................11-5
Subnet mask act (Parameter #107)............................................................................................11-6
GW address cfg (Parameter #108) .............................................................................................11-6
GW address act (Parameter #109).............................................................................................11-6
DHCP enable cfg (Parameter #114)..........................................................................................11-7
DHCP enable act (Parameter #115) .........................................................................................11-7
Data rate cfg (Parameter #117) .................................................................................................11-8
Data rate act (Parameter #118).................................................................................................11-8
Duplex Cfg (Parameter #119) ...................................................................................................11-9
Duplex Act (Parameter #120)...................................................................................................11-9
HICP Enable (Parameter #136)............................................................................................ 11-10
HICP Password (Parameter #137)......................................................................................... 11-10
ARP Gleaning Enable (Parameter #144) .............................................................................. 11-10
Server Settings......................................................................................................................................11-1
Web Srv Enable (Parameter #121) ...........................................................................................11-1
FTP Srv Enable (Parameter #122)...........................................................................................11-1
Telnet Srv Enable (Parameter #123) .........................................................................................11-2
Email Client..........................................................................................................................................11-3
SMTP Srv Address (Parameter #126) ......................................................................................11-3
Triggered Emails (Parameter #127)...........................................................................................11-3
SMTP Errors (Parameter #128)...............................................................................................11-3
Send Email (Parameter #129)...................................................................................................11-4
SMTP User Name (Parameter #142).......................................................................................11-4
SMTP Password (Parameter #143)...........................................................................................11-4
File System............................................................................................................................................11-5
VFS Enable (Parameter #130) ................................................................................................11-5
RAM-Disc Path (Parameter #131)...........................................................................................11-5
Admin Mode Cfg (Parameter #124)..........................................................................................11-6
Admin Mode Act (Parameter #125) .........................................................................................11-6
Modbus/TCP.......................................................................................................................................11-7
MB/TCP Conn TO (Parameter #132) ....................................................................................11-7
MB/TCP Enable (Parameter #133) ........................................................................................11-7
In bit size (Parameter #134)......................................................................................................11-8
Out bit size (Parameter #135) ...................................................................................................11-8
On / Off line trg (Parameter #138)...........................................................................................11-8
On / Off line time (Parameter #139).........................................................................................11-9
On / Off line Cmds (Parameter #140) ......................................................................................11-9
EtherNet/IP...................................................................................................................................... 11-10
EIP Enb Cfg (Parameter #160)............................................................................................. 11-10
EIP Enb Act (Parameter #161) ............................................................................................ 11-10
EIP Strip Status (Parameter #162)........................................................................................ 11-11
FB Password (Parameter #102).............................................................................................. 11-12
EIP Vendor ID (Parameter #163) ........................................................................................ 11-12
EIP Device Type (Parameter #164)........................................................................................ 11-13
Table of Contents V
EIP Product Code (Parameter #165)...................................................................................... 11-13
EIP Revision (Parameter #166) ............................................................................................. 11-14
EIP Product Name (Parameter #167).................................................................................... 11-14
Application Parameters (Parameters #200... #299).................................................................... 11-15
Appendix A Application Parameters
General Information ............................................................................................................................A-1
Creating an Application Parameter....................................................................................................A-2
Query - “Application Parameter Object”......................................................................................A-2
Response - “Application Parameter Object”..................................................................................A-4
Example......................................................................................................................................A-5
Mapping an Application Parameter to CIP ......................................................................................A-6
Query - “CIP Mapping Object” ...................................................................................................A-6
Response - “CIP Mapping Object”...............................................................................................A-7
Example......................................................................................................................................A-7
Table of Contents VI
Appendix B HMS Object Implementation
General Information ............................................................................................................................ B-1
Application Parameter Object (Class 85h) .......................................................................................B-2
General Information..................................................................................................................... B-2
Class Attributes........................................................................................................................... B-2
Instance Attributes....................................................................................................................... B-2
Create (Class Service)................................................................................................................... B-3
File System Object (Class 86h)........................................................................................................... B-4
General Information..................................................................................................................... B-4
Class Attributes........................................................................................................................... B-4
Instance Attributes....................................................................................................................... B-4
File Open (Class Service) ............................................................................................................. B-5
File Close (Class Service) ............................................................................................................. B-5
File Delete (Class Service) ............................................................................................................ B-6
File Copy (Class Service).............................................................................................................. B-6
File Move (Class Service) ............................................................................................................. B-7
File Rename (Class Service) ......................................................................................................... B-7
File Read (Instance Service).......................................................................................................... B-8
File Write (Instance Service)......................................................................................................... B-8
CIP Mapping Object (Class A5h) ...................................................................................................... B-9
General Information..................................................................................................................... B-9
Class Attributes........................................................................................................................... B-9
Instance Attributes....................................................................................................................... B-9
Create (Class Service).................................................................................................................B-10
Socket Object (Class A6h) ................................................................................................................B-11
General Information...................................................................................................................B-11
Class Attributes.........................................................................................................................B-11
Instance Attributes.....................................................................................................................B-11
Create Socket (Class Service)......................................................................................................B-12
Close Socket (Class Service) .......................................................................................................B-12
Bind (Instance Service) ...............................................................................................................B-13
Listen (Instance Service) .............................................................................................................B-13
Accept (Instance Service).............................................................................................................B-14
Connect (Instance Service)...........................................................................................................B-14
Receive (Instance Service) ............................................................................................................B-15
Receive From (Instance Service)...................................................................................................B-15
Send (Instance Service) ...............................................................................................................B-16
Send To (Instance Service) ..........................................................................................................B-16
Socket Errors.............................................................................................................................B-17
Appendix C Firmware Upgrade
Appendix D Technical Specification
Electrical Specification........................................................................................................................ D-1
Protective Earth (PE) Requirements ........................................................................................... D-1
Power Supply .............................................................................................................................. D-1
Environmental Specification ............................................................................................................. D-1
EMC Compliance (CE) ...................................................................................................................... D-1
Preface
About This Document
How To Use This Document
This document is intended to be used as a supplement to the Anybus-IC Design Guide. The reader of
this document is expected to have basic knowledge in modern TCP/IP communications, and communication systems in general.
Please consult the general Anybus-IC Design Guide for further information about the Anybus-IC platform.
Important User Information
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 application meets all performance and safety requirements including any applicable laws, regulations, codes, and standards.
Anybus® is a registered trademark of HMS Industrial Networks AB. All other trademarks are the property of their respective holders.
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 cannot assume responsibility or liability for actual use based on these examples and illustrations.
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.
About This Document P-2
Related Documents
Document name
Anybus-IC Design Guide
Open Modbus/TCP Specification
RFC 821
RFC 1918
ENIP Specifications
-
Author
HMS
Schneider Automation
Network Working Group
Network Working Group
ControlNet International and ODVA
-
Document History
Summary of Recent Changes (v1.55... v1.56)
Change
Added General Parameter #24
Added Vendor ID information
Updated Create request and response services in the Application Parameter
Object
Corrected Fieldbus I/O section
Revision List
Revision
<=1.12
1.50
1.51
1.52
1.53
1.54
1.55
1.56
Date
2006-09-15
2007-01-09
2007-06-13
2007-12-14
2008-06-03
2008-11-07
2010-02-19
Author(s)
PeP
PeP
PeP
PeP
PeP
HeS
KeL
Chapter(s)
2
2, 8, 9
2
P, 9, D
1, 2, B
Description
(see previous releases)
Major rewrite
Minor updates
Corrected LED indications
Minor update
Minor update
Minor update
Minor update
Page(s)
2-2
1-1
B-3
2-5
About This Document P-3
Conventions & Terminology
The following conventions are used throughout this document:
•
Numbered lists provide sequential steps
•
Bulleted lists provide information, not procedural steps
•
The term ‘module’ is refers to the Anybus module
•
The term ‘application’ refers to the device connected to the Anybus application connector
•
Hexadecimal values are written in the format NNNNh, where NNNN is the hexadecimal value.
•
Binary values are written in the format NNNNb, where NNNN is the binary value.
•
16/32 bit values are written in big endian Motorola format
•
Floating point values are in the IEEE Standard 754 format
Support
HMS Sweden (Head Office)
E-mail:
Phone:
Fax:
Online:
[email protected]
+46 (0) 35 - 17 29 20
+46 (0) 35 - 17 29 09
www.anybus.com
HMS North America
E-mail:
Phone:
Toll Free:
Fax:
Online:
[email protected]
+1-312-829-0601
+1-888-8-Anybus
+1-312-738-5873
www.anybus.com
HMS Germany
E-mail:
Phone:
Fax:
Online:
[email protected]
+49-721-96472-0
+49-721-964-7210
www.anybus.com
HMS Japan
E-mail:
Phone:
Fax:
Online:
[email protected]
+81-45-478-5340
+81-45-476-0315
www.anybus.com
HMS China
E-mail:
Phone:
Online:
[email protected]
+86 10 8532 3023
www.anybus.com
About This Document P-4
HMS Italy
E-mail:
Phone:
Fax:
Online:
[email protected]
+39 039 59662 27
+39 039 59662 31
www.anybus.com
HMS France
E-mail:
Phone:
Fax:
Online:
[email protected]
+33 (0) 3 89 32 76 41
+33 (0) 3 89 32 76 31
www.anybus.com
Chapter 1
About the Anybus-IC EtherNet/IP
General
The Anybus-IC EtherNet/IP communication module provides instant integration in any ethernet based
lan via SMTP, FTP, Telnet, HTTP as well as EtherNet/IP and Modbus/TCP. Additional protocols can
be implemented on top of TCP/IP or UDP using the transparent socket interface.
The exchange of data can be monitored via the built in web server, Modbus/TCP, or using event triggered email messages. SSI (Sever Side Include) technology enables web pages and email messages to carry dynamic content such as I/O data, configuration settings etc.
Features
•
10 and 100mbit operation, Full and Half Duplex
•
Up to 144 bytes of fieldbus I/O in each direction
•
Adapter Clarr Functionality (EtherNet/IP)
•
UCMM Capable, up to 5 explicit server connections
•
Modbus/TCP server
•
Built-in file system
•
Security framework
•
Web server
•
Email client
•
FTP server
•
Telnet server
•
Server Side Include (SSI) capability
•
Device identity customization
•
Transparent socket interface
•
Application Parameters (used for Explicit Messaging)
Fieldbus Conformance Notes
•
The Anybus-IC EtherNet has been tested standalone by ODVA’s authorized Independent Test
Lab and found to comply with ODVA Conformance Test Software Version A12. However, in
accordance with ODVA’s conformance test policy, the final product must still be compliance
tested to ensure fieldbus conformance. In order to be able to do this, the vendor information in
the EtherNet/IP Host Object must be customized.
•
It is strongly recommended to customize the information in the Identity Object (CIP), to enable
the product to appear as a vendor specific implementation rather than a generic Anybus module.
ODVA requires that all manufacturers use their own Vendor ID. A Vendor ID can be applied
for from ODVA.
For more information, please contact HMS Industrial Networks or the ODVA.
Chapter 2
Basic Operation
General Information
Software Requirements
Generally, no network-specific support code needs to be written in order to support the Anybus-IC EtherNet/IP. Optionally, advanced fieldbus functionality can be enabled using fieldbus-specific parameters.
Electronic Data Sheet (EDS)
On EtherNet/IP, the characteristics of a device is stored in an ASCII data file with the suffix ‘EDS’.
This file is used by EtherNet/IP, configuration tools etc. when setting up the network.
HMS provides a generic EDS-file, which corresponds to the default settings in the module. However,
due to the flexible nature of the Anybus concept, it is possible to alter the behaviour of the product in
ways that invalidates the generic EDS-file.
See also...
•
1-1 “Fieldbus Conformance Notes”
Device Identity
On EtherNet/IP, the module identifies itself as follows:
Information
Vendor ID
Device Type
Product Code
Revision
Product Name
Default Value
005Ah
000Ch
0002h
‘Anybus-IC EtherNet/IP’
Comments
(HMS Industrial Networks)
(Communications Adapter)
(Anybus-IC)
(reflects Anybus-IC product revision)
-
The information above can be customized. Note that in such case, the EDS-file needs to be altered as
well. Note that the identity information is protected by a password to prevent unintentional changes.
This password can be obtained by contacting HMS.
Note: These settings are stored in non-volatile memory and will not be affected by a reset or a ‘Set Defaults’-operation unless the correct password has been supplied using parameter #102 (‘FB Password’).
See also...
•
11-12 “FB Password (Parameter #102)”
•
11-12 “EIP Vendor ID (Parameter #163)”
•
11-13 “EIP Device Type (Parameter #164)”
•
11-13 “EIP Product Code (Parameter #165)”
•
11-14 “EIP Revision (Parameter #166)”
•
11-14 “EIP Product Name (Parameter #167)”
Basic Operation 2-2
General Parameters
The general parameters are used to configure the basic settings of the module. Most of these parameters
are common to all Anybus-IC modules, and are described in the Anybus-IC Design Guide. The parameter described here, is only applicable to the Anybus IC EIP. For all other general parameters, please
consult the Anybus-IC Design Guide.
SCI WD Timeout (#24)
This parameter is used to disable / enable the SCI channel watchdog timeout functionality.
Enable by writing a non-zero value between 1-65535. The value will be the watchdog timeout in milliseconds.
•
The setting will be saved in NVS memory and remembered after a power-cycle.
•
The initial watchdog will start after the first correctly received SCI Modbus request.
•
Writing 0 to the WD parameter will disable the watchdog at once.
•
If a watchdog timeout has occurred a power-cycle/module restart is required to recover.
Parameter number
Modbus Address
Default value
Range
Size
Stored in NV RAM
Access
24
0x601F
0x0000
0x0000 - 0xFFFF
1 byte
Yes
R/W
Basic Operation 2-3
Status Indicators (Fieldbus Specific Output)
General
The Anybus-IC EtherNet/IP uses bi-coloured status indications as follows:
Bit
0
1
2
3
4
5
6
7
Activates Colour
Green
Red
Green
Red
Green
Red
Green
Red
LED
Link/Activity
Comments
Data Rate
Module Status Network Status -
The standard indications are as follows:
LED
Link/Activity
State
Off
Green
Green, flashing
Alternating Red/Green
Data Rate
Off
Green
Alternating Red/Green
Module Status Off
Green
Green, flashing
Red
Red, flashing
Alternating Red/Green
Network Status Off
Green
Green, flashing
Red
Red, flashing
Alternating Red/Green
Status
Device not powered
Module connected to an Ethernet network
RX / TX Activity
Self test in progress
10 Mbps operation
100 Mbps operation
Self test in progress
Device not powered
Device has an EtherNet/IP connection
Device has no EtherNet/IP connection
Major fault (unrecoverable)
Minor fault (recoverable)
Self test in progress
No power or no IP address
EtherNet/IP connection(s) established
No EtherNet/IP connections established
Duplicate IP address detected
One or several EtherNet/IP connections has timed out
Self test in progress
Note: To comply with EtherNet/IP interoperability guidelines, the LED indications has changed slightly from that of software revision 1.05. For further information, contact HMS.
See also...
•
Anybus-IC Design Guide (parameter #7 ‘LED State’)
Compliance Notes
The following points should be kept in mind when designing for EtherNet/IP compliance.
•
Module Status LED must be labelled ‘Module Status’ or ‘MS’
•
Network Status LED must be labelled ‘Network Status’ or ‘NS’
Basic Operation 2-4
Switches (Fieldbus Specific Input)
General
The Fieldbus Specific Input is used for fieldbus-specific configuration settings and supports two types
of switches/coding.
•
BCD-coded Switches
Two switches are used to specify the last byte of the IP address, one for each decimal digit. Subnet mask and gateway address is fixed to the values below.
Switch A (x10)
0
0
0
0
...
9
9
•
Switch B (x1)
0
1
2
3
...
8
9
IP Address
(set by software)
192.168.1.1
192.168.1.2
192.168.1.3
...
192.168.1.98
192.168.1.99
Subnet Mask
(set by software)
255.255.255.0
255.255.255.0
255.255.255.0
...
255.255.255.0
255.255.255.0
Default Gateway
(set by software)
0.0.0.0
0.0.0.0
0.0.0.0
...
0.0.0.0
0.0.0.0
Binary Switches
This type of switch allows a greater address range compared to BCD-coded switches. Subnet
mask and gateway address is fixed to the values below.
b7
0
0
0
0
...
1
1
b6
0
0
0
0
...
1
1
b5
0
0
0
0
...
1
1
b4
0
0
0
0
...
1
1
b3
0
0
0
0
...
1
1
b2
0
0
0
0
...
1
1
b1
0
0
1
1
...
1
1
b0
0
1
0
1
...
0
1
IP Address
(set by software)
192.168.1.1
192.168.1.2
192.168.1.3
...
192.168.1.254
(invalid setting)
Subnet Mask
(set by software)
255.255.255.0
255.255.255.0
255.255.255.0
...
255.255.255.0
-
Default Gateway
(set by software)
0.0.0.0
0.0.0.0
0.0.0.0
...
0.0.0.0
-
Note: The type of switch used is specified in parameter #9 (‘Switch Coding’). On the Anybus-IC EtherNet/IP, the default value for this parameter is 01h (Binary Switches). However, since this is fieldbus
dependant, there is no guarantee that the same type of switch is used by default on other networks.
See also...
•
Anybus-IC Design Guide (parameter #9 ‘Switch Coding’)
•
3-1 “Network Configuration”
•
11-5 “Communication Settings”
Compliance Notes
The following issues should be kept in mind when designing for EtherNet/IP compliance.
•
Switches should be placed so that the most significant digit is located to the left or to the top of
the product.
Basic Operation 2-5
EtherNet/IP Implementation
General
EtherNet/IP is based on the Common Industrial Protocol (CIP) which is also the application layer for
DeviceNet and ControlNet. The module acts as an Adapter Class product on the EtherNet/IP network.
See also...
•
9-1 “CIP Object Implementation”
•
11-10 “EtherNet/IP”
Fieldbus I/O
On EtherNet/IP, the fieldbus I/O is represented through dedicated instances in the Assembly Object.
The module supports Class 1 connections with Cyclic and Change of State production triggers.
See also...
•
9-5 “Assembly Object (04h)”
•
9-6 “Connection Manager (06h)”
Explicit Data (Application Parameters)
Explicit Data is exchanged by means of vendor specific objects mapped to Application Parameters.
See also...
•
9-12 “Vendor Specific Objects”
•
A-1 “Application Parameters”
•
B-1 “HMS Object Implementation”
Basic Operation 2-6
Modbus/TCP Implementation
General Information
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 fieldbus I/O via a subset of the functions defined in the Modbus/TCP specification. Up to 8 simultaneous Modbus/TCP connections are
supported.
Modbus/TCP messages are exchanged through TCP port no. 502. For detailed information regarding
the Modbus/TCP protocol, consult the Open Modbus Specification.
Supported Function Codes
The following function codes are implemented:
Modbus Function
Read Coil
Read Input Discretes
Read Multiple 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...
Output Data (FB Out)
Input Data (FB In)
Output Data (FB Out)
Input Data (FB In)
Output Data (FB Out)
Supported Exception Codes
Code
0x01
0x02
0x03
Name
Illegal function
Illegal data address
Illegal data value
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
Basic Operation 2-7
Register Map
Fieldbus Input Data (FB In)
The Input Data is mapped to Coils & Registers as follows:
Register #
0001 (0513)
0002 (0514)
0003 (0515)
0004 (0516)
...
0071 (0583)
0072 (0584)
Input Data (FB In) location
000h + Coil Size In
002h + Coil Size In
004h + Coil Size In
006h + Coil Size In
...
08Ch + Coil Size In
08Eh + Coil Size In
Comments
Each register corresponds to two bytes of data.
Note: A mirror of the Input Data is available at register 513... 584 to allow efficient I/O scanning by
means of Read/Write Registers (function code 13)
Coil #
0001... 0008
0009... 0016
0017... 0024
0025... 0032
...
1137... 1144
1145... 1152
Input Data (FB In) location
000h
001h
002h
003h
...
08Eh
08Fh
Comments
Each coil corresponds a single bit of data.
Note: Coils are mapped MSB first, i.e. coil #1 corresponds to the most significant bit of byte 000h
Fieldbus Output Data (FB Out)
The Output Data is mapped to Coils & Registers as follows:
Register #
0001
0002
0003
0004
...
0071
0072
Output Data (FB Out) location
000h + Coil Size Out
002h + Coil Size Out
004h + Coil Size Out
006h + Coil Size Out
...
08Ch + Coil Size In
08Eh + Coil Size In
Comments
Each register corresponds to two bytes of data.
Coil #
0001... 0008
0009... 0016
0017... 0024
0025... 0032
...
1137... 1144
1145... 1152
Output Data (FB Out) location
000h
001h
002h
003h
...
08Eh
08Fh
Comments
Each coil corresponds a single bit of data
Note: Coils are mapped MSB first, i.e. coil #1 corresponds to the most significant bit of byte 000h
Basic Operation 2-8
Filesystem
General Information
The module features a built in filesystem, which is used to store information such as web files, network
communication settings, email messages etc.
The filesystem can be accessed using FTP, HTTP and Telnet.
Storage
The filesystem features two storage areas:
•
Non-volatile area (approx. 1Mb)
This section is intended for static files such as web files, configuration files etc.
•
Volatile area (approx. 1Mb)
This area is intended for temporary storage; data placed here will be lost in case of power loss or
reset. Note that this area is not available by default, and must be mounted by the application during initialisation (see 11-5 “RAM-Disc Path (Parameter #131)”)
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 must not contain one of 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: The non-volatile storage is located in FLASH memory. Each FLASH segment can only be erased
approximately 1000000 times due to the nature of this type of memory.
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 filesystem
Basic Operation 2-9
Filesystem Overview
(admin root)
(user root)
user
ssi_str.cfg
http.cfg
telwel.cfg
pswd
ip_accs.cfg
(protected)
sys_pswd.cfg
RAM
(volatile, optional)
email
email_1.cfg
pswd
(protected)
.
.
.
email_10.cfg
ad_pswd.cfg
email
email_1.cfg
.
.
.
email_10.cfg
System Files
The filesystem contains a set of files used for system configuration. These files, known as “system files”,
are regular ASCII files which 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 Anybus module itself,
e.g. when using SSI (see 8-1 “Server Side Include (SSI)”).
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.
Chapter 3
Network Configuration
Physical Link Settings
By default, the module uses auto-negotiation to establish the physical link settings. Optionally, it is possible to force a particular settings using parameters #117 and #119.
See also...
•
11-8 “Data rate cfg (Parameter #117)”
•
11-9 “Duplex Cfg (Parameter #119)”
TCP/IP Settings
The module offers three modes of operation regarding the TCP/IP settings:
•
Settings specified by Switches (Fieldbus Specific Input)
The module will use the switch setting if the NA-bit (Parameter #8 ‘Configuration Bits’) is
cleared (0) and the switches are set to a value other than zero (0).
In such case, the module will use the following settings:
IP Address:
Gateway:
Subnet:
DHCP:
192.168.0.x
0.0.0.0
255.255.255.0
OFF
(x = switch value)
(no gateway)
See also...
- Anybus-IC Design Guide (Parameter #8 ‘Configuration Bits’)
- 2-4 “Switches (Fieldbus Specific Input)”
•
Settings specified by Parameters
The module will use the settings stored in the IP configuration parameters if the NA-bit (Parameter #8 ‘Configuration Bits’) is set (1) and/or the switches on the fieldbus specific input register
is set to zero.
If no current settings are available (i.e. the IP configuration parameter contains invalid settings),
the module will halt and indicate an error on the on-board status LEDs (the settings may
however still be altered via HICP or ARP gleaning).
See also...
- Anybus-IC Design Guide (Parameter #8 ‘Configuration Bits’)
- 3-3 “Anybus IPconfig (HICP)”
- 3-3 “ARP Gleaning”
- 11-5 “Communication Settings”
•
Settings specified by network
The IP configuration can be altered via EtherNet/IP via the TCP/IP Interface Object.
See also...
- Anybus-IC Design Guide (Parameter #8 ‘Configuration Bits’)
- 9-8 “TCP/IP Interface Object (F5h)”
Network Configuration 3-2
IP Access Control
It is possible to specify which IP addresses that are permitted to connect to the module. 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 module via Modbus/TCP
[EtherNet/IP]
xxx.xxx.xxx.xxx
•
Nodes listed here may access the module via EtherNet/IP
[All]
xxx.xxx.xxx.xxx
•
Fallback setting, used by the module when one or several of the
keys above are omitted
Note: ‘*’ may be used as a wildcard to select IP series.
On/Off Line Configuration
By default, the On/Off Line indication is triggered by the Link Status. Other triggering options can however be specified in the system file ‘\onoffln.cfg’, which looks as follows:
•
File Format:
[ON/OFF-line trigger]
Modbus
[Timeout]
10
[Commands]
3, 16, 23
ON/OFF-line trigger
Values: ‘Link’, ‘EIP’ and ‘Modbus’
•
Timeout
Value: Timeout value. A value of 10 equals 1000ms.
•
Commands (Optional)
Selects what Modbus commands that must be
received during the timeout period.
If the keyword ‘ALL’ is given, the ON/OFF line
functionality will trigger on all Modbus commands.
The keys ‘[Timeout]’ and ‘[Commands]’ shall only given if the ON/OFF-line Trigger value is set
to ‘Modbus’.
Note: The settings in this file will be ignored when using parameters #138... 149
See also...
•
11-8 “On / Off line trg (Parameter #138)”
•
11-9 “On / Off line time (Parameter #139)”
•
11-9 “On / Off line Cmds (Parameter #140)”
Network Configuration 3-3
Anybus IPconfig (HICP)
The module 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 corresponding parameters.
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 module will appear as ‘ABICEIP’. 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’.
ARP Gleaning
The module supports the Address Resolution Protocol (ARP), allowing the TCP/IP settings to be altered using the ARP-command on a PC.
Syntax:
arp -s <IP address> <MAC address>
ping <IP address>
arp -d <IP address>
The ‘arp -s’ command stores the IP and MAC address in the PCs ARP-table. When the ‘ping’-command
is issued, the PC will address the module with the new IP address; the module recognizes that it was
addressed with the correct MAC address and adopts the new IP address from the ‘ping’ message.
If successful, new settings will be stored as follows:
IP Address:
Gateway:
Subnet:
DHCP:
xxx.xxx.xxx.xxx
0.0.0.0
255.255.255.0
OFF
(value supplied in ARP command)
(no gateway)
Note: This functionality may cause problems if multiple devices continuously issue ‘ping’-messages towards the module. The reason for this lies in the very nature of this functionality; since the module
adopts the IP address from all ‘ping’-messages, any additional ‘ping’-messages may cause it to change
back and forth between old and new settings.
See also...
•
11-10 “ARP Gleaning Enable (Parameter #144)”
Chapter 4
FTP Server
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)
See also...
•
11-1 “FTP Srv Enable (Parameter #122)”
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, or if running in Global Admin Mode, the module
will grant Admin-level access to all users. In such case, 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.
See also...
•
5-1 “Telnet Server”
•
11-6 “Admin Mode Cfg (Parameter #124)”
•
11-6 “Admin Mode Act (Parameter #125)”
FTP Server 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 module
- Substitute <user> with the username
- Substitute <password> with the password
3. Press enter. The Explorer will now attempt to connect to the module using the specified settings.
If successful, the built in file system is displayed in the Explorer window.
Chapter 5
Telnet Server
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.
See also...
•
11-2 “Telnet Srv Enable (Parameter #123)”
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,
or if running in Global Admin Mode startup, the module will grant Admin-level access to all users. In
such case, no login is required, and the root directory will be ‘\’.
See also...
•
4-1 “User Accounts”
•
11-6 “Admin Mode Cfg (Parameter #124)”
•
11-6 “Admin Mode Act (Parameter #125)”
Welcome Message
The default telnet welcome message can be customized by adding the file ‘\telwel.cfg’. This file shall
contain the desired message in pure ASCII format.
Telnet Server 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 module.
Telnet Server 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
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.
Telnet Server 5-4
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 command may only be executed by admin level users.
Telnet Server 5-5
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.
Chapter 6
Web Server
General
The Anybus module 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...
•
11-1 “Web Srv Enable (Parameter #121)”
Protected Files
For security reasons, the following files are protected from web access:
•
Files located in ‘\user\pswd’
•
Files located in ‘\pswd’
•
Files located in a directory which contains a file named ‘web_accs.cfg’
Default Web Pages
The Anybus module contains a set of virtual files that 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 that case the link
shall point to ‘\config.htm’.
These virtual files are:
\index.shtm
\config.htm
\configform.shtm
\store.shtm
\logo.jpg
\configuration.gif
\border_bg.gif
\border_m_bg.gif
-
includes the content of config.htm
Configuration frame page
Configuration form page
Configuration store page
HMS logo
Configuration picture
Picture forming a border
Picture forming a border
Note: The virtual file system can be disabled using parameter #130.
See also...
•
11-5 “VFS Enable (Parameter #130)”
Web Server 6-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 6-1 “Protected Files”.
Web Server 6-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.
Chapter 7
Email Client
General
The built-in email client can send predefined email messages when instructed to do so or based on trigger-events in the fieldbus I/O data.
The client supports SSI; note however that certain SSI-functions cannot be used in email messages (this
is specified separately for each SSI-function).
Note: This functionality requires a valid SMTP-server configuration. It is currently not possible to use
servers which require authentication.
See also...
•
7-2 “Email Definitions”
•
8-1 “Server Side Include (SSI)”
•
11-3 “SMTP Srv Address (Parameter #126)”
•
11-3 “SMTP Errors (Parameter #128)”
•
11-4 “Send Email (Parameter #129)”
Event-Triggered Messages
The email client can issue predefined messages based on events in the fieldbus I/O data. The fieldbus
I/O is scanned once every 0.5 seconds, which means that an event must be present for at least 0.5 seconds to ensure detection by the Anybus module.
In operation, this works as follows:
1. The trigger source is fetched from the fieldbus I/O data
2. A logical AND is performed between the trigger source and a mask value
3. The result is compared to a reference value according to a specified operand
4. If the end result is true, the email is sent to the specified recipient(s).
See also...
•
7-2 “Email Definitions”
•
11-3 “Triggered Emails (Parameter #127)”
Email Client 7-2
Email Definitions
The email 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.
Email definition files must be named ‘email_1.cfg’, ‘email_2.cfg’... ‘email_10.cfg’ in order to be properly
recognized by the module.
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
Setting
Area
Offset
Type
Value
Mask
Operand
To
From
Subject
Headers
Message
Value
Scanned for SSI
Source area in DPRAM. Possible values are ‘IN’ or ‘OUT’
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 ‘>’
Email recipient
Yes
Sender email address
Email 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 module.
Chapter 8
Server Side Include (SSI)
General Information
Server Side Include functionality (from now on referred to as SSI) allows data in files and objects to be
represented on web pages and in email 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 of the specified operation (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 IP address of the module:
<HTML>
<HEAD><TITLE>SSI Test</TITLE></HEAD>
<BODY>
The IP address of the Anybus module is:
<?--#exec cmd_argument=’DisplayIP’-->
</BODY>
</HTML>
Resulting webpage:
The IP address of the Anybus module is: 192.168.1.125
Server Side Include (SSI) 8-2
Functions
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’-->
DisplayDhcpState
This function returns whether DHCP/BootP is enabled or disabled.
Syntax:
<?--#exec cmd_argument=’DisplayDhcpState( "Output when ON", "Output when OFF"
)’-->
DisplayEmailServer
This function returns the currently used SMTP server address.
Syntax:
<?--#exec cmd_argument=’DisplayEmailServer’-->
Server Side Include (SSI) 8-3
StoreEtnConfig
Note: This function cannot be used in email messages.
This function stores a passed IP configuration in the corresponding parameters.
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
SetSMTPServer
SetDhcpState- (value “on” or “off”)
Default output:
Invalid IP address!
Invalid Subnet mask!
Invalid Gateway address!
Invalid IP address or Subnet mask!
Invalid Email Server address!
Invalid DHCP state!
Configuration stored correctly.
Failed to store configuration.
GetText
Note: This function cannot be used in email messages.
This function retrieves the text from an object and stores it in a specified parameter or in the fieldbus
out area.
Syntax:
<?--#exec cmd_argument=’GetText( "ObjName", argument, N)’-->
ObjName
argument
n
- Name of object.
- (see below)
- Number of characters to process (Optional)
Argument
OutWriteString(offset)
ParWriteString(prm)
ParWriteFormatted(prm)
Description
Writes the data to position offset in the fieldbus out area
Writes the data to parameter prm. Requires parameter to be a string.
Writes the data to parameter prm. Parses and converts the data according to the
parameter data type (i.e. integer, string etc.).
Default output:
Success
Failure
- Write succeeded
- Write failed
Server Side Include (SSI) 8-4
printf
This function returns a formatted string, which may contain parameter value and/or data from the fieldbus in/out area. The formatting of the string is similar 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.
Server Side Include (SSI) 8-5
The conversion characters and their meanings are shown below. If the character after the % is not a conversion character, the behaviour is undefined.
Character(s)
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)
ParReadSByte(par)
ParReadUByte(par)
ParReadSWord(par)
ParReadUWord(par)
ParReadSLong(par)
ParReadULong(par)
ParReadString(par)
ParReadFloat(par)
ParReadFormatted(par)
Description
Read a signed byte from position offset in the fieldbus IN area
Read an unsigned byte from position offset in the fieldbus IN area
Read a signed word from position offset in the fieldbus IN area
Read an unsigned word from position offset in the fieldbus IN area
Read a signed longword from position offset in the fieldbus IN area
Read an unsigned longword from position offset in the fieldbus IN area
Read a string (char*) from position offset in the fieldbus IN area
Read a floating point (float) value from position offset in the fieldbus IN area
Read a signed byte from position offset in the fieldbus OUT area
Read an unsigned byte from position offset in the fieldbus OUT area
Read a signed word (short) from position offset in the fieldbus OUT area
Read an unsigned word (short) from position offset in the fieldbus OUT area
Read a signed longword (long) from position offset in the fieldbus OUT area
Read an unsigned longword (long) from position offset in the fieldbus OUT area
Read a null-terminated string from position offset in the fieldbus OUT area
Read a floating point (float) value from position offset in the fieldbus OUT area
Reads parameter par and returns it as a signed byte
Reads parameter par and returns it as an unsigned byte
Reads parameter par and returns it as a signed word
Reads parameter par and returns it as an unsigned word
Reads parameter par and returns it as a signed longword
Reads parameter par and returns it as an unsigned longword
Reads parameter par and returns it as a string
Reads parameter par and returns it as a float
Reads parameter par, interprets it and returns it as a formatted string.
Server Side Include (SSI) 8-6
scanf
Note: This function cannot be used in email messages.
This SSI function reads a string passed from an object in a HTML form, interprets the string according
to the specification 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(s)
d
i
Input, Argument Type
Decimal number; byte, short
Number, byte, short. The number may be in octal (leading 0(zero)) or hexadecimal
(leading 0x or 0X)
Octal number (with or without leading zero); byte, short
Unsinged decimal number; unsigned byte, unsigned short
Hexadecimal number (with or without leading 0x or 0X); byte, short
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.
Character string (not quoted); char*, pointing to an array of characters large enough
for the string and a terminating "\0" that will be added.
Floating-point number with optional sign, optional decimal point and optional exponent; float*
Liteal %; no assignment is made.
o
u
x
c
s
e, f, g
%
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’
The arguments that can be passed to the SSI function scanf are:
Argument
OutWriteByte(offset)
OutWriteWord(offset)
OutWriteLong(offset)
OutWriteString(offset)
OutWriteFloat(offset)
ParWriteByte(par)
ParWriteWord(par)
ParWriteLong(par)
ParWriteString(par)
ParWriteFloat(par)
ParWriteFloat(par)
ParWriteFormatted(par)
Default output:
Write succeeded
Write failed
Description
Write a byte to position offset in the fieldbus OUT area
Write a word to position offset in the fieldbus OUT area
Write a long to position offset in the fieldbus OUT area
Write a string to position offset in the fieldbus OUT area
Write a floating point value to position offset in the fieldbus OUT area
Writes a byte to parameter par
Writes a word to parameter par
Writes a longword to parameter par
Writes a string to parameter par
Writes a float to parameter par
Writes a float to parameter par
Writes a formatted value to parameter par
Server Side Include (SSI) 8-7
IncludeFile
This function includes the contents of a file.
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 email 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
- Form saved to file
- Failed to save form
GetConfigItem
This function returns the value of a specific key in a configuration file. The format of the file must be
as follows:
[key1]
Value1
[key2]
Value2
...
[keyN]
ValueN
Syntax:
<?--#exec cmd_argument='GetConfigItem( "file", "key", "separator" )'-->
file
key
separator
- File to read from
- Key to read value from
- Optional; specifies line-separator (‘CRLF’ (default), ‘LF’ or ‘CR’)
Default output:
Success
Failure
- (Value associated with the specified key)
- Could not get value for [key]
For information about how to change the SSI output, please see 8-9 “Changing
SSI output”.
Server Side Include (SSI) 8-8
SetConfig
This function stores a passed HTML-form as a configuration file. The field name will be used as key,
and the field value will be stored as the value to that key. If the passed key (field name) isn’t present in
the file, it will be added. If the specified file does not exist, it will be created.
Field names beginning with underscore (‘_’) will be excluded.
Syntax:
<?--#exec cmd_argument='SetConfig( "File name" )'-->
Default output:
Success – Configuration stored to “File name”
Failure – Could not store configuration to “File name”
For information about how to change the SSI output, please see 8-9 “Changing SSI output”.
Example:
An HTML-form with the following fields...
• Name = “Speed”, value = “48”
• Name = “Temp”, value = “20”
• Name = “_B1”, value = “submit”
(Button used to submit the form, not stored.)
... generates a file with the following format:
[Speed]
48
[Temp]
20
Server Side Include (SSI) 8-9
Changing SSI output
There is 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 using SsiOutput()
SSI Output String File
If the file "\ssi_str.cfg" is found in the file system and the file is correctly 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
Server Side Include (SSI) 8-10
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) )’-->
Chapter 9
CIP Object Implementation
General Information
This chapter specifies the CIP-object implementation in the module. These objects can be accessed
from the network, but not directly by the host application.
Mandatory Objects:
•
9-2 “Identity Object (01h)”
•
9-4 “Message Router (02h)”
•
9-5 “Assembly Object (04h)”
•
9-6 “Connection Manager (06h)”
•
9-8 “TCP/IP Interface Object (F5h)”
•
9-10 “Ethernet Link Object (F6h)”
Vendor Specific Objects:
•
9-12 “Vendor Specific Objects”
CIP Object Implementation 9-2
Identity Object (01h)
General Information
Object Description
Supported Services
Class:
Get_Attribute_Single
Instance:
Get_Attribute_Single
Get_Attributes_All
Reset
Class Attributes
#
1
Name
Revision
Access
Get
Type
UINT
Value
0001h (Object revision)
Instance #1 Attributes
#
1
Name
Vendor ID
Access
Get
Type
UINT
005Ah (HMS Industrial Networks AB)a
2
Device Type
Get
UINT
000Ch (Communication Adapter)a
3
Product Code
Get
UINT
4
Revision
Get
0002h (Anybus-IC Ethernet/IP)a
Major and minor firmware revision
5
6
7
Status
Serial Number
Product Name
Get
Get
Get
Struct of:
{USINT, USINT}
WORD
See 9-3 “Device Status”
UDINT
Unique serial number (assigned by HMS)
SHORT_STRING “Anybus-IC EtherNet/IP” (Name of product)a
a. Can be customized, see 11-10 “EtherNet/IP”
Value
CIP Object Implementation 9-3
Device Status
bit(s)
0
1
2
3
4... 7
8
9
10
11
12... 15
Name
Module Owned
(reserved)
Configured (always set (1) in this implementation)
(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)
Service Details: Reset Service
The module can forward reset requests from the network to the application as interrupts. For more information about network reset handling, consult the general Anybus-IC Design Guide.
There are two types of network reset requests on EtherNet/IP:
•
Type 0: ‘Power Cycling Reset’
By default, the module performs a reset of the module. Optionally, the module can issue an interrupt to the application, which in turn is responsible for resetting itself and the Anybus module.
See also...
- Anybus-IC Design Guide (Parameter #12 ‘Interrupt Config’, ‘RES’-bit)
•
Type 1: ‘Out of box reset’
By default, the module resets the parameters below to their default values and resets itself.
- 11-5 “IP address cfg (Parameter #103)”
- 11-5 “Subnet mask cfg (Parameter #106)”
- 11-6 “GW address cfg (Parameter #108)”
- 11-7 “DHCP enable cfg (Parameter #114)”
- 11-8 “Data rate cfg (Parameter #117)”
- 11-9 “Duplex Cfg (Parameter #119)”
- 11-3 “SMTP Srv Address (Parameter #126)”
If the ‘DEF’-bit (Parameter #12, bit 4) is set, the module will issue an interrupt to the application.
The interrupt cause register will indicate ‘Set Default’ as cause. The application is then responsible for resetting configuration settings before resetting itself and the module.
If the ‘RES’-bit (Parameter #12, bit 5) is set, the module will issue an interrupt to the application.
The interrupt cause register will indicate ‘Reset’ as cause. The application is then responsible for
resetting itself and the module.
See also...
- Anybus-IC Design Guide (Parameter #12 ‘Interrupt Config’, ‘RES’ and ‘DES’-bits)
CIP Object Implementation 9-4
Message Router (02h)
General Information
Object Description
Supported Services
Class:
-
Instance:
-
Class Attributes
-
Instance Attributes
-
CIP Object Implementation 9-5
Assembly Object (04h)
General Information
Object Description
The Assembly Object uses static assemblies and holds the fieldbus I/O data. The assembly instance IDs
used are in the vendor specific range.
See also...
•
2-5 “EtherNet/IP Implementation”
Supported Services
Class:
Get_Attribute_Single
Instance:
Get_Attribute_Single
Set_Attribute_Single
Class Attributes
#
1
2
Name
Revision
Max Instance
Access
Get
Get
Type
UINT
UINT
Value
0002h
0096h
Instance 64h Attributes (Producing Instance)
#
3
Name
Produced Data
Access
Get
Type
Array of BYTE
Value
Data corresponds to fieldbus input data (FB IN)
Instance 96h Attributes (Consuming Instance)
#
3
Name
Consumed Data
Access
Set
Type
Array of BYTE
Value
Data corresponds to fieldbus output data (FB OUT)
Instance C6h Attributes (Heartbeat, Input-Only)
This instance is used as heartbeat for Input-Only connections, and does not carry any attributes. The
data size of the Heartbeat instance in the Forward_Open-request should be 0 bytes, however other values are also permitted.
Instance C7h Attributes (Heartbeat, Listen-Only)
This instance is used as heartbeat for listen-only connections, and does not carry any attributes. The data
size of the Heartbeat instance in the Forward_Open-request should be 0 bytes, however other values are
also permitted.
CIP Object Implementation 9-6
Connection Manager (06h)
General Information
Object Description
Supported Services
Class:
-
Instance:
Forward_Open
Forward_Close
Instance Descriptions
(No supported instance attributes)
Class 1 Connection Details
General
Class 1 connections are used to transfer I/O data, and can be established to instances in the Assembly
Object. Each Class 1 connection will establish two data transports; one consuming and one producing.
The heartbeat instances can be used for connections that shall only access inputs.
Class 1 connections use UDP transport.
•
Total number of supported class 1 connections:
20
•
Supported transports:
1
•
Max input connection size:
144 bytes
•
Max output connection size:
144 bytes
•
Supported API:
10... 3200ms
•
T->O Connection type:
Point-to-point, Multicast
•
O->T Connection type:
Point-to-point
•
Supported trigger type:
Cyclic/Change of state1
1. Only applicable from firmware revision 2.01-...
CIP Object Implementation 9-7
Connection Types
•
Exclusive-Owner connection
This type of connection controls the outputs of the Anybus module and does not depend on other connections.
•
- Max. no. of Exclusive-Owner connections:
1
- Connection point O  T:
Assembly Object, instance 64h (Default)
- Connection point T O:
Assembly Object, instance 96h (Default)
Input-Only connection
This type of connection is used to read data from the Anybus module without controlling the
outputs. It does not depend on other connections.
- Max. no. of Input-Only connections:
Up to 41
- Connection point O T:
Assembly Object, instance 03h (Default)
- Connection point T O:
Assembly Object, instance 96h (Default)
Note: If an Exclusive-Owner connection has been opened towards the module and times out,
the Input-Only connection times out as well. If the Exclusive-Owner connection is properly
closed, the Input-Only connection remains unaffected.
•
Listen-Only connection
This type of connection requires another connection in order to exist. If that connection (Exclusive-Owner or Input-Only) is closed, the Listen-Only connection will be closed as well.
•
- Max. no. of Input-Only connections:
Up to 42
- Connection point O T:
Assembly Object, instance 04h (Default)
- Connection point T O:
Assembly Object, instance 96h (Default)
Redundant-Owner connection
This connection type is not supported by the module.
Class 3 Connection Details
•
Explicit message connection
Class 3 connections are used to establish connections towards the message router. Thereafter,
the connection is used for explicit messaging.
Class 3 connections use TCP transport.
- No. of simultaneous Class 3 connections:
16
- Supported API:
2ms
- T->O Connection type:
Point-to-point
- O->T Connection type:
Point-to-point
- Supported trigger type:
Application
1. Shared with Exclusive-Owner and Listen-Only connections
2. Shared with Exclusive-Owner and Input-Only connections
CIP Object Implementation 9-8
TCP/IP Interface Object (F5h)
General Information
Object Description
The object groups TCP/IP-related settings.
See also...
•
2-4 “Switches (Fieldbus Specific Input)”
•
3-1 “TCP/IP Settings”
Supported Services
Class services:
Get_Attribute_All
Get_Attribute_Single
Instance services:
Get_Attribute_All
Get_Attribute_Single
Set_Attribute_Single
Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0002h
Description
Revision 2
CIP Object Implementation 9-9
Instance Attributes
#
1
2
Access
Get
Get
3
Get/Set
4
Get
5
6
Get/Set
Get/Set
8a Get/Set
9a Get/Set
Name
Status
Configuration
Capability
Configuration
Control
Type
DWORD
DWORD
Value
0000 0001h
0000 0014h
DWORD
-
Physical Link
Object
Path Size
Path
Interface Configuration
IP Address
Network Mask
Gateway
Address
Name Server 1
Name Server 2
Domain Name
Host Name
TTL value
Struct of:
-
Comments
Attribute #1 contains valid information.
Capable of obtaining network configuration via
DHCP. Configuration settable.
Value: Meaning:
0
Configuration from non-volatile memory
2
Configuration from DHCP
Physical Link => Ethernet object
UINT
Padded EPATH
Struct of:
0002h
20 F6 24 01h
2 words
Path to Ethernet Link Object, Instance 1
UDINT
UDINT
UDINT
-
Corresponds to IP address act (Parameter #105)
Corresponds to Subnet mask act (Parameter #107)
Corresponds to GW address act (Parameter #109)
UDINT
UDINT
STRING
STRING
USINT
0000 0000h
0000 0000h
00h
00h
1
TTL value for EIP multicast packets
Mcast Config
Alloc Control
Struct of:
USINT
0
IP multicast address configuration
0 - Use default allocation algorithm to generate
multicast addresses.
1
Shall be 0
Number of multicast addresses to allocate for EtherNet/IP.
1 - Multicast
addresses shall
be allocated
according to the
values in Num
Mcast and
Mcast Start
Addr.
Reserved
USINT
Num Mcast
UINT
a. Only applicable from firmware revision 2.01-...
CIP Object Implementation 9-10
Ethernet Link Object (F6h)
General Information
Object Description
This object groups information for the physical link.
See also...
•
3-1 “Physical Link Settings”
•
11-5 “Communication Settings”
Supported Services
Class services:
Get_Attribute_All
Get_Attribute_Single
Instance services:
Get_Attribute_All
Get_Attribute_Single
Class Attributes
#
1
Access
Get
Name
Revision
Type
UINT
Value
0002h
Comments
Revision 2
Type
UDINT
DWORD
Array of 6 USINTS
Struct:
WORD
UINT
Value
10 or 100
(MAC ID)
Comments
Actual ethernet interface speed
See 9-11 “Interface Flags”
Physical network address
-
Interface control bits
Speed at which the interface shall be forced to
operate. Returns ‘Object state Conflict’ if autonegotiation is enabled.
Instance Attributes
#
1
2
3
6
Access
Get
Get
Get
Get/Set
Name
Interface Speed
Interface Flags
Physical Address
Interface Control
Control Bits
Forced Interface
Speed
CIP Object Implementation 9-11
Interface Flags
Bit
0
Name
Link status
Description
Indicates whether or not the Ethernet 802.3 communications interface is connected to an active network.
Value: Meaning:
0
Inactive link
1
Active link
1
Half/full duplex
Indicates the duplex mode currently in use.
Value: Meaning:
0
Half duplex
1
Full duplex
2 - 4 Negotiation Status
Indicates the status of link auto-negotiation
Value: Meaning:
0
Auto-negotiation in progress.
1
Auto-negotiation and speed detection failed (using default values)
2
Auto negotiation failed but detected speed (using default duplex value)
3
Successfully negotiated speed and duplex.
4
Auto-negotiation not attempted. Forced speed and duplex.
5
Manual Setting requires Reset Value: Meaning:
0
Interface can activate changes to link parameters during runtime
1
Reset is required in order for changes to have effect
6
Local Hardware Fault
Value: Meaning:
0
No local hardware fault detected
1
Local hardware fault detected
(ignore)
7-31 (reserved)
CIP Object Implementation 9-12
Vendor Specific Objects
It is possible to create application-specific parameters and map them to a Vendor Specific CIP Class,
Instance and Attribute.
See also...
•
11-15 “Application Parameters (Parameters #200... #299)”
•
A-1 “Application Parameters”
Chapter 10
Fieldbus Interface
General
The physical interface requires an external isolation transformer with the following characteristics:
Turns Ratio (TX)
1CT:1CT
Turns Ratio (RX)
1CT:1CT
Common Mode Rejection (0 - 30Mhz)
-40db (-59dB recommended for EtherNet/IP conformance)
The PCB is part of the physical layer in that the characteristics of the traces and materials control impedance, capacitance, coupling and voltage withstand. This means that the PCB layout is a key factor
when it comes to reducing noise ingress and emissions.
To ensure proper operation, make sure to fulfil the following recommendations:
•
Earth ground planes and power planes must be properly defined and isolated
•
Traces between connector and transformer must be short and equal in length
•
Traces between transformer and application interface must be short and equal in length
•
Traces must match the circuit impedance (100 Ohms) using micro strip layout techniques
Suggested reading:
•
“General Recommendations for EtherNet/IP Developers” (ODVA)
•
“Successfully Designing EtherNet/IP Devices for Harsh Areas” (Rockwell Automation)
Application Connector Signals
Pin
13
14
15
16
19
20
Pin name
FB1
FB2
FB3
FB4
FB5
FB6
Signal
TX+
TXRX+
RXCT (RX)
CT (TX)
RJ45 Pinout
Ethernet Connector (RJ45)
Pin
Signal
1
TX+
2
TX3
RX+
4
5
6
RX7
8
Housing
Cable Shield
Anybus
Pin
-
Signal
-
1
8
Fieldbus Interface 10-2
Typical Implementation
The following example uses the PULSE H1112. Other isolation transformers which conform to the
characteristics described earlier may also be used, but may require a slightly different circuit connection
than the one illustrated below.
RJ45, Shielded
1
12 TX+
TD+
TX-
TD-
TCT
TDC
11
10
8
PULSE H1112
RCT
RDC
8 RC+
RD+
RC-
RD-
9
7
R1
C2
R2
R3
C1
Ref.
R1, R2, R3, R4
R5
C1, C2
PULSE H1112
RJ45, Shielded
13
2
14
3
20
4
19
5
15
6
16
R4
1+9
(Isolation)
R5
1
Component
75 ohm
1M ohm
1nF/2kV
PULSE H1112
RJ45 connector
24 + 32
TX+
TXCT (TX)
CT (RX)
RX+
RX-
VCC
GND
Comments
Network termination
Filter to PE
Filter capacitors to PE
-
FastJack Connectors
FastJack connectors feature built-in isolation transformers and cable shield filters, which makes them
suitable for applications where limited space is an issue.
To comply with modern EMC directives, this type of connector requires the use of shielded cables. Also
note that this type of connector is generally not recommended for EtherNet/IP applications.
(Isolation)
RJ45, "Fast jack"
13
1
14
15
8
20
19
16
1+9
24 + 32
Ref.
RJ45, Fast Jack
Component
HFJ11-2450E
TX+
TXRX+
CT (TX)
CT (RX)
RX-
VCC
GND
Comments
FastJack (HALO electronics Inc.)
Chapter 11
Fieldbus Specific Parameters
General
#
141
100
102
116
104
R/W
R
RW
W
R
R
Name
Serial number
FB status
FB Password
MAC address
DIP switch SSC
Size
4 byte
2 byte
2 byte
6 byte
1 byte
Default Value
N/A
N/A
N/A
N/A
N/A
Modbus Address
H’704D
H’7000
H’7003
H’701B - H’701D
H’7006
HOS Object
Device Object (0x80)
Fieldbus Object (0xA0)
Size
4 byte
4 byte
4 byte
4 byte
4 byte
4 byte
1 byte
1 byte
1 byte
1 byte
1 byte
1byte
1 byte
30 byte
Default Value
0.0.0.0
N/A
0.0.0.0
N/A
0.0.0.0
N/A
0x01
N/A
0x00
N/A
0x00
N/A
0x01
-
Modbus Address HOS Object
H’7004 – H’7005 Fieldbus Object (0xA0)
H’7007 - H’7008
H’7009 - H’700A
H’700B - H’700C
H’700D - H’700E
H’700F - H’7010
H’7019
H’701A
H’701E
H’701F
H’7020
H’7021
H’7039
H’703A-H’7048
Name
Web srv enable
FTP srv enable
Telnet enable
Size
1 byte
1 byte
1 byte
Default Value
0x01
0x01
0x01
Modbus Address HOS Object
H’7022
Fieldbus Object (0xA0)
H’7023
H’7024
Name
SMTP srv address
Trigged emails
SMTP errors
Send email
Size
4 byte
2 byte
2 byte
2 byte
Default Value
0.0.0.0
N/A
N/A
0x0000
Modbus Address HOS Object
H’7027 - H’7028 Fieldbus Object (0xA0)
H’7029
H’702A
H’702B
SSC Object (0xA2)
Network Configuration
#
103
105
106
107
108
109
114
115
117
118
119
120
136
137
R/W
RW
R
RW
R
RW
R
RW
R
RW
R
RW
R
RW
RW
Name
IP address cfg
IP address act
Subnet mask cfg
Subnet mask act
GW address cfg
GW address act
DHCP enable cfg
DHCP enable act
Data rate cfg
Data rate act
Duplex cfg
Duplex act
HICP enable
HICP password
Server Settings
#
121
122
123
R/W
RW
RW
RW
Email Client
#
126
127
128
129
R/W
RW
R
R
W
Fieldbus Specific Parameters 11-2
File System
#
124
125
130
131
R/W
RW
RW
RW
RW
Name
Admin mode cfg
Admin mode act
VFS enable
RAM disc path
Size
1 byte
1 byte
1 byte
16 byte
Default Value
0x00
N/A
0x01
“\RAM”
Modbus Address HOS Object
H’7025
Fieldbus Object (0xA0)
H’7026
H’702C
H’702D-H’7034
Modbus/TCP & EtherNet/IP Related Parameters
#
132
133
134
135
139
140
138
160
R/W
RW
RW
RW
RW
RW
RW
RW
RW
Name
MB/TCP conn TO
MB/TCP enable
In bit size
Out bit size
On/Off line time
On/Off line cmds
On/Off line trg
161
R
162
163
RW
R(W)
EIP enable act
EIP strip status
164
R(W)
165
R(W)
166
R(W)
167
R(W)
EIP enable cfg
Size
2 byte
1 byte
2 byte
2 byte
1 byte
4 byte
1 byte
1 byte
Default Value
60
0x01
0x30
0x30
0x0A
0xFFFFFFFF
0x01
0x01
Modbus Address Object
H’7035
Fieldbus Object (0xA0)
H’7036
H’7037
H’7038
H’704A
H’704B- H’704C
H’7049
H’7100
1 byte
N/A
H’7101
EIP vendor ID
1 byte
2 byte
1
0x005A
H’7102
H’7103
EIP device type
2 byte
0x000C
H’7104
EIP product code
2 byte
0x0002
H’7105
EIP revision
2 byte
N/A
H’7106
EIP product name
33 byte
-
H’7107 – H’7117
Application Parameters
#
200
R/W Name
a
Application Parameter #1
Size
Default Value
a
a
201
a
Application Parameter #2
a
a
Modbus Address Object
H’8000
Application Parameter
Object (0x85)
a
...
a
Application Parameter #3-99 a
a
a
299
a
Application Parameter #100
a
a
a. Parameter Dependant
a
11-3
General
Serial Number (Parameter #141)
This parameter holds the production serial number of the module.
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Serial Number’
141
704Dh
0h... FFFFFFFFh
4 bytes
No
RW
FB Status (Parameter #100)
This parameter holds returns information about the current network status.
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘FB Status’
100
7000h
0000h... FFFFh
2 bytes
No
R
Bit layout
b15
•
b14
b13 b12
(reserved)
b11
b10
b9
b8
IDLE BUS
BUS
1: Bus is on line
0: Bus is off line
•
IDLE
1: Scanner is in idle / program mode
0: Scanner is in run mode’
b7
b6
b5
b4
b3
(reserved)
b2
b1
b0
11-4
MAC address (Parameter #116)
This parameter holds the ethernet MAC address of the module.
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘MAC address’
116
701Bh... 701Dh
6 bytes
No
R
DIP switch SSC (Parameter #104)
This parameter holds the auto configured fieldbus node address from Fieldbus Specific Input register
on the SSC interface. Note that in order for this value to be valid, the ‘NA’-bit (parameter #8 ‘Configuration Bits’) must be cleared (0).
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘DIP switch SSC’
104
7006h
0h... FFh
1 byte
No
R
11-5
Communication Settings
IP address cfg (Parameter #103)
This parameter holds the manually configured IP address.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘IP address cfg’
103
7004h... 7005h
0.0.0.0
0.0.0.0... 255.255.255.255
4 bytes
No
RW
IP address act (Parameter #105)
This parameter holds the actual IP address.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘IP address act’
105
7007h... 7008h
0.0.0.0... 255.255.255.255
4 bytes
No
R
Subnet mask cfg (Parameter #106)
With this parameter it is possible to configure the Subnet mask.
Note: The module must be restarted in order for changes to have effect.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Subnet mask cfgt’
106
7009h... 700Ah
0.0.0.0... 255.255.255.255
4 bytes
No
RW
11-6
Subnet mask act (Parameter #107)
This parameter holds the currently used Subnet mask.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Subnet mask act’
107
700Bh... 700Ch
0.0.0.0... 255.255.255.255
4 bytes
No
R
GW address cfg (Parameter #108)
With this parameter it is possible to configure the Gateway address.
Note: The module must be restarted in order for changes to have effect.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘GW address cfg’
108
700Dh... 700Eh
0.0.0.0... 255.255.255.255
4 bytes
No
RW
GW address act (Parameter #109)
This parameter holds the currently used Gateway address.
Note: The module must be restarted in order for changes to have effect.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘GW address act’
109
700Fh... 7010h
0.0.0.0... 255.255.255.255
4 bytes
No
R
11-7
DHCP enable cfg (Parameter #114)
This parameter enables/disables DHCP support.
Note: The module must be restarted in order for changes to have effect.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘GW address act’
114
7019h
1
0: Disable
1: Enable
1 bytes
No
RW
DHCP enable act (Parameter #115)
This parameter holds the current DHCP state.
See also...
•
3-1 “TCP/IP Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘DHCP enable act’
115
701Ah
0: Disabled
1: Enabled
1 byte
No
R
11-8
Data rate cfg (Parameter #117)
This parameter specifies the data rate for the physical link.
Note: The module must be restarted in order for changes to have effect.
See also...
•
3-1 “Physical Link Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Data rate cfg’
117
701Eh
0
0: Auto Negotiate
1: 10Mbps
2: 100Mbps)
1 bytes
No
RW
Data rate act (Parameter #118)
This parameter holds the currently used data rate of the physical link.
See also...
•
3-1 “Physical Link Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Data rate cftt’
118
701Fh
1: 10Mbps
2: 100Mbps
1 bytes
No
R
11-9
Duplex Cfg (Parameter #119)
This parameter specifies the duplex mode for the physical link.
Note: The module must be restarted for changes to have effect.
See also...
•
3-1 “Physical Link Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Duplex Cfgt’
119
7020h
0
0: Auto Negotiate
1: Half Duplex
2: Full Duplex
1 byte
No
RW
Duplex Act (Parameter #120)
This parameter holds the currently used duplex mode of the physical link.
See also...
•
3-1 “Physical Link Settings”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Duplex Act’
120
7021h
1: Half Duplex
2: Full Duplex
1 byte
No
R
11-10
HICP Enable (Parameter #136)
This parameter enables/disables support for the Anybus IPconfig (HICP) protocol.
See also...
•
3-3 “Anybus IPconfig (HICP)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘HICP Enable’
136
7039h
1
0: Disable
1: Enable
1 byte
No
RW
HICP Password (Parameter #137)
The Anybus-IPconfig (HICP) protocol allows the IP configuration to be protected from unauthorized
changes via a password, which can be specified through this parameter.
See also...
•
3-3 “Anybus IPconfig (HICP)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘HICP Password’
137
703Ah... 7048h
30 bytes
No
RW
ARP Gleaning Enable (Parameter #144)
See also...
•
3-1 “Network Configuration”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘HICP Password’
144
706Fh
1
0: Disable
1: Enable
1 byte
No
RW
11-1
Server Settings
Web Srv Enable (Parameter #121)
This parameter enables/disables the built-in web server.
See also...
•
6-1 “Web Server”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Web Srv Enable’
121
7022h
1
0: Disable
1: Enable
1 byte
No
RW
FTP Srv Enable (Parameter #122)
This parameter enables/disables the built-in FTP server.
See also...
•
4-1 “FTP Server”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘FTP Srv Enable’
122
7023h
1
0: Disable
1: Enable
1 byte
No
RW
11-2
Telnet Srv Enable (Parameter #123)
This parameter enables/disables the built-in Telnet server.
See also...
•
5-1 “Telnet Server”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Telnet Srv Enable’
123
7024h
1
0: Disable
1: Enable
1 byte
No
RW
11-3
Email Client
SMTP Srv Address (Parameter #126)
With this parameter it is possible to configure the SMTP server address.
See also...
•
7-1 “Email Client”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘SMTP Srv Address’
126
7027h... 7028h
0.0.0.0
0.0.0.0... 255.255.255.255
4 bytes
No
RW
Triggered Emails (Parameter #127)
This parameter indicates how many email trigger events that has been detected by the module.
See also...
•
7-1 “Email Client”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Triggered Emails’
127
7029h
0000h
0000h... FFFFh
2 bytes
No
R
SMTP Errors (Parameter #128)
This parameter indicates how many emails that the module failed to send to the SMTP server.
See also...
•
7-1 “Email Client”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Triggered Emails’
128
702Ah
0000h
0000h... FFFFh
2 bytes
No
R
11-4
Send Email (Parameter #129)
This parameter is sends a predefined email stored in the file system.
The MSB in the data word determines the email type (0: Admin, 1: Normal), and the LSB specifies the
number of the message.
Example:
The value 0004h issues Admin email no. #4, and 010Ah issues Normal user email no. #10.
See also...
•
7-1 “Email Client”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Send Email’
129
702Bh
0000h
0000h... 010Ah
2 bytes
No
W
SMTP User Name (Parameter #142)
See also...
•
7-1 “Email Client”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘SMTP User Name’
142
704Fh... 705Eh
““
String, NULL-terminated
Up to 32 bytes, including NULL-termination
No
RW
SMTP Password (Parameter #143)
See also...
•
7-1 “Email Client”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘SMTP Password’
143
705Fh... 706E
““
String, NULL-terminated
Up to 32 bytes, including NULL-termination
No
RW
11-5
File System
VFS Enable (Parameter #130)
This parameter enables/disables the virtual file system (VFS).
See also...
•
6-1 “Default Web Pages”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘VFS Enable’
130
702Ch
1
0: Disable
1: Enable
2 bytes
No
RW
RAM-Disc Path (Parameter #131)
This parameter specifies where to mount the volatile part of the file system (i.e. the RAM disc). The specified directory must be empty or non-existing; an empty value (““) disables the RAM-disc.
See also...
•
2-8 “Filesystem”
•
2-8 “Storage”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘RAM Disc Path’
131
702Dh... 7034h
“\RAM”
String, null terminated
Up to 16 bytes (null termination included)
No
RW
11-6
Admin Mode Cfg (Parameter #124)
This parameter enables/disabled Global Admin Mode.
Note: The module must be restarted for changes to have effect.
See also...
•
4-1 “FTP Server” (4-1 “Security Levels”, 4-1 “User Accounts”)
•
5-1 “Telnet Server” (5-1 “Security Levels”, 5-1 “User Accounts”)
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Admin Mode Cfg’
124
7025h
0
0: Disable Global Admin Mode
1: Enable Global Admin Mode
1 byte
No
RW
Admin Mode Act (Parameter #125)
This parameter indicates whether the module is operating in Global Admin Mode or not.
See also...
•
4-1 “FTP Server” (4-1 “Security Levels”, 4-1 “User Accounts”)
•
5-1 “Telnet Server” (5-1 “Security Levels”, 5-1 “User Accounts”)
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Admin Mode Act’
125
7026h
0: Disabled
1: Enabled
1 byte
No
RW
11-7
Modbus/TCP
MB/TCP Conn TO (Parameter #132)
This parameter specifies the Modbus/TCP connection timeout in seconds. If no Modbus/TCP query
has been received within the specified time period, the Modbus/TCP connection will be closed.
See also...
•
.2-6 “Modbus/TCP Implementation”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘MB/TCP Conn TO’
132
7035h
60
0... 65535 (0 = Timeout disabled)
2 bytes
No
RW
MB/TCP Enable (Parameter #133)
This parameter enables/disables support for the Modbus/TCP protocol.
See also...
•
.2-6 “Modbus/TCP Implementation”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘MB/TCP Enable’
133
7036h
1
0: Disable
1: Enable
1 byte
No
RW
11-8
In bit size (Parameter #134)
This parameter specifies how many bytes of the fieldbus input data that shall be represented as coils/
discretes. The remainder will be represented as registers.
See also...
•
.2-6 “Modbus/TCP Implementation” (2-7 “Fieldbus Input Data (FB In)”)
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘In bit size’
134
7037h
0000h
0000h... 0030h
2 bytes
No
RW
Out bit size (Parameter #135)
This parameter specifies how many bytes of the fieldbus output data that shall be represented as coils/
discretes. The remainder will be represented as registers.
See also...
•
.2-6 “Modbus/TCP Implementation” (2-7 “Fieldbus Output Data (FB Out)”)
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘Out bit size’
135
7038h
0000h
0000h... 0030h
2 byte
No
RW
On / Off line trg (Parameter #138)
This parameter specifies the trigger source for on/off line events.
See also...
•
11-9 “On / Off line time (Parameter #139)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘On / Off line trg’
138
7049h
1
0: None
1: Link
2: Modbus/TCP
3: EtherNet/IP
1 bytes
No
RW
11-9
On / Off line time (Parameter #139)
If the On/Off line trigger source (Parameter #138) is set to Modbus/TCP, this parameter specifies the
maximum allowed time between Modbus/TCP commands; if this time is exceeded, the module triggers
an off line event. The time is set in steps of 100ms (10 = 1000ms)
Note: This parameter has no effect if the On/Off line trigger source isn’t set to Modbus/TCP
See also...
•
11-8 “On / Off line trg (Parameter #138)”
•
11-9 “On / Off line Cmds (Parameter #140)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘On / Off line time’
139
704Ah
10 (1 second)
1... 255
1 byte
No
704Ah
On / Off line Cmds (Parameter #140)
If the On / Off line trigger source (#138) is set to Modbus/TCP, this parameter specifies which Modbus
commands that shall trigger an on-line event. The parameter value represents a bit field where each bit
specifies if a particular Modbus/TCP command shall trigger the on-line event or not.
Note: This parameter has no effect if the On/Off line trigger source isn’t set to Modbus/TCP
See also...
•
11-8 “On / Off line trg (Parameter #138)”
•
11-9 “On / Off line time (Parameter #139)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
•
‘On / Off line Cmds’
140
704Bh... 704Ch
FFFFFFFFh
Bit field, 32 bits
4 bytes
No
RW
Value
Each bit in the value represents a Modbus/TCP function code, see below.
b31 b30 b29
FC32 FC31 FC30
...
...
b11 b10 b9
b8
b7
b6
b5
b4
b3 b2
b1
b0
FC12 FC11 FC10 FC9 FC8 FC7 FC6 FC5 FC4 FC3 FC2 FC1
FCxx = Modbus/TCP function code xx
11-10
EtherNet/IP
EIP Enb Cfg (Parameter #160)
This parameter enables/disables support for the EtherNet/IP protocol.
Note: The module must be restarted for changes to have effect.
See also...
•
2-5 “EtherNet/IP Implementation”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Enb Cfg’
160
7100h
1
0: Disable
1: Enable
1 byte
No
RW
EIP Enb Act (Parameter #161)
This parameter indicates whether support for the EtherNet/IP protocol is enabled or disabled.
See also...
•
2-5 “EtherNet/IP Implementation”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Enb Act’
161
7101h
0: Disabled
1: Enabled
1 byte
No
R
11-11
EIP Strip Status (Parameter #162)
This parameter specifies how the first four bytes of a consumed EtherNet/IP connection shall be treated by the module.
See also...
•
11-3 “FB Status (Parameter #100)”
•
9-1 “CIP Object Implementation” (9-5 “Assembly Object (04h)”)
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Strip Status’
162
7102h
1
0: Don’t strip status data
1: Strip status data; FB Status (Parameter #100) reflects the master’s run/idle mode.
1 byte
No
RW
11-12
FB Password (Parameter #102)
This parameter grants write access to the following parameters provided that a valid password is supplied:
•
EIP Vendor ID (Parameter #163)
•
EIP Device Type (Parameter #164)
•
EIP Product Code (Parameter #165)
•
EIP Revision (Parameter #166)
•
EIP Product Name (Parameter #167)
(The password can be obtained by contacting HMS)
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘FB Password’
102
7003
0000h... FFFFh
2 bytes
No
W
EIP Vendor ID (Parameter #163)
This parameter holds the EtherNet/IP Vendor ID.
See also...
•
2-1 “Device Identity”
•
9-2 “Identity Object (01h)”
•
11-12 “FB Password (Parameter #102)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Vendor ID’
163
7103h
005Ah (HMS Networks AB)
0000h... FFFFh
2 byte
No
R(W)
11-13
EIP Device Type (Parameter #164)
This parameter holds the EtherNet/IP Device Type.
See also...
•
2-1 “Device Identity”
•
9-2 “Identity Object (01h)”
•
11-12 “FB Password (Parameter #102)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Device Type’
164
7104h
000Ch (Communication Adapter)
0000h... FFFFh
2 byte
No
R(W)
EIP Product Code (Parameter #165)
This parameter holds the EtherNet/IP Product Code.
See also...
•
2-1 “Device Identity”
•
9-2 “Identity Object (01h)”
•
11-12 “FB Password (Parameter #102)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Product Code’
165
7105h
0002h (Anybus-IC)
0000h... FFFFh
2 byte
No
R(W)
11-14
EIP Revision (Parameter #166)
This parameter holds the EtherNet/IP Revision.
See also...
•
2-1 “Device Identity”
•
9-2 “Identity Object (01h)”
•
11-12 “FB Password (Parameter #102)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Product Code’
166
7106h
Anybus-IC Product Revision
0000h... FFFFh
2 byte
No
R(W)
EIP Product Name (Parameter #167)
This parameter holds the EtherNet/IP Product Name.
See also...
•
2-1 “Device Identity”
•
9-2 “Identity Object (01h)”
•
11-12 “FB Password (Parameter #102)”
Parameter Name
Parameter no.
Modbus Address
Default Value
Range
Size
Stored in NV RAM
Access
‘EIP Product Name’
167
7107h... 7116h
‘Anybus-IC EtherNet/IP’
String, null terminated
32 byte (null termination included)
No
R(W)
11-15
Application Parameters (Parameters #200... #299)
See also...
•
9-12 “Vendor Specific Objects”
•
A-1 “Application Parameters”
Appendix A
Application Parameters
General Information
An Application Parameter is an application-specific parameter created by the application during startup.
Application Parameters works just like normal parameters and can be accessed via the MIF and SCI interfaces. In addition, Application Parameters can be accessed from the network by mapping them to CIP
objects.
See also...
•
9-1 “CIP Object Implementation” (9-12 “Vendor Specific Objects”)
•
A-2 “Creating an Application Parameter”
•
A-6 “Mapping an Application Parameter to CIP”
•
B-1 “HMS Object Implementation”
Application Parameters A-2
Creating an Application Parameter
Query - “Application Parameter Object”
To create a new Application Parameter, send the following message using Modbus Object Messaging.
(Consult the Anybus-IC Design Guide for more information about the Object Message Sub Field)
Object Message Sub Field.
Fragment
byte count
(size)
Fragment
protocol
02h
Parameter Size
(WORD)
Class ID
Instance ID
Service Code
Attribute
Data Field
0085h
0000h
0005h
0000h
(See below)
Descriptor
(DWORD)
Parameter Info
(Size varies)
Extension Word
(Optional, WORD)
Parameter Size
This value depends on the type of data specified in the Descriptor (see below).
Data Type
UINT, INT, BITSTRING
FLOAT
STRING
BYTE_ARRAY
Valid Parameter Size values
1, 2, 4
4
1... 32 (String length including NULL termination)
1... 1024
Descriptor1
b15
b14
b13 b12
(reserved)
b11
b10
b9
Data Format
b8
b7
b6
Data Type
b5
b4
b3
b2
(reserved)
b1
b0
Write Read
Write
0
1
Meaning
Write access not allowed
Write access allowed
Read
0
1
Meaning
Read access not allowed
Read access allowed
Data Type
0 (0000)
1 (0001)
2 (0010)
3 (0011)
4 (0100)
5 (0101)
Meaning
UINT
INT
BITSTRING
STRING
FLOAT
BYTE ARRAY
Data Format
0 (00)
1 (01)
2 (10)
3 (11)
Meaning
Dec.
Hex
Bin
Dotted decimal
1. Note that the upper 16 bits of the Descriptor are reserved for future use and must be set to 0000h.
Application Parameters A-3
Parameter Info
The size and contents of this field depends on the Data Type specified in the Descriptor block.
•
Data types UINT, INT, BITSTRING & FLOAT
Min Value
(size varies)
Max Value
(size varies)
Init Value
(size varies)
Namea
(String, 16 bytes)
Unita
(String, 16 bytes)
Field
Min. Value
Max. Value
Init Value
Type / Size
Specified in ‘Parameter Size’
Specified in ‘Parameter Size’
Specified in ‘Parameter Size’
Description
Minimum allowed parameter value
Maximal allowed parameter value
Initial parameter value
Name
String (16 byte, null terminated)
Name of parameter, e.g “Speed”a
Unit
String (16 byte, null terminated)
Unit, e.g “RPM”a
a. These fields are optional. (However, if used, both fields must be present)
•
Data type STRING
Namea
(STRING, 16 bytes)
Init Value
(size varies)
Unita
(STRING, 16 bytes)
Field
Init Value
Type / Size
Specified in ‘Parameter Size’
Description
Initial value
Name
String (16 byte, null terminated)
Name of parametera
Unit
String (16 byte, null terminated)
Unita
a. These fields are optional. (However, if used, both fields must be present)
•
Data type BYTE_ARRAY
Min. Value
(BYTE)
Max. Value
(BYTE)
Init Value
(BYTE)
Namea
(String, 16 bytes)
Unita
(String, 16 bytes)
Field
Min. Value
Max. Value
Init Value
Type / Size
Byte
Byte
Byte
Description
Min. allowed value of each element in the array
Max. allowed value of each element in the array
Initial value of all elements in the array
Name
String (16 byte, null terminated)
Name of parametera
Unit
String (16 byte, null terminated)
Unita
a. These fields are optional. (However, if used, both fields must be present)
Extension Word (Optional)
This word is optional and specifies whether the response message should contain the Modbus address
of the created Application Parameter or not.
Value
0x0000
0x0001
Other values
Description
Request Modbus Address
(Reserved for future use)
Application Parameters A-4
Response - “Application Parameter Object”
The Anybus-IC module will respond with the following message. (Consult the Anybus-IC Design Guide
for more information about the Object Message Sub Field)
Object Message Sub Field
Fragment Fragment
byte count protocol
(size)
02h
HOS Instance
(WORD)
Class ID
Instance ID
0085h
0000h
Service
Code
0006h
Error Code
Data Field
0000h
(See below)
Parameter Number
(WORD)
Modbus Addressa
(WORD)
a. This field is only present if the Extension Word of the query is set to 0001h
HOS Instance
If the Error Code is 0 (Success), this field contains the HOS Instance of the created Application Parameter.
Parameter Number
If the Error Code is 0 (Success). this field contains the parameter number of the created Application
Parameter.
Modbus Address
If the Error Code is 0 (Success), this field contains the Modbus Address of the created Application Parameter.
Note: This field is only present if the Extension Word of the query is set to 0001h.
Application Parameters A-5
Example
The example below creates an Application Parameter with the following properties:
•
Parameter Name “Speed”, unit “rpm”
•
Type 16 bit unsigned INT, range 0 - 65535, initial parameter value 32768.
•
R/W access
Query
01h
37h
Class
Instance
Service Code
Attribute
Parameter Size
Descriptor MSW
Descriptor LSW
Min value
Max value
Init value
Name
Unit
5Bh
02h
0085h
0000h
0005h
0000h
0002h
0000h
0003h
0000h
FFFFh
8000h
53h (‘S’)
65h (‘e’)
64h (‘d’)
72h (‘r’)
6Dh (‘m’)
-
Extension Word
Application Parameter Class
Create
Parameter Size = 2 bytes
70h (‘p’)
65h (‘e’)
00h
70h (‘p’)
00h
0001h
CRC
UINT, DEC, R/W
Minimum allowed value: 0
Maximum allowed value: 65535
Initial value: 8000h
“Speed”
“rpm”
Request Modbus Address
Response
01h
0Fh
Class
Instance
Service Code
Error Code
HOS Instance
Parameter no.
Modbus Address
5Bh
02h
0085h
0000h
0006h
0000h
0001h
00C8h
8000h
CRC
Application Parameter Object Class
Create Response
Success
HOS Instance 1
Parameter no. = 200
Modbus Address = 8000h
Application Parameters A-6
Mapping an Application Parameter to CIP
Acyclic data on the Anybus-IC module is exchanged by means of Application Parameters mapped to
Vendor Specific CIP Objects.
The mapping procedure consists of two steps:
•
Creating the Application Parameter
(See A-2 “Creating an Application Parameter”)
•
Mapping the created Application Parameter to a CIP Object
This is done by creating a new instance in the Anybus-IC CIP Mapping Object Class (A5h). This
class is used to map a vendor specific CIP Object Attribute onto an Anybus-IC Object Attribute.
Query - “CIP Mapping Object”
(Consult the Anybus-IC Design Guide for more information about the Object Message Sub Field)
Object Message Sub Field
Fragment
byte count
(size)
CIP Class
(WORD)
Fragment
protocol
02h
CIP Instance
(WORD)
Class ID
Instance ID
Service Code
Data Field
00A5h
0000h
0005h
(See below)
HOS Attribute
(WORD)
Attribute Size
(WORD)
CIP Attribute
(WORD)
HOS Class
(WORD)
HOS Instance
(WORD)
CIP Class
HOS Class
CIP Class to map
HOS Class to map.
(In this case 85h “Application Parameter
Object Class”)
CIP Instance
CIP Instance to map
CIP Attribute
CIP Attribute to map
Attribute Size
Size of attribute. This value should match
the Parameter Size value in the Application
Parameter request.
HOS Instance
HOS Instance to map
(In this case, use the HOS Instance value
returned from the Application Parameter
Object request when the Application Parameter was created.)
HOS Attribute
HOS Attribute to map
In this case, the 0001h (=Parameter Value)
Application Parameters A-7
Response - “CIP Mapping Object”
The response contains no additional data. (Consult the Anybus-IC Design Guide for more information
about the Object Message Sub Field)
Object Message Sub Field
Fragment
byte count
(8 bits)
Fragment
protocol
02h
Class ID
Instance ID
Service Code
Error Code
00A5h
0000h
0006h
(16 bits)
Example
This example will map the Application Parameter created earlier in this chapter to CIP Class 144, Instance 1, Attribute 1.
Query
01h
17h
Class
Instance
Service Code
Attribute
CIP Class
CIP Instance
CIP Attribute
HOS Class
HOS Instance
HOS Attribute
Attribute Size
5Bh
02h
00A5h
0000h
0005h
0000h
0090h
0001h
0001h
0085h
0001h
0001h
0002h
CRC
CIP Mapping Object
Create
CIP Class 144
CIP Instance 1
CIP attribute 1
Application Parameter Object Class
HOS Instance 1
0001h = Parameter value
Size = Word
Response
01h
09h
Class
Instance
Service Code
Error Code
5Bh
02h
00A5h
0000h
0006h
0000h
CRC
CIP Mapping Object
Create Response
Success
Appendix B
HMS Object Implementation
General Information
The objects described in this chapter can be accessed using the Modbus Object Messaging protocol, and
provides access to advanced fieldbus-specific functionality.
The module features the following HOS objects:
•
B-2 “Application Parameter Object (Class 85h)”
•
B-4 “File System Object (Class 86h)”
•
B-9 “CIP Mapping Object (Class A5h)”
•
B-11 “Socket Object (Class A6h)”
HMS Object Implementation B-2
Application Parameter Object (Class 85h)
General Information
Object Description
This object manages Application Parameters.
See also...
•
A-1 “Application Parameters”
•
A-2 “Creating an Application Parameter”
•
B-9 “CIP Mapping Object (Class A5h)”
Supported Services
Class:
Instance:
Get_Attribute
Create
(see B-3 “Create (Class Service)”)
-
Class Attributes
#
1
2
Name
Revision
No. of Instances
Access
Get
Get
Type
Byte
Word
Value
01h
Current no. of instances in class.
Type
(varies)
Word
DWord
Value
(specified on ‘create’)
Instance Attributes
#
1
2
3
Name
(varies)
Parameter Size
Descriptor
Access
(varies)
Get
Get
HMS Object Implementation B-3
Create (Class Service)
Service Description
This service creates a new Application Parameter instance.
Service Request (05h)
#
1
2
3
4
5
6
7
8
Contents
Parameter Size
Descriptor
Min. Value
Max. Value
Initial Value
Name
Unit
ReqExtResp
Type
Word
DWord
(varies)
Comments
Determines access rights, types etc.
Type depends on Descriptor
String[16]
String[16]
Wprd
(optional)
(optional)
Request extended response (optional)
Type
Word
Word
Word
Comments
HOS instance number
Parameter no. of the created parameter
(optional)
Service Response (06h)
#
1
2
3
Contents
Instance Number
Parameter Number
Modbus Address
HMS Object Implementation B-4
File System Object (Class 86h)
General Information
Object Description
The File System Object class can create and delete file system instances dynamically during runtime.
Each instance is a unique handle to a file stream and contains services for file system operations.
See also...
•
2-8 “Filesystem”
Supported Services
Class:
Instance:
Get_Attribute
File Open
File Close
File Delete
File Copy
File Move
File Rename
(see B-5 “File Open (Class Service)”)
(see B-5 “File Close (Class Service)”)
(see B-6 “File Delete (Class Service)”)
(see B-6 “File Copy (Class Service)”)
(see B-7 “File Move (Class Service)”)
(see B-7 “File Rename (Class Service)”)
File Read
File Write
(see B-8 “File Read (Instance Service)”)
(see B-8 “File Write (Instance Service)”)
Class Attributes
#
1
2
3
Name
Revision
No. of Instances
Max. Instance
Access
Get
Get
Get
Instance Attributes
-
Type
Byte
Word
Word
Value
01h
Current no. of instances in class.
Max. no. of allowed instances; equals the max. number of files that
can be open simultaneously.
HMS Object Implementation B-5
File Open (Class Service)
Service Description
Creates a file instance and opens a file for reading, writing, or appending.
Service Request (80h)
#
1
Contents
Mode
Type
Byte
2
Filename
Byte[x]
•
Comments
00h: Read mode
01h: Write mode
02h: Append mode
Path + filename + NULL termination
Read mode
Opens a file for read-only access
•
Write mode
Opens a file for write-only access; if the specified file does not exist, it will be created. If the specified file already exists, it will be overwritten.
•
Read mode
Opens a file for writing at end-of-file; if the specified file does not exist, it will be created. If the
specified file already exists, data will be appended at end-of-file.
Service Response (81h)
#
1
Contents
File instance number
Type
Word
Comments
Used for all further operations on the file
File Close (Class Service)
Service Description
Closes a previously opened file and deletes the instance.
Service Request (82h)
#
1
Contents
File instance number
Type
Word
Comments
Acquired on ‘File Open’
Type
DWord
Comments
Size of closed file
Service Response (83h)
#
1
Contents
File size
HMS Object Implementation B-6
File Delete (Class Service)
Service Description
Deletes a file.
Service Request (84h)
#
1
Contents
Filename
Type
Byte[x]
Comments
Path + filename + NULL termination
Type
-
Comments
(no data)
Type
Byte[x]
Byte[x]
Comments
Source path + filename + NULL termination
Destination path + filename + NULL termination
Type
-
Comments
(no data)
Service Response (85h)
#
-
Contents
-
File Copy (Class Service)
Service Description
Creates a copy of a file.
Service Request (86h)
#
1
2
Contents
Filename (source)
Filename (destination)
Service Response (87h)
#
-
Contents
-
HMS Object Implementation B-7
File Move (Class Service)
Service Description
Moves a file.
Service Request (88h)
#
1
2
Contents
Filename
Destination
Type
Byte[x]
Byte[x]
Comments
Source path + filename + NULL termination
Destination path + NULL termination
Type
-
Comments
(no data)
Service Response (89h)
#
-
Contents
-
File Rename (Class Service)
Service Description
Renames a file.
Service Request (8Ah)
#
1
2
Contents
Old filename
New filename
Type
Byte[x]
Byte[x]
Comments
Old path + filename + NULL termination
New path + filename + NULL termination
Type
-
Comments
(no data)
Service Response (8Bh)
#
-
Contents
-
HMS Object Implementation B-8
File Read (Instance Service)
Service Description
Reads data from a file opened for reading.
Service Request (A0h)
#
1
Contents
Length
Type
Word
Comments
Number of bytes to read (up to 0400h)
Type
Word
Byte[x]
Comments
Number of bytes read
Actual data read from file
Service Response (A1h)
#
1
2
Contents
Length
Data
File Write (Instance Service)
Service Description
Writes data to a file opened for writing or appending.
Service Request (A2h)
#
1
2
Contents
Length
Data
Type
Word
Byte[x]
Comments
Number of bytes write
Data that shall be written to the file
Type
Word
Comments
Actual number of bytes written
Service Response (A3h)
#
1
Contents
Length
HMS Object Implementation B-9
CIP Mapping Object (Class A5h)
General Information
Object Description
Maps Application Parameter instances to CIP-attributes.
See also...
•
2-5 “EtherNet/IP Implementation” (2-5 “Explicit Data (Application Parameters)”)
•
9-1 “CIP Object Implementation” (9-12 “Vendor Specific Objects”)
•
A-1 “Application Parameters” (A-6 “Mapping an Application Parameter to CIP”)
•
B-2 “Application Parameter Object (Class 85h)”
Supported Services
Class:
Instance:
Get_Attribute
Create
(see B-10 “Create (Class Service)”)
-
Class Attributes
#
1
2
3
Name
Revision
No. of Instances
Max. Instance
Access
Get
Get
Get
Type
Byte
Word
Word
Value
01h
Current no. of instances in class.
Max. no. of allowed instances.
Type
Word
Word
Word
Word
Word
Word
Word
Value
Mapping information
Instance Attributes
#
1
2
3
4
5
6
7
Name
CIP Class
CIP Instance
CIP Attribute
HOS Class
HOS Instance
HOS Attribute
Size
Access
Get
Get
Get
Get
Get
Get
Get
Size of attribute data
HMS Object Implementation B-10
Create (Class Service)
Service Description
This service creates a new mapping instance.
Service Request (05h)
#
1
2
3
4
5
6
7
Contents
CIP Class
CIP Instance
CIP Attribute
HOS Class
HOS Instance
HOS Attribute
Size
Type
Word
Word
Word
Word
Word
Word
Word
Comments
CIP instance target attribute; Class must be in vendor-specific range
Type
-
Comments
-
Source Application Parameter instance attribute to map
Size of attribute
Service Response (06h)
#
-
Contents
-
HMS Object Implementation B-11
Socket Object (Class A6h)
General Information
Object Description
The Socket Object Class can create and delete Socket Instances dynamically during runtime. Each socket
instance contains services to establish and communicate over TCP or UDP channels.
Supported Services
Class:
Instance:
Get_Attribute
Create Socket
Close Socket
(see B-12 “Create Socket (Class Service)”)
(see B-12 “Close Socket (Class Service)”)
Bind
Listen
Accept
Connect
Receive
Receive From
Send
Send to
(see B-13 “Bind (Instance Service)”)
(see B-13 “Listen (Instance Service)”)
(see B-14 “Accept (Instance Service)”)
(see B-14 “Connect (Instance Service)”)
(see B-15 “Receive (Instance Service)”)
(see B-15 “Receive From (Instance Service)”)
(see B-16 “Send (Instance Service)”)
(see B-16 “Send To (Instance Service)”)
Class Attributes
#
1
2
3
Type
Byte
Word
Word
Access
R
R
R
Instance Attributes
-
Name
Class revision
Number of Instances
Max Instances
Req
R
R
R
Description
Revision number of the Class.
Number of instances in the Class.
Maximal allowed number of instances.
HMS Object Implementation B-12
Create Socket (Class Service)
Service Description
This service creates a socket.
Service Request (0x80)
#
1
Type
Byte
Name
Socket type
Description
1: SOCK_STREAM (TCP socket)
2: SOCK_DGRAM (UDP socket)
Service Response (0x81)
#
1
2
Type
Word
Word
Name
Socket Error
Instance Number
Description
See B-17 “Socket Errors”
The number of the created socket instance.
Close Socket (Class Service)
Service Description
This service causes a connected socket to shut down and deletes the socket instance.
Service Request (0x82)
#
1
Type
Word
Name
Instance
Description
Socket Instance number to close
Service Response (0x83)
#
1
Type
Word
Name
Socket Error
Description
See B-17 “Socket Errors”
HMS Object Implementation B-13
Bind (Instance Service)
Service Description
Binds a socket to a local port. Port 0 = any free port.
Service Request (0x84)
#
1
Type
Word
Name
Port
Description
The port to bind the socket to.
Service Response (0x85)
#
1
2
Type
Word
Word
Name
Socket Error
Port
Description
See B-17 “Socket Errors”
Local port number
Listen (Instance Service)
Service Description
Sets a socket to listening state.
Service Request (0x86)
#
1
Type
Byte
Name
Backlog
Description
Backlog for incoming connections:
Backlog
0
1
2
3
4
5
Service Response (0x87)
#
1
Type
Word
Name
Socket Error
Description
See B-17 “Socket Errors”
Queue length
1
2
4
5
7
6
HMS Object Implementation B-14
Accept (Instance Service)
Service Description
Accepts connections on a socket in listening state. A new socket-instance is created for each accepted
connection. The new socket is connected with the host and the Listen Response returns its instance
number.
Service Request (0x88)
#
-
Type
-
Name
-
Description
-
Accept Response (0x89)
#
1
2
3
4
Type
Word
Word
DWord
Word
Name
Socket Error
Instance Number
IP address
Port
Description
See B-17 “Socket Errors”
The number of the new instance for the connected socket.
Host IP address
Host port number
Connect (Instance Service)
Service Description
If the socket type is SOCK_DGRAM (UDP) this service specifies the peer with which the socket is to
be associated. This is to which datagrams are sent and the only address from which datagrams are received.
If the socket type is SOCK_STREAM (TCP) this service attempts to establish a connection to another
socket.
Stream sockets may connect successfully only once while datagram sockets may use connect multiple
times to change their association. Datagram sockets may dissolve the association by connection to the
invalid address: IP=0.0.0.0 Port=0
Service Request (0x8A)
#
1
2
Type Name
Dword IP address
Word Port
Description
IP address to connect to
Port number to connect to
Service Response (0x8B)
#
1
Type
Word
Name
Socket Error
Description
See B-17 “Socket Errors”
HMS Object Implementation B-15
Receive (Instance Service)
Service Description
This service receives data from a connected socket.
Service Request (0x8C)
#
1
Type
Word
Name
Length
Description
How many bytes to receive. Maximum value is 1460 bytes.
Service Response (0x8D)
#
1
2
3
Type
Word
Word
Byte[x]
Name
Socket Error
Length
Data
Description
See B-17 “Socket Errors”
Bytes received
Received data
Receive From (Instance Service)
Service Description
This service receives the next received datagram from an unconnected socket.
Service Request (0x8E)
#
1
Type
Word
Name
Length
Description
How many bytes to receive. Maximum value is 1460 bytes.
Service Response (0x8F)
#
1
2
3
4
5
Type
Word
Dword
Word
Word
Byte[x]
Name
Socket Error
IP address
Port
Length
Data
Description
See B-17 “Socket Errors”
Host IP address
Host port number
Bytes received
Received data
HMS Object Implementation B-16
Send (Instance Service)
Service Description
This service sends data on a connected socket.
Service Request (0x90)
#
1
2
Type Name
Word Length
Byte[x] Data
Description
Number of bytes to send. Maximum value is 1460 bytes.
Data to send
Service Response (0x91)
#
1
2
Type
Word
Word
Name
Socket Error
Length
Description
See B-17 “Socket Errors”
Number of sent bytes.
Send To (Instance Service)
Service Description
This service sends data on an unconnected socket.
Service Request (0x92)
#
1
2
3
4
Type
Dword
Word
Word
Byte[x]
Name
IP address
Port
Length
Data
Description
Host IP address
Host port number
Number of bytes to send. Maximum value is 1460 bytes.
Data to send
Service Response (0x93)
#
1
2
Type
Word
Word
Name
Socket Error
Length
Description
See B-17 “Socket Errors”
Number of sent bytes.
HMS Object Implementation B-17
Socket Errors
Socket Error
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Name
NOERROR
ENOBUFS
ETIMEDOUT
EISCONN
EOPNOTSUPP
ECONNABORTED
EWOULDBLOCK
ECONNREFUSED
ECONNRESET
ENOTCONN
EALREADY
EINVAL
EMSGSIZE
EPIPE
EDESTADDRREQ
ESHUTDOWN
ENOPROTOOPT
EHAVEOOB
ENOMEM
EADDRNOTAVAIL
EADDRINUSE
EAFNOSUPPORT
EINPROGRESS
ELOWER
Appendix C
Firmware Upgrade
The module supports the “standard” Anybus-IC firmware update procedures:
•
Standard Firmware Upgrade
(Consult the general Anybus-IC Design Guide for more information)
•
Firmware Upgrade using Bootloader Switch
(Consult the general Anybus-IC Design Guide for more information)
In addition to this, it also supports firmware updates via FTP. To update the firmware using this method,
follow the steps below:
1. As a precaution, make a backup copy of the filesystem contents.
2. Upload the firmware file to the system root (“\”), or to the user root (“\user\”) of the module.
3. Perform a module reset
During startup, the module will check for a new firmware file. If a valid file is found, the module
will reprogram the flash. The file will be deleted automatically after programming.
4. Done.
Appendix D
Technical Specification
Electrical Specification
Protective Earth (PE) Requirements
See 10-1 “Fieldbus Interface” and 10-2 “Typical Implementation”.
Power Supply
Supply Voltage
The module requires a regulated 5V5% DC power supply as specified in the Anybus-IC Design Guide.
Power Consumption
The maximum power consumption is 250mA.
Environmental Specification
•
Temperature
Test performed according to IEC-68-2-1 and IEC 68-2-2.
•
Operating:
-40 to +85 °C (-40 to 185°F)
Storage:
-40 to +85 °C (-40 to 185°F)
Humidity
The product is designed for a relative humidity of 5 to 95% non-condensing.
Test performed according to IEC 68-2-30.
EMC Compliance (CE)
EMC pre-compliance testing has been conducted according to the following standards:
•
Emission: EN 50 081-2:1993
Tested per
•
EN 55022:1997, class A
Immunity: EN 61000-6-2: 1999
Tested per
EN 61000-4-2:1995
EN 61000-4-3:1996
EN 61000-4-4:1995
EN 61000-4-5:1995
EN 61000-4-6:1996
Was this manual useful for you? yes no
Thank you for your participation!

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

Download PDF

advertisement