Protocol converter for ASCII to EtherNet/IP™
User manual
User manual Protocol converter for ASCII to EtherNet/IP™
2017-05-11
Revision:
A
This user manual is valid for: Designation
Order No.
GW EIP/ASCII 1E/1DB9
2702772
GW EIP/ASCII 1E/2DB9
2702773
GW EIP/ASCII 2E/2DB9
2702774
GW EIP/ASCII 2E/4DB9
2702776
PHOENIX CONTACT
3785_en_A
Please observe the following notes User group of this manual The use of products described in this manual is oriented exclusively to qualified application programmers and software engineers, who are familiar with the safety concepts of automation technology and applicable standards. Explanation of symbols used and signal words This is the safety alert symbol. It is used to alert you to potential personal injury hazards. Obey all safety measures that follow this symbol to avoid possible injury or death. There are three different categories of personal injury that are indicated with a signal word. DANGER
This indicates a hazardous situation which, if not avoided, will result in death or serious injury.
WARNING
This indicates a hazardous situation which, if not avoided, could result in death or serious injury.
CAUTION
This indicates a hazardous situation which, if not avoided, could result in minor or moderate injury.
This symbol together with the signal word NOTE and the accompanying text alert the reader to a situation which may cause damage or malfunction to the device, hardware/software, or surrounding property. This symbol and the accompanying text provide the reader with additional information or refer to detailed sources of information. How to contact us Internet
Up-to-date information on Phoenix Contact products and our Terms and Conditions can be found on the Internet at: phoenixcontact.com Make sure you always use the latest documentation. It can be downloaded at: phoenixcontact.net/products
Subsidiaries
If there are any problems that cannot be solved using the documentation, please contact your Phoenix Contact subsidiary. Subsidiary contact information is available at phoenixcontact.com.
Published by
PHOENIX CONTACT GmbH & Co. KG Flachsmarktstraße 8 32825 Blomberg GERMANY Should you have any suggestions or recommendations for improvement of the contents and layout of our manuals, please send your comments to:
[email protected]
PHOENIX CONTACT
General terms and conditions of use for technical documentation Phoenix Contact reserves the right to alter, correct, and/or improve the technical documentation and the products described in the technical documentation at its own discretion and without giving prior notice, insofar as this is reasonable for the user. The same applies to any technical changes that serve the purpose of technical progress. The receipt of technical documentation (in particular user documentation) does not constitute any further duty on the part of Phoenix Contact to furnish information on modifications to products and/or technical documentation. You are responsible to verify the suitability and intended use of the products in your specific application, in particular with regard to observing the applicable standards and regulations. All information made available in the technical data is supplied without any accompanying guarantee, whether expressly mentioned, implied or tacitly assumed. In general, the provisions of the current standard Terms and Conditions of Phoenix Contact apply exclusively, in particular as concerns any warranty liability. This manual, including all illustrations contained herein, is copyright protected. Any changes to the contents or the publication of extracts of this document is prohibited. Phoenix Contact reserves the right to register its own intellectual property rights for the product identifications of Phoenix Contact products that are used here. Registration of such intellectual property rights by third parties is prohibited. Other product identifications may be afforded legal protection, even where they may not be indicated as such.
PHOENIX CONTACT
Table of contents 1
Description..................................................................................................................................5 1.1
2
3
Structure................................................................................................................ 6
Installation ................................................................................................................................11 2.1
Safety regulations and installation notes ............................................................. 11
2.2
Mounting ............................................................................................................. 11
2.3
Data interfaces .................................................................................................... 13 2.3.1 Connecting the V.24 (RS-232) cable ................................................... 13 2.3.2 Connecting the RS-422 cable .............................................................. 14 2.3.3 Connecting the RS-485 cable .............................................................. 14 2.3.4 Connecting the Ethernet cable ............................................................. 15
2.4
Connecting the power supply .............................................................................. 16
Configuration and startup..........................................................................................................17
3785_en_A
3.1
Default settings.................................................................................................... 17
3.2
Web-based management .................................................................................... 17
3.3
Login ................................................................................................................... 17
3.4
Home screen ....................................................................................................... 18
3.5
General settings .................................................................................................. 19
3.6
LAN settings ........................................................................................................ 20 3.6.1 IP address ............................................................................................ 20 3.6.2 Security ................................................................................................ 21 3.6.3 EtherNet/IP stack ................................................................................. 22
3.7
Serial settings ...................................................................................................... 23 3.7.1 Port configuration ................................................................................. 24 3.7.2 EtherNet/IP configuration ..................................................................... 27
3.8
Socket settings .................................................................................................... 30 3.8.1 Socket settings .................................................................................... 31 3.8.2 EtherNet/IP configuration ..................................................................... 33
3.9
Diagnostics.......................................................................................................... 37 3.9.1 Communication statistics ..................................................................... 37 3.9.2 PLC interface ....................................................................................... 39 3.9.3 Serial logs ............................................................................................ 41 3.9.4 Ethernet logs ........................................................................................ 42
3.10
Maintenance........................................................................................................ 43 3.10.1 Passwords ........................................................................................... 43 3.10.2 Restore defaults ................................................................................... 44 3.10.3 Log files ............................................................................................... 45 3.10.4 Configuration files ................................................................................ 46 3.10.5 Update firmware .................................................................................. 46
PHOENIX CONTACT
1
GW EIP/ASCII...
4
5
6
7
2
Data message format................................................................................................................49 4.1
Standard message .............................................................................................. 49 4.1.1 Receive data message ........................................................................ 49 4.1.2 Transmit data message ....................................................................... 49
4.2
EtherNet/IP interface profile (ControlLogix) ......................................................... 50 4.2.1 Serial port data transfer object definition (71hex) .................................. 50
4.3
Socket port data transfer definition object (74hex)................................................ 52
4.4
Informational objects ........................................................................................... 55 4.4.1 Identity object (01hex, 1 instance) ......................................................... 55 4.4.2 Status word .......................................................................................... 56 4.4.3 Message router object (02hex) ............................................................. 57 4.4.4 Connection manager object (06hex) ..................................................... 58 4.4.5 Port object (F4hex - 1 instance) ............................................................ 59 4.4.6 TCP/IP object (F5hex - 1 instance) ....................................................... 60 4.4.7 Ethernet Link object (F6hex) ................................................................. 62 4.4.8 PCCC object (67hex) ............................................................................ 64 4.4.9 Assembly object (for Class 1 interface) ................................................ 65
MicroLogix, SLC, and PLC-5 interface......................................................................................71 5.1
Requirements ...................................................................................................... 71
5.2
Messages............................................................................................................ 73
5.3
File addressing .................................................................................................... 73
5.4
Receive data message ........................................................................................ 74 5.4.1 Received message characteristics ...................................................... 74
5.5
Transmit data message ....................................................................................... 75 5.5.1 Transmit message characteristics ....................................................... 75
5.6
Sequence number messages.............................................................................. 75
5.7
Receive communication methods........................................................................ 76 5.7.1 Write to Tag/File - Unsolicited message ............................................... 76 5.7.2 Polling .................................................................................................. 76
Troubleshooting........................................................................................................................77 6.1
Resetting the device ............................................................................................ 77 6.1.1 Hardware reset .................................................................................... 77 6.1.2 Software reset ...................................................................................... 77
6.2
LEDs.................................................................................................................... 77
EDS files ...................................................................................................................................79
PHOENIX CONTACT
7.1
Add the GW EIP/ASCII... to RSLinx..................................................................... 79
7.2
Add the EDS file to RSLinx .................................................................................. 79
7.3
Troubleshooting RSLinx ...................................................................................... 80
3785_en_A
Table of contents
A
Appendixes...............................................................................................................................81
3785_en_A
A1
List of figures ...................................................................................................... 81
B2
List of tables ....................................................................................................... 83
PHOENIX CONTACT
3
GW EIP/ASCII...
4
PHOENIX CONTACT
3785_en_A
Description
1
Description The GW EIP/ASCII... devices provide a simple way to integrate Raw/ASCII serial and Ethernet devices, such as bar code scanners, weigh scales, or radio frequency identification (RFID) tags, into EtherNet/IP™ controllers, including ControlLogix, SLC, PLC-5, and MicroLogix PLCs. The family consists of universal RS-232/422/485 one-, two-, and four-port serial versions, with one or two Ethernet ports to fit any application. This user manual is valid for: Table 1-1
3785_en_A
GW EIP/ASCII... types
Type Description
Order No.
GW EIP/ASCII 1E/1DB9
2702772
GW EIP/ASCII 1E/2DB9
2702773
GW EIP/ASCII 2E/2DB9
2702774
GW EIP/ASCII 2E/4DB9
2702776
PHOENIX CONTACT
5
GW EIP/ASCII...
1.1
Structure
GW EIP/ASCII 1E/1DB9 The GW EIP/ASCII 1E/1DB9 features one Ethernet port and one RS-232/422/485 serial port with a D-SUB 9 connector. 1
2
7 3 6 4 5
6
PHOENIX CONTACT
Figure 1-1
GW EIP/ASCII 1E/1DB9
Table 1-2
GW EIP/ASCII 1E/1DB9 structure
Item
Description
1
Power connector
2
P1 D-SUB 9 connector
3
Ethernet port (RJ45)
4
Status LED
5
Reset button
6
Ethernet activity status LED
7
Ethernet link status LED
3785_en_A
Description GW EIP/ASCII 1E/2DB9 The GW EIP/ASCII 1E/2DB9 features one Ethernet port and two RS-232/422/485 serial ports with D-SUB 9 connectors. 1
2 8
7 6 3 5
4
3785_en_A
Figure 1-2
GW EIP/ASCII 1E/2DB9
Table 1-3
GW EIP/ASCII 1E/2DB9 structure
Item
Description
1
Power connector
2
P1 D-SUB 9 connector
3
Ethernet port (RJ45)
4
P2 D-SUB 9 connector
5
Status LED
6
Ethernet activity status LED
7
Ethernet link status LED
8
Reset button
PHOENIX CONTACT
7
GW EIP/ASCII... GW EIP/ASCII 2E/2DB9 The GW EIP/ASCII 2E/2DB9 features two Ethernet ports with integrated switch functionality and two RS-232/422/485 serial ports with D-SUB 9 connectors.
1
2 11
10
3 4
9 5 8 7 6
8
PHOENIX CONTACT
Figure 1-3
GW EIP/ASCII 2E/2DB9
Table 1-4
GW EIP/ASCII 2E/2DB9 structure
Item
Description
1
Power connector
2
P1 D-SUB 9 connector
3
Ethernet link status LED
4
E2 Ethernet port (RJ45)
5
Ethernet activity status LED
6
P2 D-SUB 9 connector
7
Status LED
8
Ethernet activity status LED
9
E1 Ethernet port (RJ45)
10
Ethernet link status LED
11
Reset button
3785_en_A
Description GW EIP/ASCII 2E/4DB9 The GW EIP/ASCII 2E/4DB9 features two Ethernet ports with integrated switch functionality and four RS-232/422/485 serial ports with D-SUB 9 connectors.
1
13
2
12
11
3 4
10
5
9 8
6
7
3785_en_A
Figure 1-4
GW EIP/ASCII 2E/4DB9
Table 1-5
GW EIP/ASCII 2E/4DB9 structure
Item
Description
1
Power connector
2
P3 D-SUB 9 connector
3
Ethernet link status LED
4
E2 Ethernet port (RJ45)
5
Ethernet activity status LED
6
P4 D-SUB 9 connector
7
P2 D-SUB 9 connector
8
Status LED
9
Ethernet activity status LED
10
E1 Ethernet port (RJ45)
11
Ethernet link status LED
12
Reset button
13
P1 D-SUB 9 connector
PHOENIX CONTACT
9
GW EIP/ASCII...
10
PHOENIX CONTACT
3785_en_A
Installation
2
Installation 2.1
Safety regulations and installation notes
Installation, operation, and maintenance may be carried out only by qualified electricians. Follow the specified installation instructions. The applicable specifications and safety directives (including the national safety directives), as well as the general technical regulations, must be observed during installation and operation. The technical data should be taken from the packaging instructions and the certificates (conformity assessment, other possible approvals). Opening the device or making changes to it is not permitted. Do not repair the device yourself, but replace it with an equivalent device. Repairs may be carried out only by the manufacturer. The manufacturer is not liable for any damage caused by violation of the prescribed regulations. The IP20 degree of protection (EN 60529) of the device is intended for a clean and dry environment. Do not subject the device to any load that exceeds the prescribed limits. The device is not designed for use in environments with danger of dust explosions.
2.2
Mounting
To mount on the DIN rail: 1. Place the device onto the DIN rail from above (A), so that the upper housing keyway hooks onto the top edge of the DIN rail. 2. Hold the device by the housing cover and carefully push the device toward the mounting surface (B). 3. After the foot is snapped onto the DIN rail, verify that it is attached securely.
A
B Figure 2-1
3785_en_A
DIN rail mounting
PHOENIX CONTACT
11
GW EIP/ASCII... To remove: 1. Use a suitable screwdriver to release the locking mechanism (A) on the snap-on foot of the device. 2. Hold on to the device by the housing cover and carefully tilt it upward (B). 3. Remove the device from the DIN rail (C).
C
B A
Figure 2-2
12
PHOENIX CONTACT
DIN rail removal
3785_en_A
Installation
2.3 2.3.1
Data interfaces Connecting the V.24 (RS-232) cable
The D-SUB 9 connector may function as an RS-232, RS-422, or RS-485 interface. The RS-232 interface is a data terminal equipment (DTE) device that behaves like a personal computer (PC). A null modem cable or adapter is required to connect to a PC. The V.24 (RS-232) interface of the GW EIP/ASCII... is a DTE assignment.
Connect the GW EIP/ASCII... to the V.24 (RS-232) device to be connected (for example, a PC) by way of the PSM-KA-9SUB 9/BB/2 METER V.24 (RS-232) cable (Order No. 2799474). The cable is an interface cable with 1:1 connected contacts. Table 2-1
D-SUB 9 to RS-232 pin out
GW EIP/ASCII...
3785_en_A
End device
RS-232
D-SUB 9 (DCE)
D-SUB 9 (DTE)
D-SUB 25 (DCE)
D-SUB 25 (DTE)
1
DCD
1
4
8
20
2
RxD
2
3
3
2
3
TxD
3
2
2
3
4
DTR
4
1, 6
20
6, 8
5
GND
5
5
7
7
6
DSR
6
4
6
20
7
RTS
7
8
4
5
8
CTS
8
7
5
4
9
RI
9
-
22
-
PHOENIX CONTACT
13
GW EIP/ASCII...
2.3.2
Connecting the RS-422 cable
1
Figure 2-3
Pin 1 location
In RS-422 mode, a point-to-point connection can be established. Use a twisted-pair, common shielded bus cable to connect the I/O device. To connect the RS-422 cable: 1. Connect the individual conductors of the data cable to the GW EIP/ASCII... using a SUBCON 9/F SH (Order No. 2761499). 2. Make sure the signal assignment is correct. This operating mode supports full duplex transmission mode. Table 2-2
D-SUB 9 to RS-422 and RS-485 pin out
GW EIP/ASCII...
End device
RS-422
RS-485
RS-422
RS-485
2
T(A)
–
D(A)
–
3
D(A)
D(A)
T(A)
D(A)
5
GND
GND
GND
GND
7
D(B)
D(B)
T(B)
D(B)
8
T(B)
–
D(B)
–
2.3.3
Connecting the RS-485 cable
In RS-485 mode, an RS-485 network with several I/O devices can be created. Use a twisted-pair, common shielded bus cable to connect the I/O devices. Connect the individual conductors of the data cable to the GW EIP/ASCII... using a SUBCON 9/F SH (Order No. 2761499) (see Table 2-2). NOTE: Observe the polarity of the RS-485 cable. Fit this bus cable with a termination network at the two furthest points of the RS-485 network. The termination resistors are integrated in the GW EIP/ASCII... and can be switched on through the web-based management interface.
14
PHOENIX CONTACT
3785_en_A
Installation
2.3.4
Connecting the Ethernet cable
The GW EIP/ASCII... has an Ethernet interface on the front in RJ45 format, to which only twisted-pair cables with an impedance of 100 Ω can be connected. The data transmission rate is either 10 or 100 Mbps. The GW EIP/ASCII... supports the auto negotiation function for automatic selection of the transmission speed, as well as an automatic crossover feature for the selection of line or crossover cabling. Push the Ethernet cable with the crimped RJ45 connector into the GW EIP/ASCII... until it engages with a click. 2.3.4.1
Models with two Ethernet ports
When using two Ethernet ports, the GW EIP/ASCII... is classified as a switch. When using only one port, it is a simple end node device. The maximum number of daisy-chained GW EIP/ASCII... units, and the maximum distance between units, is based on the Ethernet standards, and is determined by the environment and conformity of the network to these standards. There may be some performance degradation on the devices at the end of the chain, so it is recommended to overload and test for performance in the environment. The application may also limit the total number of ports that may be installed. Some basic guidelines are listed below. – Ethernet 10BASE-T rules – The maximum number of repeater segments is four. – Use Category 3 or 5 twisted-pair 10BASE-T cables. The maximum length of each cable is 100 m (328 ft.). – Fast Ethernet 100BASE-TX rules – The maximum number of repeater segments is two (for a Class II hub). A Class II hub can be connected directly to one other Class II Fast Ethernet hub. A Class I hub cannot be connected directly to another Fast Ethernet hub. – Category 5 twisted-pair cable must be used. The maximum length of each twistedpair cable is 100 m (328 ft.). – The total length of twisted-pair cabling (across directly connected hubs) must not exceed 205 m (672 ft.). – IEEE 802.3 specification: A network using repeaters between communicating stations (PCs) is subject to the 5-4-3 rule of repeater placement on the network: – The maximum number of segments connected on a network is five. – Four repeaters is the maximum that can be applied to a network. – Only three segments can have user connections. The other two segments must act as repeaters with no user connections.
3785_en_A
PHOENIX CONTACT
15
GW EIP/ASCII...
2.4
Connecting the power supply
CAUTION: Incorrect connection may result in damage to equipment and/or serious personal injury. Only qualified personnel may connect the power, start up, and operate this device. According to the safety instructions in this text, qualified personnel are persons who are authorized to start up, to ground, and to mark devices, systems, and equipment according to the standards of safety technology. In addition, these persons must be familiar with all warning instructions and maintenance measures in this text. Disregarding this warning may result in damage to equipment and/or serious personal injury. The device can be connected to a single power source or two power sources for redundancy. The GW EIP/ASCII... is powered using a +24 V DC SELV power supply. The power supply is connected by way of COMBICON plug-in screw terminal blocks (24 V and 0 V).
16
PHOENIX CONTACT
Figure 2-4
Single power supply connection
Figure 2-5
Redundant power supply connection
3785_en_A
Configuration and startup
3
Configuration and startup 3.1
Default settings
The default network settings of the GW EIP/ASCII... are: IP address: 192.168.254.254 Subnet mask: 255.255.255.0 Gateway: 0.0.0.0 The default settings are invoked whenever the system is reset.
3.2
Web-based management
The user-friendly, web-based management interface, a graphical user interface (GUI), can be used to manage the GW EIP/ASCII... from anywhere in the network using a standard browser. Comprehensive configuration and diagnostic functions, including a wide range of information about the device itself, the current parameters, and the operating state, are clearly displayed.
3.3
Login
To log in: 1. Set the IP address of the connected PC to the subnetwork of the GW EIP/ASCII...: for example, IP = 192.168.254.10, subnetwork = 255.255.255.0. 2. Open a web browser and enter the IP address of the GW EIP/ASCII... in the “Address” field (default = 192.168.254.254).
Figure 3-1
“Login” screen
The web server responds immediately. If the web server does not load, first check the IP parameters of the PC. If everything is set correctly, check to see if there are any proxy settings loaded in the web browser. The proxy setting must be set to “Load automatically” or “Deactivated” to properly establish communication.
3785_en_A
PHOENIX CONTACT
17
GW EIP/ASCII... 3.
Enter the credentials to access the web server configuration pages. The default credentials are: User name: Admin Default password: admin
Powering multiple devices with factory default IP addresses causes a network conflict, and incorrect parameters may be set in the GW EIP/ASCII... modules. When programming modules for the first time, it is important to apply power to only one at a time, and change the IP address of each module to a unique IP address. Once all devices have a unique IP address, they can be powered on together while on the same network.
3.4
Home screen
Immediately after login, the “Home” screen is displayed. From the “Home” screen, the basic settings of the GW EIP/ASCII... can be immediately configured by clicking on the appropriate Ethernet port or serial port in the diagram of the module.
Figure 3-2
“Home” screen
Advanced settings can be accessed through the menu at the top of the screen. The “Home” screen can be accessed at any time by clicking the “Home” button in the upper-left corner of the web-based management interface.
18
PHOENIX CONTACT
3785_en_A
Configuration and startup
3.5
General settings
To view and edit general settings: 1. Click the “General Settings” tab to view and edit general information about the GW EIP/ASCII....
Figure 3-3 2. 3.
4.
3785_en_A
“General Settings” page
View the listed information. If desired, change the listed information. The “Device Identification” group provides fields for entering descriptive information about individual devices. Device Name: Enter a name for the device. The field accepts up to 16 characters. Contact: Enter the name of a contact person, group, or department responsible for this device. The field accepts up to 16 characters. Click the “Apply Changes” button to save the configuration.
PHOENIX CONTACT
19
GW EIP/ASCII...
3.6 3.6.1
LAN settings IP address
To enter the IP address: 1. From the “LAN Settings” page, click the “IP Address” tab to access the “IP Address” page.
Figure 3-4 2.
3.
20
PHOENIX CONTACT
“LAN Settings/IP Address” page
Select the method for assigning the LAN IP address. If a DHCP server assigns IP addresses, click the “Automatic address assignment (DHCP)” button. If using static IP addresses, click the “Manual address assignment” button and enter the appropriate information in the various fields. MAC Address: The MAC address of the GW EIP/ASCII... is displayed. Click the “Apply Changes” button to save the configuration.
3785_en_A
Configuration and startup
3.6.2
Security
The GW EIP/ASCII... includes several security options for data encryption and device authentication. It is possible to configure the GW EIP/ASCII.... so that only authorized client applications can connect using SSL/TLS. For secure operation, the GW EIP/ASCII... uses a set of four keys and certificates. These keys and certificates are configurable. To configure security settings: 1. From the “LAN Settings” page, click the “Security” tab.
Figure 3-5 2.
“LAN Settings/Security” page
Configure the GW EIP/ASCII... so that only authorized client applications can connect using SSL/TLS. For secure operation, the GW EIP/ASCII... uses a set of four keys and certificates. These keys and certificates may be configured. RSA Key pair used by SSL and SSH servers: This is a private/public key pair that is used for two purposes: – It is used by some cipher suites to encrypt the SSL/TLS handshaking messages. Possession of the private portion of this key pair allows an eavesdropper to decrypt traffic on SSL/TLS connections that use RSA encryption during handshaking. – It is used to sign the RSA server certificate in order to verify that the GW EIP/ASCII... is authorized to use the RSA server identity certificate.
Possession of the private portion of this key pair allows others to pose as the GW EIP/ASCII.... If the RSA server key is to be replaced, a corresponding RSA identity certificate must also be generated and uploaded, or clients cannot verify the identity certificate. RSA Server Certificate used by SSL servers: This is the RSA identity certificate that the GW EIP/ASCII... uses during SSL/TLS handshaking to identify itself. It is used most frequently by SSL server code in the GW EIP/ASCII... when clients open connections to the GW EIP/ASCII... secure web server or other secure TCP ports. If a GW EIP/ASCII... serial port configuration is set up to open (as a client) a TCP connection to another server device, the GW EIP/ASCII... also uses this certificate to identify itself as an SSL client if requested by the server. In order to function properly, this certificate must be signed using the RSA server key. This means that the RSA server certificate and RSA server key must be replaced as a pair.
3785_en_A
PHOENIX CONTACT
21
GW EIP/ASCII... DH Key pair used by SSL servers: This is a private/public key pair that is used by some cipher suites to encrypt the SSL/TLS handshaking messages. Possession of the private portion of the key pair allows an eavesdropper to decrypt traffic on SSL/TLS connections that use DH encryption during handshaking. The key or certificate notation changes from factory or none to user when the GW EIP/ASCII... is secure. Certificates and keys to be uploaded to the GW EIP/ASCII... must be in the .DER binary file format, not in the .PEM ASCII file format. (The openssl tools can create files in either format and can convert files back and forth between the two formats.)
3.6.3
EtherNet/IP stack
The EtherNet/IP stack management settings are advanced parameters that should only be changed by a qualified professional. The default parameters are recommended for most systems. These settings should only be modified for networks that require special attention.
Figure 3-6
“LAN Settings/EtherNet/IP Stack” page
TTL (time to live) network value: The TTL network value is the network routing parameter that allows EtherNet/IP messages to be routed between different subnets. A TTL network value of 1, the default, allows the messages to be routed over one network “hop”. A TTL network value of 2 allows two hops and so on. Multicast IP address allocation control: The Multicast IP address allocation control defines how Class 1 multicast addresses are allocated. When Automatic (default) is selected, the GW EIP/ASCII gateway uses the standard automatic multicast address mechanism. When User Defined is selected, the GW EIP/ASCII... gateway allocates the multicast addresses based on the user settings. User defined number of multicast IP addresses: If Multicast IP address allocation control is set to User Defined, the GW EIP/ASCII... uses the configured number of multicast IP addresses. User defined multicast start IP address: If Multicast IP address allocation control is set to User Defined, the GW EIP/ASCII... begins its multicast IP address range at the value entered. Session encapsulation timeout: The GW EIP/ASCII... waits the designated time in seconds with no activity before timing out a session. A value of 0 disables the timeout functionality.
22
PHOENIX CONTACT
3785_en_A
Configuration and startup
3.7
Serial settings
To configure serial settings: 1. Click the “Serial Settings” tab to configure the serial port(s). The “Overview” page provides a quick summary of the current configuration of the serial port(s). 2. Click the appropriate configuration tab to edit the configuration of that port.
Figure 3-7
3785_en_A
“Serial Settings/Overview” page
PHOENIX CONTACT
23
GW EIP/ASCII...
3.7.1
Figure 3-8 3.7.1.1
Port configuration
“Serial Settings/Port 1 Configuration/Serial Port Configuration” page Serial port configuration
To configure serial ports: 1. From the “Serial Settings” page, click the “Port Configuration” tab. 2. In the “Serial Port Configuration” group, specify the settings of each serial port to match the connected serial device.
Figure 3-9
“Serial Port Configuration” dialog box
Port name: Enter a label for the port. This could correspond to the connected device, “Shipping Label” for example, for easy identification. Port mode: Select the port operating mode. Available settings are RS-232, RS-422, RS-485 2-wire, RS-485 4-wire (M), and RS-485 4-wire (S), where “M” indicates master and “S” indicates slave. When RS-485 4-wire (M) is selected, the RS-485 transmitter is always enabled on the GW EIP/ASCII.... When RS-485 4-wire (S) is selected, the RS-485 transmitter is enabled only when the GW EIP/ASCII... has data to send. This is important when a four-wire RS-485 multidrop network is installed. Baud rate: Select the baud rate of the serial port; 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, and 230400 bps are supported. Parity: Select odd, even, mark, space, or none. Data bits: Select 5, 6, 7, or 8 data bits.
24
PHOENIX CONTACT
3785_en_A
Configuration and startup Stop bits: Select 1 or 2 stop bits. Flow control: Available options for RS-232 flow control are hardware RTS/CTS, software Xon/Xoff, half duplex, and none. RS-485 terminating resistor: The terminating resistor is used only in RS-485 networks. If the GW EIP/ASCII... is the last device in the RS-485 network, enable the terminating resistor. DTR mode: Select on all the time or off all the time when a connection is established on this port. Rx timeout between packets: This is the maximum spacing between received bytes allowed before the received Modbus serial message is expected to be complete. The default value is 200 ms. Discard packets with errors: If enabled, all packets with parity, framing, or overrun errors are dropped. The GW EIP/ASCII... modules can be configured to detect serial packet delimiters used for the identification of a raw data packet. 3.7.1.2
Raw/ASCII serial packet delimiters
“Detect Delimiters from Serial Device”:
Figure 3-10
“Raw/ASCII Serial Packet Delimiiters” dialog box
Start transmission (STX): When enabled, GW EIP/ASCII... detects an STX (start of transmission) byte sequence which is configured as one byte or two bytes when it receives a serial packet. If none is selected, the GW EIP/ASCII... accepts the first byte received after the last End Transmission (ETX) byte(s) as the start of the next data packet. If one byte is selected, the GW EIP/ASCII... starts to collect data when the STX byte is detected. If the first byte is not the STX byte, it discards the byte. The GW EIP/ASCII... continues to discard the bytes until it finds an STX byte. If two bytes is selected, the GW EIP/ASCII... starts to collect data when both of the STX bytes are detected. If the STX bytes cannot be found, it discards the bytes. The GW EIP/ASCII... continues to discard the bytes until it finds the two STX bytes. – Byte 1: Specifies the character that represents the first STX byte. The GW EIP/ASCII... looks for this character in the first STX byte, if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second STX byte. The GW EIP/ASCII... looks for this character in the second STX byte, only if the length is two bytes. Specify a value between 0 and FF in decimal format. End transmission (ETX): When enabled, the GW EIP/ASCII... detects an ETX (end of transmission) byte sequence that is configured as one byte or two bytes marking the end of the serial packet. The length indicates the number of ETX bytes; if none is selected, this function is disabled and the GW EIP/ASCII... uses the Rx Timeout Between Packets to indicate the end of data packet. If one byte is selected, the serial data is checked for one ETX byte to identify the end of a serial packet. If two bytes is selected, the serial data is checked for two ETX bytes to identify the end of a serial packet.
3785_en_A
PHOENIX CONTACT
25
GW EIP/ASCII... –
–
Byte 1: Specifies the character that represents the first ETX byte. The GW EIP/ASCII... looks for this character in the first ETX byte, if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. Byte 2: Specifies the character that represents the second ETX byte. The GW EIP/ASCII... looks for this character in the second ETX byte, only if the length is two bytes. Specify a value between 0 and FF in decimal format.
Strip RX STX/ETX Chars: When enabled, the STX and ETX characters are removed from the received serial packets. Packets sent from the PLC by way of Ethernet to the serial ports of the GW EIP/ASCII... are not checked for STX/ETX characters. The GW EIP/ASCII... modules can also be configured to append characters to the beginning or end of a serial packet. Similar information is then entered under “Append Delimiters from PLC” in the same group: Start transmission (STX): When enabled, GW EIP/ASCII... adds an STX (start of transmission) byte sequence which is configured as one byte or two bytes when it transmits a serial packet. If none is selected, the feature is disabled. If one byte is selected, the GW EIP/ASCII... adds one byte the beginning of the packet. If two bytes is selected, the GW EIP/ASCII... appends two bytes. – Byte 1: Specifies the character that represents the first STX byte. The GW EIP/ASCII... appends this byte if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second STX byte. The GW EIP/ASCII... adds this byte only if the length is two bytes. Specify a value between 0 and FF in decimal format. End transmission (ETX): When enabled, the GW EIP/ASCII... adds an ETX (end of transmission) byte sequence that is configured as one byte or two bytes marking the end of the serial packet. The length indicates the number of ETX bytes; if none is selected, this function is disabled. If one byte is selected, one ETX byte is appended to identify the end of a serial packet. If two bytes is selected, two ETX bytes are appended to identify the end of a serial packet. – Byte 1: Specifies the character that represents the first ETX byte. The GW EIP/ASCII... appends this byte if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second ETX byte. The GW EIP/ASCII... adds this byte only if the length is two bytes. Specify a value between 0 and FF in decimal format.
26
PHOENIX CONTACT
3785_en_A
Configuration and startup
3.7.2
EtherNet/IP configuration
The “EtherNet/IP Configuration” page sets how the Raw/ASCII data is transmitted to an EtherNet/IP controller.
Figure 3-11
“EtherNet/IP configuration” page
EtherNet/IP interface configuration PLC type: The GW EIP/ASCII... provides EtherNet/IP connectivity to the entire ControlLogix family of PLCs as well as the SLC, PLC-5, and MicroLogix PLCs. The ControlLogix setting supports full CIP interfaces including Class 1, Write to Tag and full object interface support. The ControlLogix PLC family of PLCs includes the Rockwell® ControlLogix®, FlexLogix, MicroLogix, SoftLogix and other advanced PLCs. This selection also supports numerous PLCs manufactured by other manufacturers, such Omron® and Schneider Electric®. The MicroLogix setting provides support for Rockwell MicroLogix, SLC and PLC-5 PLCs. These PLCs only support a limited EtherNet/IP interface that does not include Class 1 or full object support. Only Write to File and communication using PCCC MSG instructions is provided. Transfer mode to PLC: Specifies how the Raw/ASCII data will be transferred (via EtherNet/IP) to the PLC. – When Write to Tag/File is selected, the GW EIP/ASCII... writes the serial data directly into a tag or file on the PLC. This option should only be used if the PLC can scan and consume the serial data faster than the serial device can produce it. – When Class 1 is selected, the GW EIP/ASCII... writes the serial data into a tag or file on the PLC and provides a mechanism to synchronize the data flow between the PLC and the GW EIP/ASCII.... Use this method when you want to ensure that the tag or file is not overwritten before the PLC can consume the data. Class 1 communication is only applicable to ControlLogix PLCs. – Select Polling if the PLC will request data on a periodic basis. It provides the ability to control the received data flow. However, it does require periodic data requests and the request rate must be fast enough to ensure that the serial port RX queues on the GW EIP/ASCII... do not overflow. The default is Class 1.
3785_en_A
PHOENIX CONTACT
27
GW EIP/ASCII... Transfer mode from PLC: Specifies the EtherNet/IP transfer mode from the PLC for this port. – When Write Msg is selected, the PLC writes the data to the GW EIP/ASCII... by way of an MSH instruction. – The Class 1 setting configures the PLC to maintain a Class 1 connection with the GW EIP/ASCII... which provides cyclic receive (to PLC) and transmit (from PLC) data between the PLC and the GW EIP/ASCII.... Class 1 communication is only applicable to ControlLogix PLCs. The default is Class 1. PLC IP address: Enter the IP address of the PLC EtherNet/IP card. The PLC IP address only applies when Write to Tag/File is selected. Polling and Class 1 methods do not use this attribute.
PLC controller slot number: Specifies the slot number on the PLC where the controller resides. The slot numbers typically start at zero for the first slot. This is only required for the ControlLogix family of PLCs when Write to Tag/File is selected. Polling and Class 1 methods do not use this attribute.
Maximum PLC update rate: The maximum rate (in milliseconds) at which messages are sent to the PLC tag when the “Transfer mode to PLC” field is set to Write to Tag/File or Class 1. When Write to Tag/File is selected, this setting configures the GW EIP/ASCII... to space the messages to the EtherNet/IP PLC in order to prevent overwriting data before the PLC can process it. When Class 1 is selected, it specifies the fastest acceptable cycle time between the PLC and the GW EIP/ASCII.... Maximum RX packet size: When Write to Tag/File or Polling in the “Transfer mode to PLC” field are selected, this setting specifies the maximum acceptable size of a received serial or Ethernet packet. The default value is 1518 bytes for serial ports. When Class 1 is selected in the “Transfer mode to PLC” field, this setting specifies the size of the data block used in the corresponding input assembly instance. The length of the corresponding instance is equal to (RX data packet size + 4 bytes). Maximum TX packet size: Specifies the size of the data block used in the corresponding output assembly instance. The length of the corresponding instance is equal to TX data packet size + 4 bytes This setting is only used when Class 1 is selected in the “Transfer mode to PLC” field.
Oversized packets: Specifies how to process oversized received packets. Set the “Max packet size” field to the desired size and the packet is truncated. Alternatively, the packet may be dropped. RX produced data tag name: Enter the PLC tag or file name in this field. This designates where to write received data when Write to Tag/File option is selected. This field supports a name containing up to 40 characters. The “Tag/file” name must be a global variable in the PLC. Enter the tag/file name exactly as it is in the PLC. A MicroLogix type file name must be N10 or greater and have the format N10:0. The Polling method does not use this attribute.
28
PHOENIX CONTACT
3785_en_A
Configuration and startup Advanced configuration Enable TX sequence number check: If enabled, the sequence number is checked and messages are only transmitted if the sequence number is incremented from the previous sequence number. When a duplicate sequence number is received and the “Transfer mode from PLC” field is set to Write Msg, the message is rejected and the “Duplicate Transmit Sequence Error Count” counter increments. When a duplicate sequence number is received and the “Transfer mode from PLC” field is set to Class 1, the message is ignored. In either case, if a message is received with an unexpected sequence number that is not a duplicate or an incremented sequence number, the “Unexpected Transmit Sequence Error Count” counter increments. If disabled, all transmit messages are transmitted regardless if the sequence number has been incremented or not. Disable Rx Queue (to PLC): Select this option to only receive the last received data packet. If two or more packets are received during the “Maximum PLC Update Rate” time period, only the last received data packet is returned. Receive MicroLogix MSB first: Enable this option when the GW EIP/ASCII... should receive the most significant byte (MSB) of a 16-bit integer first. This option is disabled by default and the least significant byte (LSB) is received first. Transmit MicroLogix MSB first: Enable this option when the GW EIP/ASCII... should transmit the most significant byte (MSB) of a 16-bit integer first. This option is disabled by default and the least significant byte (LSB) is transmitted first. 3.7.2.1
Class 1 overview
The “Class 1 Overview” pages provide an array of highly informative Class 1 interface information to aid when programming a PLC.
Figure 3-12
3785_en_A
“Class 1 Overview” page
PHOENIX CONTACT
29
GW EIP/ASCII...
3.8 1.
Socket settings
Click on the “Socket settings” tab to access configuration parameters related to configure EtherNet/IP mapping of Ethernet Raw/ASCII data. The overview page provides a quick view of the configuration related to each Ethernet TCP/IP connection of the GW EIP/ASCII... device.
Figure 3-13 2.
“Socket/Settings Overview” page
To edit the configuration of an Ethernet TCP/IP connection, click the appropriate “Socket Configuration” tab.
The number of Ethernet TCP/IP connections supported by the GW EIP/ASCII... is equal to the number of serial ports on the device, but the TCP/IP connections are not directly linked to a particular serial port.
30
PHOENIX CONTACT
3785_en_A
Configuration and startup
3.8.1
Socket settings
On the “Socket Configuration” page, specify the settings for each socket. 3.8.1.1
Figure 3-14
TCP configuration
“Socket Settings/Socket Configuration/TCP Configuration” page
The TCP configuration specifies how the GW EIP/ASCII... connects to a TCP/IP Raw/ASCII device, such as a bar code scanner. 1. In the “TCP Interface Configuration” group, specify the TCP settings of the Ethernet port.
Figure 3-15 – – – – –
– –
3785_en_A
“TCP Interface Configuration” group
Port name: Enter a label for the port. This could correspond to the connected device, for example “Label Scanner” for easy identification. Enable: This must be checked to use the port as a socket. Listen: Check the “Listen” box so that the GW EIP/ASCII... listens for incoming TCP/IP socket connections on the port number specified in the “On port” field. On port: Enter the TCP port number on which the GW EIP/ASCII... listens for connections. Connect: If Enable is selected, this setting determines how to connect to a device. If Never is selected, the GW EIP/ASCII... does not attempt to make a connection. If Always is selected, the GW EIP/ASCII... maintains a permanent connection to the device specified by the “Connect to IP address” and “Connect to port” fields. Connect to IP address: Enter an IP address to which the GW EIP/ASCII... initiates a connection. Use the standard AAA.BBB.CCC.DDD format. Connect to port: Enter a TCP Port number to which the GW EIP/ASCII... initiates a connection.
PHOENIX CONTACT
31
GW EIP/ASCII... –
– –
2.
Disconnect: This field determines how the GW EIP/ASCII... disconnects from the device. Select Never to maintain the connection when there is no data. Select Idle to close the connection after a period of inactivity specified by the Idle timeout field. Idle timeout: The Idle Timeout is the number of seconds before a disconnect occurs if the Disconnect Idle option is selected. RX timeout between packets: Receive timeout between packets in ms. This is the maximum spacing between received bytes allowed before the received message is expected to be complete. The range is 0 to 65565 ms. Click the “Apply Changes” button to save the configuration. The fields may be edited at any time, be sure to click the “Apply Changes” button to save the modifications.
The GW EIP/ASCII... modules can be configured to detect serial packet delimiters used for the identification of a raw data packet. Raw/ASCII serial packet delimiters “Detect Delimiters from Serial Device”: Start Transmission (STX): When enabled, GW EIP/ASCII... detects an STX (start of transmission) byte sequence which is configured as one byte or two bytes when it receives a serial packet. If none is selected, the GW EIP/ASCII... accepts the first byte received after the last End Transmission (ETX) byte(s) as the start of the next data packet. If one byte is selected, the GW EIP/ASCII... starts to collect data when the STX byte is detected. If the first byte is not the STX byte, it discards the byte. The GW EIP/ASCII... continues to discard the bytes until it finds an STX byte. If two bytes is selected, the GW EIP/ASCII... starts to collect data when both of the STX bytes are detected. If the STX bytes cannot be found, it discards the bytes. The GW EIP/ASCII... continues to discard the bytes until it finds the two STX bytes. – Byte 1: Specifies the character that represents the first STX byte. The GW EIP/ASCII... looks for this character in the first STX byte, if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second STX byte. The GW EIP/ASCII... looks for this character in the second STX byte, only if the length is two bytes. Specify a value between 0 and FF in decimal format. End Transmission (ETX): When enabled, the GW EIP/ASCII... detects an ETX (end of transmission) byte sequence that is configured as one byte or two bytes marking the end of the serial packet. The length indicates the number of ETX bytes; if none is selected, this function is disabled and the GW EIP/ASCII... uses the Rx Timeout Between Packets to indicate the end of data packet. If one byte is selected, the serial data is checked for one ETX byte to identify the end of a serial packet. If two bytes is selected, the serial data is checked for two ETX bytes to identify the end of a serial packet. – Byte 1: Specifies the character that represents the first ETX byte. The GW EIP/ASCII... looks for this character in the first ETX byte, if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second ETX byte. The GW EIP/ASCII... looks for this character in the second ETX byte, only if the length is two bytes. Specify a value between 0 and FF in decimal format. Strip Rx STX/ETX Characters: When enabled, the STX and ETX characters are removed from the received serial packets. Packets sent from the PLC by way of Ethernet to the serial ports of the GW EIP/ASCII... are not checked for STX/ETX characters. The GW EIP/ASCII... modules can also be configured to append characters to the beginning or end of a serial packet.
32
PHOENIX CONTACT
3785_en_A
Configuration and startup Similar information is then entered under “Append Delimiters from PLC” in the same group: Start Transmission (STX): When enabled, GW EIP/ASCII... adds an STX (start of transmission) byte sequence which is configured as one byte or two bytes when it transmits a serial packet. If none is selected, the feature is disabled. If one byte is selected, the GW EIP/ASCII... adds one byte the beginning of the packet. If two bytes is selected, the GW EIP/ASCII... appends two bytes. – Byte 1: Specifies the character that represents the first STX byte. The GW EIP/ASCII... appends this byte if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second STX byte. The GW EIP/ASCII... adds this byte only if the length is two bytes. Specify a value between 0 and FF in decimal format. End Transmission (ETX): When enabled, the GW EIP/ASCII... adds an ETX (end of transmission) byte sequence that is configured as one byte or two bytes marking the end of the serial packet. The length indicates the number of ETX bytes; if none is selected, this function is disabled. If one byte is selected, one ETX byte is appended to identify the end of a serial packet. If two bytes is selected, two ETX bytes are appended to identify the end of a serial packet. – Byte 1: Specifies the character that represents the first ETX byte. The GW EIP/ASCII... appends this byte if the length is one byte or two bytes. Specify a value between 0 and FF in hexadecimal format. – Byte 2: Specifies the character that represents the second ETX byte. The GW EIP/ASCII... adds this byte only if the length is two bytes. Specify a value between 0 and FF in decimal format.
3.8.2
EtherNet/IP configuration
The “EtherNet/IP Configuration” page sets how the Raw/ASCII data is transmitted to an EtherNet/IP controller.
Figure 3-16
“Socket settings/Socket 1 Configuration/EtherNet/IP configuration” page
EtherNet/IP interface configuration PLC type: The GW EIP/ASCII... provides EtherNet/IP connectivity to the entire ControlLogix family of PLCs as well as the SLC, PLC-5, and MicroLogix PLCs. The ControlLogix setting supports full CIP interfaces including Class 1, Write to Tag and full
3785_en_A
PHOENIX CONTACT
33
GW EIP/ASCII... object interface support. The ControlLogix PLC family of PLCs includes the Rockwell ControlLogix, FlexLogix, MicroLogix, SoftLogix and other advanced PLCs. This selection also supports numerous PLCs manufactured by other manufacturers, such Omron and Schneider Electric. The MicroLogix setting provides support for Rockwell MicroLogix, SLC and PLC-5 PLCs. These PLCs only support a limited EtherNet/IP interface that does not include Class 1 or full object support. Only Write to File and communication using PCCC MSG instructions is provided. Transfer mode to PLC: Specifies how the Raw/ASCII data will be transferred (via EtherNet/IP) to the PLC. – When Write to Tag/File is selected, the GW EIP/ASCII... writes the serial data directly into a tag or file on the PLC. This option should only be used if the PLC can scan and consume the serial data faster than the serial device can produce it. – When Class 1 is selected, the GW EIP/ASCII... writes the serial data into a tag or file on the PLC and provides a mechanism to synchronize the data flow between the PLC and the GW EIP/ASCII.... Use this method when you want to ensure that the tag or file is not overwritten before the PLC can consume the data. Class 1 communication is only applicable to ControlLogix PLCs. – Select Polling if the PLC will request data on a periodic basis. It provides the ability to control the received data flow. However, it does require periodic data requests and the request rate must be fast enough to ensure that the serial port RX queues on the GW EIP/ASCII... do not overflow. The default is Class 1. Transfer mode from PLC: Specifies the EtherNet/IP transfer mode from the PLC for this port. – When Write Msg is selected, the PLC writes the data to the GW EIP/ASCII... by way of an MSH instruction. – The Class 1 setting configures the PLC to maintain a Class 1 connection with the GW EIP/ASCII... which provides cyclic receive (to PLC) and transmit (from PLC) data between the PLC and the GW EIP/ASCII.... Class 1 communication is only applicable to ControlLogix PLCs. The default is Class 1. PLC IP address: Enter the IP address of the PLC EtherNet/IP card. The PLC IP address only applies when Write to Tag/File is selected. Polling and Class 1 methods do not use this attribute.
PLC controller slot number: Specifies the slot number on the PLC where the controller resides. The slot numbers typically start at zero for the first slot. This is only required for the ControlLogix family of PLCs when Write to Tag/File is selected. Polling and Class 1 methods do not use this attribute.
Maximum PLC update rate: The maximum rate (in milliseconds) at which messages are sent to the PLC tag when the “Transfer mode to PLC” field is set to Write to Tag/File or Class 1. When Write to Tag/File is selected, this setting configures the GW EIP/ASCII... to space the messages to the EtherNet/IP PLC in order to prevent overwriting data before the PLC can process it. When Class 1 is selected, it specifies the fastest acceptable cycle time between the PLC and the GW EIP/ASCII.... Maximum RX packet size: When Write to Tag/File or Polling in the “Transfer mode to PLC” field are selected, this setting specifies the maximum acceptable size of a received serial or Ethernet packet. The default value is 2048 bytes for serial ports. When Class 1 in
34
PHOENIX CONTACT
3785_en_A
Configuration and startup the “Transfer mode to PLC” field is selected, this setting specifies the size of the data block used in the corresponding input assembly instance. The length of the corresponding instance is equal to (RX data packet size + 4 bytes). Maximum TX packet size: Specifies the size of the data block used in the corresponding output assembly instance. The length of the corresponding instance is equal to TX data packet size + 4 bytes This setting is only used when Class 1 is selected in the “Transfer mode to PLC” field.
Oversized packets: Specifies how to process oversized received packets. Set the “Max packet size” field to the desired size and the packet is truncated. Alternatively, the packet may be dropped. RX produced data tag name: Enter the PLC tag or file name in this field. This designates where to write received data when Write to Tag/File option is selected. This field supports a name containing up to 40 characters. The “Tag/file” name must be a global variable in the PLC. Enter the tag/file name exactly as it is in the PLC. A MicroLogix type file name must be N10 or greater and have the format N10:0. The Polling method does not use this attribute.
Advanced configuration Enable TX sequence number check: If enabled, the sequence number is checked and messages are only transmitted if the sequence number is incremented from the previous sequence number. When a duplicate sequence number is received and the “Transfer mode from PLC” field is set to Write Msg, the message is rejected and the “Duplicate Transmit Sequence Error Count” counter increments. When a duplicate sequence number is received and the “Transfer mode from PLC” field is set to Class 1, the message is ignored. In either case, if a message is received with an unexpected sequence number that is not a duplicate or an incremented sequence number, the “Unexpected Transmit Sequence Error Count” counter increments. If disabled, all transmit messages are transmitted regardless if the sequence number has been incremented or not. Disable RX queue (to PLC): Select this option to only receive the last received data packet. If two or more packets are received during the “Maximum PLC Update Rate” time period, only the last received data packet is returned. Receive MicroLogix MSB first: Enable this option when the GW EIP/ASCII... should receive the most significant byte (MSB) of a 16-bit integer first. This option is disabled by default and the least significant byte (LSB) is received first. Transmit MicroLogix MSB first: Enable this option when the GW EIP/ASCII... should transmit the most significant byte (MSB) of a 16-bit integer first. This option is disabled by default and the least significant byte (LSB) is transmitted first.
3785_en_A
PHOENIX CONTACT
35
GW EIP/ASCII... 3.8.2.1
Class 1 overview
The “Class 1 Overview” pages provide an array of highly informative Class 1 interface information to aid when programming a PLC.
Figure 3-17
36
PHOENIX CONTACT
“Class 1 Overview” page
3785_en_A
Configuration and startup
3.9
Diagnostics
A variety of packet statistics can be used to diagnose a configuration or application problem. To view any diagnostics data: 1. Click the “Diagnostics” tab to view a variety of packet statistics that can be used to diagnose a configuration or application problem.
3.9.1
Figure 3-18 1.
2.
3785_en_A
Communication statistics
“Diagnostics/Communication Statistics” page
Click the “Communication Statistics” tab. The “Communication Statistics” page provides an overview of the activity on each serial and EtherNet/IP ports. The values can be reset to zero at any time by clicking the “Reset Statistics” button. “Serial Interface” group TX byte count: This displays the number of bytes transmitted from the serial port. TX packet count: This displays the number of serial packets transmitted from the serial port. RX byte count: This displays the number of bytes received on the serial port. RX packet count: This displays the number of packets received on the serial port. Parity error count: This displays the number of parity errors dropped due to parity errors. Framing error count: This displays the number of received serial packets dropped due to framing errors. Overrun error count: This displays the number of received serial packets dropped due to overrun error incidents. To PLC dropped packet count: The number of received serial packets that were intended for the PLC but were dropped due to any of the following conditions: no STX byte(s) found, no ETX byte(s) found, a timeout occurred, the packet was too large, or the receive buffer queue overflowed.
PHOENIX CONTACT
37
GW EIP/ASCII...
3.
4.
38
PHOENIX CONTACT
To PLC truncated packet count: Displays the number of received packets that were truncated before being sent to the PLC. TX duplicate sequence errors: The count is incremented when TX sequence number checking is enabled, and the GW EIP/ASCII... receives a transmit message with a sequence number equal to the previous sequence number. It is expected that the sequence number is incremented for each transmit message. TX unexpected sequence errors: This value is incremented when the GW EIP/ASCII... receives a transmit message with a sequence number that is not equal to either the previous transmit sequence number or the previous transmit sequence number plus one. It is expected that the sequence number is incremented for each transmit message. “Ethernet Interface” group TCP connection status: Displays the IP address and port when a socket is opened. TX byte count: The number of bytes transmitted by the GW EIP/ASCII… socket port. TX packet count: The number of packets transmitted by the GW EIP/ASCII… socket port. RX byte count: The number of bytes received by the GW EIP/ASCII… socket port. RX packet count: The number of packets received by the GW EIP/ASCII… socket port. To PLC dropped packet count: Displays the number of dropped packets that were intended for the PLC. To PLC truncated packet count: Displays the number of received packets that were truncated before being sent to the PLC. Rx consumed sequence error count: The count is incremented when using the Write-to-Tag-Sync method of receive communication, a serial packet is received, and the Consumed Sequence number is out of sync. (It is not equal to the Produced Sequence number or equal to the Produced Sequence number minus one.) TX duplicate sequence errors: The count is incremented when TX sequence number checking is enabled, and the GW EIP/ASCII receives a transmit message with a sequence number equal to the previous sequence number. It is expected that the sequence number is incremented for each transmit message. TX unexpected sequence errors: This value is incremented when the GW EIP/ASCII… receives a transmit message with a sequence number that is not equal to either the previous transmit sequence number or the previous transmit sequence number plus one. It is expected that the sequence number is incremented for each transmit message. If desired, click the “Reset Statistics” button to refresh the statistics shown.
3785_en_A
Configuration and startup
3.9.2
PLC interface
The “PLC Interface” page provides diagnostic information about the EtherNet/IP communication to a PLC. The values can be reset to zero at any time by clicking the “Reset Statistics” button.
Figure 3-19
“PLC Interface” page
Active session count: Displays the number of active EtherNet/IP sessions. Sessions support both Class 1 I/O and Class 3 messages, and may be initiated or terminated by the PLC or the GW EIP/ASCII.... Active connections: Displays the current number of Class 1 and Class 3 active connections. Total connections established: Displays the total number of established connections. Connections timed out: Displays the number of connections that have closed due to a time out. Connections closed: Displays the number connections that have closed due to a standard processes. Class 3 messages/responses received: Displays the number of Class 3 messages and responses received from the PLCs. Broadcast messages received: Displays the number of broadcast messages received from the PLCs. Class 3 messages/responses transmitted: Displays the number of Class 3 messages and responses sent to the PLCs. Class 1 output updates from PLC: Displays the number of Class 1 output data updates received from the PLCs. Class 1 input updates to PLC: Displays the number of Class 1 input data updates sent to the PLCs.
3785_en_A
PHOENIX CONTACT
39
GW EIP/ASCII... Client object requests: Displays the number of Class 3 requests to the GW EIP/ASCII... vendor specific objects. Good responses from PLC: Displays the number of good responses from messages sent to PLCs. Bad responses from PLC: Displays the number of bad responses from messages sent to the PLCs. Bad responses are typically returned for such errors as incorrect tag or file names, incorrect tag or file data types, incorrect tag or file data sizes, the PLC is overloaded and cannot handle the amount of Ethernet traffic, or a PLC malfunction. No responses from PLC: Displays the number of no responses from messages sent to the PLCs. No responses are typically returned for such errors as incorrect IP address, incorrect PLC configuration, PLC malfunction, and PLC is overloaded and cannot handle the amount of Ethernet traffic. Invalid network paths: Displays the number of network path errors on messages sent to the PLCs.These are typically caused by incorrect IP address settings. Pending request limit reached: Displays the number of pending request limit errors. These errors occur when the PLC is sending a continuous stream of messages to the GW EIP/ASCII... faster they can be processed. Unexpected events: Displays the number of unexpected event errors, which occur when the GW EIP/ASCII… receives an unexpected message from the PLC such as an unexpected response or unknown message. Unsupported CIP class errors: Displays the number of unsupported CIP request instance errors. These errors occur when a message with an invalid class is received by the GW EIP/ASCII.... Unsupported CIP instance errors: Displays the number of unsupported CIP request instance errors. These errors occur when a message with an invalid instance is received by the GW EIP/ASCII.... Unsupported CIP service errors: Displays the number of unsupported CIP request service errors. These errors occur when a message with an invalid service is received by the GW EIP/ASCII.... Unsupported CIP attribute errors: Displays the number of unsupported CIP request attribute errors. These errors occur when a message with an invalid attribute is received by the GW EIP/ASCII.... Unsupported file errors: Displays the number of messages from the PLCs that attempt to access an unsupported file address. Improper configuration errors: The number of errors that occur when the GW EIP/ASCII... receives a message that cannot be performed due to an invalid configuration. Invalid message data errors: Displays the number of invalid message data errors. These errors occur when the GW EIP/ASCII... receives a message that cannot be performed due to invalid data. System resource errors: These errors indicate a system error on the GW EIP/ASCII... such as an inoperable serial port or a full transmit queue. These errors typically occur when the PLCs are sending data to the GW EIP/ASCII... at a faster rate than the GW EIP/ASCII... can process it. Oversized received data packet errors: The number of received serial or Ethernet data packets that were larger than the configured maximum receive data packet.
40
PHOENIX CONTACT
3785_en_A
Configuration and startup Writes to offline Ethernet device on socket X: The number of write attempts by a PLC to the Ethernet device when the device was offline. First error description: Text description of the first error that occurred. Last error description: Text description of the last or most recent error that occurred.
3.9.3
Serial logs
This page displays the serial messages transmitted and received during normal operation. To view serial log statistics: 1. Click the “Diagnostics” tab. 2. Click the “Serial Log” tab.
Figure 3-20
“Serial Log” page
The log format is as follows: Pkt(N): ddd:hh:mm:ss.mss Rx/Tx>(data) ddd: days since last system restart hh: hours since last system restart mm: minutes since last system restart ss: seconds since last system restart mss: milliseconds since last system restart (data): Modbus/RTU or Modbus/ASCII message data Private messages between the master and slaves on the master/slave ports are indicated as (Private). All other messages are those routed through the Modbus gateway to the Modbus network or shared memory. 3. Click the “Reset Log” button to clear the log.
3785_en_A
PHOENIX CONTACT
41
GW EIP/ASCII...
3.9.4
Ethernet logs
The “Ethernet Logs” page provides a log of received and transmitted Ethernet port messages. Up to 128 bytes per message and up to 128 messages are logged. It is intended to help with debugging Ethernet connectivity problems, determining the proper start and end of transmission bytes, and diagnosing device problems. Click the “Reset Log” button at any time to clear the log.
Figure 3-21
“Ethernet Logs” page
The format is as follows: Pkt(n): ddd:hh:mm:ss.mmm Rx/Tx:
ddd - days since last system restart hh - hours since last system restart mm - minutes since last system restart ss - seconds since last system restart mmm - milliseconds since last system restart - Data packet received. For EtherNet/IP slave data, all data bytes are shown in hexadecimal (xxh) format. For Raw/ASCII and EtherNet/IP/ASCII data, ASCII characters are displayed as characters. Non-ASCII data is displayed in hexadecimal (xxh) format
42
PHOENIX CONTACT
3785_en_A
Configuration and startup
3.10
Maintenance
Click the “Device Maintenance” tab to access the available maintenance functions of the GW EIP/ASCII....
3.10.1
Passwords
To change passwords: 1. Click the “Device Maintenance” page. 2. Click the “Passwords” tab to change the password used to access the web server.
Figure 3-22
3. 4.
3785_en_A
“Password” page
The GW EIP/ASCII... has administrator-level passwords. The administrator-level user may make changes to the configuration. The default user name and password are: User name: Admin Password: admin The “Password” field is case sensitive. The user name is fixed and cannot be modified. Enter the current password and the new password (twice) in the appropriate fields. Click the “Apply Changes” button to save changes.
PHOENIX CONTACT
43
GW EIP/ASCII...
3.10.2
Restore defaults
To restore defaults: 1. From the “Device Maintenance” page, click the “Restore Defaults” tab to return the GW EIP/ASCII... to the original factory defaults, including the IP address.
Figure 3-23 2. 3.
“Restore Defaults” page
Check the “Check the box to confirm...” box. Click the “Apply Changes” button.
Note that the IP address returns to the factory defaults and may require modification to prevent multiple devices on the network from trying to use the same address.
44
PHOENIX CONTACT
3785_en_A
Configuration and startup
3.10.3
Log files
To view log files: 1. From the “Device Maintenance” page, click the “Log Files” tab to review the log files of the device, which can be used for advanced troubleshooting.
Figure 3-24 2.
3785_en_A
“Log Files” page
Click the “Save Logfile” button to save the log as a text file for future use, or review the log in the web browser. The log displays information about the device, such as when a PC created or broke a connection to the GW EIP/ASCII.... The “Device Snapshot” feature allows a user to capture the system log, configuration data, and other information that can be used for advanced troubleshooting or for “As Configured” record keeping as a single text file.
PHOENIX CONTACT
45
GW EIP/ASCII...
3.10.4
Configuration files
For fast and easy commissioning of a replacement unit, or in the event that many devices need the same configuration, it is possible to create and load a configuration file into the GW EIP/ASCII.... To save and load configuration files: 1. From the “Device Maintenance” page, click the “Config Files” tab.
Figure 3-25 2.
3. 4. 5.
“Config Files” page
Enter a password that is used to protect the file. The password prevents unauthorized users from applying the system configuration file to an unapproved node to gain access to the network. Click the “Save Configuration” button to open a dialog box where the file name and storage location on the PC are selected. To load a configuration file to a GW EIP/ASCII..., click the “Browse” button to open a dialog box and browse to the configuration file location on the PC. After selecting the appropriate configuration file, enter the password for the file and click the “Load Configuration” button.
3.10.5
Update firmware
To update firmware: 1. From the “Device Maintenance” page, click the “Update Firmware” tab to install a new version of the firmware.
Figure 3-26
46
PHOENIX CONTACT
“Update Firmware” page
3785_en_A
Configuration and startup
2. 3. 4. 5.
Occasionally, a new version of firmware may be provided to enhance operation of the GW EIP/ASCII.... Download the firmware to a local drive on the connected computer. Click the “Browse” button and navigate to the file in the “Browse” dialog box. Highlight the file to select it, and then click the “Close” button. Click the “Apply Changes” button to install the firmware.
NOTE: Ensure that a reliable power connection is available during the firmware update. Do not restart the module or disconnect the Ethernet cable during this process. When firmware is updated, the device configuration is maintained.
3785_en_A
PHOENIX CONTACT
47
GW EIP/ASCII...
48
PHOENIX CONTACT
3785_en_A
Data message format
4
Data message format The following data message format is used for all interfaces. The ControlLogix interface uses SINT (8-bit bytes) and the MicroLogix/SLC/PLC-5 interface uses 16-bit words for the data arrays. All data is sent to and received from the PLC in little endian format.
4.1
Standard message
4.1.1
Receive data message
The receive data message format contains a sequence number, a length, and a data array. Table 4-1
Receive message data (GW EIP/ASCII... to PLC)
Name
Data type
Data value
Access rule
Produced data sequence number
UINT
0-65535 (FFFFhex)
Read only
Data length (in bytes)
UINT
0-(MSG payload-4)
Read only
Data array
Array of SINT
0-255
Read only
Receive messages have the following characteristics: – The produced data sequence number is incremented when the data is updated. – The data length field indicates the number of valid bytes contained in the message. – The message received from the PLC determines the actual length of the message returned to the PLC. (This is often greater than the length of the actual receive data message.) – All unused bytes in a message returned to the PLC are filled with zeros. – The GW EIP/ASCII... supports serial packets of up 1518 bytes and socket packets up to 2048 bytes in “Write-To-Tag/File transfer to PLC” mode. – For large received data packets, see Section 3.7.2, “EtherNet/IP configuration” and Section 3.8.2, “EtherNet/IP configuration” objects or MicroLogix/SLC/PLC-5 interface.
4.1.2
Transmit data message
The transmit data message format contains a sequence number, a length, and a data array. Table 4-2
3785_en_A
Transmit message data (PLC to GW EIP/ASCII...)
Name
Data type
Data value
Produced data sequence number
UINT
0-65535 (FFFFhex)
Data length (in bytes)
UINT
0-(MSG payload-4)
Data array
Array of SINT
0-255
Access rule
Read/Write
PHOENIX CONTACT
49
GW EIP/ASCII... Transmit messages have the following characteristics: – In “Write MSG from PLC” mode, all messages received from a PLC are transmitted, regardless if the produced data sequence number has changed or not. – For “Class 1 from PLC” mode, messages received from a PLC are only transmitted if the sequence number has changed. – If the “TX MSG Sequence Number Checking” field is checked, produced data sequence numbers that are not incremented from the last transmit message will be identified as errors. Statistics will be provided in the diagnostic pages. – The data length field indicates the number of valid bytes contained in the message. – The actual length of a message received from the PLC may contain extra, unused data. – All unused bytes in a message are ignored. – A “Get” command returns the last successfully transmitted serial/socket packet.
4.2 4.2.1
EtherNet/IP interface profile (ControlLogix) Serial port data transfer object definition (71hex)
The Serial Port Data Transfer vendor-specific object defines the attributes by which the PLC can transfer data to and from a serial port device through a GW EIP/ASCII... over EtherNet/IP. There is one instance of this object per serial port. The instance number corresponds to the associated serial port number on the GW EIP/ASCII.... Port numbers are numbered from one to N.
Table 4-3
50
PHOENIX CONTACT
Serial port data transfer object class attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max instance
UINT
Number of ports on the GW EIP/ASCII...
Get
3
Num instances
UINT
Number of ports on the GW EIP/ASCII...
Get
3785_en_A
Data message format
Table 4-4
Serial port data transfer object instance attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Transmit (PLC to GW EIP/ASCII...) message data Structure of:
2
Produced data UINT sequence number
0-65535 (FFFFhex)
Data length
UINT
1-440
Data array
Array of USINT
0-255
Set/Get
Receive (GW EIP/ASCII... to PLC) message data Structure of:
3
Produced data UINT sequence number
0-65535 (FFFFhex)
Data length
UINT
1-4401
Data array
Array of USINT
0-255
Get
Receive (GW EIP/ASCII... to PLC) produced data sequence number Normally sent to the PLC from the GW EIP/ASCII... in data transfer
5
0-65535 (FFFFhex)
UINT
Set/Get
Transmit (PLC to GW EIP/ASCII...) produced data sequence number Normally sent to the GW EIP/ASCII... from the PLC in data 1
0-65535 (FFFFhex)
UINT
Set/Get
For polling transfer to PLC mode only
The maximum sized serial port message in the “Write-to-Tag” field when set to Transfer to PLC is 1518 bytes.
Table 4-5
3785_en_A
Serial port data transfer object common services
Service code
Implemented in class
Implemented in instance
Service name
0Ehex
Yes
Yes
Get_Attribute_Single
10hex
No
Yes
Set_Attribute_Single
PHOENIX CONTACT
51
GW EIP/ASCII... Table 4-6
Serial port data transfer object instance attribute definitions
Attribute
Description
Attribute 1: Transmit (PLC to GW EIP/ASCII...) Message Data
This attribute transmits data out of a serial port on the GW EIP/ASCII.... In most cases, incrementing the sequence number is optional. However, it is required if the “Transmit Sequence Number Checking” option is enabled. The length must be at least one and a maximum of 440 bytes. A “Get” command returns the last successfully transmitted data message.
Attribute 2: Receive (GW EIP/ASCII... to PLC) Message Data
This attribute provides the receive data while operating in the polling communication method. The GW EIP/ASCII... increments the sequence number for each new serial port packet received. A length of zero indicates no data was received on the specified serial port. Two or more “Get” commands may return the same data packet, but the messages will also have the same sequence number. Serial packets up to 1518 bytes may be received while operating in the “Write-To-Tag” field when set to Transfer to PLC. For serial packets over 440 bytes, the GW EIP/ASCII places the data into a sequence of tags. These tags must meet the following criteria: – Must be of type SINT. – The entire sequence must be large enough to contain the maximum sized receive packet plus four SINTs for the sequence number and length parameters. – All tags, except the last of the sequence, must be 444 SINTs in size. – The tags must have the same base name and numbered in sequence. The first tag is not be numbered, i.e., Com1_RxData, the second tag has a “2” appended, i.e., Com1_RxData2, the third has a “3” appended, i.e., Com1_RxData3, etc. – The sequence number and total length is placed in the first tag and the first tag is the last tag updated. Therefore, once the sequence number is updated, the entire serial packet has been received and the PLC can process the data.
Attribute 3: Receive (GW EIP/ASCII... to PLC) Produced Data Sequence Number
This attribute gets and sets the “Produced Data Sequence” number. This is the same “Produced Data Sequence” number sent to the PLC in all receive communication methods.
Attribute 4: Transmit (PLC to GW EIP/ASCII...) Produced Data Sequence Number
This attribute gets and sets the “Transmit Produced Data Sequence” number. This is the same “Produced Data Sequence” number sent to the GW EIP/ASCII... in the Transmit Message data.
52
PHOENIX CONTACT
3785_en_A
Data message format
4.3
Socket port data transfer definition object (74hex)
The “Socket Port Data Transfer” vendor-specific object defines the attributes by which the PLC can transfer data to and from an Ethernet device, via a socket port through a GW EIP/ASCII... over EtherNet/IP. There is one instance of this object per serial port. The instance number corresponds to the associated serial port number on the GW EIP/ASCII.... Port numbers are numbered from one to N.
Table 4-7
Socket port data transfer object class attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max instance
UINT
Number of ports on the GW EIP/ASCII...
Get
3
Num instances
UINT
Number of ports on the GW EIP/ASCII...
Get
Table 4-8
Socket port data transfer object instance attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Transmit (PLC to GW EIP/ASCII...) message data Structure of:
2
Produced data UINT sequence number
0-65535 (FFFFhex)
Data length
UINT
1-440
Data array
Array of USINT
0-255
Set/Get
Receive (GW EIP/ASCII... to PLC) message data Structure of:
3785_en_A
Produced data UINT sequence number
0-65535 (FFFFhex)
Data length
UINT
1-4401
Data array
Array of USINT
0-255
Get
PHOENIX CONTACT
53
GW EIP/ASCII... Table 4-8
Socket port data transfer object instance attributes [...]
Attribute ID
Name
3
Receive (GW EIP/ASCII... to PLC) produced data sequence number Normally sent to the PLC from the GW EIP/ASCII... in data transfer
5
Data type
Data value
Access rule
0-65535 (FFFFhex)
UINT
Set/Get
Transmit (PLC to GW EIP/ASCII...) produced data sequence number Normally sent to the GW EIP/ASCII... from the PLC in data 1
0-65535 (FFFFhex)
UINT
Set/Get
For polling transfer to PLC mode only
The maximum sized serial port message in the “Write-to-Tag” field when set to Transfer to PLC is 2048 bytes.
Table 4-9
54
PHOENIX CONTACT
Socket port data transfer object common services
Service code
Implemented in class
Implemented in instance
Service name
0Ehex
Yes
Yes
Get_Attribute_Single
10hex
No
Yes
Set_Attribute_Single
3785_en_A
Data message format
Table 4-10
Socket port data transfer object instance attribute definitions
Attribute
Description
Attribute 1: Transmit (PLC to GW EIP/ASCII...) Message Data
This attribute transmits data out of a socket port on the GW EIP/ASCII.... In most cases, incrementing the sequence number is optional. However, it is required if the “Transmit Sequence Number Checking” option is enabled. The length must be at least one and a maximum of 440 bytes. A “Get” command returns the last successfully transmitted data message.
Attribute 2: Receive (GW EIP/ASCII... to PLC) Message Data
This attribute provides the receive data while operating in the polling communication method. The GW EIP/ASCII... increments the sequence number for each new socket port packet received. A length of zero indicates no data was received on the specified socket port. Two or more “Get” commands may return the same data packet, but the messages will also have the same sequence number. Socket packets up to 2048 bytes may be received while operating with the “Write-To-Tag” field set to Transfer to PLC. For serial packets over 440 bytes, the GW EIP/ASCII places the data into a sequence of tags. These tags must meet the following criteria: – Must be of type SINT. – The entire sequence must be large enough to contain the maximum sized receive packet plus four SINTs for the sequence number and length parameters. – All tags, except the last of the sequence, must be 444 SINTs in size. – The tags must have the same base name and numbered in sequence. The first tag is not be numbered, i.e., Com1_RxData, the second tag has a “2” appended, i.e., Com1_RxData2, the third has a “3” appended, i.e., Com1_RxData3, etc. – The sequence number and total length is placed in the first tag and the first tag is the last tag updated. Therefore, once the sequence number is updated, the entire serial packet has been received and the PLC can process the data.
Attribute 3: Receive (GW EIP/ASCII... to PLC) Produced Data Sequence Number
This attribute gets and sets the “Produced Data Sequence” number. This is the same “Produced Data Sequence” number sent to the PLC in all receive communication methods.
Attribute 4: Transmit (PLC to GW EIP/ASCII...) Produced Data Sequence Number
This attribute gets and sets the “Transmit Produced Data Sequence” number. This is the same “Produced Data Sequence” number sent to the GW EIP/ASCII... in the Transmit Message data.
4.4
Informational objects
The following object definitions are included for informational purposes only. While some software packages, such as RSLinx®, make use of these objects, few PLC programmers will have a need to directly access them.
4.4.1
Identity object (01hex, 1 instance)
The “Identity” object provides identification of and general information about the GW EIP/ASCII....
3785_en_A
PHOENIX CONTACT
55
GW EIP/ASCII...
Table 4-11
Identity object class attributes (01hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max class
UINT
1
Get
3
Max instance
UINT
1
Get
4
Maximum number class
UINT
7
Get
5
Maximum number instance
UINT
7
Get
Table 4-12
Identity object instance attributes (01hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Vendor ID
UINT
562 (Phoenix Contact)
Get
2
Device type
UINT
43 (Generic product device)
Get
3
Product code
UINT
As defined by Phoenix Contact
Get
4
Revision (product or software release) Structure of: Major revision
USINT
1 - 127
Get
Minor revision
USINT
1 - 999
Get
5
Status
WORD
See Table 4-13
Get
6
Serial number
UDINT
1 - FFFFFFFFhex
Get
7
Product name
Name length
USINT
Length of string
Get
Name string
STRING
Product name
Get
Structure of:
56
PHOENIX CONTACT
3785_en_A
Data message format
4.4.2
Status word
Table 4-13 shows the Identity object status word. Table 4-13 Status word bit
Setting
Description
0
0
Ownership flag. Does not apply to the GW EIP/ASCII....
1
0
Reserved
2
0
The GW EIP/ASCII... is operating on the default configuration
1
The GW EIP/ASCII... has a configuration other than the default configuration
3
0
Reserved
4-7
0101 (0x50)
Indicates that there is a major fault (either bit 10 or bit 11 is set)
0100 (0x40)
Indicates the stored configuration is invalid
0011 (0x30)
Indicates the system is operational and there are no I/O (Class 1) connections
0110 (0x60)
Indicates the system is operational and there is at least one active I/O (Class 1) connection
0000
Indicates the system is not operational. It may be in any of the following states: system startup, configuration in process, idle, or critical (major) fault
0
No recoverable minor fault. No error history entry reported within the last ten seconds.
1
Recoverable minor fault. The GW EIP/ASCII...has reported an error within the last ten seconds and a major fault has not been detected.
9
1
Unrecoverable minor fault. Does not apply to the GW EIP/ASCII....
10
0
No recoverable major fault
1
A major recoverable fault exists. This is a fault that the GW EIP/ASCII... may be able to recover from by a system reset. If the system does not recover automatically, a system reset message or a power cycle of the GW EIP/ASCII... may be required.
0
No major unrecoverable fault
1
A major unrecoverable fault has occurred in the GW EIP/ASCII.... If the major fault is not corrected with a system reset or a power cycle, contact Phoenix Contact.
0
Reserved
8
11
12-15
3785_en_A
Identity object status word
PHOENIX CONTACT
57
GW EIP/ASCII...
Table 4-14
Identity object common services
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
Yes
Get_Attribute_All
05hex
No
Yes
Reset
0Ehex
Yes
Yes
Set_Attribute_Single
4.4.3
Message router object (02hex)
The “Message Router” object provides a messaging connection point through which a client may address a service to any object or instance residing in the physical device. Table 4-15
Message router object class attributes (02hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max class
UINT
1
Get
3
Max instance
UINT
1
Get
4
Optional attribute list
UINT
2
Get
5
Option service list
UINT
1
Get
6
Maximum number class
UINT
7
Get
7
Maximum number instance
UINT
2
Get
Table 4-16
Message router object instance attributes (02hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Object list
Number
UINT
Number of supported class codes
Get
Classes
Array of UINT
List of supported class codes
Get
Max connections
UINT
128
Get
Structure of:
2
58
PHOENIX CONTACT
3785_en_A
Data message format
Table 4-17
Message router object common services
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
No
Get_Attribute_All
0Ehex
Yes
Yes
Set_Attribute_Single
0Ahex
No
Yes
Multiple_Service_Req
4.4.4
Connection manager object (06hex)
The “Connection Manager” object provides services for connection and connectionless communication. Table 4-18 Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max class
UINT
1
Get
3
Max instance
UINT
1
Get
4
Optional attribute list
UINT
8
Get
6
Maximum number class
UINT
7
Get
7
Maximum number instance
UINT
8
Get
Table 4-19
3785_en_A
Connection manager object class attributes (06hex)
Connection manager object instance attributes (06hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Open requests
UINT
0 - 0xFFFFFFFF
Set/Get
2
Open format rejects
UINT
0 - 0xFFFFFFFF
Set/Get
3
Open resource rejects
UINT
0 - 0xFFFFFFFF
Set/Get
4
Open other rejects
UINT
0 - 0xFFFFFFFF
Set/Get
5
Close requests
UINT
0 - 0xFFFFFFFF
Set/Get
6
Close format requests
UINT
0 - 0xFFFFFFFF
Set/Get
7
Close other requests
UINT
0 - 0xFFFFFFFF
Set/Get
8
Connection timeouts
UINT
0 - 0xFFFFFFFF
Set/Get
PHOENIX CONTACT
59
GW EIP/ASCII...
Table 4-20
Connection manager object common services (06hex)
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
Yes
Get_Attribute_All
02hex
No
Yes
Get_Attribute_All
0Ehex
Yes
Yes
Set_Attribute_Single
10hex
No
Yes
Set_Attribute_Single
4Ehex
–
–
Forward_Close
52hex
–
–
Unconnected_Send
54hex
–
–
Forward_Open
5Ahex
–
–
Get_Connection_Owner
5Bhex
–
–
Large_Forward_Open
4.4.5
Port object (F4hex - 1 instance)
The Port object enumerates the CIP ports on the GW EIP/ASCII.... Table 4-21
Port object class attributes (F4hex - 1 instance)
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max instance
UINT
2
Get
3
Num instances
UINT
2
Get
6
Maximum number class
UINT
9
Get
7
Maximum number instance
UINT
7
Get
8
Entry port
UINT
1
Get
9
All ports
Array of UINT
[0] = 0
Get
[1] = 0 [2] = 1 (vendor specific) [3] = 1 (backplane) [4] = TCP_IP_PORT_TYPE (4) [5] = TCP_IP_PORT_NUM BER (2)
60
PHOENIX CONTACT
3785_en_A
Data message format
Table 4-22
Port object instance attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Port type
UINT
1
Get
2
Port number
UINT
1
Get
3
Port object
16-bit word count in path
UINT
2
Get
Path
Array of UINT
[0] = 6420hex
Get
String length
UINT
10
Get
Port name
Array of UINT
Backplane
Get
Node address
USINT [2]
10hex, 0hex
Get
Structure of:
4
[1] = 0124
Port name Structure of:
7
Table 4-23
Port object common services
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
Yes
Get_Attribute_All
0Ehex
Yes
Yes
Set_Attribute_Single
4.4.6
TCP/IP object (F5hex - 1 instance)
The TCP/IP Interface object provides the mechanism to retrieve the TCP/IP attributes for GW EIP/ASCII.... Table 4-24
3785_en_A
TCP/IP object class attributes (F5hex - 1 instance)
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
1
Get
2
Max instance
UINT
1
Get
3
Num instances
UINT
1
Get
4
Optional attribute list
UINT
4
Get
6
Maximum number class
UINT
7
Get
7
Maximum number instance
UINT
9
Get
PHOENIX CONTACT
61
GW EIP/ASCII...
Table 4-25
TCP/IP object instance attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Status
DWORD
0 = The interface configuration attribute has not been configured
Get
1 = The interface configuration attribute contains configuration obtained from DHCP or nonvolatile storage 2
Configuration capability
DWORD
14hex (DHCP and SETTABLE
Get
3
Configuration control
DWORD
0 = Use stored IP address (static IP address)
Get
2 = DHCP 4
Physical link object Structure of:
5
Path size
UINT
2
Get
Path
Array of USINT
[0] = 20hex
Get
[1] = F6hex
Interface configuration Structure of:
6
IP address
UDINT
IP address
Get
Network mask
UDINT
Network mask
Get
Gateway address
UDINT
Gateway addr
Get
Name server
UDINT
Name server
Get
Name server 2
UDINT
Name server2
Get
Domain name length
UINT
Length of name
Get
Domain name
STRING
Domain name
Get
Host name length
UINT
0 - 15
Set
Host name
STRING
Default = IP address
Set
TTL (Time-to-live) value for IP multicast packets
USINT
1 - 255
Get
Host name Structure of:
8
62
PHOENIX CONTACT
3785_en_A
Data message format Table 4-25
TCP/IP object instance attributes [...]
Attribute ID
Name
Data type
9
IP multicast address configuration
Data value
Access rule
0 = Default algorithm
Set
Structure of: Allocation control
USINT
1 = Configuration
Table 4-26
Reserved
USINT
Default = IP address
Set
Num multicast address
UINT
1 - 32
Set
Start multicast address
UDINT
239.192.1.0 to 239.255.255.255
Set
TCP/IP object common services
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
Yes
Get_Attribute_All
02hex
No
Yes
Set_Attribute_All
0Ehex
Yes
Yes
Get_Attribute_Single
10hex
No
Yes
Set_Attribute_Single
4.4.7
Ethernet Link object (F6hex)
The Ethernet Link object maintains link-specific counters and status information for Ethernet communication on the GW EIP/ASCII.... Table 4-27
Ethernet Link object class attributes (F6hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
3
Get
2
Max instance
UINT
1 = One Ethernet-port models (GW...1E/...)
Get
3 = Two Ethernet-port models (GW...2E/...) 3
Num instance
UINT
1 = One Ethernet-port models (GW...1E/...)
Get
3 = Two Ethernet-port models (GW...2E/...)
3785_en_A
PHOENIX CONTACT
63
GW EIP/ASCII... Table 4-27
Ethernet Link object class attributes (F6hex) [...]
Attribute ID
Name
Data type
Data value
Access rule
4
Optional attribute list
UINT
4
Get
6
Maximum number class
UINT
7
Get
7
Maximum number instance
UINT
10
Get
Table 4-28
Ethernet Link object instance attributes
Attribute ID
Name
Data type
Data value
Access rule
1
Interface speed (current operational speed)
UDINT
10 = 10 Mb
Get
Interface flags (current operational status)
DWORD
2
100 = 100 Mb
Bit 0 = link status (0 = inactive, 1 = active)
Get
Bit 1 = Half/full duplex (0 = half duplex, 2 = full duplex) Bits 2 - 4: 00 = Negotiation in progress 01 = Negotiation failed 02 = Negotiation failed, speed OK 03 = Negotiation success
64
PHOENIX CONTACT
3
Physical address
Array of 6 USINT
MAC address
Get
7
Interface type
USINT
2 = Twisted pair
Get
8
Interface state
USINT
1 = Interface enabled and operational
Get
9
Admin state
USINT
1 = Interface enabled
Get
10
Interface label
USINT16
Length = 1 - 64
Get
Array of USINT
ASCII characters (Default = IP address in xxx.xxx.xxx.xxx format)
3785_en_A
Data message format
Table 4-29
Ethernet Link object common services
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
Yes
Get_Attribute_All
0Ehex
Yes
Yes
Get_Attribute_Single
4.4.8
PCCC object (67hex)
The PCCC object provides the ability to encapsulate, and then transmit and receive PCCC messages between devices on an EtherNet/IP network. This object is used to communicate to MicroLogix, SLC 5/05 and PLC-5 PLCs over EtherNet/IP. The PCCC object does not support class attributes or instance attributes. The PCCC object supports instance 1. Table 4-30
PCCC object common services
Service code
Implemented in class
Implemented in instance
Service name
4Bhex
No
Yes
Execute_PCCC
4.4.8.1
Message structure for “Execute PCCC” object
Table 4-31 Name
Data type
Description
Length
USINT
Length of requester ID
Vendor
UINT
Vendor number of requester
Serial Number
UDINT
ASA serial number of requester
CMD
USINT
Command byte
STS
USINT
0
TNSW
UINT
Transport word
FNC
USINT
Function code
PCCC_params
Array of USINT
CMD/FMC specific parameters
Table 4-32
3785_en_A
Message structure for message name requests
Message structure for message name responses
Name
Data type
Description
Length
USINT
Length of requester ID
Vendor
UINT
Vendor number of requester
Serial Number
UDINT
ASA serial number of requester
CMD
USINT
Command byte
STS
USINT
Status byte
PHOENIX CONTACT
65
GW EIP/ASCII... Table 4-32
Message structure for message name responses [...]
Name
Data type
Description
TNSW
UINT
Transport word - Same value as request.
EXT_STS
USINT
Extended status (if error)
PCCC_params
Array of USINT
CMD/FMC specific result data
Table 4-33
Supported PCCC command types
Types
FNC
Description
0Fhex
67hex
PLC-5 typed write
0Fhex
68hex
PLC-5 typed read
0Fhex
A2hex
SLC 500 protected typed read with three address fields
0Fhex
AAhex
SLC 500 protected typed write with three address fields
4.4.9
Assembly object (for Class 1 interface)
The “Assembly Object” interface is used to directly tie vendor-specific objects to a standard interface that the EtherNet/IP PLC uses to communicate to the device. The “Assembly Object” corresponds to the “Serial and Socket Data Transfer Objects” for the GW EIP/ASCII.... Each instance of the “Assembly Object” corresponds to one or more of the “Serial and/or Socket Data Transfer Object” attributes. The “Assembly Object” defines the interface by which a Class 1 PLC can request the receive data packets from and write the transmit data to the GW EIP/ASCII.... Table 4-34
Assembly object class attributes (F6hex)
Attribute ID
Name
Data type
Data value
Access rule
1
Revision
UINT
3
Get
2
Max instance
UINT
110 = One-port models (GW EIP/ASCII.../1DB9)
Get
112 = Two-port models (GW EIP/ASCII.../2DB9) 116 = Four-port models (GW EIP/ASCII.../4DB9) 3
Num instance
UINT
4 = One-port models (GW EIP/ASCII.../1DB9)
Get
8 = Two-port models (GW EIP/ASCII.../2DB9) 16 = Four-port models (GW EIP/ASCII.../4DB9)
66
PHOENIX CONTACT
3785_en_A
Data message format
Table 4-35
Assembly object instance attributes
Attribute ID
Name
Data type
Data value
Access rule
3
Data
Array of BYTE
0 - 255
Set/Get
4
Data length
UINT
Maximum number of bytes in attribute 3
Get
Table 4-36
Assembly object instance attribute definitions
Attribute
Description
3
Dependent on the instance number, this is either the PDI data block and/or the PDO data block
4
This is the maximum data length for each “Assembly” object instance
Table 4-37
Assembly object common services
Service code
Implemented in class
Implemented in instance
Service name
01hex
Yes
Yes
Get_Attribute_All
02hex
No
No
Set_Attribute_All
0Ehex
Yes
Yes
Get_Attribute_Single
10hex
No
Yes
Set_Attribute_Single
4.4.9.1
Instance definitions for one-port devices (GW.../1DB9)
Input assembly instances: Input assembly instances are grouped into one continuous array between the instances. One or more input instances may be read with one I/O connection. For example, if addressing instance 101, all input instances for both serial and socket data, 101 and 105, may be read in one connection. The length of the read (input) connection may range from 1 to the total length for all input instances. Multiple controllers may access the input assembly instances simultaneously. Table 4-38
Input assembly instance attributes
Assembly instance number
Name
Data type
Data value
Access rule
101
Receive data from serial port 1
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
Receive data from socket port 1 105
Receive data from socket port 1
Output assembly instances: Output assembly instances are grouped into one continuous array. One or more output instances may be written to with one connection. The write may begin at either instance 109 or 113, and the length of the write may range from the length of the initial output instance or up to the total length of the remaining output instances. For
3785_en_A
PHOENIX CONTACT
67
GW EIP/ASCII... example, the write may begin at output instance 109 and be the length of output instance 109, or begin at instance 109 with a length of output instances 109 and 113. Only one controller may access the output assembly instance at a time. Table 4-39
Output assembly instance attributes
Assembly instance number
Name
Data type
Data value
Access rule
109
Transmit data to serial port 1
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
Transmit data to socket port 1 113
Transmit data to socket port 1 4.4.9.2
Instance definitions for two-port devices (GW.../2DB9)
Input assembly instances: Input assembly instances are grouped into one continuous array between the instances. One or more input instances may be read with one I/O connection. For example, if addressing instance 101, all input instances for both serial and socket data, 101, 102, 105, and 106, may be read in one connection. The length of the read (input) connection may range from 1 to the total length for all input instances. Multiple controllers may access the input assembly instances simultaneously. Table 4-40
Input assembly instance attributes
Assembly instance number
Name
Data type
Data value
Access rule
101
Receive data from serial ports 1 to 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
Receive data from socket ports 1 to 2 102
Receive data from serial port 2 Receive data from socket ports 1 to 2
105
Receive data from socket ports 1 to 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
106
Receive data from socket port 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
Output assembly instances: Output assembly instances are grouped into one continuous array. One or more output instances may be written to with one connection. The write may begin at any instance from 109 to 114, and the length of the write may range from the length of the initial output instance or up to the total length of the remaining output instances. For example, the write may begin at output instance 109 and be the length of output instance 109, or begin at instance 109 with a length of output instances 109, 110, 113, and 114. Only one controller may access the output assembly instance at a time.
68
PHOENIX CONTACT
3785_en_A
Data message format
Table 4-41
Output assembly instance attributes
Assembly instance number
Name
Data type
Data value
Access rule
109
Transmit data to serial ports 1 to 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
Transmit data to socket ports 1 to 2 110
Transmit data to serial port 2 Transmit data to socket ports 1 to 2
113
Transmit data to socket ports 1 to 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
114
Transmit data to socket port 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
4.4.9.3
Instance definitions for four-port devices (GW.../4DB9)
Input assembly instances: Input assembly instances are grouped into one continuous array between the instances. One or more input instances may be read with one I/O connection. For example, if addressing instance 101, all input instances for both serial and socket data, 101, 102, 103, 104, 105, 106, 107, and 108, may be read in one connection. The length of the read (input) connection may range from 1 to the total length for all input instances. Multiple controllers may access the input assembly instances simultaneously. Table 4-42
Input assembly instance attributes
Assembly instance number
Name
Data type
Data value
Access rule
101
Receive data from serial port 1
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
102
Receive data from serial port 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
103
Receive data from serial port 3
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
104
Receive data from serial port 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
105
Receive data from socket port 1
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
106
Receive data from socket port 2
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
107
Receive data from socket port 3
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
108
Receive data from socket port 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Get
3785_en_A
PHOENIX CONTACT
69
GW EIP/ASCII... Output assembly instances: Output assembly instances are grouped into one continuous array. One or more output instances may be written to with one connection. The write may begin at any instance from 109 to 116, and the length of the write may range from the length of the initial output instance or up to the total length of the remaining output instances. For example, the write may begin at output instance 109 and be the length of output instance 109, or begin at instance 109 with a length of output instances 109, 110, 111, 112, 113, 114, 115, and 116. Only one controller may access the output assembly instance at a time. Table 4-43
Output assembly instance attributes
Assembly instance number
Name
Data type
Data value
Access rule
109
Transmit data to serial ports 1 to 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
Transmit data to socket ports 1 to 4 110
Transmit data to serial ports 2 to 4 Transmit data to socket ports 1 to 4
111
Transmit data to serial ports 3 to 4 Transmit data to socket ports 1 to 4
112
Transmit data to serial port 4 Transmit data to socket ports 1 to 4
113
Transmit data to socket ports 1 to 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
114
Transmit data to socket ports 2 to 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
115
Transmit data to socket ports 3 to 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
116
Transmit data to socket port 4
BYTE array length = (4 + maximum RX packet size)
0 - 255
Set
70
PHOENIX CONTACT
3785_en_A
MicroLogix, SLC, and PLC-5 interface
5
MicroLogix, SLC, and PLC-5 interface The MicroLogix, SLC, and PLC-5 interface supports polling and write-to-file receive communication, PLC writes transmit communication, or PCCC-based messages transferred by means of the PCCC objects including: – SLC Typed Read Message – SLC Typed Write Message – PLC-5 Typed Read Message (logical ASCII address format) – PLC-5 Typed Write Message (logical ASCII address format) The “Write-to-Tag/File” field in the “Transfer mode to PLC” supports transfers up serial data packet transfers up to 1518 bytes for serial data and 2048 bytes for socket connections. Message rates are controlled by setting the “Maximum PLC update rate” field. Class 1 is not supported when the PLC type is set to MicroLogix. Since the MicroLogix, SLC, and PLC-5 controllers operate on a file memory system, the Write to Tag/File must be selected in the “Transfer mode to PLC” field. When operating in Write to Tag/File mode, the PLC type must be set to MicroLogix. When configuring the GW EIP/ASCII... to operate in Write to Tag/File mode, enter the file name starting with the standard file format, i.e., N10:0. Polling is performed through the PLC-5/SLC-specific messages instead of accessing the “Serial Port Data Transfer” object. The maximum serial and socket port packet sizes in polling mode are smaller due to PCCC-message size limitations. It is recommended to use the “Write to Tag/File” option in conjunction with the “Maximum PLC Update Rate” option to send data to a MicroLogix, SLC, or PLC-5 controller. While ControlLogix PLCs support the SLC and PLC-5 messages, using those messages on ControlLogix PLCs is not recommended due to data size and performance considerations.
5.1
Requirements
The MicroLogix, SLC or PLC-5 controller must support EtherNet/IP, multihop, and ControlLogix devices. Table 5-1 lists PLC and firmware that meet these requirements. NOTE: Older versions of the PLC firmware may or may not provide EtherNet/IP functionality. Always verify compatibility that older versions of the PLC firmware provide EtherNet/IP functionality before using it with a GW EIP/ASCII... device. To update PLC firmware, contact your Rockwell distributor.
3785_en_A
PHOENIX CONTACT
71
GW EIP/ASCII... Table 5-1
Product list
Models
Catalog numbers
Required firmware version for EtherNet/IP compatibility
SLC 5/05
1747-L551
Series A: FRN 5 or later
1747-L552, 1747-L553
Series C: FRN 3 or later
Ethernet PLC-5
1785-L20E, 1785-L40E, 1785-L80E
Base EtherNet/IP functionality: – Series C: Revision N or later – Series D: Revision E or later – Series E: Revision D or later Full EtherNet/IP compliance: – Series C: Revision R or later – Series D: Revision H or later – Series E: Revision G or later
Enhanced PLC-5 attached to Ethernet module
ControlNet PLC-5 attached to Ethernet module
Ethernet module
785-L11B, 1785-L20B
Series B: Revision N.1 or later
1785-L30B, 1785-L40B
Series C: Revision N or later
1785-L40L, 1785-L60B
Series D: Revision E or later
1785-L60L, 1785-L80B
Series E: Revision D or later
1785-L30C15
Series C: Revision N or later
1785-L40C15
Series D: Revision E or later
1785-L60C15
Series E: Revision D or later
1785-L80C15
All revisions
1785-Enet
Series B: Base EtherNet/IP functionality: – All revisions Full EtherNet/IP compliance: – Revision D or later
72
PHOENIX CONTACT
3785_en_A
MicroLogix, SLC, and PLC-5 interface
5.2
Messages
The PLC-5 and SLC PLCs support the following PCCC messages. MicroLogix PLCs typically support only the SLC-type messages. Table 5-2
PCCC message types
Message type
PCCC message ID
Maximum message size
Maximum serial packet size
SLC typed read
162
CLX: 242 SINTs (121 INTs)
CLX: 238 SINTs (119 INTs)
SLC: 206 SINTs (103 INTs)
SLC: 202 SINTs (101 INTs)
PLC-5: 240 SINTs (120 INTs)
PLC-5: 236 SINTs (118 INTs)
CLX: 220 SINTs (110 INTs)
CLX: 216 SINTs (108 INTs)
SLC: 206 SINTs (103 INTs)
SLC: 202 SINTs (101 INTs)
SLC typed write
PLC-5 typed read
PLC-5 typed write
170
104
103
5.3
PLC-5: 238 SINTs (119 INTs)
PLC-5: 234 SINTs (117 INTs)
CLX: 234 SINTs (117 INTs)
CLX: 230 SINTs (115 INTs)
SLC: 252 SINTs (126 INTs)
SLC: 248 SINTs (124 INTs)
PLC-5: 238 SINTs (119 INTs)
PLC-5: 234 SINTs (117 INTs)
CLX: 226 SINTs (113 INTs)
CLX: 222 SINTs (111 INTs)
SLC: 226 SINTs (113 INTs)
SLC: 222 SINTs (111 INTs)
PLC-5: 224 SINTs (112 INTs)
PLC-5: 220 SINTs (110 INTs)
File addressing
PLC-5 and SLC messages should be addressed in the following manner. Table 5-3
PLC-5 and SLC message addressing
Serial port number
Receive data
Receive data produced sequence number
Transmit data
Transmit data sequence number
1
N10:0
N10:128
N11:0
N11:128
2
N20:0
N20:128
N21:0
N21:128
3
N30:0
N30:128
N31:0
N31:128
4
N40:0
N40:128
N41:0
N41:128
Socket port number
Receive data
Receive data produced sequence number
Transmit data
Transmit data sequence number
1
N50:0
N50:128
N51:0
N51:128
2
N60:0
N60:128
N61:0
N61:128
3
N70:0
N70:128
N71:0
N71:128
4
N80:0
N80:128
N81:0
N81:128
3785_en_A
PHOENIX CONTACT
73
GW EIP/ASCII...
5.4
Receive data message
When connecting to MicroLogix, PLC-5, and SLC PLCs, “Receive Data” messages are formatted in 16-bit integer format. Table 5-4
Receive data message format
Name
Data type
Data value
Access rule
Product data sequence number
UINT
0 - 65535 (FFFFhex)
Read/Write
Data length (bytes)
UINT
0 - 222 (SLC), 0 - 248 PLC-5)
Read/Write
Data array
Array of UINT
0 - 65535
Read/Write
Structure of:
5.4.1
Received message characteristics
Received messages return all data in UINTs. The data length field indicates the number of valid bytes contained in the message. Messages received from the PLC determine the actual length of the message returned to the PLC. This is often greater than the length of the actual “Receive Data” message. All unused bytes in a message returned to the PLC are filled with zeros. The default order of the bytes is least significant byte first. The GW EIP/ASCII... supports serial packets of up 1518 bytes and socket packets up to 2048 bytes when Write to Tag/File is selected in the “Transfer mode to PLC” field. When large packets of data are received, the data is automatically placed in sequential files. The files must be 256 integers in size with the exception of the last file. The last file may be shorter than 256 integers as long as the total length of all files in the sequence is sufficient to hold the largest receive packet, plus two integers for the sequence number and length parameters. The sequence number is updated when all data is transferred to the PLC.
74
PHOENIX CONTACT
3785_en_A
MicroLogix, SLC, and PLC-5 interface
5.5
Transmit data message
When connecting to MicroLogix, PLC-5, and SLC PLCs, transmit data messages are formatted in 16-bit integer format. Table 5-5
Transmit data message format
Name
Data type
Data value
Access rule
Product data sequence number
UINT
0 - 65535 (FFFFhex)
Read/Write
Data length (bytes)
UINT
1 - 202 (SLC), 1 - 222 PLC-5)
Read/Write
Data array
Array of UINT
0 - 65535
Read/Write
Structure of:
5.5.1
Transmit message characteristics
Transmit messages return all data in UINTs. The data length field indicates the number of valid bytes contained in the message. The actual length of a message received from the PLC may contain extra, unused data. All unused bytes in a message are ignored. The default order of the bytes is least significant byte first. A “Get” command returns the last successfully transmitted serial/socket packet.
5.6
Sequence number messages
PLC-5 and SLC typed read and typed write messages can read and modify both receive and transmit produced data sequence numbers. These are the same sequence numbers returned to the PLC in the “Receive Data” message and sent to the GW EIP/ASCII... in the “Transmit Data” message. Access to these sequence numbers are provided primarily for initialization purposes at the start of the PLC program to initialize the sequence numbers on the PLC, GW EIP/ASCII..., or both.
3785_en_A
PHOENIX CONTACT
75
GW EIP/ASCII...
5.7
Receive communication methods
The GW EIP/ASCII... transfers received data to a MicroLogix, SLC, and PLC-5 controller using the “Write to Tag/File” or “Polling” option.
5.7.1
Write to Tag/File - Unsolicited message
The “Write to Tag/File” option requires the least amount of programming and is the recommended method to transmit data to a controller. When the GW EIP/ASCII... receives a serial or socket packet, the data packet is immediately written to a file data location on the PLC. The “Receive Data File” name must be the same file name and offset defined to receive data on the PLC. The file on the PLC must be of integer type and must be of sufficient size to contain the sequence number, length, and data field associated with the maximum sized received data structure. The sequence number is incremented when new data is received. The “Maximum PLC Update Rate” setting may need to be increased in order to ensure the PLC program processes the data before the message is overwritten by the next incoming message.
5.7.2
Polling
The “Polling” option allows the PLC to periodically request data from the GW EIP/ASCII.... The serial or socket data is returned in the response to the data request message. The file on the PLC must be of integer type and must be of sufficient size to contain the sequence number, length, and data field associated with the maximum sized received data structure. New data is indicated with an incremented sequence number. The same data may be returned more than once. However, the same data packet also returns the same sequence number. No data is indicated with a length of zero. While the GW EIP/ASCII... queues received serial port data, the PLC program must poll for new data faster than the data can be received on the serial port to ensure the receive queues on the GW EIP/ASCII... do not overflow. For example, if two packets can be received per second on the serial port, then the polling rate would need to be at least once every 500 ms.
76
PHOENIX CONTACT
3785_en_A
Troubleshooting
6
Troubleshooting 6.1
Resetting the device
If, for some reason, the module needs to be reset to factory settings, there are two methods available: hardware reset and software reset.
6.1.1
Hardware reset
The reset button allows resetting the device without the use of a PC. To force a hardware reset: 1. With the device powered off, press and hold the reset button. Apply power and hold the reset button for at least five seconds. Reinitializing the module and firmware reset may take some time. Do not disconnect from power (see Section 1.1, “Structure” for the location of the reset button on the GW EIP/ASCII...). 2. After a successful reset, the module returns to the factory default address (192.168.254.254).
6.1.2
Software reset
To force a software reset: 1. Start the web server and navigate to the “Device Maintenance/Restore Defaults” page. 2. Click the check box on the page. 3. Click the “Apply Changes” button. 4. After a successful reset, the module returns to the factory default address (192.168.254.254).
6.2
LEDs
Table 6-1
LEDs
LED
Color
Meaning
STATUS
Green
The STATUS LED flashes while the device is booting (approximately 15 seconds). After booting, the LED blinks approximately every ten seconds. An internal error is indicated by three flashes every five seconds.
1
3785_en_A
Green
Link LED. On indicates Ethernet network is connected.1
Yellow
Activity LED. Flashing indicates data transfer activity.1
LEDs on Ethernet ports are not labeled. See Section 1.1, “Structure” for LED location.
PHOENIX CONTACT
77
GW EIP/ASCII...
78
PHOENIX CONTACT
3785_en_A
EDS files
7
EDS files It is not necessary to add the GW EIP/ASCII... to RSLinx for normal communication. However, it is easy to add the GW EIP/ASCII... and its associated electronic data sheet (EDS) files to RSLinx. The EDS files can be downloaded from phoenixcontact.com. EDS files and the associated icons are included in the self-installing file (MSI). They are copied to the Phoenix Contact/ EtherNetIP directory when the MSI file is executed.
7.1 1. 2. 3. 4. 5. 6. 7.
Add the GW EIP/ASCII... to RSLinx
Open RSLinx. From the “Communications” menu, click the “Configure Drivers” option. From the “Available Drivers” menu, click the “Remote Devices via Linx Gateway” option. Click the “Add New” button. Use the default driver name or type your own driver name in the “Name” field. Click the “OK” button to continue. Type the IP address for the device in either the “Server’s IP Address” or “Hostname” field, and then click the “OK” button. Click the “RSWho” button to verify that RSLinx can communicate with the GW EIP/ASCII....
A yellow question mark appears by the GW EIP/ASCII... in the RSWho window when the associated EDS file(s) are not installed.
7.2 1. 2. 3.
4. 5.
Add the EDS file to RSLinx
Open the EDS Hardware Installation Tool (Select Start > All Programs > Rockwell Software > RSLinx Tools). Click the “Add” button. Click the “Register” button to open a browse window. Navigate to the Phoenix Contact/EtherNetIP directory, highlight the desired file, and then click the “Next” button to continue. Verify that there is a green check mark beside each EDS file name and click the “Next” button to continue. To change the icons, perform the following tasks. a) Select a GW EIP/ASCII.... b) Click the “Change” icon. c) Browse to the Phoenix Contact/EtherNetIP directory, and then select the icon associated with the GW EIP/ASCII....
You may also select your own icon stored elsewhere. 6. 7.
3785_en_A
Click the “Next” button to continue. Click the “Finish” button to exit.
PHOENIX CONTACT
79
GW EIP/ASCII...
7.3
Troubleshooting RSLinx
If RSLinx does not display the device after adding a GW EIP/ASCII... and the EDS files to RSLinx, perform the following procedure: 1. Navigate to the “File/Exit” menu, and then click the “Shutdown” option to exit and shutdown RSLinx. 2. Remove the following files from the hard drive: Program Files\Rockwell Software\RSCOMMON\Harmony.hrc Program Files\Rockwell Software\RSCOMMON\Harmony.rsh 3. Restart RSLinx. The GW EIP/ASCII... devices should now appear with the associated icons.
80
PHOENIX CONTACT
3785_en_A
A Appendixes A1
List of figures
Section 1 Figure 1-1:
GW EIP/ASCII 1E/1DB9 ....................................................................... 6
Figure 1-2:
GW EIP/ASCII 1E/2DB9 ....................................................................... 7
Figure 1-3:
GW EIP/ASCII 2E/2DB9 ....................................................................... 8
Figure 1-4:
GW EIP/ASCII 2E/4DB9 ....................................................................... 9
Figure 2-1:
DIN rail mounting ................................................................................ 11
Figure 2-2:
DIN rail removal .................................................................................. 12
Figure 2-3:
Pin 1 location ...................................................................................... 14
Figure 2-4:
Single power supply connection ......................................................... 16
Figure 2-5:
Redundant power supply connection .................................................. 16
Figure 3-1:
“Login” screen ..................................................................................... 17
Figure 3-2:
“Home” screen .................................................................................... 18
Figure 3-3:
“General Settings” page ...................................................................... 19
Figure 3-4:
“LAN Settings/IP Address” page ......................................................... 20
Figure 3-5:
“LAN Settings/Security” page ............................................................. 21
Figure 3-6:
“LAN Settings/EtherNet/IP Stack” page .............................................. 22
Figure 3-7:
“Serial Settings/Overview” page ......................................................... 23
Figure 3-8:
“Serial Settings/Port 1 Configuration/Serial Port Configuration” page . 24
Figure 3-9:
“Serial Port Configuration” dialog box ................................................. 24
Figure 3-10:
“Raw/ASCII Serial Packet Delimiiters” dialog box ............................... 25
Figure 3-11:
“EtherNet/IP configuration” page ........................................................ 27
Figure 3-12:
“Class 1 Overview” page ..................................................................... 29
Figure 3-13:
“Socket/Settings Overview” page ....................................................... 30
Figure 3-14:
“Socket Settings/Socket Configuration/TCP Configuration” page ....... 31
Figure 3-15:
“TCP Interface Configuration” group ................................................... 31
Figure 3-16:
“Socket settings/Socket 1 Configuration/EtherNet/IP configuration” page .................................................................................................... 33
Section 2
Section 3
3785_en_A
PHOENIX CONTACT
81
GW EIP/ASCII...
82
PHOENIX CONTACT
Figure 3-17:
“Class 1 Overview” page ..................................................................... 36
Figure 3-18:
“Diagnostics/Communication Statistics” page .................................... 37
Figure 3-19:
“PLC Interface” page ........................................................................... 39
Figure 3-20:
“Serial Log” page ................................................................................ 41
Figure 3-21:
“Ethernet Logs” page .......................................................................... 42
Figure 3-22:
“Password” page ................................................................................ 43
Figure 3-23:
“Restore Defaults” page ...................................................................... 44
Figure 3-24:
“Log Files” page .................................................................................. 45
Figure 3-25:
“Config Files” page ............................................................................. 46
Figure 3-26:
“Update Firmware” page ..................................................................... 46
3785_en_A
B2
List of tables
Section 1 Table 1-1:
GW EIP/ASCII... types ........................................................................... 5
Table 1-2:
GW EIP/ASCII 1E/1DB9 structure ......................................................... 6
Table 1-3:
GW EIP/ASCII 1E/2DB9 structure ......................................................... 7
Table 1-4:
GW EIP/ASCII 2E/2DB9 structure ......................................................... 8
Table 1-5:
GW EIP/ASCII 2E/4DB9 structure ......................................................... 9
Table 2-1:
D-SUB 9 to RS-232 pin out .................................................................. 13
Table 2-2:
D-SUB 9 to RS-422 and RS-485 pin out .............................................. 14
Table 4-1:
Receive message data (GW EIP/ASCII... to PLC) ............................... 49
Table 4-2:
Transmit message data (PLC to GW EIP/ASCII...) .............................. 49
Table 4-3:
Serial port data transfer object class attributes .................................... 50
Table 4-4:
Serial port data transfer object instance attributes ............................... 50
Table 4-5:
Serial port data transfer object common services ................................ 51
Table 4-6:
Serial port data transfer object instance attribute definitions................ 52
Table 4-7:
Socket port data transfer object class attributes .................................. 53
Table 4-8:
Socket port data transfer object instance attributes ............................. 53
Table 4-9:
Socket port data transfer object common services .............................. 54
Table 4-10:
Socket port data transfer object instance attribute definitions.............. 54
Table 4-11:
Identity object class attributes (01hex).................................................. 55
Table 4-12:
Identity object instance attributes (01hex)............................................. 55
Table 4-13:
Identity object status word ................................................................... 56
Table 4-14:
Identity object common services.......................................................... 57
Table 4-15:
Message router object class attributes (02hex) .................................... 57
Table 4-16:
Message router object instance attributes (02hex) ............................... 57
Table 4-17:
Message router object common services ............................................ 58
Table 4-18:
Connection manager object class attributes (06hex) ............................ 58
Table 4-19:
Connection manager object instance attributes (06hex) ....................... 58
Table 4-20:
Connection manager object common services (06hex) ........................ 59
Table 4-21:
Port object class attributes (F4hex - 1 instance) ................................... 59
Table 4-22:
Port object instance attributes ............................................................. 60
Section 2
Section 4
3785_en_A
PHOENIX CONTACT
83
GW EIP/ASCII... Table 4-23:
Port object common services............................................................... 60
Table 4-24:
TCP/IP object class attributes (F5hex - 1 instance)............................... 60
Table 4-25:
TCP/IP object instance attributes......................................................... 61
Table 4-26:
TCP/IP object common services.......................................................... 62
Table 4-27:
Ethernet Link object class attributes (F6hex) ........................................ 62
Table 4-28:
Ethernet Link object instance attributes ............................................... 63
Table 4-29:
Ethernet Link object common services ................................................ 64
Table 4-30:
PCCC object common services ........................................................... 64
Table 4-31:
Message structure for message name requests .................................. 64
Table 4-32:
Message structure for message name responses ............................... 64
Table 4-33:
Supported PCCC command types....................................................... 65
Table 4-34:
Assembly object class attributes (F6hex).............................................. 65
Table 4-35:
Assembly object instance attributes .................................................... 66
Table 4-36:
Assembly object instance attribute definitions ..................................... 66
Table 4-37:
Assembly object common services...................................................... 66
Table 4-38:
Input assembly instance attributes....................................................... 66
Table 4-39:
Output assembly instance attributes.................................................... 67
Table 4-40:
Input assembly instance attributes....................................................... 67
Table 4-41:
Output assembly instance attributes.................................................... 68
Table 4-42:
Input assembly instance attributes....................................................... 68
Table 4-43:
Output assembly instance attributes.................................................... 69
Table 5-1:
Product list........................................................................................... 72
Table 5-2:
PCCC message types ......................................................................... 73
Table 5-3:
PLC-5 and SLC message addressing.................................................. 73
Table 5-4:
Receive data message format ............................................................. 74
Table 5-5:
Transmit data message format ............................................................ 75
Table 6-1:
LEDs.................................................................................................... 77
Section 5
Section 6
84
PHOENIX CONTACT
3785_en_A
