Comtrol UP DeviceMaster User Guide

Download

Page 1

EtherNet®/IP User Guide

Page 2

Trademark Notices

DocumentNumber:2000424RevL

PatentsPending

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. Portions of SocketServer are copyrighted by GoAhead Software, Inc. Copyright © 2001. GoAhead Software,

Inc. All Rights Reserved. Windows is a registered trademark of Microsoft Corporation in the United States and/or other countries. Other product names mentioned herein may be trademarks and/or registered trademarks of their respective

owners. Twelfth Edition, July 25, 2013

Comtrol Corporation makes no representations or warranties with regard to the contents of this document or to the suitability of the Comtrol product for any particular purpose. Specifications subject to change without notice. Some software or features may not be available at the time of publication. Contact your reseller for current product information.



Page 3

Chapter 1. Introduction........................................................................................................7

1.1. Audience ................................................................................................................................................... 7

1.2. Product Overview .................................................................................................................................. 7

1.3. EtherNet/IP Firmware .......................................................................................................................... 8

1.3.1. Traditional EtherNet/IP System Architecture (Firmware V2.x) ................................................... 8

1.3.2. Enhanced EtherNet/IP System Architecture (Firmware 3.x) ........................................................ 8

1.3.3. Filtering and Data Extraction Functionality (Patent Pending)..................................................... 9

1.4. Locating the Latest Software and Documents .............................................................................. 10

1.5. EtherNet/IP Application Setup ......................................................................................................... 11

Chapter 2. Programming Interface..................................................................................13

2.1. Overview................................................................................................................................................. 13

2.1.1. ControlLogix Family....................................................................................................................... 13

2.1.2. PLC-5/SLC or MicroLogix .............................................................................................................. 13

2.1.3. What is EtherNet/IP? ..................................................................................................................... 14

2.2. Data Type Definitions ......................................................................................................................... 14

2.3. EtherNet/IP Interface Profile (ControlLogix) ...............................................................................14

2.3.1. Serial Port Configuration Object Definition (70 Hex) .................................................................. 14

2.3.1.1. Class Attributes..................................................................................................................... 15

2.3.1.2. Instance Attributes ............................................................................................................... 15

2.3.1.3. Common Services .................................................................................................................. 20

2.3.1.4. Instance Attribute Definitions.............................................................................................. 20

2.3.2. Serial Port Data Transfer Object Definition (71 Hex) .................................................................. 29

2.3.2.1. Class Attributes..................................................................................................................... 29

2.3.2.2. Instance Attributes ............................................................................................................... 29

2.3.2.3. Common Services .................................................................................................................. 29

2.3.2.4. Instance Attribute Definitions.............................................................................................. 30

2.3.3. Serial Port Statistics Object Definition (72 Hex) .......................................................................... 31

2.3.3.1. Class Attributes..................................................................................................................... 31

2.3.3.2. Instance Attributes ............................................................................................................... 31

2.3.3.3. Common Services .................................................................................................................. 31

2.3.3.4. Instance Attribute Definitions.............................................................................................. 32

2.3.4. Socket Port Configuration Object Definition (73 Hex) ................................................................. 33

2.3.4.1. Class Attributes..................................................................................................................... 33

2.3.4.2. Instance Attributes ............................................................................................................... 33

2.3.4.3. Common Services .................................................................................................................. 39

2.3.4.4. Instance Attribute Definitions.............................................................................................. 40

2.3.5. Socket Port Data Transfer Definition Object (74 Hex) ................................................................. 48

2.3.5.1. Class Attributes..................................................................................................................... 48

2.3.5.2. Instance Attributes ............................................................................................................... 48

2.3.5.3. Common Services .................................................................................................................. 48

2.3.5.4. Instance Attribute Definitions.............................................................................................. 49

DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev. L Table of Contents - iii

Page 4

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 .........................................................................................................50

2.3.6.1.3. Status Word .....................................................................................................................50

2.3.6.1.4. Common Services ............................................................................................................50

2.3.6.2. Message Router Object (02 Hex) .......................................................................................... 51

2.3.6.2.1. Class Attributes...............................................................................................................51

2.3.6.2.2. Instance Attributes .........................................................................................................51

2.3.6.2.3. Common Services ............................................................................................................51

2.3.6.3. Connection Manager Object (06 Hex) .................................................................................. 51

2.3.6.4. Port Object (F4 Hex - 1 instance) ......................................................................................... 52

2.3.6.3.1. Instance Object Specific Services ...................................................................................51

2.3.6.4.1. Class Attributes...............................................................................................................52

2.3.6.4.2. Instance Attributes .........................................................................................................52

2.3.6.4.3. Common Services ............................................................................................................52

2.3.6.5. TCP Object (F5 Hex - 1 instance) ......................................................................................... 52

2.3.6.5.1. Class Attributes...............................................................................................................52

2.3.6.5.2. Instance Attributes .........................................................................................................53

2.3.6.5.3. Common Services ............................................................................................................53

2.3.6.6. Ethernet Link Object (F6 Hex)............................................................................................. 54

2.3.6.6.1. Class Attributes...............................................................................................................54

2.3.6.6.2. Instance Attributes .........................................................................................................54

2.3.6.6.3. Common Services ............................................................................................................54

2.3.6.7. PCCC Object (67 Hex)........................................................................................................... 54

2.3.6.7.1. Class Attributes...............................................................................................................54

2.3.6.7.2. Instance Attributes .........................................................................................................54

2.3.6.7.3. Instances..........................................................................................................................54

2.3.6.7.4. Common Services ............................................................................................................55

2.3.6.7.5. Message Structure for Execute PCCC ...........................................................................55

2.4. PLC-5/SLC and MicroLogix Interfaces............................................................................................ 56

2.4.1. Requirements .................................................................................................................................. 57

2.4.1.1. SLC 5/05................................................................................................................................. 57

2.4.1.2. PLC-5 ..................................................................................................................................... 57

2.4.2. Messages ......................................................................................................................................... 58

2.4.2.1. DeviceMaster UP File Addressing ....................................................................................... 58

2.4.3. Receive Data Message .................................................................................................................... 59

2.4.4. Transmit Data Message ................................................................................................................. 60

2.4.5. Sequence Number Messages .......................................................................................................... 61

2.4.6. Retrieve Statistics Message ........................................................................................................... 61

2.4.7. Receive Communication Methods .................................................................................................. 63

2.4.7.1. Unsolicited - Write to File Receive Method ......................................................................... 63

2.4.7.2. Unsolicited - Write to File Synced Receive Method............................................................. 63

2.4.7.3. Polling Receive Method ......................................................................................................... 64

Chapter 3. Embedded Configuration Pages...................................................................65

3.1. Overview................................................................................................................................................. 65

3.2. Embedded Web Pages Overview ....................................................................................................... 66

3.3. Serial Device Configuration Page .................................................................................................... 67

3.3.1. Edit Serial Port Configuration Page.............................................................................................. 67

3.3.2. Serial Configuration ....................................................................................................................... 68

3.3.3. Serial Packet Identification............................................................................................................ 69

3.4. Ethernet Device Configuration Page............................................................................................... 71

3.5. Edit Socket Port Configuration Page .............................................................................................. 71

3.5.1. Device TCP Connection Configuration .......................................................................................... 71

3.5.2. Socket Packet ID Settings .............................................................................................................. 73

3.6. Common Configuration Areas (Serial or Ethernet Device) ....................................................... 75

3.6.1. Ethernet/IP Settings....................................................................................................................... 75

3.6.2. Filtering/Data Extraction Configuration....................................................................................... 77

3.6.3. Application TCP Connection Configuration.................................................................................. 80

3.6.4. Saving Port Options........................................................................................................................ 81

iv - Table of Contents DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev. L

Page 5

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 ...................................................................................................................... 85

Chapter 4. Diagnostic and Statistics Pages ...................................................................87

4.1. Communication Statistics .................................................................................................................. 88

4.2. Display Serial Logs .............................................................................................................................. 94

4.3. Display Ethernet Device Logs ........................................................................................................... 95

4.4. PLC Interface Diagnostics ................................................................................................................. 96

Chapter 5. Programming the PLC....................................................................................99

5.1. Programming Guidelines ................................................................................................................... 99

5.2. PLC Algorithms................................................................................................................................... 100

5.2.1. Unsolicited - Write-to-Tag/File PLC Algorithm .......................................................................... 100

5.2.2. Unsolicited - Write-to-Tag/File-Synced PLC Algorithm ............................................................. 101

5.2.3. Polling PLC Algorithm ................................................................................................................. 102

5.3. ControlLogix PLC Programming Example Instructions .......................................................... 103

5.3.1. What is RSLogix 5000?................................................................................................................. 103

5.3.2. Requirements ................................................................................................................................ 103

5.3.3. loopbackExampleTagWrite.L5K .................................................................................................. 104

5.3.4. loopbackExampleTagWriteSynced.L5K ...................................................................................... 105

5.3.5. loopbackExamplePolling.L5K ...................................................................................................... 106

5.3.6. Configuring the DeviceMaster UP for the RSLogix 5000 Example Programs Using the Web Page 107

5.3.7. RSLogix 5000 Screen Examples................................................................................................... 108

5.3.7.1. Transmit Data to the DeviceMaster UP ............................................................................ 108

5.3.7.2. Send Configuration to DeviceMaster UP ........................................................................... 109

5.3.7.3. Request Data from DeviceMaster UP ................................................................................ 111

5.3.7.4. Send Consumed Sequence Number to DeviceMaster UP ................................................. 112

5.3.7.5. Request Statistics from DeviceMaster UP......................................................................... 113

5.3.7.6. Communication Window for all Messages sent to the DeviceMaster UP ........................ 114

5.3.8. Modifying an RSLogix 5000 PLC Program Example (Older Versions) ..................................... 114

5.4. SLC or MicroLogix PLC Programming Example Instructions................................................ 116

5.4.1. What is RSLogix 500?................................................................................................................... 116

5.4.2. Requirements ................................................................................................................................ 116

5.4.3. Example Program Considerations ............................................................................................... 117

5.4.3.1. lpbkExampleSlcMsgPollRS500 - SLC PLC........................................................................ 117

5.4.3.2. lpbkExamplePlc5MsgPollRS500 - SLC PLC...................................................................... 117

5.4.3.3. lpbkExampleSlcMsgFileRS500 - SLC PLC........................................................................ 117

5.4.3.4. lpbkExampleSlcMsgFileSyncRS500 - SLC PLC................................................................ 118

5.4.3.5. LPBKEXAMPLESLCMSGFILERS500_MICROLGX - MicroLogix PLC ......................... 118

5.4.3.6. LPBKEXAMPLESLCMSGPOLLRS500_MICROLGX - MicroLogix PLC........................ 118

5.4.4. Configure the DeviceMaster UP for the RSLogix 500 Example Program - SLC PLC .............. 119

5.4.5. Configure and Run the RSLogix 500 Example Program - SLC PLC ......................................... 120

DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev. L Table of Contents - v

Page 6

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. SLC Typed Read - Retrieve Statistics Message - SLC PLC .............................................. 128

5.4.6.5. SLC Typed Write - Set Receive Produced Sequence Number Message - SLC PLC......... 129

5.4.6.6. SLC Typed Write - Set Transmit Produced Sequence Number Message - SLC PLC...... 130

5.4.6.7. PLC-5 Typed Read - Receive Data Message - SLC PLC ................................................... 131

5.4.6.8. PLC-5 Typed Write - Transmit Data Message - SLC PLC ............................................... 132

5.4.6.9. PLC-5 Typed Read - Retrieve Statistics Message - SLC PLC .......................................... 133

5.4.6.10. PLC-5 Typed Write - Set Receive Produced Sequence Number Message - SLC PLC ... 134

5.4.6.11. PLC-5 Typed Write - Set Transmit Produced Sequence Number Message - SLC PLC 135

5.4.6.12. MultiHop Screen ............................................................................................................... 135

5.4.7. Configuring and Running the MicroLogix RSLogix 500 Example Program ............................. 136

5.4.7.1. Receive Sequence Number Init Message ........................................................................... 138

5.4.7.2. Transmit Sequence Number Init Message ........................................................................ 139

5.4.7.3. Transmit Data Message...................................................................................................... 140

5.4.7.4. Receive Data Message......................................................................................................... 141

5.4.7.5. MultiHop Screen ................................................................................................................ 142

5.5. PLC-5 PLC Programming Example Instructions........................................................................ 143

5.5.1. What is RSLogix 5?....................................................................................................................... 143

5.5.2. Requirements ................................................................................................................................ 143

5.5.3. Example Program Considerations ............................................................................................... 144

5.5.4. lpbkExampleSlcMsgPollRS5 ........................................................................................................ 144

5.5.5. lpbkExamplePlc5MsgPollRS5 ...................................................................................................... 144

5.5.6. lpbkExamplePlc5MsgFileRS500.................................................................................................. 144

5.5.7. lpbkExamplePlc5MsgFileSyncRS5.............................................................................................. 145

5.5.8. Configure the DeviceMaster UP for the RSLogix 5 Program..................................................... 145

5.5.9. Configure and Run the Example RSLogix 5 Program................................................................ 147

5.5.10. RSLogix 5 Screen Examples....................................................................................................... 149

5.5.10.1. Requirements .................................................................................................................... 149

5.5.10.2. Setting up Processor and Ethernet Channel ................................................................... 149

5.5.10.3. SLC Typed Read - Receive Data Message........................................................................ 151

5.5.10.4. SLC Typed Write - Transmit Data Message.................................................................... 152

5.5.10.5. SLC Typed Read - Retrieve Statistics Message............................................................... 153

5.5.10.6. SLC Typed Write - Set Receive Produced Sequence Number Message ......................... 154

5.5.10.7. SLC Typed Write - Set Transmit Produced Sequence Number Message ...................... 155

5.5.10.8. PLC-5 Typed Read - Receive Data Message .................................................................... 156

5.5.10.9. PLC-5 Typed Write - Transmit Data Message ................................................................ 157

5.5.10.10. PLC-5 Typed Read - Retrieve Statistics Message ......................................................... 158

5.5.10.11. PLC-5 Typed Write - Set Receive Produced Sequence Number Message .................... 159

5.5.10.12. PLC-5 Typed Write - Set Transmit Produced Sequence Number Message ................. 160

5.5.10.13. MultiHop Screen ............................................................................................................. 160

5.6. EDS Files .............................................................................................................................................. 161

5.6.1. Requirements ................................................................................................................................ 161

5.6.2. Adding DeviceMaster UP to RSLinx ........................................................................................... 162

5.6.3. Adding EDS Files to RSLinx ........................................................................................................ 162

5.6.4. Troubleshooting RSLinx............................................................................................................... 163

Chapter 6. Troubleshooting and Technical Support .................................................165

6.1. Troubleshooting Checklist .............................................................................................................. 165

6.2. General Troubleshooting.................................................................................................................. 166

6.3. Technical Support .............................................................................................................................. 166

vi - Table of Contents DeviceMaster UP EtherNet/IP User Guide: 2000424 Rev. L

Page 7

Chapter 1. Introduction

This User Guide provides detailed information about the following topics:

• Programming Interface

• Embedded Configuration Pages

• Diagnostic and Statistics Pages The DeviceMaster UP Hardware Installation and Configuration Guide

• Connecting the hardware and devices

• Programming the DeviceMaster UP IP address,

• Uploading EtherNet/IP firmware The EtherNet/IP Interface Configuration Quick Start provides embedded web page configuration procedures

if you have Read-only or read/write devices, which provides procedures for your devices. See Locating

tools.

the Latest Software and Documents on Page 10 to locate the latest firmware, documentation, and

1.1. Audience

on Page 13

on Page 65

on Page 87

provides the following information:

The primary audience of this document is the person responsible for installing the DeviceMaster UP and programming the PLC. This guide assumes you are familiar with the following topics:

• Windows operating system

• EtherNet/IP

• Allen-Bradley ControlLogix family, PLC-5, SLC or MicroLogix PLCs

• RSLogix 5000, RSLogix 500 or RSLogix 5 programs

1.2. Product Overview

Your particular DeviceMaster UP model may or may not have the EtherNet/IP firmware loaded (depending on the model you purchased).

Note: Models that have EtherNet/IP loaded on the DeviceMaster UP are identified in PortVision DX and the

DeviceMaster UP is labeled accordingly.

This document describes how to configure the DeviceMaster UP for the EtherNet/IP protocol after basic DeviceMaster UP installation and configuration procedures.

You can configure and manage the DeviceMaster UP through one of the following methods:

• Embedded web page interface

• EtherNet/IP Interface Profile objects

- Receive mode ensures data received by the PLC is not overwritten before it can be processed.

- Disabling of non-filtered receive queue ensures the PLC only receives the latest received serial/ Ethernet device data.

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 1. Introduction - 7

Page 8

EtherNet/IP Firmware

Traditional EtherNet/IP System Architecture (Firmware V2.x)

Comtrol EtherNet/IP System Architecture (V3.x)

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.

1.3.2. Enhanced EtherNet/IP System Architecture (Firmware 3.x)

Using the Ethernet TCP/IP firmware V3.x doubles the capacity of the DeviceMaster UP by providing a raw/ ASCII interface to both serial and Ethernet TCP/IP devices.

For example:

• The DeviceMaster UP 1-port provides EtherNet/IP support for one serial device and one Ethernet device for a total of two devices.

• The DeviceMaster UP 2-port provides EtherNet/IP support for two serial devices and two Ethernet devices for a total of four devices.

• The DeviceMaster UP 4-port provides EtherNet/IP support for four serial devices and four Ethernet devices for a total of eight devices.

EtherNet/IP firmware 3.x provides an application interface for both serial and Ethernet devices. You can connect any application, such as a configuration, database, or control application, via the application socket port to the serial and/or Ethernet devices while the device(s) are attached to the PLC via EtherNet/IP.

8 - Chapter 1. Introduction DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 9

Filtering and Data Extraction Functionality (Patent Pending)

EtherNet/IP Filtering Functionality (V3.x)

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.

- Barcode filtering of all UPC/ EAN formatted barcodes data to both the PLC and/or application.

• Data extraction

- RFID data extraction extracts all parameters, such as company code, product code, and serial numbers, from any or all of the 43 EPCglobal tag formats. It then transfers the data to the PLC and/ or application in a consistent and simple format.

- Barcode data extraction extracts the company, product, and numbering codes from UPC/EAN formatted barcodes. It then transfers the data to the PLC and/or application in a consistent and simple format.

• Environment specific support

- Support for multiple RFID reader tag formats.

- RFID antenna grouping.

- Aging of filtered string/RFID/barcode entries.

- Discarding of unrecognized RFID and barcode messages.

If you are running firmware V2.x, you may want to review the following list additional features provided in firmware V3.x.

• Improved PLC interfaces

- Increased PLC interface bandwidth provides improved performance and lower latencies when interfacing to higher bandwidth serial and Ethernet devices such as RFID readers.

- Transfer of large received serial device packets up to 1518 bytes.

- Transfer of large received Ethernet device packets up to 2048 bytes.

- Throttling of received data to the PLC in the Write-to-Tag/File receive mode ensures data received by the PLC is not overwritten before it can be processed.

- Disabling of non-filtered receive queue ensures the PLC only receives the latest received serial/ Ethernet device data.

• New embedded web pages

- PLC Interface Diagnostics page, which provides statistics and error messages to monitor and help diagnose PLC interface problems.

- Serial/Ethernet Device Communication Statistics page, which is a comprehensive statistics page for all serial and Ethernet device interfaces. Includes packet, byte, and error counts to the PLC(s) and Application(s) as well as comprehensive filtering statistics.

- Ethernet Device Interface Configuration page, which provides a user interface to the Ethernet device interface configuration.

For detailed information about filtering and data extraction, see the DeviceMaster UP Filtering and Data

Extraction Reference Guide.

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 1. Introduction - 9

Page 10

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.

Software and Documentation FTP

Use PortVision DX to manage Comtrol Ethernet-attached devices to:

• Scan the network for attached devices

• View networked devices in real-time

• Access product-specific network settings configurations

• Assign IP addresses and network settings to one or multiple devices

• Upload the latest firmware or Bootloader

PortVision DX

(Windows)

EtherNet/IP Firmware

DeviceMaster UP Hardware Installation and Configuration Guide

• Save and load configuration files

• Access DeviceMaster UP configuration web pages

• Access Telnet/SSH sessions

• Remotely reboot devices

• Download technical documentation

• Enable event logging to assist in monitoring and troubleshooting

• Create shortcuts to quickly access your favorite applications

• Organize devices into folders and create multiple views

• Enter notes about a folder or device

This is the application that may or may not have been loaded on the DeviceMaster UP depending on the model that was ordered.

You may need to use PortVision DX to load this firmware. This contains hardware installation, configuration information, and

connector information.

This includes using PortVision DX to configure the IP address and if necessary, how to update the firmware.

EtherNet/IP Interface Configuration Quick Start

This document with web interface configuration procedures.

The User Guide contains detailed information about the EtherNet/IP (application) firmware, which includes additional information about

EtherNet/IP User Guide

the web configuration interface for EtherNet/IP.

It also discusses the example PLC programs that were installed on your system and provides a Programming Interface chapter.

This Guide discusses the data extraction and filtering processes in the DeviceMaster UP are designed to off load as much work as possible

DeviceMaster UP Filtering and Data Extraction Reference

from the PLC and/or application and provide a very simple and easy to use interface for standard RFID and barcode data.

Guide

This functionality and interface is designed to save dozens, possibly hundreds of lines of ladder logic in a typical PLC program.

10 - Chapter 1. Introduction DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 11

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.

• Configure the DeviceMaster UP IP address using PortVision DX

Note: If necessary, refer to the DeviceMaster UP Hardware Installation and Configuration Guide

above procedures.

Use the following steps to complete the DeviceMaster UP configuration for EtherNet/IP.

1. Select the appropriate programming procedure for the following interfaces:

Interfaces Programming Procedure

• Program the PLC. See the instructions in ControlLogix PLC

Programming Example Instructions on Page 103.

ControlLogix PLC

• (Optional) Access the DeviceMaster UP Server Configuration page to configure the serial/socket port settings, if you did not configure the serial/socket port setting in the PLC program. See the DeviceMaster UP

Interface Configuration Guide for procedures and reference Embedded

Configuration Pages on Page 65, if necessary.

• Program the SLC or MicroLogix PLC, see the instructions in SLC or

MicroLogix PLC Programming Example Instructions on Page 116.

SLC or MicroLogix PLC

• Access the DeviceMaster UP Server Configuration page to configure the serial/socket port settings. See the DeviceMaster UP Interface

Configuration Guide for procedures and reference Embedded

Configuration Pages on Page 65, if necessary.

• Program the PLC-5 PLC, see the instructions in PLC-5 PLC

Programming Example Instructions on Page 143.

PLC-5 PLC

• Access the DeviceMaster UP Server Configuration page to configure the serial/socket port settings. See the DeviceMaster UP Interface

Configuration Guide for procedures and reference Embedded

Configuration Pages on Page 65, if necessary.

2. Connect your serial device or devices and make sure all Ethernet devices are attached to the same Ethernet subnet. If necessary, refer to the DeviceMaster UP Hardware Installation and Configuration

Guide.

for the

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 1. Introduction - 11

Page 12

EtherNet/IP Application Setup

12 - Chapter 1. Introduction DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 13

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. ControlLogix Family

The DeviceMaster UP supports ControlLogix PLCs. You can configure DeviceMaster UP through the PLC program or the DeviceMaster UP Server Configuration web page. The DeviceMaster UP interface for the ControlLogix PLC is described in 2.3.

The EtherNet/IP Quick Start read/write devices such as printers.

5.3.

ControlLogix PLC Programming Example Instructions on Page 103 provides descriptions of the RSLogix

5000 PLC program examples intended to aid the PLC programmer. You can also use the Server Configuration page on the DeviceMaster UP when you do not want to use the PLC

programming interface to configure the DeviceMaster UP. Chapter 3. 65 describes the web pages on the DeviceMaster UP and provides instructions for configuring the serial/ socket port settings

describes the quick start for read-only devices such as barcode scanners and

EtherNet/IP Interface Profile (ControlLogix) on Page 14.

Embedded Configuration Pages on Page

2.1.2. PLC-5/SLC or MicroLogix

The DeviceMaster UP supports PLC-5, SLC and MicroLogix PLCs. You must configure the DeviceMaster UP through the web pages on the DeviceMaster UP. The DeviceMaster UP interface for the PLC-5/SLC or MicroLogix PLC is described in 2.4.

The EtherNet/IP Quick Start read/write devices such as printers.

• SLC or MicroLogix PLC and want more information than provided in the EtherNet/IP Quick Start, see .5.4.

SLC or MicroLogix PLC Programming Example Instructions on Page 116, which contains

descriptions of the RSLogix 500 PLC program examples intended to aid the PLC programmer.

• PLC-5 PLC and want more information than provided in the EtherNet/IP Quick Start, see 5.5.

Programming Example Instructions on Page 143, which contains descriptions of the RSLogix 5 PLC

program examples intended to aid the PLC programmer.

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 13

describes the quick start for read-only devices such as barcode scanners and

PLC-5/SLC and MicroLogix Interfaces on Page 56.

PLC-5 PLC

Page 14

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. The EtherNet/IP application layer protocol is based on the Common Industrial Protocol (CIP) layer. Building on these protocols, EtherNet/IP provides a seamless integrated system from the Industrial floor to the enterprise network.

2.2.DataTypeDefinitions

Thefollowinglistdefinestheavailabledatatypes.

Data Type Definition

USINT Unsigned short integer (8-bits) UINT Unsigned integer (16-bit) UDINT Unsigned double integer (32-bits) INT Signed integer (16-bits) DINT Signed double integer (32-bits) BYTE Bit string (8-bits) WORD Bit string (16-bits) DWORD Bit string (32-bits) STRING Character string (1-byte per character)

2.3.EtherNet/IPInterfaceProfile(ControlLogix)

ThissectiondescribestheEtherNet/IPobjectsincludedintheControlLogixEtherNet/IPinterfaceandsupportedbythe DeviceMasterUP.

2.3.1. Serial Port Configuration Object Definition (70 Hex)

The Serial Port Configuration vendor specific object defines the protocol by which:

• A PLC can communicate with a serial port device through a DeviceMaster UP over EtherNet/IP.

• An optional application can communicate with a serial device through the DeviceMaster UP over an Ethernet TCP/IP socket port.

• The optional serial data filtering and data extraction functions can be implemented.

Note: The instance number corresponds to the associated serial port number on the DeviceMaster UP. (Port

numbers are numbered from one to N.)

You can disregard this object definition if you configure the DeviceMaster UP using the Server Configuration web page. See Chapter 3. the embedded web page.

Embedded Configuration Pages on Page 65 to configure the DeviceMaster UP using

14 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 15

Class Attributes

2.3.1.1. Class Attributes

Attribute ID Name Data Type Data Value(s) Access Rule

1 Revision UINT 1 Get 2 Max Instance UINT Number of ports on the DeviceMaster UP Get 3 Num Instances UINT Number of ports on the DeviceMaster UP Get

2.3.1.2. Instance Attributes

Note: Get returns the last command sent.

Attribute ID Name

(Default=0)

(Default=9600)

Serial Port Device Type UDINT 0=Raw Data Device Set/Get

Serial Port Commands DWORD

Baud Rate UDINT

(Default=0

Interface Mode USINT

RS-232)

(Default=0

Parity USINT

None)

(Default=8)

(Default=1)

Data Bits USINT

Stop Bits USINT Valid Values: 1 or 2 Set/Get

(Default=0

Flow Control USINT

None)

(Default=0

DTR Control USINT

Off)

Data Type

Data Value(s)

1=Reset Serial Port 2=Save in Flash 4=Clear Sequence Counters 8=Clear Statistics Counters

Valid rates: 300, 600, 1200, 2400, 4800, 9600

(default), 19200, 38400, 57600, 115200, 230400

0=RS-232 (Default) 1=RS-422 2=RS-485

0=None (Default) 1=Even 2=Odd

Valid Values: 5-8

0=None (Default) 1=RTS/CTS 2=XON/XOFF 3=Half Duplex

0=Off (Default) 1=On

Access

Rule

Set/Get

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 15

Page 16

Instance Attributes

Attribute ID Name

Data Type

Data Value(s)

PLC Transmit STX Append Value Structure of:

Length

USINT

0,1,2 (0=No STX)

(Default=0

No STX)

Value1 (Only valid if Length

not zero)

Value2 (Only valid if

Length=2)

USINT

0 to 255

PLC Transmit ETX Append Value Structure of:

Length

USINT

0,1,2 (0=No ETX) (Default=0)

(Default=0)

Value1 (Only valid if Length

not zero)

Value2 (Only valid if

Length=2)

USINT

0 to 255

12 Reserved UINT 0 Get

Receive STX Detect Value

Structure of:

Length

USINT

0,1,2 (0=No STX) (Default=1)

Access

Rule

Set/Get

(Default=1)

(Default=Value1

Value1=3)

(Default=200)

Value1 (Only valid if Length

not zero)

Value2 (Only valid if

Length=2)

Receive ETX Detect Value

Structure of:

Length

Value1 (Only valid if Length not zero)

Value2 (Only valid if Length=2)

Receive Timeout Between Packets (if no ETX or time to wait for ETX value)

USINT

UINT (msec)

0 to 255

0 to 255 (Default: Value1 = 2)

0,1,2 (0=No ETX) (Default=1)

0 to 255

0 to 255 (Default: Value1 = 3)

0 to 65535 (Default = 200 msec)

Set/Get

16 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 17

Instance Attributes

Attribute ID Name

Data Type

Data Value(s)

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

(Default=03)

Serial Port Transfer Options

WORD (bitwise

OR)

08 Hex = (PLC-5/SLC) Tx MS Byte First 10 Hex = Tx Sequence Number Checking 20 Hex = Disable Queuing of Non-

Filtered Rx Messages

40 Hex = Strip received STX/ETX

characters to the application (Default = 03)

80 Hex = Drop oversized received packets

(Default=3

Polling)

Receive (DeviceMaster UP to PLC) Ethernet Data Transfer Method

USINT

0=OFF 1=Unsolicited - Write-to-Tag 2=Unsolicited - Write-to-Tag-Synced

3=Polling (Default=3) 18 Reserved USINT 0 Get 19

(Default=440)

(Default=40)

Maximum Receive Data Packet Size

Maximum PLC Update Rate (No more than one message per time interval in ms.)

UINT 1-1518 (Default=440) Set/Get

UINT (ms)

10-65535 (Default = 40) Set/Get

21 Reserved USINT 0 Get 22

(Default=0)

PLC Controller Slot Number USINT

23 PLC IP Address UDINT

Receive (DeviceMaster UP to

PLC) Produced Data Tag Name

25 Application Socket Enable USINT

26 Application Listen Enable USINT

STRING (Array of 40 SINTs)

0 to Max Slot Number on PLC

(Default=0)

00000000 Hex to FFFFFFFF Hex

(Mask= 255.255.255.255)

ASCII string Set/Get

0=Disabled

1=Enabled

0=Disabled

1=Enabled

0=Never 27 Application Connect Mode USINT

1=Connect Always

2=Connect On Data

28 Application Disconnect Mode USINT

Application Listen Socket Port

Application Connect Socket Port

Application Connect IP Address

UINT 0-65535 Set/Get

UDINT

0=Never

1=Disconnect On Idle

00000000 Hex to FFFFFFFF Hex

(Mask=255.255.255.255)

Access

Rule

Set/Get

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 17

Page 18

Instance Attributes

Attribute ID Name

32 Application Idle Timeout

33 To PLC Filter Mode USINT

34 To Application Filter Mode USINT

Discard Unrecognized Data

Mode (RFID and Barcode Filter

mode only)

36 RFID Antenna Grouping USINT

37 To PLC Filter Options

38 To Application Filter Options

39 Filter Age Time

40 RFID Reader Interface Type UINT

Data Type

UDINT (ms)

USINT

WORD (Bitwise OR)

UDINT (ms)

Data Value(s)

Access

Rule

0 to FFFFFFFF Hex Set/Get

0=Off 1=String (128 byte maximum) 2=RFID (EPCglobal formats)

Set/Get

3= Barcode (UPC/EAN formats) 0=Off

1=String (128 byte maximum) 2=RFID (EPCglobal formats)

Set/Get

3= Barcode (UPC/EAN formats) 0=Off

1=To PLC 2=To application

Set/Get

3=To PLC/application 0=None

1=Groups of Twos 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 04 Hex = Antenna Number 08 Hex = Company Code

Set/Get

10 Hex = Product/Location Code 20 Hex = Serial Number

01 Hex = Encoding Scheme 02 Hex = Filter Code 04 Hex = Antenna Number 08 Hex = Company Code

Set/Get

10 Hex = Product/Location Code 20 Hex = Serial Number

0 - FFFFFFFF Hex Set/Get

0=Unspecified 10=Alien (Text Mode) 11=Alien (Terse Mode)

Set/Get

20=Intermec (Hex ASCII Mode)

18 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 19

Instance Attributes

Attribute ID Name

Barcode Formats (Barcode Filtering Only)

Application Transmit STX Append Value

Structure of:

Length

Data Type

UINT

USINT

Data Value(s)

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 04 Hex=Eight Company/Two Product

Digits 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; Three Company/Four

Product Digits 30 Hex=UPC-E

0,1,2 (0=No STX) (Default=0)

Access

Rule

Set/Get

(Default=0)

Value1 (Only valid if Length

not zero)

Value2 (Only valid if

Length=2)

USINT

0 to 255

Application Transmit ETX Append Value

Structure of:

Length

USINT

0,1,2 (0=No ETX) (Default=0)

(Default=0)

Value1 (Only valid if Length

USINT

0 to 255

not zero)

Value2 (Only valid if

Length=2)

USINT

0 to 255

44 Reserved USINT[2] 0 Get

Set/Get

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 19

Page 20

Common Services

2.3.1.3. Common Services

Service Code Implemented in Class Implemented in Instance Service Name

01 Hex Yes Yes Get_Attributes_All 02 Hex No Yes Set_Attributes_All 0E Hex Yes Yes Get_Attribute_Single 10 Hex No Yes Set_Attribute_Single

2.3.1.4. Instance Attribute Definitions

Attribute

Attribute 1

Serial Port Device

Attribute 2

Serial Port Commands

Attributes 3 to 9

Standard Serial Port Settings

Attribute 10

PLC Transmit STX Append Value

Description

This attribute indicates the Serial Port Device Type. Raw Data device is the only currently supported option.

DeviceMaster UP supports the following commands:

• Reset serial port - This option resets the serial port hardware and statistics

counters. You must reset the DeviceMaster UP after modifying any of the serial port configuration options, including: baud rate, interface mode, parity, data bits, stop bits, flow control, or DTR control. It does not clear the sequence counters.

• Save in Flash - This option saves the port configuration in flash memory. These

settings are restored when you reboot the DeviceMaster UP.

• Clear sequence counters - This option clears the Receive Produced and Consumed

Sequence counters for the selected port.

• Clear statistics counters - This option clears the statistics counters for the selected

port.

These are standard serial port settings. Attribute 10 - PLC Transmit STX Append Value - You can set this attribute to append

an STX (start of transmission) byte sequence which is configurable as 1 or 2-bytes to the beginning of the serial packet before it is sent.

The length indicates the number of STX bytes. The valid values for length are:

• 0 (zero) - Setting this attribute to zero disables this function.

• 1 (one STX byte) - Inserts one STX byte before the data.

• 2 (two STX bytes) - Inserts two STX bytes before the data.

• Value1 - Specifies the transmit character associated with the first STX byte. (Only

if the length is not zero.) You can specify a value between 0 and 255.

• Value2 - Specifies the transmit character associated with the second STX byte.

(Only if length is two bytes.) You can specify a value between 0 and 255.

You can set this attribute to append an STX (start of transmission) byte sequence which is configurable as 1 or 2-bytes to the beginning of the serial packet before it is sent.

The length indicates the number of STX bytes. The valid values for length are:

• 0 (zero) - Setting this attribute to zero disables this function.

• 1 (one STX byte) - Inserts one STX byte before the data.

• 2 (two STX bytes) - Inserts two STX bytes before the data.

• Value1 - Specifies the transmit character associated with the first STX byte. (Only if the length is not zero.) You can specify a value between 0 and 255.

• Value2 - Specifies the transmit character associated with the second STX byte. (Only if length is two bytes.) You can specify a value between 0 and 255.

20 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 21

Instance Attribute Definitions

Attribute

Attribute 11

PLC Transmit ETX Append Value

Attribute 13

Receive STX Detect Value

Attribute 14

Receive ETX Detect Value

Attribute 15

Receive Timeout Between Packets

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:

• 0 (zero) - Setting this attribute to zero disables this function.

• 1 (one ETX byte) - Inserts one ETX byte at the end of the data.

• 2 (two ETX bytes) - Inserts two ETX bytes at the end of the data.

• Value - Specifies the transmit character associated with the first ETX byte. (Only if

the length is not zero.) You can specify a value between 0 and 255.

• Value2 - Specifies the transmit character associated with the second ETX byte.

(Only if length is 2-bytes.) You can specify a value between 0 and 255.

This attribute detects an STX (start of transmission) byte sequence which is configurable as 1 or 2-bytes when it receives a serial 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.

• 1 (one STX byte) - Scans serial data for one STX byte. If the DeviceMaster UP finds

an STX byte it collects the data. If the first byte is not the STX byte, the DeviceMaster UP discards the byte. The DeviceMaster UP continues to discard the bytes until the DeviceMaster UP finds an STX byte.

• 2 (two STX bytes) - Scans serial data for two STX bytes. If the DeviceMaster UP

finds two STX bytes it collects the data. If the first two bytes are not the STX bytes, the DeviceMaster UP discards the bytes. Bytes continue to be discarded until the DeviceMaster UP finds two STX bytes.

• Value1 - Specifies the character that represents the first STX byte. DeviceMaster

UP looks for this character in the first STX byte. (Only if the length is not zero.) You can specify a value between 0 and 255.

• Value2 - Specifies the character that represents the second STX byte.

DeviceMaster UP looks for this character in the first STX byte. (Only if length is two bytes.) You can specify a value between 0 and 255.

This attribute detects an ETX (end of transmission) byte sequence which is configurable as 1 or 2 bytes marking the end of the serial packet.

The length indicates the number of ETX bytes. The valid values for length are:

• 0 (zero) - Setting this attribute to zero disables this function. When disabled, the

DeviceMaster UP uses the Receive Timeout Between Packets (attribute 15) to indicate the end of data packet.

• 1 (one ETX byte) - Scans serial data for one ETX byte. When the DeviceMaster UP

finds an ETX byte it identifies the data as a serial packet.

• 2 (two ETX bytes) - Scans serial data for two ETX bytes. When the DeviceMaster

UP finds two ETX bytes it identifies the data as a serial packet.

• Value1

- Specifies the character to scan for in the first ETX byte. (Only if the length

is not zero.) You can specify a value between 0 and 255.

• Value2 - Specifies the character to scan for in the second ETX byte. (Only if length

is 2-bytes.) You can specify a value between 0 and 255.

This attributes specifies:

• How long DeviceMaster UP waits (in milliseconds) if the Receive ETX length is not zero (0) and it does not receive an ETX byte sequence.

• The time to wait (in milliseconds) between serial packets if the Receive ETX Detect length is set to zero (0).

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 21

Page 22

Instance Attribute Definitions

Attribute

Attribute 16

Serial Port Transfer Options

Description

This attribute specifies special serial port transfer options. The following options are supported:

• 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.

• 04 Hexadecimal (Bit 2) - (PLC-5/SLC only) DeviceMaster UP receives Most

Significant (MS) byte of 16-bit integer first. The default is transmit Least Significant (LS) byte first.

08 Hexadecimal (Bit 3) - (PLC-5/SLC only) DeviceMaster UP transmit Most significant (MS) byte of 16-bit integer first. The default is transmit Least Significant (LS) byte first.

• 10 Hexadecimal (Bit 4) - Enable Transmit Sequence Number Checking.

- DeviceMaster UP rejects messages with duplicate sequence numbers (that is, the same sequence number as the previous transmit data message) and increments the Duplicate Transmit Sequence Error Count.

- DeviceMaster UP transmits messages with unexpected transmit sequence numbers (that is, sequence numbers that are not the same as or are not equal to the previous sequence number plus one) and increments the Unexpected Transmit Sequence Error Count.

• 20 Hexadecimal (Bit 5) - Disable Queuing of Non-Filtered Rx messages to PLC. If

filtering is disabled, only the last message received is sent to the PLC.

• 40 Hexadecimal (Bit 6) - DeviceMaster UP strips received STX/ETX characters from

received packets before sending the packet to the application.

• 80 Hexadecimal (Bit 7) - Drop oversized received data packets. This attribute specifies the Ethernet data transfer method used by the DeviceMaster

UP. There are three methods that DeviceMaster UP can use to transfer data received from a serial device to the PLC. These methods are:

• Off - The DeviceMaster UP does not allow any data to be sent to the PLC.

• Unsolicited - Write-to-Tag receive method - DeviceMaster UP writes the received serial data directly into tag(s) on the PLC.

The following diagram shows the Write-to-Tag receive data flow:

Attribute 17

Receive (DeviceMaster UP to PLC) Ethernet Data Transfer Method

The following restrictions apply to this method:

•The Receive Data T ag Name (Attribute 24) must have the same name as the tag

defined on the PLC. (For more information, see Attribute 24 on Page 24.)

• The tag on the PLC must be of type SINT and must be large enough to contain

the sequence number, length, and data field associated with the received data structure. (For more information, see 2.3.2.

Serial Port Data Transfer Object

Definition (71 Hex) on Page 29.)

• An incremented sequence number indicates new data.

• The PLC program must scan and consume new data faster than the data can

be received on the serial port to ensure that no data is lost.

22 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 23

Instance Attribute Definitions

Attribute

Attribute 17 (Continued)

Receive (DeviceMaster UP to PLC) Ethernet Data Transfer Method

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. Then the DeviceMaster UP writes the data into the tag data location on the PLC in the same way as the Unsolicited - Write-to-Tag receive method. For more information, see the description of Attribute 4 in 2.3.2.

Serial Port Data Transfer Object

Definition (71 Hex) on Page 29. The following diagram shows the Write-to-Tag-

Synced receive data flow:

The following restrictions apply to this method:

•The Receive Data Area Tag Name (Attribute 24) must have the same name as the

tag defined on the PLC.

• The tag on the PLC must be an SINT type and large enough to contain the

sequence number, length, and data field associated with the received data structure. (For more information, see the 2.3.2.

Serial Port Data Transfer

Object Definition (71 Hex) on Page 29.)

• An incremented sequence number indicates new data.

• The DeviceMaster UP does not write new data to the tag on the PLC until the

consumed sequence number has been incremented to match the last produced sequence number.

• While the DeviceMaster UP queues received serial port data, the PLC program

must consume the new data faster than the data can be received on the serial port to ensure the receive buffers on the DeviceMaster UP do not overflow. (For example: If the serial port can receive two serial packets per second, then the consumption rate must be at least one packet every 500 microsecond.)

• Polling receive method - The PLC requests data on a periodic basis. In this method, DeviceMaster UP returns the serial data in the response to the

data request message. The PLC requests data by accessing the Serial Port Data Transfer Object Attribute 2. For more information, see the description of Attribute 2 in 2.3.2.

Serial Port Data Transfer Object Definition (71 Hex) on Page 29.

The following diagram shows the polling receive data flow:

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 23

Page 24

Instance Attribute Definitions

Application Socket Interface

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

Attribute 24

Receive (DeviceMaster UP to PLC) Produced Data Tag Name

Attribute 25

Application Socket Enable

Attribute 26

Application Listen Enable

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 data structure. (For more information, see the 2.3.2.

Serial Port Data Transfer

Object Definition (71 Hex) on Page 29.)

• An incremented sequence number indicates new data.

• The same data may be returned more than once. However, the same data packet also returns the same sequence number.

• A length of zero (0) indicates no data.

• While the DeviceMaster UP 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 DeviceMaster UP do not overflow. (For example: If the serial port can receive two packets per second, then the polling rate must be at least once every 500 microseconds.)

Specifies the maximum acceptable size of a received serial packet. The maximum received serial packet size is 1518 bytes while operating in Write-to-Tag/File or Write- to-Tag-File-Synced receive modes.

The maximum rate (or minimum time interval) in milliseconds, that messages are sent to the PLC tag in the Write-To-Tag receive method. This attribute configures the DeviceMaster UP to space the messages to the PLC to prevent overrunning of data before the PLC can process it.

This attribute specifies the slot number on the PLC where the controller resides. The slot numbers typically start at zero (0) for the first slot.

Note: The Polling method does not use this attribute.

This attribute specifies the IP address in hexadecimal format for the PLC EtherNet/IP card. For example, an IP address of 10.1.2.100 is 0A010264 in hexadecimal.

Note: The Polling method does not use this attribute.

This attributes specifies the PLC tag name. It indicates where to write received data while operating in the Unsolicited - Write-to-Tag or Unsolicited - Write-to-Tag-Synced receive method.

The maximum length for the tag name is 40 characters.

This setting enables/ disables the Application Socket Interface. Enabling this function allows an application to be connected to the serial port. If both the PLC and application are connected to the serial port, both can transmit to and receive data from the serial port. However, the PLC and application cannot communicate directly to each other.

Enabling this setting allows the application to connect to the DeviceMaster UP via an Ethernet TCP/IP socket.

• 0 = Disables listening - The DeviceMaster UP does not accept connection attempts.

• 1 = Enables listening - The DeviceMaster UP accepts connection attempts from the application socket port.

24 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 25

Instance Attribute Definitions

Attribute

Attribute 27

Application Connect Mode

Attribute 28

Application Disconnect Mode

Attribute 29

Application Listen Socket Port

Attribute 30

Application Connection Socket Port

Attribute 31

Application Connection IP Address

Attribute 32

Application Idle Timeout

Attribute 33

To PLC Filter/Data Extraction 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.

• 2 = Connect On Data - The DeviceMaster UP does not attempt to connect to the application socket port until there is data to send to the application. Once data is received from the serial device, the DeviceMaster UP attempts connecting to the application until a connection is made.

This setting controls if and how the DeviceMaster UP disconnects from an application.

• 0 = Never - The DeviceMaster UP does not disconnect from the application socket port.

• 1 = Disconnect On Idle - The DeviceMaster UP disconnects when there has been no transmit or received data between the serial device and application socket port for a specified Idle period (Attribute 32: Application Connection IP Address).

This is the socket port number on the DeviceMaster UP the application connects to if Application Listen Enable is enabled.

This is the application socket port number the DeviceMaster UP connects to if the Application Connect Mode is set to either Connect Always or Connect On Data.

This is the application IP address in hexadecimal format that the DeviceMaster UP connects to if the Application Connect Mode is set to either Connect Always or Connect On Data. For example, an IP address of 10.1.2.100 is 0A010264 in hexadecimal.

The idle timeout period in milliseconds that is used if the Application Disconnect Mode is set to Disconnect On Idle.

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.

• 2 = RFID (EPCglobal formats) - RFID data in any of the EPCglobal formats is filtered, the associated parameters is extracted, and the extracted data and RFID tag is sent to the PLC in a specified format.

• 3 = Barcode (UPC/EAN formats) - Barcode data in specified UPC/EAN formats is filtered, the associated parameters is extracted, and the extracted data and barcode is sent to the PLC in a specified format. See the barcode format

definitions in Attribute 41 on Page 28.

See the DeviceMaster UP Filtering and Data Extraction Reference Guide

(Page 10) for

further details.

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 25

Page 26

Instance Attribute Definitions

Attribute

Attribute 34

To Application Filter/ Data Extraction Mode

Attribute 35

Discard Unrecognized Data Mode

Attribute 36

RFID Antenna Grouping

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.

• 2 = RFID (EPCglobal formats) - RFID data in any of the EPCglobal formats is filtered, the associated parameters is extracted, and the extracted data and RFID tag is sent to the application in a specified format.

• 3 = Barcode (UPC/EAN formats) - Barcode data in specified UPC/EAN formats is filtered, the associated parameters is extracted, and the extracted data and barcode is sent to the application in a specified format. See the barcode format

definitions in Attribute 41 on Page 28.

The application filter mode can be set independently of the PLC filtering mode. The only exceptions are:

• If the PLC filter mode is set to RFID, the application filter mode cannot be set to Barcode.

• If the PLC filter mode is set to Barcode, the application filter mode cannot be set to RFID.

See the DeviceMaster UP Filtering and Data Extraction Reference Guide

(Page 10) for

further details. This attribute controls what to do with unrecognized RFID or barcode data.

• 0 = Off - Send unrecognized data to the PLC and/or application.

• 1 = Discard unrecognized data to the PLC. Allow sending of unrecognized data to the application.

• 2 = Discard unrecognized data to the application. Allow sending of unrecognized data to the PLC.

• 3 = Discard unrecognized data to both the PLC and application.

This attribute is applicable only to RFID filtering and only if the Antenna filtering option is enabled. It allows the DeviceMaster UP to filter RFID tags based on Antenna groupings. The possible groupings are:

Setting

Group 1 Group 2 Group 3 Group N Antennas

Antennas Antennas Antennas

None 1234 Groups of Twos 1,2 3,4 5,6 Etc. Groups of Threes 1,2,3 4,5,6 7,8,9 Etc. Groups of Fours 1,2,3,4 5,6,7,8 9,10,11,12 Etc. First Two Only1,234N+1 First Three Only 1,2,3 4 5 N+2

26 - Chapter 2. Programming Interface DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I

Page 27

Instance Attribute Definitions

Attribute

Attribute 37

To PLC Filtering Options

Attribute 38

To Application Filtering Options

Attribute 39

Filter Age Time

Attribute 40

RFID Reader Interface Type

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.

•02 Hex = Filter Value - Include the Filter Value in the filtering criteria, which is part

of the RFID tag data.

•04 Hex = Antenna - Include the Antenna number in the filtering criteria. This is

data from the RFID reader and not from the RFID tag.

•08 Hex = Company - Include the Company code in the filtering criteria, which is

part of the RFID tag or barcode data.

•10 Hex = Product/Location - Include the Product/Location code in the filtering

criteria, which is part of the RFID tag or barcode data.

•20 Hex = Serial Number - Include the Serial Number in the filtering criteria, which

is part of the RFID tag data.

See the DeviceMaster UP Filtering and Data Extraction Reference Guide

(Page 10) for

further details. This attribute defines the RFID filtering criteria to the application. If an option is

enabled, it is used to decide when an RFID tag can be filtered or sent to the application.

•01 Hex = Encoding/Numbering - Include the Encoding/Numbering code in the

filtering criteria, which is part of the RFID tag or barcode data.

•02 Hex = Filter Value - Include the Filter Value in the filtering criteria, which is part

of the RFID tag data.

•04 Hex = Antenna - Include the Antenna number in the filtering criteria. This is

data from the RFID reader and not from the RFID tag.

•08 Hex = Company - Include the Company code in the filtering criteria, which is

part of the RFID tag or barcode data.

•10 Hex = Product/Location - Include the Product/Location code in the filtering

criteria, which is part of the RFID tag or barcode data.

•20 Hex = Serial Number - Include the Serial Number in the filtering criteria, which

is part of the RFID tag data.

See the DeviceMaster UP Filtering and Data Extraction Reference Guide

(Page 10) for

further details. This attribute defines the time a filter string, RFID tag, or barcode continues to be

filtered after the last time it was received. If an entry is received before the Filter Age Time has passed, the entry is filtered and the data is not be sent to the PLC and/or application. However, if the Filter Age Time has passed, it passes filtering and be sent to the PLC and/or application.

This attribute defines the expected RFID data format. Each format is unique and pertains to the RFID reader manufacturer. If a RFID reader is to be used and it provides a similar format to the ones listed below, it can also be used.

• 0=Unspecified

• 10 (Decimal) = Alien (Text Mode)

• 11 (Decimal) = Alien (Terse Mode)

• 20 (Decimal) = Intermec (Hex ASCII Mode) See the DeviceMaster UP Filtering and Data Extraction Reference Guide

(Page 10) for

further details.

DeviceMaster UP Modbus/TCP User Guide: 2000447 Rev. I Chapter 2. Programming Interface - 27

Page 28

Instance Attribute Definitions

Attribute

Attribute 41

Barcode Formats

Attribute 42

Application Transmit STX Append Value

Attribute 43

Application Transmit ETX Append Value

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.

Format Numbering Company Product Check

Digits Digits Digits Digit

Standard Formats

None N/A N/A N/A N/A Company-5/ Product-5 1-3 5 5 1 Company-6/ Product-4 1-3 6 4 1 Company-7/ Product-3 1-3 7 3 1 Company-8/ Product-2 1-3 8 2 1 Company-9/ Product-1 1-3 9 1 1

Eight Digit Formats

EAN-8 Number-2/Product 5 2 0 5 1 EAN-8 Number-3/Product 4 3 0 4 1 UPC-E

See the DeviceMaster UP Filtering and Data Extraction Reference Guide (Page 10) for further details.