Logix 5000 Controllers Import/Export (Publication 1756 ...

Logix 5000TM Controllers Import/Export

1756 ControlLogix?, 1756 GuardLogix?, 1769 CompactLogixTM, 1769 Compact GuardLogix?, 1789 SoftLogixTM, 5069 CompactLogixTM, 5069 Compact GuardLogix?, Studio 5000? Logix EmulateTM

Reference Manual

Publication 1756-RM014A-EN-P - March 2022 Supersedes Publication 1756-RM084Z-EN-P - Septemberr 2020

Original Instructions

Logix 5000 Controllers Import/Export

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

Rockwell Automation recognizes that some of the terms that are currently used in our industry and in this publication are not in alignment with the movement toward inclusive language in technology. We are proactively collaborating with industry peers to find alternatives to such terms and making changes to our products and content. Please excuse the use of such terms in our content while we implement these changes.

2

Publication 1756-RM014A-EN-P - March 2022

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.

Change New Studio 5000 Logix Designer? application branding

Topic Studio 5000? environment on page 17

New or enhanced features

None in this release.

Publication 1756-RM014A-EN-P - March 2022

3

Summary of changes Preface

Table of Contents

Studio 5000 environment ......................................................................... 17 Supported controllers................................................................................ 18 Additional resources ..................................................................................20 Legal Notices.............................................................................................. 20

Import and export files

Chapter 1

Introduction............................................................................................... 21 Export a project to an .L5K text file .......................................................... 21 Import an .L5K text file ............................................................................. 22 Export a Project to an .L5X XML File ....................................................... 24 Import an .L5X XML File .......................................................................... 25 Export to a .CSV or .TXT file..................................................................... 26 Import a .CSV or .TXT file ........................................................................ 28 Export source-protected logic .................................................................. 30

Export in a Cleartext Format............................................................... 31 Maintaining controller access ...................................................................33 .L5X file structure .......................................................................................34 .L5X file conventions..................................................................................36

Internal file comments ........................................................................36 Component Descriptions ....................................................................36 Boolean attribute values ......................................................................37 Data display style..................................................................................37 Data formats.........................................................................................37 .L5K file structure ...................................................................................... 42 .L5K file conventions ..................................................................................43 Internal file comments ........................................................................43 Component descriptions .................................................................... 44 Display style ......................................................................................... 44 Project documentation ............................................................................. 44

Define a controller component

Chapter 2

Introduction............................................................................................... 47 Controller component ............................................................................... 47

L5X controller structure ......................................................................47 L5K CONTROLLER structure............................................................. 48 Controller elements ............................................................................ 49 Controller attributes ........................................................................... 49 Controller attributes in a safety controller system ................................. 52 Controller guidelines ................................................................................ 52 Examples .....................................................................................................53

Publication 1756-RM014A-EN-P - March 2022

5

Table of Contents

Define a Datatype component

Chapter 3

Introduction............................................................................................... 61 Datatype component ................................................................................. 61

L5X datatype structure ........................................................................ 61 L5K datatype structure......................................................................... 61 Datatype elements ............................................................................... 61 Datatype attributes ............................................................................. 62 Datatype member ...................................................................................... 62 L5X datatype member structure ........................................................ 62 L5K datatype member structure ........................................................ 62 Datatype member elements ................................................................63 Datatype member attributes ...............................................................63 Bit members .........................................................................................63 Datatype guidelines....................................................................................65 Examples .................................................................................................... 66

Define a module component

Chapter 4

Introduction............................................................................................... 67 Module component.................................................................................... 67

L5X module structure ..........................................................................67 L5K MODULE structure.......................................................................67 Module elements ................................................................................. 68 Module attributes................................................................................ 68 Module attributes in a safety controller system....................................... 71 Module connection..................................................................................... 71 L5X connection structure .................................................................... 71 L5K CONNECTION structure ............................................................ 72 Connection elements .......................................................................... 72 Module connection attributes.............................................................73 Module connection attributes in a safety controller system ............74 Module guidelines ......................................................................................74 Examples .....................................................................................................75

Define an Add-On Instruction component

6

Chapter 5

Introduction............................................................................................... 81 Add-On Instruction component ............................................................... 81

L5X AddOnInstructionDefinition Structure ..................................... 81 L5K ADD_ON_INSTRUCTION_DEFINITION structure................. 82 Add-On Instruction elements ............................................................ 82 Add-On Instruction attributes........................................................... 82 Routines in Add-On Instructions ...................................................... 83 Parameters ................................................................................................. 84

Publication 1756-RM014A-EN-P - March 2022

Define a tag component

Table of Contents

L5X parameters structure................................................................... 84 L5K parameters structure................................................................... 85 Parameter elements ............................................................................ 85 Parameters attributes ......................................................................... 87 Signature history....................................................................................... 88 L5X SignatureHistory structure ........................................................ 88 L5K HISTORY_ENTRY structure ....................................................... 88 History entry attributes ...................................................................... 88 Local tags.................................................................................................... 89 L5X LocalTags structure ..................................................................... 89 L5K LOCAL_TAGS structure............................................................... 90 Local tag attributes.............................................................................. 90 Encoded/Unencoded Add-On Instructions ............................................ 90 L5X EncodedData Structure............................................................... 90 L5K ENCODED_DATA Structure........................................................91 Encoded data attributes ...................................................................... 91 Encoded Information elements..........................................................91 Encoded key attributes ........................................................................ 91 Encoded content attributes................................................................ 92 L5X Encoded Add-On Instruction example ...................................... 92 L5K Encoded Add-On instruction example ...................................... 92 Add-On Instruction Guidelines.................................................................93 L5X unencoded AddOnInstruction definition example .................. 94 Add-On Instruction Example, Continued......................................... 94 L5K unencoded ADD_ON_INSTRUCTION _DEFINITION example .................................................................................................95 L5X unencoded safety AddOnInstruction definition example ........97 L5K unencoded safety ADD_ON_INSTRUCTION _DEFINITION example .................................................................................................97

Chapter 6

Introduction............................................................................................... 99 Tag component .......................................................................................... 99

L5X tag structure................................................................................. 99 L5K TAG structure ............................................................................. 100 Tag elements...................................................................................... 100 Tag attributes .....................................................................................102 Produced tag attributes .....................................................................104 Consumed tag attributes...................................................................104 ALARM_ANALOG tag...............................................................................105 L5X tag structure for ALARM_ANALOG tag ....................................105 L5K tag structure for ALARM_ANALOG tag ....................................105

Publication 1756-RM014A-EN-P - March 2022

7

Table of Contents 8

ALARM_ANALOG tag attributes.......................................................105 ALARM_DIGITAL tag...............................................................................107

L5X tag structure for ALARM_DIGITAL tag ....................................107 L5K tag structure for an ALARM_DIGITAL tag ...............................107 ALARM_DIGITAL tag attributes .......................................................107 L5X AlarmConfig structure .................................................................... 108 AlarmConfig elements.......................................................................109 L5K ANALOG_ALARM message structure .......................................109 ALMMSG elements ............................................................................109 MESSAGE tag ...........................................................................................109 L5X message structure.......................................................................109 L5K MESSAGE structure ...................................................................109 Message tag attributes....................................................................... 110 AXIS_CIP_DRIVE, AXIS_CONSUMED, AXIS_GENERIC_DRIVE, AXIS_SERVO, AXIS_SERVO_DRIVE, or AXIS_VIRTUAL Tag..............111 L5X axis structure ...............................................................................111 L5K AXIS TAG structure .....................................................................111 Axis tag attributes ...............................................................................111 COORDINATE_SYSTEM tag................................................................... 123 L5X CoordinateSystem structure ..................................................... 123 L5K COORDINATE_SYSTEM structure ........................................... 123 Coordinate system tag attributes ..................................................... 123 MOTION_GROUP Tag ............................................................................. 125 L5X MotionGroup structure.............................................................. 125 L5K MOTION_GROUP structure ...................................................... 125 Motion Group Tag attributes ............................................................ 125 HMIBC tag ................................................................................................ 125 L5X HMIBC structure ........................................................................ 125 L5K HMIBC structure ........................................................................ 125 HMIBC attributes .............................................................................. 126 SAFETY tag................................................................................................ 126 L5X safety structure ........................................................................... 126 L5K SAFETY structure........................................................................126 Safety tag attributes...........................................................................126 Tag initial values....................................................................................... 127 L5X initial tag value............................................................................ 127 L5K initial TAG value.......................................................................... 127 Add-On Instruction tag values.......................................................... 127 Add-On Instruction tag values example...........................................128 Tag guidelines...........................................................................................129 Examples ................................................................................................... 129

Publication 1756-RM014A-EN-P - March 2022

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download