Allen-Bradley RapidLaunch User Manual

RapidLaunch
User Manual
Original Instructions
RapidLaunch User 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 AUTO-UM001B-EN-P - March 2024
Table of Contents
Preface
About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Summary of Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Hardware Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Software Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Library Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Studio 5000 Logix Designer Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Download Firmware, AOP, EDS, and Other Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 1
RapidLaunch Controls Solution
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
RapidLaunch HMI Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Classification Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ModeControl Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Mode Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Control Voltage Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Release Inputs Fault Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
HMI Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Mode Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Generate DeviceID Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Controls Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Area Level Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Cell Level Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Station Level Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Controller Application Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Control Level Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Area Program Main Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Area ModeControl Routine (Area<x>_Main) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
ModeControl Object Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
RapidLaunch General Device Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Configure Device Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Main Mode and Local Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Device Interlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Chapter 2
Develop a RapidLaunch
Application with Application
Code Manager
Overview of Application Code Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Set Up RapidLaunch Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Register RapidLaunch and Supplementary Libraries . . . . . . . . . . . . . . . . . . . . . . . . 31
Create a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Add Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Add Displays to the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
3
Table of Contents
Add and Configure Library Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
raD_RapidLaunchBase Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Create raD_RapidLaunchBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Create ModeMain Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Create ModeSub and Device Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Generate ACM Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Extract Attachments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Generate Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Generate Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Import Visualization Collateral into FactoryTalk View Studio . . . . . . . . . . . . . . . . . 41
Import Configured Displays into FactoryTalk View Studio. . . . . . . . . . . . . . . . . . . . 45
Chapter 3
HMI Framework
Display Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Main Screen Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Area1_Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Area1_Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Global Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Faceplate Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
HMI Tags in FactoryTalk View SE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
(raD-n-SE) Template Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
(raD-n-SE) Template Display L1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
(raD-n-SE) Template Display L2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
(raD-n-SE) Template Display L2 No L3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
(raD-n-SE) Template Display L3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
(raD-n-SE) Navigation Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Navigation Bar Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
(raD-n-SE) Graphic Symbols - Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ModeControl and Screen Navigation Global Objects . . . . . . . . . . . . . . . . . . . . . . . . . 60
Mode Selection Global Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Graphical State Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Display Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Navigation Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
FactoryTalk Alarm and Events Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Animated Alarm Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Group Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Group Control Device Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Chapter 4
Alarm and Diagnostic Handling
4
Alarm and Diagnostic Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Diagnostic Bitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Tag-based Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Tag-based Alarm Message Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Fault Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Disable Faults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Production-relevant Fault Masks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Fault Reaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Table of Contents
Chapter 5
Manual Operation
Concept of Device Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Configure Device Manual Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Configure HMI Manual Control Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Manual Control Text Tag and Data Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Text Entry and Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
HMI Manual Control Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Chapter 6
Automatic Operation
Functional Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Home Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Cycle Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Program Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Chapter 7
Sequence Control
Sequence Control in Ladder Diagram (LD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Ladder Diagram Sequences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
raD_Opr_SeqCtrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
raD_Opr_SeqRungEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
raD_Opr_SeqRungNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
End Sub-sequence Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Sequence Control in Sequential Function Chart (SFC) . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
SFC to Structure Application Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
SFC to Provide Application Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Steps and Transitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Actions and Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
End the SFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
SFC Text Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Reset SFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Pause SFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
SFC Cycle Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Appendix A
Troubleshooting
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
RapidLaunch Code Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Trace the Fault Source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Observe the raD_Opr_ModeMain Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Investigate which Cell Generated or Forwarded the Fault. . . . . . . . . . . . . . . . . . . 105
Investigate which Station Generated or Forwarded the Fault. . . . . . . . . . . . . . . . 106
Investigate which Device on the Level Generated this Fault. . . . . . . . . . . . . . . . . 107
Get the Program to Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
5
Table of Contents
Appendix B
Naming Conventions
Program Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Programs for the RapidLaunch Framework. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Programs for Third-party Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Routine Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Routines in the RapidLaunch Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Routines for Third-party Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Tag Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Device Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Sequence Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Appendix C
Configure FactoryTalk View SE
Security Groups
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Security Groups by Span of Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Appendix D
Set Up a New ACM Database
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Appendix E
Import an ACM Project
6
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Preface
About This Publication
The purpose of this document is to give you an understanding of the general concepts behind
the RapidLaunch standard, and how to develop a RapidLaunch application.
This document covers these areas:
• Control hierarchy
• Diagnostic concepts
• Manual operation
• Automatic operation
• HMI interface
• Application Code Manager implementation
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
Added Hardware Prerequisites.
Page
7
Hardware Prerequisites
RapidLaunch is compatible with these controllers:
• ControlLogix® 5580 and GuardLogix® 5580 controllers, firmware revision 35.011 or later
• CompactLogix™ 5380 and Compact GuardLogix 5380 controllers, firmware revision
35.011 or later
Software Prerequisites
This document assumes that you have good knowledge with these programming packages
and the functionality that is associated with them:
• Studio 5000 Logix Designer® version 35.00.00 or later
• FactoryTalk® View SE version 13 or later
• Application Code Manager version 4.03 or later
• FactoryTalk Logix Echo version 2.01.00 or later
Library Prerequisites
The following libraries are recommended for use with RapidLaunch. You can also use
additional libraries to meet your application needs.
• Machine Builder Library
• Power Device Library
• I/O Device Library
• Safety Device Library
On the Product Compatibility and Download Center (PCDC), download the latest versions of
these libraries.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
7
Preface
Studio 5000 Logix Designer
Settings
You can configure the appearance and functionality of the Studio 5000 Logix Designer
application for use with RapidLaunch. See Table 1 for recommended settings.
Table 1 - Recommended Studio 5000 Logix Designer Settings for RapidLaunch Applications
Location
Tab
Edit > Controller Properties
Project
Tools > Options
Verification
Tools > Options
Ladder Editor > Display
Setting
Download Firmware, AOP,
EDS, and Other Files
Download firmware, associated files (such as AOP, EDS, and DTM), and access product release
notes from the Product Compatibility and Download Center at Product Compatibility and
Download Center (PCDC).
Additional Resources
These documents contain additional information concerning related products from Rockwell
Automation. You can view or download publications at rok.auto/literature.
Resource
RapidLaunch Library Reference Manual, publication AUTO-RM001
Logix 5000 Controllers Add-On Instructions Programming Manual,
publication 1756-PM010
Logix 5000 Controllers Common Procedures Programming Manual,
publication 1756-PM001.
Application Code Manager User Manual, publication LOGIX-UM003
FactoryTalk Logix Echo Getting Results Guide, publication 9310-GR001
FactoryTalk® Optix™ Portfolio Technical Documentation
FactoryTalk View Site Edition Installation Guide, publication VIEWSE-IN003
FactoryTalk View Site Edition User's Guide, publication VIEWSE-UM006
RapidLaunch Support
8
Description
Provides information on RapidLaunch Add-On Instructions, Objects, and Data Types.
Provides information on how to design, create, and use Add-On Instructions for the Logix
Designer application.
Provides links to a collection of programming manuals that describe how you can use
procedures that are common to all Logix 5000® controller projects.
Provides information on how to use Studio 5000 Application Code Manager.
Provides information on how to use FactoryTalk Logix Echo.
Provides help on how to use FactoryTalk® Optix Studio™.
Provides information on how to install FactoryTalk View Site Edition.
Provides information on how to use FactoryTalk View Site Edition.
[email protected]
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
1
RapidLaunch Controls Solution
Overview
RapidLaunch is a controls specification solution for the Automotive industry. RapidLaunch
provides a proven approach to connect Device objects to complex equipment modules and
complete control systems. This approach allows OEMs and line builders to integrate autogenerated programs using Studio 5000® Application Code Manager and to modify programs in
the Studio 5000 Logix Designer® application.
The RapidLaunch library can interface with customer-specific application logic, other
Rockwell Automation libraries, and servers as the foundation of an automotive project.
Example applications that are primary targets for RapidLaunch include Manual and Automatic
Workstations, Transfer Conveyors, Turn Tables, Gantry Systems, and Virtual Drop Lifts.
Our scalable controls solution provides you with the flexibility to help provide faster launches
and reduce operational and maintenance costs, while helping to reduce risks. This solution
includes an HMI Framework, Code Libraries, Documentation, Design Guidelines, and Support.
RapidLaunch includes of a set of library objects that provide:
• A basic framework to interconnect applications and equipment.
• An application hierarchy from 1 to n application layers.
• Equipment integration into the application layer.
• A base equipment library.
• Interfaces for extension libraries and customer application code.
The implementation of RapidLaunch leads to:
• Faster application development.
• Standardized code.
• Easy application and equipment maintenance.
Figure 1 shows the base concept of the RapidLaunch structure. The blue elements, provided by
Rockwell Automation, provide the application framework and equipment functionality. You can
add third-party libraries and application code within the gray elements.
Figure 1 - RapidLaunch Structure
This guideline covers these aspects of the RapidLaunch structure:
• Define the control hierarchy (Area/Cell/Station).
• Add equipment (such as motors, valves, and other devices).
• Build controller and Human Machine Interface (HMI) applications.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
9
Chapter 1
RapidLaunch Controls Solution
RapidLaunch HMI Solution
The RapidLaunch HMI solution provides a framework and pre-developed content for:
• HMI displays and navigation.
• Alarm annunciation and logging.
• Graphic symbols for object status and faceplate launch.
• Faceplates for Device control, configuration, and diagnostics.
• Flexible manual control solutions.
• Language switching.
• User security and line-of-sight control.
Figure 2 - Example HMI Display
10
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
Classification Layers
RapidLaunch Controls Solution
Operational control objects create control hierarchy and manage operation mode and cycle.
These objects include the ModeControl objects, which determine operation mode, cycle, and
system status, and communicate that information to child objects.
Device objects connect a specific device to the system. These objects provide the command
interface for device activities, specific diagnostics, and alarms for the device, and even the
simulation of the device when virtualized. Examples are Roller Beds or 2-Position Motors,
which have commands for forward and reverse, among other device-specific activities.
Interface objects connect a RapidLaunch Device object to other library objects. For instance,
motor Device objects can communicate with Power Device Library objects via an interface
object. This allows for the outputs from the Device object to command the library object, and
feed diagnostics from the library object back to the RapidLaunch Device object.
Figure 3 - Example of Interface Object Connecting Device Object to Other Library Objects
Technology objects perform specific algorithms, calculations, or functions. This includes
third-party interfaces, such as robots.
Equipment objects are built out of one or many Device objects via Studio 5000 Application
Code Manager to represent a functional piece of equipment in the application. An example
would be a Turn Table, which is composed of:
• Multi-Position Motor + VFD Interface + VFD (Power Device Library)
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
11
Chapter 1
RapidLaunch Controls Solution
ModeControl Objects
ModeControl objects own and maintain the LocalBus of the corresponding hierarchical level
and supply feedback to the next higher level with the HostBus. They are also the linking
method to make sure that data flows seamlessly throughout the entire system hierarchy.
These objects have interfaces that allow:
• Mode changes to be made by HMI or physical push buttons.
• Configuration inputs.
• System-level enable and suppression inputs.
Some of these features are explained in the following chapters. For more information on
ModeControl, see the RapidLaunch Library Reference Manual, publication AUTO-RM001.
Mode Inputs
All ModeControl objects provide various button inputs (Cmd_ inputs) for:
• Operation mode and Sequence selection.
• Stop End of Cycle and Step By Step selection.
Figure 4 - ModeControl Object Cmd_ Input Examples
12
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
If necessary, these inputs are programmed in parallel branches immediately preceding the call
of the ModeControl object.
Figure 5 - Example of Programming Input Parameters for an Area-level ModeControl Object
ModeControl objects are mandatory for every control level, but the configuration of the Cmd_
inputs is optional. If desired, configuring the Cmd_ inputs to the Area-level ModeControl object
would be sufficient to control all linked control levels.
However, in practical usage, different mode decisions must be made on various levels, and
mode inputs must also be configured on different levels. If there is a conflict, the lower (more
specific) level overwrites the higher (more general) level.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
13
Chapter 1
RapidLaunch Controls Solution
Control Voltage Inputs
The output for the control voltage relay is controlled by the rising edge of the two inputs
Cmd_CtrlVoltageOn and Cmd_CtrlVoltageOff.
The Out_CtrlVoltage output should be used as a condition, in addition to others as needed, to
trigger the Inp_RelInputs input as shown in Figure 6. This helps to ensure that messages and
faults are suppressed if the Control Voltage is off.
Release Inputs Fault Filter
The ModeControl object has a input called Inp_RelInputs. This input is available at each mode
control level. Once Inp_RelInputs is TRUE, all Add-On Instructions that are configured under this
level in the hierarchy are enabled to announce their faults in the Alarm and Events server.
When Inp_RelInputs is FALSE, only the faults from the ModeControl level itself are annunciated/
registered to the alarm server. All other faulted RapidLaunch object messages are suppressed
on the levels below in the hierarchy to avoid an overflow of unnecessary messages on the HMI.
Figure 6 - Example of Suppressing Other Fault Messages, Only Current Fault Message Displayed
When Inp_RelInputs is FALSE, all faults on levels below are suppressed. Under this
condition, any faults that you want to display on the HMI must be a fault input to
the ModeControl object (Inp_bSafetyFaults, Inp_bStaticFaults), or programmed
separately as a Tag-based Alarm.
For more information, see the Mode Control chapter in the RapidLaunch Library Reference
Manual, publication AUTO-RM001A.
14
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
HMI Interface
You can initiate mode requests from the HMI. The ModeControl objects have a dedicated input
word Inp_bHMICmd with these bit definitions:
Figure 7 - Inp_bHMICmd Examples
Inp_bHMICmd is defined as a local tag in the Add-On Instruction and can only be
accessed by the HMI application.
For more information, see the Mode Control chapter in the RapidLaunch Library
Reference Manual, publication AUTO-RM001A.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
15
Chapter 1
RapidLaunch Controls Solution
Mode Outputs
The ModeControl objects provide various control, lamp, and diagnostic outputs:
• Sts_ outputs are used for diagnostic purposes and indicate the current mode on the
LocalBus. These are solid signals and can be used within the program if needed.
• Out_Lamp outputs are used for stack lights or illuminated push buttons. They can flash,
based on the system condition. For example, the Out_LampCycleActive output flashes
when Automatic mode is selected but not started, however it becomes constantly TRUE
when Automatic mode is selected AND running. These outputs are only a visual
indicator (lamps) and should not be used for further programming purposes.
Figure 8 - Mode Output Example
For more information, see the Mode Control chapter in the RapidLaunch Library Reference
Manual, publication AUTO-RM001A.
16
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
Generate DeviceID Numbers
Some functions within RapidLaunch, such as data tracking, depend on DeviceID numbers.
DeviceID numbers must be generated after the addition of new devices or equipment objects.
Figure 9 shows an example rung for DeviceID number generation that is included in the
Area1Main routine.
The raD_Opr_ModeMain object has a dedicated input Cmd_GenerateDvcID to trigger this
functionality. Even though this input is programmed inside the raD_Opr_ModeMain object to
react on the rising edge, it is good practice to add a one shot to the rung to reflect this
behavior.
Figure 9 - Example of DeviceID Number Generation
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
17
Chapter 1
RapidLaunch Controls Solution
Controls Hierarchy
RapidLaunch provides a mode control segmentation strategy that allows you to align your
controller application to the physical application requirements. There are different levels for
control that reflect mode, safety, and controller-level control requirements.
By default, RapidLaunch uses three control levels: Area, Cell and Station. However, more or
fewer control levels are also possible.
Devices like robots, roller beds, and valves can reside in any of these levels. You can program
these devices with Add-On Instructions that are provided by Rockwell Automation, or a
compatible third-party.
The control hierarchy is formed through the configuration of ModeControl objects, where each
Add-On Instruction represents a separate but connected control level. Each Add-On Instruction
has a DeviceBus parameter (HostBus or LocalBus) that is used to link different levels together.
Figure 10 shows how a hierarchy from an Area ModeControl, to a Station ModeControl with
hardware devices, is linked or configured.
IMPORTANT
The HostBus and LocalBus parameters of each ModeControl object are
configured with the proper bus tag to achieve the appropriate parentchild relationship, see Figure 10.
Figure 10 - Controls Hierarchy
18
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
Area Level Control
The Area level is the most prominent level in the hierarchy. Any device that belongs to this level
directly influences the behavior of the devices that belong to all Cells and Stations in lower
levels of the hierarchy.
Figure 11 - Area Level Control
Cell Level Control
The Cell level is the second most prominent level in the hierarchy. Any device that belongs to
this level directly influences the behavior of the devices that belong to the Stations (or even
lower levels of hierarchy based on the application).
Usually, this level includes all devices that share the same functional safety reaction.
Figure 12 - Cell Level Control
IMPORTANT
A faulted device in Cell 01 does not affect the devices in other Cells and
their respective Stations and devices.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
19
Chapter 1
RapidLaunch Controls Solution
Station Level Control
The Station level is the third most prominent level in the hierarchy. Any device that belongs to
this level only influences the behavior of the devices that belong to this same Station.
Usually, this level includes all devices that share the lowest operation mode. However,
additional levels can be created if necessary, by creating a ModeControl object and connecting
its HostBus to the Station ModeControl.
Figure 13 - Station Level Control
IMPORTANT
20
A faulted device in Station 100 does not affect the devices in other
Stations.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
Controller Application Structure
A control system can be composed of one or more controllers. Each controller can have one or
more HMIs. Controllers are connected via EtherNet/IP™ and communicate via
Produced/Consumed tags.
In the Studio 5000 Logix Designer application:
• Every level (Area/Cell/Station) is managed in the controller by using different programs
within the MainTask.
• Each program has a MainRoutine, which calls all devices and equipment routines for
this level.
Figure 14 - Controller Code Structure Example for Figure 13 on page 20
Figure 15 - Sample Project Generated from Application Code Manager
You can control each program independently with individual ModeControls (Automatic Mode,
Manual Mode, Home Cycle, Custom Cycle). You can have multiple Cells and Stations in your
application, and each level has its own ModeControl object.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
21
Chapter 1
RapidLaunch Controls Solution
Control Level Definition
While Figure 14 on page 21 shows a logical organization of the controller program, the
functional definition of the different control levels is done by ModeControl objects.
The top level of the system uses the raD_Opr_ModeMain object, while all subsequent mode
controls use the raD_Opr_ModeSub object:
• raD_Opr_ModeMain: On the Area level
• raD_Opr_ModeSub: On any sublevel (Cell or Station)
IMPORTANT
It is possible to have more than one raD_Opr_ModeMain object in a
controller. This results in two separate systems that do not share any
data on the DeviceBus.
To create a system hierarchy, there must be a ModeControl object for every level. These
objects are configured in the <ControlLevel>_Main subroutines. For more information, see
Naming Conventions on page 109
Table 2 - ModeControl Hierarchy Example
Level
Area
Cell
Station
Program
Area1
Cell01
Cell01Sta100
ModeControl
Area1_Ctrl
Cell01_Ctrl
Cell01Sta100_Ctrl
Add-On Instruction
raD_Opr_ModeMain
raD_Opr_ModeSub
raD_Opr_ModeSub
Routine
Area1_Main
Cell01_Main
Cell01Sta100_Main
The ModeControl objects serve three main purposes:
• Provide the interface from the HMI and hardware buttons to the RapidLaunch
application inside the controller.
• Host and maintain the LocalBus for the levels, which provide the operation modes, cycle
status, and diagnostics to the child ModeControl and Device objects.
• Provide the mode and cycle operation for use with user sequences to run machine
processes.
A DeviceBus is shared by all objects of a certain hierarchical level to pass information, such as
the operation mode and fault information. The DeviceBus is created by the LocalBus and
HostBus tags of the raD_UDT_DvcBus data type.
22
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
In Figure 16, the Area (controller-level) ModeControl is the owner of the LocalBus Area1_Bus.
Cell01 and Cell02 both share data with their higher control level (Area1 Mode), by connecting to
its LocalBus (or HostBus) which is the Area1_Bus.
Cell01 and Cell02 control their own bus (or LocalBus), which is called Cell<yy>_Bus to provide
connectivity for the Cell ModeControl object.
Figure 16 - Control Level Add-On Instruction
Every device in the RapidLaunch standard must be connected to a LocalBus to receive and
provide mode and fault information.
A predefined Global tag must be connected to every device. This tag maintains system
counters, timers, and production data.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
23
Chapter 1
RapidLaunch Controls Solution
Area Program Main Routine
RapidLaunch requires very little code in the MainRoutine outside of the ModeControl objects. In
the Area (top-level) Program MainRoutine, there are two rungs of code before the JSR
instruction call to its ModeControl routine, which contains the Area ModeControl object.
Figure 17 shows these rungs in the Area1 Program before the Area1_Main routine call, which
contains raD_Opr_ModeMain.
Figure 17 - Area Level MainRoutine Base Content
•
•
Rung 0 documents the description, and setts the _AlwaysON and _AlwaysOFF bits, which
can be used later in the application if either condition is required.
Rung 1 calls the User_Config subroutine. User_ routines contain user-specific
application code and project-specific parameters.
Area ModeControl Routine (Area<x>_Main)
The Area level ModeControl routine (for example, Area1_Main) contains the raD_Opr_ModeMain
Add-On Instruction call for sharing information through the different hierarchical levels.
You can use the raD_Opr_PACSts object to gather status information from the controller. An
instance of this object is located in the Area (controller-level) subroutine.
24
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
ModeControl Object Parameters
Every ModeControl object (raD_Opr_ModeMain and raD_Opr_ModeSub) requires the same base
parameter set. While some of the functionality is explained later in this manual, here is a short
overview of the mandatory parameters.
Figure 18 - ModeControl Object Mandatory Parameters
Table 3 - ModeControl Object Mandatory Parameters
Parameter
raD_Opr_ModeMain
raD_Opr_ModeSub
Ref_HostBus
Ref_LocalBus
Ref_Global
Cfg_FaultMessages
Inf_InstanceName
Data Type
raD_Opr_ModeMain
raD_Opr_ModeSub
Description
raD_UDT_DvcBus
Host DeviceBus interface (ModeSub only)
Local DeviceBus interface.
Global data for device.
Contains user safety fault and static fault message strings.
Instance name of device.
raD_UDT_Global
raD_UDT_FaultMessages
STRING
Backing tag of Add-On Instruction instance.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
25
Chapter 1
RapidLaunch Controls Solution
RapidLaunch General
Device Objects
RapidLaunch also provides Device objects to program device functionalities, such as:
• Motors
• Valves
• Conveyors and Roller Beds
• Robots
Configure Device Objects
During regular operation, devices inherit their operation mode from their assigned control
level (Area/Cell/Station). Therefore, every Device object has an input parameter
(Ref_LocalBus), which connects the device to the ModeControl object that controls its
hierarchical level.
Figure 19 - Connect a Device Object to a ModeControl Object
Besides the backing tag, every object has select parameters that must be configured. This
table highlights the most common configuration parameters for device objects.
Table 4 - Common Configuration Parameters
26
Parameter
Ref_LocalBus
Ref_Global
Inf_InstanceName
Data Type
raD_UDT_DvcBus
raD_UDT_Global
STRING
Inf_ManCtrlText
raD_UDT_ManCtrlText
Description
Local DeviceBus the device is connected to.
Global data for device.
Instance name of device.
Text to enter (.@Description) for display on HMI Manual Control
objects.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 1
RapidLaunch Controls Solution
Main Mode and Local Mode
In normal operation, devices receive their operation mode through the LocalBus tag set by the
mode control.
In some situations, maintenance representatives might have to overwrite this mode to
perform certain activities (for example, to switch a device to Manual mode).
• You can use command inputs inside the controller code.
•
Or, you can use HMI control inputs from the HMI.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
27
Chapter 1
RapidLaunch Controls Solution
Device Interlock
Every device that initiates movement has permissive inputs. These permissive inputs must be
true before motion can occur. Table 5 describes what happens if a movement is commanded
and the corresponding permissive input is false.
Device Interlock Warning and Device Interlock Fault permissive inputs are intended to be used
with the raM_Opr_PermIntlk object. This object provides various parameters to evaluate an
interlock condition.
Table 5 - Movement is Commanded While Permissive Input is False
Warning
Fault
Resuming Movement
Line Operation
28
Permissive Inputs
Device Interlock Warning
Device Interlock Fault
A summary warning is triggered to the HMI that A warning is triggered to the HMI that states
A warning is triggered to the HMI that states
states that one permissive input is
that Inp_DvcIntlkWarning is active.
that Inp_DvcIntlkFault is active.
missing.
The raM_Opr_PermIntlk faceplate diagnoses the The raM_Opr_PermIntlk faceplate diagnoses the
missing interlock condition.
missing interlock condition.
The movement is not executed unless the
The movement is not executed unless the
The movement is not executed unless the
corresponding permissive input becomes
corresponding permissive interlock condition corresponding permissive interlock condition
true.
becomes true.
becomes true.
Line operation stops Automatic Cycle at the
Line operation continues with Automatic Cycle Line operation continues with Automatic Cycle affected hierarchical level. When interlock
for all other devices.
for all other devices.
condition is cleared, the fault must be reset and
Automatic Cycle must be restarted.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
2
Develop a RapidLaunch Application with
Application Code Manager
The RapidLaunch library is deployed via Studio 5000® Application Code Manager (ACM).
• ACM is the preferred deployment method to maintain version control of all library
objects.
• ACM can automatically generate logic for the controller, and generate HMI content.
• The implement libraries can help reduce the time that is required to deploy a new
project.
• All configurations and programming that are explained in other chapters can be done
with ACM.
Overview of Application
Code Manager
Application Code Manager enables project development with libraries of reusable code. ACM
creates modular objects with customizable configuration parameters using the reusable
content. ACM can also create the associated visualization, historical, and alarming elements
for a project.
ACM can be 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 Application Code Manager, see the Application Code Manager User
Manual, publication LOGIX-UM003.
Before You Begin
You must download the RapidLaunch Product Media Kit.
1. On the Product Compatibility and Download Center (PCDC), search for “RapidLaunch”.
You will be prompted to enter in your product key and serial number, which are
provided at the time of purchase.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
29
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
2. On the Product Compatibility and Download Center (PCDC), download the latest versions
of the Machine Builder Libraries, IO Device Library, Safety Device Library, and Power
Device Library.
30
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Set Up RapidLaunch
Libraries
Develop a RapidLaunch Application with Application Code Manager
To create a RapidLaunch database in a new ACM database, Set Up a New ACM Database on
page 117.
Register RapidLaunch and Supplementary Libraries
1.
In File Explorer, go to the directory for each library.
2. Double-click Setup.cmd to register each library into the opened ACM database.
3. Once the library registration is complete, type “y” to exit the Command Prompt.
4. In the ACM Registered Libraries panel, right-click on Registered Libraries > Refresh. The
newly registered libraries appear in the panel.
Create a New Project
1.
Create a New Project, or open an existing project. Navigate to FILE > New > Project.
2. In the Object Configuration Wizard dialog, select the desired Project type (for example,
(RA-LIB) ACM 2.00 Project - Basic_Project). Click Next.
3. Enter the Name and Description.
4. Click Finish.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
31
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Add Controller
1.
Add a controller to a project. In the Class View panel, right-click on Controllers and click
Add New...
2. Configure the controller.
a. In the Object Configuration Wizard, select the desired controller type from the (RALib) ACM 2.00 Controllers (for example, ControlLogix_Controller or
GuardLogix_Controller). Click Next.
b. Enter a Name and Description for the controller.
c. Click Finish.
d. In the Library Object Configuration, select the appropriate Chassis and Processor
configurations.
e. Configure the HMI AreaPath and/or AreaPathME parameters, which will be referenced
when using ACM to generate FactoryTalk® View SE displays with the graphic symbol
launch buttons.
32
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Add Displays to the Project
1. In the System View panel, expand HMI, right-click on Displays, and click Add.
2. In the Object Configuration Wizard, select (RA-LIB) RapidLaunch 2 HMI. Click Next.
3. In the Display object Parameters tab, you must select the DisplayTemplate type to match
the FactoryTalk View application version (minimum FactoryTalk View SE version is 13).
4. Go to the Displays tab, right-click, and click Add New.
5. Set the Name and Display* parameters. Generally, all Displays tab parameters besides
Name can remain as default, because this will often be used as a temporary display,
from which graphic symbol launch buttons are copied.
6. Click Finish.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
33
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Add and Configure Library
Objects
Before you add in any library objects, verify that the library is registered in Application Code
Manager.
raD_RapidLaunchBase Object
The raD_RapidLaunchBase object contains the Add-On Instruction definition for Embedded
Add-On Instructions and User-defined Data Types (UDTs), and is used as a Linked Library to
RapidLaunch implement required objects. This gives you the flexibility to instantiate only the
definition and create custom implement code. You can also create your own implement library
and link with this definition library object.
Parameter Name
Default Value
Instance Name
Definition
TagScope
Controller
-
Tag Scope
Description
Scope to create RapidLaunch object backing tags.
Choice of Controller Scope or Program Scope.
Attachments
Name
V2_{LibraryName}
V2_{LibraryName}
34
Description
File Name
Reference Manual
RM-raD_Opr_SeqCtrl.pdf
HMI Common Components V2_raD_RapidLaunchBase.zip
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Extraction Path
{ProjectName}\Documentation
{ProjectName}\Visualization\FTViewSE\Common
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Create raD_RapidLaunchBase
Add the raD_RapidLaunchBase contents into the controller, which will add the cyclic task Main
Task and all required Add-On Instructions, UDTs, and tags required by the RapidLaunch library.
1. In the Class View panel, right-click on the controller, and click Add New...
2. In the Object Configuration Wizard, search for raD_RapidLaunchBase in the Filter bar.
3. Select (RA-LIB) RapidLaunch 2 Asset-Control. Click Next.
4. Set the TagScope parameter. The tag scope applies to all objects throughout the
system. By selecting Controller or Program, the tags for all subsequent objects are
created in the defined scope upon logic generation.
5. Click Finish.
Selecting Controller on TagScope does not necessarily make every tag that is
generated by the RapidLaunch object controller scope. Only the object backing tag
and necessary associated tags are created at controller scope. Other tags that are
not essential to be accessed outside of the object scope are created at program
scope.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
35
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Create ModeMain Object
A RapidLaunch system always requires ModeControl objects to provide mode, cycle, status and
diagnostics to all objects. Start a ModeControl tree by creating a raD_ObjPrg_ModeMain object,
which is the top-level ModeControl.
1. In the Class View panel, right-click on the controller, and click Add New...
2. In the Object Configuration Wizard, select Solution and navigate to the RapidLaunch
library.
3. Select the library object to import (for example, raD_ObjPrg_ModeMain). Click Next.
You should select the Operation or Device library type rather than the
Asset - Control library type. Asset - Control library types only provide
AOI/UDT definitions, and do not insert end user code.
4. Enter the Name for the ModeControl object.
5. Assign the object to MainTask, which was created with raD_RapidLaunchBase, using the
Task dropdown menu.
6. Configure the library object (or use defaults). For more information on individual
objects, see the RapidLaunch Library Reference Manual, publication AUTO-RM001.
7. Configure the FTView SE display. In the Parameters tab, under the HMI Configuration
section, configure the SEAssocDisplay parameter by browsing or typing:
<HMI Server Name>.GraphicDisplays.<HMI Display Name>.
8. To browse for the Display:
In the Select a Reference dialog, select the desired Displays server in the left panel.
Go to the Displays tab in the right panel, and select the specific display.
f. Click Finish.
36
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
9. Go to the Linked Libraries tab, and click Auto Create.
a. In the Auto Create Linked Objects dialog, click OK.
b. All Linked Libraries should have a green check mark.
a. Click Finish.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
37
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Create ModeSub and Device Objects
Once raD_ObjPrg_ModeMain has been created, additional ModeControl objects can be created.
Additional ModeControl objects are instantiated as raD_ObjPrg_ModeSub as they are children to
the raD_ObjPrg_ModeMain or another raD_ObjPrg_ModeSub, and only need one parameter
configured, which identifies the parent ModeControl object.
IMPORTANT
A ModeSub object must created before configuring a Device object
(such as raD_LD_Mo2Pos).
In this example, a raD_LD_Mo2Pos Device object (where LD indicates that the object creates a
Ladder Diagram routine) is configured and assigned to raD_ObjPrg_ModeSub as a parent mode
control.
1. In the Class View panel, right-click on the controller, and click Add New...
2. In the Object Configuration Wizard, select Solution, and navigate to the RapidLaunch
library.
3. Select a library Device object (for example, raD_LD_Mo2Pos). Click Next.
4. Configure the library Device object (or use defaults). For more information on Device
objects, see the RapidLaunch Library Reference Manual, publication AUTO-RM001.
5. Click Finish.
You should select the Operation or Device library type rather than the
Asset - Control library type. Asset - Control library types only provide
AOI/UDT definitions, and do not insert end user code.
General instructions for RapidLaunch objects include:
• Enter a Name and Description. Maximum name length can be 22 characters.
• Assign the Task and Program using their corresponding dropdown menus.
38
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Common RapidLaunch configurations include:
• Local_Bus or Host_Bus - The parent ModeControl object that provides the bus for mode,
status, and diagnostics.
• GrpCtrlDvcCfg - Device configuration for group control. Depending on the personality
selected for the device, the device responds to different group control commands.
• PermissiveInterlockUsed - Whether an associated Machine Builder Library Permissive
Interlock Device shall be created to provide permissives/interlocks to the RapidLaunch
Device object.
- EnableFirstOutCapture - If PermissiveInterlockUsed, decide whether FirstOutCapture
is used. FirstOutCapture detects and displays the first permissive or interlock to lose
the OK State.
- EnableFirstOutCaptureResetRequired - If PermissiveInterlockUsed, decide whether
FirstOutCapture requires reset. FirstOutCapture requires a reset from the
RapidLaunch Device if this is set.
• Other device-specific configurations may exist. For more information on a list of
configurable parameters, see the object chapters in the RapidLaunch Library Reference
Manual, publication AUTO-RM001.
In ACM, Local_Bus and Host_Bus are reference parameters. Click the ellipsis button
dialog box appears that has all available ModeControl objects to select as the parent
ModeControl object.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
, and a
39
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Generate ACM Content
Application Code Libraries contain Studio 5000 Logix Designer code, HMI objects, and
associated documentation. Those libraries that have associated Visualization content have all
required global objects (GO) and Faceplate Displays added as attachments. In addition, the
raD_RapidLaunchBase object has the required common global objects, navigation and display
templates, HMI Tags, Macros, and Images. You can generate only the necessary visualization
and documentation for the objects included in the project.
Extract Attachments
In Application Code Manager, the attachments are associated with the library objects in the
(RA-LIB) Device > Asset-Control folder. These can be accessed through the full Application Code
Manager software, or via the Studio 5000 Logix Designer Plug-In “Import Library Objects”.
1. To access the attached files, right-click on the controller, and select Extract Attached
Files.
2. Select the destination folder on the computer, and select OK. An Extract Attachments
dialog shows the extraction status.
The extracted folder contains the following:
- RapidLaunch Library Reference Manual, publication AUTO-RM001, for objects
- Required Help Files for RapidLaunch Faceplates
- Required Images
- Required HMI Tags
- Required Macros
- FactoryTalk View Site Edition Displays
- FactoryTalk View Site Edition Global Objects.
Generate Displays
Once you have assigned displays to all Device objects, you can generate the displays.
1. In the System View panel, highlight the desired display server under HMI > Display, and
right-click to select Generate Displays > All Displays or select individual displays.
2. Select the folder location to save the generated files, and take note of it.
40
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Generate Controller
Once you have assigned library objects to your application, you can generate the controller.
1. In the Class View panel, right-class on the controller, and click Generate Controller.
2. In the Logix Code Generation dialog, select all checkboxes, and set the Save Path to the
same destination folder. Click Generate.
3. Upon successful generation, click Open Folder to go to and open the generated .ACD file
with the project name.
Import Visualization Collateral into FactoryTalk View Studio
The attachments that were exported can now be imported into FactoryTalk View Studio. It is
recommended to import them in this order:
• Import Common Items -This should only be required once in a RapidLaunch project.
• Import Images - This should only be required once in a RapidLaunch project, or if there
is a desire to update the image directory.
• Import Global Objects
• Import Displays
• Import Help File
Import Common Items
1.
Open FactoryTalk View SE. Create a project, and note the name and area where the HMI
server is created (i.e. Network Station or Network Distributed).
2. Open Microsoft Windows Explorer. Navigate to the location where the files were
extracted. Go to {ProjectName}\Visualization\FTViewSE\Common, select the
*_raD_RapidLaunchBase.zip file, and unzip the files.
3. Once unzipped, navigate into the folder and run raD_RapidLaunchBase.cmd.
4. A command prompt window will open and prompt for the SE Project Type. Select the
number corresponding with the SE Project Type created, and press Enter.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
41
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
5. Select the number that corresponds with the project to which you desire to add
RapidLaunch components.
The script verifies it can find the project, and if so, it adds the following common
components into the base project:
- HMI Tags
- Global Objects
- Navigation Displays
- Macros
- Images
6. Answer at the prompt whether you would like for existing HMI files to be overwritten if
they exist within the project.
42
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
7. Do not close the command prompt window until the message “Press any key to
continue...” is displayed.
8. Upon completion, all additions and/or errors are displayed in the command prompt
window. You can review the messages in the command prompt or open
“$AddComponent.txt” to review the details.
9. You may have to close and reopen your FactoryTalk View SE project to see the added
components.
Import Images
1.
Open Windows Explorer and navigate to the location where the files were extracted then
{ProjectName}\Visualization\Images, select the images.zip file and unzip the images.
IMPORTANT
Depending on the libraries used within the project, multiple folders
and/or zip files may need to imported. Also, if some images are still
missing after import, the specific library attachments may need to be
extracted individually within ACM to verify it was not overwritten by
another library.
2. Once unzipped, right-click on Images in FactoryTalk View SE, and click Add Component
into Project...
3. Navigate to the location where the files were extracted. Select all images (or press
Ctrl+A to select all), and click Open.
4. If any duplicate images are found, choose Yes, Yes to All, or No. Choose No for any
duplicate images unless you want to overwrite existing images back to default.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
43
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Add Global Objects
Depending on the libraries used within the project, there can be multiple Global
Objects folders with slightly different names. Repeat this process for all Global
Object folders found.
1. Right-click on Global Objects in FactoryTalk View SE, and select Add Component into
Project...
2. Navigate to the location where the files were extracted then
{ProjectName}\Visualization\FTViewSE\GlobalObjects. Select all global object display
*.ggfx files (or press Ctrl+A to select all), and click Open.
3. If any duplicate displays are found, choose Yes, Yes to All, or No. Choose No for any
duplicate displays unless you want to overwrite existing displays back to default.
Add Displays
Depending on the libraries used within the project, there may be multiple Display
folders with slightly different names. Repeat this process for all Global Object
folders found.
1. Right-click on Displays in FactoryTalk View SE, and click Add Component into Project...
2. Navigate to the location where the files were extracted then
{ProjectName}\Visualization\FTViewSE\Displays. Select all display *.gfx files (or press
Ctrl+A to select all), and click Open.
3. If any duplicate displays are found, choose Yes, Yes to All, or No. Choose No for any
duplicate displays unless you want to overwrite existing displays back to default.
Import Help File
1.
Determine the help file location for the HMI Server by navigating to HMI Tags, selecting
RALibrary\HelpFilePath and observing the Initial Value. You can change this value for
the project if this is a first-time setup.
2. Navigate to the location where the files were extracted then
{ProjectName}\Visualization\FTViewSE\Documentation. Select the Help File, and copy
it.
3. Navigate to the location noted in the RALibrary\HelpFilePath tag, and paste the Help File
to that location.
44
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Import Configured Displays into FactoryTalk View Studio
1. Open FactoryTalk View SE project in FactoryTalk View Studio.
2. Right-click on Graphics > Displays, and select Import and Export...
3. Follow the required prompts:
a. Import graphic information into displays.
b. Choose whether to back up displays.
c. 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.
d. If this is the first time, it is recommended to import Multiple displays batch import file
and then Create new objects on the display.
e. If you have done this before and are updating the imported display after modifying
your Application Code Manager project, choose Update existing objects on the display.
f. Browse for the BatchImport.xml file or individual display.xml file.
4. Open up the newly imported display. Notice that there are graphic symbol launch
buttons that are labeled and configured for each item that was configured in
Application Code Manager.
5. Right-click on the object and select Global Object Parameters to view that the
parameters have been pre-configured for you.
You can now copy and paste this graphic symbol onto any other display in your application.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
45
Chapter 2
Develop a RapidLaunch Application with Application Code Manager
Notes:
46
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
3
HMI Framework
The RapidLaunch HMI template for FactoryTalk® View SE consists of display templates, Global
Objects, faceplates, HMI tags, and macros. For information on initial RapidLaunch HMI setup on
FactoryTalk View SE, see Configure FactoryTalk View SE Security Groups on page 115.
Display Templates
Display templates are the framework for the HMI application. These display screens are
duplicated for use in building displays for the HMI application. Do not change these templates,
as you can duplicate them during HMI application development. There are templates for the
header, display screens, alarms, and language selection.
Figure 20 - RapidLaunch Framework Template Displays
Table 6 - Framework Template to Display Screen Relationships
Framework Template
(raC-1-SE) Template Language-Select
(raD-n-SE) Template Header
(raD-n-SE) Template Alarm-Explorer
(raD-n-SE) Template Alarm-History
(raD-n-SE) Template Alarm-Shelved
(raD-n-SE) Template Alarm-Summary
(raD-n-SE) Template Diagnostic-Summary
(raD-n-SE) Template Display L1
(raD-n-SE) Template Display L2
(raD-n-SE) Template Display L3
Display Screens
RapidLaunch_Language-Select
Area1_Header
Area1_alarm-explorer
Area1_alarm-history
Area1_alarm-shelved
Area1_alarm-summary
Area1_diagnostic-summary
Area1
Cell01
Cell02
Cell01Sta100
Cell01Sta110
Cell02Sta200
Cell02Sta210
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
47
Chapter 3
HMI Framework
Template screens allow for simplification of HMI application development. You can quickly
develop a significant number of application screens. In this example, we use templates for
alarms, header, and Level 1 through Level 3 (L1-L3) displays.
Figure 21 - Examples of Template Screens Used as Application Screens
Main Screen Elements
The RapidLaunch HMI Area1 display consists of the Area1_Header and Area1 screens, which are
called by the Area1_Start startup macro.
Figure 22 - Example Home Screen
48
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
HMI Framework
Area1_Header
Area1_Header is the main header screen. This screen is always visible, and no other screen will
replace or overlap it. This screen provides:
• Global navigation
• Global alarm display
• General information
• Language switching
Figure 23 - Area1_Header
1
2
3
4
5
7
6
8
9
Table 7 - Area1_Header Objects
Object
[1]
[2]
[3]
[4]
[5]
[6]
[7]
[8]
[9]
Functional Description
Language switching
System Overview
Home screen (Area level)
User sign in
User Logout
Current User
Time and date
Global Alarm list
Cell level navigation
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
49
Chapter 3
HMI Framework
Area1_Overview
Area1_Overview screen provides global objects and faceplates for:
• Complete line overview
• ModeControl and controller Status object
• Mode and Cycle Command Bar
Figure 24 - Area1_Overview Screen
2
1
3
Table 8 - Area1_Overview Objects
Object
[1]
[2]
[3]
Description
Area1 ModeControl and controller Status object
Cell overview and navigation
Mode and Cycle command bar
The Mode and Cycle Command Bar is a global object that is used to control the mode and
operation of a production line. The Command Bar consists of seven animated buttons as
described below.
EE
Table 9 - Mode and Automatic Cycle Command Bar Elements
Icon
50
Function
Description
Select Manual mode
Blue: Manual mode selected/active
Select Home Cycle
Blue: Home Cycle selected/active
Select Automatic Cycle
Green: Automatic Cycle selected/active
Select Automatic mode
Green: Automatic mode selected/active
Start Cycle
Green: Cycle operation active
Stop EoCycle
Yellow: Waiting for cycle to stop at EoCycle position
Reset
Red: Active Fault
Yellow: Active Warning
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
HMI Framework
Global Objects
Global objects are the fundamental tools of the HMI application. These global objects are used
to give visualization to, and display status information for, the RapidLaunch objects used in
the controller. Global objects can also launch a faceplate to allow for more detailed status,
diagnostic information, manual control, or for maintenance and engineering settings.
Faceplates
Faceplates give you full control of each RapidLaunch object from the HMI application. The
faceplate allows for manual control of device activities, and feedback from all indicators
regarding the status of the object.
If you have the correct HMI security level, you can access and adjust maintenance and
engineering settings and configuration from the faceplate. See Table 51 on page 115 for
additional information on the different security levels.
You can view all alarm conditions and other diagnostic indicators from the faceplate. For tagbased alarms, you can launch alarm faceplates from the Alarms tab to allow for detailed
information and configuration (per security level).
Additionally, with (optional) shelving/disabling access granted in the project scope, alarms can
be shelved and/or disabled from the HMI. Faceplates are accessed by selecting the device
global object on the display screens.
Faceplate Structure
RapidLaunch faceplates use tabs to organize the Device object information. See Figure 25 for
example faceplate tab organization, and Table 10 on page 52 for tabs used in RapidLaunch.
Figure 25 - Faceplate Tabs
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
51
Chapter 3
HMI Framework
Table 10 - Faceplate Tab Descriptions
Icon
Tab Name
Description
Home
Device status and Manual Control functions.
Maintenance
Maintenance settings.
Engineering
Engineering configuration.
Diagnostics
Diagnostics for device readiness
Alarms
Alarm information and shortcuts to alarm configuration.
Extended Properties Link to detailed properties and configuration.
HMI Configuration
HMI configuration area.
Some tabs have additional indicators for alerts. See Table 11 below for details regarding alert
icons and definitions.
Table 11 - Tab Alert Descriptions
Icon
Description
Maintenance Bypass
Bad Maintenance Configuration
Device Not Ready
Bad Alarm Configuration
Alarm Inhibited (Suppressed, Shelved, or Disabled)
Bad Engineering Configuration
52
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
Macros
HMI Framework
The RapidLaunch HMI application makes use of macros to provide some functionality. In
general, macros are kept to a minimum for simplicity, however they are used in limited
scenarios for navigation purposes to allow some conditional calls to display passing
parameters.
Startup and shutdown of the HMI application are handle with macros.
IMPORTANT
When ACM generates an HMI application, the application has the Startup
Macro Template_Start. You must rename Template_Start to reflect the
naming in your application. For example, rename Template_Start to
Area1_Start.
When you create a runtime application with FactoryTalk View SE Client
Wizard, you call the startup macro. For example, on the FactoryTalk
View SE Client Wizard under Startup components, set the Startup Macro
to Area1_Start.
You should not be required to edit or access any other macros. If you need to access the
macros, the FactoryTalk View SE Client Wizard and help files and documentation in the macros
can help you understand the functionality.
HMI Tags in FactoryTalk
View SE
The RapidLaunch HMI application comes with groups of RapidLaunch HMI tags and the system
tags group that is included in all FactoryTalk View SE projects, as shown in Figure 26.
Table 12 - RapidLaunch HMI Tag Group Descriptions
Group
Const
RALibrary
Security
Description
Constant values 0...63. Often used in macros for passing constant values with display
instructions.
Project-wide library settings
Security permission level for Global Objects and faceplates. Edit the Initial Value to set allowed
security levels for the function.
Figure 26 - FactoryTalk View SE HMI Tags
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
53
Chapter 3
HMI Framework
(raD-n-SE) Template
Displays
The framework of the HMI application is provided as templates. The templates allow you to
duplicate base display functionality, such as alarm banner, display navigation, and alarm
history. All of these displays have a common look and feel that provide consistency to the
application.
RapidLaunch components have a hierarchy in the application, which is translated into the
template displays.
• Template Display L1 is considered an overview screen. This is the top hierarchy of the
application and is considered the Area level.
• Template display L2 is the Cell level hierarchy.
• Template Display L2 No L3 would be a Cell level with no sublevel (Station).
• Template Display L3 is the Station level hierarchy.
By duplicating display templates, base components such as navigation and alarming of the
application are set up.
There are templates available to run on clients with different screen sizes and resolutions.
Figure 27 shows an example of templates in a RapidLaunch application. Their usage and
configuration are explained in this chapter.
Figure 27 - RapidLaunch Framework Template Displays
54
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
HMI Framework
(raD-n-SE) Template Display L1
The (raD-n-SE) Template Display L1 screen template represents the Area level. This template
provides an empty screen that launches right below the Area1_Header (see Area1_Header on
page 49). Use this template as the top-level overview of a machine or line.
Figure 28 - RapidLaunch Template Display L1
Using this template does not require additional configuration.
(raD-n-SE) Template Display L2
The (raD-n-SE) Template Display L2 screen template represents the Cell level. This template
provides a navigation bar that launches below the banner. Use this template as the second
level of a machine or line. You only need to parameterize the navigation bar and update the
text descriptions.
Figure 29 - (raD-n-SE) Template Display L2 with Navigation Bar
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
55
Chapter 3
HMI Framework
(raD-n-SE) Template Display L2 No L3
Similar to (raD-n-SE) Template Display L2, this template launches below the Area1_Header. It is
intended to be a cell display and represents the Cell level. This cell contains no stations below.
This template is mostly empty, but has a button indication to highlight the cell display that you
select.
This button indication requires the correct configured parameters to function as represented
in Figure 30.
Figure 30 - RapidLaunch Template Display L2 No L3
56
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
HMI Framework
(raD-n-SE) Template Display L3
The (raD-n-SE) Template Display L3 screen template represents the Station level. You must set
up the banner navigation to match the control system. You only need to parameterize the
navigation bar and update the text descriptions for the Navigation Bar buttons.
Figure 31 - RapidLaunch Template Display L3
The Navigation Bar provides animation feedback and navigation between screens for the
application. In Figure 32, Cell01Sta100 (Drill Machine) is selected.
The way this indicator is set up is through parametrization. How to parameterize the
navigation bar is explained in (raD-n-SE) Navigation Bar on page 58.
Figure 32 - RapidLaunch Navigation Bar in Template Display L2
1
2
3
Table 13 - Navigation Bar Elements
Element
[1]
[2]
[3]
Description
L2_Nav_Buttons
L2_Indicator
L3_Nav_Buttons
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
57
Chapter 3
HMI Framework
(raD-n-SE) Navigation Bar
The global object L3_Nav_Bar is used for navigation between displays. The banner navigation
needs to be set up to match the control hierarchy for the system. Parameterizing the global
object parameters is explained further in the figure below.
Figure 33 - L3_Nav_Bar
Navigation Bar Parameter
You must configure the global object parameters after configuring the individual buttons on
the navigation bar. Table 34 is an example setup of an L3_Nav_Bar global object parameters.
Parameters #107 and #108 represent L2 and L3 indicators.
To help prevent unused parameters from appearing as wire-frames on the display,
add ‘NA’ to the parameter.
Figure 34 - Cell01 Global Object Parameters L3 Nav Bar
58
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
(raD-n-SE) Graphic Symbols
- Control
HMI Framework
The graphic symbol display has three groups of objects:
• Global Objects for ModeControl and Screen Navigation.
- Launch the ModeControl faceplate.
- Screen navigation with color state indication.
- Graphical state indication.
• Global Objects for ModeControl status information.
• Global Objects for mode selection.
Figure 35 contains the (raD-n-SE) Graphic Symbols - Control global objects. These global objects
show hierarchical information, diagnostic information, and the state of the application. For
example, there are different ModeSub and ModeMain global objects that display information
such as control state and diagnostic feedback.
The graphic symbols display also contains a navigation box. The navigation box is another way
to incorporate on-screen navigation into your application.
Figure 35 - Graphic Symbols
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
59
Chapter 3
HMI Framework
ModeControl and Screen Navigation Global Objects
Table 14 - ModeControl and Screen Selection Global Objects
Global Object
Object Description
ModeMain Detail with
Controller Status
ModeSub with Faceplate
Launch
ModeSub without
Faceplate Launch
Display Call with Mode and
State Animation
Parameter Description
#101
ModeControl Add-On Instruction Backing Tag
Controller Processor Status
#102
Add-On Instruction Name
#120
Optional display parameter (/X100 or /CC)
#121
Optional display parameter (/Y100).
#101
ModeControl Add-On Instruction Backing Tag
#120
Optional display parameter (/X100 or /CC)
#121
Optional display parameter (/Y100 or /CC)
#101
ModeControl Add-On Instruction Backing Tag
#110
Operator Position
(0 = Top, 1 = Bottom, 2 = Right, 3 = Left)
#101
ModeControl Add-On Instruction Backing Tag
#102
Display to Launch
Mode and State Animation #101
ModeControl Add-On Instruction Tag
ModeMain Detail with Controller Status has parameters for the backing tag, controller
processor status, Add-On Instruction name, and display parameter configuration. This object
is meant to be used on overview screens and on the top (Area) level of the application.
ModeSub with Faceplate Launch has parameters for the backing tag, and display location for
the X-axis and Y-axis. This object is meant to be used at the Cell level, and calls a ModeControl
faceplate for the cell that is parameterized for the object.
ModeSub without Faceplate Launch has parameters for the backing tag and orientation of
the object. This object is meant to to show diagnostic information and state feedback at the
Station level.
Display Call with Mode and State Animation has parameters for the ModeControl Add-On
Instruction tag and the display to launch. This object provides a way to navigate between
screens. For example, if you have multiple cells on an overview screen, then use this object to
jump between screens.
Mode and State Animation has parameters for the ModeControl Add-On Instruction tag. This
object provides current status information for Help, Alarms, Mode (Manual or Automatic), and
Cycle Start.
60
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 3
HMI Framework
Mode Selection Global Objects
The mode selection objects in Table 15 allow you to cycle between the different states of your
control system. These different states are Manual mode, Automatic mode, Cycle Start, and
Reset. This object has a parameter for the ModeControl backing tag.
Table 15 - Mode Selection Global Objects
Global Object
Object Description
Parameter Number
Mode Selection Faceplate #101
Description
ModeControl Add-On
Instruction Backing Tag
There are horizontal and vertical versions of this object. Both objects have the same
parameter even though the vertical object has more push buttons available.
Graphical State Indication
You can use the objects in Table 16 to develop a graphical representation of the control
hierarchy on the HMI. These objects:
• Show Mode, Alarm, and other states of the connected Device in the controller.
• Allow you to send mode change commands at every level.
• Allow you to reset faults.
Table 16 - Graphical State Indication Global Objects
Global Object
Object Description
Parameter Number
Description
Device Framework
#101
Device Add-On Instruction
Backing Tag
ModeControl Framework
#101
Device Add-On Instruction
Backing Tag
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
61
Chapter 3
HMI Framework
Display Header
The display header is part of each Station and Cell display. The header contains three main
components:
• Navigation Buttons
• FactoryTalk Alarm and Event Banner
• Animated Alarm Button
Figure 36 - Display Header
2
1
3
Table 17 - Display Header Elements
Element
[1]
[2]
[3]
Description
Navigation Buttons
FactoryTalk Alarm and Event Banner
Animated Alarm Button
Navigation Buttons
The navigation buttons allow you to navigate between previous displays.
Table 18 - Navigation Button Parameter Settings
Parameter
Value
Left: 0
Top: 62
Position
FactoryTalk Alarm and Events Banner
The FactoryTalk Alarm and Event banner provides diagnostic feedback.
Table 19 - Factory Talk Alarm and Event Banner Parameter Settings
Parameter
Height
Width
Position
Top
Left
Event Subscriptions
General
Columns
FHD
FWXGA
WXGA
FHD
FWXGA
WXGA
Scopes
Event Sources
Icon Style:
Sort
62
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Value
85
1600
1200
1137
62
196
140
140
:FactoryTalk Linx
[controller1]Area1*
RapidLaunch
See Figure 37.
Priority Descending
Event Time Ascending
Chapter 3
HMI Framework
For the FactoryTalk Alarm and Events banner, you must configure the event source and scope
to limit the number of alarms that display.
Figure 37 - FactoryTalk Alarm and Events Banner Columns Settings
Animated Alarm Button
The alarm button allows you to navigate to the FactoryTalk Alarm and Events summary page,
and also provides diagnostic feedback in the form of alarm severity.
Table 20 has the parameters and settings for the display header objects. These settings are
consistent across all RapidLaunch screens. The only object that has configurable parameters
is the alarm button.
Table 20 - Alarm Button Parameter Settings
Parameter
Top
Position
Left
FHD
FWXGA
WXGA
Alarm Summary Display Name
Alarm Group Name
Group Control
Value
Top:60
1860
1220
For example, Area1_Alarm-Summary
For example, Area1
Group Control allows you to control multiple different devices at once. For example, Group
Control is used to simultaneously move all Roller Beds in an area backwards or forwards to
evaluate a malfunctioning piece of equipment.
Group Control selection only works when the mode control for the span of control is in Manual
mode and you have proper Span of Control and Security privileges.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
63
Chapter 3
HMI Framework
Figure 38 - Example Group Control Display
In Figure 38, Group Control is enabled but no devices are selected. This is shown with the gray
box around Motor 1 and Motor 2. You see a light blue frame when any devices are selected. If
you tried to select these two motors, nothing would happen because the mode control is not in
Manual mode.
Group Control Device Configuration
Each Device faceplate has a Device configuration that is associated with the Group Control.
Figure 39 is an example of a two-position motor. The two-position motor has these Group
Control configurations: Lift, Turn Table, Positioning Motor, or Continuous motor.
For example, if you selected a Roller Bed activity, nothing would happen on the two-position
motor Mo2Pos. If you set up the Group Control configuration as a Turn Table, then triggering
the Clockwise or Counterclockwise activity would produce the desired output.
Figure 39 - Example of a Two-position Motor
Figure 40 contains the group control activity buttons. Selecting an activity results in the
activity being performed for all objects that are selected and have the proper Group Control
configuration.
Figure 40 - Group Control Activity Buttons
64
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
4
Alarm and Diagnostic Handling
RapidLaunch provides embedded diagnostics in the Device objects. Built-in diagnostic
bitmaps and tag-based alarms provide diagnostic information.
Alarm and Diagnostic
Categories
Diagnostic information consists of faults, warnings, and prompts.
• Faults are always latched and require a reset even though the external condition may
have cleared.
• Warnings and prompts clear automatically.
Table 21 - Diagnostic Categories
Category
Faults
Warnings
Reaction
Stops operation for the device or control level.
Notifies the operation about a condition that requires attention and can
lead to a production stop.
Color
Red
Yellow
Prompts
(Diagnostic events)
No impact on operation. Provides additional information to the operator.
Purple
These categories are split into subcategories to provide more meaningful diagnostic
messages, and to help maintenance in finding faults quickly.
Table 22 - Diagnostic Subcategories and Details
Category
Fault
Subcategory
Device Status Output Clearing
Alarm Definition/Trigger Tag
Safety Fault
Static Faults
Device Interlock Faults
Sts_SafetyFault
Sts_StaticFault
Sts_DvcIntlkFault
Alm_FaultSafety
Alm_FaultIO
Alm_FaultDvcIntlk
Pair Check Faults
Sts_PairCheckFault
Timeout Faults
Sts_TimeOutFault
Position Interlock Faults Sts_PositionItlkFault
Warning
I/O Warnings
Prompt (Diagnostic event) Messages
Latched (clear with Alm_FaultPairCheck
reset only)
Alm_FaultTimeout
Alm_FaultPosIntlkReqON
Alm_FaultPosIntlkReqOFF
Fault Description
(.@Description)
Safety Fault
IO Fault
Device Interlock Fault
PairCheck Fault - Input expected
OFF
Timeout Fault
Position Interlock - Input expected
ON
Position Interlock - Input expected
OFF
Sts_Warning
Clear with condition Alm_WarningIO
IO Warning
Not Applicable
Clear with condition Alm_PromptIO
IO Prompt
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
65
Chapter 4
Alarm and Diagnostic Handling
Diagnostic Bitmap
RapidLaunch provides up to three DINTs of diagnostic information that you can use to create
custom diagnostic displays. While the usage of these bits can vary, in most cases, the bits are
laid out as shown in Table 23.
Table 23 - Diagnostic Bits
Diagnostic
Sts_bDiag1
Sts_bDiag2
Sts_bDiag3
Objects
ModeControl
Device
ModeControl
Device
ModeControl and Device
The bit layout is described in the comment of each bit.
Figure 41 - Diagnostic Bits Example
66
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Description
User Safety Faults
Faults
User Faults
Faults (additional 32 bits)
Warning/Prompts
Chapter 4
Tag-based Alarms
Alarm and Diagnostic Handling
Tag-based Alarms provide diagnostic information to Manufacturing Execution Systems (MES)
and HMI equipment. The tag-based alarms in this section are predefined in RapidLaunch
objects. The alarm definition and the trigger tag always carry the same name, as shown in
Table 22 on page 65.
Each alarm message references its corresponding alarm definition description, as shown in
blue text in Table 25. The diagnostic text follows this syntax:
<Instance Name> - <Fault Description> - <Parameter Name>
Table 24 - Diagnostic Text Syntax
<Instance Name>
<Fault Description>
<Parameter Name>
Name of the Add-On Instruction alarm definition instance. This should reflect
hardware labeling and drawing.
Default fault description is provided by the instance definition. This is stored as the
alarm trigger description (@Description) and can be translated to different
languages, including Asian characters.
The name of the Add-On Instruction input parameter that triggers the alarm. This is
stored in a string array that can be adjusted to reflect the hardware drawing.
This results in alarm messages that could look like the sample messages in the table below.
Table 25 - Sample Alarm Messages
Alarm
Safety Fault
IO Fault
Device Interlock Fault
PairCheck Fault
Timeout Fault
Position Interlock Req. ON
Position Interlock Req. OFF
IO Warning
Device Warning
Prompt
Sample Alarm Message
Area1_Ctrl – Safety Fault – E-stop #1
Area1_Grp01M – IO Fault – _EHT100_Q02
Area1_Grp01M – Device Interlock Fault – Inp_DvcIntlkFault
Area1_Grp01M – PairCheck Fault - Input expected OFF – Inp_OverloadTrip
Area1_Grp01M – Timeout Fault – Position Fwd
Area1_Grp01M – Position Interlock - Input expected ON – _EHT100_Local_B01
Area1_Grp01M – Position Interlock - Input expected OFF – _EHT100_Local_B01
Area1_Grp01M – IO Warning – Area1_Grp01M_Drv
Area1_Grp01M – Warning –
Area1_Grp01M – Waiting for – Enable Fwd/Rev
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
67
Chapter 4
Alarm and Diagnostic Handling
Tag-based Alarm Message Setup
In RapidLaunch, alarms are predefined in the Add-On Instruction definition, with English US
(en-US) as the default language. Some of the alarm messages are stored as a comment in the
alarm trigger tag to enable customization and language switching. Moving this information
from the Add-On Instruction definition to the instance requires you to take an action that is
called ’Paste Pass-Through’.
Bit and tag comments of an Add-On Instruction definition are not automatically copied into
every instance of the Add-On Instruction. The information that is passed to the instance is
shown in gray. Since Tag-based Alarms can only display descriptions that are stored inside the
instance, make-sure that this information is stored in every instance.
Figure 42 - Pass Through Information of the raD_Dvc_Mo2Pos Add-On Instruction
To copy the information from the Add-On Instruction definition to the instance:
1. Select the language of the desired comment.
2. Place the cursor in the Description field.
3. Right-click and select Paste Pass-Through.
IMPORTANT
Paste Pass-Through the default language (English US) last.
Once the Default language is pasted in, the Paste Pass-Through option
is not available for other languages.
4. Modify the text if needed.
5. Select Enter.
IMPORTANT
68
You must do this for:
• Every alarm trigger tag and every RapidLaunch Add-On Instruction
instance.
• Every language that you want to show on the HMI.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 4
Fault Exceptions
Alarm and Diagnostic Handling
RapidLaunch Add-On Instructions have embedded diagnostics that trigger faults, warnings, or
prompts to react to unusual or undesired situations.
In some cases, it might not be appropriate to trigger an alarm.
• A cylinder with a short movement can be designed to cover forward and reverse
position for a time until it reaches the end state and the reverse input clears. Triggering
a PairCheck fault would not be appropriate in this case.
• A replaced or bypassed piece of equipment can cause a fault, which is temporarily
accepted and does not impact production.
Cases like these drive the need to disable fault conditions, or to allow or accept a fault
message to be triggered (and reported to MES) but bypassed to continue production.
Disable Faults
Depending on the device, each Sts_bDiag(x) word can have a disabled word associated with it.
These disabled words are labeled Cfg_bDiag(x)Disable.
• If the bit Sts_bDiag1.1 is true and the corresponding bit Cfg_bDiag1Disable.1 is not true,
the proper fault is activated and displayed on the HMI system.
• If the bit Sts_bDiag1.1 is true and the corresponding bit Cfg_bDiag1Disable.1 is also true,
the fault is ignored and no message is displayed.
The table below shows an example of fault masking for Sts_bDiag1.0.
Table 26 - Fault Masking for Sts_bDiag1.0 Truth Table
Sts_bDiag1.0
False
False
True
True
Cfg_bDiag1Disable.0
False
True
False
True
Station Fault Generated
False
False
True
False
HMI Display
False
False
True
False
Production-relevant Fault Masks
Depending on the device, each Sts_bDiag(x) word can have a bypass word associated with it.
These bypass words are labeled Set_bDiag(x)Bypass.
• If the bit Sts_bDiag1.1 is true and the corresponding bit Cfg_bDiag1Bypass.1 is not true,
the proper fault is activated and displayed on the HMI system.
• If the bit Sts_bDiag1.1 is true and the corresponding bit Cfg_bDiag1Bypass.1 is also true,
the fault is not active in the control system but is displayed on the HMI.
The table below shows an example of bypassing for Sts_bDiag1.0.
Table 27 - Bypassing for Sts_bDiag1.0 Truth Table
Sts_bDiag1.0
False
False
True
True
Set_bDiag1Bypass.0
False
True
False
True
Station Fault Generated
False
False
True
False
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
HMI Display
False
False
True
True
69
Chapter 4
Alarm and Diagnostic Handling
Fault Reaction
Every ModeControl object can define the system fault reaction for its span of control. You can
use the Cfg_bFaultHandler parameter to configure the fault handler.
Figure 43 - Fault Handler Configuration Parameter on the ModeControl Object
The fault handler is a binary representation of the different fault classes that are defined in
RapidLaunch.
Table 28 - Fault Mask Bit Definition
Fault Mask
Bit 0
Bit 1
Bit 2
Bit 3
Bit 4
Bit 5
Bit 6
Bit 7
Definition
Safety Fault
Static Fault
PairCheck Fault
Timeout Fault
Position Interlock Fault
User Fault
Device Interlock Fault
Reserved
If you set Cfg_bFaultHandler to the default value of 127 (2#01111111), then every fault class that
triggers in a device passes back to the ModeControl object, and this Cell in the line stops. This
setting is common in a body shop environment, where one fault stops the whole line.
If you set Cfg_bFaultHandler to 1 (2#00000001), then a safety fault passes across the bus and
stops this Cell in the line. This setting is common in transportation and conveyance, where one
roller bed can fault but the rest of the line continues until it is full or starved.
For the Cfg_bFaultHandler fault mask, you can choose any bit pattern and configuration. Since
this can disable alarms and can lead to dangerous situations, it is your responsibility to ensure
machine and operational safety.
The Fault Handler setting, Cfg_bFaultHandler, is a project decision that is evaluated at prescan
only and cannot be changed during runtime. Changes can only be applied during the next
program download, or the next switch to controller Run mode.
70
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
5
Manual Operation
Concept of Device Activities RapidLaunch works with the concept of Device activities. An activity is a description of the
device behavior, including setting and resetting device outputs based on expected device
input combinations.
For example, the raD_Dvc_Mo2Pos Device object has these activities:
Table 29 - Device Activities Example
Maintenance Activity
Run Forward
Run Reverse
Stop
Goto Position Forward
Goto Position Reverse
Description
Triggered with the program command input PCmd_RunFwd in Automatic mode, or
the maintenance command input MCmd_JogFwd in Manual mode.
Triggered with the program command input PCmd_RunRev in Automatic mode, or
the maintenance command input MCmd_JogRev in Manual mode.
Triggered with the program command input PCmd_Stop in Automatic mode, or the
maintenance command input MCmd_Stop in Manual mode.
Triggered with the program command input PCmd_PosRev in Automatic mode, or
the maintenance command input MCmd_RunFwd in Manual mode.
Triggered with the program command input PCmd_PosRev in Automatic mode, or
the maintenance command input MCmd_RunRev in Manual mode.
When you trigger PCmd_PosRev in Automatic Cycle, it sets the forward fast output
(Out_Outputs.0) until the forward position input Inp_FwdPos becomes TRUE and Inp_RevPos
becomes FALSE.
Triggering PCmd_PosRev also automatically starts movement timeout monitoring. If the time
configured in Set_CmdPosRevTimeout is exceeded, a timeout fault is triggered. If
Set_CmdPosRevTimeout is not configured, movement timeout monitoring is inactive.
You can implement other diagnostic checks, like Position Interlock and Pair-check in a Device
activity.
If all conditions that define the end of an Activity are true (in this case only Inp_RevPos = true),
then the corresponding complete bit is set TRUE (in this case Sts_AtPosRev). This bit can be
evaluated inside your program code.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
71
Chapter 5
Manual Operation
Configure Device Manual
Activities
Manual Activities are assigned to a device from the HMI or from a push button. While HMI
inputs connect to the device directly, you must map push buttons to the device inputs as
shown in Figure 44. You can combine this mapping with additional code to match the desired
line behavior or security.
Figure 44 - Map Maintenance Command Inputs for Cell01Sta100_xxx
Configure HMI Manual
Control Text
Unlike manual control from the controller through a push button, manual control from the HMI
needs additional configuration for the manual control objects in the HMI faceplates to show
the right diagnostic and text.
As shown in Figure 45, when you create the Manual Control object, no text is applied. This is by
design, as the object’s functionality determines the appropriate text.
Figure 45 - Manual Control Object Without Controller Configuration
72
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 5
Manual Operation
Manual Control Text Tag and Data Type
You must create a tag to store the manual control text, and this tag is configured in the
Inf_ManCtrlText parameter. This is a mandatory parameter in any RapidLaunch instruction that
supports manual operation.
IMPORTANT
You must name this tag the same as the device backing tag, with the
addition of _ManCtrlTxt as a suffix. This tag must also have the same
scope as the device backing tag (for example, controller scope).
In our example below, the backing tag for the valve Device object is named Cell01Sta110_Vm01
and the manual control text tag name is Cell01Sta110_Vm01_ManCtrlTxt.
Figure 46 - Manual Control Text Tag Example
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
73
Chapter 5
Manual Operation
Text Entry and Visibility
Once you create the tag, you can edit the contents to display text on the Manual Control object.
To do this, navigate to the tag in the tag explorer, and expand the array.
Each array index corresponds with the activity that is assigned to the Manual Control object.
As a result, 0 is unused, and no text is entered on this index position. RapidLaunch uses tag
descriptions for text display to support language switching. Also, each tag is a Boolean data
type. The status of this Boolean value acts as a visibility animation on the HMI.
Table 30 - Manual Control Text Descriptions
UDT Member Name
MotionName
ActName
IndSummaryText
PosIndText
Ind0Text - Ind11Text
Description
Enter text to appear as Motion Name (.@Description) on the Manual Control object here.
Enter text to appear as Activity Name (.@Description) on the Manual Control object here.
Enter text to appear as Indicator Summary (.@Description) text on the Manual Control
object here.
Enter text to appear as text in on the lower indicator (.@Description) for the Manual
Control object here.
Enter text to appear as text in on the indicator 0 - indicator 11 (.@Description) for the
Manual Control object here.
To display manual control text, the description fields must be entered and the tag value must
be set to 1. You can use ACM can automate this process.
If the tag has no description (or only displays the default grayed out description), the default
behavior on the HMI is for question marks (????) to appear on the Manual Control object.
74
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 5
Manual Operation
In Figure 47, the Manual Control Text for activities 1 and 2 are shown. The visibility is on for all
descriptions except for PosIndText. In the example shown in Figure 47 for Activity 1 and Activity
2, the Position Indicator is not used for Manual Control functionalities like Jog. PosIndText is
reserved for devices with multiple positions (for example, Cross Transfer object) or position
feedback (for example, 5-Position Motor with encoder). Therefore, as shown in Figure 53 on
page 79 for Activity 3, PosIndText is used for indexing position.
Figure 47 - Completed Manual Control Text Tag for Text Entry
Figure 48 - Manual Control Object with Complete Controller Configuration
For description of the Manual Control object, see HMI Manual Control Object on page 76.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
75
Chapter 5
Manual Operation
HMI Manual Control Object
The Guided Manual Control object is supported by all RapidLaunch Devices that support
manual operation. This object provides access to predefined manual activities for each Device
object.
You can use the Guided Manual Control object to create a display for manual control of
numerous Device objects. By adding a number of global objects to the display, you can
parameterize the objects in order to guide the operator to perform manual operations in the
correct sequence. For more information on activity definitions, see the Device object chapters
in the RapidLaunch Library Reference Manual, publication AUTO-RM001A.
Figure 49 - Example of Guided Manual Control Object
The Guided Manual Control global objects are available for different screen resolutions and
purposes as faceplates under (raD-n-SE) Common - Guided Manual.
Functional Description
The HMI objects that accompany the Manual Control consist of a number of global objects.
There are objects that are designed to be embedded in faceplates or to span the entire screen
(in multiple resolutions). The Manual Control HMI object supports manual activities that are
defined in the RapidLaunch controller objects.
Figure 50 - Manual Control Object Main Components
2
1
3
4
Table 31 - Manual Control Object Main Components
76
Item
1
Description
Manual Motion Name
2
Left Activity
3
Right Activity
4
Motion Numeric Position/State
Details
Motion Name
Grouping of indicators, outputs, and text for the activity assigned to the
left position of the Manual Control global object.
Grouping of indicators, outputs, and text for the activity assigned to the
right position of the Manual Control global object.
(Object Dependent) shows numerical position/state of Device object
with configurable text.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 5
Manual Operation
These main components break down into sub-elements.
Figure 51 - Manual Control Object Sub-elements
1
2
5
3
4
6
Table 32 - Manual Control Object Sub-elements
Item
1
2
3
4
5
6
Description
Details
Inputs to trigger the activity that is assigned to the left or right parameter.
Activity input button
Buttons appear gray if activity is not possible due to permissive.
Button pressed indicator Indication that the Activity input button is pressed.
Overall status of the position indicators. This definition is object-dependent.
Indicator summary
For instance, a valve shows returned if all position indicators for each
cylinder are in the return position.
This shows the status of individual position indicators for an object. This
Individual indicators
object can display the status of 1 to 12 position indicators and is Device object
dependent.
Activity name
Name of Activity.
Output indicator
Slow/Fast output indicators.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
77
Chapter 5
Manual Operation
Configuration
The global objects can all be parametrized with their associated backing tag and manual
activities for the left and right buttons. The manual control extended object is designed to
extend across the entire display.
Parameterization of the Global Object
The object requires three global object parameter values:
• #101 - Backing tag for the Add-On Instruction. For example, raD_Dvc_Mo2Pos.
• #102 - Left Activity Number
• #103 - Right Activity Number
For more information on supported activities, see the Device object chapters in the
RapidLaunch Library Reference Manual, publication AUTO-RM001A.
For servo manual control objects, two additional parameters are required to assign position
index for the move.
Figure 52 - Manual Control Global Object Parameter
#101 - Backing Tag
The backing tag is the controller tag for the instance of the RapidLaunch Device object.
Depending on the object type, it is able to respond to predefined manual activities.
#102 - Left Activity Number
The parameter for the left activity defines the manual activity that is assigned to the left
button. You can assign this parameter to an integer, as defined by the Device object instance
used. This assigns the input to the proper activity, and displays the correct indicators on the
object to reflect device status. By populating the parameter with 0, no manual function is
assigned to the left activity, and the button and indicators will not be visible.
#103 - Right Activity Number
Similar to the left activity, the parameter for the right activity defines the manual activity that
is assigned to the right button. You can assign this parameter to an integer, as defined by the
Device object instance used. This assigns the input to the proper activity, and displays the
correct indicators on the object to reflect device status. By populating the parameter with 0,
no manual function is assigned to the right activity, and the button and indicators are not
visible.
IMPORTANT
78
For parameters #102 and #103, you must have authorization for the
security group {Security/CmdSrcOperProg} and your computer must be
in the group that is defined by {[backing tag].Inf_DvcInfo.SpanOfCtrl}
for line of sight operation.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 5
Manual Operation
Configure the Global Object Controller Tags to Display Text
The Manual Control object carries the configuration parameter for the device to be controlled
(#101), and the activity to be executed (#102 - #103). The controller stores the text that
displays on the object. See Manual Control Text Tag and Data Type on page 73 for information.
Table 33 shows the relationship between the Text being displayed on the ModeControl object
and the data that is stored in the controller.
Figure 53 - Activity 3 Configured at Manual Control Object
3
2
5
1
4
Table 33 - Manual Control Object Text Linkage to Controller
Element
1
2
3
4
5
Visibility
1
1
1
1
1
Controller Reference
.[ActivityNumber].MotionName
.[ActivityNumber].ActName
.[ActivityNumber].IndSummaryText
.[ActivityNumber].PosIndText
.[ActivityNumber].Ind0Text - Ind11Text
Figure 54 - Controller Configuration to Activity 3 Manual Control
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
79
Chapter 5
Manual Operation
Notes:
80
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
6
Automatic Operation
Functional Description
While requests for cycle selection and stop modes are done through the ModeControl Cmd_
inputs, the actual execution of these requests is done in the raD_Opr_CycleCtrl RapidLaunch
object.
RapidLaunch provides four predefined Automatic Cycles in two environments that can be
selected and started at any control level by the ModeControl object.
Discrete (non-process) environment:
• Home Cycle
• Automatic Cycle
• Custom Cycle 1
• Custom Cycle 2
Process environment:
• Startup Cycle
• Automatic (Process) Cycle
• Shutdown Cycle
• Weekend Cycle
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
81
Chapter 6
Automatic Operation
The ModeControl and Cycle Control objects provide input and output parameters to control
devices.
Table 34 - ModeControl and Cycle Control Parameters to Control Automatic Cycles
Cycle
Home
Automatic
Custom 1
Custom 2
Startup
Automatic (Process)
Shutdown
Weekend
Command Input
(raD_Opr_ModeMain or
raD_Opr_ModeSub)
Cmd_HomeCycle
Cmd_AutomaticCycle
Cmd_Custom1Cycle
Cmd_Custom2Cycle
Cmd_PStartup
Cmd_PAutomaticCycle
Cmd_PShutdownCycle
Cmd_PWeekendCycle
Cycle Reset Outputs
(raD_Opr_CycleCtrl)
Cycle Run Outputs
(raD_Opr_CycleCtrl)
Out_ResHomeCycle
Out_ResAutoCycle
Out_ResCustom1Cycle
Out_ResCustom2Cycle
Out_ResPStartupCycle
Out_ResPAutomaticCycle
Out_ResPShutdownCycle
Out_ResPWeekendCycle
Out_RunHomeCycle
Out_RunAutoCycle
Out_RunCustom1Cycle
Out_RunCustom2Cycle
Out_RunPStartupCycle
Out_RunPAutomaticCycle
Out_RunPShutdownCycle
Out_RunPWeekendCycle
Home Position
The Home cycle ends once the home position is reached. Since the home condition is
application specific, it is your responsibility to set Inp_PosHome to TRUE once home position is
reached.
IMPORTANT
Home position information is passed downwards through the control
levels, but not upwards.
If Home cycle is selected at a level higher than where the Home
sequences are executed, you must add code to pass this information to
the level where the Home sequence was called.
Figure 55 - Example of Collecting Home Position Information
82
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 6
Automatic Operation
End Of Cycle (EOC) Position
You can stop Automatic cycles at predefined positions/states. These positions are called End
Of Cycle (EOC) positions. As with the Home position, these positions are application specific. It
is your responsibility to set Inp_PosEoCycle TRUE once an EOC condition is reached.
You can only select Stop EOC mode if the system cycle is active (Sts_CycleActive). You can
select Stop EOC mode on any level by using the ModeControl input Cmd_StopEoCycle. Once
Cmd_StopEoCycle is pressed, the Stop EOC functionality is active on this level and all levels
below.
You can define multiple EOC positions in the application. Once Stop EOC is active (to be
selected through the ModeControl), CycleActive is dropped when Inp_PosEoCycle becomes
TRUE the first time.
IMPORTANT
EOC position information is passed downwards through the control
levels, but not upwards.
If Stop EOC is selected at a level higher than where the Home sequences
are executed, you must add code to pass this information to the level
where the Home sequence was called.
Figure 56 - Example of Collecting EOC Position Information
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
83
Chapter 6
Automatic Operation
Cycle Selection
To align the application code with the physical machine, it is mandatory to run the
Home/Initialization cycle after an application download. You can only select any other cycle
(Automatic Cycle, Custom Cycle 1, or Custom Cycle 2) if the machine is in a known state.
• You can only select Home/Initialization cycle in Manual mode.
• You can select other cycles in any operation mode.
Table 35 - Cycle Selection in Discrete Environment
Cycle
Home/Initialization Cycle
Automatic Cycle
Custom Cycle 1
Custom Cycle 2
IMPORTANT
Operation Mode for Selection
Manual mode only
Precondition
none
Manual mode or Automatic mode
System at known position
Not CycleStart
This object allows switching cycles while a line is in Automatic mode. It
is your responsibility to ensure appropriate line condition in the
moment of a cycle switch. Switching cycles after Stop EoCycle (End of
Cycle) is recommended but not enforced.
There is a specific sequence on how to start a line with RapidLaunch after an initial download:
1. Select Manual mode (Cmd_ManualMode).
2. Select Home sequence (Cmd_Home), and hold the selection for the configured time
(default = 3 sec).
3. Select Automatic mode (Cmd_AutomaticMode).
4. Select Start Cycle (Cmd_CycleStart), and hold the selection for the configured time
(default = 3 sec).
After the completion of HomeCycle, the AutomaticCycle gets pre-selected.
5. Select Start Cycle (Cmd_CycleStart), and hold the selection for the configured time
(default = 3 sec).
84
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 6
Automatic Operation
Figure 57 - Sequence of Cycle Selection and Start after Download
After a valid selection of a specific cycle (for example, HomeCycle), the Out_ResHomeCycle
output becomes TRUE for one scan. This lets you reset this and other Cycle Control code to a
given state.
Once Automatic mode is selected for this ModeControl object and Automatic cycle is active,
the Out_RunHomeCycle becomes active.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
85
Chapter 6
Automatic Operation
Figure 58 shows how these outputs can be used to control SFC subroutines.
Figure 58 - Sequence Control Example
Table 36 - Cycle Control Base Code
Condition
Out_ResHomeCycle
Out_RunHomeCycle
Out_ResAutoCycle
Out_RunAutoCycle
Program Commands
Action
Clear existing active steps.
JSR to execute User Reset (or Home) routine
Clear existing active steps.
JSR to execute User Automatic Cycle routine
RapidLaunch provides activities as described in Concept of Device Activities on page 71 to
command a device from the controller application when running Automatic Cycle. These
commands are identified by the prefix PCmd_. For example, the raD_Dvc_Mo02Pos Device
provides the following PCmd_ commands.
Table 37 - raD_Dvc_Mo02Pos PCmd_ Commands
PCmd_ Command
PCmd_Slow
PCmd_RunFwd
PCmd_RunRev
PCmd_Stop
PCmd_PosRev
PCmd_PosFwd
IMPORTANT
Description
Program command to run motor with slow speed. 1 = command slow speed.
Program command to run motor forward. 1 = start motor in forward direction.
Program command to run motor reverse. 1 = start motor in reverse direction.
Program command to stop. 1 = stop motor.
Program command to position motor reverse. 1 = command motor to reverse position.
Program command to position motor forward. 1 = command motor to forward position.
PCmd_ command inputs are cleared internally at the end of every scan.
All PCmd_ command inputs are reset within Device objects every scan, so you do not have to
reset these commands within the application code. Also, by resetting (via an OTU instruction)
allows for the PCmd_ command inputs to be Latched (via an OTL instruction) in multiple
locations within the application code without concern for commands being overwritten and
without triggering a Duplicate Destructive Coil warning. A traditional OTE instruction (Open
Coil) with seal-in logic will still trigger the commands as well.
IMPORTANT
Automatic Cycle Activities are edge driven.
Even though the PCmd_ command input is cleared inside the Device at the end of every scan,
the Activity that is triggered by the command is latched until it either completes or a different
activity is commanded to the Device. This also allows for special conditions like the Device
being faulted or entering Manual mode. Once the fault is cleared and the Cycle Active is reestablished the Device will continue to execute the Activity previously commanded.
86
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter
7
Sequence Control
The RapidLaunch Add-On Instruction library is a standard library that can be used in many
different ways. While RapidLaunch provides the hierarchical framework and a base set of Unit,
Equipment, and Control modules, it is your responsibility to program the machine operation.
While different programming styles can be applied, this chapter explains how to use
sequential programming.
In RapidLaunch, Ladder Diagram (LD) and Sequential Function Charts (SFC) are used for
Sequence Control.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
87
Chapter 7
Sequence Control
Sequence Control in Ladder
Diagram (LD)
This section describes an application example using the RapidLaunch library and the Studio
5000 Logix Designer Ladder Diagram (LD) functionality.
The RapidLaunch Sequence Control objects in Table 38 provide an easy way to structure a
system sequence and to identity the current active step, as shown in Figure 59. Therefore,
each rung should be kept simple, and adding more intermediate steps are encouraged. Rung
comments can be added in LD for easier understanding and troubleshooting.
Table 38 - RapidLaunch Objects Used in a Sequence
RapidLaunch Object
raD_Opr_ModeMain
raD_Opr_ModeSub
raD_Opr_SeqCtrl
raD_Opr_SeqRungEnable
raD_Opr_SeqRungNext
Description
Used to select, start, and coordinate different automatic cycles.
Used to program operational sequences in ladder code. These instructions work on
dynamic step number, taking away some of the challenges with traditional step
Counter logic.
Ladder Diagram Sequences
The Ladder Diagram (LD) sub-sequences are triggered from other LD routines or the transition
blocks of the Sequential Function Charts, as shown in Sequence Control in Sequential Function
Chart (SFC) on page 90.
In this application example, the sub-sequences are programmed using RapidLaunch objects in
LD in Table 38, while the main sequence is programmed in SFCs.
These sub-sequences are programmed in Ladder Diagram using raD_Opr_SeqCtrl,
raD_Opr_SeqRungEnable, and raD_Opr_SeqRungNext RapidLaunch objects. These three objects
provide the framework for the example below.
The RapidLaunch SequenceControl objects provide a dynamic step assignment. This
eliminates the challenge that most traditional step Counter logic encounter, which is when
steps have to be inserted in the middle of an existing Sequence.
Figure 59 - Sub-sequence Template
88
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
Using RapidLaunch SequnceControl, adding a new step within an existing Sequence simply
requires an additional rung inside the Sequential Operation section. Each step is associated
with the rung number. Therefore, there is no need to manually update step numbers.
IMPORTANT
As step numbers are updated automatically with a Sequence change,
the active rung number should not be referenced in the application
code outside of the sequence.
If there is a need to reference to an active rung number (or step), the
usage of a memory flag is recommended.
raD_Opr_SeqCtrl
The first rung of a Sequence Control routine must contain the raD_Opr_SeqCtrl Add-On
Instruction. This instruction resets the rung index and enables the next rung in case no other
rung is active.
The raD_Opr_SeqCtrl instruction has these parameters:
Table 39 - raD_Opr_SeqCtrl Parameters
Parameter
raD_Opr_SeqCtrl
Ref_LocalBus
Ref_Global
Ref_RungActive
Ref_RungEnable
Type
InOut
InOut
InOut
Output
Description
Backing tag for this instruction
Local DeviceBus interface
Global values
Rung number to be activated.
Backing tag for raD_Opr_SeqRungEnable within a Sub-Sequence.
Each following rung executes the following functions by using the raD_RungEnable and
raD_Opr_NextRung Add-On-Instructions.
raD_Opr_SeqRungEnable
This instruction dynamically assigns a rung index to this rung and compares the rung index to
the RungActive request.
• If the requested rung number is equal to the rung index, this rung gets executed as true.
• If the requested rung number is not equal to the rung index, this rung gets executed as
false.
This instruction is also responsible to ensure that rungs are being executed one by one in
StepByStep mode.
The raD_Opr_SeqRungEnable instruction has these parameters:
Table 40 - raD_Opr_SeqRungEnable Parameter
Parameter
Type
raD_Opr_SeqRungEnable
Sts_RungActive
Input
Description
Backing tag for this instruction (reused for all raD_Opr_SeqRungEnable
within a Sub-Sequence).
Rung number to be activated.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
89
Chapter 7
Sequence Control
raD_Opr_SeqRungNext
This instruction always increases the active rung by one when the PCmd_RungNextTrigger is
being set.
The raD_Opr_SeqNext instruction has these parameters:
Table 41 - raD_Opr_SeqRungNext Parameter
Parameter
Type
raD_Opr_SeqRungNext
Ref_RungActive
Input
Description
Backing tag for this instruction
(reused for all raD_Opr_SeqRungNext within a Sub-Sequence)
Rung number to be activated.
The backing tags for raD_Opr_SeqRungEnable and raD_Opr_SeqRungNext are
reused across a sub-sequence. These objects are intentionally designed that way,
so configuration overhead remains minimal.
End Sub-sequence Operation
The last rung in Figure 59 - Sub-sequence Template shows how to end a sub-sequence. It is
important to set Sequence Complete PCmd_SetSeqPC before releasing the SFC step. This
ensures that the sub-sequence will start from active rung number 1 (or step 1) the next time it
is triggered.
Figure 60 - Ending Sub-sequence
Sequence Control in
Sequential Function Chart
(SFC)
This section describes an application example using the RapidLaunch library and the Studio
5000 Logix Designer SFC functionality. When implemented correctly, the SFC provides an easy
and quick way to visualize a system sequence and to observe where the system is having
trouble. Notes can be added to SFCs to for easier understanding and troubleshooting.
The intent of the SFC is to provide program structure and visual indication of the current
program state and active step. Therefore, the SFC should be kept simple, and alternate or
parallel branches are discouraged.
IMPORTANT
In this chapter, we are using SFC sequences as examples. RapidLaunch
is not limited to SFC, but supports many programming styles and
languages.
In the application example, SFCs are used to:
• Structure the application code.
• Provide first-level diagnostics about the system operation.
The core system operation (sub-sequences) is written in Ladder Diagram, as shown in
Sequence Control in Ladder Diagram (LD) on page 88.
90
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
SFC to Structure Application Code
The application code in Figure 61 is divided into these major SFC steps:
• Drill Position 1
• Drill Position 2
• Shuttle Back
Figure 61 - Application Divided into Major SFC Steps
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
91
Chapter 7
Sequence Control
Every major SFC step has a Start Sequence trigger PCmd_StartSeq in the transition block that
triggers a Ladder Diagram sub-sequence, as shown in Figure 62.
Figure 62 - Triggering _HSQ_SeqCtrl Homing Sub-Sequence Routine
SFC to Provide Application Information
You can go online to monitor the SFC step that is active. This helps identify the Ladder
Diagram sub-sequence that is currently being scanned and executed.
Figure 63 - Active SFC Step Shows Subsequence Being Executed
The SFC action of an active SFC step displays the active rung number (of the sub-sequence
step) that is currently being executed.
Figure 64 - SFC Action Show Current Active Rung Number (Step) in Sub-Sequence
92
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
Within the sub-sequence, you can easily identify the commanded action [1] and waiting
transition [2].
Figure 65 - Action and Transition in Sub-Sequence
1
2
Steps and Transitions
This section provides a quick introduction to SFC-related functions in the Studio 5000 Logix
Designer® application, which are used in the application example.
Two types of steps are used in the SFCs: initial and normal. SFC steps are always separated by
a transition.
Initial Step
An initial step is identified within an SFC by a double-outline block. It is the first step that is
executed when the SFC is running, or when edits to the SFC program are accepted or tested.
There is only one initial step per SFC.
Although the initial step can be located anywhere in the SFC, it is good practice to have the
initial step as the first step of the SFC, positioned in the upper left area of the chart. In
addition, the transition that follows the initial step should have _AlwaysOn for the condition
(the transition should always allow the initial step to unconditionally move to the next step).
The SFC Recovery routine is the only action to be configured in the initial step.
Figure 66 - Initial Step of Homing SFC Example
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
93
Chapter 7
Sequence Control
Normal Step
A normal step is identified within an SFC by a single-outline block. Normal steps are executed
sequentially after the initial step. Each normal step is intended to represent a logical block of
programming.
It is important to note that normal steps do not call the LD sub-sequences in this programming
approach, as it is handled by transitions.
RapidLaunch uses normal steps to help visualize the process and aid troubleshooting (by using
actions and indicator tags). Normal steps, unlike initial steps, are allowed to have routine calls
(via JSRs) in the transition following a step, and can have actions that are associated with
them.
Figure 67 - Configuration of Step Type ’Normal’
94
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
Transition
A transition is used to move from one step to the next within an SFC. A transition must have a
tag and a step condition configured.
Figure 68 - Configure a Transition Tag
When TRUE, the step condition of a transition allows the SFC to move to the next step. A JSR or
a Boolean tag can be programmed as the step condition.
Figure 69 - Step Transition with a Boolean Tag Example (_HT_StartHome and _HT_Homing)
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
95
Chapter 7
Sequence Control
Once the Sub-Sequence is triggered (see Figure 69 on page 95), a Sequence Complete
(PCmd_SetSeqPC) must be programmed in the sub-sequence to allow the SFC sequence to
proceed to the next step.
Figure 70 - Set Sequence Complete of Sub-Sequence Example
As soon as the Sequence Complete PCmd_SetSeqPC of an executing sub-sequence becomes
TRUE, the SFC transition advances.
Actions and Indicators
An action is a block that can be tied to each SFC step, and is solved whenever a step is active.
In RapidLaunch, actions are used to display the current active routine or active rung number
of a sub-sequence (via indicator tags), and to set the major SFC step number.
Each action has a qualifier, which is used to determine when and how the action is executed.
The "N" (Non-stored), the ’P1’ (Rising-edge), and the ‘P’ (Pulse) qualifiers are the only
ones that are currently approved for RapidLaunch use.
An action block can also be categorized as Boolean or Non-boolean via a checkbox. A Boolean
action block does not allow you to add logic. On the other hand, a Non-boolean action block
has a body, in which you can add logic.
Figure 71 - SFC Action with ‘Non-Stored, Non-Boolean’ Example
96
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
Each action can have indicator tags that are associated with it. Here, the indicator tag is used
primarily to display the current executing active rung number in the sub-sequence routine,
triggered by the transition.
Figure 72 - SFC Action with ‘Non-Stored, Non-Boolean’ Indicator Tag Example
Sometimes, a STRING type indicator tag is used to display the sub-sequence routine name that
is being executed. This is needed when a decision is made to run a particular sub-sequence
routine over another. In the example below, a second (Boolean) action is added to the SFC step
to display a STRING indicator tag that is populated with the sub-sequence routine name.
Figure 73 - SFC Action with String Indicator Tag Example
Indicator tags are populated by the sub-sequence routine name in the LD logic that is
triggered by the transition.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
97
Chapter 7
Sequence Control
End the SFC
Once an SFC completes its last step, there are two options: stop element or loop back to the
first step.
SFC Stop
Since the Homing Sequence only runs once, the stop element is used and the Home flags must
be set.
Figure 74 - SFC Stop Element Example
SFC Loopback Wire
A loopback wire is used when the SFC is going to run continuously. This would be a case in the
Automatic Sequence. Once the SFC finishes all its steps, the loopback wire sends the sequence
back to the first step.
Figure 75 - SFC Loopback Wire Example
98
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
SFC Text Box
A text box is an important way to document SFCs. You can add information in each text box to
describe the steps and transitions, and make the SFCs more understandable.
Figure 76 - Text Box Example
Reset SFC
The Reset SFC (SFR) block is used to interrupt the execution of an SFC, and set it to a particular
step. The SFC name and the particular SFC step to reset to are required parameters.
In the example below, the SFR instruction is interrupting the CycleA_DrillingSFC SFC (whether it
is running or not), and resetting the current SFC step to _AS_StartAuto (the initial step of the
SFC).
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
99
Chapter 7
Sequence Control
Figure 77 - SFC Reset Example
Pause SFC
The Pause SFC (SFP) block is used to pause the execution of an SFC. The SFC name and the
desired state of the SFC step (for example, Execute or Pause) are required parameters.
In an application, the SFP instruction is used to resume the CycleH_DrillingSFC Homing SFC,
and pause the CycleA_DrillingSFC Automatic SFC.
100
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Chapter 7
Sequence Control
SFC Cycle Control
In this application example, SFC sequences require a specific setup for Cycle Control.
Table 42 - SFC Cycle Control Base Code
Condition
Out_ResHomeCycle
Out_RunHomeCycle
Out_ResAutoCycle
Out_RunAutoCycle
Action
Reset the HomeCycle SFC to initial step
Set the HomeCycle SFC to Execute
Reset the AutoCycle SFC to initial step
Set the AutoCycle SFC to Pause
Clear existing active steps. (This example uses an array to hold all step references)
JSR to execute HomeCycle SFC routine
Reset the HomeCycle SFC to initial step
Set the HomeCycle SFC to Pause
Reset the AutoCycle SFC to initial step
Set the AutoCycle SFC to Execute
Clear existing active steps. (This example uses an array to hold all step references)
JSR to execute AutoCycle SFC routine
JSR to execute commands
JSR to execute commands
JSR to execute commands
JSR to execute commands
Maintenance of Active Steps
SFC may have a tag storing the number of the major SFC step. Figure 78 shows how the
selection of a new cycle (for example, changing from HomeCycle to AutomaticCycle) clears the
active major step information.
It is good practice to alias tags containing step numbers into a step array. This
provides the ability to clear out all step numbers with a FLL instruction.
Figure 78 - Sequence Control Example
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
101
Chapter 7
Sequence Control
Notes:
102
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix
A
Troubleshooting
Overview
The best way to track a fault in the RapidLaunch standard is to refer to the diagnostics
information on the HMI. The HMI diagnostics are designed to indicate the exact Device level, at
which the problem or fault originates.
This chapter is a guide to track faults when the HMI is not available. For example, during initial
program test runs where the HMI is still in development.
This chapter explains how to navigate through the code structure, find the source of a fault,
and how to get the program to run again.
RapidLaunch Code Structure
Figure 79 shows the structure of the RapidLaunch program. The Area is the highest level, then
the Cells, and within the Cells are designated Stations. The Stations are comprised of Device
objects that correspond to physical devices.
Figure 79 - RapidLaunch PLC Code Structure
RapidLaunch is extremely beneficial as it reduces debug time when trying to troubleshoot a
fault.
The first step is to observe the Area-level ModeControl object, raD_Opr_ModeMain, which
displays Fault status output bits. When faulted:
• The program is faulted, and will not proceed unless the fault is resolved.
• The Automatic and Manual mode capabilities have been suspended.
• The objective is to find and clear the fault before the program can proceed.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
103
Appendix A
Troubleshooting
Trace the Fault Source
This section demonstrates how to trace the fault source in RapidLaunch.
IMPORTANT
• Sts_BusFault- Fault state that gets passed down to all objects on this
level and any sublevel. All objects and devices react with their configured
fault behavior.
• Sts_FaultACC- Fault indication that is accumulated and passed upwards
for troubleshooting purposes.
Observe the raD_Opr_ModeMain Outputs
The raD_Opr_ModeMain outputs highlighted in Figure 80 show:
• Sts_ER= 0 (no fault on this object)
• Sts_BusFault= 0 (no fault existing in the LocalBus or HostBus)
• Sts_FaultACC= 1 (fault existing on a sublevel)
Figure 80 - Area1 ModeControl Object Status Information
Based on this information, we know that there is no fault on this level or above. We also know
that a sublevel has a production relevant fault (Sts_FaultACC= 1). Therefore, the next step is to
determine which Cell generated the fault.
104
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix A
Troubleshooting
Investigate which Cell Generated or Forwarded the Fault
Cells that are configured underneath Area are shown in Figure 81.
Figure 81 - Cells Configured in Area
Check the Cell-level ModeControl objects in the Cell<yy>_Main subroutine in the project for any
faults.
The Cell-level ModeControl object in Figure 82 shows the following information:
• Sts_ER= 0 (no fault on this object)
• Sts_BusFault= 0 (no fault existing in the LocalBus or HostBus)
• Sts_FaultACC= 1 (fault existing on any sublevel)
Figure 82 - Cell01 ModeControl Object Status Information
Based on this information, we know that there is no fault on this level or above. We also know
that a sublevel has a production relevant fault (Sts_FaultACC= 1). Therefore, the next step is to
continue to determine which Station generated the fault.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
105
Appendix A
Troubleshooting
Investigate which Station Generated or Forwarded the Fault
Stations that are configured underneath this Cell are shown in Figure 83.
Figure 83 - Stations Configured in Cell01
Start with Station Cell01Sta100 and check its ModeControl object in the Cell01Sta100Main
subroutine.
The Cell01Sta100 ModeControl object in Figure 84 shows the following information:
• Sts_ER= 0 (no fault on this object)
• Sts_BusFault= 0 (no fault existing in the LocalBus or HostBus)
• Sts_FaultACC= 1 (fault existing on any sublevel)
Figure 84 - Cell01Sta100 ModeControl Object Status Information
Based on this information, we know that there is no fault on this level or above. We also know
that there is a fault on this level (Sts_BusFault= 1), therefore the next step is to determine
which Device on this sublevel generated the fault.
106
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix A
Troubleshooting
Investigate which Device on the Level Generated this Fault
Devices that are configured underneath Cell01Sta100 are shown in Figure 85.
Figure 85 - Devices Configured in Station Cell01Sta100
Check the first Device in the Cell01Sta100_Mo01 subroutine. The Device object in Figure 86
shows the following information:
• Sts_ER= 1 (this Device has a fault)
• Sts_BusFault= 1 (fault exists on the LocalBus, in this case it is likely caused by this
Device)
Figure 86 - Cell01Sta100_Mo01 Device Object Status Information
Detailed diagnostic information for every Device is stored on a bit level in the diagnostic
status words Sts_bDiag1 to Sts_bDiag3. Opening the Properties window of Cell01Sta100_Mo01
shows Sts_bDiag1 = 1, which reflects in Sts_bDiag1.0 (F_Motor Protection Tripped) being TRUE.
Figure 87 - Two-Position Motor Device Properties in Station100
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
107
Appendix A
Troubleshooting
Get the Program to Run
To get the program to run, you have to resolve the fault condition and reset the fault. In this
case, a Motor Protection input being TRUE caused the fault.
1. Clear _Mo01_OverloadTrip to resolve the fault condition.
2. Select reset on any of these levels. Repeat by setting the fault manually again and
select reset on the other levels.
• Cell01Sta100_Mo01_Ctrl
• Cell01Sta100_Ctrl
• Cell01
• Area1
IMPORTANT
108
Resetting Cell01Sta100_Mo01 only resets the Device itself, but not the
Station. This is only useful in conveyance or process environments
when a Device fault does not get passed back to the LocalBus.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix
B
Naming Conventions
Application naming conventions are customer-specific, and a part of customer
standardization. This chapter is intended to share some good practices on how you can
develop these conventions.
Program Names
The RapidLaunch controls solution includes Programs under these categories:
• To define the application control hierarchy.
• To define third-party application operation code.
Programs for the RapidLaunch Framework
The program names in the Logical Organizer represent the control hierarchy.
Table 43 - Control Hierarchy
Level
Naming Convention Description
<x> represents the area number in a production line with
Area
Area<x>
multiple areas.
NOTE: <x> is optional in the program name.
Cell
Cell<yy>
<yy> is a two-digit number that represents a cell in an area.
<yy> is a two-digit number that represents the host cell in an
area.
Station Cell<yy>Sta<zzz>
<zzz> is a three-digit number that represents the station in a
cell. The first digit must be the corresponding Cell number.
Example
Area1
Cell01
Cell01Sta100
Programs for Third-party Applications
Create a meaningful program name that identifies the application content and associated
control level.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
109
Appendix B
Naming Conventions
Routine Names
The RapidLaunch controls solution includes Routines under these categories:
• To define the Devices associated with each level of the application control hierarchy.
• To define third-party application operation code (for example, sequence control).
Routines in the RapidLaunch Framework
Figure 88 - Example of Program Names
MainRoutine
Every program has a main routine that is called MainRoutine. This routine calls the main
ModeControl routine, third-party routines, and so on.
ModeControl Main Routine
Programs also contain ModeControl main routines that:
• Contain the ModeControl object.
• Call Device routines.
In this naming convention, <Program Name> is the name of program hosting this routine:
<Program Name>_Main
110
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix B
Naming Conventions
Device Routines
One routine is recommended per Device (for example: roller bed, drive, and part tracking).
Align the routine names with the Device names mounted on the physical line.
Follow this naming convention: <Program Name>_<Device Type><nn>
Table 44 - Device Routine Name Breakdown
<Program Name>
<DeviceType>
<nn>
Name of program hosting this routine.
Device type (like TT for turn table).
Two-digit number to differential differentiate devices of the same type within a control level.
An example to reflect this naming convention is 'Cell01Sta100_Mo02,' where 'Cell01Sta100' is the
Program Name, 'Mo' is the Device Type, and '02' is the numerical Device identifier.
Routines for Third-party Applications
Third-party applications usually contain a main routine (for example, in Figure 89, the program
Cell01_UserSFC is used for application-specific sequence control, and contains the main
routine SeqCtrl_Main). This routine contains the needed code to organize and coordinate
different sequence types.
Figure 89 - Example of Third-party Routines
In this example, the sequential operation is organized by main sequence routines (for Home
and Automatic modes, in SFC) that call Ladder Diagram sub-sequence routines to execute the
application.
For sequence control routines in Ladder Diagram and SFC, follow this naming convention:
<Type>_<nn>_<Description>
Table 45 - Sequence Routine Naming Convention
<Type>
<nn>
<Description>
A = Automatic, H = Home
Two-digit number for differentiation of alternative auto sequences (optional).
Not applicable for home sequence.
Description of functionality.
An example to reflect this naming convention is CycleA_DrillingSFC, where CycleA is the Type to
indicate Automatic sequence, and DrillingSFC is the Description of the sequence function.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
111
Appendix B
Naming Conventions
Tag Names
Device Names
Device tag names always start with the identification of the associated control level, followed
by a Device type specification, and a two-digit counter.
We use this naming convention: <ControlLevel>_<Device Type><nn>
Table 46 - Tag Name Breakdown
<ControlLevel>
<Device Type>
<nn>
Associated control Level (like Cell01Sta100)
Device type (for example, TT for turn table)
Two-digit number to differentiate devices of the same type within a control level
Table 47 - ModeControl Naming Conventions
Element type
Area<x>_Ctrl
Description
Area Level Control
Cell<yy>_Ctrl
Cell Level Control (for example, Cell01_Ctrl)
Cell<yy>Sta<zzz>_Ctrl
Station Level Control (for example, Cell01Sta110_Ctrl)
Area<x>_controller
Controller Status
Table 48 gives the appropriate letter acronyms for Device naming.
Table 48 - Commonly Used Device Types
Element type
112
Description
Acc
Accumulating Conveyor
Cdo
Control Device object (for example, a variable speed drive or servo drive)
Crc
Cross Conveyor or Chain Conveyor
Ctrl
ModeControl
Dbn
DeviceBus interface next controller
Dbp
DeviceBus interface previous controller
En
Ethernet Diagnostic
Fwm
Fault Warning Message (use with add fault Add-On Instruction)
Lt
Lift Table
Mo
Motor
<y>St
<y> Module Status
Pid
PID control
controller
controller Status/Diagnostic
Rbc
Roller Bed conveyor
RFID
RFID Reader
Rob
Robot
Scl
Scaling
Seq
Sequence Control
Sfm
Safety Fault Message (use with add safety fault Add-On Instruction)
Tcr
Transfer Cart
Tt
Turn Table
VM
Valve
Wdg
Watchdog
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix B
Naming Conventions
Sequence Tags
These acronyms are used for step tags, transitions, actions, RungIndex, RungNumber,
RungEnable, NextRung, and so on.
Table 49 - Sequence Tags Acronyms
ASQ
HSQ
CycleH
CycleA
CycleC1
CycleC2
Tags for use in automatic sequences
for example, Cell01_ASQ_[DescriptiveName]_RungNumber
Tags for use in homing sequences
for example, Cell01_HSQ_[DescriptiveName]_RungIndex
Routine prefix for Home cycle
Routine prefix for Automatic cycle
Routine prefix for Custom1 cycle
Routine prefix for Custom2 cycle
Step array and activity array do not have a specific acronym, but can be named.
Table 50 - Sequence Tags Acronyms for SFC Only
AA
AS
AT
HA
HS
HT
Action Tags for use in SFC auto sequences
for example, Cell01_AA_[DescriptiveName]
Step Tags for use in SFC auto sequences
for example, Cell01_AS_[DescriptiveName]
Transition Tags for use in SFC auto sequences
for example, Cell01_AT_[DescriptiveName]
Action Tags for use in SFC homing sequences
for example, Cell01_AT_[DescriptiveName]
Step Tags for use in SFC homing sequences
For example Cell01_AS_[DescriptiveName]
Transition Tags for use in SFC homing sequences
for example, Cell01_HT_[DescriptiveName]
Cell01_StepArray and Cell01_ActArray for instance.
When using a sequence with only minor steps (for example, a conveyor with a
turntable), the name of the tag shall always include the sub-operation.
For example, Cell01_Sta110_ASQ_[DescriptiveName]_RungEnable
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
113
Appendix B
Naming Conventions
Notes:
114
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix
C
Configure FactoryTalk View SE Security Groups
Overview
FactoryTalk® View SE is a server-based HMI platform. The RapidLaunch HMI template contains
all Global Objects, Template Displays, HMI Tags, and Macros.
Security groups are configured to ensure that users have the proper authority to access
specific HMI functionality. A list of pre-configured user groups can be found in the HMI tags in
the security folder. Security levels are per Table 51. The list of acceptable user codes for each
security function can be adjusted by modifying the initial value of the HMI tags in the Security
Folder.
Figure 90 - HMI Tags for Security Access
Users and Groups can be configured in the System area of the FactoryTalk View SE project.
Table 51 - Default Security Codes
Default User Group
Operator
Supervisor
Maintenance
Maintenance Leader
Engineering
Engineering Leader
Default Security Code
A
B
C
D
E
F
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
115
Appendix C
Configure FactoryTalk View SE Security Groups
Users can be Microsoft Windows® users or FactoryTalk users (though it is recommended to
use only one type in a deployment rather than a mixture of Windows and FactoryTalk users).
Verify all Windows and/or FactoryTalk users exist in the correct User Groups to establish
proper security authorization.
Security is built in the RapidLaunch framework. However the topic as such is too
complex for this document and shall be handled separately. Therefore we will not
configure different user groups at this point but work with the Windows
Administrators group
Security Groups by
Span of Control
Different span of control allows for different user security levels. Verify that for each
ModeControl Object (raD_Opr_ModeMain and raD_Opr_ModeSub) in the controller, a
corresponding User Group exists in FactoryTalk View SE.
The User Group shall match the name of the ModeControl backing tag with either _Basic or
_Advanced as a suffix.
Table 52 - User Rights for _Basic and _Advanced Users
User Group Suffix
_Basic
_Advanced
Description
Users in this group are allowed basic HMI functionality for this area. This typically
included most ModeControl and Manual Operation functions.
Users in this group are allowed advanced HMI functionality for this area. This typically
includes maintenance and configuration functionality.
The span of control user groups are added security on top of Security Codes to
help prevent unauthorized access for members outside of their assigned area. The
Groups and Codes that are described in Table 51 on page 115 still apply.
Add the appropriate users to these areas to ensure that proper level of configuration access is
granted to the right users. Faceplates are designed to allow configuration and settings in
accordance with User Groups for Basic and Advanced users. If User Groups are not configured,
functionality may be missing or not allowed.
Set up the following User Groups:
116
User Group
Member
Area1_Basic
Authenticated Users
Area1_Advanced
Authenticated Users
Cell01_Basic
Authenticated Users
Cell01_Advanced
Authenticated Users
Cell01Sta100_Basic
Authenticated Users
Cell01Sta100_Advanced
Authenticated Users
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Corresponding User Groups for Span of Control
Appendix
D
Set Up a New ACM Database
Overview
To create a RapidLaunch library in a new Application Code Manager (ACM) database:
1. Open Application Code Manager.
The last project opens by default. Otherwise, a blank screen appears.
2. Go to TOOLS > Database Manager.
3. In the Database Manager dialog:
a. Select the ACM default sa password checkbox.
b. Select Connect.
c. Under Select a database name, enter raD_RapidLaunch_DB.
d. Select Execute Task.
e. Select OK once the Action Result dialog displays “Action completed successfully.”
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
117
Appendix D
Set Up a New ACM Database
4. Since this is a new database setup, you must add the ACM libraries.
a. Open Microsoft Windows® File Explorer.
b. Go to C:\Users\Public\Documents\Studio 5000\Libraries\Application Code
Manager\(RA-LIB) ACM 2.00
c. Copy the folder contents, and drag them into the ACM Registered Libraries panel.
d. In the Libraries Registration dialog, click Finish.
e. The Registered Libraries panel populates the ACM libraries.
118
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix
E
Import an ACM Project
Overview
The RapidLaunch Controls Solutions provides two sample base project, under the RapidLaunch
> ProjectImports_ApplicationCodeManager folder in .xlsx format:
• Project_RapidLaunch_V2_Start
• Project_RapidLaunch_V2_Sample
To import a sample base project:
1. Go to TOOLS > Import Export Manager.
2. In the Import Export Manager dialog:
a. Check the New - Create new project checkbox.
b. Click
and navigate to the RapidLaunch >
ProjectImports_ApplicationCodeManager folder.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
119
Appendix E
Import an ACM Project
c. Select the desired .xlsx file. This imports a project into ACM from an .xlsx file.
d. Click Import.
e. In the Import dialog, click Next. Once Import is complete, click Finish.
f. Click Finish. The .xlsx project populates the ACM panels.
120
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
Appendix E
Import an ACM Project
3. In the Class View panel, right-click on the controller, and click Generate Controller.
a. In the Logix Code Generation dialog, select all checkboxes, and set the Save Path to
your desired destination folder.
b. Click Generate.
This creates an .ACD file.
c. Upon successful generation, click Open Folder to go to and open the generated .ACD
file with the project name.
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
121
Appendix E
Import an ACM Project
Notes:
122
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
RapidLaunch User Manual
Rockwell Automation Publication AUTO-UM001B-EN-P - March 2024
123
Rockwell Automation Support
Use these resources to access support information.
Technical Support Center
Local Technical Support Phone Numbers
Technical Documentation Center
Literature Library
Product Compatibility and Download Center
(PCDC)
Find help with how-to videos, FAQs, chat, user forums, Knowledgebase, and product
notification updates.
Locate the telephone number for your country.
Quickly access and download technical specifications, installation instructions, and user
manuals.
Find installation instructions, manuals, brochures, and technical data publications.
Download firmware, associated files (such as AOP, EDS, and DTM), and access product
release notes.
rok.auto/support
rok.auto/phonesupport
rok.auto/techdocs
rok.auto/literature
rok.auto/pcdc
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, expanding human possibility, CompactLogix, ControlLogix, GuardLogix, FactoryTalk, FactoryTalk Optix, FactoryTalk Optix Studio, Logix 5000, PlantPAx, PowerFlex,
Rockwell Automation, Studio 5000, Studio 5000 Logix Designer, and Studio 5000 View Designer are trademarks of Rockwell Automation, Inc.
EtherNet/IP is a trademark of ODVA, Inc.
Microsoft Windows it a trademark of Microsoft Corporation.
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 AUTO-UM001B-EN-P - March 2024
Supersedes Publication AUTO-UM001A-EN-P - January 2024
Copyright © 2024 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.
">