Allen-Bradley Studio 5000 Logix Emulate Owner's manual

Programming Manual
Logix 5000 Controllers Messages
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 cause an 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-PM012H-EN-P - February 2018 3
Summary of 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
This table identifies changes that apply to all information about a subject in the
manual and the reason for the change. For example, the addition of new supported
hardware, a software design change, or additional reference material would result
in changes to all of the topics that deal with that subject.
Subject Reason
Updated screen shots throughout. The graphical user interface has been updated in release 31 of the
Logix Designer application.
Updated supported controllers. Logix Designer supports new 5069 Compact GuardLogix controllers.
New or enhanced features
This table contains a list of topics changed in this version, the reason for the
change, and a link to the topic that contains the changed information.
Topic Name Reason
Guidelines on page 15 Added tip that MSG tags can be created at the controller or Program Local
scope for some controllers in version 31 of the Logix Designer application.

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 5
Table of contents
Studio 5000 environment....................................................................................................7
Additional resources.............................................................................................................8
Legal notices ...........................................................................................................................8
Chapter 1
Introduction to Controller Messages............................................................................. 11
Supported data types ......................................................................................................... 11
Message Queue ................................................................................................................... 12
Cache list.............................................................................................................................. 13
Unconnected buffers......................................................................................................... 15
Guidelines............................................................................................................................ 15
Get or set the number of unconnected buffers............................................................. 16
Get the number of unconnected buffers................................................................ 16
Set the number of unconnected buffers................................................................. 16
Convert between INTs and DINTs............................................................................... 18
Chapter 2
Introduction........................................................................................................................ 23
Message manager logic....................................................................................................... 23
Chapter 3
Introduction........................................................................................................................ 27
Configure the I/O configuration.................................................................................... 28
Define your source and destination elements............................................................... 29
Create the MESSAGE_ CONFIGURATION data type......................................... 30
Create the configuration array......................................................................................... 31
Get the size of the local array ........................................................................................... 32
Load the message properties for a controller ................................................................ 33
Configure the message....................................................................................................... 34
Step to the next controller................................................................................................ 34
Restart the sequence .......................................................................................................... 35
Preface
Controller messages
Manage multiple messages
Send a message to multiple
controllers
Index

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 7
Preface
This manual shows how to program message (MSG) instructions to and from
Logix 5000™ controllers. This manual is one of a set of related manuals that show
common procedures for programming and operating Logix 5000™ controllers.
For a complete list of common procedures manuals, refer to the Logix 5000
Controllers Common Procedures Programming Manual, publication 1756-
PM001.
•The term Logix 5000 controller refers to any controller that is based on the
Logix 5000 operating system.
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.
Studio 5000 environment

Preface
8Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
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.
You can view or download publications at
http://www.rockwellautomation.com/literature. To order paper copies of
technical documentation, contact your 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.
Other 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 can be located at their respective web site(s).
You may alternately obtain complete Corresponding Source code by contacting
Rockwell Automation via our 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.
Additional resources
Legal notices

Preface
Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 9
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, PLC-2, PLC-3, PLC-5,
PanelBuilder, PowerFlex, PhaseManager, POINT I/O, PowerFlex, Rockwell
Automation, RSBizWare, Rockwell Software, RSEmulate, Historian, RSFieldbus,
RSLinx, RSLogix, RSNetWorx for DeviceNet, RSNetWorx for EtherNet/IP,
RSMACC, RSView, RSView32, Rockwell Software Studio 5000 Automation
Engineering & Design Environment, Studio 5000 View Designer, SCANport,
SLC, SoftLogix, SMC Flex, Studio 5000, Ultra 100, Ultra 200, VersaView,
WINtelligent, XM, SequenceManager are trademarks of Rockwell Automation,
Inc.
Any Rockwell Automation logo, software or hardware product not mentioned
herein is also a trademark, registered or otherwise, of Rockwell Automation, Inc.
Other Trademarks
CmFAS Assistant, CmDongle, CodeMeter, CodeMeter Control Center, and
WIBU are trademarks of WIBU-SYSTEMS AG in the United States and/or
other countries. Microsoft is a registered trademark of Microsoft Corporation in
the United States and/or other countries. ControlNet is a trademark of
ControlNet International. DeviceNet is a trademark of the Open DeviceNet
Vendors Association (ODVA). Ethernet/IP is a trademark of ControlNet
International under license by ODVA.
All other trademarks are the property of their respective holders and are hereby
acknowledged.
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in

Preface
10 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
Rockwell Automation maintains current product environmental information on
its website at http://www.rockwellautomation.com/rockwellautomation/about-
us/sustainability-ethics/product-environmental-compliance.page
Contact Rockwell Automation
Customer Support Telephone — 1.440.646.3434
Online Support — http://www.rockwellautomation.com/support/

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 11
Chapter 1
Controller messages
This section describes how to transfer (send or receive) data between controllers
by executing a message (MSG) instruction. It explains cache connections and
buffers so you can correctly program the controller.
The following data types are supported when sending CIP messages.
•SINT
•INT
•DINT
•LINT
•REAL
In addition, you can send a message with any structure type that is predefined,
module-defined, or user-defined.
For more information, see "Convert between INTs and DINTs on page 18".
For complete details on programming a message instruction, see the LOGIX 5000
Controllers General Instruction Reference Manual, publication 1756-RM003.
Example: Execute a message (MSG) instruction
If count_send = 1
and count_msg.EN = 0 (MSG instruction is not enabled)
then execute a MSG instruction that sends data to another controller.
Introduction to Controller
Messages
Supported data types

Chapter 1
Controller messages
12 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
This diagram shows how the controller processes MSG instructions.
Description
The controller scans the MSG instruction and its rung-condition-in goes true. The message passes to a throttle that has 16 positions. If the throttle is full, the message
remains enabled but is held until another controller scan.
The System-overhead time slice executes and the message is pulled from the throttle to the message queue.
If the MSG instruction Then the MSG instruction
Does not use a connection or the connection was not previously cached Uses an unconnected buffer to establish communication with the
destination device.
Uses a connection and the connection is cached Does not use an unconnected buffer.
Communication occurs with the destination device.
The message queue holds up to 48 MSG instructions, including those that you
configure as a block-transfer read or block-transfer write. When the queue is full,
an instruction tries to enter the queue on each subsequent scan of the instruction,
as shown in the following illustration.
Message Queue

Controller messages
Chapter 1
Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 13
Description
The controller scans the MSG instruction.
The rung-condition-in for the MSG instruction is true.
The EN bit is set.
The MSG instruction attempts to enter the queue but 16 throttle positions exist. If all 16 are filled and a 17th message is executed, the message is enabled.
The EW bit remains cleared.
& The controller scans the MSG instruction.
The rung-condition-in for the MSG instruction is false.
The EN bit remains set.
The MSG instruction attempts to pass through the throttle, but no open positions exist yet.
The EW bit remains cleared.
The controller scans the MSG instruction.
The MSG instruction attempts to enter the queue. This time the throttle position is open and the message can pass to the message queue.
The EW bit is set.
Depending on how you configure a MSG instruction, it may use a connection to
send or receive data.
This type of message And this communication method Uses a connection
CIP data table read or write — Your option(1)
PLC-2, PLC-3, PLC-5, or SLC (all types) CIP
CIP with Source ID
No
DH+ Yes
CIP generic — Your option(2)
Block-transfer read or write — Yes
(1) CIP data table read or write messages can be connected or unconnected. However for most applications, it is recommended you leave CIP data table read or write
messages connected.
(2) CIP generic messages can be connected or unconnected. However for most applications, it is recommended you leave CIP generic messages unconnected, unless you
want to use the Large Connection option.
If a MSG instruction uses a connection, you have the option to leave the
connection open (cache) or close the connection when the message is done
transmitting.
If you Then
Cache the connection The connection stays open after the MSG instruction is done. This optimizes
execution time. Opening a connection each time the message executes increases
execution time.
Do not cache the connection The connection closes after the MSG instruction is done. This frees up that
connection for other uses.
Cache list

Chapter 1
Controller messages
14 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
The controller has the following limits on the number of connections that you can
cache.
If you have this software version and firmware
revision
Then you can cache
11.x or earlier
•
Block transfer messages for up to 16 connections.
•Other types of messages for up to 16 connections.
12.x or later Up to 32 connections.
If several messages go to the same device, the messages may be able to share a
connection.
If the MSG instructions are to And they are Then
Different devices — Each MSG instruction uses 1 connection.
The same device, cached, and not a large connection Enabled simultaneously (same scan) Each MSG instruction uses 1 connection and 1 cached
buffer.
Not enabled simultaneously All MSG instructions use 1 connection and 1 cached buffer.
They share the connection and the buffer.
The same device, cached, and a large connection Enabled simultaneously (same scan) Each MSG instruction uses 1 connection and 1 cached
buffer.
Not enabled simultaneously All MSG instructions use 1 connection and 1 cached buffer.
They share the connection and the buffer.
Example: Share a connection
•If the controller alternates between sending a block-transfer read message and a block-transfer write message to the same module, then together the
messages count as one connection. Caching both messages counts as one on the cached buffer.
•If the controller sends 10 cached connected messages to the same bridge module (for example, 1756-EN2T) where 7 utilize a standard connection (large
connection unchecked) and 3 utilize a large connection, then the 7 standard connection messages all utilize one cached connection. The 3 large connection
messages all utilize another cached connection. In total, the 10 messages use 2 cached connections.

Controller messages
Chapter 1
Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 15
To establish a connection or process unconnected messages, the controller uses an
unconnected buffer.
Term Definition
Unconnected buffer An allocation of memory that the controller uses to process unconnected communication. The controller performs unconnected communication
when it:
•Establishes a connection with a device, including an I/O module.
•Executes a MSG instruction that does not use a connection.
The controller can have 10 to 40 unconnected buffers.
•The default number is 10.
•To increase the number of unconnected buffers, execute a MSG instruction that reconfigures the number of unconnected buffers.
•Each unconnected buffer uses 1.2 KB of memory.
•If all unconnected buffers are in use when an instruction leaves the message queue, an error occurs and data does not transfer.
If a MSG instruction uses a connection, the instruction uses an unconnected
buffer when it first executes to establish a connection. If you configure the
instruction to cache the connection, it no longer requires an unconnected buffer
once the connection is established.
As you plan and program your MSG instructions, follow these guidelines.
Guideline Details
For each MSG instruction, create a control tag.
•
Data type = MESSAGE
•Scope = controller
•The tag cannot be part of an array or a user-defined data type.
Keep the source and destination data at the controller scope. A MSG instruction can access only tags that are in the Controller Tags folder (controller scope).
Tip: On CompactLogix 5370, ControlLogix 5570, Compact GuardLogix 5370, and GuardLogix 5570
controllers, enter an MSG tag only as a controller scope tag.
In versions 31 and later of the Logix Designer application, on CompactLogix 5380, CompactLogix 5480,
ControlLogix 5580, Compact GuardLogix 5380, and GuardLogix 5580 controllers, enter an MSG tag as either
a controller scope or a Program Local scope tag.
If your message is to a device that uses 16-bit integers, such as a
PLC-
5 or SLC 500 controller, and it transfers integers (not REALs),
use a buffer of INTs in the message and DINTs throughout the
project.
Logix 5000 controllers execute more efficiently and use less memory when working with 32-bit integers
(DINTs).
See Convert Between INTs and DINTs on page 18.
Cache the connection for those MSG instructions that execute
most frequently, up to the maximum number permissible for
your controller revision.
Execution time is optimized when the controller does not open a connection each time the message
executes.
If you want to enable more than 16 MSGs at one time, use a
management strategy to ensure some MSG instructions are not
delayed entering the queue.
To guarantee the execution of each message, use one of these options:
•Enable each message in sequence.
•Enable the messages in groups.
•Program a message to communicate with multiple devices.
•Program logic to coordinate the execution of messages.
Unconnected buffers
Guidelines

Chapter 1
Controller messages
16 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
Keep the number of unconnected and uncached MSGs less than
the number of unconnected buffers.
The controller can have 10 to 40 unconnected buffers. The default number is 10.
•If all unconnected buffers are in use when an instruction leaves the message queue, an error occurs, the
data is not transferred.
•You can increase the number of unconnected buffers (up to 40), provided you continue to adhere to the
previous guideline.
•To increase the number of unconnected buffers, see "Get or Set the Number of Unconnected Buffers on
page 16".
To determine or change the number of unconnected buffers, use a MSG
instruction.
•The range is 10 to 40 unconnected buffers.
•The default number is 10.
•Each unconnected buffers uses 1.1 KB of memory.
To determine the number of unconnected buffers that are currently available,
configure a Message (MSG) instruction as follows.
On this tab For this item Type or choose
Configuration Message Type CIP Generic
Service Type Custom
Service Code 3
Class 304
Instance 1
Attribute 0
Source Element source_array where data type = SINT[4]
In this element Enter
source_array[0] 1
source_array[1] 0
source_array[2] 17
source_array[3] 0
Source Length (bytes) 4 (Write 4 SINTs.)
Destination Element destination_array where data type = SINT[10] (Leave all values = 0.)
destination_array[6] = current number of unconnected buffers
Communication Path 1, slot_number_of_controller
As a starting value, set the number of unconnected buffers equal to the number of
unconnected and uncached messages enabled at one time plus 5. The additional 5
buffers provide a cushion in case you underestimate the number of messages that
are enabled at once.
Get or set the number of
unconnected buffers
Get the number of unconnected
buffers
Set the number of unconnected
buffers

Controller messages
Chapter 1
Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 17
To change the number of unconnected buffers of the controller, configure a
Message (MSG) instruction as follows.
On this tab For this item Type or select
Configuration Message Type CIP Generic
Service Type Custom
Service Code 4
Class 304
Instance 1
Attribute 0
Source Element source_array where data type = SINT[8]
In this element Enter
source_array[0] 1
source_array[1] 0
source_array[2] 17
source_array[3] 0
source_array[4] Number of unconnected buffers
that you want.
source_array[5] 0
source_array[6] 0
source_array[7] 0
Source Length (bytes) 8 (Write 8 SINTs.)
Destination Element destination_array where data type = SINT[6] (Leave all the values = 0.)
Communication Path THIS
or for earlier Logix 5000 controllers: 1, slot_number_of_controller

Chapter 1
Controller messages
18 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
Example: Set the number of unconnected buffers
If S:FS = 1 (first scan)
then set the number of unconnected buffers for the controller.
Source_Array[0] = 1
Source_Array[0] = 1
Source_Array[1] = 0
Source_Array[2] = 17
Source_Array[3] = 0
Source_Array[4] = 12 (The number of unconnected buffers that you want. In this example, we want 12 buffers.)
If UCB_Set.EN = 0 (MSG instruction is not already enabled)
then MSG instruction sets the number of unconnected buffers = Source_Array[4].
Tag Name Type Description
UCB_Set MESSAGE Control tag for the MSG instruction.
Source_Array SINT[8] Source values for the MSG instruction, including the number of unconnected buffers
that you want.
In the Logix 5000 controller, use the DINT data type for integers whenever
possible. Logix 5000 controllers execute more efficiently and use less memory
when working with 32-bit integers (DINTs).
If your message is to a device that uses 16-bit integers, such as a PLC-5 or SLC 500
controller, and it transfers integers (not REALs), use a buffer of INTs in the
message and DINTs throughout the project. This increases the efficiency of your
project.
Convert between INTs and
DINTs

Controller messages
Chapter 1
Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 19
Read 16-bit integers
Data from the
device
Buffer of INTs
DINTs for use in the
project
Word 1 INT_Buffer[0] DINT_Array[0]
Word 2 INT_Buffer[1] DINT_Array[1]
Word 3 INT_Buffer[2] DINT_Array[2]
Description
The Message (MSG) instruction reads 16-bit integers (INTs) from the device and stores them in a temporary array of INTs.
A File Arith/Logical (FAL) instruction converts the INTs to DINTs for use by other instructions in your project.
Write 16-bit integers
DINTs from the project
Buffer of INTs
Data for the
device
DINT_Array[0] INT_Buffer[0] Word 1
DINT_Array[1] INT_Buffer[1] Word 2
DINT_Array[2] INT_Buffer[2] Word 3
Description
An FAL instruction converts the DINTs from the Logix 5000 controller to INTs.
The MSG instruction writes the INTs from the temporary array to the device.

Chapter 1
Controller messages
20 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018
Example: Read integer values from a PLC-5 controller
If Condition_1 = 1
and Msg_1.EN = 0 (MSG instruction is not enabled)
then read 3 integers from the PLC-5 controller and store them in INT_Buffer (3 INTs).
If Msg_1.DN =1 (MSG instruction has read the data)
then reset the FAL instruction.
The FAL instruction sets DINT_Array = INT_Buffer. This converts the values to 32-bit integers (DINTs).
Example: Write integer values to a PLC-5 controller
If Condition_2 = 1
then reset the FAL instruction.
The FAL instruction sets INT_Buffer = DINT_Array. This converts the values to 16-bit integers (INTs).
If Control_2.DN = 1 (FAL instruction has converted the DINTs to INTs)
and Msg_2.EN = 0 (MSG instruction is not enabled)
then write the integers in INT_Buffer (3 INTs) to the PLC-5 controller.