EtherNet®/IP User Guide
Trademark Notices Comtrol, DeviceMaster, and PortVision are registered trademarks of Comtrol Corporation. ControlLogix, PLC-5 and Rockwell Automation are registered trademarks of Rockwell Automation. MicroLogix, RSLinx, RSLogix 5, RSLogix 500, RSLogix 5000 and SLC are trademarks of Rockwell Automation. PLC is a registered trademark of Allen-Bradley Company, Inc. Ethernet is a registered trademark of Digital Equipment Corporation, Intel, and Xerox Corporation.
Table of Contents Chapter 1. Introduction ........................................................................................................7 1.1. Audience ................................................................................................................................................... 7 1.2. Product Overview .................................................................................................................................. 7 1.3. EtherNet/IP Firmware ..................
Table of Contents 2.3.6. Informational Objects..................................................................................................................... 50 2.3.6.1. Identity Object (01 Hex, 1 instance)..................................................................................... 50 2.3.6.1.1. Class Attributes...............................................................................................................50 2.3.6.1.2. Instance Attributes ......................................
Table of Contents 3.7. Edit Network Configuration Page.................................................................................................... 82 3.8. Edit Security Configuration Page .................................................................................................... 83 3.8.1. Client Authentication ..................................................................................................................... 84 3.8.2. Configuring Security .................................
Table of Contents 5.4.6. RSLogix 500 Screen Examples - SLC PLC.................................................................................. 123 5.4.6.1. Setting up Processor and Ethernet (Channel 1)................................................................ 123 5.4.6.2. SLC Typed Read - Receive Data Message - SLC PLC....................................................... 126 5.4.6.3. SLC Typed Write - Transmit Data Message - SLC PLC................................................... 127 5.4.6.4.
Chapter 1.
EtherNet/IP Firmware 1.3. EtherNet/IP Firmware The following subsections provides information for existing users who may or may not want to update systems with the enhanced EtherNet/IP firmware V3.x. For new users, the following subsections provide EtherNet/IP system architecture information. 1.3.1. Traditional EtherNet/IP System Architecture (Firmware V2.x) EtherNet/IP firmware V2.x provided a traditional EtherNet/IP interface to devices through a raw/ASCII serial interface as illustrated.
Filtering and Data Extraction Functionality (Patent Pending) 1.3.3. Filtering and Data Extraction Functionality (Patent Pending) EtherNet/IP firmware 3.x provides the following filtering and data extraction functionality: • • • Filtering - String Filtering of up to 128 bytes of raw/ASCII data to both the PLC and/or application. - RFID filtering of EPCglobal formatted RFID tag data to both the PLC and/or application.
Locating the Latest Software and Documents 1.4. Locating the Latest Software and Documents You can use the links in this table to check for updated software or documentation.
EtherNet/IP Application Setup 1.5. EtherNet/IP Application Setup Before you can configure the EtherNet/IP firmware on the DeviceMaster UP, you must have previously performed the following steps: • Install the hardware • Install PortVision DX • If necessary, upload the EtherNet/IP firmware using PortVision DX Note: Models that have EtherNet/IP loaded on the DeviceMaster UP are identified in PortVision DX and the DeviceMaster UP is labeled accordingly.
EtherNet/IP Application Setup 12 - Chapter 1. Introduction DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev.
Chapter 2. Programming Interface 2.1. Overview The DeviceMaster UP provides an EtherNet/IP interface to: • Transmit and receive raw/ASCII serial and socket (Ethernet device) data • Filtering of the data • Extraction of RFID and barcode parameters • A connection to an optional application via a TCP/IP socket The DeviceMaster UP provides EtherNet/IP connectivity to the entire ControlLogix family of PLCs as well as the SLC, PLC-5, and MicroLogix PLCs. 2.1.1.
What is EtherNet/IP? 2.1.3. What is EtherNet/IP? EtherNet/IP is an industrial application layer protocol for industrial automation applications. The IP stands for ‘Industrial Protocol’. Built on the standard TCP/IP protocols, it uses long established Ethernet hardware and software to define an application layer protocol for configuring access and controlling industrial automation devices. EtherNet/IP classifies Ethernet nodes as predefined device types with specific behaviors.
Class Attributes 2.3.1.1. Class Attributes Attribute ID 1 2 3 Name Revision Max Instance Num Instances Data Type UINT UINT UINT Data Value(s) Access Rule 1 Get Number of ports on the DeviceMaster UP Get Number of ports on the DeviceMaster UP Get 2.3.1.2. Instance Attributes Note: Get returns the last command sent.
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule PLC Transmit STX Append Value Structure of: Length USINT 0,1,2 (0=No STX) 10 (Default=0 No STX) Value1 (Only valid if Length USINT not zero) Value2 (Only valid if USINT Length=2) PLC Transmit ETX Append Value Structure of: Length USINT 0 to 255 Set/Get 0 to 255 0,1,2 (0=No ETX) (Default=0) 11 (Default=0) 12 Value1 (Only valid if Length USINT not zero) 0 to 255 Value2 (Only valid if Length=2) Reserved Receive STX De
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule 01 Hex = Strip received STX/ETX characters to the PLC 02 Hex = Discard received packets with errors 04 Hex = (PLC-5/SLC) Rx MS Byte First 16 (Default=03) WORD Serial Port Transfer Options (bitwise OR) 08 Hex = (PLC-5/SLC) Tx MS Byte First 10 Hex = Tx Sequence Number Checking Set/Get 20 Hex = Disable Queuing of NonFiltered Rx Messages 40 Hex = Strip received STX/ETX characters to the application (Default = 03) 17 (Default=3
Instance Attributes Attribute ID 32 Name Application Idle Timeout Data Type UDINT (ms) Data Value(s) 0 to FFFFFFFF Hex Access Rule Set/Get 0=Off 33 To PLC Filter Mode USINT 1=String (128 byte maximum) 2=RFID (EPCglobal formats) Set/Get 3= Barcode (UPC/EAN formats) 0=Off 34 35 To Application Filter Mode Discard Unrecognized Data Mode (RFID and Barcode Filter mode only) USINT 1=String (128 byte maximum) 2=RFID (EPCglobal formats) Set/Get 3= Barcode (UPC/EAN formats) 0=Off USINT 1=To PLC 2=T
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule Standard 12-14 Digit Format (Mask = 000F Hex) 00 Hex=NONE 01 Hex=Five Company/Five Product Digits 02 Hex=Six Company/Four Product Digits 03 Hex=Seven Company/Three Product Digits 41 Barcode Formats (Barcode Filtering Only) UINT 04 Hex=Eight Company/Two Product Digits Set/Get 05 Hex=Nine Company/One Product Digits Eight Digit Format (Mask = 00F0 Hex) 00 Hex=NONE 10 Hex=EAN-8; Two Company/Five Product Digits 20 Hex=EAN-8; Thr
Common Services 2.3.1.3. Common Services Service Code Implemented in Class Implemented in Instance 01 Hex 02 Hex 0E Hex 10 Hex Yes No Yes No Yes Yes Yes Yes Service Name Get_Attributes_All Set_Attributes_All Get_Attribute_Single Set_Attribute_Single 2.3.1.4. Instance Attribute Definitions Description Attribute Attribute 1 Serial Port Device This attribute indicates the Serial Port Device Type. Raw Data device is the only currently supported option.
Instance Attribute Definitions Attribute Description You can set this attribute to append an ETX (end of transmission) byte sequence which is configurable as 1 or 2 -bytes to the end of the serial packet before it is sent. The length indicates the number of ETX bytes. The valid values for length are: Attribute 11 PLC Transmit ETX Append Value • 0 (zero) - Setting this attribute to zero disables this function. • 1 (one ETX byte) - Inserts one ETX byte at the end of the data.
Instance Attribute Definitions Attribute Description This attribute specifies special serial port transfer options. The following options are supported: • Attribute 16 Serial Port Transfer Options 01 Hexadecimal (Bit 0) - DeviceMaster UP strips received STX/ETX characters from received packets before sending the packet to the PLC. • 02 Hexadecimal (Bit 1) - DeviceMaster UP discards received packets with errors.
Instance Attribute Definitions Attribute • Description Unsolicited - Write-to-Tag-Synced receive method - DeviceMaster UP writes the serial data into tag(s) on the PLC and provides a mechanism to synchronize the data flow between the PLC and DeviceMaster UP. In this method, DeviceMaster UP does not write the serial packet to the tag on the PLC until the PLC updates the consumed sequence number (Serial Port Data Transfer object Attribute 4) to match the produced data sequence number.
Instance Attribute Definitions Attribute Attribute 17 (Continued) Receive (DeviceMaster UP to PLC) Ethernet Data Transfer Method Attribute 19 Maximum Receive Data Packet Size Attribute 20 Maximum PLC Update Rate Attribute 22 PLC Controller Slot Number Attribute 23 PLC IP Address Description The following restrictions apply to the Polling receive method: • The data tag to receive the data on the PLC must be large enough to contain the sequence number, length, and data field associated with the received
Instance Attribute Definitions Attribute Attribute 27 Application Connect Mode Description This setting controls if and how the DeviceMaster UP attempts to connect to the application at the application connection IP address and application connection socket port. • 0 = Never - The DeviceMaster UP does not attempt to connect to the application. • 1 = Connect Always - The DeviceMaster UP attempts connecting to the application socket port until a connection is made.
Instance Attribute Definitions Attribute Attribute 34 To Application Filter/ Data Extraction Mode Description The filter/data extraction mode to be employed on data to be sent to the application. • 0 = Off • 1 = String (128 char max) - Raw/ASCII data is filtered up to 128 characters (or bytes) in length.
Instance Attribute Definitions Attribute Attribute 37 To PLC Filtering Options Description This attribute defines the RFID filtering criteria to the PLC. If an option is enabled, it is used to decide when an RFID tag can be filtered or sent to the PLC. • 01 Hex = Encoding/Numbering - Include the Encoding/Numbering code in the filtering criteria, which is part of the RFID tag or barcode data.
Instance Attribute Definitions Attribute Description This attribute defines barcode format to be used for both standard and eight digit UPC labels. The term standard refers to UPC-A, EAN-13, JAN, and EAN-14 barcodes which all have ten company/product digits. The standard and eight digit formats are selected independently and each operates independently. Barcode filtering/data extraction does not function if no format is selected.
Serial Port Data Transfer Object Definition (71 Hex) 2.3.2. Serial Port Data Transfer Object Definition (71 Hex) 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 DeviceMaster UP over EtherNet/IP. Note: There is one instance of this object per serial port. The instance number corresponds to the associated serial port number on the DeviceMaster UP. (Port numbers are numbered from one to N.) 2.3.2.1.
Instance Attribute Definitions 2.3.2.4. Instance Attribute Definitions Attribute Description This attribute transmits data out of a serial port on the DeviceMaster UP. Attribute 1 • Transmit (PLC to DeviceMaster UP) Message Data In most cases, incrementing the sequence number is optional. However, it is required if you enable the Transmit Sequence Number Checking option. (For more information, see Attribute 16 - Serial Port Transfer Options on Page 22.
Serial Port Statistics Object Definition (72 Hex) 2.3.3. Serial Port Statistics Object Definition (72 Hex) The Serial Port Statistics object defines the statistics gathered by the DeviceMaster UP on a serial port basis. Note: There is one instance of this object per serial port. The instance number corresponds to the associated serial port number on the DeviceMaster UP. (Port numbers are numbered from one to N.) 2.3.3.1.
Instance Attribute Definitions 2.3.3.4. Instance Attribute Definitions Description Attribute Attribute 1 Receive Byte Count Attribute 2 Attribute 3 Transmit Byte Count Attribute 4 Transmit Packet Count This attribute counts the number of bytes received over the serial port. Receive Packet Count: This attribute counts the packets received over the serial port. This attribute counts the number of bytes sent out the serial port. This attribute counts the number of packets sent out the serial port.
Socket Port Configuration Object Definition (73 Hex) Attribute Description This attribute counts the number of Unexpected Transmit Sequence Number errors. The DeviceMaster UP increments this number when the following statements are true: • Attribute 11 Unexpected Transmit Sequence Number • Error Count You enabled the Transmit Sequence Number Checking configuration option. (See Attribute 16 - Serial Port Transfer Options on Page 22 for additional information.
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule 1=Reset Socket Port 2 Socket Port Commands DWORD 2=Save in Flash 4=Clear Sequence Counters Set/Get 8=Clear Statistics Counters 3 Device Socket Enable USINT 4 Device Listen Enable USINT 5 Device Listen Socket Port UINT 6 Device Connect Mode 0=Disabled Set/Get 1=Enabled 0=Disabled Set/Get 1=Enabled 0-65535 Set/Get 0=Never USINT 1=Connect Always Set/Get 2=Connect On Data 7 Device Disconnect Mode USINT 8
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule 01 Hex = (PLC/SLC) Rx MS Byte First 02 Hex = (PLC/SLC) Tx MS Byte First 15 Socket Port Transfer Options WORD (bitwise OR) 04 Hex = Tx Sequence Number Checking Set/Get 08 Hex = Disable Queuing of Non-Filtered Rx Messages 10 Hex = Drop oversized received packets Maximum PLC Update UINT Rate (No more than one (Default=40) message per time period.
Instance Attributes Attribute ID 29 Name Data Type Discard Unrecognized Data Mode USINT (RFID and Barcode Filter mode only) Data Value(s) Access Rule 0=Off 1=To PLC 2=To application Set/Get 3=To PLC/application 0=None 1=Groups of Twos 30 RFID Antenna Grouping USINT 2=Groups of Threes 3=Groups of Fours Set/Get 4=First Two Only 5=First Three Only 01 Hex = Encoding Scheme 02 Hex = Filter Code 31 To PLC Filter Options WORD (Bitwise OR) 04 Hex = Antenna Number 08 Hex = Company Code Set/Get 10
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule Standard 12-14 Digit Format (mask = 000F Hex) 00 Hex=NONE 01 Hex=Five Company/Five Product Digits 02 Hex=Six Company/Four Product Digits 03 Hex=Seven Company/Three Product Digits 35 Barcode Formats (Barcode Filtering Only) 04 Hex=Eight Company/Two Product Digits UINT 05 Hex=Nine Company/One Product Digits Set/Get Eight Digit Format (mask = 00F0 Hex) 00 Hex=NONE 10 Hex=EAN-8; Two Company/Five Product Digits 20 Hex=EAN-8; Thr
Instance Attributes Attribute ID Name Data Type Data Value(s) Access Rule As defined for Get/Set All PLC Transmit ETX Append Value Structure of: Value1 (Only valid if Length not zero) Value2 (Only valid if Length=2) USINT 0 to 255 USINT 0 to 25 37 (Default=0 As defined for Get/Set Single No ETX) PLC Transmit ETX Append Value Structure of: Set/Get Length USINT 0,1,2 (0=No ETX) (Default=0) Value1 (Only valid if Length not zero) USINT 0 to 255 Value2 (Only valid if Length=2) USINT 0 to 255
Common Services Attribute ID Data Type Name Data Value(s) Access Rule Application Transmit STX Append Value Structure of: Length USINT 0,1,2 (0=No STX) (Default=0) Value1 (Only valid if Length not zero) USINT 0 to 255 USINT 0 to 255 40 (Default=0 No STX) Value2 (Only valid if Length=2) Set/Get Application Transmit ETX Append Value Structure of: Length USINT 0,1,2 (0=No ETX) (Default=0) Value1 (Only valid if Length not zero) USINT 0 to 255 USINT 0 to 255 41 (Default=0 No ETX) Value2
Instance Attribute Definitions 2.3.4.4. Instance Attribute Definitions Description Attribute Attribute 1 Socket Port Device Type This attribute indicates the socket port device type. Raw/ASCII Data Device is the only currently supported option for EtherNet/IP. DeviceMaster UP supports the following commands: Attribute 2 • Reset socket port - This option resets the device socket port, application socket port, and the statistics counters.
Instance Attribute Definitions Description (Continued) Attribute Attribute 8 Device Connection Socket Port Attribute 9 Device Connection IP Address Attribute 10 Device Idle Timeout This is the device socket port number the DeviceMaster UP connects to if the Device Connect Mode is set to either Connect Always or Connect On Data. This is the device IP address the DeviceMaster UP connects to if the Device Connect Mode is set to either Connect Always or Connect On Data.
Instance Attribute Definitions Description (Continued) Attribute Attribute 18 This attribute specifies the PLC tag name. It indicates where to write received data Receive (DeviceMaster while operating in the Write-to-Tag or Write-to-Tag-Synced receive method. UP to PLC) Data Tag Note: This attribute is not used in the Polling method. Name This attribute enables/ disables the Application Socket Interface. Enabling this function allows an application to be connected to the Attribute 19 device socket port.
Instance Attribute Definitions Attribute Attribute 27 To PLC Filter/Data Extraction Mode Description (Continued) The filter/data extraction mode to be employed on data to be sent to the PLC. • 0 = Off • 1 = String (128 char max) - Raw/ASCII data is filtered up to 128 characters (or bytes) in length.
Instance Attribute Definitions Attribute Attribute 31 To PLC Filtering Options Description (Continued) This attribute defines the RFID filtering criteria to the PLC. If an option is enabled, it is used to decide when an RFID tag can be filtered or sent to the PLC. • 01 Hex = Encoding/Numbering - Include the Encoding/Numbering code in the filtering criteria, which is part of the RFID tag or barcode data.
Instance Attribute Definitions Attribute Description (Continued) This attribute defines barcode format to be used for both standard and eight digit UPC labels. The term standard refers to UPC-A, EAN-13, JAN, and EAN-14 barcodes which all have ten company/product digits. The standard and eight digit formats are selected independently and each operates independently. It is important to note that the barcode filtering/data extraction does not function if no format is selected.
Instance Attribute Definitions Attribute Description (Continued) This attribute detects an STX (start of transmission) byte sequence which is configurable as 1 or 2-bytes when it receives a Ethernet packet. The length indicates the number of STX bytes. The valid values for length are: • 0 (zero) - Setting this attribute to zero disables this function. When disabled, the DeviceMaster UP accepts the first byte received after the last ETX byte(s) as the start of the next data packet.
Instance Attribute Definitions Attribute Attribute 41 Application Transmit ETX Append Value Description (Continued) You can set this attribute to append an ETX (end of transmission) byte sequence which is configurable as 1 or 2-bytes to the end of the Ethernet packet before it is sent. The length indicates the number of ETX bytes. The valid values for length are: • 0 (zero) ‐ Setting this attribute to zero disables this function. • 1 (one ETX byte) ‐ Inserts one ETX byte at the end of the data.
Socket Port Data Transfer Definition Object (74 Hex) 2.3.5. Socket Port Data Transfer Definition Object (74 Hex) 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 DeviceMaster UP over EtherNet/IP. Note: There is one instance of this object per socket port. The instance number corresponds to the associated socket port number on the DeviceMaster UP.
Instance Attribute Definitions 2.3.5.4. Instance Attribute Definitions Attribute Description This attribute transmits data out of a socket port on the DeviceMaster UP. Attribute 1 Transmit (PLC to DeviceMaster UP) Message Data In most cases, incrementing the sequence number is optional. However, it is required if you enable the Transmit Sequence Number Checking option. (For more information, see Attribute 16 - Serial Port Transfer Options on Page 22.
Informational Objects 2.3.6. 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. 2.3.6.1. Identity Object (01 Hex, 1 instance) The Identity Object provides identification of and general information about the DeviceMaster UP. 2.3.6.1.1.
Message Router Object (02 Hex) 2.3.6.2. Message Router Object (02 Hex) 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. 2.3.6.2.1. Class Attributes Attribute ID Name Data Type Data Value(s) Access Rule 1 Revision UINT 1 Get 2.3.6.2.2.
Port Object (F4 Hex - 1 instance) 2.3.6.4. Port Object (F4 Hex - 1 instance) The Port Object enumerates the CIP ports on the DeviceMaster UP. 2.3.6.4.1. Class Attributes Attribute ID Name Data Type Data Value(s) 1 2 3 8 Revision Max Instance Num Instances Entry Port UINT UINT UINT UINT 9 All Ports Array of UINT Access Rule 1 1 1 1 [0]=0 Get Get Get Get [1]=0 Get [2]=TCP_IP_PORT_TYPE (4) [3]=TCP_IP_PORT_NUMBER(2) 2.3.6.4.2.
TCP Object (F5 Hex - 1 instance) 2.3.6.5.2.
Ethernet Link Object (F6 Hex) 2.3.6.6. Ethernet Link Object (F6 Hex) The Ethernet Link object maintains link-specific counters and status information for the Ethernet communications on the DeviceMaster UP. 2.3.6.6.1. Class Attributes Attribute ID 1 2 3 Name Revision Max Instance Num Instances Data Type Data Value(s) Access Rule UINT UINT UINT 2 1 1 Get Get Get 2.3.6.6.2.
PCCC Object (67 Hex) 2.3.6.7.4. Common Services Service Code Implemented in Class Implemented in Instance 4B Hex No Yes Service Name Execute_PCCC 2.3.6.7.5.
PLC-5/SLC and MicroLogix Interfaces 2.4. PLC-5/SLC and MicroLogix Interfaces EtherNet/IP firmware versions 2.01 or later supports EtherNet/IP connections to the PLC-5 and SLC PLCs. As of EtherNet/IP version 3.02, the PLC-5 and SLC interface supports: • Polling, Write-to-File, and Write-to-File-Synced receive communication methods.
Requirements 2.4.1. Requirements Your PLC-5/SLC must support: • MultipHop • ControlLogix devices • EtherNet/IP The following tables list PLCs that support EtherNet/IP and the required firmware version for each PLC. Note: Older versions of the PLC firmware may or may not provide EtherNet/IP functionality. You must verify that an older version of the PLC firmware provides EtherNet/IP functionality before you can use it with DeviceMaster UP.
Messages 2.4.2.
Receive Data Message 2.4.3. Receive Data Message The Receive Data message format is similar to the format used in the Serial Port Data Transfer Object. However, the data is in 16-bit integer format instead of byte format. The 16-bit integer format is required when connecting to PLC-5 and SLC PLCs. The following table displays the format of the Receive Data message.
Transmit Data Message 2.4.4. Transmit Data Message The Transmit Data message format is similar to the format used in the Serial Port Data Transfer Object. However, the data is in 16-bit integer format instead of byte format. The 16-bit integer format is required when connecting to PLC-5 and SLC PLCs. The following table displays the format of the Transmit Data message.
Sequence Number Messages 2.4.5. Sequence Number Messages PLC-5/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 DeviceMaster UP in the Transmit Data message.
Retrieve Statistics Message Retrieve Statistics Message Description (Continued) Parity Error Count This attribute counts the number of packets with parity errors received on the serial port. Framing Error Count This attribute counts the number of packets with framing errors received on the serial port. Overrun Error Count This attribute counts the number of packets with overrun type errors received on the serial port. This attribute counts the number of received consumed sequence number errors.
Receive Communication Methods 2.4.7. Receive Communication Methods There are three methods of transferring received data to the PLC from the DeviceMaster UP. 2.4.7.1. Unsolicited - Write to File Receive Method Note: This is the recommended receive method. When a serial/socket packet is received on the DeviceMaster UP, the data packet is immediately written to a file data location on the PLC. The following diagram shows the data flow.
Polling Receive Method 2.4.7.3. Polling Receive Method This method provides the polling method that allows the PLC to request data on a periodic basis. In this method, the serial/socket data is returned in the response to the data request message.
Chapter 3. Embedded Configuration Pages This chapter provides detailed information about the embedded web pages for serial and Ethernet device configuration. Ethernet devices are configured via an Ethernet TCP/IP socket connection. The latest EtherNet/IP firmware must be installed before you can configure network or serial/socket port characteristics. For firmware installation and setup information, see the DeviceMaster UP Hardware Installation and Configuration Guide or the PortVision DX help system.
Embedded Web Pages Overview 4. Use the appropriate procedure for your environment to complete the DeviceMaster UP installation. • ControlLogix PLC: 5.3. ControlLogix PLC Programming Example Instructions on Page 103 describes how to use RSLogix 5000 to configure and run the DeviceMaster UP. • SLC or MicroLogix PLC: 5.4. SLC or MicroLogix PLC Programming Example Instructions on Page 116 describes how to use RSLogix 500 to configure and run the DeviceMaster UP. • PLC-5 PLC: 5.5.
Serial Device Configuration Page Server Configuration Page (Continued) Ethernet Device Configuration Opens the Ethernet Device Configuration page (3.4. Ethernet Device Configuration Page on Page 71), which provides an overview of the Ethernet device interface settings and access to the Edit Socket Port Configuration page for Ethernet device configuration on the selected socket port. Communication Statistics Opens the Communication Statistics page (4.1.
Serial Configuration • 3.6.3. Application TCP Connection Configuration on Page 80 • 3.6.4. Saving Port Options on Page 81 3.3.2. Serial Configuration Use the Serial Configuration area of the Edit Serial Port Configuration page to configure serial port characteristics for the device that you plan on connecting to the port. Serial Configuration Mode Select the communications mode for the serial device that you are connecting to the port. The available modes are RS-232, RS-422, and RS-485.
Serial Packet Identification Serial Configuration (Continued) Specifies the following information, once the start of a packet is received: Rx Timeout Between Packets • How long the DeviceMaster UP should wait (in milliseconds) before timing-out, if the ETX Rx Detect length is one byte or two bytes and the ETX byte(s) are not received. • The time to wait in milliseconds between serial packets if the ETX Rx Detect length is set to none. 3.3.3.
Serial Packet Identification Serial Port Packet Identification (Continued) When enabled, the DeviceMaster UP 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, valid values for length are: ETX (End of Transmission) Rx Detect • none - Disables this function and the DeviceMaster UP uses the Rx Timeout Between Packets to indicate the end of data packet.
Ethernet Device Configuration Page 3.4. Ethernet Device Configuration Page The Ethernet Device Configuration page provides: • Links to other pages • Access to the Edit Socket Port Configuration page for each port (Socket #) • An overview of Ethernet device configuration settings The overview area for each port displays the current settings. To change these settings for a port, select the corresponding Socket # link, which opens the Edit Socket Port Configuration page. See 3.3.1.
Device TCP Connection Configuration The following table provides information about configuring the Device TCP Connection Configuration area. Device TCP Connection Configuration Enable This setting enables/disables the Device Ethernet Device. Enabling this function allows an Ethernet TCP/IP device to be connected to a PLC and/or application. If both the PLC and application are connected to the device, both can transmit to and receive data from the device socket port.
Socket Packet ID Settings 3.5.2. Socket Packet ID Settings This subsection discusses the Socket Packet ID Settings area of the Ethernet Device Configuration page. Socket Packet ID Settings Specifies the following information, once the start of a packet is received: Rx Timeout Between Packets • How long the DeviceMaster UP should wait (in milliseconds) before timing-out, if the ETX Rx Detect length is one byte or two bytes and the ETX byte(s) are not received.
Socket Packet ID Settings Socket Packet ID Settings (Continued) When enabled, the DeviceMaster UP detects an ETX (end of transmission) byte sequence that is configured as one byte or two bytes marking the end of the Ethernet packet. The length indicates the number of ETX bytes, valid values for length are: ETX (End of Transmission) Rx Detect • none - Disables this function and the DeviceMaster UP uses the Rx Timeout Between Packets to indicate the end of data packet.
Common Configuration Areas (Serial or Ethernet Device) 3.6. Common Configuration Areas (Serial or Ethernet Device) The Edit Serial Port Configuration and Edit Socket Port Configuration pages have the following areas in common. This section discusses the following: • 3.6.1. Ethernet/IP Settings on Page 75 • 3.6.2. Filtering/Data Extraction Configuration on Page 77 • 3.6.3. Application TCP Connection Configuration on Page 80 3.6.1.
Ethernet/IP Settings Ethernet/IP Settings (Serial or Socket Port) The maximum rate (or minimum time interval) in milliseconds, that messages is sent Maximum PLC to the PLC tag in the Write-To-Tag/File receive method. This setting configures the Update Rate (WriteDeviceMaster UP to space the messages to the PLC in order to prevent overrunning of To-Tag/File) data before the PLC can process it. Maximum Rx Data Packet Size Specifies the maximum acceptable size of a received serial or Ethernet packet.
Filtering/Data Extraction Configuration 3.6.2. Filtering/Data Extraction Configuration Use this area to configure filtering or data extraction settings for a serial or socket port using the appropriate Edit Port Configuration page. Filtering/Data Extraction Configuration (Serial or Socket Port) Defines the filter/data extraction mode to be employed on data to be sent to the PLC. To PLC Filter Mode • Off • String (128 char max) - Raw/ASCII data is filtered up to 128 characters (or bytes) in length.
Filtering/Data Extraction Configuration Filtering/Data Extraction Configuration (Serial or Socket Port) (Continued) The filter/data extraction mode to be employed on data to be sent to the application. To Application Filter Mode • Off • String (128 char max) - Raw/ASCII data is filtered up to 128 characters (or bytes) in length.
Filtering/Data Extraction Configuration Filtering/Data Extraction Configuration (Serial or Socket Port) (Continued) Defines the expected RFID data format to be used while operating in the RFID filtering mode. Each Reader Interface Type is unique and pertains to the RFID reader manufacturer. If a different RFID reader is to be used and it provides a similar format to any of the RFID readers listed below, it can also be used in the RFID filtering mode.
Application TCP Connection Configuration 3.6.3. Application TCP Connection Configuration Use this area to configure application TCP connection settings for a serial or socket port using the appropriate Edit Port Configuration page. Application TCP Connection Configuration (Serial or Socket Port) Enables/disables the Application Socket Interface. Enabling this function allows an application to be connected to the device serial/socket port.
Saving Port Options Application TCP Connection Configuration (Serial or Socket Port) (Continued) Controls if and how the DeviceMaster UP disconnects from an application. Disconnect Mode Idle Timer • Never – The DeviceMaster UP does not disconnect from the application. • Idle - The DeviceMaster UP disconnects when there has been no transmit or received data between the serial/socket device and application for a specified Idle Timer period.
Edit Network Configuration Page 3.7. Edit Network Configuration Page You can use the Edit Network Configuration page to change the DeviceMaster UP network configuration after using PortVision DX for initial network configuration. Use the following procedure to change the network configuration. 1. Select the IP configuration type (DHCP or Static). 2. If you select Static, enter a valid IP address, subnet mask, and IP gateway for your network.
Edit Security Configuration Page 3.8. Edit Security Configuration Page You can use the Edit Security Configuration page to configure security on the DeviceMaster UP. Edit Security Configuration Page If Secure Data Mode is enabled, TCP connections that carry data to/from the serial ports are encrypted using SSL or TLS security protocols. This includes the following: Enable Secure Data Mode • TCP connections to the per-serial-port TCP ports (default is 8000, 8001, 8002, ...) are encrypted using SSL/TLS.
Client Authentication Edit Security Configuration Page RSA Server Certificate used by SSL servers DH Key pair used by SSL servers This is the RSA identity certificate that the DeviceMaster UP uses during SSL/ TLS handshaking to identify itself. It is used most frequently by SSL server code in the DeviceMaster UP when clients open connections to the DeviceMaster's secure web server or other secure TCP ports.
Configuring Security 3.8.2. Configuring Security Use the following procedure to configure DeviceMaster UP security. Note: All DeviceMaster UP units are shipped from the factory with identical configurations. They all have the identical, self-signed, Comtrol Server RSA Certificates, Server RSA Keys, Server DH Keys, and no Client Authentication Certificates. For maximum data and access security, you should configure all DeviceMaster units with custom certificates and keys. 1.
Configuring Security 86 - Chapter 3. Embedded Configuration Pages DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev.
Chapter 4. Diagnostic and Statistics Pages You can access the following diagnostic and statistics pages from the Server Configuration (main) page and related configuration and diagnostics or statistics pages. This section discusses the following pages: • 4.1. Communication Statistics on Page 88 • 4.2. Display Serial Logs on Page 94 • 4.3. Display Ethernet Device Logs on Page 95 • 4.4. PLC Interface Diagnostics on Page 96 DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 4.
Communication Statistics 4.1. Communication Statistics The top portion of this page provides links to other pages. The displayed counters are the same as those specified in 2.3.3. Serial Port Statistics Object Definition (72 Hex) on Page 31. Refer to the following table for definitions of the fields. Note: The refresh rate on this page is set to 20 seconds. To stop the page refresh, select Refresh in your browser. To restart refreshing the page display; exit and return to this page.
Communication Statistics Serial Device Interfaces Statistics (Continued) Displays the number of received serial packets intended for the PLC dropped: To PLC Dropped Packet Count To PLC Truncated • No STX byte(s) found • No ETX byte(s) found • Time-outs • Packet to large • Receive buffer queue overflows Displays the number of received packets that were truncated before being sent to the PLC. Displays the number of Unexpected Transmit Sequence Number errors.
Communication Statistics Filtering Statistics (Serial) Valid Data Items Sent To PLC Interface Displays the number of valid string, RFID, or barcode data sent to the PLC. Applies when filtering is enabled. Valid Data Items Filtered From PLC Displays the number of valid string, RFID, or barcode data filtered from (not sent) to the PLC. Applies when filtering is enabled. Invalid Data Items Discarded From PLC Displays the number of invalid RFID or barcode data not sent to the PLC.
Communication Statistics Application Connection Statistics (Serial) (Continued) RX Pkt Count Displays the number of packets received over the application socket port. To Device Dropped Packet Count Displays the number of dropped packets that were intended for the device. Ethernet Device Interface Statistics Yes/No Toggles to display or not to display socket statistics. Reset Statistics Clears the socket port statistics, which sets the value to 0 for all ports.
Communication Statistics Filtering Statistics (Ethernet Device Interface Statistics) Valid Data Items Sent To PLC Interface Displays the number of valid string, RFID, or barcode data sent to the PLC. Applies when filtering is enabled. Valid Data Items Filtered From PLC Displays the number of valid string, RFID, or barcode data filtered from (not sent) to the PLC. Applies when filtering is enabled.
Communication Statistics Application Connection Statistics (Ethernet Device Interface Statistics) TX Byte Count Displays the number of bytes sent out the application socket port. TX Pkt Count Displays the number of packets sent out the application socket port.
Display Serial Logs 4.2. Display Serial Logs The Serial Interface Logs page provides a log of received and transmitted serial port messages. Up to 128 bytes per message and up to 128 messages are logged. It is intended to help with debugging serial connectivity problems, determining the proper start and end of transmission bytes, and diagnosing device problems. The format is as follows: Pkt(n): ddd:hh:mm:ss.
Display Ethernet Device Logs 4.3. Display Ethernet Device Logs The Ethernet Device Interface Logs page is accessed using the Display Ethernet Device Logs option, which provides a log of received and transmitted Ethernet device 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. The format is as follows: Pkt(n): ddd:hh:mm:ss.
PLC Interface Diagnostics 4.4. PLC Interface Diagnostics The PLC Interface Diagnostics page provides detailed statistics and error reporting for the EtherNet/IP PLC interface. It is intended to help with debugging PLC programs, monitoring the PLC interface, and solving configuration problems. PLC Interface Diagnostics Messages/ Responses Received From PLC Displays the number of messages and responses received from the PLC(s).
PLC Interface Diagnostics PLC Interface Diagnostics (cont.) Unexpected Event Errors Displays the number of unexpected event errors. Unexpected event errors occur when the DeviceMaster UP receives an unexpected message from the PLC such as an unexpected response or unknown message. Displays the number of unsupported CIP request instance errors. These Unsupported CIP Request Instance Errors errors occur when a message with an invalid instance is sent to the DeviceMaster UP.
PLC Interface Diagnostics 98 - Chapter 4. Diagnostic and Statistics Pages DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev.
Chapter 5. Programming the PLC This chapter provides information to help you configure PLC programs for the DeviceMaster UP. It includes instructions for modifying the PLC program examples included with the DeviceMaster UP. The PLC program examples are designed to work with the ControlLogix line of PLCs, PLC-5s or SLCs. 5.1. Programming Guidelines Choose the receive communication method that best suits your implementation. The following communication methods are available.
PLC Algorithms 5.2. PLC Algorithms This section displays the following PLC algorithms: • Unsolicited - Write-to-Tag/File PLC Algorithm on Page 100 • Unsolicited - Write-to-Tag/File-Synced PLC Algorithm on Page 101 • Polling PLC Algorithm on Page 102 5.2.1. Unsolicited - Write-to-Tag/File PLC Algorithm Use the following algorithm to receive data in the Unsolicited - Write-to-Tag/File mode. 100 - Chapter 5. Programming the PLC DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev.
Unsolicited - Write-to-Tag/File-Synced PLC Algorithm 5.2.2. Unsolicited - Write-to-Tag/File-Synced PLC Algorithm Use the following algorithm to receive data in the Unsolicited - Write-to-Tag/File-Synced mode. DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev. L Chapter 5.
Polling PLC Algorithm 5.2.3. Polling PLC Algorithm Use the following algorithm to Receive Data in the Polling mode. 102 - Chapter 5. Programming the PLC DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev.
ControlLogix PLC Programming Example Instructions 5.3. ControlLogix PLC Programming Example Instructions This topic describes how to use RSLogix 5000 to configure and run the DeviceMaster UP in a ControlLogix environment. You can configure the RSLogix 5000 PLC program examples to your site’s requirements. These programs are included in the self-installing file (.MSI) and are copied to the Comtrol/EtherNetIP directory on your computer when you open the .MSI file and follow the prompts.
loopbackExampleTagWrite.L5K 5.3.3. loopbackExampleTagWrite.L5K This example program demonstrates an RSLogix 5000 loopback PLC program using the Unsolicited - Writeto-Tag receive method. This program configures a DeviceMaster UP 1-port at startup and then loops data by means of the loopback plug on the serial port. The Com1_RxData tag transmits and receives the data and increments the sequence numbers. You can configure and run the loopbackExampleTagWrite.L5K program through RSLogix 5000.
loopbackExampleTagWriteSynced.L5K 5.3.4. loopbackExampleTagWriteSynced.L5K This example program demonstrates an RSLogix 5000 loopback PLC program using the Write-to-Tag-Synced receive method. This program configures a DeviceMaster UP 1-port at startup and then loops data through the loopback plug on the serial port. The Com1_RxData tag transmits and receives the data, increments the sequence numbers, and sends the consumed receive sequence number to the DeviceMaster UP after each received data packet.
loopbackExamplePolling.L5K 5.3.5. loopbackExamplePolling.L5K This example program demonstrates an RSLogix 5000 loopback PLC program using the Polling receive method. This program configures a DeviceMaster UP 1-port at startup and then loops data through the loopback plug on the serial port. The Request Data Message transmits and receives the data and increments the sequence numbers. You can configure and run the loopbackExamplePolling.L5K program through RSLogix 5000.
Configuring the DeviceMaster UP for the RSLogix 5000 Example Programs Using the Web Page 5.3.6. Configuring the DeviceMaster UP for the RSLogix 5000 Example Programs Using the Web Page The following procedure configures the DeviceMaster UP for the RSLogix 500 example programs. You must perform this task before you configure and run the RSLogix 500 example program. For more information on the Server Configuration web pages, see Chapter 3. Embedded Configuration Pages on Page 65. 1.
RSLogix 5000 Screen Examples 5.3.7. RSLogix 5000 Screen Examples The following subsections explain how to configure the DeviceMaster UP through RSLogix 5000. 5.3.7.1. Transmit Data to the DeviceMaster UP Use the Configuration tab on the Message Configuration dialog to set options for transmitting data through a specified port on the DeviceMaster UP. Provide the following information.
Send Configuration to DeviceMaster UP 5.3.7.2. Send Configuration to DeviceMaster UP Use the Configuration tab on the Message Configuration dialog for sending a serial port configuration to the DeviceMaster UP. Provide the following information. Field Message Type Service Type Service Code Class Instance Attribute Source Element Selection CIP Generic Custom 2 Hex (Set Attribute All) 70 Hex (Serial Port Configuration object) 1 (Port 1) 0 (Unused) Com1_SetConfigData (Configuration data structure.
Send Configuration to DeviceMaster UP The following image displays the user defined data type for a serial port configuration. 110 - Chapter 5. Programming the PLC DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev.
Request Data from DeviceMaster UP 5.3.7.3. Request Data from DeviceMaster UP Use the Configuration tab on the Message Configuration dialog to request data from a specified serial port on the DeviceMaster UP. Only the Polling receive method uses this feature. Provide the following information.
Send Consumed Sequence Number to DeviceMaster UP 5.3.7.4. Send Consumed Sequence Number to DeviceMaster UP Use the Configuration tab on the Message Configuration dialog to update the consumed sequence number for a specified port on the DeviceMaster UP. Only the Write-to-Tag-Synced receive method uses this feature. Provide the following information: Field Message Type Service Type Service Code Class Instance Attribute Source Element Source Length 112 - Chapter 5.
Request Statistics from DeviceMaster UP 5.3.7.5. Request Statistics from DeviceMaster UP Use the Configuration tab on the Message Configuration dialog for requesting statistics for a specified port from the DeviceMaster UP. Provide the following information.
Communication Window for all Messages sent to the DeviceMaster UP 5.3.7.6. Communication Window for all Messages sent to the DeviceMaster UP Use the Communication tab on the Message Configuration dialog for sending all EtherNet/IP messages to the DeviceMaster UP. Provide the following information. Field Selection Provide the following information in this box: Path • SoftEtherIP - Specifies the name of the EtherNet/IP interface • 2 - Required for routing on ControlLogix PLCs. • 10.0.0.
Modifying an RSLogix 5000 PLC Program Example (Older Versions) • 5.3.5. loopbackExamplePolling.L5K on Page 106 If you still have problems loading the example .L5K file, go to the next step. 7. Make the following modifications to the .L5K file: • Modify the ProcessorType setting in the example .L5K file to match the ProcessorType in the known functional .L5K file (line 10 of the example .L5K file). • Replace the MODULE local section of the example .
SLC or MicroLogix PLC Programming Example Instructions 5.4. SLC or MicroLogix PLC Programming Example Instructions This topic describes how to use RSLogix 500 to configure and run the DeviceMaster UP in an SLC or MicroLogix PLC environment. You can configure the RSLogix 500 PLC program examples to your site’s requirements. These programs are included in the self-installing file (.MSI) and are copied to the Comtrol/EtherNetIP directory on your computer when you open the .MSI file and follow the prompts.
Example Program Considerations 5.4.3. Example Program Considerations • While the RSLogix example programs are simple in nature, they include retry mechanisms for timed-out messages. You may or may not want to include the time-out mechanism in your application. • While the receive and transmit sequence numbers are cleared on the DeviceMaster UP at the start of the programs, the only requirement is that the sequence numbers be in sync between the PLC and DeviceMaster UP.
lpbkExampleSlcMsgFileSyncRS500 - SLC PLC 5.4.3.4. lpbkExampleSlcMsgFileSyncRS500 - SLC PLC This example program demonstrates a loop-back RSLogix 500 PLC program using SLC Typed messages in the Write-to-File-Synced receive method. This program initializes the produced receive and transmit sequence numbers as well as the consumed receive sequence number at startup and then loops data via a loop-back plug on the serial port.
Configure the DeviceMaster UP for the RSLogix 500 Example Program - SLC PLC 5.4.4. Configure the DeviceMaster UP for the RSLogix 500 Example Program SLC PLC The following procedure configures the DeviceMaster UP for the RSLogix 500 example programs. You must perform this task before you configure and run the RSLogix 500 example program. For more information on the Server Configuration web pages, see Chapter 3. Embedded Configuration Pages on Page 65. 1. Attach a loopback plug to the serial port. 2.
Configure and Run the RSLogix 500 Example Program - SLC PLC Field Save in Flash Selection Select. 7. Click Submit. 5.4.5. Configure and Run the RSLogix 500 Example Program - SLC PLC You can configure and run the RSLogix 500 example programs through RSLogix 500. For additional information on the RSLogix 500, see 5.4.6. RSLogix 500 Screen Examples - SLC PLC on Page 123. Note: Configure the DeviceMaster UP before you configure and download the RSLogix 500 example program.
Configure and Run the RSLogix 500 Example Program - SLC PLC 11. Double-click Channel Configuration, and select the following in the General tab: a. In the Channel 1 panel, type 60 in the Diagnostic File box. b. In the Channel 0 panel, type 61 in the Diagnostic File box. DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev. L Chapter 5.
Configure and Run the RSLogix 500 Example Program - SLC PLC 12. Select the Chan. 1 System tab on the Channel Configuration dialog and select the following options. a. Type the IP address for your PLC in the IP Address box if you are not using Bootp. b. Type the subnet mask for your PLC in the Subnet Mask box. c. Type the gateway address for your PLC in the Gateway Address box. d. Select Bootp Enable if you are using Bootp to initialize your network settings. e. Select SNMP Server Enable. f.
RSLogix 500 Screen Examples - SLC PLC 5.4.6. RSLogix 500 Screen Examples - SLC PLC The following subsections explain how to configure the DeviceMaster UP through RSLogix 500. Use the screens to set up the PLC and program the various messages. 5.4.6.1. Setting up Processor and Ethernet (Channel 1) You must set up the Processor and Ethernet communication port properly for EtherNet/IP to function.
Setting up Processor and Ethernet (Channel 1) 5. Double-click Processor Status, and select the Chan 1 tab on the Data File S2 -- STATUS dialog. 6. Make the following recommended changes. a. Select the DH485 Gateway Disable Bit S:34/0 option. b. Clear the DF1 Gateway Enable BIT S:34/5 option. c. Select the Comms Servicing Sel S:2/15 option. d. Select the Msg Servicing Sel S:33/7 option. (You must enable this option if you want to run EtherNet/IP.) 7.
Setting up Processor and Ethernet (Channel 1) 8. Select the Chan. 1 System tab on the Channel Configuration dialog. 9. Make the following recommended changes. a. Select the SNMP server Enable option. (EtherNet/IP may not function without this setting.) b. Select the HTTP Server Enable option. (EtherNet/IP may not function without this setting.) c. To automatically select the proper Ethernet speed and duplex settings: • Select the Auto Negotiate option.
SLC Typed Read - Receive Data Message - SLC PLC 5.4.6.2. SLC Typed Read - Receive Data Message - SLC PLC The following screen depicts an SLC Typed Read - Receive Data message in ladder logic. Make the following changes to the ladder logic. 1. Select the Read option. 2. Select the 500CPU option. 3. Select Local. 4. Assign a dedicated integer file of 51 integers to the Control block. 5. In the ladder logic, double-click the Setup Screen in the MSG instruction. 6. Make the following changes: a.
SLC Typed Write - Transmit Data Message - SLC PLC 5.4.6.3. SLC Typed Write - Transmit Data Message - SLC PLC The following screen depicts an SLC Typed Write - Transmit Data message in ladder logic. Make the following changes to the ladder logic. 1. Select the Write option. 2. Select the 500CPU option. 3. Select Local. 4. Assign a dedicated integer file of 51 integers to the Control block. 5. In the ladder logic, double-click the Setup Screen in the MSG instruction. 6. Make the following changes: a.
SLC Typed Read - Retrieve Statistics Message - SLC PLC 5.4.6.4. SLC Typed Read - Retrieve Statistics Message - SLC PLC The following screen depicts an SLC Typed Read - Retrieve Statistics message in ladder logic. Make the following changes to the ladder logic. 1. Select the Read option. 2. Select the 500CPU option. 3. Select Local. 4. Assign a dedicated integer file of 51 integers to the Control block. 5. In the ladder logic, double-click the Setup Screen in the MSG instruction. 6.
SLC Typed Write - Set Receive Produced Sequence Number Message - SLC PLC 5.4.6.5. SLC Typed Write - Set Receive Produced Sequence Number Message - SLC PLC The following screen depicts an SLC Typed Write - Set Receive Produced Sequence Number message in ladder logic. Make the following changes to the ladder logic. 1. Select the Write option. 2. Select the 500CPU option. 3. Select Local. 4. Assign a dedicated integer file of 51 integers to the Control block. 5.
SLC Typed Write - Set Transmit Produced Sequence Number Message - SLC PLC 5.4.6.6. SLC Typed Write - Set Transmit Produced Sequence Number Message - SLC PLC The following screen depicts an SLC Typed Write - Set Transmit Produced Sequence Number message in ladder logic. Make the following changes to the ladder logic. 1. Select the Write option. 2. Select the 500CPU option. 3. Select Local. 4. Assign a dedicated integer file of 51 integers to the Control block. 5.
PLC-5 Typed Read - Receive Data Message - SLC PLC 5.4.6.7. PLC-5 Typed Read - Receive Data Message - SLC PLC The following screen depicts a PLC-5 Typed Read - Receive Data message in ladder logic. Make the following changes to the ladder logic. 1. Select the Read option. 2. Select the PLC5 option. 3. Select Local. 4. Assign a dedicated integer file of 93 integers to the Control block. In the ladder logic, double-click the Setup Screen in the MSG instruction. 5. Make the following changes. a.
PLC-5 Typed Write - Transmit Data Message - SLC PLC 5.4.6.8. PLC-5 Typed Write - Transmit Data Message - SLC PLC The following screen depicts a PLC-5 Typed Write - Transmit Data message in ladder logic. Make the following changes to the ladder logic. 1. Select the Write option. 2. Select the PLC5 option. 3. Select Local. 4. Assign a dedicated integer file of 93 integers to the Control block. 5. In the ladder logic, double-click the Setup Screen in the MSG instruction. 6. Make the following changes: a.
PLC-5 Typed Read - Retrieve Statistics Message - SLC PLC 5.4.6.9. PLC-5 Typed Read - Retrieve Statistics Message - SLC PLC The following screen depicts an PLC-5 Typed Read - Retrieve Statistics message in ladder logic. Make the following changes to the ladder logic. 1. Select the Read option. 2. Select the PLC5 option. 3. Select Local. 4. Assign a dedicated integer file of 93 integers to the Control block. 5. In the ladder logic, double-click the Setup Screen in the MSG instruction. 6.
PLC-5 Typed Write - Set Receive Produced Sequence Number Message - SLC PLC 5.4.6.10. PLC-5 Typed Write - Set Receive Produced Sequence Number Message - SLC PLC The following screen depicts an PLC-5 Typed Write - Set Receive Produced Sequence Number message in ladder logic. Make the following changes to the ladder logic. 1. Select the Write option. 2. Select the PLC5 option. 3. Select Local. 4. Assign a dedicated integer file of 93 integers to the Control block. 5.
PLC-5 Typed Write - Set Transmit Produced Sequence Number Message - SLC PLC 5.4.6.11. PLC-5 Typed Write - Set Transmit Produced Sequence Number Message - SLC PLC The following screen depicts an PLC-5 Typed Write - Set Transmit Produced Sequence Number message in ladder logic. Make the following changes to the ladder logic. 1. Select the Write option. 2. Select the PLC5 option. 3. Select Local. 4. Assign a dedicated integer file of 93 integers to the Control block. 5.
Configuring and Running the MicroLogix RSLogix 500 Example Program 5.4.7. Configuring and Running the MicroLogix RSLogix 500 Example Program 1. Select the appropriate message type example programs (_MICROLGX) and copy the files (.RSS) to the desired directory. 2. Start RSLogix 500 and open the .RSS file through RSLogix 500. 3. To modify the PLC program for your system, double-click Controller Properties.
Configuring and Running the MicroLogix RSLogix 500 Example Program 6. Double-click Processor Status, select the Chan. 1 System tab on the Channel Configuration dialog and select the following options. a. Type the IP address for your PLC in the IP Address box if you are not using Bootp. b. Type the subnet mask for your PLC in the Subnet Mask box. c. Type the gateway address for your PLC in the Gateway Address box. d. Select Bootp Enable if you are using Bootp to initialize your network settings. e.
Receive Sequence Number Init Message 5.4.7.1. Receive Sequence Number Init Message The following screen depicts a SLC Typed Read - Receive Sequence Number Init message in ladder logic. In the ladder logic, double-click the Setup Screen in the MSG instruction. Make the following changes: 1. Set the Channel parameter to 1 to use the Ethernet port. 2. Specify the file address where the transmit sequence number resides in the Data Table Address box on This Controller panel.
Transmit Sequence Number Init Message 5.4.7.2. Transmit Sequence Number Init Message The following screen depicts a SLC Typed Read - Transmit Sequence Number Init message in ladder logic. In the ladder logic, double-click the Setup Screen in the MSG instruction. Make the following changes: 1. Set the Channel parameter to 1 to use the Ethernet port. 2. Specify the file address where the transmit sequence number resides in the Data Table Address box on This Controller panel.
Transmit Data Message 5.4.7.3. Transmit Data Message The following screen depicts an SLC Typed Write - Transmit Data message in ladder logic. In the ladder logic, double-click the Setup Screen in the MSG instruction. Make the following changes: 1. Set the Channel parameter to 1 to use the Ethernet port. 2. Specify the file address where the transmit sequence number resides in the Data Table Address box on This Controller panel. For more information on file addresses, see 2.4.2.1.
Receive Data Message 5.4.7.4. Receive Data Message The following screen depicts an SLC Typed Read - Receive Data message in ladder logic. In the ladder logic, double-click the Setup Screen in the MSG instruction. Make the following changes: 1. Set the Channel parameter to 1 to use the Ethernet port. 2. Specify the file address where the transmit sequence number resides in the Data Table Address box on This Controller panel. For more information on file addresses, see 2.4.2.1.
MultiHop Screen 5.4.7.5. MultiHop Screen Select the MultiHop tab on the MSG dialog. 2. Make the following changes. a. Type the IP address for the DeviceMaster UP (the designated EtherNet/IP Device) in the To Address box. 142 - Chapter 5. Programming the PLC DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev.
PLC-5 PLC Programming Example Instructions 5.5. PLC-5 PLC Programming Example Instructions This topic describes how to use RSLogix 5 to configure and run the DeviceMaster UP in a PLC-5 PLC environment. You can configure the RSLogix 5 PLC program examples to your site’s requirements. This program is included in the self-installing file (.MSI) and is copied to the Comtrol/EtherNetIP directory on your computer when you open the .MSI file and follow the prompts.
Example Program Considerations 5.5.3. Example Program Considerations • While the RSLogix example programs are simple in nature, they include error counters and transmit retry mechanisms for timed-out messages. You may or may not want to include the error counters and transmit retry mechanisms in your own application. • The receive and transmit sequence numbers are cleared on the DeviceMaster UP when you start the programs.
lpbkExamplePlc5MsgFileSyncRS5 5.5.7. lpbkExamplePlc5MsgFileSyncRS5 This example program demonstrates a loop-back RSLogix 5 PLC program using PLC-5 Typed messages in the Write-to-File-Synced receive method. This program initializes the produced receive and transmit sequence numbers as well as the consumed receive sequence number at startup and then loops data via a loop-back plug on the serial port.
Configure the DeviceMaster UP for the RSLogix 5 Program 6. Set the serial port settings under EtherNet/IP Settings to the following values. Field TX Sequence Number Checking. Rx (To PLC) Ethernet Transfer Method PLC IP Address Settings Select • Set to Polling for lpbkExampleSlcMsgPollRS5 and lpbkExamplePlc5MsgPollRS5. • Set to Write-to-Tag/File for lpbkExamplePlc5MsgFileRS5. • • Set to Write-to-Tag/File-Synced for lpbkExamplePlc5MsgFileSyncRS5. Leave blank for Polling.
Configure and Run the Example RSLogix 5 Program 5.5.9. Configure and Run the Example RSLogix 5 Program You can configure and run the RSLogix 5 example programs through RSLogix 5. For additional information on the RSLogix 5, see 5.5.10. RSLogix 5 Screen Examples on Page 149. Note: The DeviceMaster UP must be configured for PLC-5/SLC before you can configure and download the example RSLogix 5 program. For instructions on configuring DeviceMaster UP, see 5.5.8.
Configure and Run the Example RSLogix 5 Program 10. Double-click Channel Configuration and click the Channel 3A tab. Note: The port number for the Ethernet channel may be different on your PLC-5. 11. In the Ethernet Configuration panel, make the following changes: a. Set Channel Type to Ethernet. b. Type 60 in the Diagnostic File box. You can use the diagnostic file to help solve any network-related problems. c. Type the IP address for your PLC-5 in the IP address box. d.
RSLogix 5 Screen Examples 5.5.10.RSLogix 5 Screen Examples The following subsections explain how to configure the DeviceMaster UP through RSLogix 5. Use these screens to set up PLC and program the various messages. 5.5.10.1. Requirements • PLC-5 PLCs require EtherNet/IP firmware 2.01 or later running on the DeviceMaster UP. • The PLC-5 PLC firmware must support MultiHop, ControlLogix devices and EtherNet/IP. The tables in 2.4.1.
Setting up Processor and Ethernet Channel 3. Select the Controller Communications tab and select the proper driver for RSLogix 5. 4. Click OK to apply your changes and close the Controller Properties dialog. 5. Double-click Channel Configuration, click the Channel 3A tab and make the following changes. a. Type a value (between 0 and 256) in the Diagnostic File box for an integer diagnostic file. (This example uses Diagnostic file 60.
SLC Typed Read - Receive Data Message 5.5.10.3. SLC Typed Read - Receive Data Message The following screen depicts an SLC Typed Read - Receive Data message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic. 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a. Specify the file address to receive data information in the Data Table Address box on This PLC-5 panel.
SLC Typed Write - Transmit Data Message 5.5.10.4. SLC Typed Write - Transmit Data Message The following screen depicts an SLC Typed Write - Transmit Data message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic (as shown above). 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a. Specify the file address to transmit data information in the Data Table Address box on This PLC-5 panel.
SLC Typed Read - Retrieve Statistics Message 5.5.10.5. SLC Typed Read - Retrieve Statistics Message The following screen depicts an SLC Typed Read - Retrieve Statistics message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic. 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a. Specify the file address to receive statistics data information in the Data Table Address box on This PLC-5 panel.
SLC Typed Write - Set Receive Produced Sequence Number Message 5.5.10.6. SLC Typed Write - Set Receive Produced Sequence Number Message The following screen depicts an SLC Typed Write - Set Receive Produced Sequence Number message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic (as shown above). 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a.
SLC Typed Write - Set Transmit Produced Sequence Number Message 5.5.10.7. SLC Typed Write - Set Transmit Produced Sequence Number Message The following screen depicts an SLC Typed Write - Set Transmit Produced Sequence Number message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic (as shown above). 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a.
PLC-5 Typed Read - Receive Data Message 5.5.10.8. PLC-5 Typed Read - Receive Data Message The following screen depicts a PLC-5 Typed Read - Receive Data message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic (as shown above). 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a. Specify the file address to receive data information in the Data Table Address box on This PLC-5 panel.
PLC-5 Typed Write - Transmit Data Message 5.5.10.9. PLC-5 Typed Write - Transmit Data Message The following screen depicts a PLC-5 Typed Write - Transmit Data message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic (as shown above). 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a. Specify the file address to transmit data information in the Data Table Address box on This PLC-5 panel.
PLC-5 Typed Read - Retrieve Statistics Message 5.5.10.10. PLC-5 Typed Read - Retrieve Statistics Message The following screen depicts an PLC-5 Typed Read - Retrieve Statistics message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic (as shown above). 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a.
PLC-5 Typed Write - Set Receive Produced Sequence Number Message 5.5.10.11. PLC-5 Typed Write - Set Receive Produced Sequence Number Message The following screen depicts an PLC-5 Typed Write - Set Receive Produced Sequence Number message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic. 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a.
PLC-5 Typed Write - Set Transmit Produced Sequence Number Message 5.5.10.12. PLC-5 Typed Write - Set Transmit Produced Sequence Number Message The following screen depicts an PLC-5 Typed Write - Set Transmit Produced Sequence Number message in ladder logic. 1. Assign a dedicated message file to the Control block in the ladder logic. 2. In the ladder logic, double-click the Setup Screen in the MSG instruction. 3. Make the following changes: a.
EDS Files 5.6. EDS Files You do not need to add DeviceMaster UP to RSLinx for normal DeviceMaster UP-to-PLC communications. However, you can easily add the DeviceMaster UP and its associated Electronic Data Sheet (EDS) files to RSLinx. 5.6.1. Requirements EDS files and the associated icons are included in the self-installing file (.MSI) and are copied to the Comtrol/ EtherNetIP directory on your computer when you open the .MSI file and follow the prompts. The files named DeviceMaster UP_*.
Adding DeviceMaster UP to RSLinx 5.6.2. Adding DeviceMaster UP to RSLinx 1. Open RSLinx. 2. Under Communications, select Configure Drivers. 3. Under Available Drivers, select Remote Devices via Linx Gateway. 4. Select Add New. 5. Use the default driver name or type your own driver name and click OK to continue. 6. Type the IP address for the device under Server’s IP Address or Hostname and select OK. 7. Select RSWho to verify that RSLinx can communicate with the DeviceMaster UP.
Troubleshooting RSLinx 5.6.4. Troubleshooting RSLinx If RSLinx does not display the device after adding DeviceMaster UP and the EDS files to RSLinx, perform the following procedure: 1. Select File > Exit and Shutdown to exit and shutdown RSLinx. 2. Remove the following files from your hard drive: • \Program Files\Rockwell Software\RSCOMMON\Harmony.hrc • \Program Files\Rockwell Software\RSCOMMON\Harmony.rsh 3. Restart RSLinx.
Troubleshooting RSLinx 164 - Chapter 5. Programming the PLC DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev.
Chapter 6. Troubleshooting and Technical Support You should review the Troubleshooting chapter in the DeviceMaster UP Installation and Configuration Guide before calling Technical Support because they will request that you perform many of the procedures or verifications before they can help you diagnose a problem. • 6.1. Troubleshooting Checklist on Page 165 • 6.2. General Troubleshooting on Page 166 If you cannot diagnose the problem, you can contact 6.3. Technical Support on Page 166. 6.1.
General Troubleshooting 6.2. General Troubleshooting This table illustrates some general troubleshooting tips. Note: Make sure that you have reviewed the 6.1. Troubleshooting Checklist on Page 165. General Condition Explanation/Action Indicates that boot program has not downloaded to the unit. 1. Reboot the system. PWR or Status LED flashing 2. Make sure that you have downloaded the most current firmware for your protocol: http://www.comtrol.com/support/download.asp.