Syslib Rm029 en P (P DOut)
Syslib Rm029 en P (P DOut)
WARNING: Identifies information about practices or circumstances that may 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 may 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.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to
potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL
Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, Rockwell Automation, RSLogix, Logix5000, FactoryTalk, PlantPAx, and ControlLogix are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of Contents
Preface
Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Discrete Output Instruction Input Structure . . . . . . . . . . . . . . . . . . . 11
Discrete Output Instruction Output Structure . . . . . . . . . . . . . . . . . 15
Discrete Output Instruction Local Configuration Tags . . . . . . . . . . 19
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Using Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Quick Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Discrete Output Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table of Contents
Notes:
Preface
This document is updated throughout for version 3.1 of the Rockwell
Automation Library of Process Objects. Changes for this revision are marked by
change bars shown in the right margin.
Page
Changed title from 'PlantPAx Library of Process Objects' to 'Rockwell Automation Library of Process
Objects'
Front Cover
Changed version of Rockwell Automation Library of Process Objects from 3.0 to 3.1
5, 9, 10
5,
Visualization Files
added Important note concerning the order in which files must be imported
File Types table - added optional files
9
10
11
15
21
24
27
Faceplates:
replaced images for Tabs, Operator, Maintenance, Engineering, and Alarms to include new
Diagnostics tab
Operator tab:
added Interlock/Permissive condition table
added Alarm Locations image
33
Engineering tab - changed 'Mode Configuration Message Box' to 'Mode Configuration Display'
38, 39
43
Alarm Severity Color Definitions table - changed level 4 alarm severity from 'Highest' to 'Urgent'
45
For the latest compatible software information and to download the Rockwell
Automation Library of Process Objects, see the Product Compatibility and
Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.
Preface
Additional Resources
Description
Add-On Instruction
Global Objects
Guidelines
Functional Description
Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times in
your application code as needed.
Required Files
Controller File
The P_DOut_3_1-00_AOI.L5X Add-On Instruction must be imported into
the controller project to be used in the controller configuration. The service
release number (boldfaced) can change as service revisions are created.
Visualization Files
The following files for this Add-On Instruction can be downloaded from the
Product Compatibility and Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.
IMPORTANT
Files must be imported in the following order: image files, then global object
files, and then graphic files. This order is required to properly configure the
visualization files.
File Type
Description
Graphics - Displays
GFX
(RA-BAS) P_DOut-Faceplate
(RA-BAS-ME) P_DOut-Faceplate
(RA-BAS) P_DOut-Help
(RA-BAS-ME) P_DOut-Help.gfx
(RA-BAS) P_DOut-Quick
(RA-BAS-ME) P_DOut-Quick.gfx
(RA-BAS) Common-AnalogEdit
N/A
(RA-BAS) P_Alarm-Faceplate
(RA-BAS-ME) P_Alarm-Faceplate
(RA-BAS) P_Alarm-Help
(RA-BAS-ME) P_Alarm-Help
(RA-BAS) P_Mode-Help
(RA-BAS-ME) P_Mode-Help
(RA-BAS) P_Mode-Config
(RA-BAS-ME) P_Mode-Config
File Type
Description
Optional Graphic
Displays
GFX
(RA-BAS) P_Intlk-Faceplate
(RA-BAS-ME) P_Intlk-Faceplate
(RA-BAS) P_IntlkPerm-Help
(RA-BAS-ME) P_IntlkPerm-Help
(RA-BAS) P_Perm-Faceplate
(RA-BAS-ME) P_Perm-Faceplate
Graphics - Global
Objects
GGFX
Graphics - Images
PNG
HMI Tags
CSV
N/A
FTVME_PlantPAxLib_Tags_3_1_00.csv (1)
(1) The service release number (boldfaced) can change as service revisions are created.
10
This section describes the parameter references for this Add-On Instruction.
Controller Code
Data
Type
EnableIn
Alias For
Default
Description
BOOL
Ladder Diagram:
If the rung-in condition is true, the instructions Logic routine executes. If the rungin condition is false, the instructions EnableInFalse routine executes.
Function Block Diagram:
If true, or not connected, the instructions Logic routine executes. If the parameter
is exposed as a pin and wired, and the pin is false, the instructions EnableInFalse
routine executes.
Structured Text:
No effect. The instructions Logic routine executes.
Inp_OnFdbk
BOOL
Inp_OffFdbk
BOOL
Inp_PermOK
BOOL
Inp_NBPermOK
BOOL
Inp_IntlkOK
BOOL
Inp_NBIntlkOK
BOOL
Inp_IOFault
BOOL
Inp_Sim
BOOL
Simulation input. When set to 1, the instruction simulates a working device while
keeping the output de-energized. When set to 0, the instruction operates the
device normally.
Inp_Hand
BOOL
Mode.Inp_Hand
Inp_Ovrd
BOOL
Mode.Inp_Ovrd
Inp_OvrdCmd
DINT
Inp_Reset
BOOL
Input parameter used to programatically reset alarms. When set to 1, all alarms
requiring reset are reset.
11
Data
Type
Cfg_CompletePulse
Alias For
Default
Description
BOOL
Cfg_HasOnFdbk
BOOL
Cfg_HasOffFdbk
BOOL
Cfg_UseOnFdbk
BOOL
Cfg_FdbkFail
BOOL
Cfg_HasPermObj
BOOL
1 = Tells HMI a permissive object (for example, P_Perm) is used for Inp_PermOK
and navigation to the permissive objects faceplate is enabled.
IMPORTANT: The name of the Permissive object in the controller must be this
object's name with the suffix '_Perm'. For example, if your P_DOut object has the
name 'DOut123', then its Permissive object must be named 'DOut123_Perm'.
Cfg_HasIntlkObj
BOOL
1 = Tells HMI an interlock object (for example, P_Intlk) is used for Inp_IntlkOK and
navigation to the interlock objects faceplate is enabled.
IMPORTANT: The name of the interlock object in the controller must be this
object's name with the suffix _Intlk. For example, if your P_DOut object has the
name DOut 123, then its interlock object must be named DOut 123_Intlk.
Cfg_PCmdClear
BOOL
Mode.Cfg_PCmdClear
When this parameter is 1, program commands are cleared once they are acted
upon. When set to 0, program commands remain set until cleared by the
application program logic.
IMPORTANT: Clearing this parameter online can cause unintended program
command execution.
Cfg_ProgDefault
BOOL
Mode.Cfg_ProgDefault
This parameter defines the default mode. When this parameter is 1, the mode
defaults to Program if no mode is being requested. When this parameter is 0, the
mode defaults to Operator if no mode is being requested.
IMPORTANT: Changing this parameter online can cause unintended mode
changes.
Cfg_OperOffPrio
BOOL
Cfg_OCmdResets
BOOL
Cfg_OvrdPermIntlk
BOOL
Cfg_ShedOnFail
BOOL
Cfg_ShedOnIOFault
BOOL
Cfg_HasOnFailAlm
BOOL
Cfg_UseOffFdbk
OnFail.Cfg_Exists
Cfg_HasOffFailAlm
OffFail.Cfg_Exists
Cfg_HasIntlkTripAlm
IntlkTrip.Cfg_Exists
Cfg_HasIOFaultAlm
IOFault.Cfg_Exists
12
Data
Type
Alias For
Default
Description
Cfg_OnFailResetReqd
BOOL
OnFail.Cfg_ResetReqd
These parameters determine whether a reset is required to clear the alarm status.
When these parameters are 1, the alarm is latched ON when the alarm occurs. After
the alarm condition returns to normal, a reset is required to clear the alarm status
(for example, OCmd_Reset, Inp_Reset, or Fail.OCmd_Reset is required to clear
Alm_Fail alarm after the alarm is set and the value returns to normal). When this
parameter is 0, no reset is required and the alarm status is cleared when the alarm
condition returns to normal.
IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.
1000
These parameters determine the severity of each alarm. This drives the color and
symbol that are used to indicate alarm status on the faceplate and global object.
The following are valid values:
1250 = Low
251500 = Medium
501750 = High
7511000 = Urgent
IMPORTANT: For FactoryTalk View software, version 7.0, these severity
parameters drive only the indication on the global object and faceplate. The
Alarms and Event definition severity drives the color and symbol that is used on the
alarm banner and alarm summary as well as the value returned by FactoryTalk
Alarms and Events display commands.
Cfg_OffFailResetReqd
OffFail.Cfg_ResetReqd
Cfg_IntlkTripResetReqd
IntlkTrip.Cfg_ResetReqd
Cfg_IOFaultResetReqd
IOFault.Cfg_ResetReqd
Cfg_OnFailAckReqd
BOOL
OnFail.Cfg_AckReqd
Cfg_OffFailAckReqd
OffFail.Cfg_AckReqd
Cfg_IntlkTripAckReqd
IntlkTrip.Cfg_AckReqd
Cfg_IOFaultAckReqd
IOFault.Cfg_AckReqd
Cfg_OnFailSeverity
INT
OnFail.Cfg_Severity
Cfg_OffFailSeverity
OffFail.Cfg_Severity
1000
Cfg_IntlkTripSeverity
IntlkTrip.Cfg_Severity
500
Cfg_IOFaultSeverity
IOFault.Cfg_Severity
1000
Cfg_SimFdbkT
DINT
Cfg_OnDelayT
REAL
0.0
Cfg_OnPulseT
REAL
0.5
Cfg_OffPulseT
REAL
0.5
Cfg_OnFailT
DINT
10
Cfg_OffFailT
DINT
10
Time after output Off to get Off feedback before fault (seconds).
PSet_Owner
DINT
PCmd_On
BOOL
When Cfg_PCmdClear is 1:
Set PCmd_On to 1 to turn the device on
While the device is on, set PCmd_OffPulse to 1 to pulse the device off once
Set PCmd_Off to 1 to turn the device off
While the device is off, set PCmd_OnPulse to 1 to pulse the device on once
Set PCmd_ContPulse to 1 to pulse the device continuously (blink)
These parameters reset Automatically
When Cfg_PCmdClear is 0:
Set PCmd_On to 1 to turn the device on
While the device is on, set PCmd_OffPulse to 1 to pulse the device off once
While the device is on, set PCmd_ContPulse to 1 to pulse the device
continuously (blink)
Set PCmd_On to 0 to turn the device off
While the device is off, set PCmd_OnPulse to 1 to pulse the device on once
While the device is off, set PCmd_ContPulse to 1 to pulse the device
continuously (blink)
PCmd_Off is not used
The AOI clears PCmd_OffPulse and PCmd_OnPulse when they are used, the
remaining parameters do not reset automatically
Cfg_OffDelayT
PCmd_Off
PCmd_OnPulse
PCmd_OffPulse
PCmd_ContPulse
13
Data
Type
Alias For
Default
Description
PCmd_Acq
BOOL
Mode.PCmd_Acq
When Cfg_PCmdClear is 1:
Set PCmd_Acq to 1 to Acquire
Set PCmd_Rel to 1 to Release
These parameters reset automatically
When Cfg_PCmdClear is 0:
Set PCmd_Acq to 1 to Acquire
Set PCmd_Acq to 0 to Release
PCmd_Rel is not used
These parameters do not reset automatically
When Cfg_PCmdClear is 1:
Set PCmd_Lock to 1 to Lock
Set PCmd_Unlock to 1 to Unlock
These parameters reset automatically
When Cfg_PCmdClear is 0:
Set PCmd_Lock to 1 to Lock
Set PCmd_Lock to 0 to Unlock
PCmd_Unlock is not used
These parameters do not reset automatically
When Cfg_PCmdClear is 1:
Set PCmd_<Alarm>Suppress to 1 to suppress alarm
Set PCmd_<Alarm>Unsuppress to 1 to unsuppress alarm
These parameters reset automatically
When Cfg_PCmdClear is 0:
Set PCmd_<Alarm>Suppress to 1 to suppress alarm
Set PCmd_<Alarm>Suppress to 0 to unsuppress alarm
PCmd_<Alarm>Unsuppress is not used
These Parameters do not reset automaticallyS
PCmd_Rel
PCmd_Lock
Mode.PCmd_Rel
BOOL
PCmd_Unlock
Mode.PCmd_Lock
Mode.PCmd_Unlock
PCmd_Reset
BOOL
PCmd_OnFailAck
BOOL
OnFail.PCmd_Ack
PCmd_OffFailAck
OffFail.PCmd_Ack
PCmd_IntlkTripAck
IntlkTrip.PCmd_Ack
PCmd_IOFaultAck
PCmd_OnFailSuppress
IOFault.PCmd_Ack
BOOL
PCmd_OffFailSuppress
OnFail.PCmd_Suppress
OffFail.PCmd_Suppress
PCmd_IntlkTripSuppress
IntlkTrip.PCmd_Suppress
PCmd_IOFaultSuppress
IOFault.PCmd_Suppress
PCmd_OnFailUnsuppress
OnFail.PCmd_Unsuppress
PCmd_OffFailUnsuppress
OffFail.PCmd_Unsuppress
PCmd_IntlkTripUnsuppress
IntlkTrip.PCmd_Unsuppress
PCmd_IOFaultUnsuppress
IOFault.PCmd_Unsuppress
PCmd_OnFailUnshelve
BOOL
OnFail.PCmd_Unshelve
PCmd_OffFailUnshelve
OffFail.PCmd_Unshelve
PCmd_IntlkTripUnshelve
IntlkTrip.PCmd_Unshelve
PCmd_IOFaultUnshelve
IOFault.PCmd_Unshelve
OCmd_On
BOOL
OCmd_Off
BOOL
OCmd_OnPulse
BOOL
OCmd_OffPulse
BOOL
OCmd_ContPulse
BOOL
OCmd_Bypass
BOOL
OCmd_Check
BOOL
MCmd_Disable
BOOL
MCmd_Enable
BOOL
14
Data
Type
Alias For
Default
Description
MCmd_Acq
BOOL
Mode.MCmd_Acq
MCmd_Rel
BOOL
Mode.MCmd_Rel
OCmd_AcqLock
BOOL
Mode.OCmd_AcqLock
OCmd_Unlock
BOOL
Mode.OCmd_UnlockRel
OCmd_Reset
BOOL
OCmd_ResetAckAll
BOOL
Operator command to reset and acknowledge all alarms and latched shed
conditions.
Data Type
Alias For
Description
EnableOut
BOOL
Enable output: The EnableOut signal is not manipulated by this instruction. Its output state
always reflects EnableIn input state.
Out
BOOL
Primary output:
1 = On
0 = Off
15
Data Type
SrcQ_IO
SINT
SrcQ
Alias For
Description
I/O signal source and quality.
Final device status source and quality.
GOOD
0 = I/O live and confirmed good quality
1 = I/O live and assumed good quality
2 = No feedback configured, assumed good quality
TEST
8 = Device simulated
9 = Device loopback simulation
10 = Manually entered value
UNCERTAIN 16 = Live input, off-specification
17 = Value substituted at device/bus
18 = Value substituted by maintenance (Has and not Use)
19 = Shed, using last good value
20 = Shed, using replacement value
BAD
32 = Signal failure (out-of-range, NaN, invalid combination)
33 = I/O channel fault
34 = I/O module fault
35 = Bad I/O configuration (for example, scaling parameters)
Val_Cmd
SINT
Device command:
0 = None
1 = Off
2 = On
3 = Pulse off
4 = Pulse on
5 = Pulse continuously
Val_Fdbk
SINT
Device feedback:
0 = Transition
1 = Off
2 = On
3 = Invalid
Val_Sts
SINT
Device status:
0 = Off
1 = On
2 = Pulse off
3 = Pulse on
4 = Pulse continuously
5 = Turning off
6 = Turning on
33 = Disabled
Val_Fault
SINT
Val_State
SINT
16
Data Type
Alias For
Description
Val_Mode
SINT
Mode.Val
The current mode is shown with status bits and also as an enumeration Val_Mode as follows:
0 = No mode
1 = Hand
2 = Maintenance
3 = Override
4 = Program (locked)
5 = Operator (locked)
6 = Program (unlocked, Operator is default)
7 = Operator (unlocked, Program is default)
8 = Program (unlocked, Program is default)
9 = Operator (unlocked, Operator is default)
Val_Owner
DINT
Val_Notify
SINT
Sts_Out
BOOL
1 = Output is On (energized).
0 = Output is Off (de-energized).
Sts_Pulsing
BOOL
Sts_FdbkOff
BOOL
Sts_FdbkOn
BOOL
Sts_FdbkFail
BOOL
Sts_Available
BOOL
Sts_Bypass
BOOL
Sts_BypActive
BOOL
Sts_Disabled
BOOL
Sts_NotRdy
BOOL
Nrdy_Disabled
BOOL
Sts_MaintByp
BOOL
Sts_AlmInh
BOOL
Sts_Err
BOOL
Nrdy_CfgErr
Nrdy_Intlk
Nrdy_Perm
Nrdy_OperPrio
Nrdy_Fail
Nrdy_IOFault
Nrdy_NoMode
17
Data Type
Err_Timer
BOOL
Err_Sim
BOOL
Err_Alarm
BOOL
Sts_Hand
BOOL
Alias For
Description
1 = Error in configuration:
Feedback check timer preset invalid (use 02,147,483).
Simulation timer preset (use 0 2,147,483).
Alarm minimum On time or severity.
Mode.Sts_Hand
Sts_Maint
Mode.Sts_Maint
Sts_Ovrd
Mode.Sts_Ovrd
Sts_Prog
Mode.Sts_Prog
Sts_Oper
Mode.Sts_Oper
Sts_ProgOperLock
BOOL
Mode.Sts_ProgOperLock
Sts_NoMode
BOOL
Mode.Sts_NoMode
Sts_MAcq_Rcvd
BOOL
Mode.Sts_MAcq_Rcvd
Sts_OnFail
BOOL
OnFail.Inp
Sts_OffFail
OffFail.Inp
Sts_IntlkTrip
IntlkTrip.Inp
Sts_IOFault
IOFault.Inp
Alm_OnFail
OnFail.Alm
Alm_OffFail
BOOL
OffFail.Alm
Alm_IntlkTrip
IntlkTrip.Alm
IOFault.Alm
OnFail.Ack
OffFail.Ack
Ack_IntlkTrip
IntlkTrip.Ack
Ack_IOFault
IOFault.Ack
OnFail.Disabled
Sts_OffFailDisabled
OffFail.Disabled
Sts_IntlkTripDisabled
IntlkTrip.Disabled
Sts_IOFaultDisabled
IOFault.Disabled
OnFail.Shelved
Sts_OffFailShelved
OffFail.Shelved
Sts_IntlkTripShelved
IntlkTrip.Shelved
Sts_IOFaultShelved
IOFault.Shelved
OnFail.Suppressed
Sts_OffFailSuppressed
OffFail.Suppressed
Sts_IntlkTripSuppressed
IntlkTrip.Suppressed
Sts_IOFaultSuppressed
IOFault.Suppressed
Alm_IOFault
Ack_OnFail
BOOL
Ack_OffFail
Sts_OnFailDisabled
Sts_OnFailShelved
Sts_OnFailSuppressed
18
BOOL
BOOL
BOOL
Data Type
Alias For
Rdy_On
BOOL
1 = Ready to receive OCmd: On, Off, OnPulse, OffPulse, ContPulse, Bypass, or Check (enables HMI
button).
Rdy_Disable
BOOL
Rdy_Enable
BOOL
Rdy_Reset
BOOL
Rdy_ResetAckAll
BOOL
P_DOut
BOOL
Rdy_Off
Description
Rdy_OnPulse
Rdy_OffPulse
Rdy_ContPulse
Rdy_Bypass
Rdy_Check
Data Type
Default
Description
Cfg_OStText
STRING_8
'Off'
Cfg_1StText
STRING_8
'On'
Cfg_Desc
STRING_40
'Discrete On/Off
Device'
Description for display on HMI. The string shows in the title bar of the faceplate.
Cfg_Label
STRING_20
'Discrete Device'
Label for graphic symbol displayed on HMI. This string appears on the graphic symbol.
Cfg_Tag
STRING_20
'P_DOut'
Description for display on HMI. The string shows in the title bar of the faceplate.
19
Operations
Modes
The P_DOut Add-On Instruction uses the following standard modes,
implemented by using an embedded P_Mode Add-On Instruction.
Graphic Symbol
Description
Operator mode
Control of the device is owned by the Operator. Operator Commands (OCmd_) and
Operator Settings (OSet_) from the HMI are accepted.
Program mode
Control of the device is owned by Program logic. Program Commands (PCmd_) and
Program Settings (PSet_) are accepted.
Override mode
Control of the device is owned by priority logic, superseding Operator and Program
control. Override Inputs (Inp_OvrdCmd and other Inp_OvrdXxxx values) are accepted. If
so configured, bypassable interlocks and permissives are bypassed.
Maintenance mode
Control of the device is owned by Maintenance. Operator Commands and Settings from
the HMI are accepted. Bypassable interlocks and permissives are bypassed, and device
timeout checks are not processed.
Hand mode
Control of the device is owned by hardwired logic or other logic outside the instruction.
The instruction tracks the state of the device for bumpless transfer back to one of the
other modes.
No mode
The device is disabled and has no owner because the EnableIn input is false. The main
instruction Logic routine is not being scanned. See Execution for more information on
EnableInFalse processing.
Alarms
The P_DOut instruction uses the following alarms, implemented by using
embedded P_Alarm Add-On Instructions.
20
Alarm
P_Alarm Name
Description
Interlock Trip
IntlkTrip
Triggered when an Interlock not OK causes the device to transition from the On
state or a pulsing operation to the Off state.
I/O Fault
IOFault
Off Fail
OffFail
Triggered when the device is commanded Off, but device feedback does not
confirm the device is Off within the configured time.
The OffFail Status/Alarm has a configurable time (Cfg_OffFailT) so the device
feedbacks can show the device reached the Off state before declaring a failure.
On Fail
OnFail
Triggered when the device is commanded On, but device feedback does not
confirm the device is On within the configured time.
The OnFail Status/Alarm has a configurable time (Cfg_OnFailT) so the device
feedbacks can show the device reached the On state before declaring a failure.
Simulation
Simulation in P_DOut de-energizes the output and simulates providing feedback
of a working device. You can test the operation of the instruction under
controlled conditions.
You must set the Inp_Sim parameter in the controller to 1 to enable simulation.
The Simulation icon
is displayed at the bottom left of the Operator
faceplate indicating the device is in simulation.
You can use Cfg_SimFdbkT to delay the echo of the On/Off status of the device.
When you have finished in simulation, set the Inp_Sim parameter in the
controller to 0. The output is re-energized and feedback is enabled.
Execution
The following table explains the handling of instruction execution conditions.
Condition
Description
Postscan
21
Programming Example
This example uses the P_DOut instruction to control a heating jacket on a vent
filter. The heating jacket is being used in this case to keep the vent filter dry when
there is potential for condensate buildup.
In this example, the vent filter heater jacket does not provide the feedback on its
status. In normal operating conditions, the vent filter heater jacket is being
commanded on or off by the control sequence configured in the controller. If the
operating status of the sequence is not OK, always command the vent filter off.
In this example, the controlling sequence issues a single bit for the desired state of
the vent filter heater. The parameter P_CmdOn is connected to this bit to
command the vent filter heater on and off. The parameter Cfg_PCmdClear is set
to 0, indicating that the command bit does not need reset by the instruction. This
setting also indicates that the P_DOut instruction acts upon P_CmdOn based
on value (level) instead of acting only on transition to true (edge) so that
P_CmdOn can be used to command both the On and Off states.
The controlling sequence could be written to set the command bits P_CmdOn
and P_CmdOff directly (for example, by using structured text within a SFC), in
which case Cfg_PCmdClear could be left at its default of 1 to cause the
instruction to clear the commands once they have been acted upon.
The parameter Cfg_ProgDefault is set to 1 to indicate that the normal operating
state of the controller is Program, meaning it is normally commanded by the
control sequence.
The status of the sequence is connected to the Inp_IntlkOK parameter so that
the output to the vent filter heater jacket is always off when the skid is not
operating properly, even if the instruction is not in Program mode.
The parameters Cfg_HasOnFdbk and Cfg_HasOffFdbk are both set to 0 to
indicate that the vent filter heater jacket does not provide feedback on its status.
The parameter Cfg_HasOnFailAlm, Cfg_HasOffFailAlm,
Cfg_HasIntlkTripAlm, and Cfg_HasIOFaultAlm are all set to 0, indicating that
no alarms are necessary for this device.
22
Lastly, configure the following local configuration tags to drive the text on the
HMI faceplate. In this example, the vent filter P&ID tag is JV9010. In this
example, they are set as follows:
Cfg_Tag:
JV9010
Cfg_Label:
Cfg_Desc:
Cfg_St0Text:
Off
Cfg_St1Text:
On
Local tags can be configured through the HMI faceplates or in RSLogix 5000
software by opening the Instruction Logic of the Add-On Instruction instance
and then selecting the string on the displayed rung.
All of the strings in local tags are shown on the first rung of the Add-On
Instruction's Logic routine for your convenience.
23
Display Elements
A display element (global object) is created once and can be referenced multiple
times on multiple displays in an application. When changes are made to the
original (base) object, the instantiated copies (reference objects) are
automatically updated. Use of global objects, in conjunction with tag structures
in the ControlLogix system, aid consistency and save time.
Table 6 - P_DOut Display Elements Description
Display Element Name
Display Element
Description
GO_P_DOut
Alarm Indicator
Status/Quality Indicator
Mode Indicator
Status/Quality
Indicator
Alarm Border
Device Status
Status/Quality Indicators
One of these symbols appears to the left of the graphic symbol when the
described condition is true.
Table 7 - Status/Quality Indicators
Graphic Symbol
Description
Invalid configuration.
I/O Fault.
I/O uncertain.
24
Description
The device is not ready to operate.
The device is disabled.
No symbol displayed
TIP
When the Invalid Configuration Indicator appears, you can find what
configuration setting is invalid by following the indicators. Click the graphic
symbol to open the faceplate. The Invalid Configuration indicator appears next
to the appropriate tab at the top of the faceplate to guide you in finding the
configuration error. Once you navigate to the tab, the misconfigured item is
flagged with this indicator or appear in a magenta box.
For the Discrete Output instruction, the Invalid Configuration indicator appears
under the following conditions:
The outputs On Delay, Off Delay, On Pulse, Off Pulse, On Failure Check,
or Off Failure Check time is set to a value less than zero or greater than
2,147,483 seconds.
The simulated feedback time is set to a value less than zero or greater than
2,147,483 seconds.
An Alarm Minimum On Time is set to a value less than zero or greater
than 2,147,483 seconds.
Alarm Severity is set to a value less than 1 or greater than 1000.
TIP
When the Not Ready indicator appears, you can find what condition is
preventing operation by following the indicators. Click the graphic symbol to
open the faceplate. The Not Ready indicator appears next to the appropriate
tab at the top of the faceplate to guide you in finding the condition. When you
navigate to the tab, the condition preventing operation is flagged.
For the Discrete Output instruction, the Device Not Ready indicator appears
under the following conditions:
The device has been disabled by Maintenance.
There is a configuration error.
An interlock or permissive is not OK.
The Operator State 0 priority command requires reset.
There is a Device failure or I/O Fault and shed requires reset.
The device logic is disabled or there is no mode.
25
Description
A Maintenance Bypass is active.
No symbol displayed
TIP
When the Maintenance Bypass Indicator appears, you can find what condition
was bypassed by following the indicators. Click the graphic symbol to open the
faceplate. The Maintenance Bypass Indicator appears next to the appropriate
tab at the top of the faceplate to guide you in finding the
bypass. Once you navigate to the tab, the bypassed item is flagged with this
indicator.
For the Discrete Output instruction, the Maintenance Bypass Indicator appears
under the following conditions:
A feedback input that Engineering has configured to exist has been set by
Maintenance to not be used.
Maintenance has bypassed the bypassable interlocks and permissives.
Mode Indicators
One of these symbols appears to the right of the graphic symbol to indicate the
mode of the device instruction
Table 8 - P_DOut Mode Indicators
Graphic Symbol
Transparent
Description
Operator mode (if the default mode is Operator and in Operator mode, the mode indicator
is transparent)
Operator mode (if the default mode is Program)
Operator mode locked
Transparent
Program mode (if the default mode is Program and in Program mode, the mode indicator is
transparent)
Program mode (if the default mode is Operator)
Program mode locked
Override mode
26
Description
Maintenance mode
Hand mode
No mode
The images provided for the Operator and Program default modes are
completely transparent; therefore, no mode indicators appear if the device is in
its default mode. This behavior can be changed by replacing these mode
indicators with images that are not completely transparent.
TIP
Alarm Indicators
One of these symbols appears to the left of the Label to indicate the described
alarm condition. The alarm border and label background blink if
Acknowledgement of an alarm condition is required.
Symbol
No symbol
Description
No change in color
White
Blue
Yellow
Red
Magenta
No change in color
27
2. In the display, right-click the global object and choose Global Object
Parameter Values.
The Global Object Parameter Values dialog box appears.
28
Required
Description
#102
Object tag to point to the name of the associated object Add-On Instruction
in the controller.
#103
Path used for display navigation features to other objects. Include program
scope if tag is a program scope tag.
#120
#121
#122
3. Type the tag or value in the Value column as specified in the Description
column.
TIP
4. Click OK.
Quick Display
The Quick Display screen provides means for operators to perform simple
interactions with the P_DOut instruction instance. From the Quick Display,
you can navigate to the faceplate for full access for operation, maintenance,
and configuration for operation, maintenance, and configuration.
29
Faceplate
The P_DOut faceplate consists of five tabs and each tab consists of one or more
pages.
The faceplate contains the value of local configuration tags Cfg_Tag and
Cfg_Desc in the title bar.
The Operator tab is displayed when the faceplate is initially opened. Click the
appropriate icon at the top of the faceplate to access a specific tab.
Maintenance
Operator
Diagnostics
Engineering
Help
Alarms
Exit
The faceplate provides the means for operators, maintenance personnel, and
others to interact with the P_DOut instruction instance, including viewing its
status and values and manipulating it through its commands and settings.
Operator Tab
The Faceplate initially opens to the Operator (Home) tab. From here, an
operator can monitor the device status and manually operate the device when it is
in Operator mode.
The Operator tab shows the following information:
Current mode (Operator, Program, Override, Maintenance, or Hand)
Requested Modes indicator (Appears only if the Operator or Program
mode has been superseded by another mode)
Interlock and Permissive States
Input Source and Quality indicator (See 'SrcQ' in the Output parameters
table on page 16 for details).
30
Mode Indicator
Requested Mode
Indicator
Operator Mode
Command Buttons
Feedback Indicator
Output 'On' Button
Continuous Pulse
Button
The following table shows the functions included on the Operator tab.
Table 9 - Operator Tab Description
Function
Action
Security
Manual Device
Operation (Code B)
31
Action
Security
Normal Operation of
Devices (Code A)
Acknowledge Alarms
(Code F)
None
If the object is configured to have permissive and interlock objects (for example,
Cfg_HasIntlkObj is true), the permissive and interlock indication become
buttons that open the faceplates of the source objects used as a permissive or
interlock (often this is a P_Intlk interlock object or a P_Perm permissive object).
If the object is not configured in this way, the permissive or interlock are
indicators only.
Refer to these publication for more information:
Rockwell Automation Library of Process Objects: Permissives with Bypass
(P_Perm) Reference Manual, publication SYSLIB-RM007
Rockwell Automation Library of Process Objects: Interlock with First Out
and Bypass (P_Intlk) Reference Manual, publication SYSLIB-RM004
32
Interlock Symbol
Description
One or more conditions not OK
Non-bypassed conditions OK
All conditions OK
On Fail Alarm
33
The following table shows the alarm status on the Operator tab.
Table 10 - Operator Tab Alarm Status
Graphic Symbol
Alarm Status
In Alarm (Active Alarm).
In Alarm and Acknowledged.
Out of Alarm but not Acknowledged.
Alarm Suppressed (by Program logic).
Alarm Disabled (by Maintenance).
Alarm Shelved (by Operator)
34
Maintenance Tab
Maintenance personnel use the information and controls on the Maintenance tab
to make adjustments to device parameters, troubleshoot and temporarily work
around device problems, and disable the device for routine maintenance.
The Maintenance tab has two pages.
Mode Indicator
35
The following table shows the functions on page 1 of the Maintenance tab.
Table 11 - Maintenance Tab Page 1 Description
Function
Action
Security
Configuration Parameters
Equipment
Maintenance
(Code C)
None
Equipment
Maintenance
(Code C)
None
36
In Override Mode,
bypass Interlocks
and Permissives
that can be
bypassed
Use Device ON
feedback
Disable
Alarms
Bypass
Permissives
and Interlocks
(Code H)
Cfg_OvrdPermIntlk
Equipment
Maintenance
(Code C)
Cfg_UseOffFdbk
Cfg_UseOnFdbk
The following table shows value settings on page 2 of the Maintenance tab.
Table 12 - Maintenance Tab Page 2 Description
Function
Action
Security
Configuration Parameters
Configuration
and Tuning
Maintenance
(Code D)
Cfg_OnFailT
Cfg_OffFailT
Delay before
initially turning
output ON
(seconds)
Cfg_OnDelayT
Delay before
initially turning
output OFF
(seconds)
Cfg_OffDelayT
37
Action
Security
Configuration Parameters
Cfg_OnPulseT
Configuration
and Tuning
Maintenance
(Code D)
Cfg_OffPulseT
Engineering Tab
The Engineering tab provides access to device configuration parameters and
ranges, options for device and I/O setup, displayed text, faceplate-to-faceplate
navigation settings, and for initial system commissioning or later system changes.
The Engineering tab has three pages.
38
The following table lists the functions on page 1 of the Engineering tab.
Table 13 - Engineering Tab 1 Description
Function
Action
Security
Configuration Parameters
None
Description
Cfg_Desc
Label
Engineering
Configuration
(Code E)
Tag
Cfg_Tag
Text to Display in
CV = 0 State
Cfg_OStText
Cfg_HasOffFdbk
Cfg_FdbkFail
Clear Program
Commands on
Receipt
Text to Display in
CV = 1 State
Device has OFF
feedback
Device has ON
feedback
Cfg_Label
Cfg_1StText
Cfg_HasOnFdbk
Cfg_PCmdClear
This display lets you select the default mode for the object by selecting the
appropriate mode.
IMPORTANT
If no mode is being requested, changing the default mode changes the mode
of the instruction.
39
You must have FactoryTalk View security code E to select the default mode on
this display.
The following table shows the functions on page 2 of the Engineering tab.
Table 14 - Engineering Tab Page 2 Description
40
Function
Action
Security
Configuration Parameters
Operator command
resets fault
Engineering
Configuration
(Code E)
Cfg_OCmdResets
Operator Off
command available
in any mode
Cfg_OperOffPrio
Cfg_CompletePulse
Action
Enable navigation
Check if a permissive instruction is
to permissive object used with this device. This changes
the Permissive indicator to a clickable
button to open the Permissive
faceplate.
IMPORTANT: The name of the
Permissive object in the controller
must be this object's name with the
suffix '_Perm'. For example, if your
P_DOut object has the name
'DOut123', then its Permissive object
must be named 'DOut123_Perm'.
Security
Configuration Parameters
Engineering
Configuration
(Code E)
Cfg_HasPermObj
Enable navigation
to interlock object
Cfg_HasIntlkObj
Deengerize Output:
on I/O Fault
Cfg_ShedOnIOFault
Deengerize Output:
on Position Fail
Cfg_ShedOnFail
Deengerize Output:
on Interlock Trip
None
41
The following table shows the functions on page 3 of the Engineering tab.
Table 15 - Engineering Tab Page 3 Description
42
Function
Action
Security
Configuration Parameters
Engineering
Configuration
(Code E)
Cfg_SimFdbkT
Diagnostics Tab
The Diagnostic tab provides indications helpful in diagnosing or preventing
device problems, which could include specific reasons a device is 'Not Ready',
device warnings and faults, warning and fault history, and predictive/preventive
maintenance data.
43
Alarms Tab
The Alarms tab displays each configured alarm for the P_DOut instruction. The
icon on the tab for the alarms page changes color based on the current active
alarms. A blinking alarm icon indicates that one or more alarms must be
acknowledged or the device must be reset.
Alarm Acknowledge
Command Button
Alarm Names
Alarm Severity Indicators
Click an alarm name to open the P_Alarm faceplate for that alarm. From the
P_Alarm faceplate, you can configure and perform additional operations on the
alarm.
If an alarm is active, the panel behind the alarm changes color to match the
severity of the alarm. The color of the bell icon at the top of the faceplate shows
the highest active alarms severity, and the icon blinks if any alarm is
unacknowledged or requires reset.
44
Definition
Magenta
Urgent
Red
High
Yellow
Medium
Blue
Low
No alarm
Action
Security
Acknowledge Alarms
(Code F)
Alarm Name
The Reset and Acknowledge All Alarms button is enabled, the panel behind the
alarm blinks, and the Alarm Acknowledge button is enabled if the alarm requires
acknowledgment. Click the button with the checkmark to acknowledge the
alarm.
Refer to the Rockwell Automation Library of Process Objects: Common Alarm
Mode (P_Alarm) Reference Manual, publication SYSLIB-RM002, for more
information.
45
46
Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this
manual. You can contact Customer Support for initial help in getting your product up and running.
United States or Canada
1.440.646.3434
Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your
distributor to complete the return process.
Please contact your local Rockwell Automation representative for the return procedure.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.
Rockwell Otomasyon Ticaret A.., Kar Plaza Merkezi E Blok Kat:6 34752 erenky, stanbul, Tel: +90 (216) 5698400
Copyright 2014 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.