OPTO 22 EtherNet/IP User guide

ETHERNET/IP FOR SNAP PAC

PROTOCOL GUIDE

Form 1770-130915—September 2015

43044 Business Park Drive • Temecula • CA 92590-3614

Phone: 800-321-OPTO (6786) or 951-695-3000

Fax: 800-832-OPTO (6786) or 951-695-2712

www.opto22.com

Product Support Services

800-TEK-OPTO (835-6786) or 951-695-3080

Fax: 951-695-3017

Email: suppor[email protected]

Web: support.opto22.com

SNAP-PAC-S1 SNAP-PAC-EB2

SNAP-PAC-S2 G4EB2

SNAP-PAC-R1 OPTOEMU-SNR-3V

SNAP-PAC-R2 OPTOEMU-SNR-DR1

SNAP-PAC-EB1 OPTOEMU-SNR-DR2

EtherNet/IP for SNAP PAC Protocol Guide

ii

EtherNet/IP for SNAP PAC Protocol Guide

Form 1770-130915—September 2015

Printed in the United States of America.

The information in this manual has been checked carefully and is believed to be accurate; however, Opto 22 assumes no

responsibility for possible inaccuracies or omissions. Specifications are subject to change without notice.

Opto 22 warrants all of its products to be free from defects in material or workmanship for 30 months from the

manufacturing date code. This warranty is limited to the original cost of the unit only and does not cover installation, labor,

or any other contingent costs. Opto 22 I/O modules and solid-state relays with date codes of 1/96 or newer are guaranteed

for life. This lifetime warranty excludes reed relay, SNAP serial communication modules, SNAP PID modules, and modules

that contain mechanical contacts or switches. Opto 22 does not warrant any product, components, or parts not

manufactured by Opto 22; for these items, the warranty from the original manufacturer applies. These products include,

but are not limited to, OptoTerminal-G70, OptoTerminal-G75, and Sony Ericsson GT-48; see the product data sheet for

specific warranty information. Refer to Opto 22 form number 1042 for complete warranty information.

Wired+Wireless controllers and brains are licensed under one or more of the following patents: U.S. Patent No(s). 5282222,

RE37802, 6963617; Canadian Patent No. 2064975; European Patent No. 1142245; French Patent No. 1142245; British Patent

No. 1142245; Japanese Patent No. 2002535925A; German Patent No. 60011224.

Opto 22 FactoryFloor, groov, Optomux, and Pamux are registered trademarks of Opto 22. Generation 4, groov Server,

ioControl, ioDisplay, ioManager, ioProject, ioUtilities, mistic, Nvio, Nvio.net Web Portal, OptoConnect, OptoControl,

OptoDataLink, OptoDisplay, OptoEMU, OptoEMU Sensor, OptoEMU Server, OptoOPCServer, OptoScript, OptoServer,

OptoTerminal, OptoUtilities, PAC Control, PAC Display, PAC Manager, PAC Project, SNAP Ethernet I/O, SNAP I/O, SNAP OEM

I/O, SNAP PAC System, SNAP Simple I/O, SNAP Ultimate I/O, and Wired+Wireless are trademarks of Opto 22.

ActiveX, JScript, Microsoft, MS-DOS, VBScript, Visual Basic, Visual C++, Windows, and Windows Vista are either registered

trademarks or trademarks of Microsoft Corporation in the United States and other countries. Linux is a registered

trademark of Linus Torvalds. Unicenter is a registered trademark of Computer Associates International, Inc. ARCNET is a

registered trademark of Datapoint Corporation. Modbus is a registered trademark of Schneider Electric, licensed to the

Modbus Organization, Inc. Wiegand is a registered trademark of Sensor Engineering Corporation. Nokia, Nokia M2M

Platform, Nokia M2M Gateway Software, and Nokia 31 GSM Connectivity Terminal are trademarks or registered trademarks

of Nokia Corporation. Sony is a trademark of Sony Corporation. Ericsson is a trademark of Telefonaktiebolaget LM Ericsson.

CompactLogix, MicroLogix, SLC, and RSLogix are trademarks of Rockwell Automation. Allen-Bradley and ControlLogix are a

registered trademarks of Rockwell Automation. CIP and EtherNet/IP are trademarks of ODVA.

groov includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org)

All other brand or product names are trademarks or registered trademarks of their respective companies or organizations.

Opto 22

Automation Made Simple.

EtherNet/IP for SNAP PAC Protocol Guide iii

iii

Table of Contents

Chapter 1: Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Using this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Documents and Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Additional Resources for EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Product Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2: CIP Object Model for SNAP PAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

CIP Object Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Accessing Object Classes in Implicit and Explicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

For Implicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

For Explicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Points, Ports, and Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Column Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

0x01 - Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Vendor Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

0x02 - Message Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

0x04 - Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

0x06 - Connection Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Object Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

0x08 - Discrete Input Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Features for 0x08 - Discrete Input Point, Attribute 0x80 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Vendor Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

0x09 - Discrete Output Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

EtherNet/IP for SNAP PAC Protocol Guide

iv

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Vendor Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

0x0A - Analog Input Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

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

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

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Vendor Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Analog Input: Value Attribute Semantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

0x0B - Analog Output Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Vendor Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Analog Output: Value Attribute Semantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

0x66 - Load Cell Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

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

Vendor Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Load Cell Input: Value and Value32 Attribute Semantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

0x68 - OptoMMP Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

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

Object Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

0x69 - Scratchpad DINT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

0x70 - Scratchpad REAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

0x71 - Scratchpad STRING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

0x73 - Pulse and TPO Generator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

0x74 - Ramp Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

0x75 - PID Loop Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

EtherNet/IP for SNAP PAC Protocol Guide v

v

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

0x76 - Serial Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Object Specific Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

0x80 - Communication Watchdog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

0x81 - PPP Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

0xF5 - TCP/IP Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84

0xF6 - Ethernet Link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

EtherNet/IP for SNAP PAC Protocol Guide

vi

EtherNet/IP for SNAP PAC Protocol Guide 1

1

3: 1: WelcomeChapter 3

1: Welcome

Welcome to the EtherNet/IP™ for SNAP PAC Protocol Guide. Inside you’ll find detailed descriptions of

the EtherNet/IP commands that can be accessed when using remote Opto 22 SNAP PAC I/O with an

Allen-Bradley® Logix™ controller.

This guide assumes that you are already familiar with how to use Allen-Bradley’s RSLogix 5000

software to configure Allen-Bradley devices.

SNAP PAC S-series

PLCs

EtherNet/IP automation environment with PLCs and Opto

SNAP PAC

SNAP PAC R-series

USING THIS GUIDE

EtherNet/IP for SNAP PAC Protocol Guide

2

Using this Guide

Chapter 1: Welcome—Provides information about this guide, where to find additional information,

and how to reach Opto 22 Product Support.

Chapter 2: CIP Object Model for SNAP PAC—Describes the SNAP PAC functionality accessible via

EtherNet/IP with implicit and explicit messaging.

Documents and Online Help

You may also need the following Opto 22 hardware documentation, depending on your application:

All documents are available on our website, www.opto22.com. The easiest way to find a document

is to search on its form number.

Additional resources are also available on the Opto 22 Web site such as a demonstration video that

shows how easy it is to configure and program an Allen-Bradley controller to talk to SNAP PAC I/O. If

you are viewing this document online and have an internet connection, click the image. Otherwise,

For this information See this guide Form

Setting up EtherNet/IP messaging between an

Allen-Bradley® Logix™ controller and Opto 22

SNAP PAC I/O IO4AB User’s Guide 1909

Installing and using SNAP PAC brains SNAP PAC Brain User’s Guide 1690

Installing and using SNAP PAC R-series controllers

SNAP PAC R-Series Controller User’s Guide 1595

Installing and using SNAP PAC S-series controllers

SNAP PAC S-Series Controller User’s Guide 1592

Using the OptoMMP Communication Toolkit or the

IEEE 1394-based OptoMMP memory-mapped

protocol for programming OptoMMP Protocol Guide 1465

Wiring, specifications, and installation information

for SNAP Analog Input Modules SNAP Analog Input Modules Data Sheet 1065

Wiring, specifications, and installation information

for SNAP Analog Output Modules SNAP Analog Output Modules Data Sheet 1066

Wiring, specifications, and installation information

for SNAP High-Density Digital Modules SNAP High-Density Digital Modules Data Sheet 1556

Wiring, specifications, and installation information

for SNAP Digital Input Modules SNAP Digital Input Modules Data Sheet 0773

Wiring, specifications, and installation information

for SNAP Digital Output Modules SNAP Digital Output Modules Data Sheet 1144

Wiring, specifications, and installation information

for isolated analog input modules SNAP Isolated Analog Input Modules Data Sheet 1182

Wiring, specifications, and installation information

for serial modules SNAP Serial Communication Modules Data Sheet 1184

Latest release, installation, and system require-

ments information for EtherNet/IP Configurator. EtherNet/IP Configurator Release Notes. (See

www.opto22.com for the latest form number.)

CHAPTER 1: WELCOME

EtherNet/IP for SNAP PAC Protocol Guide 3

3

go to the Learn tab on the Opto 22 website, www.opto22.com, and click SNAP I/O with

Allen-Bradley Systems.

Additional Resources for EtherNet/IP

For an overview of CIP and EtherNet/IP technology, see

http://www.odva.org/Portals/0/Library/Publications_Numbered/PUB00138R2_CIP_Adv_Tech_Series_EtherNetIP.pdf

For information on the network infrastructure for EtherNet/IP, see

http://www.odva.org/Portals/0/Library/Publications_Numbered/PUB00035R0_Infrastructure_Guide.pdf

For a good starting point for Ethernet/IP research on the ODVA web site, see

http://www.odva.org/default.aspx?tabid=67

Product Support

If you have any questions about using EtherNet/IP to communicate with Opto 22 devices, you can

call, fax, or email Opto 22 Product Support.

Phone: 800-TEK-OPTO (800-835-6786)

951-695-3080

(Hours are Monday through Friday,

7 a.m. to 5 p.m. Pacific Time)

Fax: 951-695-3017

Email: suppor[email protected]

Opto 22 website: www.opto22.com

When calling for technical support, be prepared to provide the following information about your

system to the Product Support engineer:

•Opto 22 software and version being used

•Opto 22 firmware versions

•PC configuration (type of processor, speed, memory, and operating system)

•PLC software description and version

•PLC model

•PLC firmware version

NOTE: Email messages and phone

calls to Opto 22 Product Support

are grouped together and

answered in the order received.

PRODUCT SUPPORT

EtherNet/IP for SNAP PAC Protocol Guide

4

•A complete description of your hardware and operating systems, including:

–type of power supply

–types of remote I/O installed

– third-party devices installed (for example, barcode readers)

•Description and symptoms of the issue

•Specific error messages seen.

EtherNet/IP for SNAP PAC Protocol Guide 5

5

2: CIP Object Model for SNAP PACChapter 4

2: CIP Object Model for

SNAP PAC

CIP Object Classes

This chapter details the available CIP objects that can be accessed via EtherNet/IP for implicit and

explicit messaging.

The following table shows the CIP object classes that are supported on Opto 22 devices. While all of

the classes are available for explicit messaging, only the classes marked with an asterisk (*) include

some attributes that are available for implicit messaging.

Object Class Devices Supported

SNAP-PAC-EB1 SNAP-PAC-EB2 SNAP-PAC-R1 SNAP-PAC-R2 SNAP-PAC-S1 SNAP-PAC-S2

0x01 - Identity  

0x02 - Message Router  

0x04 - Assembly  

0x06 - Connection Manager  

0x08 - Discrete Input Point*   

0x09 - Discrete Output Point*   

0x0A - Analog Input Point*   

0x0B - Analog Output Point*   

0x66 - Load Cell Input*   

0x68 - OptoMMP Request      

0x69 - Scratchpad DINT*     

0x70 - Scratchpad REAL*     

0x71 - Scratchpad STRING*     

0x73 - Pulse and TPO Generator*   

0x74 - Ramp Controller*   

0x75 - PID Loop Controller*   

0x76 - Serial Port*   

0x80 - Communication Watchdog 

0x81 - PPP Link 

0xF5 - TCP/IP Object  

0xF6 - Ethernet Link  

ACCESSING OBJECT CLASSES IN IMPLICIT AND EXPLICIT MESSAGING

EtherNet/IP for SNAP PAC Protocol Guide

6

Accessing Object Classes in Implicit and Explicit Messaging

All of the attributes in the object model can be accessed by explicit messaging. Only a subset of the

attributes can be accessed by implicit messaging.

For Implicit Messaging

Implicit messaging is configured in EtherNet/IP Configurator in the Add Assembly Member dialog

box. In the following example, the class called DiscreteInputPoint in EtherNet/IP Configurator is the

same as 0x08 - Discrete Input Point in the CIP object model. For more information on using

EtherNet/IP Configurator to set up an implicit messaging connection, see form 1909, the IO4AB

User’s Guide.

The same Class and Attribute that are selected above in EtherNet/IP Configurator can be found in

the object model tables.

Attributes with this background color can only be accessed by explicit messaging.

Attributes with this background color can be accessed by explicit messaging and implicit

messaging (through a properly configured assembly instance.)

Class

Attribute

Class

Attribute ID

Attribute name

CHAPTER 2: CIP OBJECT MODEL FOR SNAP PAC

EtherNet/IP for SNAP PAC Protocol Guide 7

7

For Explicit Messaging

Explicit messaging is configured in RSLogix 5000 as described in form 1909, the IO4AB User’s Guide.

In the following example, fields A-D on the Message Configuration dialog box correspond to items

in the object model tables.

Points, Ports, and Channels

The terms point, port, and channel are used in this document. Each channel of a SNAP-PAC I/O

module provides connectivity to one point of I/O. Each channel of a SNAP-PAC communication

module provides connectivity to one communication port.

For

default

A

B

C

D

B

C

A

ACCESSING OBJECT CLASSES IN IMPLICIT AND EXPLICIT MESSAGING

EtherNet/IP for SNAP PAC Protocol Guide

8

Column Descriptions

Attribute ID

An integer identification value assigned to an attribute. Use the Attribute ID in the Get_Attributes

and Set_Attributes services list. The Attribute ID identifies the particular attribute being accessed.

Access Rule

Specifies how a requestor can access an attribute. The definitions for access rules are:

•Settable (SET) - The attribute can be accessed by one of the Set_Attribute services.

Important: Settable attributes can also be accessed by Get_Attribute services.

•Gettable (GET) - The attribute can be accessed by one of the Get_Attribute services.

NV

NV indicates whether an attribute value is maintained through power cycles. This column is used in

object definitions where non-volatile storage of attributes is required. An entry of ‘NV’ indicates the

value shall be saved, ‘V’ means not saved and ‘NVS‘ indicates the value shall be saved only when the

“Store Configuration In Non-Volatile Memory” service (0x32) for the Identity object is invoked.

Name

Name refers to the attribute.

Data Type

Specifies the data type of the attribute value.

Description

Provides general information about the attribute.

Semantics

Specifies the meaning of the attribute value.

CHAPTER 2: CIP OBJECT MODEL FOR SNAP PAC

EtherNet/IP for SNAP PAC Protocol Guide 9

9

0x01 - Identity

This object class provides identification and general information about the device. Vendor specific

services have been implemented that store or erase configuration data in non-volatile memory.

There is only one instance of the Identity object class: instance ID 1.

Class Attributes

Instance Attributes

Only one instance (instance ID = 1) is implemented in SNAP-PAC devices.

0x01 - Identity - Class Attributes

Attribute

ID Access

Rule NV Name Data

Type Description Semantics

0x1 GET Revision UINT Revision of

this open

object

The revision of the Identity Object class specified by

the CIP Common Specification. The current value

assigned to this attribute is 1.

0x2 GET Max

Instance UINT

Maximum

instance num-

ber for objects

of this class.

There is only one instance of the Identity Object:

instance ID 1.

0x01 - Identity - Instance Attributes

Attribute

ID Access

Rule NV Name Data Type Description Semantics

0x1 GET Vendor ID UINT Identification of ven-

dor by number. This attribute is set to the vendor number for

Opto 22: 83.

0x2 GET Device

Type UINT Identification of gen-

eral type of product. This attribute is set to the 0. This device con-

forms to the Generic Device profile.

0x3 GET Product

Code UINT Vendor specific prod-

uct identification

code.

The value of this attribute is set to one of the

product codes listed in the following table:

0x4 GET Revision STRUCT OF Revision of the prod-

uct this identity object

represents.

This attribute is set to the major/minor revision

of the firmware installed on the device.

Major

Revision USINT Major revision of this

product.

Product Name Product Code

SNAP-PAC-EB1 118

SNAP-PAC-EB2 116

SNAP-PAC-R1 122

SNAP-PAC-R2 120

SNAP-PAC-S1 124

SNAP-PAC-S2 110

0X01 - IDENTITY

EtherNet/IP for SNAP PAC Protocol Guide

10

Common Services

•0x0E - Get Attribute Single

•0x05 - Reset

–Description

This instance-level service performs the type of requested.

– Request Service Data Field Parameters

– Success Response Service Data Field Parameters

None

•0x01 - Get Attributes All (instance level only)

Vendor Specific Services

•0x32 - Store Configuration in Non-volatile Memory

–Description

This instance level service stores the current device configuration to non-volatile memory.

– Request Service Data Field Parameters

None

– Success Response Service Data Field Parameters

None

•0x33 - Erase Configuration from Non-volatile Memory

Minor

Revision USINT Minor revision of this

product.

0x5 GET Status WORD Summary status of

this device.

0x6 GET Serial

Number UDINT Serial number of

device.

0x7 GET Product

Name SHORT_STRING Human readable

identification This attribute is set to the product name.

0x01 - Identity - Instance Attributes (Continued)

Attribute

ID Access

Rule NV Name Data Type Description Semantics

Name Data Type Description Of Parameter

Type USINT

Type of reset:

Value Type of Reset

0Emulate power-cycle on SNAP-PAC

device.

1

Return to factory-default configuration, then

emulate power-cycle on SNAP PAC device.

This operation does not erase IP configura-

tion.

CHAPTER 2: CIP OBJECT MODEL FOR SNAP PAC

EtherNet/IP for SNAP PAC Protocol Guide 11

11

–Description

This instance level service erases configuration information from non-volatile memory.

– Request Service Data Field Parameters

None

– Success Response Service Data Field Parameter

None

0x02 - Message Router

This object has no supported attributes.

0x04 - Assembly

The assembly object class binds attributes from multiple objects into the Data attribute. The Data

attribute value is a block of data composed of the values of all bound attributes. By accessing the

Data attribute of an assembly instance, all bound attributes are accessed as a single block of data.

Input or output data may be bound by an assembly object. The terms input and output are defined

from the network's point of view. An input will produce data on the network and an output will

consume data from the network. 16 assembly instances are provided (instance IDs 100-115). By

default, no attributes are bound (the length of the data attribute value is 0 for all assembly

instances). Using the EtherNet/IP Configurator software, the format of the each assembly Data

attribute may be configured by specifying the object attributes to be bound and their locations with

in the data block.

Changes made to the configuration of an assembly instance at the same an implicit connection is

using the assembly instance will not take effect until the implicit connection is closed.

Instance 254 is provided to serve as the output connection point for Input Only connections. The

modeless real-time data format with a data length of 0 is used for this instance.

Instance 255 is provided to serve as the output connection point for Listen Only connections. The

modeless real-time data format with a data length of 0 is used for this instance.

0X06 - CONNECTION MANAGER

EtherNet/IP for SNAP PAC Protocol Guide

12

Class Attributes

Instance Attributes

Common Services

•0x0E - Get Attribute Single

•0x10 - Set Attribute Single

0x06 - Connection Manager

•One instance of this object is implemented, instance ID = 1. This object has no supported

attributes.

•Explicit (class 3 transport type) and implicit (or I/O) (class 1 transport type) connections are

supported.

•The following implicit (or I/O) connection types are supported:

–Exclusive Owner

–Input Only

0x04 - Assembly - Class Attributes

Attribute ID Access Rule NV Name Data Type Description Semantics

0x1 GET Revision UINT Revision of this

open object

The revision of the Assembly Object class

specified by the CIP Common Specifica-

tion. The current value assigned to this

attribute is 2.

0x2 GET Max

Instance UINT

The maximum

instance num-

ber for objects

of this class.

Default value is 255.

0x04 - Assembly - Instance Attributes

Attribute ID Access Rule NV Name Data Type Description Semantics

0x3 SET VData ARRAY OF

BYTE

All attribute data

bound by this assem-

bly instance.

The format of this data can be specified

using the EtherNet/IP configurator utility.

Type Maximum Number of Connections Maximum Message Size

Explicit (Class 3

transport) 32 (16 EtherNet/IP encapsulation sessions)

Type Read/

Input Write/

Output

connected 498 494

unconnected 500 496

Implicit (Class 1

transport) 16 Read/Input = 500, Write/Output = 496

CHAPTER 2: CIP OBJECT MODEL FOR SNAP PAC

EtherNet/IP for SNAP PAC Protocol Guide 13

13

–Listen Only

•Implicit (or I/O) messaging (class 1 transport) real-time formats are:

Object Specific Services

•0x4E - Forward Close (instance only)

Description

Closes a connection. See The CIP Networks Library, Volume 1, Common Industrial Protocol,

section 3-5 for more information.

•0x54 - Forward Open (instance only)

Description

Opens a connection, maximum data size is 511 bytes. See The CIP Networks Library, Volume 1,

Common Industrial Protocol, section 3-5 for more information.

0x08 - Discrete Input Point

The Discrete Input Point object class provides access to the input channels of SNAP-PAC digital I/O

modules.

Class Attributes

Instance Attributes

Each channel of I/O can be uniquely identified by channel number and slot number. The channel

number can range from 0 through 31, and is unique for each channel on a particular module. The

module slot number can range from 0 through 15 and is printed next to each module slot on the I/O

Messaging Direction Real-Time Format

input (target to originator) Modeless

output (originator to target) 32-bit Run/Idle Header

0x08 - Discrete Input Point - Class Attributes

Attribute ID Access Rule NV Name Data Type Description Semantics

0x1 GET Revision UINT Revision of this open

object

The revision of the Discrete Input Point

specified by the CIP Common Specifica-

tion. The current value assigned to this

attribute is 2.

0x64 GET Vendor

Specific

Revision UINT Revision of vendor

specific extension to

this open object

The revision of our vendor specific exten-

sions to the open Discrete Input Point

specified by the CIP Common Specifica-

tion. The current value assigned to this

attribute is 1.

0X08 - DISCRETE INPUT POINT

EtherNet/IP for SNAP PAC Protocol Guide

14

rack. The instance id of the Discrete Input Point object associated with a given channel number and

slot is determined through the following equations.

The following equations provide a means to determine the Instance Id for the Discrete Input object

that represents a digital input channel in a given slot (or vice versa). The slot number can range from

0 - 15. The channel number can range from 0 - 31.

Instance Id = 1 + (Module Slot Number)*64 + (Module Channel Number)

Module Slot Number = RoundDown((Instance Id - 1)/64)

Channel Number = (Instance Id - 1) % 64

0x08 - Discrete Input Point - Instance Attributes

Attribute ID Access

Rule NV Name Data Type Description Semantics

0x1 GET Number

Of Attri-

butes USINT Number sup-

ported in this

product Default value is 16.

0x2 GET Attribute

List ARRAY

OF USINT

List of attri-

butes sup-

ported in this

product

0x3 GET Value BOOL Input Point

Value 0 = Off

1 = On

0x64 GET Module

(Slot)

Number UINT

The module

slot associated

with this I/O

point.

The Module Slot Number identifies the slot into which the

module associated with this I/O point is installed. The first

slot (nearest the brain) is assigned Module Slot Number 0.

The module slot number is also related to the instance id for

this object as follows:

Module Slot Number = RoundDown( (Instance Id-1)/64 )

0x65 GET Module

Channel

Number UINT

The module

channel asso-

ciated with this

I/O point.

The first channel on a module is channel number 0.

The module channel number is related to the instance id for

this object as follows:

Module Channel Number = (Instance Id - 1) % 64

0x66 GET Module

Path STRUCT

OF

EPATH for the

Module Config-

uration object

associated with

this I/O point.

This path con-

tains one logi-

cal class

segment and

one logical

instance seg-

ment.

Path Size UINT

Length (in

octets) of the

Packed EPATH

contained in

the Path.

Page is loading ...

OPTO 22 EtherNet/IP User guide

Related papers

Other documents