Page 2
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.
None in this release. New or enhanced features Subject Reason Tag type service parameters for structure Added link to the Rockwell Automation Type Encoding of Logix page 38 Structures in CIP Data Table R/W document. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
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 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 6
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 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 7
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 Index Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
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.
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"...
Page 11
Rockwell Automation is not responsible for these intervening factors. The instructions in this document do not cover all the details or variations in...
Page 12
Preface Online Support — http://www.rockwellautomation.com/support/ Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Depending on the needs of the application, create additional structures, which are referred to as user-defined structures. Array. A sequence of elements, each of which is the same data type. • Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Data type, which defines the organization of the data. • See CIP data types for more information. In the Logix Designer application, version 21.00.00 and later, and in RSLogix 5000 software, version 18.00.00 and later, external access to Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
8-bit Class ID 0x20 Value 16-bit Class ID 0x21 High Segment Type Value Byte Order Representation of Instance ID Value (low byte first) … 8-bit Instance ID 0x24 Value 16-bit Instance ID 0x25 High Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Indicates to the object referenced in the request path to perform a task. The CIP or the device manufacturer define these tasks. Most of the services covered in this manual are defined by the Rockwell Automation vendor-specific objects, and are not found in the CIP Networks Library.
Logix 5000 Controllers on tags in the controller using symbolic addressing: Read Tag Service (0x4c) • • Read Tag Fragmented Service (0x52) Write Tag Service (0x4d) • • Write Tag Fragmented Service (0x53) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 19
CIP Read Data CIP Data Table Read Read Tag Fragmented Service Read Data Fragmented Format Write Tag Service CIP Write Data CIP Data Table Write Write Tag Fragmented Service Write Data Fragmented Format Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Example Using Symbolic has a data type of DINT and a value of 534. The value used for Instance ID Segment Addressing was determined using methods described in CIP Services and User-created Tags. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
0000216 = 534 decimal See also Read Tag Service page 20 Services Supported by Logix 5000 Controllers page 18 Both Symbolic Segment Addressing and Symbol Instance Addressing may Read Tag Service Error Codes Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Start at this byte offset (0) and return as much as will fit 1st Message Reply Field Bytes (in hex) Description - Symbolic Segment Addressing Reply Service Read Tag Fragmented Service (Reply) Reserved Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 23
Description - Symbolic Segment Addressing Reply Service Read Tag Fragmented Service (Reply) Reserved General Status Reply Data Too Large Extended Status Size No extended status Reply Data C2 00 SINT Tag Type Value Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
00 00 00 00 Start at this element (0) and return as much will fit 1st Message Reply Field Bytes (in hex) Description - Symbol Instance Addressing Reply Service Read Tag Fragmented Service (Reply) Reserved Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 25
Start at this element (980) and return as much will fit 3rd Message Reply Field Bytes (in hex) Description - Symbol Instance Addressing Reply Service Read Tag Fragmented Service (Reply) Reserved General Status Reply Data Too Large Extended Status Size No extended status Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Insufficient Request Data: Data too short for expected parameters. 0x26 The Request Path Size received was shorter or longer than expected. 0xFF 0x2105 General Error: Number of Elements or Byte Offset is beyond the end of the requested tag. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
CIP Services and User-created Tags. Message Request Field Bytes (in hex) Description - Symbol Instance Addressing Request Service Write Tag Service (Request) Request Path Size Request Path is 3 words (6 bytes) long Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
(approximately 500 bytes). The client must issue a series of requests to the controller to write all data using this service. The Request Service, Request Path Size, Request Path, and Number of Elements fields remain the same for each request. The client must change the Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
91 0A 54 6F 74 61 6C 43 6F 75 6E 74 ANSI Ext. Symbolic Segment for TotalCount Request Data C2 00 SINT Tag Type Value D6 06 Total number of elements to write (1750) DA 01 00 00 Start at this offset. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 30
C2 00 SINT Tag Type Value D6 06 Total number of elements to write (1750) 8E 05 00 00 Start at this Offset nn, nn, …nn Element Data for Elements 1422 through 1749 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Logical Segment for Instance ID for the tag TotalCount Request Data C2 00 Tag Data Type D6 06 Number of elements to write (1750) EC 01 00 00 Start at this Offser nn,nn,...nn Element Data (474 through 947) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 32
Logical Segment for Instance ID for the tag TotalCount Request Data C2 00 Tag Data Type D6 06 Number of elements to write (1750) 8E 05 00 00 Start at this Offset nn,nn,...nn Element Data (1422 through 1749) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Tag. Also use the Read Modify Write Tag Service to modify a single bit in a Tag without disturbing other data. See also PCCC Commands page 81 These are the Service Request Parameters. Service Request Parameters Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Error Code (Hex) Extended Error Description of Error (Hex) 0x03 Bad parameter, size > 12 or size greater than size of element. 0x04 0x0000 A syntax error was detected decoding the Request Path. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
The Multiple Service Packet Request Path contains the Message Router object (Class 2, Instance 1). This is the destination of the Multiple Service Packet’s Request Path. The Request Data field contains the Number of Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
A structure contains one or more members. • • Each member can be an: Atomic data type. • Another structured data type. • A single dimension array of an atomic or structure data type. • Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
UDTs with nested tags of these types. Instead, access atomic members of these tags that are visible in the Logix Designer application Data Monitor, using one of the methods that follow. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
A0 and 02, followed by the latter two bytes, which contain a 16-bit calculated field called a Structure Handle. When transmitted on the wire, it looks like this: Structure Handle Low Byte Structure Handle High Byte Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 39
Reserve this method only in cases where the control system development is complete and no further data structure changes will be made. See also CIP Services and user-created tags page 41 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
What tags are created • If a tag is structure • • The structure members How the data is packed in a message when reading a structure • Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
This instance of the template object provides information about the template structure such as: • Its name. The member list. • • The number of members. The size of the structure when read or written. • • The Structure Handle. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 43
(NAME in the Data Monitor) in the client software. This includes atomic members of any structure that are visible in Data Monitor. This only applies to visible atomic tags and atomic members of structured tags. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
1. Find all controller-scope tags. 2. Isolate user-created tags from system tags. 3. Determine the makeup of the structures. Structure members are not separate Symbol instances. 4. Determine the data packing of structure members in a message. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
3. When General Status = 06 is returned, there is more data to read. To determine the last instance sent in the reply, parse the data received from the Logix 5000 controller to find the last instance ID returned. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Symbol Type 51 0E 00 00 Second 32-bit Instance ID 06 00 16-bit Symbol Name Length 63 6F 75 6E 74 73 Characters in the symbol name 82 CF Symbol Type … Next … Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Request Path is 3 words (6 bytes) long Request Path 20 6B 25 00 35 5D Logical Segments: Class 0x6B, Instance 0 x5D35(starting instance) Request Data 02 00 Number of attributes to retrieve 01 00 Attribute 1 – Symbol Name Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 48
Which instance of the Symbol class is associated with each controller scope tag Information about the data type of each controller scope tag, including • whether it is a structured tag See also Analysis page 47 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
For any tag type, the value of bits 13 and 14 indicates the dimensions of the tag as shown in this table: Bit 14 Bit 13 Meaning 0 dimensions (not an array) 1 dimension array 2 dimension array 3 dimension array Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
The Symbol Type, Bit 12=0, Bit 15=0, and Bits 0-11 range from • 0x001-0x0FF (atomics) The Symbol Type, Bit 12=0, Bit 15=1, and Bits 0-11 range from • 0x100-0xEFF (structures, not including Predefined) 2. Discard tags that contain these characters Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
• This is the number of 32-bit words • Template Object Definition Size • Data Type: UDINT • This is the number of bytes of the structure data • Template Structure Size • Data Type: UDINT Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Attribute 1, Structure Handle 00 00 Status: 0000 = success CD 9E Calculated CRC value for members of the structure. The error codes may be returned by the Get_Attribute_List service to the Template object. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
The structure data returned by the Template Read service has the • format shown in Structure data format. See also Structure data format page 53 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
If the member is a Boolean data type, the value is the bit location • (0-31; 0-7 if mapped to a SINT). The upper 16-bits represent the data type. • The second 32-bit value is the offset location of the member in the • UDT structure. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
00 00 00 00 Offset to start reading from (should be zero, initially) 61 00 The number of bytes to be read. Message Reply Field Bytes Description Reply Service Read Template Service (Reply) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 56
NULL instead of the semi-colon and characters. Non-UDT structures are beyond the scope of this publication and should not be accessed as whole structures. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Get_Attribute_List service with the Read Tag services. If the situations occur, discard the Tag Read reply data and refresh the symbol and template information: • The values returned for these attributes are different than the last time they were read. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 60
01 00 Attribute number (attribute 1) 00 00 Success 05 00 Attribute value (INT) 02 00 Attribute number (attribute 2) 00 00 Success 01 00 Attribute value (INT) 03 00 Attribute Number (Attribute 3) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 61
General Status 0x10, Device State Conflict when the controller is password locked. In this state, controller memory can not be altered. Rockwell Automation suggests after receipt of the Device State Conflict for the first time, the client application should refresh the tag information one time.
ANSI Ext. Symbolic Segment for parts Request Data 01 00 Number of elements to read (1) Message Reply Field Bytes (in hex) Description - Symbolic Segment Addressing Reply Service Read Tag Service (Reply) Reserved General Status Success Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
ANSI Ext. Symbolic Segment for setpoints and …the Member segment for 5 Request Data CA 00 REAL Tag Type Value 01 00 Number of elements to write (1) 00 00 68 41 0x41680000 = 14.5 decimal Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Read one element of profile[0,1,257] which is a three dimensional array of Example 5 (Symbol Instance DINTs. Addressing Method) Message Request Field Bytes (in hex) Description Request Service Read Tag Service (Request) Request Path Size Request Path is 7 words (14 bytes) long Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Success Extended Status Size No extended status Reply Data C4 00 DINT Tag Type Value 25 02 00 00 0x00000252 = 549 decimal See also Atomic Members of Predefined Data Types page 63 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Description - Symbol Instance and Symbolic Segment Addressing Reply Service Read Tag Service (Reply) Reserved General Status Success Extended Status Size No extended status Reply Data CA 00 REAL Tag Type Service Parameter 00 00 80 41 16.0 decimal Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Atomic Members of Predefined Data Types page 63 Read the value of a BOOL named struct2.pilot_on using Symbolic Segment Example 10 (Symbolic Segment Addressing. The value of the BOOL is 1. Addressing Method) with BOOLs Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
REAL errors SINT wear REAL Structure Name: STRUCT_C Structure Name: STRUCT_D Member Data Type Member Data Type hours_full BOOL myint today STRUCT_B myfloat REAL sampleTime DINT myarray STRUCT_C[8] shipped DINT mypid REAL Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Read two elements of the tag struct2.hourlyCount[4], which is a structure of Example 4 type STRUCT_B. Message Request Field Bytes (in hex) Description - Symbolic Segment Addressing Request Service Read Tag Service (Request) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Read Tag Service (Reply) Reserved General Status Success Extended Status Size No extended status Reply Data CA 00 REAL Tag Type Value 00 00 80 41 0x41800000=16.0 decimal See also Access User-Defined Structures page 69 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Read Tag Service (Reply) Reserved General Status Success Extended Status Size No extended status Reply Data C3 00 INT Tag Type Value D0 5C 0x5CD0=23760 decimal See also Access User-Defined Structures page 69 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Description of Request Parameter Semantics of Values USINT Command = 0x0B USINT Status (0 in request) See the DF1 Protocol and Command Set Reference Manual, publication 1770-6.5.16. TNSW UINT Used to match response with request Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Tip: Rockwell Automation assumes that you are familiar with CIP and the information related to CIP that is discussed here. The details of the CIP portions of the frame are not fully described here. References to where more detailed information can be found are provided later. If you are not familiar with CIP, a tutorial is available for purchase at http://www.rockwellautomation.com/enabled/cipetraining.html.
Page 77
0B command with a CIP Forward_Close service request in it. It is not acceptable to allow connections to timeout naturally and clean themselves up. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
(Ack or Nak) before the next fragment is sent, and provides the ability for the client device to abort the fragmentation sequence if necessary. This fragmentation protocol is used only with the 0A and 0B PCCC commands. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 79
CIP Over the Controller Serial Port Chapter 4 For more information on the PCCC fragmentation protocol, go to http://www.rockwellautomation.com/enabled/guides.html. See also CIP Over the Controller Serial Port page 75 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
PCCC commands described in this chapter. See also Supported Subset of PCCC Commands page 81 Logix controllers support these subset of PCCC commands. Supported Subset of PCCC Commands PLC-2 Communication Commands page 83 • Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
The name of each command is listed in this format: Command Name (CMD=xx,yy; FNC=zz), where: • xx= CMD code in the Request yy= CMD code in the Reply • • zz = Function code Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
• [PLC-2 address] 2-bytes; byte offset from start of file, on 16-bit boundary, low byte first • [size] 1-byte; must be an even number of bytes Reply Format: [data] [data] is up to 244 bytes See also PLC-2 Communication Commands page 83 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
• [PLC-2 address] 2-bytes; byte offset from start of file, on 16-bit boundary, low byte first • [SET mask] is 1 byte (1=set to 1) • [RESET mask] is 1 byte (1=reset to 0) Reply Format: no data-only status Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Members of SINT, INT, DINT, and REAL arrays are contiguous in Logix memory. For more information on Logical addressing, see the DF1 Protocol and Command Set Manual, publication 1770-6.5.16. Symbolic, which addresses data directly by a tag name. • Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
RMW command performs this procedure. 1. Copy the specified word. 2. Reset the bits specified in the [AND mask]. 3. Set the bits specified in the [OR mask]. 4. Write the word back. Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
• For an unsuccessful command ([STS]=0xF0), a byte (error code) occurs; data may be returned, but the Logix data format is not documented. See also PCCC Commands page 81 PLC-5 Communication Commands page 85 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
See also PLC-5 Communication Commands page 85 The word range read command reads a block of words starting at the PLC-5 Word Range Read (CMD=0F, 4F; system address plus the word offset. FNC=01) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
• [SET mask] is 2 bytes (low byte first) specifying which bits in the word to set (1=set to 1) • [RESET mask] is 2 bytes (low byte first) specifying which bits in the word to reset (1=reset to 0) Reply Format: no data; only status Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
The service is supported for compatibility with SLC modules. It reads data SLC Protected Typed Logical from the logical address. Read with 3 Address Fields (CMD=0F, 4F; FNC=A2) Request Format: [byte size][file number][file type][element number][sub-element number] Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
See also SLC Communication Commands page 90 PCCC Commands page 81 This read command provides a simpler version for reading data. SLC Protected Typed Logical Read with 2 Address Fields (CMD=0F, 4F; FNC=A1) Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
• [element number] 1 byte, 0-254; 3 bytes for >=255, first byte=0xFF then 2-byte number, low byte first • [data] Reply Format: no data-only access See also SLC Communication Commands page 90 PCCC Commands page 81 Rockwell Automation Publication 1756-PM020F-EN-P - January 2019...
Page 94
Automation representative. New product satisfaction return Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.