Rockwell Automation Discrete 2 Reference Manual
Reference Manual
Rockwell Automation Library of Process Objects:
Discrete 2-, 3-, or 4-state Device (P_D4SD)
Version 3.5
IMPORTANT
This manual applies to the Rockwell Automation Library of Process Objects version 3.5 or earlier.
For Rockwell Automation Library of Process Objects version 5.0, see
• PROCES-RM200
For Rockwell Automation Library of Process Objects version 4.0 or later, use the following manuals:
• PROCES-RM013 contains logic instructions
• PROCES-RM014 contains display elements
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to
familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws,
and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required
to be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the
use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and
requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or
liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or
software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation,
Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
IMPORTANT
Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to
potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL
Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, and Rockwell Automation are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of Contents
Preface Software Compatibility and Content Revision. . . . . . . . . . . . . . . . . . . . 5
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Discrete 2-, 3-, 4-state Device
(P_D4SD)
Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Discrete 2-, 3-, 4-state Device Input Structure. . . . . . . . . . . . . . . . 12
Discrete 2-, 3-, or 4-state Device Output Structure . . . . . . . . . . . 16
Discrete 2-, 3-, or 4-state Device Local Configuration Tags. . . . 20
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Using Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Quick Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Discrete 2-, 3-, 4-state Device Faceplate Help . . . . . . . . . . . . . . . . 54
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 3
Table of Contents
Notes:
4 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
Preface
Software Compatibility and Content Revision
Table 1 - Summary of Changes
Topic Page
Visualization Files: Global Objects (.ggfx) - Process Diagnostic Objects 10
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.
For general library considerations, see Rockwell Automation Library of Process
Objects, publication
PROCES-RM002.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 5
Preface
Additional Resources
These documents contain additional information concerning related products
from Rockwell Automation.
Resource Description
PlantPAx® Distributed Control System Selection Guide,
publication
PlantPAx Distributed Control System Reference Manual,
publication
Rockwell Automation Library of Process Objects,
publication
FactoryTalk® View Machine Edition User Manual,
publication
FactoryTalk View SE Edition User Manual,
publication
Logix5000™ Controllers Add-On Instructions Programming
Manual, publication
Rockwell Automation Library of Process Objects: Common
Alarm Block (P_Alarm) Reference Manual, publication
SYSLIB-RM002
Rockwell Automation Library of Process Objects: Interlocks
with First Out and Bypass (P_Intlk) Reference Manual,
publication
Rockwell Automation Library of Process Objects: Common
Mode Block (P_Mode) Reference Manual, publication
SYSLIB-RM005
Rockwell Automation Library of Process Objects: Permissives
with Bypass (P_Perm) Reference Manual, publication
SYSLIB-RM007
PROCES-SG001
PROCES-RM001
PROCES-RM002
VIEWME-UM004
VIEWSE-UM006
1756-PM010
SYSLIB-RM004
Provides information to assist with equipment
procurement for your PlantPAx system.
Provides characterized recommendations for
implementing your PlantPAx system.
Provides general considerations for the PlantPAx system
library of process objects.
Provides details on how to use this software package for
creating an automation application.
Provides details on how to use this software package for
developing and running human-machine interface
(HMI) applications that can involve multiple users and
servers, distributed over a network.
Provides information for designing, configuring, and
programming Add-On Instructions.
Details how to monitor an input condition to raise an
alarm. Information includes acknowledging, resetting,
inhibiting, and disabling an alarm. Generally the
P_Alarm faceplate is accessible from the Alarms tab.
Explains how to collect (sum up) the interlock
conditions that stop or de-energize a running or
energized piece of equipment or prevent it from
starting or being energized.
Explains how to choose the Mode (owner) of an
instruction or control strategy. The Mode instruction is
usually embedded within other instructions to extend
their functionality. It is possible to use a standalone
Mode instruction to enhance a program where modes
are wanted.
Details how to collect permissive conditions to start a
piece of equipment.
You can view or download publications at
http:/www.rockwellautomation.com/literature/. To order paper copies of
technical documentation, contact your local Allen-Bradley distributor or
Rockwell Automation sales representative.
6 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
Discrete 2-, 3-, 4-state Device (P_D4SD)
The P_D4SD (Discrete 2-, 3-, 4-state Device) Add-On Instruction controls and
monitors feedback from a discrete 2-state, 3-state, or 4-state device in various
modes, monitoring for fault conditions. These devices include multiple-speed
motors or multiple-position valves. The global objects and the following
faceplate are examples of the graphical interface tools that are used with this
instruction.
Add-On Instruction
Faceplate
Guidelines
Global Objects
Use this instruction in these situations:
• You need to operate a discrete device that has two, three, or four unique
states, and the device is not supported by other Rockwell Automation
Library of Process Objects Add-On Instructions for various motors, valves,
and so forth.
• You have a device, such as a valve or motor, that is supported by other
Add-On Instructions, but you want the device to use non-standard state
names, such as ‘recycle’ and ‘deliver’ for a diverter valve, rather than the
fixed names used in the other Instruction, such as ‘closed’ and ‘open’. The
P_D4SD Instruction has configurable names for each of the device states.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 7
Discrete 2-, 3-, 4-state Device (P_D4SD)
Do not use this instruction in these situations:
• You need to operate a device that has more than four states, such as a six-
position rotary selector valve. You can use the P_nPos
(n-Position Device) Add-On Instruction instead.
• You need to operate a single-speed motor, two-speed motor, simple
reversing motor, solenoid valve, motor-operated valve, mix-proof valve, or
other device that is better supported by other Rockwell Automation
Library of Process Objects Add-On Instructions. Instructions such as
P_Motor, P_MotorRev, P_Motor2Spd, P_ValveSO, P_ValveMO, and
P_ValveMP more closely model the device under control and can provide
better diagnostics for the device.
• You need to operate a continuously-variable device. Use the P_AOut
(Analog Output), P_ValveC (Control Valve), or P_VSD (Variable Speed
Drive) Add-On Instruction instead.
• You need to operate a two-state device that requires pulsing (single-pulse
or continuous). Use the P_DOut (Discrete Output) Instruction instead.
Functional Description
The Discrete 2-, 3-, or 4-state Device Add-On Instruction provides the following
capabilities:
• Provides configuration to have two, three, or four selectable states for the
device.
• Provides Operator and Program Commands to select one of the two,
three, or four states of the device.
• Controls four discrete outputs, with configurable states of each output in
the various device states. Each output can be set, cleared, or left in last state
in a given device state.
• Monitors four discrete feedback inputs, with configurable states
(including ‘must be on’, ‘must be off’, and ‘don't care’) for each input in the
various device states for monitoring the actual position of the device.
• Provides configurable text labels for each of the states.
• When feedback inputs are used, detects failure to reach the target state,
after a configurable time, and alarms the failure. Optionally ‘sheds’ to the
default state (state 0) on a feedback failure.
• Monitors Permissive conditions that allow commanding the device to each
state.
• Monitors Interlock conditions that return the device to its default state
(state 0).
• Provides simulation of a normal working device, while holding the outputs
to the real device de-energized, for use in testing or operator training.
• Monitors I/O communication status, providing an alarm on an I/O fault.
Optionally ‘sheds’ to the default state on an I/O fault condition.
• Provides an ‘Available’ Status when in Program mode and operating
normally for use by automation logic to determine if the logic can
manipulate the device.
• Operates in Hand, Maintenance, Override, Program, and
Operator modes. (See
Modes on page 20.)
8 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
Discrete 2-, 3-, 4-state Device (P_D4SD)
Required Files
Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times in
your application code as needed.
Controller File
The P_D4SD_3_5-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
This Add-On Instruction has associated visualization files that provide a
common user interface. These files can be downloaded from the Product
Compatibility and Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.
IMPORTANT
Images are external graphic files that can be used in displays. They must be
imported for FactoryTalk View to make use of them.
When PNG files are imported, they are renamed by FactoryTalk View with
a .bmp file extension, but retain a .png format.
Table 2 - Visualization Files: Images (.png)
FactoryTalk View SE Software FactoryTalk View ME Software Description
All .png files in the images folder All .png files in the images folder These are the common icons used in the global objects and
The Global Object files (.ggfx file type) in the following table are Process Library
display elements that are created once and referenced multiple times on multiple
displays in an application. When changes are made to a Global Object, all
instances in the application are automatically updated.
The visualization file dependencies require Process Library content imports to
occur in a specific order as reflected in the following tables:
• Images
• Global Objects
• Standard Displays
• HMI Tags
• Macros
standard displays for all Process Objects.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 9
Discrete 2-, 3-, 4-state Device (P_D4SD)
Table 3 - Visualization Files: Global Objects (.ggfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) Common Faceplate Objects (RA-BAS-ME) Common Faceplate Objects Global objects used on process object faceplates.
(RA-BAS) P_D4SD Graphics Library (RA-BAS-ME) P_D4SD Graphics Library P_D4SD global object device symbols used to build
(RA-BAS) P_D4SD Motor Graphics Library (RA-BAS-ME) P_D4SD Motor Graphics Library P_D4SD Motor global object device symbols used to build
(RA-BAS) Process Alarm Objects (RA-BAS-ME) Process Alarm Objects Global objects used for managing alarms on process
(RA-BAS) Process Diagnostic Objects (RA-BAS-ME) Process Diagnostic Objects Diagnostic global objects used on process object
(RA-BAS) Process Faceplate Misc Objects (RA-BAS-ME) Process Faceplate Misc Objects Miscellaneous global objects used on process object
(RA-BAS) Process Help Objects (RA-BAS-ME) Process Help Objects Global objects used for all process objects help displays.
(RA-BAS) Process Interlock Objects (RA-BAS-ME) Process Interlock Objects Global objects used for managing interlocks and
(RA-BAS) Process Mode Objects (RA-BAS-ME) Process Mode Objects Global objects used for managing modes on process
process graphics.
process graphics.
object faceplates.
faceplates.
faceplates.
permissives on process object faceplates.
object faceplates.
The Standard Display files (.gfx file type) in the following table are the Process
Library displays that you see at runtime.
Table 4 - Visualization Files: Standard Displays (.gfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) Common-AnalogEdit N/A Faceplate used for analog input data entry. The FactoryTalk
(RA-BAS) P_Alarm-Faceplate (RA-BAS-ME) P_Alarm-Faceplate The faceplate that is used for managing alarms for
(RA-BAS) P_Alarm-Help (RA-BAS-ME) P_Alarm-Help Alarm Help information that is accessed from the
(RA-BAS) P_D4SD-Config (RA-BAS-ME) P_D4SD-Config The Configuration Display used to configure the
(RA-BAS) P_D4SD-Faceplate (RA-BAS-ME) P_D4SD-Faceplate The faceplate that is used for the object
(RA-BAS) P_D4SD-Quick (RA-BAS-ME) P_D4SD-Quick The Quick display that is used for the object
(RA-BAS) P_Mode-Config (RA-BAS-ME) P_Mode-Config The Configuration Display used to configure the
(RA-BAS) P_Mode-Help (RA-BAS-ME) P_Mode-Help Mode Help information that is accessed from the
(RA-BAS) Process Discrete Family-Help (RA-BAS-ME) Process Discrete Family-Help The Help display for Discrete objects
View ME faceplates use the native analog input data entry
so no file is required.
the object.
P_AIarm faceplate.
P_D4SD object.
P_Mode object.
Help faceplate.
HMI Tags are created in a FactoryTalk View ME application to support tab
switching on Process Library faceplates. The HMI tags may be imported via the
comma-separated values file (.csv file type) in the following table.
Table 5 - Visualization Files: HMI Tags (.csv)
FactoryTalk View SE Software FactoryTalk View ME Software Description
N/A FTVME_PlantPAxLib_Tags_3_5_xx.csv
where xx = the service release number.
10 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
These tags must be imported into the
FactoryTalk View ME project to support switching tabs on
any Process Object faceplate.
Discrete 2-, 3-, 4-state Device (P_D4SD)
Controller Code
This section describes the parameter references for this Add-On Instruction.
Discrete 2-, 3-, 4-state Device Input Structure
Input parameters include the following:
• Input data elements (Inp_) are typically used to connect field inputs from
I/O modules or signals from other objects.
• Configuration data elements (Cfg_) are used to set configurable
capabilities and features of the instruction.
• Command data elements (PCmd_, OCmd_, MCmd_) are used by
program logic, operators, and maintenance personnel to request
instruction actions.
• Setting data elements (PSet_) are used by program logic to establish
runtime setpoints, thresholds, and so forth.
Table 6 - P_D4SD Input Parameters
Input Parameter Data
Type
EnableIn BOOL 1 Ladder Diagram:
Inp_FdbkA BOOL 0 Feedback input signals from device. Use the feedback configuration
Inp_FdbkB
Inp_FdbkC
Inp_FdbkD
Inp_DeviceFault BOOL 0 Input Signal: Device fault from device.
Inp_PermOK0 BOOL 1 1 = Permissives OK, device can be commanded to State 0...3.
Inp_PermOK1
Inp_PermOK2
Inp_PermOK3
Inp_NBPermOK0 BOOL 1 1 = Non-Bypassable Permissives OK, device can be commanded to State 0...3.
Inp_NBPermOK1
Inp_NBPermOK2
Inp_NBPermOK3
Inp_IntlkOK BOOL 1 1 = Interlocks OK.
Inp_NBIntlkOK BOOL 1 1 = Non-bypassable Interlocks OK.
Alias For Default Description
If the rung-in condition is true, the instruction’s Logic routine executes. If the
rung-in condition is false, the instruction’s EnableInFalse routine executes.
Function Block Diagram:
If true, or not connected, the instruction’s Logic routine executes. If the
parameter is exposed as a pin and wired, and the pin is false, the instruction’s
EnableInFalse routine executes.
Structured Text:
No effect. The instruction’s Logic routine executes.
parameters (for example, Cfg_FdbkSt0Check and Cfg_FdbkSt0State) to
determine how these inputs are used to determine actual state.
1 = fault
0 = Not OK, go to State 0.
0 = Not OK, go to State 0.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 11
Discrete 2-, 3-, 4-state Device (P_D4SD)
Table 6 - P_D4SD Input Parameters
Input Parameter Data
Type
Inp_IOFault BOOL 0 Input Communication Status:
Inp_Sim BOOL 0 Simulation input. When set to 1, the instruction simulates a working device
Inp_Hand BOOL Mode.Inp_Hand 0 1 = Select Hand (hard-wired) mode.
Inp_Ovrd BOOL Mode.Inp_Ovrd 0 1 = Select Override mode.
Inp_OvrdCmd DINT 0 Override mode device command:
Inp_Reset BOOL 0 Input parameter used to programatically reset alarms. When set to 1, all
Cfg_St0onShed BOOL 0 1 = Go to State 0 on Shed.
Cfg_NumStates DINT 2 Number of device states (2…4).
Cfg_OutSt0Write SINT 2#0000_1111 These configuration parameters determine how the outputs are used to
Cfg_OutSt0State 2#0000_0001
Cfg_OutSt1Write 2#0000_1111
Cfg_OutSt1State 2#0000_0010
Cfg_OutSt2Write 2#0000_1111
Cfg_OutSt2State 2#0000_0100
Cfg_OutSt3Write 2#0000_1111
Cfg_OutSt3State 2#0000_1000
Cfg_FdbkSt0Check SINT 2#0000_0000 These configuration parameters determine how the inputs are used to
Cfg_FdbkSt0State 2#0000_0001
Cfg_FdbkSt1Check 2#0000_0000
Cfg_FdbkSt1State 2#0000_0010
Cfg_FdbkSt2Check 2#0000_0000
Cfg_FdbkSt2State 2#0000_0100
Cfg_FdbkSt3Check 2#0000_0000
Cfg_FdbkSt3State 2#0000_1000
Cfg_HasPerm0Obj BOOL 0 1 = Tells HMI a permissive object (for example, P_Perm) is used for
Cfg_HasPerm1Obj
Cfg_HasPerm2Obj
Cfg_HasPerm3Obj
Cfg_HasIntlkObj BOOL 0 1 = Tells HMI an interlock object (for example, P_Intlk) is used for Inp_IntlkOK
Alias For Default Description
0 = OK
1 = Fail
while keeping outputs de-energized. When set to 0, the instruction controls
the device normally.
0 = None
1 = State 0
2 = State 1
3 = State 2
4 = State 3
alarms requiring reset are reset.
0 = Hold position on Shed.
command state. The parameter Cfg_OutSt[x]Write configures which outputs
get written for each state. The parameter Cfg_OutSt[x]State configures what
gets written for each state.
For example, if all outputs must be set to 0 except Out_A which must be set
to 1 to command the device to state 1, then Cfg_OutSt1Write must be
2#0000_1111 and Cfg_OutSt1State must be 2#0000_0001.
By default, all four outputs are written in every state, with a single output set
to 1 in each state.
determine state. The parameter Cfg_FdbkSt[x]Check configures which inputs
get checked for each state. The parameter Cfg_FdbkSt[x]State configures the
values of the inputs which determine each state.
For example, if the device returns a 0 to Inp_FdbkA and Inp_FdbkB and a 1 to
Inp_FdbkC when the device is in state 3, then Cfg_FdbkSt3Check must be
2#0000_0111 and Cfg_FdbkSt1Write must be 2#0000_0100.
By default, all inputs are ‘don’t’ care’ in every state (no feedback checking).
Inp_PermOK0....3 and navigation to the channel object’s faceplate is enabled.
IMPORTANT: The name of the Permissives object in the controller must be this
object's name with the suffix ‘_Perm#’, where ‘#’ is the permissive number
(0…3) For example, if your P_D4SD object has the name ’D4SD123’, then its
Permissives object must be named ‘D4SD123_Perm0’.
and navigation to the interlock object’s 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_D4SD object has
the name 'D4SD123', then its interlock object must be named 'D4SD123_Intlk'.
12 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
Table 6 - P_D4SD Input Parameters
Discrete 2-, 3-, 4-state Device (P_D4SD)
Input Parameter Data
Type
Cfg_PCmdClear BOOL Mode.Cfg_PCmdClear 1 When this parameter is 1, program commands are cleared once they are acted
Cfg_ProgDefault BOOL Mode.Cfg_ProgDefault 0 This parameter defines the default mode. When this parameter is 1, the mode
Cfg_OperSt0Prio BOOL 0 1 = OCmd_St0 has priority, accepted any time
Cfg_OCmdResets BOOL 0 1 = New Operator state command resets fault.
Cfg_OvrdPermIntlk BOOL 0 1 = Override mode ignores Bypassable Permissives/Interlocks.
Cfg_ShedOnFail BOOL 1 1 = Go to shed state and alarm on Fail to reach position, Device fault, or I/O
Cfg_ShedOnDeviceFault
Cfg_ShedOnIOFault
Cfg_HasFailAlm BOOL Fail.Cfg_Exists 0 1 = Fail to Reach State alarm, Device Fault alarm, Interlock Trip alarm, and I/O
Cfg_HasDeviceFaultAlm DeviceFault.Cfg_Exists
Cfg_HasIntlkTripAlm IntlkTrip.Cfg_Exists
Cfg_HasIOFaultAlm IOFault.Cfg_Exists
Cfg_FailResetReqd BOOL Fail.Cfg_ResetReqd 0 These parameters determine whether a reset is required to clear the alarm
Cfg_DeviceFaultResetReqd DeviceFault.Cfg_ResetReqd
Cfg_IntlkTripResetReqd IntlkTrip.Cfg_ResetReqd
Cfg_IOFaultResetReqd IOFault.Cfg_ResetReqd
Cfg_FailAckReqd BOOL Fail.Cfg_AckReqd 1 These parameters determine whether an acknowledgement is required for an
Cfg_DeviceFaultAckReqd DeviceFault.Cfg_AckReqd
Cfg_IntlkTripAckReqd IntlkTrip.Cfg_AckReqd
Cfg_IOFaultAckReqd IOFault.Cfg_AckReqd
Cfg_FailSeverity INT Fail.Cfg_Severity 1000 These parameters determine the severity of each alarm. This drives the color
Cfg_DeviceFaultSeverity DeviceFault.Cfg_Severity 1000
Cfg_IntlkTripSeverity IntlkTrip.Cfg_Severity 500
Cfg_IOFaultSeverity IOFault.Cfg_Severity 1000
Alias For Default Description
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.
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.
0 = OCmd_St0 only in Operator or Maintenance Mode.
0 = Reset required to clear fault.
0 = Override mode uses Bypassable Permissives/Interlocks.
fault.
0 = Alarm only on fail, Device fault, or I/O fault.
Shed state is determined by configuration parameter Cfg_St0onShed.
Fault alarm exist and are checked.
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 the Fail alarm after the alarm is set and the value returns to
normal). When these parameters are 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.
alarm. When these parameters are 1, the acknowledge (ack) bit is cleared
when the alarm occurs. An acknowledge command (for example,
PCmd_FailAck or Fail.OCmd_Ack) is required to acknowledge the alarm. When
set to 0, the Acknowledge bit is set when an alarm occurs indicating an
acknowledged alarm and no acknowledge command is required.
and symbol that are used to indicate alarm status on the faceplate and global
object.
The following are valid values:
1…250 = Low
251…500 = Medium
501…750 = High
751…1000 = 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 Events definition of 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.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 13
Discrete 2-, 3-, 4-state Device (P_D4SD)
Table 6 - P_D4SD Input Parameters
Input Parameter Data
Type
Cfg_OutAPulseT REAL 0.0 Time to pulse Output A...D (s) (0=output held continuously).
Cfg_OutBPulseT
Cfg_OutCPulseT
Cfg_OutDPulseT
Cfg_SimFdbkT DINT 2 Delay to echo back reaching state when in simulation (seconds).
Cfg_FailT DINT 10 Time after new state requested to reach that state before fault (seconds).
PSet_Owner DINT 0 Program owner request ID (non-zero) or release (zero).
PCmd_St0 BOOL 0 When Cfg_PCmdClear is 1:
PCmd_St1
PCmd_St2
PCmd_St3
PCmd_Acq BOOL Mode.PCmd_Acq 0 When Cfg_PCmdClear is 1:
PCmd_Rel Mode.PCmd_Rel
PCmd_Lock BOOL Mode.PCmd_Lock 0 When Cfg_PCmdClear is 1:
PCmd_Unlock Mode.PCmd_Unlock
PCmd_Reset BOOL 0 • Set PCmd_Reset to 1 to reset all alarms requiring reset
PCmd_FailAck BOOL Fail.PCmd_Ack 0 • Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm
PCmd_DeviceFaultAck DeviceFault.PCmd_Ack
PCmd_IntlkTripAck IntlkTrip.PCmd_Ack
PCmd_IOFaultAck IOFault.PCmd_Ack
Alias For Default Description
• Set PCmd_St0 to 1 to set the device to State 0
• Set PCmd_St1 to 1 to set the device to State 1
• Set PCmd_St2 to 1 to set the device to State 2
• Set PCmd_St3 to 1 to set the device to State 3
• These parameters reset automatically
When Cfg_PCmdClear is 0:
• State 0 is the default State; PCmd_St0 is not used
• Set PCmd_St1, PCmd_St2, and PCmd_St3 to 0 to set the device to State 0
• Set PCmd_St1 to 1 to set the device to State 1
• Set PCmd_St2 to 1 to set the device to State 2
• Set PCmd_St3 to 1 to set the device to State 3
• These parameters do not reset automatically
• 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
• 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
• This parameter is always reset automatically
• The parameter is reset automatically
14 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
Table 6 - P_D4SD Input Parameters
Discrete 2-, 3-, 4-state Device (P_D4SD)
Input Parameter Data
Type
PCmd_FailSuppress BOOL Fail.PCmd_Suppress 0 When Cfg_PCmdClear is 1:
PCmd_DeviceFaultSuppress DeviceFault.PCmd_Suppress
PCmd_IntlkTripSuppress IntlkTrip.PCmd_Suppress
PCmd_IOFaultSuppress IOFault.PCmd_Suppress
PCmd_FailUnsuppress BOOL Fail.PCmd_Unsuppress 0
PCmd_DeviceFaultUnsuppress
PCmd_IntlkTripUnsuppress IntlkTrip.PCmd_Unsuppress
PCmd_IOFaultUnsuppress IOFault.PCmd_Unsuppress
PCmd_FailUnshelve BOOL Fail.PCmd_Unshelve 0 • Set PCmd_<Alarm>Unshelve to 1 to Unshelve alarm
PCmd_DeviceFaultUnshelve
PCmd_IntlkTripUnshelve IntlkTrip.PCmd_Unshelve
PCmd_IOFaultUnshelve IOFault.PCmd_Unshelve
OCmd_St0 BOOL 0 Operator command to set device to State 0...3.
OCmd_St1
OCmd_St2
OCmd_St3
OCmd_Bypass BOOL 0 Operator command to bypass all bypassable Interlocks and Permissives.
OCmd_Check BOOL 0 Operator command to check (not bypass) all Interlocks and Permissives.
MCmd_Disable BOOL 0 Maintenance command to disable device.
MCmd_Enable BOOL 0 Maintenance command to enable device.
MCmd_Acq BOOL Mode.MCmd_Acq 0 Maintenance Command to Acquire Ownership (Operator/Program/Override to
MCmd_Rel BOOL Mode.MCmd_Rel 0 Maintenance Command to Release Ownership (Maintenance to
OCmd_AcqLock BOOL Mode.OCmd_AcqLock 0 Operator Command to Acquire (Program to Operator) /Lock Ownership
OCmd_Unlock BOOL Mode.OCmd_UnlockRel 0 Operator Command to Unlock/Release (Operator to Program) Ownership
OCmd_Reset BOOL 0 Operator command to reset all alarms requiring reset and any latched shed
OCmd_ResetAckAll BOOL 0 Operator command to reset and acknowledge all alarms and reset any latched
Alias For Default Description
• 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
DeviceFault.PCmd_Unsuppress
DeviceFault.PCmd_Unshelve
• PCmd_<Alarm>Unsuppress is not used
• These Parameters do not reset automatically
• The parameter is reset automatically
Maintenance)
Operator/Program/Override)
conditions.
shed conditions.
Discrete 2-, 3-, or 4-state Device Output Structure
Output parameters include the following:
• Output data elements (Out_) are the primary outputs of the instruction,
typically used by hardware output modules; however’ they can be used by
other application logic.
• Value data elements (Val_) are numeric outputs of the instruction for use
by the HMI. Values can also be used by other application logic or
software packages.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 15
Discrete 2-, 3-, 4-state Device (P_D4SD)
Table 7 - P_D4SD Output Parameters
• Source and Quality data elements (SrcQ_) are outputs of the instruction
used by the HMI to indicate PV source and quality.
• Status data elements (Sts_) are bit outputs of the instruction for use by the
HMI. Status bits can also be used by other application logic.
• Error data elements (Err_) are outputs of the instruction that indicate a
particular configuration error. If any Err_ bit is set, then the Sts_Err
configuration error summary status is set and the Invalid Configuration
indicator is displayed on the HMI.
• Not Ready data elements (Nrdy_) are bit outputs of the instruction for use
by the HMI for displaying the Device Not Ready indicator. Not Ready bits
can also be used by other application logic.
• Alarm data elements (Alm_) are outputs of the instruction that indicate a
particular alarm has occurred.
• Acknowledge data elements (Ack_) are outputs of the instruction that
indicate the corresponding alarm has been acknowledged.
• Ready data elements (Rdy_) are bit outputs of the instruction used by the
HMI to enable or disable command buttons and set data entry fields.
Output Parameter Data Type Alias For Description
EnableOut BOOL Enable Output: The EnableOut signal is not manipulated by this instruction. Its output state
Out_A BOOL Outputs A...D to device.
Out_B
Out_C
Out_D
SrcQ_IO SINT I/O signal source and quality.
SrcQ Final Device state source and quality.
Val_Cmd SINT Device command:
always reflects EnableIn Input state.
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)
0 = None
1 = State 0
2 = State 1
3 = State 2
4 = State 3
16 Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017
Discrete 2-, 3-, 4-state Device (P_D4SD)
Table 7 - P_D4SD Output Parameters
Output Parameter Data Type Alias For Description
Val_Sts SINT Device confirmed status:
0 = Powerup/Reset
1 = State 0
2 = State 1
3 = State 2
4 = State 3
9 = Moving
33 = Disabled
Val_Fault SINT Device fault status:
0 = None
16 = Position Fail
17 = Device Fault
32 = I/O Fault
34 = Configuration Error
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 Current object owner ID (0 = not owned).
Val_Notify SINT Current alarm level and acknowledgement (enumeration):
0 = No alarm
1 = Alarm cleared: a reset or acknowledge is required
2 = Low (acknowledged)
3 = Low (unacknowledged)
4 = Medium (acknowledged)
5 = Medium (unacknowledged)
6 = High (acknowledged)
7 = High (unacknowledged)
8 = Urgent (acknowledged)
9 = Urgent (unacknowledged)
Sts_St0 BOOL 1 = Device commanded to and confirmed in State 0...3.
Sts_St1
Sts_St2
Sts_St3
Sts_Moving BOOL 1 = Device not yet confirmed in commanded state.
Sts_Available BOOL 1 = Device available for control by automation (Program).
Sts_Bypass BOOL 1 = Bypassable interlocks and permissives are bypassed.
Sts_BypActive BOOL 1 = Interlock / permissive bypassing active (Bypassed or Maintenance mode).
Sts_Disabled BOOL 1 = Device is disabled.
Sts_NotRdy BOOL 1 = Device is not ready to be operated.
Rockwell Automation Publication SYSLIB-RM028E-EN-P - February 2017 17
Loading...