Rockwell Automation Allen-Bradley Logix 5000 Series Owner's manual

Programming Manual
Logix 5000 Controllers Data Access
1756 ControlLogix, 1756 GuardLogix, 1769 CompactLogix, 1769 Compact GuardLogix, 1789
SoftLogix, 5069 CompactLogix, 5069 Compact GuardLogix, Studio 5000 Logix Emulate

Important user information
Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this
equipment before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and
wiring instructions in addition to requirements of all applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried
out by suitably trained personnel in accordance with applicable code of practice. If this equipment is used in a manner not specified by the
manufacturer, the protection provided by the equipment may be impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or
application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements
associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the
examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described
in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can causean explosion in a hazardous environment, which may lead to
personal injury or death, property damage, or economic loss.
ATTENTION:Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic
loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence
Important: Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be
present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc
Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work
practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.

Rockwell Automation Publication 1756-PM020F-EN-P - January 2019 3
Summaryof Changes
This manual includes new and updated information. Use these reference
tables to locate changed information.
Grammatical and editorial style changes are not included in this summary.
Global changes
None in this release.
New or enhanced features
Subject Reason
Tag type service parameters for structure on
page 38
Added link to the Rockwell Automation Type Encoding of Logix
Structures in CIP Data Table R/W document.

Rockwell Automation Publication 1756-PM020F-EN-P - January 2019 5
Tableofcontents
Studio 5000 environment................................................................................ 9
Additional resources ....................................................................................... 9
Legal notices................................................................................................. 10
Chapter 1
CIP Services Overview................................................................................. 13
CIP Data Types ...................................................................................... 13
Atomic data type sizes ..................................................................... 14
Logix 5000 data...................................................................................... 14
Tag type service parameter .................................................................... 15
Tag type service parameter values used with Logix controllers...... 15
Analysis.................................................................................................. 16
Segment Encoding.................................................................................. 16
Logical Segments............................................................................. 16
Symbolic Segments ......................................................................... 17
CIP Service Request/Response Format.................................................. 17
Services Supported by Logix 5000 Controllers............................................ 18
Read Tag Service ................................................................................... 20
Example Using Symbolic Segment Addressing .............................. 20
Example Using Symbol Instance Addressing.................................. 21
Read Tag Service Error Codes......................................................... 21
Read Tag Fragmented Service ............................................................... 22
Example Using Symbolic Segment Addressing .............................. 22
Example Using Symbol Instance Addressing.................................. 24
Read Tag Fragmented Service Error Codes .................................... 26
Write Tag Service................................................................................... 27
Example Using Symbolic Segment Addressing .............................. 27
Example Using Symbol Instance Addressing.................................. 27
Write Tag Service Error Codes........................................................ 28
Write Tag Fragmented Service .............................................................. 28
Example Using Symbolic Segment Addressing .............................. 29
Example Using Symbol Instance Addressing.................................. 31
Write Tag Fragmented Service Error Codes.................................... 33
Read Modify Write Tag Service ............................................................ 33
Service Request Parameters............................................................. 33
Example ........................................................................................... 34
Read Modify Write Tag Service Error Codes ................................. 34
Multiple Service Packet Service...................................................... 35
Example ........................................................................................... 35
Logix Data Structures ................................................................................... 36
Work with Data Structures..................................................................... 37
Tag type service parameters for structure .............................................. 38
Summary of Changes
Preface
CIP services

Table of contents
6Rockwell Automation Publication 1756-PM020F-EN-P - January 2019
Chapter 2
How tags are organized in the controller ...................................................... 41
Symbol object......................................................................................... 42
Template object...................................................................................... 42
Create and maintain a symbol object list ...................................................... 44
Step 1: Find user-created controller scope tags in a Logix 5000 controller . 45
Retrieve all symbol object instances ...................................................... 45
Example of retrieving the first group of tags ......................................... 46
Analysis.................................................................................................. 47
Continue the retrieval process.......................................................... 47
Step 2: Isolate user-created tags from system tags/identifying structured
tags................................................................................................................ 49
Symbol Type Attribute........................................................................... 49
Eliminate tags by applying rules...................................................... 50
Step 3: Determine the structure makeup for a specific structure.................. 51
Example of reading template attributes.................................................. 52
Analysis.................................................................................................. 53
Structure data format ....................................................................... 54
Contents of the member information ............................................... 54
Example of retrieving member information .................................... 55
Example ........................................................................................... 55
More about BOOLS in UDTs.......................................................... 57
Step 4: Determine the data packing of the members of a structure when
accessed as a whole ...................................................................................... 57
Example of reading an entire structure................................................... 58
Step 5: Determine when the tags list and structure information need
refreshing ...................................................................................................... 59
How to detect changes............................................................................ 59
Chapter 3
Atomic Members of Predefined Data Types ................................................ 63
Example 1 (Symbolic Segment Addressing Method) ............................ 63
Example 2 (Symbol Instance Addressing Method)................................ 64
Example 3 (Symbolic Segment Addressing Method) ............................ 64
Example 4 (Symbolic Segment Addressing Method) ............................ 65
Example 5 (Symbol Instance Addressing Method)................................ 65
Example 6 (Symbolic Segment Addressing Method) ............................ 66
Example 7 (Symbolic Segment Addressing Method) ............................ 67
Example 8 (Both Addressing Methods) ................................................. 67
Example 9 (Both Addressing Methods) ................................................. 68
Example 10 (Symbolic Segment Addressing Method) with BOOLs..... 68
Access User-Defined Structures ................................................................... 69
Example 1............................................................................................... 70
Example 2............................................................................................... 70
Example 3............................................................................................... 71
Example 4............................................................................................... 71
Example 5............................................................................................... 72
Example 6............................................................................................... 73
CIP Services and User-created
Tags
CIP Addressing Examples

Table of contents
Rockwell Automation Publication 1756-PM020F-EN-P - January 2019 7
Chapter 4
Unconnected Messaging (UCMM) through PCCC ...................................... 75
Connected Explicit Messages through PCCC............................................... 76
Fragmentation Protocol................................................................................. 78
Chapter 5
Supported Subset of PCCC Commands........................................................ 81
Initial Fields of All PCCC Commands ......................................................... 82
PLC-2 Communication Commands.............................................................. 83
Unprotected Read (CMD=01, 41; FNC not present) ............................. 83
Protected Write (CMD=00, 40; FNC not present) ................................. 84
Unprotected Write (CMD=08, 48; FNC not present)............................. 84
Protected Bit Write (CMD=02, 42; FNC not present) ........................... 84
Unprotected Bit Write (CMD=05, 45; FNC not present)....................... 85
PLC-5 Communication Commands.............................................................. 85
Addressing examples.............................................................................. 86
Read Modify Write N (CMD=0F, 4F; FNC=79) ................................... 87
Typed Read (CMD=0F, 4F; FNC=68)................................................... 88
Typed Write (CMD=0F, 4F; FNC=67) .................................................. 88
Word Range Read (CMD=0F, 4F; FNC=01)......................................... 88
Word Range Write (CMD=0F, 4F; FNC=00)........................................ 89
Bit Write (CMD=0F, 4F; FNC=02) ....................................................... 89
SLC Communication Commands ................................................................. 90
SLC Protected Typed Logical Read with 3 Address Fields (CMD=0F,
4F; FNC=A2) ......................................................................................... 90
SLC Protected Typed Logical Write with 3 Address Fields(CMD=0F,
4F, FNC=AA) ........................................................................................ 91
SLC Protected Typed Logical Read with 2 Address Fields (CMD=0F,
4F; FNC=A1) ......................................................................................... 91
SLC Protected Typed Logical Write with 2 Address Fields (CMD=0F,
4F; FNC=A9) ......................................................................................... 92
CIP Over the Controller Serial
Port
PCCC Commands
Index

Rockwell Automation Publication 1756-PM020F-EN-P - January 2019 9
Preface
Before using this document:
•Have a thorough understanding of CIP and EtherNet/IP.
•Have purchased a copy of the pertinent volumes of the CIP Networks
Library.
•Be properly licensed through ODVA to use the CIP technology.
For more information on the CIP Networks Library and CIP technologies,
contact ODVA at http://www.odva.org/.
The Studio 5000 Automation Engineering & Design Environment®
combines engineering and design elements into a common environment. The
first element is the Studio 5000 Logix Designer® application. The Logix
Designer application is the rebranding of RSLogix 5000® software and will
continue to be the product to program Logix 5000™ controllers for discrete,
process, batch, motion, safety, and drive-based solutions.
The Studio 5000® environment is the foundation for the future of
Rockwell Automation® engineering design tools and capabilities. The Studio
5000 environment is the one place for design engineers to develop all
elements of their control system.
These documents contain additional information concerning related
Rockwell Automation products.
Resource Description
Industrial Automation Wiring and Grounding Guidelines,
publication 1770-4.1 Provides general guidelines for installing a Rockwell
Automation industrial system.
Product Certifications webpage, available at
http://ab.rockwellautomation.com
Provides declarations of conformity, certificates, and other
certification details.
Studio 5000 environment
Additional resources

Preface
10 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019
View or download publications at
http://www.rockwellautomation.com/literature. To order paper copies of
technical documentation, contact the local Rockwell Automation distributor
or sales representative.
Copyright Notice
Copyright © 2018 Rockwell Automation Technologies, Inc. All Rights
Reserved. Printed in USA.
This document and any accompanying Rockwell Software products are
copyrighted by Rockwell Automation Technologies, Inc. Any reproduction
and/or distribution without prior written consent from Rockwell Automation
Technologies, Inc. is strictly prohibited. Please refer to the license agreement
for details.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement
("EULA") by opening the License.rtf file located in your product's install
folder on your hard drive.
Open source licenses
The software included in this product contains copyrighted software that is
licensed under one or more open source licenses. Copies of those licenses are
included with the software. Corresponding Source code for open source
packages included in this product are located at their respective web site(s).
Alternately, obtain complete Corresponding Source code by contacting
Rockwell Automation via the Contact form on the Rockwell Automation
website:
http://www.rockwellautomation.com/global/about-us/contact/contact.page
Please include "Open Source" as part of the request text.
A full list of all open source software used in this product and their
corresponding licenses can be found in the OPENSOURCE folder included
with the Release Notes. The default installed location of these licenses is
C:\Program Files (x86)\Common
Files\Rockwell\Help\<Product>\ReleaseNotes\OPENSOURCE\index.htm.
Trademark Notices
Allen-Bradley, ControlBus, ControlFLASH, Compact GuardLogix, Compact
I/O, ControlLogix, CompactLogix, DCM, DH+, Data Highway Plus,
DriveLogix, DPI, DriveTools, Explorer, FactoryTalk, FactoryTalk
Administration Console, FactoryTalk Alarms and Events, FactoryTalk Batch,
FactoryTalk Directory, FactoryTalk Security, FactoryTalk Services Platform,
FactoryTalk View, FactoryTalk View SE, FLEX Ex, FlexLogix, FLEX I/O,
Guard I/O, High Performance Drive, Integrated Architecture, Kinetix,
Logix5000, Logix 5000, Logix5550, MicroLogix, DeviceNet, EtherNet/IP,
Legal notices