Network Device Library

Release v12.04.01

Reference Manual Original Instructions

Rockwell Automation Network Device Library Reference Manual

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.

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

The following icon may appear in the text of this document.

Identifies information that is useful and can help to make a process easier to do or easier to understand.

2 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Table of Contents

Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Device Object Libraries Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Other Application Code Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Software and Firmware Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Rockwell Automation® Services and Support . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 1
Rockwell Automation® Network Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Device Library Compatible Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Compatible Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Summary of Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Footprint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 2
Library Components Network Device Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Library Folders and Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Studio 5000 View Designer® Visualization Files . . . . . . . . . . . . . . . . 21
FactoryTalk® Optix Library Objects Visualization Files . . . . . . . . . . 22
Basic Faceplate Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Status Banner for FactoryTalk® View ME/SE and Studio 5000 View
Designer®. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Status Banner for FactoryTalk® Optix™ . . . . . . . . . . . . . . . . . . . . . . . . 23
Faceplate Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Faceplate Revision Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Launch Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Library Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
State Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Architectural Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 3
Using the Library Install the Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Download the Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Download & Install Studio 5000® Application Code Manager . . . . 33
Register Libraries in Studio 5000® Application Code Manager . . . 34
CIP Message Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Ref_RingPointerNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Ref_PointerRingID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Ref_SwitchPaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 3
Table of Contents

Examples of DLR Object Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Example 1 - Device only ring, ControlLogix® with EN2TR (EN3TR/
EN4TR) Module slot 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Example 2- Device only ring, CompactLogix® 5380 with ports in DLR
mode, IP Address 192.168.1.23 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Example 3- Mixed DLR Network with switches and 1756-EN4TRs. 40
Importing Logic into Studio 5000® Projects . . . . . . . . . . . . . . . . . . . . . . . 46
Import Library Objects Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Import Rung Logic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Using Studio 5000 View Designer® . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Using Studio 5000 View Designer® Project Files . . . . . . . . . . . . . . . . 53
Configuring View Designer Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Using FactoryTalk® View Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Import FactoryTalk® View Visualization Files . . . . . . . . . . . . . . . . . . 54
Configuring FactoryTalk® View Objects. . . . . . . . . . . . . . . . . . . . . . . . 55
Using FactoryTalk® Optix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Download the Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Register FactoryTalk Optix Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Import Library Objects in FactoryTalk Optix Project . . . . . . . . . . . . 57
Using Style Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Configuring FactoryTalk Optix Objects . . . . . . . . . . . . . . . . . . . . . . . . 60
Library Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Add-On Instruction Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
DLR Add-on Instruction Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
FactoryTalk® View Upgrades. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Studio 5000 View Designer® Upgrades . . . . . . . . . . . . . . . . . . . . . . . . 68
FTOptix Upgrade Process (v1.4 to v1.5 or Higher). . . . . . . . . . . . . . . . 68

Chapter 4
Using Application Code Manager Overview of Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Adding & Configuring Device Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Adding Stratix Device Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
............................................................ 78
Adding DLR Device Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Configuring Displays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Generating Displays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Importing Displays into FactoryTalk® View Studio . . . . . . . . . . . . . . . . . 85
Generating Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Exporting Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Chapter 5
Using the Network Device Application Code Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Library with Other Application
Code Libraries Chapter 6
Stratix® Switch Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
(raC_Dvc_Stratix) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

4 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Table of Contents

Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
FactoryTalk® View HMI Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Studio 5000 View Designer® HMI Files . . . . . . . . . . . . . . . . . . . . . . . . 92
FactoryTalk® Optix Library Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Studio 5000® Application Code Manager Files . . . . . . . . . . . . . . . . . . 93
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Add-On Instruction I/O Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
InOut Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Output Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
raC_UDT_ItfAD_Stratix_Sts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
raC_UDT_Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
raC_UDT_LookupMember_STR0082 . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Add-On Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
FactoryTalk® View ME/SE Graphic Symbols . . . . . . . . . . . . . . . . . . . . 99
Studio 5000 View Designer® Graphic Symbols. . . . . . . . . . . . . . . . . 100
FactoryTalk® Optix Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . 100
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Switch Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Port Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Alarm Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Definition Objects: raC_Dvc_Stratix. . . . . . . . . . . . . . . . . . . . . . . . . . 118
Implementation Objects: raC_LD_Dvc_Stratix . . . . . . . . . . . . . . . . 118
Linked Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Configured HMI Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Chapter 7
Device Level Ring Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
(raC_Opr_NetDLR1, Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
raC_Opr_NetDLRLite) Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
FactoryTalk® View HMI Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Studio 5000 View Designer® HMI Files . . . . . . . . . . . . . . . . . . . . . . . 123
FactoryTalk® Optix Library Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Studio 5000® Application Code Manager Files . . . . . . . . . . . . . . . . . 123
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Add-On Instruction I/O Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
InOut Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 5

Table of Contents

Output Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Add-On Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
FactoryTalk® View ME/SE Graphic Symbols . . . . . . . . . . . . . . . . . . . 128
Studio 5000 View Designer® Graphic Symbols. . . . . . . . . . . . . . . . . 129
FactoryTalk® Optix Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . 129
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Ring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Node Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Fault Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
........................................................... 148
Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Definition Objects: raC_Opr_NetDLR1. . . . . . . . . . . . . . . . . . . . . . . . 150
Implementation Objects: raC_LD_Opr_NetDLR1 . . . . . . . . . . . . . . 150
Linked Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Configured HMI Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Chapter 8
Parallel Redundancy Protocol Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
(raC_Opr_NetPRP) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
FactoryTalk® View HMI Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Studio 5000 View Designer® HMI Files . . . . . . . . . . . . . . . . . . . . . . . 154
FactoryTalk® Optix Library Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
........................................................... 155
Studio 5000® Application Code Manager Files . . . . . . . . . . . . . . . . . 155
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Add-On Instruction I/O Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
InOut Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Output Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Add-On Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
FactoryTalk® View ME/SE Graphic Symbols . . . . . . . . . . . . . . . . . . . 158
Studio 5000 View Designer® Graphic Symbols. . . . . . . . . . . . . . . . . 158
FactoryTalk® Optix Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . 159
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Faceplate Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Diagnostic Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

6 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Table of Contents

Warning Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Definition Objects: raC_Opr_NetPRP. . . . . . . . . . . . . . . . . . . . . . . . . 169
Implementation Objects: raC_LD_Opr_NetPRP . . . . . . . . . . . . . . . 169
Linked Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Configured HMI Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 7

Table of Contents

8 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Preface

Device Object Libraries Our Device Object Libraries enable you to easily interface with Rockwell
Automation® intelligent devices like drives, motion, network switches,
Overview sensors, IO and more. The libraries contain tested, documented, and lifecycle-
managed objects which can be used with machine builder, process, and
packaged libraries or as standalone components. Device objects include HMI
faceplates for FactoryTalk® View ME/SE, FactoryTalk® Optix and Studio 5000
View Designer® software and provide a user interface that seamlessly
integrates with the products.

HMI faceplates are standard display files that provide a common user
interface. These are HMI pop-up screens used to display detailed information
related to a specific instruction or device. In systems that follow ISA 101.1
design guidelines, faceplates are often referred to as Level 4 displays.

Pre-configured Device Objects include an Add-On Instruction Rung and an

HMI Faceplate providing the following benefits:
• Collect, Process and Deliver Data between Smart Devices and
Application Logic
• Detailed Device Data Collection and Delivery
• Enhanced Device Status and Diagnostics
• Common Control Interfaces maximizing Flexible Automation Device
Selection & Application Code Reuse

Device Object Use Cases:

• Basic Device Maintenance and Diagnostics
• Virtual Device Operations for Startup and Commissioning
• Operator and Program Control for Velocity Machine and Process
Applications

Device Object Libraries may be downloaded from the Product Compatibility

and Download Center. Search for “Library”.

Application Code Manager Studio 5000® Application Code Manager is a tool that can be used with Device
Object Libraries to streamline project and machine development. This bulk
coding tool allows you to easily design and standardize functionality with
reusable application code.

Enable more efficient project development with reusable libraries of code:

• Quickly create and deploy projects through our Application Content
Libraries
• Import Rockwell provided application content libraries to expedite
system development

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

Preface

• Build your own reusable code that can be managed and deployed across
your entire enterprise
• Easily configure objects in bulk with reusable code to increase
application development, no additional programming is necessary
• Consolidate content for Studio 5000 Logix Designer®, FactoryTalk®
View Studio, FactoryTalk® Alarms & Events, FactoryTalk® Historian to
configure an object a single time and generate content for each of those
software packages.

See the section on Using the Library with Application Code Manager for more
details.

Other Application Code This Device Object Library may be used in harmony with other Application
Code Libraries including other Device Object Libraries (Power, IO, IO-Link,
Libraries Safety Device Libraries) or Application Libraries (PlantPAx® Process Objects
library, Machine Builder Libraries). All libraries are intended to follow similar
design philosophies to provide a consistent experience for operators and
maintenance staff.

A complete list of Application Code Libraries from Rockwell Automation®

follows.

Item Description
PlantPAx® Process Library Rockwell Automation® Library of Process Objects provides application templates, Endress + Hauser library objects,
Application Code Manager library objects, and tools and utilities for PlantPAx® DCS applications.
Includes the following:
• Graphics for built-in instructions
• HMI images and Help files
• Logix diagnostic objects
• Process objects
• Control strategies
• Sequencer objects
• PlantPAx® Configuration Tools for Tags, Alarms and Historian
• Color Change
• Historian -- Asset Framework template and objects
Machine Builder Libraries Tested, documented and life-cycle managed library objects and faceplates for use with Studio 5000® Application Code
Manager for use primarily with OEM and discrete machine applications.
Common Application Libraries Commonly used application library objects and faceplates for use with Studio 5000® Application Code Manager
including basic functions like unit conversion and data collection.
Independent Cart Technology Libraries ICT Libraries for iTRAK and MagneMotion including MagneMover LITE and QuickStick for Studio 5000® Application Code
Manager
I/O Device Library Provides objects for Rockwell Automation® 1756, 1769, 1734, 1794, 1738, 1732E, 1719, 5069, 5094 I/O modules
including pre-configured status and diagnostic faceplates
IO-Link Device Library Provides IO-Link master and sensor objects including pre-configured status and diagnostic faceplates
Network Device Library Provides objects for Stratix® switch and Device Level Ring network objects
Power Device Library Provides objects for discrete, velocity, motion, and power monitor devices
Safety Device Library Provides safety objects to interface with safety I/O
Condition Monitoring Device Library Provides Dynamix™ -1444 module and machinery Condition Monitoring applications such as motors and pumps. This
includes FactoryTalk View® SE HMI faceplates and Studio 5000® Application Code Manager implementations.
Electrical Protection Device Library Provides a standard to represent protection devices within your electrical distribution system

Libraries can be accessed from the

Product Compatibility and Download Center.

10 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Preface

Software and Firmware When you update software or firmware revisions, we recommend that you
verify the impact on performance and memory utilization before
Upgrades implementing the upgrade on the production system. For FactoryTalk® View
or ControlLogix® platforms, we recommend that you review the release notes
and verify the impact of the upgrade on performance and memory utilization.

You can also verify the compatibility of the upgrade with the installed software
and operating systems in use on Your system. See the Product Compatibility
and Download Center.

Rockwell Automation® System Support offers technical assistance that is tailored for control systems.
Some of the features include the following:
Services and Support
• Highly experienced team of engineers with training and
systems experience
• Use of online remote diagnostic tools
• Access to otherwise restricted TechConnectSM Knowledgebase content
• 24-hour, 7 days per week, 365 days per year of phone-support coverage upgrade
option

For more information, contact your local distributor or Rockwell Automation®

representative or see http://www.rockwellautomation.com/support.

You can view or download publications at

http://www.rockwellautomation.com/literature. To order paper copies of
technical documentation, contact your local Allen-Bradley® distributor or
Rockwell Automation® sales representative.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 11

Preface

12 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 1

Rockwell Automation® Network Device Library

The Network Device Library is a tested, documented, and life cycle managed
object library. The Device Library provides pre-configured status and
diagnostic faceplates and AOI sets for Rockwell Automation® network devices.
The Network Device Objects may be used with Machine Builder, Process, and
Packaged Libraries or as standalone components. Network Device Library add-
on instructions objects collect, process, and deliver data between hardware
devices and application logic.

The Network Device Library includes Add-On Instructions (AOIs) and HMI
Faceplates for Allen-Bradley® Stratix® Switch products, Device-Level Ring
(DLR) network monitoring and Parallel Redundancy Protocol (PRP) network
monitoring.

This document includes the functional requirements of the Stratix® Switch,

Device-Level Ring and Parallel Redundancy Protocol device objects.

The Network Device Library may be downloaded from the Product

Compatibility and Download Center. Search for Network Device Library.

Compatibility Compatible Software

• Studio 5000 Logix Designer® v30.02.00, v31.02.00, v32.04.00, v33.01.01,
v34.01.00, v35.01.00, v36.00.00 for PAC Application Development
• Studio 5000® Application Code Manager v4.0 and later for bulk code
configuration
• Studio 5000 View Designer® v8.01 and later for PanelView™ 5000
Application Development
• FactoryTalk® View Studio for FactoryTalk View ME/SE or PanelView™
Plus Application Development v11.00.00 and later
• FactoryTalk® Optix™ v1.5 or later
“Feature Preview” must be enabled in settings if any extended tag properties
(@.Description) is used.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 13

 Rockwell Automation® Network Device Library

Compatible Hardware
• PanelView™ 5500/5510/5310 with v8 or later firmware
• PanelView™ Plus v11 or later firmware
• FactoryTalk® Optix Panel
a. Optix Panel Standard 10.1” or larger
• ControlLogix®/GuardLogix® 5570 or 5580 controller with v30.011 or
later firmware
• CompactLogix™/Compact GuardLogix® 5580 or 5570 controller with
v30.011 or later firmware
• Stratix® 2500 with v2.003 or later firmware
• Stratix® 5200 with v17.12.02 or later firmware
• Stratix® 5400/5410 with IOS rev 15.2(7)E1a or later
• Stratix® 5700/ArmorStratix™ 5700 with IOS rev 15.2(7)E1a or later
• Stratix® 5800 with v17.12.02 or later

Summary of Changes This publication contains the following new or updated information. This list
includes substantive updates only and is not intended to reflect all changes.

Topic Page
Support for FTOptix version 1.5 and later has been added to the Library all
Bug fixed for Stratix AOI’s & DLR AOI’s all

Footprint Each instruction requires memory footprint within the Logix controller. The
following characteristics apply:
• Definition: Estimated memory required to store the object definition,
including all dependents
• Instance: Estimated memory required per object instantiated.
• Execution (L85E): Estimated execution time / scan footprint evaluated
in 1756-L85E PAC
Device Object Footprint
Device Object Defintion (kB) Instance (kB) Execution (µs)
raC_Dvc_StratixSwitch 145.74 19.19 135
raC_Opr_NetDLR1 203.42 30.05 50
raC_Opr_NetDLRLite 83.216 6.84 48
raC_Opr_NetPRP 110.80 11.93 320

14 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Rockwell Automation® Network Device Library

Additional resources For a complete understanding of Rockwell Automation safety applications it is

recommended to review the following documents.

Resource Description
Stratix Ethernet Device
Specifications Technical Data, Provides specifications for Stratix® Ethernet switches and other devices.
1783-TD001
Deploying Device Level Ring within Represents a collaborative development effort from Rockwell Automation and
a Converged Plantwide Ethernet Cisco Systems®. Provides application requirements, technology, and design
Architecture Design Guide, considerations to deploy Device Level Ring (DLR) technology through a plant-
publication ENET-TD015 wide Industrial Automation and Control System (IACS) network infrastructure.
EtherNet/IP Device Level Ring This publication describes DLR network operation, topologies, configuration
Application Technique ENET-AT007 considerations, and diagnostic methods.
Stratix Managed Switches User Describes how to configure, monitor, and troubleshoot Stratix® 5400, 5410,
Manual, 1783-UM007 5700, 8000, 8300, and ArmorStratix™ 5700 managed switches.
ControlLogix EtherNet/IP Network Describes how to configure and use EtherNet/IP devices to communicate on
Devices User Manual, 1756-UM004 the EtherNet/IP network.
Ethernet Reference Manual, Describes basic Ethernet concepts, infrastructure components, and
publication ENET-RM002 infrastructure features.
Troubleshoot EtherNet/IP Networks
Application Technique, publication Describes troubleshooting techniques for Integrated Architecture products
ENET-AT003 on EtherNet/IP networks.
Ethernet/IP Parallel Redundancy
Protocol Application Technique Describes how you can configure a Parallel Redundancy Protocol (PRP)
ENET-AT006D network with a compatible device or switch.
Deploying Parallel Redundancy
Protocol within a Converged Designing & Deploying the Parallel Redundancy Protocol within a Converged
Plantwide Ethernet Architecture Plantwide Ethernet Architecture (CPwE PRP)
ENET-TD021B
Application Code Manager User Studio 5000® Application Code Manager is a tool that enables more efficient
Manual LOGIX-UM003 project development with libraries of reusable code.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 15

 Rockwell Automation® Network Device Library

16 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2

Library Components

The Network Device Library is a tested, documented, and life cycle managed
object library. The Device Library provides pre-configured status and
diagnostic faceplates and AOI sets for Allen-Bradley® Stratix® Switches, Device
Level Ring (DLR) networks, and Parallel Redundancy Protocol (PRP) networks.
The Network Device Objects may be used with Machine Builder, Process, and
Packaged Libraries or as standalone components. Network Device Library add-
on instructions objects collect, process, and deliver data between hardware
devices and application logic.

Network Device The Network Device Library includes instructions to interface with Stratix®
managed network switches and Device Level Ring (DLR) networks.
Instructions
A single Stratix® Switch Add-On Instruction is used for any compatible
Stratix® or ArmorStratix™ managed switch (2500/5400/5410/5700/5800/5200).
Specific HMI faceplates are used for each Stratix® model.

The Stratix® Switch Objects included are as follows:

• raC_Dvc_Stratix® - Generic Stratix® Switch

The Device Level Ring (DLR) add-on instructions support either a single ring
with up to 12 nodes (DLR Lite), A single ring, identified as DLR1, has the
capacity to support up to 56 nodes. In case of larger networks that include
multiple ring networks, you will have to use multiple DLR1 AOI instances. Each
AOI instance is capable of accommodating up to 56 nodes. The DLR1 Add-On
Instruction can be paired with either the 24 node or 56 node HMI faceplates
depending on the network size. It is recommended to use a PanelView™ Plus 7
with a minimum resolution of 640x390 for 24 node HMI faceplates and a
minimum resolution of 800x600 for 56 node HMI faceplates.

The Device Level Ring (DLR) Objects includes are as follows:

• raC_Opr_NetDLR1
• raC_Opr_NetDLRLite

The Parallel Redundancy Protocol (PRP) Objects includes are as follows:

• raC_Opr_NetPRP

There are two types of instruction in this library:

• Device (Dvc): instruction used for devices (e.g. Stratix® Switch).
• Operation (Opr): instruction used for operation (e.g. Network
Monitoring)

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 17

Chapter 2 Library Components

Network Device Instructions

Compatible
Add-On Instruction FactoryTalk® View ME Faceplate FactoryTalk® View SE Faceplate Version
Device/Network
Stratix® 2500 (raC-12_04-ME) raC_Dvc_S2500-Faceplate (raC-12_04-SE) raC_Dvc_S2500-Faceplate 12.04
Stratix® 5200 (raC-12_04-ME) raC_Dvc_S5200-Faceplate (raC-12_04-SE) raC_Dvc_S5200-Faceplate 12.04
Stratix® 5400 (raC-12_04-ME) raC_Dvc_S5400-Faceplate (raC-12_04-SE) raC_Dvc_S5400-Faceplate 12.04
raC_Dvc_Stratix Stratix® 5410 (raC-12_04-ME) raC_Dvc_S5410-Faceplate (raC-12_04-SE) raC_Dvc_S5410-Faceplate 12.04
Stratix® 5700 (raC-12_04-ME) raC_Dvc_S5700-Faceplate (raC-12_04-SE) raC_Dvc_S5700-Faceplate 12.04
ArmorStratix™ 5700
Stratix® 5800 (raC-12_04-ME) raC_Dvc_S5800-Faceplate (raC-12_04-SE) raC_Dvc_S5800-Faceplate 12.04
Single Ring (raC-12_04-ME) raC_Opr_NetDLR1_24Node-Faceplate (raC-12_04-SE) raC_Opr_NetDLR1_24Node-Faceplate 12.04
24 Notes Maximum
raC_Opr_NetDLR1
Single Ring (raC-12_04-ME) raC_Opr_NetDLR1_56Node-Faceplate (raC-12_04-SE) raC_Opr_NetDLR1_56Node-Faceplate 12.04
56 Notes Maximum
Single Ring
raC_Opr_NetDLRLite (raC-12_04-ME) raC_Opr_NetDLR1_12Node-Faceplate (raC-12_04-SE) raC_Opr_NetDLR1_12Node-Faceplate 12.04
12 Nodes Maximum
PRP Node Table
applicable with 1756-
EN2TP, 1756-EN4TR,
raC_Opr_NetPRP (raC-12_04-ME) raC_Opr_NetPRP-Faceplate (raC-12_04-SE) raC_Opr_NetPRP-Faceplate 12.04
5094-AEN2TR And
maximum 240 PRP
Nodes

Compatible
Add-On Instruction Studio 5000 View Designer® Faceplate FactoryTalk® Optix™ Faceplate Version
Device/Network
Stratix® 2500 (raC-12_04-VD) raC_Dvc_S2500_FP raC_12_04_raC_Dvc_S2500_Faceplate 12.04.001
Stratix® 5200 (raC-12_04-VD) raC_Dvc_S5200_FP raC_12_04_raC_Dvc_S5200_Faceplate 12.04.001
Stratix® 5400 (raC-12_04-VD) raC_Dvc_S5400-FP raC_12_04_raC_Dvc_S5400_Faceplate 12.04.001
raC_Dvc_Stratix Stratix® 5410 (raC-12_04-VD) raC_Dvc_S5410-FP raC_12_04_raC_Dvc_S5410_Faceplate 12.04.001
Stratix® 5700 (raC-12_04-VD) raC_Dvc_S5700-FP raC_12_04_raC_Dvc_S5700_Faceplate 12.04.001
ArmorStratix™ 5700
Stratix® 5800 (raC-12_04-VD) raC_Dvc_S5800-FP raC_12_04_raC_Dvc_S5800_Faceplate 12.04.001
Single Ring (raC-12_04-VD) raC_Opr_NetDLR1_24Node-FP raC_12_04_raC_Opr_NetDLR1_24Node_Faceplate 12.04.001
24 Notes Maximum
raC_Opr_NetDLR1
Single Ring (raC-12_04-VD) raC_Opr_NetDLR1_56Node-FP raC_12_04_raC_Opr_NetDLR1_56Node_Faceplate 12.04.001
56 Notes Maximum
Single Ring
raC_Opr_NetDLRLite (raC-12_04-VD) raC_Opr_NetDLR1_12Node-FP raC_12_04_raC_Opr_NetDLRLite_Faceplate 12.04.001
12 Nodes Maximum
PRP Node Table
applicable with 1756-
EN2TP, 1756-EN4TR,
raC_Opr_NetPRP (raC-12_04-VD) raC_Opr_NetPRP-FP raC_12_04_raC_Opr_NetPRP_Faceplate 12.04.001
5094-AEN2TR And
maximum 240 PRP
Nodes

In case of larger networks that include multiple ring networks, you

will have to use multiple DLR1 AOI instances. Each AOI instance is
capable of accommodating up to 56 nodes.

18 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Library Folders and Files When you extract the library from the downloaded .zip folder, you will find the
following folder and file structure. Note that some items are generalized with
TYPE (e.g. Dvc, Opr, Tec) and OBJECT (e.g. S2500, S5400, etc). The major and
minor versions are represented by X and Y respectively.

Level 1 Level 2 Level 3 File Type Description

ApplicationCodeManagerLibraries Application Code Manager
Folder files
Attachments (.HZ1 and .txt files) Folder ACM Object Attachments
(RA-LIB)_Device_Asset-Control_GROUP_raC_Dvc_OBJECT_(X.Y).HSL4 HSL4 ACM Asset-Control Object
(RA-LIB)_Device_Device_GROUP_raC_Dvc_OBJECT_(X.Y).HSL4 HSL4 ACM Device Object
HMI - FactoryTalk® View ME Folder FactoryTalk® View ME files
Displays - gfx Folder FT View ME display files
(raC-X_YY-ME) raC_TYPE_OBJECT-faceplate.gfx GFX Object Faceplate display
Global Objects - ggfx Folder FT View ME Global Object files
Graphic Symbol/Launch Button
(raC-X-ME) Graphic Symbols - LIBRARY.ggfx GGFX
global objects
(raC-X-ME) Toolbox - LIBRARY.ggfx GGFX Toolbox global objects
HMI - FactoryTalk® View SE Folder FactoryTalk® View SE Files
Displays - gfx Folder FT View SE display files
(raC-X_YY-SE) raC_TYPE_OBJECT-faceplate.gfx GFX Object Faceplate display
Global Objects - ggfx Folder FT View SE Global Object files
Graphic Symbol/Launch Button
(raC-X-SE) Graphic Symbols - LIBRARY.ggfx GGFX global objects
(raC-X-SE) Toolbox - LIBRARY.ggfx GGFX Toolbox global objects
HMI - ViewDesigner - vpd Folder View Designer Files
(raC-X_YY-VD) raC_Dvc_Stratix.vpd Object faceplate and graphic
VPD
(raC-X_YY-VD) raC_Opr_NetDLR.vpd symbol/launch buttons
FactoryTalkOptixLibraries FactoryTalk® Optix Library
Folder Files
NetworkDevice_vXR Folder Library Folder
NetworkDevice_vXR.optix FT Optix Library Application
HMI FactoryTalk® View Images - Folder FT View ME/SE image files
png
images.png PNG FTView ME/SE images
Reference Manuals Folder Manuals
RAC-RM400C.pdf PDF Reference manual
Studio 5000 Logix Designer Files - Studio 5000® AOI and RUNG
Folder
L5X import files
raC_TYPE_OBJECT_X.YY_RUNG.L5X L5X Object rung import
raC_TYPE_OBJECT_X.YY_AOI.L5X L5X Object AOI import
Explanation of standard vs
ReadMe.txt TXT PlantPAx® files

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 19

Chapter 2 Library Components

Videos How-to and Operational

Folder Overview Videos
How_To_Import_and_Configure_TYPE_Objects_in_FTViewME.mp4 MP4 How-to Video
How_To_Import_and_Configure_TYPE_Objects_in_FTViewSE.mp4 MP4 How-to Video
How_To_Import_and_Configure_TYPE_Objects_in_LogixDesigner.mp4 MP4 How-to Video
How_To_Configure_TYPE_Objects_in_ViewDesigner.mp4 MP4 How-to Video
How to Import and Configure Device Objects in FTOptix MP4 How-to Video
Operational_Overview_of_OBJECT_Faceplate.mp4 MP4 Operational Overview video
ReadMe.txt TXT Explanation of setup.cmd
Application Code Manager setup
SetUp.cmd CMD script to register library

See the files in the Application Example folder to see a functional application that
uses all of the Network Device Library instructions. These files are referenced in
the Programming Examples for each instruction. The files include a Studio 5000
Logix Designer® controller file, a Studio 5000® Application Code Manager project
back-up, and an HMI projects for Studio 5000 View Designer®, FactoryTalk® View
ME, FactoryTalk® View SE, and FactoryTalk® Optix.

20 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Visualization Files Each Add-On Instruction has associated visualization files that provide a
common user interface. The Network Device Library supports HMI options
each with their own files supplied:
• FactoryTalk® View ME (Machine Edition)
• FactoryTalk® View SE (Site Edition)
• Studio 5000 View Designer®
• FactoryTalk® Optix™

FactoryTalk® View Visualization Files

You must import these files in the following order:
• Images (.png files)
• Global Objects(.ggfx file type)
• HMI faceplates (.gfx file type)

File Type FactoryTalk® View ME FactoryTalk® View SE Description

Abbreviations
All .png files in the HMI FactoryTalk® View All .png files in the HMI FactoryTalk® View
Images - png folder. Images - png folder.
Images (.png) IMPORTANT: FactoryTalk® View application IMPORTANT: FactoryTalk® View application Common icons that are used in the Global
renames PNG files when they are imported renames PNG files when they are imported Objects and standard displays for all objects.
with a .bmp file extension, but the files retain a with a .bmp file extension, but the files retain a
.png format. .png format.
(raC-12-ME) Graphic Symbols - Network (raC-12-SE) Graphic Symbols - Network Graphic symbols or launch buttons used to
Device.ggfx Device.ggfx open faceplate displays from other displays.
Global objects (.ggfx)
Common objects used across multiple device
(raC-12-ME) Toolbox - Network Device.ggfx (raC-12-SE) Toolbox - Network Device.ggfx faceplates.
e.g. (raC-12_04-SE) raC_Dvc_S5700-
Standard displays (.gfx) (raC-12_04-ME) precedes name of the display. (raC-12_04-SE) precedes name of the display. Faceplate.gfx

Global object files contain Graphic Symbols that are created once and
referenced multiple times on multiple displays in an application. When
changes are made to a global object, all instances in the application are
automatically updated.

Global objects serve two purposes:

• Toolbox files contain common elements that are used to build faceplate
displays.
• Graphic Symbols files contain device symbols or launch buttons that
you can use to build your application displays. Select the symbol to
open the corresponding faceplate display.

Standard display files, commonly called faceplates, provide a common user

interface.

Studio 5000 View Designer® Visualization Files

Two Studio 5000 View Designer® project files are supplied which contain
faceplates and launch buttons for the Network Device Library. These are split
into a project for Stratix® switch objects (raC_12_04-VD) raC_Dvc_Stratix.vpd,
Device Level Ring Objects (raC-12_04-VD) raC_Opr_NetDLR.vpd and Parallel
Redundancy Protocol (raC-12_04-VD) raC_Opr_NetPRP.vpd.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 21

Chapter 2 Library Components

These files are found in the HMI - ViewDesigner - vpd folder. Inside of the VPD
file you will find a the required display files inside of the User-Defined Screens
folder.

Display Type View Designer Screen Description

Graphic symbols or launch buttons used to open faceplate/pop-up displays from other
Screen Toolbox displays.
Pop-Up raC_Dvc_ precedes name of the pop-up. Faceplate display for specific device. e.g. raC_Dvc_S5700_FP

FactoryTalk® Optix Library Objects Visualization Files

Once the library files have been added to the standard library location
(C:\Users\Username\Documents\Rockwell Automation\FactoryTalk
Optix\Libraries\) using the Setup.cmd script, the following library objects will
be available in the NetworkDevice_v12R Library:

Note: xx may be replaced with the current minor version.

Library Object Description
raC_12_xx_raC_Dvc_DeviceName_UI Network Device faceplate user interface components and graphic symbols

raC_12_xx_raC_Dvc_DeviceName_UI

The User Interface (UI) library object folder contains all graphical components
for raC_Dvc_DeviceName_UI. This includes:

Level 1 Level 2 Level 3 Type Description

Folder User interface files
raC_12_xx_raC_Dvc_DevicName_UI
raC_12_xx_raC_Dvc_DeviceName_Faceplate Dialog Box Faceplate for Network Device
Graphic Symbols Folder Graphic symbol launch buttons
Graphic symbol launch button used to navigate to
raC_12_xx_raC_Dvc_DeviceName_GS Button
raC_12_xx_raC_Dvc_DeviceName_Faceplate.
Private elements used in faceplate design. These do
<PrivateElements> Folder
not need to be accessed or modified by library users.
PanelsFaceplate Folder Panels used in faceplates
Widgets Folder Widgets used in faceplates

Basic Faceplate Attributes Faceplate consist of tabs, and each tab consists of one or more pages. The
Home tab is displayed when the faceplate is initially opened. The faceplate
provides the means for operators, maintenance personnel, engineers, and
others to interact with a device or instruction instance, which includes a view
of its status and values. Faceplate may also manipulate an instruction through
its commands and settings. Select the appropriate icon on the left of the
faceplate to access a specific tab. This section provides an overview of the
faceplate attributes that are common across the objects. More details are
supplied in the individual section for each object.

22 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Status Banner for FactoryTalk® View ME/SE and Studio 5000 View
Designer®

At the top of all device object faceplates there is a common status banner which
provides the following information:
• Ready (green LED icon) or Not Ready (yellow LED icon) status
• Faulted (banner will show Not Ready with fault message)
• Communication Loss

3 4

Item Description
1 Ready state displays green LED icon and grey background.
2 Faulted state shows yellow LED icon and Not Ready status.
3 Fault message for latest fault present.
4 Fault reset button
5 Add-On Instruction not enabled status

Status Banner for FactoryTalk® Optix™

At the top of all device object faceplates in FactoryTalk Optix there is a common
status banner which provides the following information:
• Ready or Not Ready Status
• Faulted (banner will show Not Ready with fault message)
• Communication Loss

A fault status may be reset using the Reset button on the right side of the
banner if the condition has been cleared.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 23

Chapter 2 Library Components

3 4 5 6

Item Description
1 Ready state displays Ready Status
2 Faulted state shows Fault and Not Ready status
3 Fault message for latest fault present
4 Faulted state shows Black background
5 Transparent button to navigate fault tab
6 Fault reset button

Faceplate Navigation
All device object faceplates have navigation tabs on the left side of the
faceplate. Navigation tabs may vary based on device type. The active tab will
show as a light grey, while an inactive tab will show as a dark grey.

Active Tab Inactive Tab

The common tabs are shown below.

Home Tab Ring Tab

Port Details Tab Fault Tab

Switch/Node Tab

Faceplate Revision Notes By clicking on the open space near the bottom left corner of the faceplate you
can momentarily view revision notes and details of the active faceplate. This
may be useful in troubleshooting or when communicating with Rockwell
Automation® Tech Support.

24 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Item Description
1 Click near the bottom right corner to temporarily open up the revision notes dialogue
2 Revision number
3 Faceplate display name
4 Close revision information button

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 25

Chapter 2 Library Components

Additionally, The Optix Faceplates are provided with the Help Button for each
faceplates. Help Button is located on the upper right corner of Faceplate frame
as shown in image below,

When user click on the Help Button it will open a pop-up display which
includes a Help Document and Accordian which contains web browser to
access Reference manual from web. See in Image provided below

3 5

Item Description
1 Help Pop-Up window with Close button
2 Help Document
3 Accordion which contains Reference Manual web browser (Status: - Not Expanded)
4 Revision Information
5 Accordion which contains Reference Manual web browser (Status: - Expanded) shown in image below.
Note: Active Internet connection is required to see Reference Manual.

26 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Launch Buttons Launch buttons are provided in Global Display (GGFX) files for FactoryTalk
View® ME/SE as well as in Studio 5000 View Designer® projects. These are
used to open HMI faceplate displays or pop-ups. Two types of launch buttons
are provided:

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 27

Chapter 2 Library Components

Launch Button Image Examples Usage

Style

Basic Text Simple launch button with diagnostic

Button information.

Graphic button can be used in

schematic style displays where a
Graphical system/network diagram is shown.
Button When available, basic module
diagnostics is displayed.

Basic Text Simple launch button with diagnostic

Button in FT information.
Optix

Graphic button can be used in

schematic style displays where a
Graphical system/network diagram is shown.
Button When available, basic module
in FT Optix diagnostics and a live value is
displayed.

Diagnostic Icons

Diagnostic icons may be displayed on the graphic buttons for compatible

modules. Safety modules are designated with a small guard icon.

Icon Image Visible Condition

Communications Failure Connection Faulted

Any device fault active

Fault (module hardware issue)

Any device warning

Warning active (maintenance
required)

Not Ready Device Not Ready

28 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Library Versions Each library object has a revision x.yy where: x is the Major Revision number
and yy is the Minor Revision number. Each release of the library comes with
release notes that describe the changes that were made since the last release.
You can find the revision number of the object in a number of locations as
shown below.

Component Example

The Add-On Instruction in Logix Designer

application has revision information
visible when the instruction is selected
in the Controller Organizer.

The Add-On Instruction Definition

General tab shows the revision number
along with basic revision notes. Refer to
the release notes for complete revision
notes.

The faceplate in FactoryTalk® View

software has revision information
visible when the pointer is clicked just
inside the lower left corner of the
faceplate.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 29

Chapter 2 Library Components

Component Example

The revision number is shown in the file

names for GFX, VPD, ACM.HSL4, AOI.L5X,
and RUNG.L5X files.

In FactoryTalk® Optix™ Library object

folder where the major (x) and minor (y)
versions are used in the folder name e.g.
raC_x_yy_raC_Dvc_DeviceName_UI
The major (x) revision number is used in
the Library folder and file name
e.g. NetworkDevice_vxR
Note that only major versions are used
at the library level and a library may
contain multiple minor versions of
different objects.

State Model The following section will discuss the state model for Device Object. The figure
below shows the core logic states.

By default, each state is active for a minimum of 256us to allow for evaluation
of state outside of the ADO instance in the user program

30 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 2 Library Components

Interfaces Device object interfaces are intended to provide the application programmer a
class based harmonized interface for interacting with the device object from
user code. Standard control interfaces are used for passing device inputs (Inp),
device configuration (Cfg), Settings (Set), Commands (Cmd) and Status (Sts).

In the Network Device Library, only a Status (Sts) interface is provided for the
raC_Dvc_StratixAll object. This interface called Ref_Ctrl_Sts provides status
information for the object such as connected, warning and fault statuses. The
data-type used is raC_UDT_ItfAD_Stratix_Sts. This common interface allows
you to easily switch between Stratix® switch devices without having to update
user code. For complete information on this interface, please refer to the
raC_Dvc_Stratix® section of this manual.

Application Code Manager Architectural Overview

Device libraries, as with most Application Code Libraries are divided into 2
logical groups: either Asset-Control Object or Device Implement Object.

Asset-Control Objects contain the asset definition of an object and any

associated content which belongs to the asset. This includes controller tags,
add-on instructions, data types, and attachments such as HMI content and

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 31

Chapter 2 Library Components

documentation. These are found under the (RA-LIB) Device > Asset-Control
folder and have names like raC_Dvc_xxxx where xxxx is the device name.

Device Implement Objects contain an instance of an asset-control object and

provide all related configuration of the asset. The Device implement type is the
application code (e.g. programming rung). This includes the required
controller tags, programs, modules, and FactoryTalk® View ME/SE symbols.
These are found under the (RA-LIB) Device > Device folder and have names like
raC_LD_Dvc_xxxx where xxxx is the device name. LD stands for ladder logic.

32 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 3

Using the Library

Install the Library Download the Library

For the latest compatible software information and to download the Rockwell
Automation® Library, see the Product Compatibility and Download Center.

Search “Device Library” or filter on Application Content to quickly find the

library.

Download & Install Studio 5000® Application Code Manager

Studio 5000® Application Code Manager is free to install from Rockwell
Automation’s Product Compatibility and Download Center.

Search “Application Code Manager” and select the item to download.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 33

 Using the Library

Extract the downloaded .zip file by running the 4.xx.00-Studio5000_ACM-

DVD.exe executable file. This will extract a new folder containing a Setup.exe file
which can be run to begin product installation.

Follow the prompts from the splash screen until installation is complete. Note
that a SQL server is required for Application Code Manager. SQL Server
Express is offered for free and is included in the Application Code Manager
installer.

Register Libraries in Studio 5000® Application Code Manager

It is recommended that you use Studio 5000® Application Code Manager or
the Studio 5000® “Import Library Objects” Plug-In Wizard to import device
library objects into a Logix 5000 controller project. To use the library in
Application Code Manager you must first register the libraries.

Using Studio 5000® Application Code Manager is not mandatory although it is

highly recommended to reduce the likelihood of configuration errors and
simplify the workflow. Alternatively, you can import the RUNG.L5X files directly
into a Studio 5000® project.
The Lite version of Studio 5000® Application Code Manager is free of charge and
can be downloaded from the Product Compatibility and Download Centre. None
of the features included in the Standard (paid) version are required to use Device
Object Libraries.

34 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Register Complete Library Automatically

To automatically register the entire library, find and run the setup.cmd file in
the root folder of the library files. You will see a windows console appear as the
script runs. When it is complete it will display “Deployment Complete”. Enter
“Y” to exist the console.

Register Individual Library Objects Manually

As an alternative to registering the entire library using the setup.cmd script,

you can manually register one or multiple library objects in Studio 5000®
Application Code Manager. Open up Application Code Manager and view the
Registered Libraries panel on the right. Right-click on Registered Libraries and
select Register. Browse to the ApplicationCodeManagerLibraries folder within the
library files and select any HSL4 files that you would like to register. Note you
may select more than one at a time. Once you complete registering the desired
objects they will be shown under the (RA-LIB) Device solution folder.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 35

 Using the Library

CIP Message Paths CIP message paths must be configured in DLR objects to communicate with
the network. This includes the following Instructions. Instructions has few
parameter that need to be configure which are explained below.

Ref_RingPointerNode
To assign the Ref_RingPointerNode please refer to any Module that is directly
connected to the Device Level Ring (DLR). For Stratix Switches, use the
designated DLR IP address, and avoid using a VLAN reference. Ensures
references to non-CIP VLANs should be actively prevented.

Ref_PointerRingID
For the Pointer node, set the Ring ID to ‘1’ for devices other than Stratix. Stratix
devices must use the actual Ring ID associated with their participation in the
application ring.

Ref_SwitchPaths
Ref_SwitchPaths is an array containing CIP-VLAN path details for Stratix
switches within Ring networks. Switch[0] reference is required if Stratix
reference is used as a Pointer Node. Switches 1-9 are optional.

Ref_SwitchPaths parameter is a UDT data type which members & description

are as follows.
Members Description
Description User defined description of a switch
DeviceType Switch platform ie. 5200, 5400, 5700, 5800 – used with configurator tab only
Source port of the controller
L5570: 1-Backplane
L5580: 1-Backplane, 2-Front Port
From_ControllerPort L5370: 2-Front Port
L5380: 2-A1/A2 DLR, 3-Front Port A1, 4-Front Port A2
L5480: 2 - Port B1, 3-A1/A2 DLR, 4-Front Port A1, 5-Front Port A2

36 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Members Description
Slot number for 1756-EnxT(R) module. 0-16 Valid Slots. Required for 5570 and 5580
Via_BackplaneSlot controllers with ENxT modules only.
For all other set to 0.
To_IPAddress IP Address of a DLR Node
The device Ring number used in this specific application
Eg.
Device_RingID For Stratix switches that support one ring only, Ring ID =1
For Stratix switches that support more than one ring, Ring ID =1, 2 or 3

You can configure Ref Switch Paths using two methods

1. Using switch configutator AOI's (In this case you will need to add
switches in H/W IO tree)
2. Using configuration tab of DLR Faceplate

Examples of DLR Object Example 1 - Device only ring, ControlLogix® with EN2TR (EN3TR/
Configuration. EN4TR) Module slot 2.

Example scenario

The Ring application utilizes multiple CompactLogix controllers and a single

ControlLogix controller chassis with an EN2TR (or EN3TR/EN4TR)
communication module in slot 2.

Ring Diagram

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 37

 Using the Library

DLR Object AOI Rung

In this scenario, we have a single ring network. Therefore, you only need to
import a single instance of raC_Opr_NetDLR1. Additionally, please note the
following:
• Since there are no switches in the ring network, CIP message
configuration is not required.
• You need to delete the Switch Configuration instance that is created
during the Rung Import process.

However, if you use ACM/Plug-in to create new objects, you do not need to
manually delete the Switch Configurator AOIs

• To configure the AOI Parameter as per above Example 1 ring Diagram

1. Ref_RingPointerNode - Point to EN2TR or Any Module.
2. Ref_PointerRingID - Set value ‘1’ for EN2TR
3. Ref Switch Path - Not required to configure. (Delete the Optional
Configurator AOI Rung)

38 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Example 2- Device only ring, CompactLogix® 5380 with ports in DLR

mode, IP Address 192.168.1.23

Example scenario

The Ring application utilizes multiple communication module AENTR and

CompactLogix controller with DLR ports.

Ring Diagram

DLR Object AOI Rung

In this scenario, we have a single ring network. Therefore, you only need to
import a single instance of raC_Opr_NetDLR1. Additionally, please note the
following:
• Since there are no switches in the ring network, CIP message
configuration is not required.
• You need to delete the Switch Configuration instance that is created
during the Rung Import process.

However, if you use ACM/Plug-in to create new objects, you do not need to
manually delete the Switch Configurator AOIs.

• Configure the AOI Parameter as per above Example 2 Ring Diagram

1. Ref_RingPointerNode - Point to Any I/O Adapter Module.
2. Ref_PointerRingID - Set value ‘1’
3. Ref Switch Path - Not required to configure. (Delete the Optional
Configurator AOI Rung)

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 39

 Using the Library

Example 3- Mixed DLR Network with switches and 1756-EN4TRs

Example scenario

The Ring application features two separate networks, Application Ring A

(10.10.20.x) and Application Ring B (10.10.10.x), sharing a common VLAN and
CIP-enabled switch infrastructure.

Application Ring B is also comprises CIP paths and IP addresses. The two rings
differ in their application ring paths, utilizing unique EN4TR modules and
RING IDs.

Ring Diagram

40 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

DLR Object AOI Rung

Two AOI Rung with configuration AOI’s is imported For Ring A and Ring B.

• Configure the AOI Parameter for Ring A as per above Example 3 Ring
Diagram
1. Ref_RingPointerNode - Point to EN4TR Module Slot 1
2. Ref_PointerRingID - Set value ‘1’
3. Ref Switch Path - Two methods to configure this
b. Using switch configutator AOI's (In this case you will need to add
switches in H/W IO tree)
c. Using configuration tab of DLR Faceplate

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 41

 Using the Library

Method 1 - Ring A Switch CIP Path Configuration:

Using switch configuration AOI's (In this case you will need to add switches in
H/W IO tree and do not delete the Optional Configuration AOI - Rung).

In our example, there are a total of four switches, so you will need four switch
configuration AOIs. All other AOIs should be deleted to avoid verification
errors.

Following steps required to be done for each Switch Configuration.

1. Select Switch 0 Configuration AOI and click next to Ref_SwitchDevice
2. Browse the Module ‘S5400_dot3’ from IO-Tree
3. Set the Inp_SwitchRingID ‘2’ as per Switch Ring A
4. Set Input Accept to ‘1’
5. Repeat steps 1 to 4 for Switches 1 through 3

The below pictures shown the configuration of Ring A using Method 1

Ring A Configuration

Method 2 - Ring A Switch CIP Path Configuration:

Using configuration tab of DLR Faceplate. Following steps required to be done.

1. Delete all the Switch Configurator AOI’s Rung.
2. Download the project into Controller and go to Online.
3. Run the HMI Application.
4. Open DLR Object faceplate for Ring A.
5. Navigate to Configuration tab of DLR Faceplate.
6. To access the Configuration press on Disable Button.
7. Go to Step 1 and select Switch ‘0’
42 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024
 Using the Library

8. Go to Step 2 and Enter the Description e.g. S5400_dot3

9. Select controller to switch path as Backplane and Slot 3. (CIP Path is
Required)
10. Enter the CIP IP 10.10.10.3
11. Select device type ‘Stratix 5400’
12. Select DLR Ring ID ‘2’ as configuring Ring A
13. Press on Accept button to Accept all the Configured value of Switch ‘0’
14. Repeat steps 7 to 13 for Switches 1 through 3. The remaining switches do
not require configuration.

The below pictures shown the configuration of Ring A using Method 2

• Configure the AOI Parameter for Ring B as per above Example 3 Ring
Diagram
1. Ref_RingPointerNode - Point to EN4TR Module Slot 3
2. Ref_PointerRingID - Set value ‘1’
3. Ref Switch Path - Two methods to configure this
d. Using switch configutator AOI's (In this case you will need to add
switches in H/W IO tree)
e. Using configuration tab of DLR Faceplate

Method 1- Ring B Switch CIP Path Configuration:

Using switch configuration AOI's (In this case you will need to add switches in
H/W IO tree and do not delete the Optional Configuration AOI - Rung).

In our example there are total four switches so we required four configuration
AOI’s. Rest of the AOI’s deleted to avoid verification error.

Following steps required to be done for AOI Switch Configuration.

1. Select Switch 0 Configuration AOI and click next to Ref_SwitchDevice
2. Browse the Module ‘S5400_dot3’ from IO-Tree
3. Set the Inp_SwitchRingID ‘1’ as per Switch Ring B

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 43

 Using the Library

4. Set Input Accept to ‘1’

5. Same steps from 1 to 4 required to Switch 1 to 3

The below pictures shown the configuration of Ring B using Method 1

Ring BConfiguration

Method 2 - Ring B Switch CIP Path Configuration:

Using configuration tab of DLR Faceplate. Following steps required to be done.

1. Delete all the Switch Configuration AOI’s Rung.
2. Download the project into Controller and go to Online.
3. Run the HMI Application.
4. Open DLR Object faceplate for Ring B.
5. Navigate to Configuration tab of DLR Faceplate.
6. To access the Configuration press on Disable Button.
7. Go to Step 1 and select Switch ‘0’
8. Go to Step 2 and Enter the Description e.g. S5400_dot3
9. Select controller to switch path as Backplane and Slot 3. (CIP Path is
Required)
10. Enter the CIP IP 10.10.10.3
11. Select device type ‘Stratix 5400’
12. Select DLR Ring ID ‘1’ as configuring Ring B
13. Press on Accept button to Accept all the Configured value of Switch ‘0’
14. Repeat steps 7 to 13 for Switches 1 through 3. The remaining switches do
not require configuration.

44 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

The below pictures shown the configuration of Ring B using Method 2

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 45

 Using the Library

Importing Logic into Studio There are multiple methods to using the logic in a Studio 5000® application.
For projects that are being developed from scratch using Studio 5000®
5000® Projects Application Code Manager along with other Application Code Libraries such as
the PlantPAx® Process Objects Library or the Machine Builder Library, you can
continue to use the Device Object Libraries in Application Code Manager. For
existing applications where devices are being added, it is recommended to use
the Studio 5000® Plug-In “Import Library Objects” Wizard. Alternatively you
can import the RUNG.L5X files into your program and configure them
manually.

In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following videos for this section:
“How_To_Import_and_Configure_Stratix_Switch_Device_Objects_in_Logix_Desig
ner”
“How To Import and Configure Single DLR Object Components in Logix Designer”

It is not recommended to simply import the AOI.L5X files and attempt to build
your own logic rung. Doing so will increase the likelihood of configuration errors
and likely miss logic that is required outside of the Add-On Instruction.
AOI files should only be imported when updating an existing application from a
previous version of a Device Object Library to a newer one.

Below is a table to capture recommendations on when to use which tool or

workflow when importing and configuring device objects.

Tool/Workflow Description of when to use Software Requirements

Studio 5000® Application Code Project is developed from scratch using Studio 5000 Logix Designer®
Manager Application Code Manager along with Studio 5000® Application Code Manager
(full application) PlantPAx® or Machine Builder libraries. (Lite)
Application Code Manager is installed
but not required for the entire project. Studio 5000 Logix Designer®
Studio 5000® Plug-In “Import Application has already been developed Studio 5000® Application Code Manager
Library Objects” Wizard but some Device Objects need to be (Lite)
added.
Application Code Manager is not
installed.
Application has already been developed
Import RUNG.L5X File Studio 5000 Logix Designer®
but some Device Objects need to be
added.
Familiar with rung import workflow.
Updating existing application that
Import AOI.L5X File contains an older version of a Device Studio 5000 Logix Designer®
Object AOI.

Import Library Objects Wizard

The most simple way to import a Device Object into an existing application is
to use the Studio 5000® Plug-In “Import Library Objects” wizard. This plug-in
requires Application Code Manager to be installed but does not require it to be
open or have a project created.

46 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Right click on an item (e.g. Controller, Task, Program, etc) in the Controller
Organizer and select Plug-Ins > Import Library Objects...

This will launch a small wizard version of Application Code Manager inside of
your Studio 5000 Logix Designer® Project. In the Registered Libraries panel on
the left, find your desired object under Registered Libraries > (RA-LIB) Device >
Device and drag it into the Library Object(s) list in the Object Configuration
Tab.

Stratix Configuration

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 47

 Using the Library

Perform the following configuration:

Parameters - 00 General:
• Enter a name and description. Maximum name length can be 22
characters. Note that other parameters such as the RoutineName,
TagName, etc will auto-complete based on these fields.
• Assign the Task and Program.

Parameters - 01 Module:
• You can choose to automatically create the Stratix® switch module in
your program if not already included by setting IncludeHW to True.
• Assign the desired ModuleName, ModuleType, CatalogNo for the
hardware.
• Assign a unique IPAddress.
• Set the ParentModule to the name of the Ethernet communications
adapter that the switch is connected to. If using the embedded
Ethernet port on a 5580 controller then leave this as Local. Note that this
may show a red ‘X’ next to the name even though the program will be
correctly generated and compile.
• Parent module port ID -
Parent Module Type Port ID
Local/Linear/DLR 2
5380 Dual-Port A1 3
5380 Dual-Port A2 4
5480 Dual-Port A1 4
5480 Dual-Port A2 5

Parameters - HMI Configuration:

• The HMI Configuration options are not used in the Plug-In Wizard and
can be ignored.

Linked Libraries:
• Click next or click on the Linked Libraries tab. Click the Auto Create
button to automatically create all of the required linked libraries.
You can manually create new linked libraries or point to existing linked libraries
if necessary. You may need to do this if you would like to use an older version of
library objects when multiple versions are installed in Application Code Manager.

Complete the Import:

• On the following screen you can select the desired Merge Actions.
Generally these can be left with the default actions.
• Add: used when AOIs don’t previously exist in application
• Overwrite: usually preferred. Used when AOIs previously exist but
may or may not be the same revision.
• Use Existing: used when AOIs previously exist in the application and
you do not wish to overwrite the existing items.
• Click next and you can now see any new logic and modules that will be
created.
• Click Finish to complete the import.

48 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

DLR Configuration

DLR configuration will vary slightly depending on whether DLR1, DLR_Lite.

Parameters - 00 General:
• Enter a name and description. Maximum name length can be 22
characters. Note that other parameters such as the RoutineName,
TagName, etc will auto-complete based on these fields.
• Assign the Task and Program.
• Enter the name of Ref_RingPointerNode parameter which is the name
for the module that appears in the controller organization tree that is
directly connected to the Device Level Ring (DLR).
• As per the Ref_RingPointerNode, Select Ref_PointerRing ID to ‘1’ for
devices other than Stratix. Stratix devices must use the actual Ring ID
associated with their participation in the application Ring.

Parameters - 01 Switch Cfg 00 to 10 Switch Cfg 09:

• Up to ten Stratix switches can be configured to connect to the Stratix
CIP VLAN path. For mixed and switch-only networks, the Stratix[0]
entry is mandatory, while the definitions for Stratix[1] through
Stratix[9] apply to each additional switch on the DLR
• Description - User defined description of a switch
• Device Type - Select the actual device type from drop down selection.
i.e. Switch platform 5200, 5400, 5700, 5800
• From Controller Port - You have to define the source port of the
controller from drop down selection.
f. L5570: 1-Backplane

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 49

 Using the Library

g. L5580: 1-Backplane, 2-Front Port

h. L5370: 2-Front Port
i. L5380: 2-A1/A2 DLR, 3-Front Port A1, 4-Front Port A2
j. L5480: 2-Port B1, 3-A1/A2 DLR, 4-Front Port A1, 5-Front port A2
• Via Backplane Slot - Choose the slot number for the 1756-EnxT®
module. If you’re using 5570 or 5580 controllers (Backplane) with ENxT
modules, this setting is necessary. Otherwise, set it to 0.
• To IP Address - IP Address of a DLR Node.
• Device Ring ID - The device Ring number used in this specific
application.
For Stratix switches that support one ring only, Ring ID =1
For Stratix switches that support more than one ring, Ring ID =1, 2 or 3

Parameters - HMI Configuration:

• The HMI Configuration options are not used in the Plug-In Wizard and
can be ignored.

Linked Libraries:
• Click next or click on the Linked Libraries tab. Click the Auto Create
button to automatically create all of the required linked libraries.
You can manually create new linked libraries or point to existing linked libraries
if necessary. You may need to do this if you would like to use an older version of
library objects when multiple versions are installed in Application Code Manager.

Complete the Import:

• On the following screen you can select the desired Merge Actions.
Generally these can be left with the default actions.
• Add: used when AOIs don’t previously exist in application
• Overwrite: usually preferred. Used when AOIs previously exist but
may or may not be the same revision.
• Use Existing: used when AOIs previously exist in the application and
you do not wish to overwrite the existing items.
• Click next and you can now see any new logic and modules that will be
created.
• Click Finish to complete the import.

Import Rung Logic

An Add-On Instruction is defined once in each controller project, and can be

instantiated multiple times in your application code. To use pre-engineered
logic, import each desired RUNG.L5X file into a controller project. The process
is similar for both Stratix® switch and DLR objects.
1. In the Studio 5000 Logix Designer® application, open a new or
existing project.

IMPORTANT Add-On Instruction definitions can be imported, but not updated, online.
2. Choose or create a new ladder routine to open. Right-click in the
routine ladder and choose Import Rungs...

50 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

3. Select the desired RUNG and Select Import. The file will have a name
like raC_Dvc_Stratix_xx.yy_RUNG.L5X.

.
Both “RUNG” and “AOI” .L5X files are provided. Import the
RUNG file to get all required additional tags, data types, and
message configurations.

4. An Import Configuration dialogue window will open and display generic

Import names which include “_InstanceName”. Click the Find/Replace...
button and replace all instances of “_InstanceName” with your desired
device name (e.g. “Switch_Panel100”).

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 51

 Using the Library

5. Click on the Other Components section to set the ModuleName. Type or

browse to the name of the Stratix® Switch module. In this example our
module is called “Dvc_Switch_Panel100”. This step is not required for
DLR objects.

6. The rung will now be imported into your ladder routine.

7. For DLR objects the same steps from 1 to 6 required.

52 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Using Studio 5000 View Using Studio 5000 View Designer® Project Files
Designer®
Studio 5000 View Designer® may be used for HMI development for
PanelView™ 5000 applications. Open up your Studio 5000 View Designer®
project alongside a second application instance running the required VPD file
in the library folder HMI - ViewDesigner - vpd.
In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following videos for this section:
“How_To_Import_and_Configure_Stratix_Switch_Device_Objects_in_ViewDesign
er”
“How To Configure DLR Object Components in View Designer”

You will notice there are two screens available under the User-Defined Screens
folder:
• Screen_001: This has the graphic symbol launch buttons for the
faceplate.
• raC_Dvc_xxxxx_FP: This is a faceplate pop-up screen.

To include these files in your project, perform the following steps:

• Copy the entire faceplate _FP screen from the supplied VPD project to
your project application.
• Open the Screen_01 screen and copy the desired graphic symbol and
paste it into a screen in your project application.

Configuring View Designer Objects

For text based buttons, you can assign the text shown on the button by
highlighting the button. View the Properties tab and modify the General > Text
parameter as required.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 53

 Using the Library

To link the launch button to the faceplate, highlight the button and view the
Events tab of within the Properties pane. If not already configured, set an Event
to Open popup on release with the following settings:
• Key: Touch Only
• Popup: Select desired faceplate screen
• Stratix/AOI_Tag: Browse to AOI backing tag for the device object in
your controller file

Using FactoryTalk® View Import FactoryTalk® View Visualization Files

Studio
There are several components to import for the visualization files. You import
files from the downloaded Rockwell Automation® library files via FactoryTalk®
View ME or FactoryTalk® View SE. The workflow is the same for both
FactorTalk View ME and SE.
In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following videos for this section:
“How_To_Import_and_Configure_Stratix_Switch_Device_Objects_in_FTViewME”
“How_To_Import_and_Configure_Stratix_Switch_Device_Objects_in_FTViewSE”
“How To Import and Configure DLR Object Components in FTView ME”
“How To Import and Configure DLR Object Components in FTView SE”

54 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

All image and display items can be imported either by right-clicking in

FactoryTalk® View on the Graphic sub-folder (e.g. Displays, Global Objects,
Images) or simply dragging and dropping the files into the application.

Import files in this order:

1. Import HMI Images files.

Select all the images in the \HMI FactoryTalk® View Images - png folder
and Open.
2. Import Global Object files

Select the global object (.ggfx) files from the \HMI - FactoryTalk® View
ME\Global Objects - ggfx or \HMI - FactoryTalk® View SE\Global Objects -
ggfx folder
3. Import HMI Faceplates

Select the faceplate (.gfx) files from the \HMI - FactoryTalk® View ME\Displays -
gfx or \HMI - FactoryTalk® View SE\Displays - gfx folder

Configuring FactoryTalk® View Objects

Once the files have been imported into the FactoryTalk® View Studio project,
you can begin using them in your application. Open the Global Display (raC-12-
ME) Graphic Symbols - Network Device. Copy the desired launch button style and
paste it into a display in your application where you would like to open the
faceplate. For more information on graphic symbols, refer to the Graphic
Symbols section of the specific device type chapter in this manual.

To configure the graphic symbol launch button, right-click and select Global
Object Parameter Values. The Global Object Parameter value for the Backing Tag
(#102) is mandatory while the custom Navigation Button Label (#104) and
display position values (#120, #121) are optional. If you do not enter in a custom
Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 55
 Using the Library

text label it will by default show the AOI’s .@Description field. You can browse
for the tag in your controller project by clicking ‘...’ or manually type them in.
These parameters may vary depending on the graphic symbol used, please
refer to the Graphic Symbols section of the device type for detailed
information.

These Global Object Parameter Values are automatically configured when you
use Studio 5000® Application Code Manager to design and configure your
project. Refer to Using Studio 5000® Application Code Manager for more
information.

Using FactoryTalk® Optix Download the Library

For the latest compatible software information and to download the Rockwell
Automation® Library, see the Product Compatibility and Download Center.

Search “Network Device Library” or filter on Application Content to quickly

find the library.
In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following video for this section:
“How_To_Import_and_Configure_Device_Objects_in_FTOptix”

Register FactoryTalk Optix Library

1. Run the provided Setup.cmd script or extract the downloaded zip file to
the Windows user’s FactoryTalk Optix library directory, which by
default is C:\Users\<UserName>\Documents\Rockwell
Automation\FactoryTalk Optix\Libraries.
2. If you have FactoryTalk Optix Studio open on your computer, please
close the application and reopen to ensure the library will be visible.

56 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Import Library Objects in FactoryTalk Optix Project

1. Open the template library and ensure that before we start importing
library, the "preserve paths on library elements" option is turned on.

2. Drag and drop the “raC_12_xx_raC_Dvc_ObjectName_UI” object to the

UI folder of your project. Shown as (1) below.

Using Style Sheets

FactoryTalk Optix allows users to define custom style sheets or use ones
provided in the Factoryalk Optix Libraries. It is recommended to use the
provided “ISA Style Sheet” for a consistent look and feel across all FactoryTalk
Optix libraries and displays. All screenshots of faceplates in FactoryTalk Optix
contained in this manual use the ISA Style Sheet. Other style sheets may be
applied; however, this will cause faceplates to appear differently and usability
can be hindered in some cases for example where low-contrast colors or
different sizes are chosen.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 57

 Using the Library

Use the following steps to import and set the ISA Style Sheet which comes with
FactoryTalk Optix Studio in the StyleSheets library.
1. In FactoryTalk Optix Studio, drag and drop the “ISA Style Sheet”
component from StyleSheets library to a location in your project.

2. In the PresentationEngine used in the Optix project (e.g.

NativePresentationEngine), point the Style sheet property to the
ISAStylesheet just imported. Update the Style Sheet’s Font size and
other settings accordingly.

Custom Style sheet

You can now merge new style types from one stylesheet to another. Here’s how
to use this feature with the ISA Style Sheet:
a. If you prefer a custom style sheet over the ISA Style Sheet, start by
importing the ISA Style Sheet from the template library.

58 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

b. Right-click on your custom style sheet and select Import control

styles from > ISA Style Sheet.

Any styles in the ISA Style Sheet that are not in your custom style sheet will be
added. You can then modify these new styles to fit your needs.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 59

 Using the Library

Configuring FactoryTalk Optix Objects

Once the Objects have been imported into the FactoryTalk® Optix Studio
project, you can begin using them in your application. To add a new Launch
Button to a Main window, navigate to raC_Dvc_ObjectName > Graphic
Symbols > Dvc ObjectName Text Button to insert a navigation launch button
with a text label.

After placing the graphic symbol on a UI panel, link the “Ref_Tag” property to
the targeted Asset under Asset tag.

Text label shown on button can be configured using “cfg_Label” property, If it

is not configured then description of the asset will be shown on the button
face.

This is the only step needed to link the UI to the asset data model. For more
information on graphic symbols, refer to the Graphic Symbols section of the
respective device type in this manual.

Library Upgrades Add-On Instruction Upgrades

There are two methods to upgrading existing device object add-on

instructions in a project. You can do this either by using the Studio 5000® Plug-
In Import Library Objects Wizard or by importing individual add-on instruction
AOI.L5X files. Both methods are described in the following sections.

Note that all updates to Add-On Instructions must be done with Studio 5000
Logix Designer® in OFFLINE mode and a download to the controller is
required.

60 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Upgrades Using Studio 5000® Plug-In to Import Library Objects

If Studio 5000® Application Code Manager is installed, you can use the Studio
5000® Plug-In Import Library Objects Wizard to update existing Add-On
Instructions. For complete information on Studio 5000® Application Code
Manager, refer to the section Using Application Code Manager.

Right-click in your controller organizer or within a routine to access Plug-Ins >

Import Library Objects...

The Library Object Import Wizard dialogue window will open. Under Registered
Libraries expend (RA-LIB) Device > Asset-Control and find the desired object and
version. Drag the object into the Object Configuration window on the right.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 61

 Using the Library

In the Merge Actions window, select the Action for the AddOnIntructionDefinition
to Overwrite. This will update any existing instance of the object to the newer
version. You may also choose to overwrite any other DataTypes or Tags. Review
the release notes of the latest library release to understand what may be
impacted. Click next and finish to complete the process.

62 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Upgrades by Importing AOI.L5X Files

To upgrade or migrate a project that uses a previous library version to a newer

one, the add-on instruction L5X files are supplied. To perform an upgrade to
an object perform the following steps:
• Open the controller file. Note changes must be done offline.
• In the Controller Organizer pane right-click on Assets > Add-On Instructions
and select Import Add-On Instruction. Navigate to the AOI.L5X file in the
Studio 5000 Logix Designer Files - L5X and Open.

• You will be prompted that there is an existing version of the instruction

that is different. Choose Overwrite as the operation.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 63

 Using the Library

• If the Red flag exist in the References. e.g.

a. In Data Type: Wherever it shows Differences, we must select
Overwrite operation.

64 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

b. Add-On Instructions: For all Add-On Instruction select Overwrite

option.

• Select OK once you have read and understood the warnings. Your
existing logic will be updated with the new add-on instruction. Verify
that your code compiles and test adequately.
• After compilation if there is an error with the "Ref_Ctrl_Sts" parameter,
it is necessary to manually modify the Data type of each instance of the
"Ref_Ctrl_Sts" parameter to the new data type
"raC_UDT_ItfAD_Stratix_Sts."

• In order to ensure the HMI faceplate still works properly you will need
to update the object’s library information stored in the Inf_Lib tag. In
the Controller Organizer pane under Assets > Add-On Instructions expend
the device object that was updated. Double-click on Parameters and Local
Tags to open up the instructions tags.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 65

 Using the Library

• In the Add-On Instruction Parameters and Local Tags window, you may
notice that the Inf_Lib tag in the add-on instruction definition matches
the new library revision number. Click on the down-arrow to the right
of the copy button and select Copy Specified Values...

• In the Copy Default Values window, be sure to first uncheck all

Parameters and Local Tags by clicking the +/- box in the top right.
Failure to do so may result in overwriting settings in the existing
objects.
• Check Inf_Lib and Wrk_Type44 in the Local Tag area. On the right, all
affected objects should be selected. Click OK.

66 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

• You can now confirm that the Inf_Lib tag has been updated to the
current library (e.g. ‘raC-12_02’) by changing the Data Context drop-
down to a specific device object.

DLR Add-on Instruction Upgrade

When upgrading to version 12.04 or later, please follow these instructions to
update your DLR objects. This upgrade is applicable if you are transitioning
from earlier versions.

Changes in DLR Objects

In earlier releases, there were three DLR objectst:

1. raC_Opr_NetDLR1
2. raC_Opr_NetDLR_Lite
3. raC_Opr_NetDLR3

From this release onward, we are using only two DLR objects with a new
structured AOI (Add-On Instruction) parameters and UDTs (User-Defined
Types). The `raC_Opr_NetDLR3` object has been retired. The remaining
objects are:
1. raC_Opr_NetDLR1
2. raC_Opr_NetDLRLite

Upgrading DLR Lite Object

To upgrade the `DLR Lite` object

1. Delete the existing instances of `raC_Opr_NetDLR_Lite` AOI
2. Delete `raC_Opr_NetDLR_Lite` AOI
3. Follow Using the Library section and import new
`raC_Opr_NetDLRLite` objects as per requirement.
4. Create the new instances of raC_Opr_NetDLRLite

Upgrading DLR1 Object

To upgrade the `DLR1` object

1. Delete the existing instances of `raC_Opr_NetDLR1` AOI
2. Delete the `raC_Opr_NetDLR1` AOI
3. Follow Using the Library section and import new `raC_Opr_NetDLR1`
objects as per requirement.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 67

 Using the Library

Upgrading Three DLR Objects

To upgrade from using all three DLR objects:

1. Remove the existing instances of `raC_Opr_NetDLR3` AOI
2. Delete the `raC_Opr_NetDLR3` old AOI
3. Follow Using the Library section and import new `raC_Opr_NetDLR1`
objects as per requirement.
4. Here note that each ring application requires one instance of
`raC_Opr_NetDLR1`.

By following these steps, you can ensure a smooth transition to the new
version of the DLR Add-on Instruction.

For more details about creating the New Instances of DLR object please refer the
section Device Level Ring

FactoryTalk® View Upgrades

To upgrade a device object in a FactoryTalk® View ME/SE application, simply
import the new faceplate .gfx display file into the application. If any global
objects or images have been added or modified, you may need to import these
as well. Any unused displays from previous versions may be removed or
deleted from the application.

Note that the reference to the faceplate version is set in the Add-On
Instruction Local Tag Inf_Lib so there does not need to be other modifications
to the HMI application.

Studio 5000 View Designer® Upgrades

To upgrade a device object in a Studio 5000 View Designer® application,
simply import the open the new View Designer .vpd file and copy the
raC_Dvc_xxxxx_FP pop-up screen into the existing application. Find any
graphic symbol launch buttons in the application that open the faceplate, and
update the Action to open the new pop-up screen. Any unused pop-up screens
from previous versions may be removed or deleted from the application.

FTOptix Upgrade Process (v1.4 to v1.5 or Higher)

There are two methods to upgrade the FTOptix project either running Find &
Replace to update the extended tag properties references, or instead import
the latest version of the library compatible with v1.5

Method 1: FTOptix Project upgrade using Find & Replace to Update Extended Tag
Properties
1. Open Your Project:
a. Launch FTOptix Studio v1.5.

68 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

b. Click on “Open” and browse for your existing project file (either
.optix or .optix.z).
c. Select the file and click “Open”.
2. Upgrade Prompt:
a. An upgrade popup will appear.

b. Click “Upgrade” to automatically convert your project to v1.5.

3. Search and Replace:
a. Once the project is upgraded, go to the top menu and click “Search in
Project”.
b. This will open the “Find or Replace in Project” window.

4. Replace Extended Tag Properties:

a. Click on the “Replace” tab.
b. In the “Find what” field, enter: /Ref_Tag@Description.
c. In the “Replace with” field, enter: /Ref_Tag/Description.
5. Set Search Parameters:
a. Look for: Anything.
b. Folder: Project root folder.
c. Scope: Entire Project.
d. Keep other options at their default settings.
6. Execute Replace:
a. Click “Replace” and then “Proceed”.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 69

 Using the Library

b. Review the replace results to ensure all changes are correct.

7. Completion:
a. This completes the upgrade process, and your project is now ready to
use with the updated version.

Method 2: FactoryTalk® Optix Library Upgrades importing the Latest Library Version

To upgrade a library object in a FactoryTalk® Optix application, simply import

the new version of the library objects into the application from the template
library. In the event that library objects or sub-components (such as used
Types) are imported with the same name, choose “Replace All” during the
import process to ensure you are using the most current versions of all types.

In the event that library objects are updated with a new version number, for
example a graphic symbol launch button is updated from
raC_12_04_raC_Dvc_ObjectName_GS to
raC_12_05_raC_Dvc_ObjectName_GS, then existing instances of the graphic
symbol will not be updated by default. Both versions of the object can exist
simultaneously in the same application.

To update an object to a new version, you can use the refactor function. In
order to use the refactor function, you must be running FactoryTalk Optix
Studio in “Advanced Mode”. This can be enabled in FactoryTalk Optix Stuio
Options and requires an application restart to take effect.

With Advanced Mode enabled, you can right-click on an object and select
Refactor > Change Type. Select the new version of the desired type. Note that
this function cannot be undone and should be handled with caution. This
process is shown in the following screenshot.

ATTENTION: Refactoring types is irreversible can in some cases can lead to unex-
pected results. Ensure you create a back-up of your project prior to performing
refactoring.

70 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using the Library

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 71

 Using the Library

72 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 4

Using Application Code Manager

Overview of Application Studio 5000® Application Code Manager is a tool that enables more efficient
project development with libraries of reusable code. Application Code
Code Manager Manager creates modular objects with customizable configuration parameters
using the reusable content. Application Code Manager can also create the
associated visualization, historical and alarming elements for a project.

Studio 5000® Application Code Manager can be easily used along with
Rockwell Automation® application code libraries such as the PlantPAx®
Process Objects Library, Machine Builder Library, and Device Object Libraries.
For more information on Studio 5000® Application Code Manager, refer to the
Application Code Manager User Manual.

Creating a New Project Begin by opening Application Code Manager.

Note: the last project (if any) is opened by default; otherwise a blank screen is
displayed.

Create a New Project or open an existing project. Navigate to File > New >
Project.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using Application Code Manager

Select the desired project type (e.g. (RA-LIB) ACM 2.00 Project - Basic_Project)
and fill in the Name and Description.

To add a new controller to a project, in the Controller Preview window, right-

click on Controllers and select Add New...

Select the desired controller type (e.g. ControlLogix®_Controller,

GuardLogix_Controller, CompactLogix_Controller, etc). Enter a Name and
Description for the controller. Select the appropriate Chassis and Processor
configurations.

You can also configure the HMI AreaPath and.or AreaPathME parameters which
will be referenced if you use Application Code Manager to generate
FactoryTalk® View ME/SE displays with graphic symbol launch buttons.

74 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using Application Code Manager

You can now add in any desired tasks and programs to your controller. Right-
Click on the Tasks folder underneath your controller in the Controller Preview
and Add New Task. Similarly, right-click on any Task and select Add New
Program. Complete the desired parameters for Tasks and Programs such as
name, type, period, etc.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 75

 Using Application Code Manager

Adding & Configuring Prior to adding in any Device Objects, ensure you have registered the library in
Application Code Manager. Refer to Register Libraries in Studio 5000®
Device Objects Application Code Manager for details.

Adding Stratix Device Instructions

To add a Device Object into a project, right-click on a Program and Add New...

• In the Object Configuration Wizard dialogue window you can click on the
Category heading to group objects by category and find Network. Select
the desired Network object with Library Type Device (e.g.
raC_LD_Dvc_Stratix) and click Next.

• Fill in all of the required configuration parameters for the device object.
The following example shows a configuration of the
raC_LD_Dvc_Stratix object.

Perform the following configuration:

76 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using Application Code Manager

Parameters - 00 General:
• Enter a name and description. Maximum name length can be 22
characters. Note that other parameters such as the RoutineName,
TagName, etc will auto-complete based on these fields.
• Assign the Task and Program.

Parameters - 01 Module:
• You can choose to automatically create the Stratix® switch module in
your program if not already included by setting IncludeHW to True.
• Assign the desired ModuleName, ModuleType, CatalogNo for the
hardware.
• Assign a unique IPAddress.
• Set the ParentModule to the name of the Ethernet communications
adapter that the switch is connected to. If using the embedded
Ethernet port on a 5580 controller then leave this as Local. Note that this
may show a red ‘X’ next to the name even though the program will be
correctly generated and compile.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 77

 Using Application Code Manager

• Set Parent Module port ID

Parent Module Type Port ID
Local/Linear/DLR 2
5380 Dual-Port A1 3
5380 Dual-Port A2 4
5480 Dual-Port A1 4
5480 Dual-Port A2 5

Parameters - HMI Configuration:

• Navigation Button: Choose Icon or Text type navigation button.
• For HMI Configuration refer to Configuring Displays.

Linked Libraries:
• Click next or click on the Linked Libraries tab. Click the Auto Create
button to automatically create all of the required linked libraries.
You can manually create new linked libraries or point to existing linked libraries
if necessary. You may need to do this if you would like to use an older version of
library objects when multiple versions are installed in Application Code Manager.

• Click Finish to complete the object configuration.

For specific devices details, refer to the appropriate chapter in this manual.

78 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using Application Code Manager

Adding DLR Device Object

To add a DLR Object into a project, right-click on a Program and Add New...

In the Object Configuration Wizard dialogue window you can click on the
Category heading to group objects by category and find Network. Select the
desired DLR object of type Device (e.g. raC_LD_Opr_NetDLR1,
raC_LD_Opr_NetDLR_Lite) and click Next.

• Fill in all of the required configuration parameters for the device object.
The following example shows a configuration of the
raC_LD_Opr_NetDLR1 object.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 79

 Using Application Code Manager

Perform the following configuration:

Parameters - 00 General:
• Enter a name and description. Maximum name length can be 22
characters. Note that other parameters such as the RoutineName,
TagName, etc will auto-complete based on these fields.
• Assign the Task and Program.
• Enter the name of Ref_RingPointerNode parameter which is the name
for the module that appears in the controller organization tree that is
directly connected to the Device Level Ring (DLR).
• As per the Ref_RingPointerNode, Select Ref_PointerRing ID to ‘1’ for
devices other than Stratix. Stratix devices must use the actual Ring ID
associated with their participation in the application Ring.

Parameters - 01 Switch Cfg 00 to 10 Switch Cfg 09:

• Up to ten Stratix switches can be configured to connect to the Stratix
CIP VLAN path. For mixed and switch-only networks, the Stratix[0]
entry is mandatory, while the definitions for Stratix[1] through
Stratix[9] apply to each additional switch on the DLR.

80 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Using Application Code Manager

• Description - User defined description of a switch

• Device Type - Select the actual device type from drop down selection.
i.e. Switch platform 5200, 5400, 5700, 5800
• From Controller Port - You have to define the source port of the
controller from drop down selection.
b. L5570: 1-Backplane
c. L5580: 1-Backplane, 2-Front Port
d. L5370: 2-Front Port
e. L5380: 2-A1/A2 DLR, 3-Front Port A1, 4-Front Port A2
f. L5480: 2-Port B1, 3-A1/A2 DLR, 4-Front Port A1, 5-Front port A2
• Via Backplane Slot - Choose the slot number for the 1756-EnxT®
module. If you’re using 5570 or 5580 controllers (Backplane) with ENxT
modules, this setting is necessary. Otherwise, set it to 0.
• To IP Address - IP Address of a DLR Node.
• Device Ring ID - The device Ring number used in this specific
application.
For Stratix switches that support one ring only, Ring ID =1
For Stratix switches that support more than one ring, Ring ID =1, 2 or 3
• For more details refer Ref Switch Path
• Parameters - HMI Configuration:
• The HMI Configuration options are not used in the Plug-In Wizard and
can be ignored.
You can manually create new linked libraries or point to existing linked libraries
if necessary. You may need to do this if you would like to use an older version of
library objects when multiple versions are installed in Application Code Manager.

• Click Finish to complete the object configuration.

For specific devices details, refer to the appropriate chapter in this manual.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 81

 Using Application Code Manager

82 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

Configuring Displays Application Code Manager can be used to automatically configure graphic
symbol launch buttons for device objects In FactoryTalk® View ME or SE. Note
that Application Code Manager is not compatible with Studio 5000 View
Designer® applications.

First you must add Displays to your project. Under the System View panel
expand HMI and right-click on Displays to select Add. Choose the type of
display (e.g. FTViewME or FTViewSE depending on your project requirements.

In the display object parameter configuration, you must select the

DisplayTemplate type to match the version of FactoryTalk® View application
that you are using.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 83

 Navigate to the Displays tab where you can right-click and Add New display.

Set the desired name and display parameters. Generally all display parameters
aside from Name can be left as default since this will often be used as a
temporary display where object launch buttons are copied from.

Return to your device object configuration and view the HMI Configuration
section of the parameters. You can browse or type in the
HMI_Server_Name.HMI_Display_Name.

84 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 If you browse for the display, select the desired display server in the left panel,
then click on the Display tab in the right panel and select the specific display.
Click finish.

This workflow can be followed for either FactoryTalk® View ME or SE

depending on the project requirements.

Generating Displays Once you have assigned displays to all of the device objects, you can generate
the displays. In the System View highlight the desired display server under HMI
> Display and right-click to select Generate Displays > All Displays or select
individual displays. Choose a place to save the generated files and take note of
it.

Importing Displays into To import the configured displays, open your FactoryTalk® View ME/SE
project in FactoryTalk® View Studio. Right-click on Graphic > Displays and
FactoryTalk® View Studio select Import and Export...

Follow the required prompts:

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 85
 • Import graphic information into displays
• Choose whether or not to backup displays
• Choose either a Single display import file (must have an existing or blank
display to import into) or Multiple displays batch import file if All Displays
was used to Generate Displays.
• If this is the first time it is recommended to import Multiple displays
batch import file and then Create new objects on the display.
• If you have done this before and are updating the imported display
after modifying your Application Code Manager project, you can
choose Update existing objects on the display.
• Browse for the BatchImport.xml file or individual display.xml file.

Open up the newly imported display. Notice that there are graphic symbol
launch buttons labeled and configured for each item that was configured in
Application Code Manager.

Right-click on the object and select Global Object Parameters to view that all of
the parameters have been pre-configured for you.

You may not copy and paste this graphic symbol onto any other display in your
application.

Generating Controller Files Once you have completed configuring your project in Studio 5000®
Application Code Manager, you can generate the controller file for use in
Studio 5000 Logix Designer®.

In the Controller Preview pane right-click on the controller name within the
Controllers folder and select Generate Controller.

86 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 In the Logix Code Generation dialogue window you will need to check Create
ACD. You ma also need to check Overwrite Existing if this is not the first time
generating the controller code.

Once the controller file is generated, you can navigate to the location set in
Save Path and open your file. Note that all of the configuration that was done in
Application Code Manager is now shown in your Logix Designer ACD file.

Exporting Attachments Application Code Libraries not only contain Logix code, but also contain
Visualization collateral and associated documentation. Every Asset library
contains at least a reference manual (RM). Those libraries which have
associated Visualization content also have all required global objects (GO),
images, static displays and View Designer applications added as attachments.
In this manner the user can generate only the necessary visualization and
documentation for the objects included in the project.

In Application Code Manager, all of the attachments are associated with the
device objects in the (RA-LIB) Device > Asset-Control folder. These can be
accessed both through the full Application Code Manager software, or via the
Studio 5000® Plug-In “Import Library Objects”.

To access the attached files, right click on the objects (e.g. raC_Dvc_Stratix)
and select Extract Attached Files.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 87

 Select the destination folder on your computer, and select OK. An Extract
Attachments dialog will show the extraction status.

The extracted folder will contain the following:

• Reference Manual
• Required Images
• View Designer Faceplate Files
• FactoryTalk® View Machine Edition Display
• FactoryTalk® View Machine Edition Global Objects

88 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 5

Using the Network Device Library with Other

Application Code Libraries

Application Code Libraries The Network Device Library is can be used alongside other Application Code
Libraries.

The Machine Builder Library and PlantPAx® Process Object Library

application-level library objects may be used in the same applications with the
device-level objects in the Network Device Library. At this time there are no
direct dependencies or interaction points between these libraries. They may be
used independently from one another but within the same application.

Other libraries utilize the common device interface UDTs to interact with
device level objects. In the case of the Network Device Library you may
programmatically reference the Status (Sts) interfaces of the Stratix
instructions. This is covered in detail in Interfaces section of this document.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 89

 Using the Network Device Library with Other Application Code Libraries

90 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6

Stratix® Switch (raC_Dvc_Stratix)

Overview The Stratix® Switch device object (raC_Dvc_Stratix) includes HMI faceplates
for each managed Stratix® switch (2500, 5200, 5400, 5410, 5700, 5800) and
ArmorStratix™ 5700 switch which displays device information including:
• Port status and diagnostics
• Switch status and diagnostics
• Switch configuration, settings, and port layout
• Fault and alarm status
In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following videos for this section:
“Operational_Overview_Stratix_Managed_Switch_ Faceplates_in_MachineEdition”
“Operational_Overview_Stratix_Managed_Switch_ Faceplates_in_SiteEdition”
“Operational_Overview_Stratix_Managed_Switch_Faceplates_in_ViewDesigner”

Functional Description The Stratix® Switch pre-configured Device Objects:

• Collect, Process and Deliver Data between managed switches and
Application Logic
• Provide Device Status & Diagnostics Faceplates for Machine Startup,
Commissioning, Operations, and Maintenance
• Include Common HMI Faceplate Components, Device States, and
Control Interfaces providing Application Development and Operation
Efficiency

All these features provide quick feedback, shorten recovery time, and simplify
implementation.

Required Files Device Objects include Add-On Instructions (AOIs) and HMI faceplates. The
revision number (e.g. 1.01) used in filenames can change as new revisions are
created.

Controller Files

Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix®® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 91

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

The Add-On Instruction must be imported into the controller project to be

used in the controller configuration. These can be imported as Add-On
Instruction files, or as part of the Rung Import or Import Library Objects
wizard.

All Add-On Instruction and Rung Import files can be found in the /Studio 5000
Logix Designer Files - L5X/ folder in the library.

Compatible
Device Add-On Instruction Rung Import
Device
Stratix® 2500
Stratix® 5200
Stratix® 5400
Stratix® Switch Stratix® 5410 raC_Dvc_Stratix_12.04_AOI.L5X raC_Dvc_Stratix_12.04_RUNG.L5X
Stratix® 5700
ArmorStratix™ 5700
Stratix® 5800

FactoryTalk® View HMI Files

FactoryTalk® View ME applications require importing the desired device
faceplates in addition to all Global Object (ggfx) files and all images located in
the /HMI FactoryTalk® View Images - png/ folder of the library. FactoryTalk®
View ME files are stored in the /HMI - FactoryTalk® View ME/ library folder.

Note that a single Add-On Instruction raC_Dvc_Stratix® is common with any of

the Stratix® models. The HMI faceplate will automatically display the correct
layout for the device type.

FactoryTalk® View ME FactoryTalk® View SE

Device/Item Type Compatible Device Faceplate Faceplate
Stratix® 2500 (raC-12_04-ME) raC_Dvc_S2500-Faceplate.gfx (raC-12_04-SE) raC_Dvc_S2500-Faceplate.gfx
Stratix® 5200 (raC-12_04-ME) raC_Dvc_S5200-Faceplate.gfx (raC-12_04-SE) raC_Dvc_S5200-Faceplate.gfx
Stratix® 5400 (raC-12_04-ME) raC_Dvc_S5400-Faceplate.gfx (raC-12_04-SE) raC_Dvc_S5400-Faceplate.gfx
Stratix® Switch Display Stratix® 5410 (raC-12_04-ME) raC_Dvc_S5410-Faceplate.gfx (raC-12_04-SE) raC_Dvc_S5410-Faceplate.gfx
Stratix® 5700 (raC-12_04-ME) raC_Dvc_S5700-Faceplate.gfx (raC-12_04-SE) raC_Dvc_S5700-Faceplate.gfx
ArmorStratix™ 5700
Stratix® 5800 (raC-12_04-ME) raC_Dvc_S5800-Faceplate.gfx (raC-12_04-SE) raC_Dvc_S5800-Faceplate.gfx
Graphic Symbols Global Object All Stratix (raC-12-ME) Graphic Symbols - Network Device (raC-12-SE) Graphic Symbols - Network Device
Toolbox Global Object All Stratix (raC-12-ME) Toolbox -Network Device.ggfx (raC-12-SE) Toolbox -Network Device.ggfx

Studio 5000 View Designer® HMI Files

All Studio 5000 View Designer® Files can be found in the /HMI - ViewDesigner -
vpd/ folder of the library.
Device/Item Studio 5000 View Designer® Faceplate
All Stratix® Switch (raC-12_04-VD) raC_Dvc_Stratix.vpd

92 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

FactoryTalk® Optix Library Files

FactoryTalk® View Optix applications require importing the desired library
objects located in the NetworkDevice_v12R library folder.

Device/Item FactoryTalk® Optix Library Object

S2500 raC_12_04_raC_Dvc_S2500_UI
S5700 raC_12_04_raC_Dvc_S5700_UI
S5400 raC_12_04_raC_Dvc_S5400_UI
S5410 raC_12_04_raC_Dvc_S5410_UI
S5200 raC_12_04_raC_Dvc_S5200_UI
S5800 raC_12_04_raC_Dvc_S5800_UI

Studio 5000® Application Code Manager Files

Studio 5000® Application Code Manager (ACM) can be optionally used if it is
installed. All devices can be easily registered in the ACM repositories by
running the setup.cmd file located in the root folder of the library.

Individual HSL4 files are provided as an alternative to running the setup.cmd

to allow users to manually register specific implementation objects. Each
object has two files - an Asset Control file and a Device file. The Asset Control
files include attachments of all required files for that object. The Device files
are used to actually add that device into a Studio 5000® project and these
reference the Asset Control files.

All Studio 5000® Application Code Manager files can be found in the /
ApplicationCodeManagerLibraries/ folder of the library. The files included are as
follows:

Implementatio Compatible Device Asset Control File (.HSL4)

n Object Device File (.HSL4)
Stratix® 2500
Stratix® 5200
Stratix® 5400
Stratix® Switch Stratix® 5410 (RA-LIB)_Device_Asset-Control_Network_raC_Dvc_Stratix_(12.4) (RA-LIB)_Device_Device_Network_raC_LD_Dvc_Stratix_(12.4)
Stratix® 5700
ArmorStratix™ 5700
Stratix® 5800

Operations The Network Device objects provide only physical operation mode. There is no
virtual device mode offered.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 93

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Execution
The following table explains the handling of instruction execution conditions.

Condition Description
Processing for EnableIn False (false rung) is handled the same as if the device
EnableIn False (false rung) were taken out of service by Command. The device outputs are de-energized and
the device is shown as Program Out of Service on the HMI. All alarms are cleared.
On prescan, any commands that are received before first scan are discarded. The
device is de-energized. On first scan, the device is treated as if it were returning
from Hand command source: the instruction state is set based on the position
Powerup (prescan, first feedback that is received from the device. If the feedback is valid for one position,
scan) the device is set to that position. If the device does not have position feedback or
the position feedback is invalid, the device is set to the ‘unknown/powerup’ state.
The command source is set to its default, either Operator or Program (unlocked).
Postscan No SFC Postscan logic is provided.

94 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Add-On Instruction I/O Data InOut Data

InOut Function / Description DataType

Ref_Module Reference to module in I/O tree MODULE

Ref_Ctrl_Sts Network Device Status Interface raC_UDT_ItfAD_ItfAD_Stratix_Sts

Inf_Lookup Code / Description List Entry raC_UDT_LookupMember_STR0082[32]

Message used to read complete CIP

Ref_GetAllMessage MESSAGE
objects.

Message used to read vendor specific

Ref_GetSingleMessage MESSAGE
attributes.

Ref_Storage Stores CIP message data SINT[300]

Input Data
Input Function/Description DataType
EnableIn Enable Input - System Defined Parameter BOOL

Inp_Enable Enable AOI functions. 1 = enabled. BOOL

Cmd_ResetFault 1 = Reset the Fault BOOL

Output Data
Output Function/Descritpion DataType

EnableOut Enable Output - System Defined Parameter BOOL

Sts_EN AOI Enabled Status; 1 = enabled. BOOL

Sts_ER Message error bit; 1= Error BOOL

Device is connected to the Programmable

Sts_Connected BOOL
Controller
Device is available for interaction with user
Sts_Available BOOL
code
Device warning status: 1 = an active alarm or BOOL
Sts_Warning warning exists
Device faulted status: 1 = an active fault
Sts_Faulted BOOL
exists
Bitwise device 'not ready' reason
0: Reserved
1: Device not connected
Sts_bNotReady DINT
2: Device not available
3: Device Faulted
4 - 31: Reserved
raC_Dvc_StratixAll Unique Parameter Name for auto-discovery BOOL

HMI_Ref Alias tag for HMI_Parameters.HMI_Pointer DINT

Data Types A number of User-Defined Datatypes (UDT) are used in the Network Device

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 95

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Library. A full list of the UDTs used with the raC_Dvc_StratixAll object follows:

User Defined Datatype Description

raC_UDT_Event Event log
raC_UDT_ItfAD_Stratix_Sts Stratix® Device Status Interface
raC_UDT_LookupMember_STR0082 Warning/Fault Code Look-up table member
raC_UDT_StratixEthernetLink Stratix® Ethernet Link Details
raC_UDT_StratixEthernetLinkClass Stratix® Ethernet Link Class Details
raC_UDT_StratixEthernetPort Stratix® Ethernet Port Details
raC_UDT_StratixHMI Stratix® HMI Faceplate Information
raC_UDT_StratixInfo Stratix® Module Information
raC_UDT_StratixInputData Stratix® Module Input Data
raC_UDT_StratixLocalData Stratix® Module Local Data
raC_UDT_StratixPortIndicator Stratix® Port Indicator Status
raC_UDT_StratixPortSelector Stratix® Port Selector Drop-down Menu
raC_UDT_StratixSwitchParameters Stratix® Module Parameters
raC_UDT_StratixTab0_Home Stratix® HMI Faceplate - Home Tab Information
raC_UDT_StratixTab1_Switch Stratix® HMI Faceplate - Switch Tab Information
raC_UDT_StratixTab1_Switch_Config Stratix® HMI Faceplate - Switch Tab - Configuration Information
raC_UDT_StratixTab1_Switch_General Stratix® HMI Faceplate - Switch Tab - General Information
raC_UDT_StratixTab1_Switch_PTPGM Stratix® HMI Faceplate - Switch Tab - PTPGM Information
raC_UDT_StratixTab1_Switch_PTPLOC Stratix® HMI Faceplate - Switch Tab - PTPLOC Information
raC_UDT_StratixTab1_Switch_VLAN Stratix® HMI Faceplate - Switch Tab - VLAN Information
raC_UDT_StratixTab2_Port Stratix® HMI Faceplate - Port Tab Information
raC_UDT_StratixTab2_Port_Media Stratix® HMI Faceplate - Port Tab - Media Information
raC_UDT_StratixTab2_Port_PTP Stratix® HMI Faceplate - Port Tab - PTP Information
raC_UDT_StratixTab2_Port_Stats Stratix® HMI Faceplate - Port Tab - Stats Information
raC_UDT_StratixTab2_Port_Status Stratix® HMI Faceplate - Port Tab - Status Information
raC_UDT_StratixTab2_Port_Threshold Stratix® HMI Faceplate - Port Tab - Threshold Information
raC_UDT_StratixTab3_Alarm Stratix® HMI Faceplate - Alarm Tab Information
raC_UDT_StratixTab3_AlarmGlobal Stratix® HMI Faceplate - Alarm Tab - Global Information
raC_UDT_StratixTab3_AlarmPort Stratix® HMI Faceplate - Alarm Tab - Port - Information
raC_UDT_StratixTCPIPInterface Stratix® TCP/IP Interface Information
STR0016 String
STR0032 String
STR0064 String
STR0128 String

The primary UDTs which a user may interact with are defined in more detail
below.

raC_UDT_ItfAD_Stratix_Sts
This is the Stratix® Common Control interfacing Status tag. By configuring
these tags, we can read various status from the device like Ready, Connected,
and Available etc. The below table shows detailed information of members
used in this UDT tags.

Refer to the Interfaces section for general information on interfaces.

96 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Input Description Data Type

Enumerated state value:
0 = Unused
1 = Initializing
2 = Disconnected
eState 3 = Disconnecting DINT
4 = Connecting
5 = Idle
6 = Configuring
7 = Available
FirstWarning First Warning Event Data raC_UDT_Event
FirstFault First Fault Event Data raC_UDT_Event
Enumerated command failure code.
0 = Interface Initialization failure code
eCmdFail DINT
1 = Operate as Physical Device failure code
2 = Operate as Virtual Device failure code
bSts Status (Bit Overlay) DINT
Connected 1 = PAC to device connection has been established BOOL
Available 1 = The device is available for interaction with the user program BOOL
Warning 1 = A warning is active on the device BOOL
Faulted 1 = A fault is active on the device BOOL

raC_UDT_Event

Member Description Data Type

Event type:
1 = Status
Type 2 = Warning DINT
3 = Fault
4...n = User
ID User definable event ID. DINT
User definable category
Category DINT
(Electrical,Mechanical,Materials,Utility,etc.).
Action User definable event action code. DINT
Value User definable event value or fault code. DINT
Message Event message text. STRING
EventTime_L Timestamp (Date/Time format). LINT
EventTime_D Timestamp (Y,M,D,h,m,s,us). DINT[7]

raC_UDT_LookupMember_STR0082

Member Description Data Type

Code Stores the value of device fault code DINT
Desc Stores the Messages related to fault code STRING

Add-On Instructions A number of embedded Add-On Instructions (AOI) are used within the
raC_Dvc_StratixAll instruction. These are used to convert between datatypes
and generate values which can be read from the HMI faceplate. The following
AOIs are included:
Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 97
Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

User Defined Datatype Revision Description

Converts decimal number to hexadecimal
raC_Tec_DecToHex 12.02 String
Converts numerical IP address into user-
raC_Tec_IPtoString_NET 12.02 readable string
Dynamically generates Stratix® Switch Port
raC_Tec_PortName_NET 12.02 Name
Converts Unsigned DINT into two tags to
raC_Tec_UDINT_Display 12.02 display correctly on HMI

98 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Programming Example Fully configured device on a rung is provided below for reference.

Note that this programming example is the same code that is imported when
either importing the supplied rung .L5X files or when using Application Code
Manager or the Studio 5000® Import Library Objects wizard plug-in.

The following example uses the Stratix® Switch device object named Dvc_S5700
connected to Stratix® module named Mod_Dvc_S5700.

Graphic Symbols Graphic Symbols are used as launch buttons within HMI applications to open
up faceplate displays. See Basic Launch Button Attributes section for details on
configuration and indicators.

FactoryTalk® View ME/SE Graphic Symbols

Graphic Symbol Name Graphic Symbol Description Global Object Parameter Values
#102: AOI Backing Tag Instance (e.g.
Faceplate navigation button with string tag label. {::[PAC]Program::IOLinkProgram._InstanceName
This launch button graphic object allows the
GO_LaunchFP user to navigate to the device object faceplate. })#104: Navigation Button Label
The text on the button face is set to the #120: Display’s left position (e.g. 100) (optional)
parameter #104. #121: Display’s top position (e.g. 100) (optional)

#102: AOI Backing Tag Instance (e.g.

Faceplate navigation button with string tag label. {::[PAC]Program::IOLinkProgram._InstanceName
This launch button graphic object allows the })
GO_LaunchFP user to navigate to the device object faceplate. #104: Navigation Button Label
The text on the button face is set to the #120: Display’s left position (e.g. 100) (optional)
parameter #104. #121: Display’s top position (e.g. 100) (optional)

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 99

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Studio 5000 View Designer® Graphic Symbols

Graphic
Symbol Graphic Symbol Description Property Configuration
Name

The supplied launch button in

View Designer is used to navigate
Launch to the faceplate in a user
application.

FactoryTalk® Optix Graphic Symbols

Graphic Symbols are used as launch buttons within HMI applications to open
up faceplate displays. All graphical symbols for Network Devices display the
following information:
• - Device label (Tag.@Description or custom label )
• - Device Warning/Fault Indication
• - AOI Enable/Disable
• - Device bad communication

See Basic Launch Button Attribute section for more general information on
launch button diagnostics and usage.

Once the Objects have been imported into the FactoryTalk® Optix Studio
project, you can begin using them in your application. To add a new Launch
Button to a Main window, navigate to raC_Dvc_ObjectName > Graphic
Symbols > Dvc ObjectName Text Button to insert a navigation launch button
with a text label. Similarly you can also add Dvc_ObjectName Graphical Button

100 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

After placing the graphic symbol on a UI panel, link the “Ref_Tag” property to
the targeted Asset under Asset tag.

Text label shown on button can be configured using “cfg_Label” property, If it

is not configured then description of the asset will be shown on the button
face.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 101

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

This is the only step needed to link the UI to the asset data model. For more
information on graphic symbols, refer to the Graphic Symbol section of the
Network device type in this manual.

Graphic Symbol Name Graphic Symbol Description Property Configuration

raC_12_xx_raC_Dvc_Devicename_GS_N Faceplate navigation button. Use Cfg_Label Variable to

avText modify the button label text. Cfg_CloseCurrentDisplay: Set to ‘True’
to close the previously open display
when launching the object faceplate

Cfg_DisplayType: Faceplate to be
opened on button click. This should
not be modified.

Ref_Tag: Object’s Add-On Instruction

Tag

Cfg_Label: Text label shown on the

raC_12_xx_raC_Dvc_Devicename_GS_N Faceplate navigation button with Icon. Use Cfg_Label button face
avGraphical Variable to modify the button label text.

Graphic Symbol Button Configuration Variables

Variable Name Description Default Value

Cfg_CloseCurrentDisplay Set to ‘True’ to close the previously open display when launching the object faceplate False
Cfg_DisplayType Faceplate to be opened on button click. This should not be modified. Faceplate
Ref_Tag Link to instance of desired target Asset model found in Model > Asset folder. N/A - User must configure
Text label shown on the button face. Defaults to the description of the asset but users may
Cfg_Label ../Ref_Tag@Description
replace in instances with other desired text.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 22.

In this document, the faceplate pictures (or snapshots) are of Stratix® 5700
Faceplate in Studio 5000 View Designer®. All other Stratix® faceplates have
similar screens, but some faceplates may not have all tabs and pages available
depending on the features and port layout supported by the specific model.

The faceplate title is linked to _InstanceName.@description, the .@description

extended tag property of the Add-On Instruction instance. This is user-
configurable from controller/program tags in Studio 5000 Logix Designer®.

102 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Home
The Home tab is the main tab of the faceplate. It provides the information of
the Network device along with Port status.

2 1

3
4

Item Description
1 Banner- Ready Status
Port Status Indicators

GREEN = Link Active

GREY with dark lines = Link Inactive

YELLOW =Port Alarm/Fault

GREY with light lines = Port Disabled

3 Host Name

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 103

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Item Description
4 IP Address
5 Switch Uptime
SD Card Status
6 ON/Blue LED = SD Card is present
OFF/Grey LED = SD Card is not present
Power supply A & B Status
7 ON/Blue LED = Power supply is connected
OFF/Grey LED = Power supply is not connected

Switch Tab
The Switch tab provides switch details on multiple pages. A drop-down
selector is used to navigate between pages of data including:
• General
• Configuration
• VLANs
• Time Sync

Each selection is described in the following sections

Switch Tab - General

2
3
4
5
6
7
8
9

Item Description
1 Switch Details Drop-Down Menu:
2 Model Number
3 Serial Number
4 Software Version
5 CIP Revision
6 Firmware Type: Full/Lite
7 PTP: Precision Type Protocol Supported/Not Supported
8 NAT: Network Address Translation Supported/Not Supported
9 DLR: Device Level Ring One Ring/Three Ring/Not Supported

104 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Switch Tab - Configuration

2
3
4
5
6
7
8

Item Description
1 Switch Details Drop-Down Menu
2 IP Address
3 Subnet Mask
4 Default Gateway
5 Name Server 1: Primary Domain Name System (DNS) Server
6 Name Server 2: Secondary Domain Name System (DNS) Server
7 Domain Name
8 Spanning Tree Mode

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 105

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Switch Tab - VLAN

3 4

Item Description
1 Switch Details Drop-Down Menu
A maximum of 16 VLANs will be displayed. If the number of VLANs configuration on the switch
2 exceeds 16 then the faceplate will display a message “There are more than 16 VLANs configured”.
3 VLAN Number. Note the switch is pre-configured with a default VLAN which has ID 1.
4 VLAN Name

Switch Tab - Time Sync

The Time Sync section displays current information about the real-time clocks
in the network. The data is only displayed if the CIP (Common Industrial
Protocol) Sync Time Synchronization feature is enabled and the time sync
information is available for Grandmaster & local Clock

106 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

2
3

4
5
6
7
8

Item Description
1 Switch Details Drop-Down Menu
2 Clock selector: Grandmaster/Local Clock
3 Time Sync: Enabled/Disabled
Identity: unique identifier for the grand master clock. The format depends on the network protocol.
4 Ethernet encodes the MAC address into the identifier while DeviceNet and ControlNet encode the
Vendor ID and serial number.
Class: measure of the quality of the grand master clock. Values are defined from 0 through 255 with
5 zero (0) as the best clock.
Accuracy: Indicates the expected absolute accuracy of the grand master clock relative to CIP Sync
6 Time Synchronization epoch (31 December, 1969 23:59:51.99918 UTC).
Variance: Displays the measure of inherent stability properties of the grandmaster clock. The value is
7 represented in offset scaled log units. The lower the variance, the better the clock
Source: Time source of the clock. Atomic Clock/GPS/Terrestrial Radio/PTP/NTP/HAND Set/Other/
8 Internal Oscillator
Priority 1 & 2: relative priority of the grandmaster clock to other clocks in the system. The value is
9 between 0 and 255. The highest priority is zero (0).

Port Tab
The Port Tab screens provide detailed information about selected Switch ports
to help troubleshoot connections for a specific port.

There are two ways to navigate to these screens: Click on the Port button on the
left, and then select the port from the drop-down on the right or Click on the
desired port icon on the Home Tab.

The drop-down selector in the top left offers the following options:
• Status
• Statistics

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 107

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

• Media Counter
• Thresholds
• Time Sync

Port - Status

1 9

2
3
4
5
6
7
8

Item Description
1 Port Details Drop-Down Menu
Link: Displays whether the link between the Switch Port and the attached device is Active or Inactive
2 or Disabled or Fault/Alarm
Speed/Duplex: Displays operating speed and duplex type of port. Available duplex types are:
3 - Full
- Half
Auto-Negotiation: Displays current state of Auto-negotiation process. Available Auto-negotiation
states are:
- In Progress
4 - Failed
- Duplex Fail
- Ok
- Forced
Smartport: Displays the Smartport role that will be applied to the connected port, these are preset
recommended configurations for the switch ports. These configurations, referred to as port roles,
optimize the switch connections and provide security, transmission quality, and reliability for traffic
from the switch Ports. The port roles also help prevent port mis-configurations.
The available values for each port are:
- Automation Device - Port is configured to be connected to a single EtherNet/IP (Ethernet Industrial
Protocol) device. This role can be used to manage industrial automation devices, such as logic
controllers and I/O
- Desktop for Automation - Port is configured to be connected to desktop devices, such as desktop
PCs, workstations, notebook PCs, and other client-based hosts
- Switch for Automation - Port is configured to be connected to other switches that support Spanning
Tree, such as, Stratix® 8000, Stratix® 6000 release 3, or Cisco switches
5 - Router for Automation - Port is configured to be connected to Cisco routers or Layer 3 switches
with routing service capabilities. Use this role if the port will connect to devices that connect to the
WAN or the Internet
- Phone for Automation - Port is configured to be connected to Cisco IP phones. A desktop device,
such as a PC, can be connected to the IP phone. Both the IP phone and the connected PC would have
access to the network and the Internet through the switch port
- Wireless for Automation - Port is configured to be connected to Cisco Wireless Access Point
- Multiport Automation Device - Port is configured to be connected to multiport EtherNet/IP (Ethernet
Industrial Protocol) devices
- Virtual Desktop for Automation - Port is configured to be connected to PCs running virtualization
software. This can be used with devices running up to two MAC addresses
- None - Apply this role to ports if you do not want a specialized Smartport role on the port

108 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Item Description
Mode: Displays Administrative Mode of selected port, available modes for each port are:
- Dynamic Auto
- Access
6 - Trunk
- Dynamic Desirable
- Tunnel
- Routed Port
7 VLAN: Displays the VLAN ID for configured VLANs. The default VLAN ID, 1, cannot be edited or deleted
8 Utilization: Displays current port utilization
9 Drop-down selector for desired port number.

Port - Statistics

1 9

2
3
4
5
6
7
8

Item Description
1 Port Details Drop-Down Menu
Statistics type
2 - Input Statistics: packets received/inbound packets
- Output Statistics: packaged transmitted/outbound packets
3 Octets: The number of octets that are received/transmitted by the port
Unicast: The total number of well-formed unicast packets received/transmitted by a port. It excludes
4 packets received with errors, with multicast or broadcast destination addresses, undersize packets,
discarded packets, or packets without a destination
Non-Unicast: The total number of well-formed multicast packets received/transmitted by a port. It
5 excludes packets received with errors, with unicast or broadcast destination addresses, oversized or
undersized packets, discarded packets, or packets without a destination
6 Discards: The number of inbound/outbound packets that have been discarded
7 Errors: The number of inbound/outbound packets that contain errors
8 Unknown Protocols: The number of inbound/outbound packets with unknown protocols
9 Drop-down selector for desired port number.

Port - Media Counter

The Media Counters page displays the number of errors and collisions on a
selected port.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 109

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

1 8

2 9
3 10
4 11
5 12
6 13
7 14

Item Description
1 Port Details Drop-Down Menu
2 Alignment Errors: The number of frames received that are not an integral number of octets in length
FCS (Frame Check Sequence) Errors: The number of frames received that do not pass the Frame,
3 check Sequence test
4 Single Collisions: The number of single (multiple, late) frame collisions detected by the interface.
5 Multiple Collisions: The number of multiple collisions detected by the interface
6 SQE Test Errors: The number of times that the SQE TEST ERROR is generated
7 Deferred Transmissions: The count of transmissions that are deferred by busy network
8 Drop-down selector for desired port number.
9 Late Collisions: The number of late collisions detected by the interface
10 Excessive Collisions: The number of frames for which transmission fails due to excessive collisions
MAC TX Errors: The number of frames that failed to transmit due to an internal MAC sublayer transmit
11 error
Carrier Sense Errors: The number of times the carrier sense condition was lost or never asserted
12 when attempting to transmit a frame
13 Frame Too long: The number of frames received that exceed the maximum permitted frame size
MAC RX Errors: The number of frames that failed to be received due to an internal MAC sublayer
14 receive error

Port - Thresholds

The Thresholds screen displays packets passing from an interface to the

switching bus. The switch counts the number of packets of a specified type that
is received within the 1-second time interval and compares the measurement
with a predefined suppression-level threshold.

110 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Port - Time Sync

The Time Sync screen displays port Precision Time Protocol (PTP)
synchronization status (Enable/Disable) and current state of the Time
Synchronization port on the device.

1 4

2
3

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 111

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Item Description
1 Port Details Drop-Down Menu
2 Port Time Sync Status: Enabled/Disabled
Port PTP State:
- Unknown
- Initializing: The switch port is waiting while a parent or grand master clock is selected
- Faulty: Either PTP is not operating properly on that switch port or nothing is connected to the port
- Forward: This switch passes PTP packets as normal multicast traffic. All switch ports are enabled
by default
- Listening: The switch port is waiting while a parent or grand master clock is selected
3 - Pre-Master: The switch port is transitioning to change to Master state
- Master: The switch is acting as a parent clock to the devices connected to that switch port
- Passive: The switch has detected a redundant path to a parent or grand master clock. For example,
two different switch ports claim the same parent or grand master clock. To prevent a loop in the
network, one of the ports changes to Passive state
- Uncalibrated: The switch port cannot synchronize with the parent or grand master clock
- Slave: The switch port is connected to and synchronizing with the parent or grand master clock
4 Drop-down selector for desired port number.

Alarm Tab
The Alarm Tab screens provide details for global switch alarms and individual
Port alarms Click on the tab with exclamation icon, then select Global or Port
Screens using left drop-down selector.

There are multiple way to get to these screens:

• Click on the banner if alarm text appears or click on individual port.
• An Active Alarm is indicated by a yellow rectangle button.

112 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Clicking on the yellow button will launch the Alarm Details screen providing
an alarm description and recommended actions, click on the X on the upper
right corner to close the alarm details screen.

There are two type of alarms will be displayed on the alarm tab:
• Global Alarms
• Port Alarms

Global Alarms

Set the drop-down selector to Global Alarms to display global switch alarms.

Active alarms are shown with a yellow LED icon and a darker gray background.
You can click on the active alarm to see more details.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 113

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

2 7
3
8
4

Item Description
1 Drop-down selector Global Alarms/Port Alarms
2 SD Card: Indicates Alarms generated by a faulted SD card.
Power Supply: The switch monitors DC power supply levels. If the system is configured to operate in a
3 dual power mode, an alarm is triggered if a power supply fails or is missing. The alarm is
automatically cleared when the power supplies are present or working.
4 License File: An alarm is triggered when the license file is corrupt.
Primary Temperature: These alarms are triggered when the system temperature is higher or lower
5 than the configured thresholds. By default, the primary temperature alarm is associated with the
major relay.
Secondary Temperature: These alarms are triggered when the system temperature is higher or lower
6 than the configured thresholds.
Major Output: User can configure the switch to trigger an external alarm device. The switch software
7 is configured to detect faults that are used to energize the relay coil and change the state.
Input 1/2/3/4 Event: An alarm is triggered based on an external input 1/2/3 alarm. Input 3 and 4
8 visibility depends on switch type.

Port Alarms

Click on left drop-down menu and select Port Alarms option. This will allow
you to view and use the right drop-down menu to navigate between specific
port alarms.

Active alarms are shown with a yellow LED icon and a darker gray background.
You can click on the active alarm to see more details.

114 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

1 2

Item Description
1 Drop-down selector - Global Alarms/Port Alarms
2 Drop-down selector - Port Selection
3 Ports with an active alarm display an alarm bell icon in the drop-down menu

1 8

2 9
10
3

4 11
12
5
13
6
7

Item Description
1 Drop-down selector - Global Alarms/Port Alarms
Unauthorized Device: Indicates that an unauthorized MAC ID has attempted to communicate on a
2 specific port.
3 Link Fault: Connection Fault detected on a specific port, including disconnected cable.
Port Not Forwarding: The switch generates a port not-forwarding alarm when a port is not forwarding
4 packets.
Port Not Operating: The switch generates a port not-operating alarm when a port fails during the
5 startup self-test.
FCS Bit Error Rate: The switch generates an FCS bit error-rate alarm when the actual FCS bit error-
6 rate is close to the configured rate.
7 Error Disable
8 Drop-down selector - Port Selection
9 SFP Disabled: Software placed the SFP interface in an error-disabled state.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 115

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Item Description
10 Native VLAN Mismatch: Connected switches the native VLAN numbers differ.
11 MAC Address Flap: Switch detected that a MAC address is being learned on alternating switch ports.
12 Port Security Violation: A security violation occurred on a selected port
13 Port Threshold Exceeded: Port traffic exceeded a preset threshold

Banner
A banner will be displayed at the top of each screen to provide the following
information of the device:
• Ready
• Not Ready (device will show Not Ready and fault message)
• AOI Not Enabled

There are two types of banner available that provides the overall status of the
switch.
• Abbreviated version of the banner: Only available on Home tab

• Full version of banner : Available on Switch, Port & Alarm tab

116 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

The full banner will be visible when there is any alarm or fault present on
switch or on any port, or when AOI is not enabled.

When an alarm or fault is preset a reset button is visible on banner to reset

alarms or faults.

When the device is healthy and no alarms are present then ready with green
LED will be shown on banner.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 117

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Application Code Manager Network Device Library objects can be set-up and configured using Studio
5000® Application Code Manager.

Refer to the section Using Application Code Manager for complete details.

Definition Objects: raC_Dvc_Stratix

This Asset-Control object contains the Add-On Instruction definition and

required data types. It is used as a linked library to the device implement
object. This gives users the flexibility to choose to instantiate only definition
and create custom implement code. A user may also create their own
implement library and link with this definition library object.

Implementation Objects: raC_LD_Dvc_Stratix

The Device Implementation Object is the rung that is instantiated when
generating controller code using Application Code Manager. This
implementation object includes a reference to the Asset-Control Add-On
Instruction definition, along with any required controller tags, programs,
modules, and HMI objects.

The Stratix® implementation has the following configuration parameters.

Parameter Name Default Value Instance Name Definition Description

Enter Routine name. Routine will be created and Object

implement rung(s) inserted.
A JSR will be inserted in MainRoutine.
RoutineName {ObjectName} {RoutineName} Routine If routine name already exists, then object will be inserted into
existing routine.
By default, parameter is set to Object Name.

Enter the backing tag of the main AOI.

TagName {ObjectName} {TagName} Backing Tag This will serve as the base tag name for other tags in this object
that are derived from the base.

TagDescription {ObjectDescription} {TagDescription} Tag Description of the main AOI backing tag

Enter the Module Name. This is the name for the module that
ModuleName Mod_[ObjectName] [ModuleName] appears in the Controller Organizer tree.

Allow ACM to create the Hardware Module. If the module already

IncludeHW True exists in the Controller Organizer, select False or existing module
properties will be overwritten.
Select hardware module type:
Stratix® 2500
Stratix® 5200
ModuleType Stratix® 2500 Stratix® 5400
Stratix® 5410
Stratix® 5700
Stratix® 5800

CatalogNo Select Stratix® hardware module type

118 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

Parameter Name Default Value Instance Name Definition Description

Enter a valid network address for the hardware module. It must

IPAddress 192.168.1.0 be of form X.X.X.X

Select the Parent Module. This represents the name of the

communications adapter this module will communicate through.
If connecting to a non-library object module enter the name of
the module only. If the module is connected directly to the
ParentModule Local Module controller Ethernet port, enter “Local”. Note: entering non-library
object modules will result in the parameter displaying a red ‘X’.
This will still generate properly as long as the entered name
exists in the project.

Local/Linear/DLR=2
5380 Dual-Port A1=3
Parent Module
ParentModulePort 2 5380 Dual-Port A2=4
Port ID 5480 Dual-Port A1=4
5480 Dual-Port A2=5

Select navigation button type. Icon/Text. See FactoryTalk® View

NavigationButton Icon ME/SE Graphic Symbols for more information.

Note that if the tag names are manually entered or not linked to ParentModule
tags a red ‘X’ will be shown beside the parameter. This is acceptable and the
program can still be generated.

Linked Libraries

Link Name Catalog Number Revision Solution Category

raC_Dvc_Stratix raC_Dvc_Stratix 12.4 (RA-LIB) Device Network

Configured HMI Content

HMI Content Instance Name Description

Launch Button {ObjectName}_GO_LaunchFP_Text Global Object launch button using basic text label.

Launch Button {ObjectName}_GO_LaunchFP_Icon Global Object launch button using schematic style device icon.

Attachments

Name Description File Name Extraction Path

V12_raC_Dvc_Globall Graphic Symbols ME (raC-12-ME) Graphic Symbols - Network Device.ggfx {ProjectName}\Visualization\FTViewME\GlobalObjects
V12_raC_Dvc_Stratix® Faceplate ME (raC-12_xx-ME) raC_Dvc_S2500-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_Stratix® Faceplate ME (raC-12_xx-ME) raC_Dvc_S5200-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_Stratix® Faceplate ME (raC-12_xx-ME) raC_Dvc_S5400-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 119

Chapter 6 Stratix® Switch (raC_Dvc_Stratix)

V12_raC_Dvc_Stratix® Faceplate ME (raC-12_xx-ME) raC_Dvc_S5410-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays

V12_raC_Dvc_Stratix® Faceplate ME (raC-12_xx-ME) raC_Dvc_S5700-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_Stratix® Faceplate ME (raC-12_xx-ME) raC_Dvc_S5800-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_Globall Graphic Symbols SE (raC-12-ME) Graphic Symbols - Network Device.ggfx {ProjectName}\Visualization\FTViewSE\GlobalObjects
V12_raC_Dvc_Stratix® Faceplate SE (raC-12_xx-SE) raC_Dvc_S2500-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Dvc_Stratix® Faceplate SE (raC-12_xx-SE) raC_Dvc_S5200-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_Stratix® Faceplate SE (raC-12_xx-SE) raC_Dvc_S5400-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Dvc_Stratix® Faceplate SE (raC-12_xx-SE) raC_Dvc_S5410-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Dvc_Stratix® Faceplate SE (raC-12_xx-SE) raC_Dvc_S5700-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Dvc_Stratix® Faceplate SE (raC-12_xx-SE) raC_Dvc_S5800-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays

V12_raC_Dvc_SDtratix View Designer (raC-12_xx-VD) raC_Dvc_Stratix.vpd {ProjectName}\Visualization\ViewDesigner

V12_RM_raC_Dvc_Network Reference Manual DEVICE-RM400B-EN-P.pdf {ProjectName}\Documentation

V12_Network_Images HMI Image Set HMI FactoryTalk® View Images - png.zip {ProjectName}\Visualization\Images
V12_raC_Dvc_Network_Glob Toolbox ME (raC-12-ME) Toolbox - Network Device.ggfx {ProjectName}\Visualization\FTViewME\GlobalObjects
V12_raC_Dvc_Network_Glob Toolbox SE (raC-12-SE) Toolbox - Network Device.ggfx {ProjectName}\Visualization\FTViewSE\GlobalObjects

120 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7

Device Level Ring (raC_Opr_NetDLR1,

raC_Opr_NetDLRLite)

Overview The Device Level Ring device objects (raC_Opr_NetDLR1 and

raC_Opr_NetDLRLite) include HMI faceplates for Device Level Ring (DLR)
networks which displays network information including:
• Automatically generated network topology
• Detailed ring network data and statistics
• Network fault monitoring including graphical identification and
location of faulted network links
• Ring supervisor, ring participant, and redundant gateway information

The standard object (raC_Opr_NetDLR1) can be used for DLR networks

containing up to 56 nodes. The smaller Lite version of the instruction
(raC_Opr_NetDLRLite) can be used with smaller networks up to 12 nodes.

The standard object (raC_Opr_NetDLR1) is also utilized for multi-ring

applications. This is accomplished by creating multiple instances of the AOI,
with each instance corresponding to a specific application ring. By doing so,
you can manage and monitor multiple network rings within the same system,
ensuring that each ring is individually addressed and configured.

Previously, we used a separate instruction (raC_Opr_NetDLR3) for three DLR

networks. However, starting from this release, the raC_Opr_NetDLR3
instruction is being retired. The standard object (raC_Opr_NetDLR1) will now
be used for multi-ring networks, streamlining the configuration process and
reducing complexity.
In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following videos for this section:
“Operational Overview of DLR Object Faceplates”

Functional Description The Device Level Ring pre-configured Device Objects:

• Collects and processes data from the Active Ring Supervisor and
participant node devices and delivers data to the status and diagnostic
faceplates.
• Provides enhanced DLR network and node status and diagnostic
information simplifying network maintenance and reducing network
downtime.

All these features provide quick feedback, shorten recovery time, and simplify
implementation.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 121

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Required Files Device Objects include Add-On Instructions (AOIs) and HMI faceplates. The
revision number (e.g. 1.01) used in filenames can change as new revisions are
created.

Controller Files
Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

The Add-On Instruction must be imported into the controller project to be

used in the controller configuration. These can be imported as Add-On
Instruction files, or as part of the Rung Import or Import Library Objects
wizard.

All Add-On Instruction and Rung Import files can be found in the /Studio 5000
Logix Designer Files - L5X/ folder in the library.

Compatible
Object Add-On Instruction Rung Import
Network Configuration
Ring up to 56 nodes, one instance raC_Opr_NetDLR1_12.04_AOI.L5X
raC_Opr_NetDLR1 raC_Opr_NetDLR1_12.04_RUNG.L5X
for each ring
Ring up to 12 nodes, one instance raC_Opr_NetDLRLite_12.04_AOI.L5X
raC_Opr_NetDLRLite raC_Opr_NetDLRLite_12.04_RUNG.L5X
for each ring

FactoryTalk® View HMI Files

FactoryTalk® View ME and FactoryTalk® View SE applications require
importing the desired device faceplates in addition to all Global Object (ggfx)
files and all images located in the /HMI FactoryTalk® View Images - png/ folder of
the library. FactoryTalk® View ME files are stored in the /HMI - FactoryTalk®
View ME/ library folder and FactoryTalk® View SE files are stored in the /HMI -
FactoryTalk® View SE/ library folder.

Note that the Add-On Instruction raC_Opr_NetDLR1 can be used with either
the 24 Node or 56 Node displays depending on the size of the network. The
HMI faceplate will automatically display the correct layout for connected
network.

122 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Compatible FactoryTalk® View ME FactoryTalk® View SE

Device/Item Network Type Faceplate Faceplate
Configuration
raC_Opr_NetDLRLite Single ring up Display (raC-12_04-ME) raC_Opr_NetDLR1_12Node-Faceplate.gfx (raC-12_04-SE) raC_Opr_NetDLR1_12Node-Faceplate.gfx
to 12 nodes
Single ring up Display (raC-12_04-ME) raC_Opr_NetDLR1_24Node-Faceplate.gfx (raC-12_04-SE) raC_Opr_NetDLR1_24Node-Faceplate.gfx
to 24 nodes
raC_Opr_NetDLR1
Single ring up Display (raC-12_04-ME) raC_Opr_NetDLR1_56Node-Faceplate.gfx (raC-12_04-SE) raC_Opr_NetDLR1_56Node-Faceplate.gfx
to 56 nodes
Graphic Symbols All DLR Global Object (raC-12-ME) Graphic Symbols - Network Device (raC-12-SE) Graphic Symbols - Network Device
Toolbox All DLR Global Object (raC-12-ME) Toolbox -Network Device.ggfx (raC-12-SE) Toolbox -Network Device.ggfx

Studio 5000 View Designer® HMI Files

All Studio 5000 View Designer® Files can be found in the /HMI - ViewDesigner -
vpd/ folder of the library.
Device/Item Studio 5000 View Designer® Faceplate
All Device Level Ring Objects (raC-12_04-VD) raC_Opr_NetDLR.vpd

FactoryTalk® Optix Library Files

FactoryTalk® View Optix applications require importing the desired library
objects located in the NetworkDevice_v12R library folder.

Device/Item FactoryTalk® Optix Library Object

DLR Lite raC_12_04_raC_Opr_NetDLRLite_UI
DLR1 Upto 56 Node raC_12_04_raC_Opr_NetDLR1_56Node_UI
DLR1 Upto 24Node raC_12_04_raC_Opr_NetDLR1_24Node_UI

Studio 5000® Application Code Manager Files

Studio 5000® Application Code Manager (ACM) can be optionally used if it is
installed. All devices can be easily registered in the ACM repositories by
running the setup.cmd file located in the root folder of the library.

Individual HSL4 files are provided as an alternative to running the setup.cmd

to allow users to manually register specific implementation objects. Each
object has two files - an Asset Control file and a Device file. The Asset Control
files include attachments of all required files for that object. The Device files
are used to actually add that device into a Studio 5000® project and these
reference the Asset Control files.

All Studio 5000® Application Code Manager files can be found in the /
ApplicationCodeManagerLibraries/ folder of the library. The files included are as
follows:

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 123

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Implementatio Compatible
Network Asset Control File (.HSL4) Device File (.HSL4)
n Object Configuration
Single ring up to (RA-LIB)_Device_Asset-Control_Network_raC_Opr_NetDLRLite_(12.4) (RA-LIB)_Device_Device_Network_raC_LD_Opr_NetDLRLite_(12.4)
DLRLite 12 nodes
Single ring up to (RA-LIB)_Device_Asset-Control_Network_raC_Opr_NetDLR1_(12.4)
DLR1 (RA-LIB)_Device_Device_Network_raC_LD_Opr_NetDLR1_(12.4)
56 nodes

Operations The Network Device objects provide only physical operation mode. There is no
virtual device mode offered.

Execution
The following table explains the handling of instruction execution conditions.

Condition Description
Processing for EnableIn False (false rung) is handled the same as if the device
EnableIn False (false rung) were taken out of service by Command. The device outputs are de-energized and
the device is shown as Program Out of Service on the HMI. All alarms are cleared.
On prescan, any commands that are received before first scan are discarded. The
device is de-energized. On first scan, the device is treated as if it were returning
from Hand command source: the instruction state is set based on the position
Powerup (prescan, first feedback that is received from the device. If the feedback is valid for one position,
scan) the device is set to that position. If the device does not have position feedback or
the position feedback is invalid, the device is set to the ‘unknown/powerup’ state.
The command source is set to its default, either Operator or Program (unlocked).
Postscan No SFC Postscan logic is provided.

124 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Add-On Instruction I/O Data InOut Data

InOut Function / Description DataType

Ref_RingPointerNode Module that is directly connected to the MODULE

Device Level Ring (DLR)
Ref_SwitchPaths Stratix Switch Path Configuration raC_UDT_DLR1_Paths

Message used to read complete CIP

Ref_Msg_Get_All MESSAGE
objects.

Message used to read vendor specific

Ref_Msg_Get_Single MESSAGE
attributes.

Message used to read member

Ref_Msg_Get_Member MESSAGE
attributes

Ref_Msg_Rst_SignOn Message used to sign on to switch MESSAGE

Ref_Storage Stores CIP message data SINT[520]

Input Data
Input Function/Description DataType
EnableIn Enable Input - System Defined Parameter BOOL

Inp_Enable Enable AOI functions. 1 = enabled. BOOL

Ref_PointerRingID 1 = Other than Stratix Device DINT

For stratix actual ring ID
Inp_RefreshInhibit Inhibit data refresh BOOL

Cfg_InhibitCfgTab 1 = Inhibit/Hide the Config tab in the faceplate BOOL

Output Data
Output Function/Descritpion DataType

EnableOut Enable Output - System Defined Parameter BOOL

Sts_EN AOI Enabled Status; 1 = enabled. BOOL

Sts_ER Message error bit; 1= Error BOOL

Device is connected to the Programmable

Sts_Connected BOOL
Controller
Device is available for interaction with user
Sts_Available BOOL
code
Device faulted status: 1 = an active fault
Sts_Faulted BOOL
exists
Sts_Ring_Faulted Enable if Ring network has faulted BOOL

Sts_PathError Enable Switch configuration is not proper BOOL

Ref_HMI Alias tag for HMI_Parameters.Tab_Active DINT

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 125

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Data Types A number of User-Defined Datatypes (UDT) are used in the Network Device
Library. A full list of the UDTs used with the raC_Opr_NetDLR1 and
raC_Opr_NetDLRLite objects follows:

raC_Opr_NetDLR1
User Defined Datatype Description
raC_UDT_DLR1_ActiveNode DLR Active Node Address
raC_UDT_DLR1_HMI DLR HMI Faceplate Information
raC_UDT_DLR1_HMIDropdowns DLR Drop-down menu
raC_UDT_DLR1_HMITab0x_Home DLR HMI Faceplate Information - Home Tab
raC_UDT_DLR1_HMITab1x_Ring DLR HMI Faceplate Information - Ring Tab
raC_UDT_DLR1_HMITab2x_Node DLR HMI Faceplate Information - Node Tab
raC_UDT_DLR1_HMITab3x_Faults DLR HMI Faceplate Information - Fault Tab
raC_UDT_DLR1_HMITab8x_Config DLR HMI Faceplate Information - Configure Tab
raC_UDT_DLR1_LastNode DLR Last Node Information
raC_UDT_DLR1_LocalData DLR HMI local data
raC_UDT_DLR1_MacAddress DLR Mac Address
raC_UDT_DLR1_NodeInfo DLR Node information
raC_UDT_DLR1_PathDevice Switch configuration Path details
raC_UDT_DLR1_Paths CIP Paths to Stratix Switches
raC_UDT_DLR1_RedGateway DLR Redundant Gateway information
raC_UDT_DLR1_StratixRing DLR Stratix Ring Info
rac_UDT_DLR1_SwitchInfo DLR Stratix Switch Info
raC_UDT_DLR1_TakeoverOrder DLR Supervisor precedence
raC_UDT_DLR1_ValidDLRPath DLR valid path info

raC_Opr_NetDLRLite
User Defined Datatype Description
raC_UDT_DLRLite_ActiveNode DLR Active Node Address
raC_UDT_DLRLite_CaptureError DLR Error Information
raC_UDT_DLRLite_HMI DLR HMI Faceplate Information
raC_UDT_DLRLite_Dropdowns DLR Drop-down menu
raC_UDT_DLRLite_HMITab0x_Home DLR HMI Faceplate Information - Home Tab
raC_UDT_DLRLite_HMITab1x_Ring DLR HMI Faceplate Information - Ring Tab
raC_UDT_DLRLite_HMITab2x_Node DLR HMI Faceplate Information - Node Tab
raC_UDT_DLRLite_HMITab3x_Faults DLR HMI Faceplate Information - Fault Tab
raC_UDT_DLRLite_LastNode DLR Last Node Information
raC_UDT_DLRLite_LocalData DLR HMI local data
raC_UDT_DLRLite_MacAddress DLR Mac Address
raC_UDT_DLRLite_NodeInfo DLR Node information

Add-On Instructions A number of embedded Add-On Instructions (AOI) are used within the
raC_Opr_NetDLR1 and raC_Opr_NetDLRLite instructions. These are used to
convert between datatypes and generate values which can be read from the
HMI faceplate. The following AOIs are included:

126 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

raC_Opr_NetDLR1
User Defined Datatype Revision Description
raC_Opr_NetDLR1_SwitchConfiguration 12.04 Switch Configuuration
Converts decimal number to hexadecimal
raC_Tec_NetDLR1_DecToHex 12.04 String
raC_Tec_NetDLR1_ClearNodeInfo 12.04 Clears node information
raC_Tec_NetDLR1_GetMembersDLR 12.04 DLR Member Info
Determines device icon used in DLR network
raC_Tec_NetDLR1_IconSW 12.04 schematic
raC_Tec_NetDLR1_IPAddressValidation 12.04 IP Address Validation
Converts numerical IP/MAC address into user-
raC_Tec_NetDLR1_IPMACtoString 12.04 readable string
raC_Tec_NetDLR1_MACCompare 12.04 Compares two MAC addresses
raC_Tec_NetDLR1_MACFindIPReplace 12.04 Switch IP Address & Ring Instance number
Strips and separates the last IP address from
raC_Tec_NetDLR1_PathCombine 12.04 the path
raC_Tec_NetDLR1_PathValidationRing 12.04 Validate the Ring Path
raC_Tec_NetDLR1_PathValidationSwitch 12.04 Validate the Switch Path

raC_Opr_NetDLRLite
User Defined Datatype Revision Description
Converts decimal number to hexadecimal
raC_Tec_NetDLRLite_DecToHex 12.04 String
raC_Tec_NetDLRLite_ClearNodeInfo 12.04 Clears node information
Determines device icon used in DLR network
raC_Tec_NetDLRLite_DLRIcon 12.04 schematic
Converts numerical IP/MAC address into user-
raC_Tec_NetDLRLite_IPMACtoString 12.04 readable string
raC_Tec_NetDLRLite_MACCompare 12.04 Compares two MAC addresses
Strips and separates the last IP address from
raC_Tec_NetDLRLite_PathCombine 12.04 the path

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 127

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Programming Example Fully configured device on a rung is provided below for reference.

Note that this programming example is the same code that is imported when
either importing the supplied rung .L5X files.

The following example uses the Device Level Ring device object named
Dvc_DLR1. There are two methods to configure the Switch Configuration
Assistant configuration.
1. Optional Switch Configuration Assistant.
2. HMI Configuration Tab.

See CIP Message Path for more information and Examples of DLR Object
Configuration assigning the AOI for Ref_RingPointerNode,
Ref_PointerRingID & Ref_SwitchPaths.

Graphic Symbols Graphic Symbols are used as launch buttons within HMI applications to open
up faceplate displays. See Basic Launch Button Attributes section for details on
configuration and indicators.

FactoryTalk® View ME/SE Graphic Symbols

Graphic Symbol Name Graphic Symbol Description Global Object Parameter Values
Faceplate navigation button with string tag label. #102: AOI Backing Tag Instance (e.g.
This launch button graphic object allows the {::[PAC]._InstanceName})
GO_LaunchFP user to navigate to the device object faceplate. #104: Navigation Button Label
The text on the button face is set to the #120: Display’s left position (e.g. 100) (optional)
parameter #104. #121: Display’s top position (e.g. 100) (optional)

128 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Studio 5000 View Designer® Graphic Symbols

Graphic Symbol Name Graphic Symbol Description Property Configuration

Navigate to 12 Node
btn_nav_NetDLR1_12Node_FP DLR Faceplate Pop-
Up Screen

Navigate to 24 Node
btn_nav_NetDLR1_24Node_FP DLR Faceplate Pop-
Up Screen

Navigate to 56 Node
btn_nav_NetDLR1_56Node_FP DLR Faceplate Pop-
Up Screen

FactoryTalk® Optix Graphic Symbols

Graphic Symbols are used as launch buttons within HMI applications to open
up faceplate displays. All graphical symbols for Network Devices display the
following information:
• - Device label (Tag.@Description or custom label )
• - Device Warning/Fault Indication
• - AOI Enable/Disable
• - Device bad communication

See Basic Launch Button Attribute section for more general information on
launch button diagnostics and usage.

Once the Objects have been imported into the FactoryTalk® Optix Studio
project, you can begin using them in your application. To add a new Launch
Button to a Main window, navigate to raC_Dvc_ObjectName > Graphic

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 129

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Symbols > Dvc ObjectName Text Button to insert a navigation launch button
with a text label.

After placing the graphic symbol on a UI panel, link the “Ref_Tag” property to
the targeted Asset under Asset tag.

Text label shown on button can be configured using “cfg_Label” property, If it

is not configured then description of the asset will be shown on the button
face.

This is the only step needed to link the UI to the asset data model. For more
information on graphic symbols, refer to the Graphic Symbol section of the
Network device type in this manual.

130 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Graphic Symbol Name Graphic Symbol Description Property Configuration

Cfg_CloseCurrentDisplay: Set to ‘True’
to close the previously open display
when launching the object faceplate

Cfg_DisplayType: Faceplate to be
Faceplate navigation button. Use Cfg_Label Variable to opened on button click. This should
raC_12_xx_raC_Dvc_Devicename_GS_N not be modified.
avText modify the button label text.
Ref_Tag: Object’s Add-On Instruction
Tag

Cfg_Label: Text label shown on the

button face

Graphic Symbol Button Configuration Variables.

Variable Name Description Default Value

Cfg_CloseCurrentDisplay Set to ‘True’ to close the previously open display when launching the object faceplate False
Cfg_DisplayType Faceplate to be opened on button click. This should not be modified. Faceplate
Ref_Tag Link to instance of desired target Asset model found in Model > Asset folder. N/A - User must configure
Text label shown on the button face. Defaults to the description of the asset but users may
Cfg_Label ../Ref_Tag@Description
replace in instances with other desired text.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 22.

In this document, the faceplate pictures (or snapshots) are of 24-node

faceplate, although the 56-node screens and 12-node(DLRLite) screens operate
identically with only Home Tab difference displaying up to 56 nodes and 12-
nodes respectively instead of 24. Also the Redundant Gateway option is not
applicable for 12-node DLR Network irrespective of 24-node and 56-node
Network.

Faceplate Navigation

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 131

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Cfg Tab

• The Home tab provides connected ring network layout and node icons
with device information (Catalog Number, IP Address).
• The Ring tab provides the Active Ring Supervisor details, Active
Redundant Gateway details.
• The
• Node tab provides details for all connected nodes.
• The Fault tab provides network fault information and location.
• The Cfg tab used to configure the Stratix Switch path configuration. It
is applicable for 24 & 56 DLR Node faceplate and not applicable for 12 or
Lite node DLR faceplate.

Home
The Home screen is visible when the Home tab button is selected in the tab
control object on the left side of the screen. The Home tab screen displays an
auto-generated network layout. This example is displaying 24-node network.
The number and sequence of nodes are based on the information provided by
the Active Ring Supervisor.

132 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

The Active Ring Supervisor is always located on the upper left position of the
screen and it is identified by the star icon at the upper right corner of the node.

If the Backup Supervisor is configured, then it is identified by numerical icons

at the upper right corner of the nodes. The numerical order indicates the order
taken over by the supervisor, if the initial Active Ring Supervisor and
subsequent Backup Supervisor cannot perform functions any longer.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 133

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

In addition, each node will display its catalog number and IP address as
reported by the device.

Detailed node information can be accessed by pressing the individual device

Icons.

Devices without IP addresses can participate in the DLR and will be identified
with a question mark. Device catalog number will be shown only if node
responds to Identity request by the Add-On Instruction (AOI), otherwise a
question mark icon will be shown.

In the Ring application, if there’s a speed mismatch between two nodes, it will
display the ‘not equal to’ sign.

If a network connection fault is detected, a Link Fault indicator represented by

the round yellow circle with an exclamation mark will appear on the network
layout at the point or points of failure. In addition, a yellow border will appear
on the network fault tab navigation button. Once the failed connection is
restored, the Link Fault indicator will disappear.

Note: Refer the Fault tab section for more information on the faults detected

134 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

If a node is no longer responding, for example, if node power turned off, then
missing node will be shown with “X” sign over the device icon.

Once the node functionality and connections are restored, the node and the
associated link appearance will be restored to the normal state.

Ring Tab
The Ring Tab provides more information about the Device Level Ring network.
The drop-down menu next to the Ring selector allows users to select the
detailed Ring Information, Active Supervisor Identity, Active Supervisor
Capabilities or Redundant Gateway information.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 135

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Ring Information

The Ring information provides basic network configuration, status and

diagnostic information to assist in troubleshooting potential network
problems.

Network Topology “Ring” state indicates that at least one node has the Active
Ring Supervisor function enabled. The faceplate will be suspended if network
is transitioned from the ring to the linear topology.

Network “Normal” state indicates that the ring is functioning correctly and no
link faults are present. Otherwise, network status will indicate the various type
of faults as reported by the Active Ring Supervisor.

In addition, this display shows currently active DLR configuration parameters

that can be used for DLR network configuration, maintenance and
troubleshooting.

Please refer to the DLR user guides for more information.

https://literature.rockwellautomation.com/idc/groups/literature/documents/
at/enet-at007_-en-p.pdf

https://literature.rockwellautomation.com/idc/groups/literature/documents/
td/enet-td015_-en-p.pdf

Active Supervisor Identity

The Active Ring Supervisor is automatically determined based on the

precedence value and MAC address. The Active Supervisor identity
information helps the user to identify the device that is currently acting as the
Active Ring Supervisor. This information includes the MAC address, IP
address, Catalog Number, Vendor, Device Type, Product Code and Serial
Number. Firmware Revision helps with troubleshooting to determine if the
device firmware is current.
136 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024
 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

This information is updated in real time and will reflect any changes in the
Active Ring Supervisor.

Active Supervisor Capabilities

The Active Supervisor capability information provides the configuration and

device capabilities of the Active Ring Supervisor which helps with device
configuration and troubleshooting. See Node Capabilities for details.

Redundant Gateway

If Redundant Gateway functionality is enabled on the DLR network, then this

screen will display information about the device that acts as an Active
Redundant Gateway, including IP address, MAC address and Gateway
Precedence value.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 137

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Redundant Gateway option is not applicable for 12-node DLR Network.

Node Tab
The DLR faceplate also allows user to display information about all DLR
participant nodes. For specific node information, select the Node Tab
navigation button.

The node selection dropdown at the top right side of the node tab display
allows user to access a specific node based on the IP or MAC address.

Node Information

The Node Information display helps users to associate the specific node by one
or more of its identity parameters:

138 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Catalog Number, MAC address, IP address, Vendor, Device Type, Product

Code, Serial number. It also allows to verify if firmware revision meets the user
requirements.

Node Mode

The Node Mode information provides the role of a specific node on the
network, either normal node, Active Supervisor, or Backup Supervisor.

Please note that Supervisor Precedence is not the same as the Takeover Order
shown on the Home screen. The Takeover order is calculated by the Add-On
Instruction and is based on the precedence value and individual MAC
addresses.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 139

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Node Capabilities

The Node Capabilities provide the information that potentially helps with
node configuration and troubleshooting.

The first two fields identify if the node’s DLR implementation is done in
software (Announce-Based) or in Hardware (Beacon Based).

Supervisor Capability indicates that a specific device can be configured as a

supervisor.

Some Supervisor capable devices can act as Redundant Gateway allowing

multiple uplink connections to the distribution layer switches.

The Flush Table capability is required for all nodes that are present on the DLR
network where a Redundant Gateway is enabled.

Redundant Gateway

The Redundant Gateway Display will provide detailed node configuration

parameters, if the node is configured for Redundant Gateway. It will also
indicate the Redundant Gateway status for selected node.

This information allows users to troubleshoot an issue related to the

Redundant Gateway connections and loss of data.

Redundant Gateway option is not applicable for 12-node DLR Network.

140 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Node DLR Ports

The Node DLR Port Display will provide detailed DLR Ports information. It
gives the following information which is shown in below picture.

Fault Tab
The Network Fault Tab provides details about network health. When a network
fault occurs, it will indicate the fault type, fault location. Any fault clear/reset

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 141

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

operations should be performed via advanced user tools like Device Manager
or Studio 5000 Logix Designer® Add-On Profile.

Network Fault

A fully functional DLR network should remain in Normal state.

When a network fault occurs, the faceplate will indicate one of the following
faults:
• Ring Fault
• Unexpected Loop Detected
• Partial Network Fault
• Rapid Fault/Restore Cycle Fault

Ring Fault: The most common fault, the Ring Fault – usually occurs when one
or more link is broken, or a node is taken off the network.

142 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Unexpected Loop Detected: this fault occurs when the network ring was closed
without defining at least one node as the Active Ring Supervisor – in Linear
topology.

Partial Network Fault: occurs when the Active Ring Supervisor detects
network fault in one direction only.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 143

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Rapid Fault/Restore Cycle fault: Occurs when there are more than 5
consecutive fault/recovery cycles detected in less than 30 seconds. This usually
happens during network commissioning and indicates a severe hardware or
cabling issue, or misconfiguration that requires immediate attention. When
this fault occurs, it is required to restore normal operations after the fault
cause was determined and corrected. Then Rapid Fault/Restore reset should be
performed via advanced user tools like Device Manager or Studio 5000 Logix
Designer® Add-On profile.

Ring Fault Count indicates number of ring faults since the Active Ring
Supervisor’s power-up or last fault reset.

Please note that the counter is just a status indicator and does not affect DLR
or faceplate operations.

144 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Ring Fault Reset should be performed via advanced user tools like Device
Manager or Studio 5000 Logix Designer® Add-On Profile.

Fault Location

The fault location information provides a potential breaking point as reported

to the faceplate by the Active Ring Supervisor.

Warning Information

The faceplate also provides a series of warnings, here are few examples:

Faceplate Displays rely on the information provided by the Add-On

Instruction.

If the Add-On Instruction operation is disabled by the user, then “AOI Not
Enabled” warning message is shown and all faceplate operations will be
suspended.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 145

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

If the detected number of nodes on the connected network exceeds 24 then the
below warning will display and all faceplate operations will be suspended.

Likewise, if the number of nodes on a 56-node faceplate exceeds 56, a similar

warning will replace the network layout and all faceplate operations will be
suspended.

Similarly, if the number of nodes on 12-node faceplate exceeds 12, a warning

will replace the network layout and all faceplate operations will be suspended.

The following message indicates that corresponding Logix Add-On Instruction

(AOI) message to the DLR Supervisor failed. The incorrect or invalid path
defined in the Add-On Instruction parameters is likely the cause of this error.

146 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

The following message will be displayed if AOI is pointing to a network that is

not a DLR topology.

The initial scan of the network must be performed in “Normal” state where
DLR is functioning without a fault or cable break. Otherwise, the following
message will be displayed. Once DLR is restored to the Normal state, the
faceplate will automatically build the network participant list and display
current network topology.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 147

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

148 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Configuration Tab
The Configuration Tab provides detailed configuration about the Stratix
switch path from controller.

If a Stratix switch is included in the Ring network application, a controller-to-

switch path is required and can be configured using the Config tab in DLR
HMI Faceplate. Configuration tab is available in 24 & 56 DLR Node faceplate
and not available in 12 or Lite node DLR faceplate.

However, if Stratix switch paths are configured using the Option Switch
Configuration AOIs in Studio 5000 Logix Designer, the Config tab in the HMI
faceplate should not be used. To hide the Config tab, set the input parameter
Cfg_InhibitCfgTab.

Refer to the section CIP Message Path for complete details

Configuration Tab is not required if switch configuration can be done through

the ACM or through rung import- Optional Switch Configuration Assistant
AOI. Below is the picture of 56 Node display configuration tab.

The Path Animation feature is only compatible with the 56-Node displays.

9
5

6 7 8

To inhibit the Config tab set the input parameter ‘Cfg_InhibitCfgTab’ bit in the
controller.
To enable the functionality of the configuration tab, Press the Disable/Enable AOI
Button.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 149

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Item Description
1 From list box selection Select switch number to configure
2 String input to describe the switch description
3 List box option to select controller to switch path. For backplane slot selection list box is available.
4 String input to enter CIP IP address
5 Select the device type from list box
6 Select DLR Ring ID from list box.
Accept Button: If you finished the step from 1 to 6, Press on Accept button so that the data you
7 configured will be updated.
8 Enable AOI / Disable AOI Button: Press the Disable AOI Button to enable the configuration parameter.
Revert: If you want to revert the data which is already configured for any switch then press the
9 Revert button.
10 Clear Button: Pressing the clear button it will clear the configured. (Applicable for Switch 1 to 9)

Application Code Manager Network Device Library objects can be set-up and configured using Studio
5000® Application Code Manager.

Refer to the section Using Application Code Manager for complete details.

Definition Objects: raC_Opr_NetDLR1

This Asset-Control object contains the Add-On Instruction definition and
required data types. It is used as a linked library to the device implement
object. This gives users the flexibility to choose to instantiate only definition
and create custom implement code. A user may also create their own
implement library and link with this definition library object.

Implementation Objects: raC_LD_Opr_NetDLR1

The Device Implementation Object is the rung that is instantiated when
generating controller code using Application Code Manager. This
implementation object includes a reference to the Asset-Control Add-On
Instruction definition, along with any required controller tags, programs,
modules, and HMI objects.

The DLR1 implementation has the following configuration parameters.

Parameter Name Default Value Instance Name Definition Description

Enter Routine name. Routine will be created and Object

implement rung(s) inserted.
A JSR will be inserted in MainRoutine.
RoutineName {ObjectName} {RoutineName} Routine If routine name already exists, then object will be inserted into
existing routine.
By default, parameter is set to Object Name.

150 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

Parameter Name Default Value Instance Name Definition Description

Enter the backing tag of the main AOI.

TagName {ObjectName} {TagName} Backing Tag This will serve as the base tag name for other tags in this object
that are derived from the base.

TagDescription {ObjectDescription} {TagDescription} Tag Description of the main AOI backing tag

Ref_RingPointerNode Refer to the section CIP Message Path for complete details

Ref_PointerRingID Refer to the section CIP Message Path for complete details

Switch Cfg 00 to 09 Refer to the section CIP Message Path for complete details

DLR1 Only; Not applicable to DLR1_Lite. Select 56 nodes if there

Nodes 24 Nodes are more than 24 nodes in DLR network.

Linked Libraries

Link Name Catalog Number Revision Solution Category

raC_Opr_NetDLR1 raC_Opr_NetDLR1 12.4 (RA-LIB) Device Network

raC_Opr_NetDLRLite raC_Opr_NetDLRLite 12.4 (RA-LIB) Device Network

Configured HMI Content

HMI Content Instance Name Description

Global Object launch button to 12Node/Lite Faceplate using
Launch Button {ObjectName}_GO_Launch_12Node_FP basic text label.
Global Object launch button to 24 Node Faceplate using basic
Launch Button {ObjectName}_GO_Launch_24Node_FP text label.
Global Object launch button to 56 Node Faceplate using basic
Launch Button {ObjectName}_GO_Launch_56Node_FP text label.

Attachments

Name Description File Name Extraction Path

V12_raC_Dvc_Globall Graphic Symbols ME (raC-12-ME) Graphic Symbols - Network Device.ggfx {ProjectName}\Visualization\FTViewME\GlobalObject
V12_raC_Dvc_DLR1_12Node Faceplate ME (raC-12_xx-ME) raC_Opr_NetDLR1_12Node-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_DLR1_24Node Faceplate ME (raC-12_xx-ME) raC_Opr_NetDLR1_24Node-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays
V12_raC_Dvc_DLR1_56Node Faceplate ME (raC-12_xx-ME) raC_Opr_NetDLR1_56Node-Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 151

Chapter 7 Device Level Ring (raC_Opr_NetDLR1, raC_Opr_NetDLRLite)

V12_raC_Dvc_Globall Graphic Symbols SE (raC-12-ME) Graphic Symbols - Network Device.ggfx {ProjectName}\Visualization\FTViewSE\GlobalObject

V12_raC_Dvc_DLR1_12Node Faceplate SE (raC-12_xx-SE) raC_Opr_NetDLR1_12Node-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Dvc_DLR1_24Node Faceplate SE (raC-12_xx-SE) raC_Opr_NetDLR1_24Node-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Dvc_DLR1_56Node Faceplate SE (raC-12_xx-SE) raC_Opr_NetDLR1_56Node-Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays

V12_raC_Opr_NetDLR View Designer (raC-12_xx-VD) raC_Opr_NetDLR.vpd {ProjectName}\Visualization\ViewDesigner

V12_RM_raC_Dvc_Network Reference Manual DEVICE-RM400B-EN-P.pdf {ProjectName}\Documentation

V12_Network_Images HMI Image Set HMI FactoryTalk® View Images - png.zip {ProjectName}\Visualization\Images
V12_raC_Dvc_Network_Glob Toolbox ME (raC-12-ME) Toolbox - Network Device.ggfx {ProjectName}\Visualization\FTViewME\GlobalObjects
V12_raC_Dvc_Network_Glob Toolbox SE (raC-12-SE) Toolbox - Network Device.ggfx {ProjectName}\Visualization\FTViewSE\GlobalObjects

152 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8

Parallel Redundancy Protocol (raC_Opr_NetPRP)

Overview The Parallel Redundancy Protocol (PRP) device object (raC_Opr_NetPRP)

includes HMI faceplates for PRP networks which displays network
information including:
• PRP Node Table
• PRP Node Diagnostics
• PRP Node Identity

The raC_Opr_NetPRP object can be used for PRP networks containing up to

240 nodes.
In the Library there is a folder named Videos which contains many How-To and
Operational Overview Videos which walk step-by-step through each process. You
can refer to the following videos for this section:
“Operational Overview of PRP Object Faceplates”

Functional Description The PRP Network objects:

• Collects and processes data from one of the PRP network devices (1756-
EN2TP, 1756-EN4TR, 5094-AEN2TR, Stratix switch)
• Provides diagnostic data for PRP Node tables, streamlining network
maintenance and minimizing network downtime.

All these features provide quick feedback, shorten recovery time, and simplify
implementation.

Required Files Device Objects include Add-On Instructions (AOIs) and HMI faceplates. The
revision number (e.g. 1.01) used in filenames can change as new revisions are
created.

Controller Files
Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

The Add-On Instruction must be imported into the controller project to be

used in the controller configuration. These can be imported as Add-On

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 153

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Instruction files, or as part of the Rung Import or Import Library Objects

wizard.

All Add-On Instruction and Rung Import files can be found in the /Studio 5000
Logix Designer Files - L5X/ folder in the library.

Compatible
Object Add-On Instruction Rung Import
Network Configuration
PRP Node Table applicable with
1756-EN2TP, 1756-EN4TR,
raC_Opr_NetPRP raC_Opr_NetPRP_12.04_AOI.L5X raC_Opr_NetPRP_12.04_RUNG.L5X
5094-AEN2TR And maximum 240
PRP Nodes

FactoryTalk® View HMI Files

FactoryTalk® View ME and FactoryTalk® View SE applications require

importing the desired device faceplates in addition to all Global Object (ggfx)
files and all images located in the /HMI FactoryTalk® View Images - png/ folder of
the library. FactoryTalk® View ME files are stored in the /HMI - FactoryTalk®
View ME/ library folder and FactoryTalk® View SE files are stored in the /HMI -
FactoryTalk® View SE/ library folder.

FactoryTalk® View ME FactoryTalk® View SE

Device/Item Type Faceplate Faceplate
raC_Opr_NetPRP Display (raC-12_04-ME) raC_Opr_NetPRP-Faceplate.gfx (raC-12_04-SE) raC_Opr_NetPRP-Faceplate.gfx
Graphic Symbols Global Object (raC-12-ME) Graphic Symbols - Network Device (raC-12-SE) Graphic Symbols - Network Device
Toolbox Global Object (raC-12-ME) Toolbox -Network Device.ggfx (raC-12-SE) Toolbox -Network Device.ggfx

Studio 5000 View Designer® HMI Files

All Studio 5000 View Designer® Files can be found in the /HMI - ViewDesigner -
vpd/ folder of the library.

Device/Item Studio 5000 View Designer® Faceplate

Network Objects (raC-12_04-VD) raC_Opr_NetPRP_FP.vpd

FactoryTalk® Optix Library Files

FactoryTalk® View Optix applications require importing the desired library

objects located in the NetworkDevice_v12R library folder.

Device/Item FactoryTalk® Optix Library Object

PRP Network Object raC_12_04_raC_Opr_NetPRP_UI

154 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Studio 5000® Application Code Manager Files

Studio 5000® Application Code Manager (ACM) can be optionally used if it is
installed. All devices can be easily registered in the ACM repositories by
running the setup.cmd file located in the root folder of the library.

Individual HSL4 files are provided as an alternative to running the setup.cmd

to allow users to manually register specific implementation objects. Each
object has two files - an Asset Control file and a Device file. The Asset Control
files include attachments of all required files for that object. The Device files
are used to actually add that device into a Studio 5000® project and these
reference the Asset Control files.

All Studio 5000® Application Code Manager files can be found in the /
ApplicationCodeManagerLibraries/ folder of the library. The files included are as
follows:

Implementatio Asset Control File (.HSL4) Device File (.HSL4)

n Object
PRP (RA-LIB)_Device_Asset-Control_Network_raC_Opr_NetPRP_(12.04) (RA-LIB)_Device_Device_Network_raC_LD_Opr_NetPRP (12.04)

Operations The Network Device objects provide only physical operation mode. There is no
virtual device mode offered.

Execution
The following table explains the handling of instruction execution conditions.

Condition Description
Processing for EnableIn False (false rung) is handled the same as if the device
EnableIn False (false rung) were taken out of service by Command. The device outputs are de-energized and
the device is shown as Program Out of Service on the HMI. All alarms are cleared.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 155

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Add-On Instruction I/O Data InOut Data

InOut Function / Description DataType

Ref_Module Reference Module MODULE

Message used to read vendor specific

Ref_MsgGetSgl MESSAGE
attributes.

Message used to read vendor specific

Ref_MsgGetAll MESSAGE
attributes.

Message used to read Member

Ref_MsgGetMember MESSAGE
Information vendor specific attributes.

Message used to read vendor specific

Ref_MsgGetSglNode MESSAGE
attributes.

Message used to read vendor specific

Ref_MsgGetAllNode MESSAGE
attributes.

Ref_MsgData Message Destination Address. SINT[503]

Input Data
Input Function/Description DataType
EnableIn Enable Input - System Defined Parameter BOOL

Inp_Enable Enable AOI functions. 1 = enabled. BOOL

Status and diagnostic information cycle update in second.

Set_SampleInterval DINT
Default Value - 8 sec.

Set_SampleInterval value as per the total node count in the PRP Network. Tested
with Set_SampleInterval value 6 sec. for 56 nodes in 100ms Periodic Task. (The
Set_Sample Interval value depend on Periodic Task where AOI rung imported &
Total no. of node count)

Output Data
Output Function/Descritpion DataType
EnableOut Enable Output - System Defined Parameter BOOL

Sts_EN AOI Enabled Status; 1 = enabled BOOL

Sts_ER Message error bit; 1= Error BOOL

Sts_Connected Device is connected to the Programmable BOOL

Controller
Sts_Available Connected and in the PRP Topology BOOL

Sts_Faulted Device faulted status: 1 = LAN A or LAN B not BOOL

OK
Val_MejorRevision Mejor revision of Device SINT

Val_MinorRevision Minor revision of Device SINT

Val_ProductCode Product Code INT

Val_TotalIPDevices Total Non-zero (0.0.0.0) IP Address DINT

Nodes after filter.

156 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Output Function/Descritpion DataType

Val_WarningCountLanA Warning Count LAN A DINT

Val_WarningCountLanB Warning Count LAN B DINT

Val_WarningLanA 1 = Warning on LAN A SINT

Val_WarningLanB 1 = Warning on LAN B SINT

Val_DeviceType 12=Communication Adapter, 14=Progammable INT

Controller, 44=Switch, 24=HMI, 7=Discrete I/O,
Val_MsgErr CIP Message Error Indicatior SINT

Val_TotalDevices Total node count in PRP Table DINT

Sts_StratixNode 1 = Connected reference module is Stratix BOOL

Switch
Val_NodeType 0=Deprecated (PRP Mode 0), 1=PRP Mode 1, INT
2=HSR Mode, 3-65535=Reserved for Future

Data Types A number of User-Defined Datatypes (UDT) are used in the Network Device
Library. A full list of the UDTs used with the raC_Opr_NetPRP and object
follows:
User Defined Datatype Description
raC_UDT_DLRMAC Raw MAC
raC_UDT_PRPDuplicateDetectCounter LRE Duplicate detection counters
raC_UDT_PRPInterfaceCounter LRE Interface counters
raC_UDT_PRPNodeTableHMI PRP Node Table Member Information

Add-On Instructions A number of embedded Add-On Instructions (AOI) are used within the
raC_Opr_NetPRP instruction. These are used to convert between datatypes
and generate values which can be read from the HMI faceplate. The following
AOIs are included:

User Defined Datatype Revision Description

Converts numerical IP address into user-
raC_Tec_IPMACtoString 1.01 readable string
Converts numerical IP address into user-
raC_Tec_IPtoString_NET 12.02 readable string
raC_Tec_MsgPathFormation 1.00 Provide Appropriate message path
Get Members Service (0x18) for PRP Object
raC_Tec_GetMembersPRP 1.02 (0x57) Instance attributes 2&3
raC_Tec_DecToHex 12.02 Converts Decimal number to Hexadecimal String

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 157

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Programming Example Fully configured device on a rung is provided below for reference.

Note that this programming example is the same code that is imported when
either importing the supplied rung .L5X files or when using Application Code
Manager or the Studio 5000® Import Library Objects wizard plug-in.

In this example DAN_Local is the name of a PRP enabled module such as a 1756-
EN2TP communications adapter.

Graphic Symbols Graphic Symbols are used as launch buttons within HMI applications to open
up faceplate displays. See Basic Launch Button Attributes section for details on
configuration and indicators.

FactoryTalk® View ME/SE Graphic Symbols

Graphic Symbol Name Graphic Symbol Description Global Object Parameter Values

Faceplate navigation button with string tag label. #102: AOI Backing Tag Instance (e.g.
This launch button graphic object allows the {::[PAC]._InstanceName})
GO_LaunchFP user to navigate to the device object faceplate. #104: Navigation Button Label
The text on the button face is set to the #120: Display’s left position (e.g. 100) (optional)
parameter #104. #121: Display’s top position (e.g. 100) (optional)

Studio 5000 View Designer® Graphic Symbols

Graphic Symbol Name Graphic Symbol Description Property Configuration

Navigate to NetPRP
btn_nav_raC_Opr_NetPRP_FP Faceplate Pop-Up
Screen

Text displayed in the launch buttons can be modified from the Properties tab
using the General > Text parameter.

158 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

FactoryTalk® Optix Graphic Symbols

Graphic Symbols are used as launch buttons within HMI applications to open
up faceplate displays. All graphical symbols for Network Devices display the
following information:
• - Device label (Tag.@Description or custom label )
• - Device Warning/Fault Indication
• - AOI Enable/Disable
• - Device bad communication

See Basic Launch Button Attributes section for more general information on
launch button diagnostics and usage.

Once the Objects have been imported into the FactoryTalk® Optix Studio
project, you can begin using them in your application. To add a new Launch
Button to a Main window, navigate to raC_Dvc_ObjectName > Graphic
Symbols > Dvc ObjectName Text Button to insert a navigation launch button
with a text label.

After placing the graphic symbol on a UI panel, link the “Ref_Tag” property to
the targeted Asset under Asset tag.

Text label shown on button can be configured using “cfg_Label” property, If it

is not configured then description of the asset will be shown on the button
face.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 159

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

This is the only step needed to link the UI to the asset data model. For more
information on graphic symbols, refer to the Graphic Symbols section of the
Network device type in this manual.
Graphic Symbol Name Graphic Symbol Description Property Configuration
Cfg_CloseCurrentDisplay: Set to ‘True’
to close the previously open display
when launching the object faceplate

Cfg_DisplayType: Faceplate to be
Faceplate navigation button. Use Cfg_Label Variable to opened on button click. This should
raC_12_xx_raC_Dvc_Devicename_GS_N not be modified.
avText modify the button label text.
Ref_Tag: Object’s Add-On Instruction
Tag

Cfg_Label: Text label shown on the

button face

160 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Graphic Symbol Button Configuration Variables

Variable Name Description Default Value

Cfg_CloseCurrentDisplay Set to ‘True’ to close the previously open display when launching the object faceplate False
Cfg_DisplayType Faceplate to be opened on button click. This should not be modified. Faceplate
Ref_Tag Link to instance of desired target Asset model found in Model > Asset folder. N/A - User must configure
Text label shown on the button face. Defaults to the description of the asset but users may
Cfg_Label ../Ref_Tag@Description
replace in instances with other desired text.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 22.

In this document, the faceplate pictures (or snapshots) shows the information
of PRP node table of PRP Network.

Faceplate Navigation

• The Home tab provides PRP Node table information of (MAC Address,
IP Address, Active Port A, Active Port B, and Node type).
• The Diagnostic tab provides various types of counts for Port A & Port B
which used to analysis PRP Network of that node. Also provides the
node identity of that node.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 161

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Home
The Home screen is visible when the Home tab button is selected on the left
side of the screen. Within the “Home Tab”, you will find information on the
PRP Node table, including total node count and a node table of all active nodes.
The PRP Node table details contains MAC Address, IP Address, Active Port A
status, Active Port B status, and Node type.

An active (blue) LED indicates the node’s Port A and/or Port B connection
status. An inactive (gray) LED indicates that there is no connection on the
respective port. The node type is set to one of the following types:
• DAN: Double attached node. An end device with PRP technology that
connects to both LAN A and LAN B.
• SAN: Single attached node. An end device without PRP technology that
connects to either LAN A or LAN B. A SAN does not have PRP
redundancy.
• RedBox: Redundancy box. A switch with PRP technology that connects
devices without PRP technology to both LAN A and LAN B.
• VDAN: Virtual double attached node. An end device without PRP
technology that connects to both LAN A and LAN B through a RedBox. A
VDAN has PRP redundancy and appears to other nodes in the network
as a DAN.

162 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Use the page navigation buttons to view other nodes.

Enable the filter button to filter and display only non-zero (0.0.0.0) IP Address
Nodes.

If you select an any filtered IP Address row it will navigate to second tab and
displays the Detailed node diagnostic data of that PRP Node.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 163

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

You can also navigate the other IP Address node information from here by using
next or previous arrow button below the Diagnostic of Node table. This is visible
only if the filter is applied.

164 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Diagnostic Tab
Within the “Diagnostic tab” you will find a detailed node diagnostic data of the
selected node. If the filter is not enabled on the home tab, this will link directly
to the reference module assigned to the Add-On Instruction’s Ref_Module tag.
Users can easily monitor the Network status, Network fault count, Transit &
receive count, Wrong LAN Count, Unique entry Count, Duplicate entry count
and multiple entry count of PORT A & PORT B to diagnose the PRP network.

The diagnostic tab also allows user to display information of node identity.
Click the Node Identity button to display the node associated identity
parameters catalog number, mac address, IP address, vendor, device type,
product code, serial number, firmware revision.

Click the Node Diagnostic button to return to the previous page.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 165

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Warning Information
The faceplate also provides a series of warnings, here are few examples:

Faceplate Displays rely on the information provided by the Add-On

Instruction.
• If the Add-On Instruction operation is disabled by the user, then an
“AOI Not Enabled” warning message is shown and all faceplate
operations will be suspended.

166 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

• If the Add-On Instruction message to the Reference module node failed

it will display the “Add-On Instruction message to the PRP Node failed”
message on all tabs.

• In the Home Tab if you click on filtered IP address row and the AOI
Message failed, it will display the “PRP diagnostic data is not available
for this node” message on Diagnostic tab.

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 167

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

• If the connected PRP Network has PRP Node table count more than
240, it will display the warning message “The connected network
exceeded recommended limit of 240 nodes” in bottom right home tab.

• If the AOI Reference module connected to Stratix Switch it will display

the warning message “PRP Node table data is not available for this
module” on home tab.

168 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Application Code Manager Network Device Library objects can be set-up and configured using Studio
5000® Application Code Manager.

Refer to the section Using Application Code Manager for complete details.

Definition Objects: raC_Opr_NetPRP

This Asset-Control object contains the Add-On Instruction definition and

required data types. It is used as a linked library to the device implement
object. This gives users the flexibility to choose to instantiate only definition
and create custom implement code. A user may also create their own
implement library and link with this definition library object.

Implementation Objects: raC_LD_Opr_NetPRP

The Device Implementation Object is the rung that is instantiated when
generating controller code using Application Code Manager. This
implementation object includes a reference to the Asset-Control Add-On
Instruction definition, along with any required controller tags, programs,
modules, and HMI objects.

The PRP implementation has the following configuration parameters.

Parameter Name Default Value Instance Name Definition Description

Enter Routine name. Routine will be created and Object

implement rung(s) inserted.
A JSR will be inserted in MainRoutine.
RoutineName {ObjectName} {RoutineName} Routine If routine name already exists, then object will be inserted into
existing routine.
By default, parameter is set to Object Name.

Enter the backing tag of the main AOI.

TagName {ObjectName} {TagName} Backing Tag This will serve as the base tag name for other tags in this object
that are derived from the base.

TagDescription {ObjectDescription} {TagDescription} Tag Description of the main AOI backing tag

Linked Libraries

Link Name Catalog Number Revision Solution Category

raC_Opr_NetPRP raC_Opr_NetPRP 12.03 (RA-LIB) Device Network

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 169

Chapter 8 Parallel Redundancy Protocol (raC_Opr_NetPRP)

Configured HMI Content

HMI Content Instance Name Description

Launch Button {ObjectName}_GO_LaunchFP_Text Global Object launch button using basic text label.

Attachments

Name Description File Name Extraction Path

V12_Network_Images Images HMI Factory Talk View Images - png.zip {ProjectName}\Visualization\Images
V12_raC_Dvc_Network_Global Graphic Symbols ME (raC-12-ME) Graphic Symbols - Network Device.ggfx {ProjectName}\Visualization\FTViewME\GlobalObjects
V12_raC_Dvc_Network_Global Toolbox ME (raC-12-ME) Toolbox - Network Device.ggfx {ProjectName}\Visualization\FTViewME\GlobalObjects
V12_raC_Dvc_Network_Global Toolbox SE (raC-12-SE) Toolbox - Network Device.ggfx {ProjectName}\Visualization\FTViewSE\GlobalObjects
V12_raC_Dvc_Network_Global Graphic Symbols SE (raC-12-SE) Graphic Symbols - Network Device.ggfx {ProjectName}\Visualization\FTViewSE\GlobalObjects
RM_raC_Dvc_Network Reference Manual DEVICE-RM400B-EN-P.pdf {ProjectName}\Documentation
V12_raC_Opr_NetPRP Faceplate SE (raC-12_XX-SE) raC_Opr_NetPRP- Faceplate.gfx {ProjectName}\Visualization\FTViewSE\Displays
V12_raC_Opr_NetPRP Faceplate ME (raC-12_XX-ME) raC_Opr_NetPRP- Faceplate.gfx {ProjectName}\Visualization\FTViewME\Displays

V12_raC_Opr_NetPRP View Designer (raC-12_xx-VD) raC_Opr_NetPRP_FP.vpd {ProjectName}\Visualization\ViewDesigner

170 Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024

 Rockwell Automation Network Device Library Reference Manual

Rockwell Automation Publication DEVICE-RM400D-EN-P - October 2024 171

Rockwell Automation Support
Use these resources to access support information.
Find help with how-to videos, FAQs, chat, user forums, Knowledgebase, and product
Technical Support Center rok.auto/support
notification updates.
Local Technical Support Phone Numbers Locate the telephone number for your country. rok.auto/phonesupport
Quickly access and download technical specifications, installation instructions, and user
Technical Documentation Center rok.auto/techdocs
manuals.
Literature Library Find installation instructions, manuals, brochures, and technical data publications. rok.auto/literature
Product Compatibility and Download Center Download firmware, associated files (such as AOP, EDS, and DTM), and access product rok.auto/pcdc
(PCDC) release notes.

Documentation Feedback
Your comments help us serve your documentation needs better. If you have any suggestions on how to improve our content, complete the
form at rok.auto/docfeedback.

Waste Electrical and Electronic Equipment (WEEE)

At the end of life, this equipment should be collected separately from any unsorted municipal waste.

Rockwell Automation maintains current product environmental compliance information on its website at rok.auto/pec.

Allen-Bradley, ArmorStart, CompactLogix, ControlLogix, FactoryTalk, Integrated Architecture, iTRAK, Kinetix, Logix 5000, MagneMotion, PlantPAx, PowerFlex, RSLinx, RSLogix, RSLogix 5000,
SoftLogix, Stratix, Studio 5000, Studio 5000 Logix Designer, TechConnect, Rockwell Automation, and Rockwell Software are trademarks of Rockwell Automation, Inc.
EtherNet/IP is a trademark of ODVA, Inc.
Microsoft and Windows are trademarks of Microsoft.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Rockwell Otomasyon Ticaret A.Ş. Kar Plaza İş Merkezi E Blok Kat:6 34752, İçerenkÖy, İstanbul, Tel: +90 (216) 5698400 EEE YÖnetmeliğine Uygundur

Publication DEVICE-RM400D-EN-P - October 2024

DEVICE-RM400C-EN-P - July 2024 Copyright © 2024 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.