Allen-Bradley 1769 Compact GuardLogix, 1756 ControlLogix, 1789 SoftLogix, 5069 CompactLogix, 5069 Compact GuardLogix Programming 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:

Labels may also be on or inside the equipment to provide specific precautions.

Identifies information that is critical for successful application and understanding of the product.

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 Au tomation, and TechConnect are trademarks of Rockwell Automation, Inc.

Trademarks not belonging to Rockwell Automation are prope rty of their respective companies.

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 3

Preface

Controller messages

Manage multiple messages

Send a message to multiple
Index

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

controllers

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

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 5

Studio 5000 environment

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

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.

Logix 5000

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 7

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.

Preface

Provides declarations of conformity, certificates, and other

Additional resources

Legal notices

These documents contain additional information concerning related Rockwell

Automation products.

Resource Description

Industrial Automation Wiring and Grounding Guidelines,

publication 1770-4.1

Product Certifications webpage, available at

http://ab.rockwellautomation.com

Provides general guidelines for installing a Rockwell
Automation industrial system.

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.

8 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018

Preface

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

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 9

Preface

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/

10 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018

Introduction to Controller
Supported data types

Messages

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

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.

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

".

Rockwell Automation Publication 1756-PM012H-EN-P - February 2018 11

Chapter 1

Controller messages

Message Queue

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.

12 Rockwell Automation Publication 1756-PM012H-EN-P - February 2018