8/20/2019 P D4SD 2.0 Syslib-
1/56
PlantPAx Library of Process Objects:Discrete 2-, 3-, or 4-state Device (P_D4SD)Version 2.0
Reference Manual
8/20/2019 P D4SD 2.0 Syslib-
2/56
Important User Information
Solid-state equipment has operational characteristics differing from those of electromechanical equipment. SafetyGuidelines for the Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at http://www.rockwellautomation.com/literature/ ) describes someimportant differences between solid-state equipment and hard-wired electromechanical devices. Because of this difference,and also because of the wide variety of uses for solid-state equipment, all persons responsible for applying this equipmentmust satisfy themselves that each intended application of this equipment is acceptable.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from theuse or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables andrequirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility orliability 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.
Allen-Bradley, Rockwell Soft ware, Rockwell Automation, RSLogix, Logix5000, FactoryTalk, PlantPAx, ControlLogix, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
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.
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.
IMPORTANT Identifies information that is critical for successful application and understanding of the product.
http://literature.rockwellautomation.com/idc/groups/literature/documents/in/sgi-in001_-en-p.pdfhttp://www.rockwellautomation.com/literature/http://www.rockwellautomation.com/literature/http://literature.rockwellautomation.com/idc/groups/literature/documents/in/sgi-in001_-en-p.pdf
8/20/2019 P D4SD 2.0 Syslib-
3/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 3
Table of Contents
Preface Library Programming Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Ladder Diagram Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Prescan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Accessing Revision Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Entering Text in FactoryTalk View SE Software . . . . . . . . . . . . . . . . . . 8Additional Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Discrete 2-, 3-, 4-state Device
(P_D4SD)
Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Optional Template Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Discrete 2-, 3-, or 4-state Device Input Structure . . . . . . . . . . . . . . . . 15
Discrete 2-, 3-, or 4-state Device Output Structure . . . . . . . . . . . . . . 20Discrete 2-, 3-, or 4-state Device Local Configuration Tags. . . . . . . 24
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Generic Alarm Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Use Global Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Alarm Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Discrete 2-, 3-, 4-state Device Faceplate Help . . . . . . . . . . . . . . . . . . . 53
8/20/2019 P D4SD 2.0 Syslib-
4/56
4 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Table of Contents
Notes:
8/20/2019 P D4SD 2.0 Syslib-
5/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 5
Preface
The PlantPAx™ Library of Process Objects is a predefined library of controllercode (Add-On Instructions), display elements (global objects), and faceplatedisplays that let you quickly assemble large applications with proven strategies,rich functionality, and known performance.
The Process Objects can be downloaded from Knowledgebase Answer ID 62682at http://www.rockwellautomation.custhelp.com.
The PlantPAx Library of Process Objects version 2.0 is compatible with thefollowing products:
• RSLogix™ 5000 software, version 18 or later
• FactoryTalk® View Site Edition software, version 6.0 or later
• FactoryTalk View Machine Edition software, version 6.0 or later
Library ProgrammingConsiderations
PlantPAx Library Add-On Instructions can be used in ladder diagrams, functionblock diagrams, or structured text languages. Select the programming languagebased on the type of application you are developing.
The following programming considerations are common for all PlantPAx Libraryof Process Objects.
Ladder Diagram Considerations
The controller evaluates ladder diagram instructions based on the rung condition preceding the instruction (rung-in condition). Based on the
rung-in condition and the instruction, the controller sets the rung condition following the instruction (rung-out condition), which affects anysubsequent instruction.
If the rung-in condition to an input instruction is true, the controller evaluatesthe instruction and sets the rung-out condition based on the results of theinstruction. If the instruction evaluates to true, the rung-out condition is true; ifthe instruction evaluates to false, the rung-out condition is false.
https://rockwellautomation.custhelp.com/https://rockwellautomation.custhelp.com/
8/20/2019 P D4SD 2.0 Syslib-
6/56
6 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Preface
Prescan
During the transition into Run mode, the controller performs a Prescan beforethe first logic scan. Prescan is a special scan of all routines in the controller. Thecontroller scans all main routines and subroutines during Prescan, but ignores
jumps that could skip the execution of instructions. The controller executes allFOR loops and subroutine calls. If a subroutine is called more than once, it isexecuted each time it is called. The controller uses Prescan instructions to resetnon-retentive data values.
During Prescan, input values are not current and outputs are not written. Thefollowing conditions generate Prescan:
• Toggle from Program to Run mode
• Automatically enter Run mode from a power-up condition
Prescan does not occur for a program when the following occurs:
• Program becomes scheduled while the controller is running • Program is unscheduled when the controller enters Run mode
IMPORTANT The rung-in condition is reflected in the EnableIn parameter and determines
how the system performs each Process Add-On Instruction. If the EnableIn
signal is true, the system performs the instruction’s main logic routine.
Conversely, if the EnableIn signal is false, the system performs the instruction’s
EnableInFalse routine.
The instruction’s main logic routine sets/clears the EnableOut parameter,which then determines the rung-out condition. The EnableInFalse routine
cannot set the EnableOut parameter. If the rung-in condition is false, then the
EnableOut parameter and the rung-out condition will also be false.
IMPORTANT The Prescan performs the Process Add-On Instruction’s logic routine as all false
and then performs its Prescan routine as true.
8/20/2019 P D4SD 2.0 Syslib-
7/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 7
Preface
Accessing Revision Information
Add-On Instructions in the PlantPAx Library of Process Objects canshow revision history in RSLogix 5000 software and the faceplate inFactoryTalk View software.
The instruction and faceplate are compatible if they have the same Major andMinor Revision numbers. The Major Revision is the first number, before the period. The Minor Revision is the second number, after the period and before thehyphen or space.
Information after the hyphen or space indicates the Service Release. The
instruction and faceplate do not have to have the same Service Release to becompatible. In the table above, the Add-On Instruction and faceplate shown arecompatible because they have the same Major.Minor (2.0).
Component Example
The Add-On Instruction in RSLogix 5000 soft warehas revision information visible when the instruction isselected in the Controller Organizer.
The faceplate in FactoryTalk View software has revisioninformation visible when the pointer is paused just insidethe lower left corner of the faceplate when accessed in arunning HMI Client.
8/20/2019 P D4SD 2.0 Syslib-
8/56
8 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Preface
Entering Text in FactoryTalk View SE Software
When entering data into String Input fields in FactoryTalk View SE software, thedata is not saved to the tag until you press Enter. When the Input field is active, itsborder changes based on the state of the input:
• When the Input field is active (the cursor is in the field), the Input fieldborder is a solid line.
• If you modify the data in the Input field and move to a different field without pressing Enter, the border remains a solid line. This indicates thatthe data has not been saved to the tag.
• If the data in the Input field has not changed or has been written to thecontroller tag, the border is a dashed line.
EXAMPLE
EXAMPLE
EXAMPLE
8/20/2019 P D4SD 2.0 Syslib-
9/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 9
Preface
Additional Resources These documents contain additional information concerning related productsfrom Rockwell Automation.
You can view or download publications athttp:/www.rockwellautomation.com/literature/ . To order paper copies oftechnical documentation, contact your local Allen-Bradley distributor orRockwell Automation sales representative.
Resource Description
PlantPAx Process Automation System Selection Guide,publication PROCES-SG001
Provides information to assist with equipmentprocurement for your PlantPAx system.
PlantPAx Process Automation System Reference Manual,publication PROCES-RM001 Provides characterized recommendations forimplementing your PlantPAx system.
FactoryTalk View SE Edition User Manual,publication VIEWSE-UM006
Provides details on how to use this software package fordeveloping and running human-machine interface(HMI) applications that can involve multiple users andservers, distributed over a network.
Logix5000™ Controllers Add-On Instructions ProgrammingManual, publication 1756-PM010
Provides information for designing, configuring, andprogramming Add-On Instructions.
Process Add-On Instructions and Graphics: Standard AlarmSub-Block (P_Alarm) Reference Manual,publication SYSLIB-RM002
Details how to monitor an input condition to raise analarm. Information includes acknowledging, resetting,inhibiting, and disabling an alarm.
Process Add-On Instructions: Standard Modes (P_Mode)Reference Manual, publication SYSLIB-RM005
Explains how to select the Mode (owner) of aninstruction or control strategy. The Mode instruction isusually embedded within other instructions to extend
their functionality. It is possible to use a standaloneMode instruction to enhance a program where modesare wanted.
http://www.rockwellautomation.com/literature/http://literature.rockwellautomation.com/idc/groups/literature/documents/sg/proces-sg001_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/proces-rm001_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/um/viewse-um006_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/um/viewse-um006_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm002_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm005_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm005_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm005_-en-e.pdfhttp://www.rockwellautomation.com/literature/http://literature.rockwellautomation.com/idc/groups/literature/documents/um/viewse-um006_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/sg/proces-sg001_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm005_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm002_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/proces-rm001_-en-p.pdf
8/20/2019 P D4SD 2.0 Syslib-
10/56
10 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Preface
Notes:
8/20/2019 P D4SD 2.0 Syslib-
11/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 11
Discrete 2-, 3-, 4-state Device (P_D4SD)
The P_D4SD (Discrete 2-, 3-, 4-state Device) Add-On Instruction controlsand monitors feedback from a Discrete 2-state, 3-state, or 4-state Device in a
variety of modes, monitoring for fault conditions. These devices include amultiple-speed motor or a multiple-position valve. The global objects andfaceplate shown below are examples of the graphical interface tools used with theembedded logic.
Guidelines 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 PlantPAx Library Add-OnInstructions for various motors, valves, and so forth.
• You have a device, such as a valve or motor, that is supported by otherAdd-On Instructions, but you want the device to use non-standard statenames, such as ‘recycle’ and ‘deliver’ for a diverter valve, rather than thefixed names used in the other Instruction, such as ‘closed’ and ‘open’. The
P_D4SD Instruction has configurable names for each of the device states.
Do not use this instruction in these situations:
• You need to operate a device that has more than four states, such asa six-position rotary selector valve. You may be able to use the P_nPos(n-Position Device) Add-On Instruction instead.
Faceplate
Add-On Instruction
Global Objects
8/20/2019 P D4SD 2.0 Syslib-
12/56
8/20/2019 P D4SD 2.0 Syslib-
13/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 13
Discrete 2-, 3-, 4-state Device (P_D4SD)
Required Files Add-On Instructions are reusable code objects that contain encapsulated logicthat can streamline implementing your system. This lets you create your owninstruction set for programming logic as a supplement to the instruction set provided natively in the ControlLogix® firmware. An Add-On Instruction isdefined once in each controller project, and can be instantiated multiple times in your application code as needed.
Controller File
The P_D4SD_2_0-00_AOI.L5X Add-On Instruction must be imported intothe controller project to be able to be used in the controller configuration. Theservice release number (boldfaced) may change as service revisions are created.
Visualization Files
The following files from Knowledgebase Answer ID 62682 athttp://www.rockwellautomation.custhelp.com are required in order to usethe P_D4SD Object.
Table 1 - P_D4SD Visualization File Types
Application Type File Type FactoryTalk View SE Software FactoryTalk View ME Software Description
Graphics - Displays GFX (RA-BAS) Common-AnalogEdit N/A Faceplate used for analog input data entry.The FactoryTalk View ME software faceplatesuse the native analog input data entry so nofile is required.
(RA-BAS) P_D4SD-Faceplate (RA-BAS-ME) P_D4SD-Faceplate The faceplate display used for the object.
(RA-BAS) P_D4SD-Help (RA-BAS-ME) P_D4SD-Help The help display used for the object.
(RA-BAS) P_Alarm-Help (RA-BAS-ME) P_Alarm-Help P_Alarm Help information that is accessedfrom the P_D4SD Help faceplate.
(RA-BAS) P_D4SD-Config (RA-BAS-ME) P_D4SD-Config Pop-up used to configure states for a device.
(RA-BAS) P_Mode-Help (RA-BAS-ME) P_Mode-Help Mode Help information that is accessed fromthe P-D4SD faceplate.
(RA-BAS) P_Mode-Config (RA-BAS-ME) P_Mode-Config Pop-up used to set Default mode.
Graphics - GlobalObjects
GGFX (RA-BAS) Common Facepl ate Objects (RA- BAS-ME) Common Facepl ate Ob jects Common g lobal o bj ects u sed on all ProcessObject faceplates.
(RA-BAS) Process Faceplate Objects (RA-BAS-ME) Process Faceplate Objects Process-specific global objects used on allProcess Object faceplates.
(RA-BAS) Process Alarm Objec ts (R A-BAS -ME) Process Alar m Objec ts Common global objec ts used for alarming onall Process Object faceplates.
(RA-BAS) Process Help Objects (RA-BAS-ME) Process Help Objects Common global objects used for all ProcessObjects help displays.
(RA-BAS) Process Mode Objec ts (RA-BAS-ME) Proces s Mode Objec ts Common global objec ts used for m ana gingmodes on all Process Object f aceplates.
(RA-BAS) P_D4SD Graphics L ibr ar y (RA-BAS-ME) P_D4SD Graphics L ib rary Common gl ob al ob jects in the g raphicslibrary for this instruction.
(RA-BAS) P_D4SD Motor Graphics Library (RA-BAS) P_D4SD Motor Graphics Library Common global objects in the motor graphicslibrary for this instruction.
https://rockwellautomation.custhelp.com/https://rockwellautomation.custhelp.com/
8/20/2019 P D4SD 2.0 Syslib-
14/56
14 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Optional Template Files
You can import the files in Table 1 individually, or you can use the followingtemplate files:
• FTVME_6_0_Template_PlantPAxLib_2_0_00(1).apa:FactoryTalk View ME backup. Contains .gfx, .ggfx, images, and tags for allProcess Objects in a FactoryTalk View Machine Edition project.
• FTVSE_6_0_Template_PlantPAxLib_2_0_00(1).apa:FactoryTalk View SE Station backup. Contains .gfx , .ggfx, and images forall Process Objects in a FactoryTalk View Site Edition Station project.Use Knowledgebase Answer ID 39581 athttp://www.rockwellautomation.custhelp.com to load the files in therestored station project into your HMI server on a FactoryTalk View SEDistributed application.
• RSL5k_18_Template_PlantPAxLib_2_0_00(1).acd:RSLogix 5000 software template project with all Process Objectsinstructions loaded, as well as recommended task structure and
diagnostic objects.
Graphics - Images BMP All.bmp files in the images folder All .bmp files in the images folder These are the common icons used in theglobal objects and faceplates for allProcess Objects.
HMI Tags CSV N/A FTVME_PlantPAxOBjx2_0_2011 09 30-
Tags.CSV
These tags must be imported into the
FactoryTalk View ME project to supportswitching tabs on any ProcessObject faceplate.
Table 1 - P_D4SD Visualization File Types
Application Type File Type FactoryTalk View SE Software FactoryTalk View ME Software Description
(1) The service release number (boldfaced) may change as service revisions are created.
https://rockwellautomation.custhelp.com/https://rockwellautomation.custhelp.com/
8/20/2019 P D4SD 2.0 Syslib-
15/56
8/20/2019 P D4SD 2.0 Syslib-
16/56
16 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Inp_IOFault BOOL 0 Input Communication Status
0 = OK
1 = Fail
Inp_Sim BOOL 0 1 = Simulate working device0 = Control actual device
Inp_Hand BOOL 0 1 = Select Hand (hard-wired) mode
Alias for Mode.Inp_Hand
Inp_Ovrd BOOL 0 1 = Select Override mode
Alias for Mode.Inp_Ovrd
Inp_OvrdCmd DINT 0 Override mode device command:
0 = None
1 = State 0
2 = State 1
3 = St.ate 2
4 = State 3
Inp_Reset BOOL 0 1 = Reset all fault conditions and latched alarmsCfg_St0onShed BOOL 0 1 = Go to State 0 on Shed
0 = Hold position 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 command state. The parameterCfg_OutSt[x]Write configures which outputs get written for each state. The parameterCfg_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 deviceto state 1, then Cfg_OutSt1Write should be 2#0000_1111 and Cfg_OutSt1State should be2#0000_0001.
By default, all four outputs are written in every state, with a single output set to 1 in each state.
Cfg_OutSt0State SINT 2#0000_0001
Cfg_OutSt1Write SINT 2#0000_1111
Cfg_OutSt1State SINT 2#0000_0010
Cfg_OutSt2Write SINT 2#0000_1111
Cfg_OutSt2State SINT 2#0000_0100
Cfg_OutSt3Write SINT 2#0000_1111Cfg_OutSt3State SINT 2#0000_1000
Cfg_FdbkSt0Check SINT 2#0000_0000 These configuration parameters determine how the inputs are used to determine state. The parameterCfg_FdbkSt[x]Check configures which inputs get checked for each state. The parameterCfg_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 thedevice is in state 3, then Cfg_FdbkSt3Check should be 2#0000_0111 and Cfg_FdbkSt1Write shouldbe 2#0000_0100.
By default, all inputs are ‘don’t’ care’ in every state (no feedback checking).
Cfg_FdbkSt0State SINT 2#0000_0001
Cfg_FdbkSt1Check SINT 2#0000_0000
Cfg_FdbkSt1State SINT 2#0000_0010
Cfg_FdbkSt2Check SINT 2#0000_0000
Cfg_FdbkSt2State SINT 2#0000_0100
Cfg_FdbkSt3Check SINT 2#0000_0000
Cfg_FdbkSt3State SINT 2#0000_1000
Cfg_HasPerm0Obj BOOL 0 1 = Tells HMI a P_Perm is connected to Inp_PermOK0
Cfg_HasPerm1Obj BOOL 0 1 = Tells HMI a P_Perm is connected to Inp_PermOK1
Cfg_HasPerm2Obj BOOL 0 1 = Tells HMI a P_Perm is connected to Inp_PermOK2
Cfg_HasPerm3Obj BOOL 0 1 = Tells HMI a P_Perm is connected to Inp_PermOK3
Cfg_HasIntlkObj BOOL 0 1 = Tells HMI a P_Intlk is connected to Inp_IntlkOK
Cfg_PCmdClear BOOL 1 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. This parameter is aliasedto internal tag Mode.Cfg_PCmdClear from P_Mode.
IMPORTANT: Clearing this parameter online may cause unintended program command execution.
Table 2 - P_D4SD Input Parameters
Input Parameter Data Type Default Description
8/20/2019 P D4SD 2.0 Syslib-
17/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 17
Discrete 2-, 3-, 4-state Device (P_D4SD)
Cfg_ProgDefault BOOL 0 This parameter defines the default mode. When this parameter is 1, the mode defaults to Program if nomode is being requested. When this parameter is 0, the mode defaults to Operator if no mode is beingrequested. This parameter is aliased to internal tag Mode.Cfg_ProgDefault of P_Mode.
IMPORTANT: Changing this parameter online may cause unintended mode changes.
Cfg_OCmdResets BOOL 0 1 = New Operator state command resets fault
0 = Reset required to clear fault
Cfg_OvrdPermIntlk BOOL 0 1 = Override mode ignores Bypassable Permissives/ Interlocks
0 = Override mode uses Bypassable Permissives/Interlocks
Cfg_ShedOnFail BOOL 1 1 = Go to shed state and alarm on fail to reach position
0 = Alarm only on fail
Shed state is determined by configuration parameter Cfg_St0onShed.
Cfg_ShedOnDeviceFault BOOL 1 1 = Go to State 0 and alarm on device fault
0 = Alarm only on device fault
Shed state is determined by configuration parameter Cfg_St0onShed.
Cfg_ShedOnIOFault BOOL 1 1 = Go to State 0 and alarm on I/O fault
0 = Alarm only on I/O fault
Shed state is determined by configuration parameter Cfg_St0onShed.
Cfg_HasFailAlm BOOL 1 1 = Fail to reach state alarm exists and will be checked
Alias for Fail.Cfg_Exists
Cfg_HasDeviceFaultAlm BOOL 1 1 = Device fault alarm exists and will be checked
Alias for DeviveFault.Cfg_Exists
Cfg_HasIntlkTripAlm BOOL 1 1 = Interlock trip alarm exists and will be checked
Alias for IntlkTrip.Cfg_Exists
Cfg_HasIOFaultAlm BOOL 1 1 = I/O fault alarm exists and will be checked
Alias for IOFault.Cfg_Exists
Cfg_FailResetReqd BOOL 0 This parameter determines whether a reset is required to clear the alarm status. When this parameteris 1, the alarm is latched On when the alarm occurs. After the alarm condition returns to normal, a resetis required to clear the a larm status (for example, OCmd_Reset, Inp_Reset, or Fail.OCmd_Reset would
be required to clear the Fail alarm after the alarm is set and the value returns to normal). When thisparameter is 0, no reset is required and the alarm status is cleared when the alarm condition returns tonormal. This parameter is aliased to internal tag .Cfg_ResetReqd of the corresponding P_Alarm object.
IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.
Cfg_DeviceFaultResetReqd BOOL 0
Cfg_IntlkTripResetReqd BOOL 0
Cfg_IOFaultResetReqd BOOL 0
Cfg_FailAckReqd BOOL 1 This parameter determines whether an acknowledgement is required for an alarm. When thisparameter is 1, the acknowledge (ack) bit is cleared when the alarm occurs. An acknowledge command(for example, PCmd_FailAck or Fail.OCmd_Ack) would be required to acknowledge the alarm. When setto 0, the Acknowledge bit is set when an alarm occurs indicating an acknowledged alarm and noacknowledge command is required. This parameter is aliased to internal tag Cfg_AckReqd of thecorresponding P_Alarm object.
Cfg_DeviceFaultAckReqd BOOL 1
Cfg_IntlkTripAckReqd BOOL 1
Cfg_IOFaultAckReqd BOOL 1
Cfg_FailSeverity SINT 3 These parameters determine the severity of each alarm. This drives the color and symbol that are usedto indicate alarm status on the faceplate and global object. This parameter is aliased to internal tag.Cfg_Severity of the associated P_Alarm object. The following are valid values:
1 = Information
2 = Warning3 = Exception
4 = Fault
IMPORTANT: This severity parameter drives only the indication on the global object and f aceplate. TheAlarms and Events definition severity drives the color and symbol that is used on the alarm banner andalarm summary as well as the value returned by FactoryTalk Alarms and Events display commands.
Cfg_DeviceFaultSeverity SINT 4
Cfg_IntlkTripSeverity SINT 3
Cfg_IOFaultSeverity SINT 3
Cfg_OutAPulseT REAL 0.0 Time to pulse Output A (s) (0=output held continuously)
Cfg_OutBPulseT REAL 0.0 Time to pulse Output B (s) (0=output held continuously)
Cfg_OutCPulseT REAL 0.0 Time to pulse Output C (s) (0=output held continuously)
Cfg_OutDPulseT REAL 0.0 Time to pulse Output D (s) (0=output held continuously)
Table 2 - P_D4SD Input Parameters
Input Parameter Data Type Default Description
8/20/2019 P D4SD 2.0 Syslib-
18/56
18 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Cfg_SimFdbkT DINT 2 Delay to echo back reaching state when in simulation (s)
Cfg_FailT DINT 10 Time after new state requested to reach that state before fault (s)
PSet_Owner DINT 0 Program owner request ID (non-zero) or release (zero)
PCmd_St0 BOOL 0 Program command to set device to State 0
PCmd_St1 BOOL 0 Program command to set device to State 1
PCmd_St2 BOOL 0 Program command to set device to State 2
PCmd_St3 BOOL 0 Program command to set device to State 3
PCmd_Acq BOOL 0 Program command to Acquire ownership (Oper ator to Program).
This parameter is aliased to internal tag Mode.PCmd_Acq of P_Mode. This parameter is resetautomatically, when Cfg_PCmdClear is 1.
PCmd_Rel BOOL 0 Program command to Release ownership (Program to Operator).
This parameter is aliased to internal tag Mode.PCmd_Rel of P_Mode. This parameter is resetautomatically, when Cfg_PCmdClear is 1.
PCmd_Lock BOOL 0 Program command to Lock Mode in Program.
This parameter is aliased to internal tag Mode.PCmd_Lock of P_Mode. This parameter is resetautomatically, when Cfg_PCmdClear is 1.
PCmd_Unlock BOOL 0 Program command to Unlock Mode.
This parameter is aliased to internal tag Mode.PCmd_Unlock of P_Mode. This parameter is resetautomatically, when Cfg_PCmdClear is 1.
PCmd_Reset BOOL 0 Program command to reset latched alarms and faults.
PCmd_FailAck BOOL 0 Program command to acknowledge Fail alarm.
Alias for Fail,PCmd_Ack
PCmd_FailInhibit BOOL 0 Program command to inhibit Fail alarm
This parameter is reset automatically, when Cfg_PCmdClear is 1.
Alias for Fail.PCmd_Inhibit
PCmd_FailUninhibit BOOL 0 Program command to uninhibit Fail alarm
Alias for Fail.PCmd_Reset
PCmd_DeviceFaultAck BOOL 0 Program command to acknowledge Device Fault alarm
Alias for DeviceFault.PCmd_Ack
PCmd_DeviceFaultInhibit BOOL 0 Program command to Inhibit Device Fault alarm
Alias for DeviceFault.PCmd_Inhibit
PCmd_DeviceFaultUninhibit BOOL 0 Program command to Uninhibit Device Fault alarm
Alias for DeviceFault.PCmd_Uninhibit
PCmd_IntlkTripAck BOOL 0 Program command to acknowledge Interlock Trip alarm
Alias for IntlkTrip.PCmd_Ack
PCmd_IntlkTripInhibit BOOL 0 Program command to inhibit Interlock Trip alarm
Alias for IntlkTrip.PCmd_Inhibit
PCmd_IntlkTripUninhibit BOOL 0 Program command to uninhibit Interlock Trip alarmAlias for IntlkTrip.PCmd_Uninhibit
PCmd_IOFaultAck BOOL 0 Program command to acknowledge I/O Fault alarm
Alias for IOFault.PCmd_Ack
PCmd_IOFaultInhibit BOOL 0 Program command to inhibit I/O Fault alarm
Alias for IOFault.PCmd_Inhibit
PCmd_IOFaultUninhibit BOOL 0 Program command to uninhibit I/O Fault alarm
Alias for IOFault.PCmd_Uninhibit
OCmd_St0 BOOL 0 Operator command to set device to State 0
Table 2 - P_D4SD Input Parameters
Input Parameter Data Type Default Description
8/20/2019 P D4SD 2.0 Syslib-
19/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 19
Discrete 2-, 3-, 4-state Device (P_D4SD)
OCmd_St1 BOOL 0 Operator command to set device to State 1
OCmd_St2 BOOL 0 Operator command to set device to State 2
OCmd_St3 BOOL 0 Operator command to set device to State 3
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 (allow to turn ON) device
OCmd_Reset BOOL 0 Operator command to reset all alarms requiring reset and any latched shed conditions
OCmd_ResetAckAll BOOL 0 Operator command to reset and acknowledge all alarms and reset any latched shed conditions
Table 2 - P_D4SD Input Parameters
Input Parameter Data Type Default Description
8/20/2019 P D4SD 2.0 Syslib-
20/56
20 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
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 may be used by
other application logic.• Value data elements (Val_) are numeric outputs of the instruction for
use by the HMI. Values also may be used by other application logic orsoftware packages.
• Status data elements (Sts_) are bit outputs of the instruction for use by theHMI. Status bits also may be used by other application logic.
• Ready data elements (Rdy_) are bit outputs of the instruction used by theHMI to enable or gray out Command buttons and Setting entry fields.
Table 3 - P_D4SD Output Parameters
Output Parameter Data Type Description
EnableOut BOOL Enable Output: The EnableOut signal is not manipulated by this instruction. Its output state always reflectsEnableIn input state
Out_A BOOL Output A to device
Out_B BOOL Output B to device
Out_C BOOL Output C to device
Out_D BOOL Output D to device
Val_Cmd SINT Device Command:
0 = None
1 = State 0
2 = State 1
3 = State 2
4 = State 3
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
8/20/2019 P D4SD 2.0 Syslib-
21/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 21
Discrete 2-, 3-, 4-state Device (P_D4SD)
Val_Mode DINT Mode enumeration:
0 = No mode
1 = Hand
2 = Maintenance
3 = Override4 = Program (locked)
5 = Operator (locked)
6 = Program (unlocked, Oper is default)
7 = Operator (unlocked, Prog is default)
8 = Program (unlocked, Prog is default)
9 = Operator (unlocked, Oper is default)
Alias for Mode.Val
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, not acknowledged
2 = Information alarm
3 = Unacknowledged information alarm4 = Warning alarm
5 = Unacknowledged warning alarm
6 = Exception alarm
7 = Unacknowledged exception alarm
8 = Fault alarm
9 = Unacknowledged fault alarm
Sts_St0 BOOL 1 = Device commanded to and confirmed in State 0
Sts_St1 BOOL 1 = Device commanded to and confirmed in State 1
Sts_St2 BOOL 1 = Device commanded to and confirmed in State 2
Sts_St3 BOOL 1 = Device commanded to and confirmed in State 3
Sts_Moving BOOL 1 = Device not yet confirmed in commended stateSts_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 (output held OFF)
Sts_NotRdy BOOL 1 = Device is not ready to be operated
Sts_MaintByp BOOL 1 = Device has a Maintenance Bypass function active
Sts_AlmInh BOOL 1 = One or more alarms inhibited, disabled or suppressed
Sts_Err BOOL 1 = Error in configuration: see detail bits for reason
Err_Timer BOOL 1 = Error in configuration: feeback check timer preset (use 0…2,147,483 seconds)
Err_Sim BOOL 1 = Error in configuration: simulation timer preset (use 0…2,147,483 seconds)
Err_Alarm BOOL 1 = Error in configuration: alarm minimum on time or severity
Sts_Hand BOOL 1 = Mode is Hand (supersedes Maintenance, Override, Program, Operator)
Alias for Mode.Sts_Hand
Sts_Maint BOOL 1 = Mode is Maintenance (supersedes Override, Program, Operator)
Alias for Mode.Sts_Maint
Sts_Ovrd BOOL 1 = Mode is Override (supersedes Program, Operator)
Alias for Mode.Sts_Ovrd
Table 3 - P_D4SD Output Parameters
Output Parameter Data Type Description
8/20/2019 P D4SD 2.0 Syslib-
22/56
22 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Sts_Prog BOOL 1 = Mode is Program (auto)
Alias for Mode.Sts_Prog
Sts_Oper BOOL 1 = Mode is Operator (manual)
Alias for Mode.Sts_OperSts_ProgOperLock BOOL 1 = Program or Operator has requested Mode Lock
Alias for Mode.Sts_ProgOperLock
Sts_NoMode BOOL 1 = NoMode (disabled because EnableIn is false)
Alias for Mode.Sts_NoMode
Sts_Fail BOOL 1 = Device failed to reach commanded state (one-shot)
Alias for Fail.Inp
Alm_Fail BOOL 1 = Device failed to reach commended state
Alias for Fail.Alm
Ack_Fail BOOL 1 = Fail to reach commanded state Alarm has been acknowledged
Alias for Fail.Ack
Sts_FailDisabled BOOL 1 = Fail to reach commanded state Alarm has been disabled (will not be sent)
Alias for Fail.Disabled
Sts_FailInhibited BOOL 1 = Fail to reach commanded state Alarm has been inhibited by logic
Alias for Fail.Inhibited
Sts_FailSuppressed BOOL 1 = Fail to reach commanded state Alarm has been suppressed (logged only)
Alias for Fail.Suppressed
Sts_DeviceFault BOOL 1 = Device fault (from Inp_DeviceFault)
Alias for DefaultFault.Inp
Alm_DeviceFault BOOL 1 = Device fault alarm
Alias for DeviceFault.Alm
Ack_DeviceFault BOOL 1 = Device fault alarm has been acknowledged
Alias for DeviceFault.Ack
Sts_DeviceFaultDisabled BOOL 1 = Device fault alarm has been disabled (will not be sent)
Alias for DeviceFault.Disabled
Sts_DeviceFaultInhibited BOOL 1 = Device fault alarm has been inhibited by logic
Alias for DeviceFault.Inhibited
Sts_DeviceFaultSuppressed BOOL 1 = Device fault alarm has been suppressed (logged only)
Alias for DeviceFault.Suppressed
Sts_IntlkTrip BOOL 1 = Device commanded to State 0 by an Interlock NOT OK (one-shot)
Alias for IntlkTrip.Inp
Alm_IntlkTrip BOOL 1 =Alarm: Device set to State 0 by an Interlock NOT OK
Alias for IntlkTrip.Alm
Ack_IntlkTrip BOOL 1 = Interlock Trip Alarm has been acknowledged
Alias for IntlyTrip.AckSts_IntlkTripDisabled BOOL 1 = Interlock Trip Alarm is disabled (not saved or sent)
Alias for IntlkTrip.Disabled
Sts_IntlkTripInhibited BOOL 1 = Interlock Trip Alarm has been inhibited by logic
Alias for IntlkTrip.Inhibited
Sts_IntlkTripSuppressed BOOL 1 = Interlock Trip Alarm has been suppressed (logged only)
Alias for IntlkTrip.Suppressed
Table 3 - P_D4SD Output Parameters
Output Parameter Data Type Description
8/20/2019 P D4SD 2.0 Syslib-
23/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 23
Discrete 2-, 3-, 4-state Device (P_D4SD)
Sts_IOFault BOOL I/O communication fault status
0 = OK
1 = Bad
Alias for IOFault.Inp
Alm_IOFault BOOL 1 = I/O fault alarm
Alias for IOFault.Alm
Ack_IOFault BOOL 1 = I/O fault alarm has been acknowledged
Alias for IOFault.Ack
Sts_IOFaultDisabled BOOL 1 = I/O fault alarm is disabled (not saved or sent)
Alias for IOFault.Disabled
Sts_IOFaultInhibited BOOL 1 = I/O fault alarm has been inhibited by logic
Alias for IOFault.Inhibited
Sts_IOFaultSuppressed BOOL 1 = I/O fault alarm has been suppressed (logged only)
Alias for IOFault.Suppressed
Rdy_St0 BOOL 1 = Ready to receive OCmd_St0 (enables HMI button)
Rdy_St1 BOOL 1 = Ready to receive OCmd_St1 (enables HMI button)
Rdy_St2 BOOL 1 = Ready to receive OCmd_St2 (enables HMI button)
Rdy_St3 BOOL 1 = Ready to receive OCmd_St3 (enables HMI button)
Rdy_Bypass BOOL 1 = Ready to receive OCmd_Bypass (enables HMI button)
Rdy_Check BOOL 1 = Ready to receive OCmd_Check (enables HMI button)
Rdy_Disable BOOL 1 = Ready to receive MCmd_Disable (enables HMI button)
Rdy_Enable BOOL 1 = Ready to receive MCmd_Enable (enables HMI button)
Rdy_Reset BOOL 1 = At least one alarm or latched shed requires reset
Rdy_ResetAckAll BOOL 1 = At least one alarm or latched shed condition requires reset or acknowledged
P_D4SD BOOL Unique parameter name for auto - discovery
Table 3 - P_D4SD Output Parameters
Output Parameter Data Type Description
8/20/2019 P D4SD 2.0 Syslib-
24/56
24 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Discrete 2-, 3-, or 4-state Device Local Configuration Tags
Configuration parameters that are arrayed, string, or structure data types cannotbe configured as parameters for Add-On Instructions. Configuration parametersof these types appear as local tags to the Add-On Instruction. Local tags can beconfigured through the HMI faceplates or in RSLogix 5000 software by openingthe Instruction Logic of the Add-On Instruction instance and then opening theData Monitor on a local tag. These parameters cannot be modified by usingcontroller logic or RSLogix 5000 software export/import functionality.
Table 4 - P_D4SD Local Configuration Tags
Tag Name Data Type Default Description
Cfg_Desc STRING_40 ‘Discrete 2-, 3-, or4-state Device’
Description for display on HMI
Cfg_Label STRING_20 ‘Discrete Device’ Label for graphic symbol displayed on HMI
Cfg_St0Text STRING_8 ‘Off’ Text to display in State 0
Cfg_St1Text STRING_8 ‘On’‘’ Text to display in State 1
Cfg_St2Text STRING_8 ‘’’ Text to display in State 2
Cfg_St3Text STRING_8 ‘’ Text to display in State 3
Cfg_Tag STRING_20 ‘P_D4SD’ Tag name for display on HMI
8/20/2019 P D4SD 2.0 Syslib-
25/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 25
Discrete 2-, 3-, 4-state Device (P_D4SD)
Operations This section describes the primary operations for this Add-On Instruction.
Modes
The Discrete 2-, 3-, 4-state Device Add-On Instruction uses the following
standard modes, implemented by using an embedded P_ModeAdd-On Instruction.
Refer to the Process Add-On Instructions and Graphics: Mode (P_Mode)Reference Manual, publication SYSLIB-RM005, for more information.
Execution
The following table explains the handling of instruction execution conditions.
Refer to the Logix5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010, for more information.
Mode Description
Operator The operator controls the state of the device by using the HMI faceplate.
Pro gram Lo gic outside the P_D4SD instru ct ion control s the device by using Pro gram Co mmands(PCmd_St0, PCmd_St1, PCmd_St2, PCmd_St3).
Override Pr io rity log ic ou tside the P_D4 SD instr uction co ntrol s the device. The default is to set thedevice to State 0, but any state can be commanded. Bypassable interlocks and permissivescan optionally by bypassed in Override mode.
Maintenance Maintenance personnel have control of the device by using the HMI faceplate and it is notavailable for normal operation by operators or program logic. Bypassable permissives and
interlocks are bypassed; and checking for device failure to reach target position isnot performed.
Hand Logic, usually ha rd-wired, has supe rsede d P_D4SD control of the device. If devi ce statefeedback inputs are used, the P_D4SD instruction tracks the state of the device (to theextent that unique feedback patterns are used for the states) to facilitate bumplesstransfer back to one of the other modes.
Condition Description
EnableIn False (false rung) Handled the same as if the device were Disabled byCommand. The device outputs are de-energized and thedevice is shown as Disabled on the HMI. The mode isshown as ‘NO MODE’. All alarms are cleared.
Powerup (prescan, first scan) On Prescan, any Commands received before First Scan arediscarded. The device is de-energized. On first scan, thedevice is treated as if it were returning from Hand mode:the instruction state is set based on the position feedbackreceived from the device.
Embedded P_Mode and P_Alarm instructions arehandled in accordance with their standard powerup
procedures. Refer to the P_Mode and P-Alarm referencemanuals for details.
Instruction first run Instruction first run refers to the first time the instructionexecutes with a new instance of a data s tructure. Thecontroller uses instruction first run to generatecoefficients and other data stores that do not change for afunction block after initial download.
Postscan No SFC Postscan logic is provided.
http://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm005_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm005_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdf
8/20/2019 P D4SD 2.0 Syslib-
26/56
26 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Alarms
The P_D4SD Instruction uses the following alarms, implemented by usingembedded P_Alarm Add-On Instructions.
Generic Alarm Parameters
The following parameters of the P_Alarm object can be used for each alarm inTable 5. These parameters are accessible by the following convention: [P_AlarmName].CP_Alarm Parameter] Configuration parameters for the alarms arealiased to parameters that can be found in the input parameters table. Forexample, Fail.Cfg_Exists can be accessed as parameter Cfg_HasFailAlm.
Table 5 - P_D4SD Alarm Parameters
Alarm P_Alarm Name Description
Interlock Trip IntlkTrip Triggered when an Interlock not OK causes the device to transition from another state to State 0.
I/O Fault IOFault Triggered by the Inp_IOFault Input, usually used to indicate an I/O communication failure.
The device can be configured to either alarm only or to ‘shed’ to State 0 on an I/O Fault.
Fail Fail Device failed to reach commanded position.
Device Fault DeviceFault Device fault from device via an input.
Table 6 - Generic Alarm Input Parameters
P_Alarm P arameter Description
Inp Alarm condition input 1 = Alarm
Inp_Reset 1 = Reset alarm requiring a reset
Cfg_AlmMinOnT Prog ram command to set al ar m for minimum on timePCmd_Reset Program command to reset a latched alarm
PCmd_Ack Program command to acknowledge an alarm
PCmd_Inhibit Program command to inhibit an ala rm (f orce Alm to 0)
PCm d_ Uninhi bit Program command to uninhibit an ala rm
OCmd_Reset Operator command to reset a latched alarm
OCmd_Ack Operator command to acknowledge an alarm
OCmd_Suppres s Operator com mand to suppres s a larm
OCmd_Unsuppress Operator command to unsuppress an alarm
MCmd_Disable Maintenance command to disabl e an alarm (force Alm to 0)
MCmd_Enable Maintenance command to enable an alarm
Table 7 - Generic Alarm Output Parameters
P_Alarm P arameter Description
Rdy_Reset 1 = Ready to receive OCmd_Reset (enables the HMI button)
Rdy_Ack 1 = Ready to receive OCmd_Ack (enables the HMI button)
Rdy_Supp ress 1 = Ready to receive OCmd_Sup press (enabl es the HMI b utton)
Rdy_Unsuppress 1 = Ready to receive OCmd_Unsuppress (enables the HMI button)
8/20/2019 P D4SD 2.0 Syslib-
27/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 27
Discrete 2-, 3-, 4-state Device (P_D4SD)
Refer to the Process Add-On Instructions and Graphics: Alarm (P_Alarm)Reference Manual, publication SYSLIB-RM002, for more information.
Rdy_Disable 1 = R eady to receive MCmd_Disable (enables the HMI button)
Rdy_Enable 1 = Ready to recei ve MCm d_Enable (ena bles the HMI button)
Val_Notify Current alarm level and Acknowledgement (enumeration):
0 = No alarm
1 = Alarm cleared, not a cknowledged2 = Information alarm
3 = Unacknowledged information alarm
4 = Warning alarm
5 = Unacknowledged warning alarm
6 = Exception alarm
7 = Unacknowledged exception alarm
8 = Fault alarm
9 = Unacknowledged fault alarm
Alm Alarm output: 1 = In alarm
Ack Alarm acknowledged status: 1 = Acknowledged
Inhibited 1 = Alarm inhibited by logic (will not be sent)
Suppressed 1 = Alarm suppressed (not visible on the HMI)Disabled 1 = Alarm disabled by operator (will not be sent)
Sts_Error 1 = Error in Config: see Err_bits for reason
Err_Timer 1 = Error in Config: Invalid timer preset (use 0…2,147,483)
Err_Severity 1 = Error in Config: Invalid Severity (use 1…4)
Table 7 - Generic Alarm Output Parameters
http://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm002_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm002_-en-e.pdf
8/20/2019 P D4SD 2.0 Syslib-
28/56
28 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Programming Example This example uses the P_D4SD Add-On Instruction to control a cooling fan thathas three fixed speeds (‘low’, ‘medium’, ‘high’) and an ‘off ’ state. This is considereda 4-state device. In this example, three digital outputs are used to set the speedsetting (when all three are off, the fan is commanded off ) and three digital inputs providing feedback of the actual fan state (when all three are off, the fan is off).
In this example, the four cooling fan states are being mapped to the deviceas follows:
• State 0 = Off • State 1 = Low
• State 2 = Medium
• State 3 = High
The parameter Cfg_NumStates should be set to 4, indicating this is a four-statedevice. The input parameters for states 1…3 (Inp_FdbkB, Inp_FdbkC,Inp_FdbkD) are connected to the digital inputs representing the status of the fan.The output parameters for states 1…3 (Out_B, Out_C, Out_D) are connectedto the digital outputs that command the fan to the desired state.
8/20/2019 P D4SD 2.0 Syslib-
29/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 29
Discrete 2-, 3-, 4-state Device (P_D4SD)
Based on the wiring of the I/O, we can now configure the P_D4SD instructionhow we want to process the outputs to get to the desired state. We can dothis via the following table: x = don't care, 1 = command output On, 0 = command output Off.
We are setting Output A so it can be used for display purposes even thoughOutput A is not used by the cooling fan device. The parameterCfg_OutSt[x]Write determines which outputs get written for each state. The parameter Cfg_OutSt[x]State determines the state that gets written. These parameters are single integers where bit 0 represents output A and bit 3 representsoutput D.
These parameters are displayed in binary format as indicated by the prefix 2#. Byusing Table 8, we can set the settings as follows:
Cfg_OutSt0Write: 2#0000_1111
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
We can now repeat this same effort to configure how the P_D4SD instructiondetermines actual state based on the field inputs via the following table: x = don't care, 1 = status checked on, 0 = status checked off.
Table 8 - P-D4SD Example Outputs
Output A Output B Output C Output D
State 0 1 0 0 0
State 1 0 1 0 0
State 2 0 0 1 0
State 3 0 0 0 1
Table 9 - P_D4SD Example Inputs
Input A Input B Input C Input D
State 0 x 0 0 0
State 1 x 1 0 0
State 2 x 0 1 0
State 3 x 0 0 1
8/20/2019 P D4SD 2.0 Syslib-
30/56
30 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
The parameter Cfg_FdbkSt[x]Check determines which feedback inputs to checkfor each state. The parameter Cfg_FdbkSt[x]State determines how the state isinterpreted from the input values.
By using Table 9, we can set the settings as follows:
Cfg_FdbkSt0Check: 2#0000_1110
Cfg_FdbkSt0State: 2#0000_0000
Cfg_FdbkSt1Check: 2#0000_1110
Cfg_FdbkSt1State: 2#0000_0010
Cfg_FdbkSt2Check: 2#0000_1110
Cfg_FdbkSt2State: 2#0000_0100
Cfg_FdbkSt3Check: 2#0000_1110
Cfg_FdbkSt3State: 2#0000_1000
As this is a cooling fan, if there is a device mismatch or fault, we still want thelogic to command to the desired state. Therefore, Cfg_ShedOnFail andCfg_ShedOnDeviceFault are both set to 0.
Lastly, the following local configuration tags should be configured to drive thetext on the operations faceplate. In this example, the cooling fan P&ID tag isM401. In this example, they are set as follows:
Cfg_Tag: ‘M401’
Cfg_Label: ‘Line 4 Rectifier Fan’
Cfg_Desc: ‘Line 4 Rectifier Cooling Fan’
Cfg_St0Text: ‘Stopped’Cfg_St1Text: ‘Slow’
Cfg_St2Text: ‘Medium’
Cfg_St3Text: ‘Fast’
8/20/2019 P D4SD 2.0 Syslib-
31/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 31
Discrete 2-, 3-, 4-state Device (P_D4SD)
Local tags can be configured through the HMI faceplates or in RSLogix 5000software by opening the Instruction Logic of the Add-On Instruction instanceand then selecting the string on the displayed rung.
All the strings in local tags are shown on the first rung of the Add-OnInstruction's ‘Logic’ routine for your convenience.
8/20/2019 P D4SD 2.0 Syslib-
32/56
32 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Display Elements A display element (global object) is created once and can be referenced multipletimes on multiple displays in an application. When changes are made to theoriginal (base) object, the instantiated copies (reference objects) areautomatically updated. Use of global objects, in conjunction with tag structuresin the ControlLogix system, aid consistency and save engineering time.
IMPORTANT Some display elements have different names in FactoryTalk View ME software
than in FactoryTalk View SE software. This is because display elements that
are shared among objects have to be instantiated separately in FactoryTalk
View ME software to make sure the correct faceplate is accessed from the
display element.
For the P_D4SD Add-On Instruction, the display element names are the same
for the FactoryTalk View SE software and the FactoryTalk View ME software.
Table 10 - P_D4SD Display Elements Description
Display Element Name Display Element Description
GO_P_D4SD_4Way The Three/Four-way Valve parameters define the inletand output ports of the valve:
• No. 110 - Top port open state• No. 111 - Right port open state• No. 112 - Bottom port open state• No. 113 - Left port open state
• 0 = Inlet (always shown as open)• 1 = Open when Val_Sts = 1 (state 0)• 2 = Open when Val_Sts = 2 (state 1)• 3 = Open when Val_Sts = 3 (state 2)• 4 = Open when Val_Sts = 4 (state 3)
GO_P_D4SD_Diverter (top display)
GO_P_D4SD_Diverter1 (bottom display)
The Two-way Diverter Valve parameters define the stateof the valve:
• State 0: Open top-left• State 1: Open top-right• State 2: N/A• State 3: N/A
GO_P_D4SD _3WaySO_Rt (first display)
GO_P_D4SD _3WaySO_Lt (second display)
GO_P_D4SD _3WaySO_Btm (third display)
GO_P_D4SD _3WaySO_Top (fourth display)
Parameters define the inlet and output ports of theTwo-way Solenoid-operated Diverter Valve.
8/20/2019 P D4SD 2.0 Syslib-
33/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 33
Discrete 2-, 3-, 4-state Device (P_D4SD)
GO_P_GO_P_D4SD_3WayMO_Rt (first display)
GO_P_GO_P_D4SD_3WayMO_Rt (second display)
GO_P_GO_P_D4SD_3WayMO_Rt (third display)
GO_P_GO_P_D4SD_3WayMO_Rt (fourth display)
Parameters define the inlet and output ports of theTwo-way Motor-operated Diverter Valve.
GO_P_D4SD_R (top display)
GO_P_D4SD_U (middle display)GO_P_D4SD_D (bottom display)
Motors operating in different positions.
GO_P_D4SD_Inline_U (first display)
GO_P_D4SD_Inline_D (second display)
GO_P_D4SD_Inline_L (third display)
GO_P_D4SD_Inline_R (fourth display)
Inline motors operating in different positions.
Table 10 - P_D4SD Display Elements Description
Display Element Name Display Element Description
8/20/2019 P D4SD 2.0 Syslib-
34/56
34 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
GO_P_D4SD_Agitator_D Agitator shown as a display element.
GO_P_D4SD_Mixer_U Mixer shown as a display element.
GO_P_D4SD_Blower_R (first display)
GO_P_D4SD_Blower_U (second display)
GO_P_D4SD_Blower_L (third display)
GO_P_D4SD_Blower_D (fourth display)
Blowers operating in different positions.
GO_P_D4SD_Pump_R
GO_P_D4SD_Pump_U
GO-P_D4SD_Pump_L
Pumps operating in different positions.
GO_P_D4SD_RPump_U Rotary Gear Pump shown as a display element.
GO_P_D4SD_Fan_D Fan shown as a display element.
Table 10 - P_D4SD Display Elements Description
Display Element Name Display Element Description
8/20/2019 P D4SD 2.0 Syslib-
35/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 35
Discrete 2-, 3-, 4-state Device (P_D4SD)
Common attributes of the P_D4SD global objects include the following:
• Current state of the inputs in text
• Status/Quality indicator
• Maintenance Bypass indicator
• Label
• Color changing alarm border that blinks on unacknowledged alarm
• Alarm indicator that changes color with the severity of an alarm
Status/Quality Indicators
One of these symbols appears to the left of the graphic symbol or right of thelabel when the described condition is true.
GO_P_D4SD_Conveyor_R Conveyor shown as a display element.
Table 10 - P_D4SD Display Elements Description
Display Element Name Display Element Description
Graphic Symbol Description
Invalid configuration
I/O Fault
Value uncertain
The device is not ready to operate
No symbol displayed I/O quality good and configuration valid
TI P When the Invalid Configuration Indicator appears, you can find what
configuration setting is invalid by following the indicators. Click the graphic
symbol to call up 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
will be flagged with this indicator or appear in a magenta box.
Alarm Indicator
Status/Quality Indicator
Maintenance Bypass
8/20/2019 P D4SD 2.0 Syslib-
36/56
36 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Maintenance Bypass Indicator
This symbol appears to the right of the Label to indicate that a MaintenanceBypass has been activated.
Alarm Indicators
One of these symbols appears to the left of the Label to indicate the describedalarm condition. The alarm border and label background blink ifAcknowledgement of an alarm condition is required.
Graphic Symbol Description
A Maintenance Bypass is active
No symbol displayed No Maintenance Bypass active
TI P When the Maintenance Bypass Indicator appears, you can find what condition
was bypassed by following the indicators. Click the graphic symbol to call up
the faceplate. The Maintenance Bypass Indicator will appear 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 will be flagged with this
indicator.
Symbol Description
Black ‘I’ in white box Alarm Inhibit: an alarm is inhibited by the Program,Disabled by Maintenance, or Suppressed by the Operator
White bell, border, and text
background blinking
Return to Normal (no Alarm condition), but a previous
Alarm has not been acknowledged
Blue border and text backgroundYellow rectangle with explanation point (!)
Information Severity Alarm
Yellow border and text backgroundOrange triangle with explanation point (!)
Warning Severity Alarm
Red border and text backgroundOrange diamond with explanation point (!)
Exception Severity Alarm
Magenta border and text background
Red circle with two explanation points (!!)
Fault Severity Alarm
No symbol or border displayed, text is on normal (lightgray) background, not blinking
No Alarm or Alarm Inhibit condition, and allAlarms are Acknowledged
8/20/2019 P D4SD 2.0 Syslib-
37/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 37
Discrete 2-, 3-, 4-state Device (P_D4SD)
Use Global Objects
The global objects for this instruction can be found in the global object file(RA-BAS) P_D4SD Graphics Library.ggfx. Complete the following to use aglobal object.
1. Copy it from the global object file and paste it in the display file.
2. In the display file, right-click the global object file and choose GlobalObject Parameter Values.
The Global Object Parameter Values dialog box appears.
3. Type the tag in the Value column as specified in the Description column.
4. Click OK.
TI P You can click the ellipsis (…) to browse and select a tag.
Values for items marked ‘(optional)’ may be left blank.
8/20/2019 P D4SD 2.0 Syslib-
38/56
38 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Faceplate The P_D4SD faceplate consists of five tabbed pages. The Operator tab isdisplayed when the faceplate is initially called up. Click the appropriate icon atthe top of the faceplate to access a specific tab.
The faceplate provides the means for operators, maintenance workers, engineers,and others to interact with the P_D4SD Instruction instance, including viewingits status and values and manipulating it through its commands and settings. When a given input is restricted via FactoryTalk View security, the required usersecurity code letter is shown in the tables that follow.
Operator Tab
Operator
Maintenance
Engineering
Alarm Configuration
Alarms Help
Exit
Reset AcknowledgeAll Alarms Button
Input Status Indicator
Mode Indicator
Requested Modes Indicator
Device StateIndicator
Device Command Buttons
8/20/2019 P D4SD 2.0 Syslib-
39/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 39
Discrete 2-, 3-, 4-state Device (P_D4SD)
The Operator tab shows the following information:
• The current Mode (Program, Operator, Override, Maintenance,or Hand)
• Requested Modes Indicator (This only appears if the Operator or ProgramMode has been superseded by another mode.)
• Device states• Permissive states
• Communication status (Comm or I/O Fault)
The following table shows the functions included on the Operator tab.
When the P_D4SD instruction does not have associated Permissive (P_Perm)instructions, the Permissive buttons revert to indicators only .
Table 11 - Operator Tab Description
Function Action Security
Click to release Operator mode lock. Manual DeviceOperation (Code B)
Click to lock in Operator mode.
Click to reset and acknowledge all alarms. Acknowledge Alarms(Code F)
Click to command the device to a state. None
There are up to four Permissive status indicators/buttons.Click the button beside each state to view the faceplate for
Permissives associated with that state. The Permissive buttonappears when Cfg_HasPerm0Obj, Cfg_HasPerm1Obj,Cfg_HasPerm2Obj, or Cfg_HasPerm3Obj is set.
Click to open the i nterlock faceplate for the device. Thisbutton appears if Cfg_HasIntlkObj is set and opens thefaceplate associated with the P_Intlk instruction configuredin the global object instance.
8/20/2019 P D4SD 2.0 Syslib-
40/56
8/20/2019 P D4SD 2.0 Syslib-
41/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 41
Discrete 2-, 3-, 4-state Device (P_D4SD)
Maintenance Tab
This tab is divided into two pages.
Page 1 of the Maintenance tab shows the following information:
• The current mode (Program, Operator, Override, Maintenance, or Hand)• Requested Modes Indicator - This display highlights all of the modes that
have been requested. The leftmost highlighted mode is the active mode
• Shows whether the device is enabled or disabled
• Shows Permissive Bypassed/Enabled Indicator
• Shows whether Override mode bypasses the bypassable permissives
Maintenance Tab Page 1
Mode IndicatorMaintenance ModeAcquire and ReleaseCommand Buttons
Requested Modes Indicator
Device Enable andDisable CommandButtons
Interlock and Permissive
Bypass and EnableCommand Buttons
8/20/2019 P D4SD 2.0 Syslib-
42/56
42 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
The following table shows the functions on the Maintenance tab page 1.
Function Action Security Configuration Parameters
Click to release device fromMaintenance mode
EquipmentMaintenance(Code C)
None
Click to place device inMaintenance mode
Click to enable the device
Click to disable the device
Click to enable checking of allpermissives and interlocks
Disable AlarmsBypass
Permissivesand Interlocks(Code H)
Click to bypass checking ofbypassable permissives andinterlocks
In Override Mode,bypass Interlocksand Permissivesthat can bebypassed
Check this box to bypass thebypassable permissives andinterlocks in Override mode
Cfg_OvrdPermIntlk
8/20/2019 P D4SD 2.0 Syslib-
43/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 43
Discrete 2-, 3-, 4-state Device (P_D4SD)
Maintenance Tab Page 2
Page 2 of the Maintenance tab shows data entry fields for severalconfiguration parameters.
The following table shows the functions on the Maintenance tab page 2.
Table 13 - Maintenance Tab 2 Description
Function Action Security Configuration Parameters
Time to pulse:
Output A (sec)
Output B (sec)
Output C (sec)
Output D (sec)
Type a value to indicate the time(seconds) to energize outputs to thedevice to be sure they are latched in.(0 = output held continuously)
Configuration& TuningMaintenance(Code D)
• Cfg_OutAPulseT• Cfg_OutBPulseT• Cfg_OutCPulseT• Cfg_OutDPulseT
Time after newstate requested to
reach that statebefore Fault (sec)
Type a value to indicate the time(seconds) to allow the device to reach
state before issuing a fault.
Cfg_FailT
8/20/2019 P D4SD 2.0 Syslib-
44/56
44 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Engineering Tab
This tab is divided into three pages.
On Page 1 of the Engineering tab, you can configure the description, label, tag,and state names for the device.
Engineering Tab Page 1
The following table lists the functions on the Engineering tab page 1.
Mode Configuration Button
Configure Device Description,
Label, and Tag Text
Table 14 - Engineering Tab 1 Description
Function Action Security Configuration Parameters
Click to navigate to the ModeConfiguration popup. None See popup on page 45.
D escr ipt io n Type the d evice descript ion to sho won the Faceplate title bar.
EngineeringConfiguration(Code E)
Cfg_Desc
Label Type the label to show on the GraphicSymbol.
Cfg_Label
8/20/2019 P D4SD 2.0 Syslib-
45/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 45
Discrete 2-, 3-, 4-state Device (P_D4SD)
Mode Configuration Popup
This popup lets you set the Cfg_ProgDefault parameter, which sets the defaultmode when no mode is being requested. Changing the parameter requiresengineering access (security code E).
Tag Type the tag name to show on theFaceplate and Tooltip.
Important: Pausing the mouse overthis field will display a tool tip with
the configured Logix tag/path.
EngineeringConfiguration(Code E)
Cfg_Tag
Text to Display in:
State 0:
State 1:
State 2:
State 3:
Type text to describe the state. • Cfg_St0Text• Cfg_St1Text• Cfg_St2Text• Cfg_St3Text
Number of States:
2
3
4
Select the number of states. Cfg_NumStates
Clear ProgramCommands onReceipt
Set this parameter to the following:• ON to use Edge-triggered Program
Commands (default).
• OFF to use Level-triggeredProgram Commands.
Cfg_PCmdClear
New operatorcommand resetsfault
Check this box to reset a fault upon anew operator command.
Cfg_OCmdResets
IMPORTANT If no mode is being requested, changing the default mode will change the
mode of the instruction.
Table 14 - Engineering Tab 1 Description
Function Action Security Configuration Parameters
8/20/2019 P D4SD 2.0 Syslib-
46/56
46 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Engineering Tab Page 2
The following table shows the functions on the Engineering tab page 2.
Table 15 - Engineering Tab 2 Description
Function Action Security Configuration Parameters
A P_Perm object isconnected to:
Inp_PermOK0
Inp_PermOK1
Inp_PermOK2
Inp_PermOK3
Check a box to have the P_Perminstruction used with this device foropen Permissives. This changes thePermissive Indicator to a button thataccesses the Permissive faceplate.
EngineeringConfiguration(Code E)
• Cfg_HasPerm0Obj• Cfg_HasPerm1Obj• Cfg_HasPerm2Obj• Cfg_HasPerm3Obj
A P_Intlk object is
connected toInp_Intlk
Check this box to have a P_Intlk
object connected to an interlock trip.
Cfg_HasIntklObj
Outputs andFeedback
Click the state to open a popupwindow to see what is enabled.
None See popup on page 47.
8/20/2019 P D4SD 2.0 Syslib-
47/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 47
Discrete 2-, 3-, 4-state Device (P_D4SD)
State Configuration Popup
This popup directs how the P_D4SD instruction commands the device state viaoutputs and determines the actual device state via feedback inputs. The first twocolumns for output set parameters, Cfg_OutSt[x]Write, andCfg_OutSt[x]Value, determine how outputs are written to command to a state.The second two columns for feedback set parameters, Cfg_FdbkSt[x]Check, andCfg_FdbkSt[x]State, determine how the state is interpreted from theinput values.
Changing the parameters requires engineering access (security code E).
8/20/2019 P D4SD 2.0 Syslib-
48/56
48 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Engineering Tab Page 3
The following table shows the functions on the Engineering tab page 3.
Table 16 - Engineering Tab 3 Description
Function Action Security Configuration Parameters
Shed Action
Go to State 0
Hold State
Click the radio button to determinewhether you hold position or go tostate 0 upon a shed condition.
EngineeringConfiguration(Code E)
Cfg_St0onShed
Shed Trigg er s: C lick the respect ive box to enabl e
whether an I/O Fault, Device Fault,or Failure to Reach State isconsidered a shed condition.
The device always sheds an InterlockTrip. This item cannot be unchecked.It is displayed as a reminder that theInterlock Trip function alwaystriggers a shed.
• Cfg_ShedonDeviceFault
• Cfg_ShedonIOFault• Cfg_ShedonFail
Delay to echo backON/OFF status inSimulation (sec)
Type a value (seconds) to indicatethe delay to echo back reachingstate when in simulation.
Cfg_SimFdbkT
8/20/2019 P D4SD 2.0 Syslib-
49/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 49
Discrete 2-, 3-, 4-state Device (P_D4SD)
Alarm Configuration Tab
The Alarm Configuration tab contains configuration related to the alarm statusfor the device.
Alarm Configuration Tab Page 1
The following table shows the functions on the Alarm Configuration tab page 1.
Table 17 - Alarm Configuration Tab 1 Description
Function Action Security Configuration Parameters
Alarm Click for a checkmark to indicate thealarm exists for this alarm parameter.
EngineeringConfiguration
(Code E)
• Cfg_HasFailAlm• Cfg_HasDeviceFaultAlm
• Cfg_HasIntlkTripAlm• Cfg_HasIOFaultAlm
8/20/2019 P D4SD 2.0 Syslib-
50/56
50 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
AcknowledgeRequired
Require acknowledgement of thealarm.
If using FactoryTalk View Alarm andEvents software, configure its Alarm
Tag with Acknowledge Required. Thecontroller handles acknowledgementwithin this instruction.
EngineeringConfiguration(Code E)
• Cfg_FailAckReqd• Cfg_DeviceFaultAckReqd• Cfg_IntlkTripAckReqd• Cfg_IOFaultAckReqd
Reset Required Require a reset to clear the alarmstatus. There is a single alarm resetthat resets all of the alarms for thedevice.
If using FactoryTalk View Alarm andEvents software, do not checkLatched. The controller handles thealarm latching and reset withinthis instruction.
• Cfg_FailResetReqd• Cfg_DeviceFaultResetReqd• Cfg_IntlkTripResetReqd• Cfg_IOFaultResetReqd
Severity These parameters determine theseverity of each alarm. The followingare valid values:
1 = Information (blue)2 = Warning (yellow)
3 = Exception (red)
4 = Fault (magenta)
Important: The Severity is used todrive the color of the indication of theglobal object and faceplate when thealarm is active.
If using FactoryTalk View Alarm andEvents software, the severity in thealarm tag must be set to align withthe configuration value. Typicalvalues are the following:
Severity 1: 1…250
Severity 2: 251…500
Severity 3: 501…750
Severity 4: 751…1000
• Cfg_FailSeverity• Cfg_DeviceFaultSeverity• Cfg_IntlkTripSeverity• Cfg_IOFaultSeverity
Alarm Minimum ONTime (seconds)
When an Alarm occurs, the Alarmoutput will be held on for at least thisamount of time (sec). If set to 5seconds or less, the Alarm output willbe held on for at least 5 seconds toensure it is seen by polling. Set thistime higher if you want an Alarm tobe held in the Alarm state (and onthe Alarm summary) longer. This willkeep it visible to the Operator, or keepthe Alarm from clearing and beingset again (for an intermittentcondition) until the Operator has hadtime to perform any Alarm-relatedactions.
Important: If the alarm isconfigured with Reset Required(Cfg_ResetReqd = 1), the operatorcan reset the alarm before this timeexpires if the input condition hasreturned to normal.
Code D • Fail.Cfg_AlmMinOnT• DeviceFault.Cfg_AlmMinOnT• IntlkTrip.Cfg_AlmMinOnT• IOFault.Cfg_AlmMinOnT
Table 17 - Alarm Configuration Tab 1 Description
Function Action Security Configuration Parameters
8/20/2019 P D4SD 2.0 Syslib-
51/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 51
Discrete 2-, 3-, 4-state Device (P_D4SD)
Alarms Tab
The Alarms tab displays each configured alarm for the P_D4SD instruction.The icon on the tab for the Alarms page changes color based on the current activealarms. A blinking alarm icon indicates that one or more alarms must beacknowledged or the device must be reset.
If an alarm is active, the panel behind the alarm changes color to match theseverity of the alarm. The color of the bell icon at the top of the faceplateshows the highest active alarm’s severity, and the icon blinks if any alarmis unacknowledged.
Alarm AcknowledgeCommand and Button
Reset and Acknowledge AllAlarms Command Button
Table 18 - Alarm Color Definitions
Color Definition
Magenta Fault
Red Exception
Yellow Warning
Blue Information
White (bell icon) Alarm has cleared but is unacknowledged
Background (light gray) No alarm
8/20/2019 P D4SD 2.0 Syslib-
52/56
52 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
The following table shows the function on the Alarms tab.
The panel behind the alarm blinks if the alarm requires acknowledgement.Click the button with the checkmark to acknowledge the alarm.
The Alarm Acknowledge button is enabled if the corresponding alarmrequires acknowledgement.
The Reset and Acknowledge All Alarms button is enabled if any alarm requiresreset or acknowledgement.
Table 19 - Alarms Tab Description
Function Action Security
Click to acknowledge the alarm. Acknowledge Alarms(Code F)
Click to reset and acknowledgeall alarms.
Acknowledge Alarms(Code F)
8/20/2019 P D4SD 2.0 Syslib-
53/56
Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012 53
Discrete 2-, 3-, 4-state Device (P_D4SD)
Discrete 2-, 3-, 4-state Device Faceplate Help
8/20/2019 P D4SD 2.0 Syslib-
54/56
54 Rockwell Automation Publication SYSLIB-RM028A-EN-P - August 2012
Discrete 2-, 3-, 4-state Device (P_D4SD)
Notes:
8/20/2019 P D4SD 2.0 Syslib-
55/56
8/20/2019 P D4SD 2.0 Syslib-
56/56
Rockwell Automation Support
Rockwell Automation provides technical information on the Web to assist you in using its products.At http://www.rockwellautomation.com/support , you can find technical manuals, technical and application notes, samplecode and links to software service packs, and a MySupport feature that you can customize to make the best use of thesetools. You can also visit our Knowledgebase at http://www.rockwellautomation.com/knowledgebase for FAQs, technicalinformation, support chat and forums, software updates, and to sign up for product notification updates.
For an additional level of technical phone support for installation, configuration, and troubleshooting, we offerTechConnectSM support programs. For more information, contact your local distributor or Rockwell Automationrepresentative, or visit http://www.rockwellautomation.com/support/ .
Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in thismanual. You can contact Customer Support for initial help in getting your product up and running.
New Product Satisfaction Return
Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from themanufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve thisdocument, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/ .
United States or Canada 1.440.646.3434
Outside United States or Canada Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html, or contact your local RockwellAutomation representative.
United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to yourdistributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Rockwell Otomasyon Ticaret A.Ş., Kar Plaza ş Merkezi E Blok Kat:6 34752 çerenköy, stanbul, Tel: +90 (216) 5698400
http://www.rockwellautomation.com/supporthttp://www.rockwellautomation.com/knowledgebasehttp://www.rockwellautomation.com/support/http://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdfhttp://www.rockwellautomation.com/literature/http://www.rockwellautomation.com/locations/http://www.rockwellautomation.com/locations/http://www.rockwellautomation.com/support/americas/phone_en.htmlhttp://www.rockwellautomation.com/support/americas/phone_en.htmlhttp://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdfhttp://www.rockwellautomation.com/knowledgebasehttp://www.rockwellautomation.com/supporthttp://www.rockwellautomation.com/locations/http://www.rockwellautomation.com/literature/http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/americas/phone_en.htmlhttp://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdf