Plantpax Library of Process Objects: Solenoid-Operated Valve (P - Valveso)

Reference Manual
PlantPAx Library of Process Objects:

Solenoid-operated Valve (P_ValveSO)
Version 3.0
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, Rockwell Automation, RSLogix, Logix5000, FactoryTalk, PlantPAx, and ControlLogix are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of Contents
Preface Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Solenoid-operated Valve Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

(P_ValveSO) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Optional Template Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Solenoid-operated Valve Input Structure . . . . . . . . . . . . . . . . . . . . . . . 12
Solenoid-operated Valve Output Structure . . . . . . . . . . . . . . . . . . . . . 15
Solenoid-operated Valve Local Configuration Tags. . . . . . . . . . . . . . 18
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
State Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Use Global Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Quick Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Solenoid-operated Valve Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . 41
Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 3

Table of Contents
Notes:
4 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Preface
This document applies to version 3.0 of the PlantPAx™ Library of Process

Objects. The PlantPAx Library of Process Objects is a predefined library of
controller code (Add-On Instructions), display elements (global objects), and
faceplate displays 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 62682

at http://www.rockwellautomation.custhelp.com.
The PlantPAx Library of Process Objects version 3.0 is compatible with the
following products:
• RSLogix™ 5000 software, version 18 or later
• FactoryTalk® View Site Edition software, version 7.0 or later
• FactoryTalk View Machine Edition software, version 7.0 or later
For general library considerations, see PlantPAx Library of Process Objects,

publication PROCES-RM002.
Additional Resources These documents contain additional information concerning related products
from Rockwell Automation.
Table 1 - Additional Resources

Resource Description
PlantPAx Process Automation System Selection Guide, Provides information to assist with equipment procurement
publication PROCES-SG001 for your PlantPAx system.
PlantPAx Process Automation System Reference Manual, Provides characterized recommendations for implementing
publication PROCES-RM001 your PlantPAx system.
PlantPAx Library of Process Objects, Provides general considerations for the PlantPAx system
publication PROCES-RM002 library of process objects.
FactoryTalk View Machine Edition User Manual, Provides details on how to use this software package for
publication VIEWME-UM004 creating an automation application.
FactoryTalk View Site Edition User Manual, Provides details on how to use this software package for
publication VIEWSE-UM006 developing and running human-machine interface (HMI)
applications that can involve multiple users and servers,
distributed over a network.
PlantPAx Library of Process Objects: Common Alarm Block Details how to monitor an input condition to raise an alarm.
(P_Alarm) Reference Manual, publication SYSLIB-RM002 Information includes acknowledging, resetting, inhibiting,
and disabling an alarm. Generally the P_Alarm faceplate is
accessible from the Alarms tab.
PlantPAx Library of Process Objects: Interlocks with First Explains how to collect (sum up) the interlock conditions
Out and Bypass (P_Intlk) Reference Manual, that stop or de-energize a running or energized piece of
publication SYSLIB-RM004 equipment or prevent it from starting or being energized.

Preface
Table 1 - Additional Resources

Resource Description
PlantPAx Library of Process Objects: Common Mode Block Explains how to choose the Mode (owner) of an instruction
(P_Mode) Reference Manual, publication SYSLIB-RM005 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.
PlantPAx Library of Process Objects: Permissives with Details how to collect permissive conditions to start a piece
Bypass (P_Perm) Reference Manual, of equipment.
publication SYSLIB-RM007
PlantPAx Library of Process Objects: 2-state Valve Explains how to monitor stroke times and stroke counts for a
Statistics (P_ValveStats) Reference Manual, 2-state (open and close) valve.
publication SYSLIB-RM036
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.

The P_ValveSO (Solenoid-operated Valve) Add-On Instruction is used to

operate (open and close) a single solenoid-operated valve in a variety of modes,
monitoring for fault conditions.
Faceplate
Global Object
Add-On Instruction
Guidelines Use this instruction when you need to operate a single-solenoid spring-return
valve, either energize-to-open (fail closed) or energize-to-close (fail open). The
valve can have, but does not require, limit switch feedback for either or both ends
of travel.
Do not use this instruction in these situations:

• You need to operate a motor-operated valve or other valve that requires
separate Open and Close outputs. Use the P_ValveMO Motor-Operated
Valve Add-On Instruction instead. The P_ValveMO Instruction can also
be suitable for some dual-solenoid valves.
• You need to operate a multi-solenoid valve such as a Mix-Proof Valve that
has positions (such as for SIP/CIP) other than ‘opened’ and ‘closed’. Use
the P_ValveMP Mix-Proof Valve Add-On Instruction instead.
• You need to monitor a valve that is primarily operated by hand. The valve
could support a ‘trip’ output to drive it to a ‘safe’ position. Use the
P_ValveHO Hand-Operated Valve Add-On Instruction instead.
• You have a throttling (continuously variable) valve. Use the P_AOut
Analog Output Instruction, the P_ValveC Control Valve Instruction, or
operate the valve directly from a PIDE or PID built-in Instruction.
• For some valves, the P_DOut (Discrete Output), P_D4SD (Discrete
Four-State Device), or P_nPos (n-Position Device) Instruction could be
suitable.

Functional Description The P_ValveSO instruction includes an Add-On Instruction for use with
RSLogix 5000 software, version 18 or later, and Logix controllers, version 18 or
later, plus a multi-tabbed faceplate and several graphic symbols for use in building
displays on FactoryTalk View SE version 7.0 or later.
The P_ValveSO provides the following capabilities:

• Provide for ownership of the Solenoid Valve through the standard
P_Mode Add-On Instruction and Modes. Modes of operation are
described below.
• Provide for configuration of the de-energized state of the valve: Fail Open
or Fail Closed (default) at the engineer level.
• Provide the ability to open or close a Solenoid Valve, and if the valve is so
equipped, monitor open/close limit switch feedback to verify the Solenoid
Valve is opened or closed. Whether or not the Solenoid Valve has each of
the feedback limit switches can be configured at the engineer level.
Whether or not to use each of the feedback limit switches can be
configured at the Maintenance level.
• Provide an alarm for Full Stall if the valve feedback indicates it did not
move off the original position within a configured amount of time when
commanded to the other position. Provide an alarm for Transit Stall if the
valve feedback indicates the valve moved from the original position but did
not reach the target position within a configured amount of time. The
Transit Stall or Full Stall condition can optionally de-energize the output
to the valve, requiring a reset.
• Provide a limit switch Failure indication if the limit switches indicate the
valve is not closed, not opened, and not moving. Provide a configuration
for the failure state: whether both switches are ON or both switches are
OFF to indicate limit switch failure.
• Provide for Permissives (Bypassable and Non-bypassable) that are
conditions that allow the Solenoid Valve to energize, and Interlocks
(Bypassable and Non-bypassable) that are conditions that de-energize the
Solenoid Valve as well as prevent energizing. Provide an Alarm when an
Interlock de-energizes the Solenoid Valve. Provide Maintenance the
capability to bypass the Bypassable Permissives and Interlocks.
• Provide maintenance personnel the capability to Disable
(keep de-energized) the Solenoid Valve.
• Monitor an I/O Fault input and alarm on an I/O Fault. The I/O Fault
condition can optionally de-energize the output to the valve, requiring
a reset.

• In Override mode, provide an Override State input that determines

whether the Override is to Open or Close the Solenoid Valve (default =
Close). See Modes below for more information on Override.
• Provide a Simulation capability, where the output to the Solenoid Valve are
kept de-energized, but the instruction can be manipulated as if a working
Solenoid Valve were present. The delay between a command to Open or
Close and the simulated opened or closed response is configurable. (This
same delay is used if the Solenoid Valve is configured with no Open/Close
feedback.) This capability is often used for activities such as instruction
testing and operator training.
• Provide an output suitable for holding the Solenoid Valve coil energized
(to open or close, based on the configured fail state).

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_ValveSO_3_0-00_AOI.L5X Add-On instruction must be imported into

the controller project to be able to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.
Visualization Files
The following files from Knowledgebase Answer ID 62682 at
http://www.rockwellautomation.custhelp.com are required to use
the P_ValveSO Object.
Table 2 - P_ValveSO 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 faceplates use the native
analog input data entry so no file is required.
(RA-BAS) P_Alarm-Faceplate (RA-BAS-ME) P_Alarm-Faceplate The alarm faceplate display used for the object.
(RA-BAS) P_Alarm-Help (RA-BAS-ME) P_Alarm-Help P_Alarm Help information that is accessed
from the P_Alarm Help faceplate.
(RA-BAS) P_Intlk-Faceplate (RA-BAS-ME) P_Intlk-Faceplate The Interlock faceplate display used for the
object.
(RA-BAS) P_IntlkPerm-Help (RA-BAS-ME) P_IntlkPerm-Help Interlock/Permissives Help information that is
accessed from the P_Intlk or P_Perm Help
faceplate.
(RA-BAS) P_Mode-Help (RA-BAS-ME) P_Mode-Help Mode Help information that is accessed from
the P_Mode Help faceplate.
(RA-BAS) P_Perm-Faceplate (RA-BAS-ME) P_Perm-Faceplate The Permissives faceplate display used for the
object.
(RA-BAS) P_Mode-Config (RA-BAS-ME) P_Mode-Config Message box used to set Default mode.
(RA-BAS) P_ValveSO-Faceplate (RA-BAS-ME) P_ValveSO-Faceplate The faceplate display used for the object.
(RA-BAS) P_ValveSO-Help (RA-BAS-ME) P_ValveSO-Help The help display used for the object.
(RA-BAS) P_ValveSO-Quick (RA-BAS-ME) P_ValveSO-Quick The Quick display for the object.
(RA-BAS) P_ValveStats-Faceplate (RA-BAS-ME) P_ValveStats-Faceplate The Valve Stats faceplate display used for the
object.

Table 2 - P_ValveSO Visualization File Types

Application Type File Type FactoryTalk View SE Software FactoryTalk View ME Software Description
Graphics - Global GGFX (RA-BAS) Common Faceplate Objects (RA-BAS-ME) Common Faceplate Objects Common global objects used on all Process
Objects Object faceplates.
(RA-BAS) Process Alarm Objects (RA-BAS-ME) Process Alarm Objects Process-specific global objects used on all
Process Object faceplates.
(RA-BAS) Process Faceplate Valve (RA-BAS-ME) Process Faceplate Valve Objects Global objects used for Process Object valve
Objects faceplates.
(RA-BAS) Process Graphics Library (RA-BAS-ME) Process Graphics Library Graphic objects used to build process displays
for process objects, including P_ValveSO.
(RA-BAS) Process Help Objects (RA-BAS-ME) Process Help Objects Global objects used for help on all Process
Objects help displays.
(RA-BAS) Process Intlk Objects (RA-BAS-ME) Process Intlk Objects Global objects used for managing interlocks
and permissives on Process Object faceplates.
(RA-BAS) Process Mode Objects (RA-BAS-ME) Process Mode Objects Global objects used for managing modes on
process object faceplates.
Graphics - Images PNG 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 faceplates for all Process Objects.
When PNG graphic formats are imported they
are renamed like a BMP file but retain a
PNG format.
HMI Tags CSV N/A FTVME_PlantPAxOBjx_Tags_3_0_00.csv(1) These tags must be imported into the
FactoryTalk View ME project to support
switching tabs on any Process Object faceplate.
(1) The service release number (boldfaced) can change as service revisions are created.
Optional Template Files

You can import the files in Table 2 individually, or you can use the following
template files:
• FTVME_7_0_Template_PlantPAxLib_3_0_00.apa(1): FactoryTalk View
ME backup. Contains .gfx, .ggfx, images, and tags for all Process Objects
in a FactoryTalk View Machine Edition project.
• FTVSE_7_0_Template_PlantPAxLib_3_0_00.apa(1): FactoryTalk View
SE Station backup. Contains .gfx, .ggfx, and images for all Process Objects
in a FactoryTalk View Site Edition Station project. Use Knowledgebase
Answer ID 39581 at http://www.rockwellautomation.custhelp.com to
load the files in the restored station project into your HMI server on a
FactoryTalk View SE Distributed application.
• RSL5k_18_Template_PlantPAxLib_3_0_00.acd(1): RSLogix 5000
software template project with all process objects instructions loaded, as
well as recommended task structure and diagnostic objects.
(1) The service release number (boldfaced) can change as service revisions are created.

Controller Code This section describes the parameter references for this Add-On Instruction.
Solenoid-operated Valve 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.
Table 3 - P_ValveSO Input Parameters
Input Parameter Data Type Default Description
EnableIn BOOL 1 Ladder Diagram:
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.
Inp_OpenLS BOOL 0 Valve Open and Closed Limit switch:
1 = Confirmed open or closed
Inp_ClosedLS
Inp_PermOK BOOL 1 1 = Bypassable and Non-bypassable permissives OK, valve can energize.
Inp_NBPermOK BOOL 1 1 = Non-bypassable permissives OK, valve can energize if Bypassable permissives are bypassed.
Inp_IntlkOK BOOL 1 1 = Bypassable and Non-bypassable interlocks OK, valve can energize.
Inp_NBIntlkOK BOOL 1 1 = Non-bypassable interlocks OK, valve can energize if Bypassable interlocks are bypassed.
Inp_IOFault BOOL 0 Input communication status:
0 = OK
1 = Fail
Inp_Sim BOOL 0 Simulation input. When set to 1, the instruction keeps the output de-energized and simulates a working
solenoid valve. When set to 0, the instruction operates the valve normally.
Inp_Hand BOOL 0 1 = Select Hand (hard-wired) mode.
Inp_Ovrd BOOL 0 1 = Select Override mode.
Inp_OvrdCmd DINT 0 Override mode command:
0 = None
1 = Close
2 = Open
Inp_Reset BOOL 0 Input parameter used to programatically reset alarms. When set to 1, all alarms requiring reset are reset.
Cfg_FailOpen BOOL 0 1 = Fail Open (energize to close).
0 = Fail Closed (energize to open).
Cfg_HasOpenLS BOOL 0 1 = Valve provides an Open or Closed Limit switch signal.
Cfg_HasClosedLS
Cfg_UseOpenLS BOOL 0 1 = Valve Open or Closed Limit switch is used for failure checking.
Cfg_UseClosedLS


Cfg_LSFail BOOL 1 1 = Both switches ON = fail.
0 = Both switches OFF = fail.
Cfg_HasPermObj BOOL 0 1 = Tells the HMI a library object is connected to Inp_Perm.
IMPORTANT: The name of the Permissive object in the controller must be this object's name with the
suffix ‘_Perm’. For example, if your P_MotorSO object has the name ’MotorSO123’, then its Permissive
object must be named ‘MotorSO123_Perm’.
Cfg_HasIntlkObj BOOL 0 1 = Tells the HMI a library object is connected to Inp_Intlk
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_ValveSO object has the name’ValveSO123’, then its Interlock object
must be named ‘ValveSO123_Intlk’.
Cfg_HasStatsObj BOOL 0 1 = Tells the HMI a P_ValveStats object has been created for this instance os P_ValveSO.
IMPORTANT: The name of the Valve Stats object in the controller must be this object's name with the
suffix ‘_ValveStats’. For example, if your P_ValveSO object has the name’ValveSO123’, then its Valve
Stats object must be named ‘ValveSO123_ValveStats’.
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 aliased to internal tag Mode.Cfg_PCmdClear from P_Mode.
IMPORTANT: Clearing this parameter online can cause unintended program command execution.
Cfg_ProgDefault BOOL 0 This parameter defines the Default mode. When this parameter is 1, the mode defaults to Program if no
mode is being requested. When this parameter is 0, the mode defaults to Operator if no mode is being
requested.
This parameter is aliased to internal tag Mode.Cfg_ProgDefault of P_Mode.
IMPORTANT: Changing this parameter online can cause unintended mode changes.
Cfg_OCmdResets BOOL 0 1 = New Operator Valve Command resets fault.
0 = Reset required to clear fault.
Cfg_ShedOnFullStall BOOL 1 1 = De-energize Valve and Alarm on Full Stall, Transit Stall, or I/O Fault.
0 = Alarm only on Full Stall, Transit Stall, or I/O Fault.
Cfg_ShedOnTransitStall
Cfg_ShedOnIOFault
Cfg_OvrdPermIntlk BOOL 0 1 = Override ignores Bypassable permissive/interlock.
0 = Always use permissive/interlock.
Cfg_HasFullStallAlm BOOL 0 These parameters determine whether the corresponding alarm exists and is checked or if the alarm does
not exist and is not used. When this parameter is 1, the corresponding alarm exists.
Cfg_HasTransitStallAlm These parameters are aliased to the internal tag .Cfg_Exists of the corresponding P_Alarm object.
Cfg_HasIntlkTripAlm
Cfg_HasIOFaultAlm
Cfg_FullStallResetReqd BOOL 0 These parameters determines whether a reset is required to clear the alarm status. When these
parameters are 1, the alarm is latched ON when the alarm occurs. After the alarm condition returns to
Cfg_TransitStallResetReqd normal, a reset is required to clear the alarm status (for example, OCmd_Reset, Inp_Reset, or
Hi.OCmd_Reset are required to clear Alm_Hi alarm after the alarm is set and the value returns to
Cfg_IntlkTripResetReqd normal). When these parameters are 0, no reset is required and the alarm status is cleared when the
Cfg_IOFaultResetReqd alarm condition returns to normal.
These parameters are 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_FullStallAckReqd BOOL 1 These parameters determine whether an acknowledgement is required for an alarm. When these
parameters are 1, the acknowledge (ack) bit is cleared when the alarm occurs. An acknowledge
Cfg_TransitStallAckReqd 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
Cfg_IntlkTripAckReqd acknowledge command is required.
Cfg_IOFaultAckReqd These parameters are aliased to internal tag Cfg_AckReqd of the corresponding P_Alarm object.


Cfg_FullStallSeverity SINT 4 These parameters determine the severity of each alarm. This drives the color and symbol that are used to
indicate alarm status on the faceplate and global object.
Cfg_TransitStallSeverity 4 These parameters are aliased to internal tag.Cfg_Severity of the associated P_Alarm object. The
Cfg_IntlkTripSeverity 2 following are valid values:
1 = Low
Cfg_IOFaultSeverity 4 2 = Medium
3 = High
4 = Highest
IMPORTANT: These severity parameters drive 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.
Cfg_SimFdbkT DINT 2 Delay (in seconds) to echo back open/closed status when in simulation or when position feedbacks are
not being used.
Cfg_FullStallT DINT 5 After command, time with no motion before fault (seconds).
Cfg_TransitStallT DINT 10 After command, time to reach position before fault (seconds).
PSet_Owner DINT 0 Program Owner Request ID (non-zero) or release (zero).
PCmd_Open BOOL 0 Program command to open or close valve.
PCmd_Close
PCmd_Acq BOOL 0 Program command to acquire ownership (operator to program).
This parameter is aliased to internal tag Mode.PCmd_Acq of P_Mode.
This parameter is reset automatically, 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.
PCmd_Lock BOOL 0 Program command to Lock mode in program.
This parameter is aliased to internal tag Mode.PCmd_Lock of P_Mode.
PCmd_Unlock BOOL 0 Program command to Unlock mode.
This parameter is aliased to internal tag Mode.PCmd_Unlock of P_Mode.
PCmd_Reset BOOL 0 Program command to reset all alarms requiring reset.
PCmd_FullStallAck BOOL 0 Program command to acknowledge alarms.
These parameters are aliased to internal tag .PCmd_Ack of associated P_Alarm.
PCmd_TransitStallAck
These parameters are reset automatically, when Cfg_PCmdClear is 1.
PCmd_IntlkTripAck
PCmd_IOFaultAck
PCmd_FullStallSuppress BOOL 0 Program commands to suppress alarm.
These parameters are aliased to internal tag of the embedded P_Alarm instruction. For example,
PCmd_TransitStallSuppress PCmd_FullStallSuppress is aliased to FullStall.PCmd_Suppress.
PCmd_IntlkTripSuppress These parameters are reset automatically, when Cfg_PCmdClear is 1.
PCmd_IOFaultSuppress
PCmd_FullStallUnsuppress BOOL 0 Program commands to unsuppress alarm.
PCmd_TransitStallUnsuppress PCmd_FullStallUnsuppress is aliased to FullStall.PCmd_Unsuppress.
PCmd_IntlkTripUnsuppress These parameters are reset automatically, when Cfg_PCmdClear is 1.
PCmd_IOFaultUnsuppress


PCmd_FullStallUnshelve BOOL Program commands to unshelve alarm.
PCmd_TransitStallUnshelve PCmd_FullStallUnshelve is aliased to FullStall.PCmd_Unshelve.
PCmd_IntlkTripUnshelve These parameters are reset automatically, when Cfg_PCmdClear is 1.
PCmd_IOFaultUnshelve
OCmd_Open BOOL 0 Operator command to open or close valve.
OCmd_Close
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 (de-energize) Valve.
MCmd_Enable BOOL 0 Maintenance command to enable (allow to energize) Valve.
OCmd_AcqLock BOOL 0 Operator command to acquire or lock in Operator mode, unlock or release Operator mode, reset all
alarms requiring reset, or reset all alarms and latched shed conditions.
OCmd_UnlockRel
OCmd_Reset
OCmd_ResetAckAll
Solenoid-operated Valve 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 also can be used by other application logic or
software packages.
• Status data elements (Sts_) are bit outputs of the instruction for use by the
HMI. Status bits also can be used by other application logic.
• Ready data elements (Rdy_) are bit outputs of the instruction used by
the HMI to enable or disable Command buttons and Setting entry
fields.
Table 4 - P_ValveSO Output Parameters
Output Parameter Data Type Description
EnableOut BOOL Enable Output: The EnableOut signal is not manipulated by this instruction. Its output state always reflects
EnableIn input state.
Out BOOL 1 = Energize Valve Solenoid.
Val_Cmd SINT This shows the command being processed, returns to zero once the command succeeds or fails. These values are also
used for Inp_OvrdCmd:
0 = None
1 = Close
2 = Open
Val_Fdbk SINT This shows the interpreted feedback input from the device:
0 = Moving
1 = Closed
2 = Opened
3 = Limit Switch Failure


Val_Sts SINT This is the Primary Status, used to show the operator the ‘confirmed’ device status:
0 = Unknown
1 = Closed
2 = Opened
5 = Closing
6 = Opening
33 = Disabled
Val_Fault SINT This is the Device Fault Status, used to show the operator the most severe device fault:
0 = None
16 = Transit Stall
17 = Full Stall
32 = I/O Fault
34 = Configuration Error
Val_Mode DINT This shows the current device mode:
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 = Highest (acknowledged)
9 = Highest (unacknowledged)
Sts_Closed BOOL 1 = Valve requested to close and is confirmed closed.
Sts_Opening BOOL 1 = Valve requested to open and awaiting open feedback.
Sts_Opened BOOL 1 = Valve requested to open and is confirmed opened.
Sts_Closing BOOL 1 = Valve requested to close and awaiting closed feedback.
Sts_Available BOOL 1 = Valve available for control by automation (Program mode and ready to operate).
Sts_Bypass BOOL 1 = Bypassable interlocks and permissives are bypassed.
Sts_BypActive BOOL 1 = Bypassing Active (Bypassed or Maintenance).
Sts_Disabled BOOL 1 = Valve is disabled and is being held de-energized.
Sts_LSFail BOOL 1 = Limit Switch Overlap failure.
Sts_NotRdy BOOL 1 = Valve is Not Ready to Energize (independent of mode).
Sts_MaintByp BOOL 1 = A Maintenance bypass is active, display icon.
Sts_AlmInh BOOL 1 = An Alarm is shelved, disabled, or suppressed, display icon.
Sts_Err BOOL 1 = Error in Config: See detail bits for reason.
Err_Timer BOOL 1 = Error in Config: Invalid Check Time (use 0…2,147,483).


Err_Sim BOOL 1 = Error in Config: Invalid Simulation Time (use 0…2,147,483).
Err_Alarm BOOL 1 = Error in Config: Invalid Alarm Delay or Severity.
Sts_Hand BOOL 1 = Mode is Hand (supersedes Maintenance, Override, Program, Operator), Maintenance (supersedes Override,
Program, Operator), Override (supersedes Program, Operator), Program (auto), or Operator (manual).
Sts_Maint
Sts_Ovrd
Sts_Prog
Sts_Oper
Sts_ProgOperLock BOOL 1 = Program or Operator has requested Mode Lock.
Sts_NoMode BOOL 1 = No Mode (Disabled because EnableIn is false).
Sts_FullStall BOOL 1 = Valve Full Stall (failed to move at all).
Sts_TransitStall BOOL 1 = Valve Transit Stall (did not reach target position).
Sts_IntlkTrip BOOL 1 = Valve de-energized by an Interlock Not OK.
Sts_IOFault BOOL I/O Comm Fault Status:
0 = OK
1 = Bad
Alm_FullStall BOOL 1 = Valve Full Stall (failed to move at all) alarm.
Alm_TransitStall 1 = Valve Transit Stall (did not reach target position) alarm.
Alm_IntlkTrip 1 = Alarm: Valve de-energized by an Interlock Not OK.
Alm_IOFault 1 = I/O Fault alarm.
Ack_FullStall BOOL 1 = Full Stall, Transit Stall, Interlock Trip, or I/O Fault alarm acknowledged.
Ack_TransitStall
Ack_IntlkTrip
Ack_IOFault
Sts_FullStallDisabled BOOL 1 = Full Stall, Transit Stall, Interlock Trip, or I/O Fault alarm disabled (by Maintenance).
Sts_TransitStallDisabled
Sts_IntlkTripDisabled
Sts_IOFaultDisabled
Sts_FullStallShelved BOOL 1 = Full Stall, Transit Stall, Interlock Trip, or I/O Fault alarm shelved by Operator.
Sts_TransitStallShelved
Sts_IntlkTripShelved
Sts_IOFaultShelved
Sts_FullStallSuppressed BOOL 1 = Full Stall, Transit Stall, Interlock Trip, or I/O Fault alarm suppressed (by Program).
Sts_TransitStallSuppressed
Sts_IntlkTripSuppressed
Sts_IOFaultSuppressed
Rdy_Open BOOL 1 = Ready to receive OCmd (Open, Close, Bypass, or Check) (enables HMI button).
Rdy_Close
Rdy_Bypass
Rdy_Check


Rdy_Disable BOOL 1 = Ready to receive MCmd (Disable or Enable) (enables HMI button).
Rdy_Enable
Rdy_Reset BOOL 1 = Ready for OCmd (Reset or ResetAckAll) (enables HMI button).
Rdy_ResetAckAll
P_ValveSO BOOL Unique Parameters Name for auto-discovery.
Solenoid-operated Valve Local Configuration Tags

Configuration parameters that are array, string, or structure data types cannot be
configured as parameters for Add-On Instructions. Configuration parameters of
these types appear as local tags to the Add-On Instruction. Local tags can be
configured through the HMI faceplates or in RSLogix 5000 software by opening
the Instruction Logic of the Add-On Instruction instance and then opening the
Data Monitor on a local tag. These parameters cannot be modified by using
controller logic or RSLogix 5000 software export/import functionality.
Table 5 - P_ValveSO Input Local Configuration Tags

Tag Name Data Type Default Description
Cfg_Desc STRING_40 'Solenoid Operated Description for display on HMI. The string shows in the title bar of the faceplate.
Valve'
Cfg_Label STRING_20 ’Valve Control’ Label for graphic symbol displayed on HMI. This string appears on the graphic symbol.
Cfg_Tag STRING_20 ’P_ValveSO’ Tagname for display on HMI. This string shows in the bottom right of the home tab of the faceplate.

Operations This section describes the primary operations for Add-On Instructions.
Modes
The P_ValveSO Add-On Instruction uses the following standard modes,
implemented by using an embedded P_Mode Add-On Instruction.
Mode Description
Operator Control of the device is owned by the Operator. Operator Commands (OCmd_) and
Operator Settings (OSet_) from the HMI are accepted.
Program Control of the device is owned by Program logic. Program Commands (PCmd_) and
Program Settings (PSet_) are accepted.
Override Control of the device is owned by priority logic, superseding Operator and Program
control. Override commands (Inp_OvrdCmd) are accepted. If so configured, bypassable
interlocks and permissives are bypassed.
Maintenance Control of the device is owned by Maintenance. Operator Commands and Settings from
the HMI are accepted. Bypassable interlocks and permissives are bypassed, and device
timeout checks are not processed.
Hand Control of the device is owned by hardwired logic or other logic outside the instruction.
The instruction tracks the state of the device for bumpless transfer back to one of the
other modes.
No mode The device is disabled and has no owner because the EnableIn input is false. The main
instruction Logic routine is not being scanned. See Execution on page 20 for more
information on EnableInFalse processing.
Refer to the PlantPAx Library of Process Objects: Common Mode Block

(P_Mode) Reference Manual, publication SYSLIB-RM005, for more
information.
Alarms
The following Alarms, implemented by using the P_Alarm Add-On Instruction,

are used by the Solenoid Valve Add-On Instruction.
Alarm Alarm Name Description

Full Stall FullStall Raised if the Valve has and is using Open and/or Closed feedback, an attempt
is made to open or close the valve, and the valve position feedback indicates
the valve did not move off its previous position at all during the configured
time.
Transit Stall TransitStall Raised if the Valve has and is using Open and Closed feedback, an attempt is
made to open or close the valve, and the valve position feedback indicates the
valve moved from its original position but did not reach its target position
within the configured time.
I/O Fault IOFault Raised if the Inp_IOFault input is true.
Interlock Trip IntlkTrip Raised if the Solenoid Valve is energized and an Interlock causes it to de-
energize. If Interlocks are not bypassed, a Non-bypassable interlock not OK or
a Bypassable Interlock not OK de-energizes the Solenoid Valve. If Interlocks
are bypassed, only a Non-bypassable interlock not OK de-energizes the
Solenoid Valve.

The Full Stall and Transit Stall Alarms have a configurable delay to allow the
Open and/or Closed feedback time to align with the commanded output (time
for the Solenoid Valve to actually Open or Close).
Refer to the PlantPAx Library of Process Objects: Common Alarm Block

(P_Alarm) Reference Manual, publication SYSLIB-RM002, for more
information.
Execution
The following table explains the handling of instruction execution conditions.
Condition Description
EnableIn False (false rung) Processing for EnableIn False (False Rung) is handled the
same as if the Solenoid Valve were Disabled by Command.
The Solenoid Valve output is de-energized and the
Solenoid Valve is shown as Disabled on the HMI.
Powerup (pre-scan, first scan) Processing of Modes and Alarms on Prescan and Powerup
is handled by the embedded P_Mode and P_Alarm Add-
On Instructions - refer to their manuals for details.
On Powerup, the Solenoid Valve is treated as if it had been
commanded to its de-energized position.
Postscan (SFC transition) No SFC Postscan logic is provided.
Refer to the Logix5000 Controllers Add-On Instructions Programming Manual,

publication 1756-PM010, for more information.

Display Elements A display element (global object) is created once and can be referenced multiple
times on multiple displays in an application. When changes are made to the
original (base) object, the instantiated copies (reference objects) are
automatically updated. Use of global objects, in conjunction with tag structures
in the ControlLogix system, aid consistency and save engineering time.
Display Element Name Display Element Description
P_ValveSO Standard solenoid-operated valve global objects.
P_ValveSO2
P_ValveSO1
P_ValveSO3
Common attributes of the Solenoid Valve Graphic Symbols include the

following:
• Graphical representation of the valve
• Current state of the valve in text
• Status / quality indicator
• Mode indicator
• Label
• Alarm indicator that changes color for the severity of the alarm
• Color changing alarm border that blinks on unacknowledged alarm
• Maintenance bypass indicator
Alarm Border State Indicator
Status/Quality Mode Indicator

Indicator
Status/Quality
Indicator
Alarm Indicator
Label
Maintenance Bypass
Indicator

Each Graphic Symbol includes a touch field over it that opens the object’s
faceplate. In addition, there is a tooltip on the graphic symbol that displays the
object’s configured Tag and Description.
State Indicators
The state indicator text changes and the graphic symbol color changes depending
on the state of the valve.
Table 6 - Valve State Colors

Color State Text
White Transition: Closing or Opening
Dark Gray De-energized
(Closed if Fail Closed, Opened if Fail Open)
White Energized
(Opened if Fail Closed, Closed if Fail Open)
The Valve Actuator symbol also changes color depending on the state of
the valve.
Table 7 - Valve Actuator Colors

Color State Text
White Transition: Closing or Opening
Dark Gray De-energized
(Closed if Fail Closed, Opened if Fail Open)
White Energized
(Opened if Fail Closed, Closed if Fail Open)

Status/Quality Indicators
One or more of these symbols appears on the graphic symbol when the described
condition is true.
Graphic Symbol Description

Invalid Configuration.
I/O Fault (status is ‘stale’).
The device is not ready to operate.
No symbol displayed I/O quality good and Configuration valid.
TIP When the Invalid Configuration Indicator appears, you can find what
configuration setting is invalid by following the indicators. Click the Graphic
Symbol to open the Faceplate. The Invalid Configuration indicator appears next
to the appropriate tab at the top of the Faceplate to guide you in finding the
configuration error. Once you navigate to the tab, the misconfigured item is
flagged with this indicator or appears in a magenta box.
For the Solenoid Valve instruction, the Invalid Configuration Indicator appears
under the following conditions:
• The Full Stall check time (time with no motion) or Transit Stall check
time (time to reach final position) is set to a value less than zero or greater
than 2,147,483 seconds.
• The feedback Simulation time is set to a value less than zero or greater than
2,147,483 seconds.
• An Alarm Severity is set to a value other than 1 (low), 2 (medium),
3 (high), or 4 (highest).
Maintenance Bypass Indicator
This symbol appears to the right of the label to indicate that a Maintenance
bypass has been activated.
A Maintenance bypass is active.
No symbol displayed No Maintenance bypass active.
TIP When the Maintenance Bypass Indicator appears, you can find what condition
was bypassed by following the indicators like a ‘trail of breadcrumbs’. Click the
Graphic Symbol to open the Faceplate. The Maintenance Bypass Indicator
appears next to the appropriate tab at the top of the Faceplate to guide you in
finding the bypass. Once you navigate to the tab, the bypassed item is flagged
with this indicator.

For the Solenoid Valve instruction, the Maintenance Bypass Indicator appears
under the following conditions:
• Bypassable Interlocks and Permissives have been bypassed.
• The valve is configured to have an Open Limit Switch (on the Engineering
tab of the Faceplate), but the Open Limit Switch is not being used
(selection on the Maintenance tab of the Faceplate).
• The valve is configured to have a Closed Limit Switch, but the Closed
Limit Switch is not being used.
Mode Indicators
One of these symbols appears to the right of the graphic symbol to indicate the
Mode of the Solenoid Valve instruction.

Transparent Operator Mode (if the default mode is Operator and in Operator mode, the mode indicator
is transparent)
Operator Mode (if the default mode is Program)
Operator Mode locked
Transparent Program Mode (if the default mode is Program and in Program mode, the mode indicator is
transparent)
Program Mode (if the default mode is Operator)
Program Mode locked
Override Mode
Maintenance Mode
Hand Mode
No Mode
The valve has been disabled.
When the object is in Default mode, the mode indicator is transparent.
Refer to the PlantPAx Library of Process Objects: Common Mode Block

(P_Mode) Reference Manual, publication SYSLIB-RM005, for more
information.

Alarm Indicators
One of these symbols appears to the left of the label to indicate the described
alarm condition. The alarm border and label background blink if
acknowledgement of an alarm condition is required.
Symbol Border and Label Background Description
No change in color Alarm Inhibit: an alarm is suppressed by the Program,
disabled by Maintenance, or shelved by the Operator.
White Return to normal (no alarm condition), but a previous

alarm has not been acknowledged.
Blue Low severity alarm.
Yellow Medium severity alarm.
Red High severity alarm.
Magenta Highest severity alarm.
No symbol No change in color No alarm or alarm inhibit condition, and all alarms
are acknowledged.
Refer to the PlantPAx Library of Process Objects: Common Alarm Block

information.

Use Global Objects
The graphic symbol for P_ValveSO can be found in the global object file
(RA-BAS) Process Graphics Library.ggfx.
1. Copy the global object from the global object file and paste it in the
display file.
2. In the display, right-click the global object and choose Global Object
Parameter Values.
The Global Object Parameter Values dialog box appears.

The global object parameters are as follows.
Parameter Required Description

#102 Y Object tag to point to the name of the associated object Add-On Instruction
in the controller.
#103 Y Path used for display navigation features to other objects. Include program
scope if tag is a program scope tag.
#120 N Additional parameter to pass to the display command to open the faceplate.
Typically used to define position for the faceplate.
#121 N Additional parameter to pass to the display command to open the faceplate.
if defining X and Y coordinate, separate parameters so that X is defined by
#120 and Y is defined by #121. This lets the same parameters be used in
subsequent display commands originating from the faceplate.
#122 Y These are the options for the global object display:
0 = Always show faceplate
1 = Show Quick Display for users without Maintenance access (Code C)
2 = Always show Quick Display
3. Type the tag in the Value column as specified in the Description column.
TIP Click the ellipsis (. . .) to browse and choose a tag.

Values for items marked ‘(optional)’ can be left blank.
4. Click OK.
Quick Display
The Quick Display screen provides the means for operators to perform simple
interactions with the P_ValveSO instruction instance. From the Quick Display,
you can navigate to the faceplate for full access for operation, maintenance, and
configuration.
Navigate to Full
Faceplate Button

Faceplate The P_ValveSO faceplate consists of four tabbed pages. The Operator tab is
displayed when the faceplate is initially opened. Choose the appropriate icon at
the top of the faceplate to access a specific tab.
Maintenance Alarms Exit
Operator Engineering Help
The faceplate provides the means for operators, maintenance personnel,

engineers, and others to interact with the P_ValveSO instruction instance,
including viewing its status and values and manipulating it through its commands
and settings. When a given input is restricted via FactoryTalk View security, the
required user security code letter is shown in the tables that follow.

Operator Tab
The Operator tab has buttons to open and close the valve when it is in the proper
mode and shows the following information:
• Current mode (Operator, Program, Override, Maintenance, or Hand)
• Requested modes Indicator (appears if the Operator or Program Mode has
been superseded by another mode) Refer to the Maintenance Tab on
page 33 for more information.
• Solenoid Valve State (Closing, Closed, Opening, Opened, Disabled, or I/
O Fault)
• Limit Switch Fault (appears over the Valve State when the fault is active)
• Interlock and Permissive States
• Communication Status (Comm or I/O Fault)
Mode Indicator Reset and Acknowledge

All Alarms Command
Operator Mode
Command Buttons
Valve State Valve Open and Close

Indicator Command Buttons
Interlock and Permissive

Valve Statistics Indicators and
Navigation Button Navigation Buttons
Communication Status
Indicator

The following table lists the functions on the Operator tab.
Table 8 - Operator Tab Descriptions

Button Action Security
Click to release Operator Mode Lock. Manual Device Operation (Code B)
Click to acquire from Program and lock in

Operator Mode.
Click to request Program mode.
Click to request Operator mode.
Click to reset and acknowledge all alarms. Acknowledge Alarms (Code F)
Click to open solenoid valve. Normal Operation of Devices (Code A)

Available in Operator or Maintenance Mode.
Click to close solenoid valve.
Click to open Interlocks faceplate. N/A
Click to open Permissives faceplate.
Click to open Valve Statistics faceplate.

.

If the object is configured to have permissive and interlock objects (for example,
Cfg_HasIntlkObj is true), the permissive and interlock indication become
buttons that open the faceplates of the source objects used as a permissive or
interlock (often this is a P_Intlk permissive object). If the object is not configured
in this way, the permissive or interlock are indicators only.
The Operator tab also has a button to open the Valve Statistics faceplate if the
valve is configured to use the P_ValveStats object (Cfg_HasValveStats = 1).
When the object is not configured to have an P_ValveStats instruction, the Valve
Statistics button is not displayed.
Refer to these publication for more information:

• PlantPAx Library of Process Objects: Permissives with Bypass (P_Perm)
Reference Manual, publication SYSLIB-RM007
• PlantPAx Library of Process Objects: Interlock with First Out and Bypass
(P_Intlk) Reference Manual, publication SYSLIB-RM004
• PlantPAx Library of Process Objects: 2-state Valve Statistics
(P_ValveStats) Reference Manual, publication SYSLIB-RM036.
Alarm indicators appear on the Operator tab when the corresponding alarm
occurs.
Table 9 - Alarm State Indicator Locations

Alarm State Location
Full Stall (valve failed to move) Below the valve state
Transit Stall (valve failed to reach target position) Below the valve state
Interlock trip To the right of the interlock indicator
I/O Fault To the right of the communication status
One of these symbols appears to indicate the described alarm condition. The
alarm bell symbol blinks if acknowledgement of an alarm condition is required.
Table 10 - Alarm Status Symbols

Graphic Symbol Alarm Status
In Alarm (Active Alarm)
In Alarm and Acknowledged
Out of Alarm but Not Acknowledged
Alarm Suppressed (by Operator) (Alarm is logged but not

displayed)
Alarm Disabled (by Maintenance)
Alarm shelved (disabled by Program Logic)

When the P_ValveSO instruction does not have associated Permissive (P_Perm)
or Interlock (P_Intlk) instructions, the Permissive and Interlock buttons revert to
indicators.
When the P_ValveSO instruction does not have an associated Valve Statistics
(P_ValveStats) instruction, the Valve Statistics button is not shown.
Permissives Indicator
Interlock Indicator

Maintenance Tab
The Maintenance tab shows the following information:

• Current mode (Operator, Program, 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.
The mode flagged with a triangle in the corner is the default mode.
• Whether Solenoid Valve is enabled or disabled.
• Interlock and Permissive Bypassed/Enabled Indicator.
• Whether Override Mode bypasses the bypassable interlocks and
permissives.
• Whether the valve’s Limit Switch Feedback is checked when opening or
closing the valve.
Maintenance Mode
Mode Indicator
Acquire and Release
Requested Modes Command Buttons
Indicator
Valve Enable and
Valve Disabled Disable Command
Indicator Buttons
Interlocks and Interlock and

Permissives Permissive Indicators
Bypassed Indicator and Navigation Buttons

The following table lists the functions on the Maintenance tab.
Table 11 - Maintenance Tab Descriptions

Function Action Security Configuration Parameters
Click to release valve from Maintenance Mode. Equipment None
Maintenance
(Code C)
Click to place valve in Maintenance Mode.
Click to enable valve.
Click to disable valve.
Click to enable checking of all interlocks and Disable

permissives. Alarms
Bypass
Permissives
Click to bypass checking of bypassable and
interlocks and permissives. Interlocks
(Code H)
In Override mode, Check this checkbox to bypass bypassable

bypass Interlocks interlocks and permissives in Override Mode.
and Permissives
that can be
bypassed
Time after Enter the amount of time to allow for the valve Configuration Cfg_FullStallT
command with no to move off the current position’s limit before and Tuning
motion before raising a Full Stall alarm. Maintenance
fault (seconds) (Code D)
Time after Enter the amount of time to allow for Cfg_TransitStallT
command to reach completing valve travel before raising a Transit
position before Stall alarm.
fault (seconds)
Use Valve Closed Check this checkbox if the instruction uses the Equipment Cfg_UseClosedLS
limit switch for closed limit switch feedback to check for valve Maintenance
failure checking full stall or transit stall. (Code C)
Use Valve Open Check this checkbox if the instruction uses the Cfg_UseOpenLS
limit switch for open limit switch feedback to check for valve
failure checking full stall or transit stall.

Engineering Tab
The Engineering tab is divided into two pages.
Engineering Tab Page 1
Mode Configuration
Button
Configure Valve
Description, Label,
and Tag
The following table lists the functions on page 1 of the Engineering Page tab.
Table 12 - Engineering Tab Page 1 Descriptions

Click to navigate to the Mode Configuration Engineering See Mode Configuration
message box. Configuration Message Box on page 36.
(Code E)
Description Enter a Description of the valve that will Cfg_Desc

appear in the title bar of the faceplate.
Label Enter a Label for the valve that will appear on Cfg_Label
the graphic symbol.
Tag Enter a Tag for the valve that will appear in the Cfg_Tag
bottom right of the home tab of the faceplate.
Valve has Closed Check this checkbox if the valve has a Closed Cfg_HasClosedLS
Limit Switch signal Limit Switch wired to Inp_ClosedLS.


Valve has Open Check this checkbox if the valve has an Open Engineering Cfg_HasOpenLS
Limit Switch signal Limit Switch wired to Inp_OpenLS. Configuration
(Code E)
Fault when both Click ON if both limit switches are OFF when Cfg_LSFail
limit switches are the valve is in motion.
ON/OFF Click OFF if both limit switches are ON when
the valve is in motion. This selection
determines how the instruction detects a
stuck limit switch.
Clear Program Check this checkbox to clear Program Cfg_PCmdClear
Commands on Commands on receipt.
Receipt
Operator Check this checkbox to allow an Operator Open Cfg_OCmdResets
command resets or Close command to reset any previous faults
fault (I/O Fault, Transit Stall, Full Stall, Interlock
Trip), then open or close the valve.
Clear this checkbox to reset faults by using the
Reset command.
Fail Open Check this checkbox if the valve fails Open for Cfg_FailOpen
(energize to close) energize-to-close operation
Clear the checkbox if the valve fails Closed for
energize-to-open operation.
Mode Configuration Message Box
This message box lets the user you to choose the Default mode for the object by
clicking a radio button. The radio buttons require security code E.

Engineering Tab Page 2
The following table lists the functions on page 2 of the Engineering tab.

Enable navigation Check this checkbox if a permissive object is Engineering Cfg_HasPermObj
to Permissive connected to the Permissive input. This Configuration
object changes the Permissive indicator to a clickable (Code E)
button.
IMPORTANT: The name of the Permissive
object in the controller must be this object's
name with the suffix ‘_Perm’. For example, if
your P_MotorSO object has the name
’MotorSO123’, then its Permissive object must
be named ‘MotorSO123_Perm’.
Enable navigation Check this checkbox if an interlock object is Cfg_HasIntlkObj
to Interlock object connected to the Interlock input. This changes
the Interlock indicator to a clickable button.
IMPORTANT: The name of the Interlock
name with the suffix ‘_Intlk’. For example, if
your P_ValveSO object has the
name’ValveSO123’, then its Interlock object
must be named ‘ValveSO123_Intlk’.


Enable navigation Check this checkbox if a Valve Stats object is Engineering Cfg_HasStatsObj
to Valve Statistics used with this valve. This makes the Valve Configuration
object Statistics button visible. (Code E)
IMPORTANT: The name of the Valve Stats
name with the suffix ‘_ValveStats’. For
example, if your P_ValveSO object has the
name’ValveSO123’, then its Valve Stats object
must be named ‘ValveSO123_ValveStats’
Deengerize Valve Check this checkbox to deenergize the output Cfg_ShedOnIOFault
on I/O Fault to the valve, returning it to its fail position,
when an I/O Fault condition occurs.
Clear this checkbox to keep the output to the
valve in its current state on an I/O Fault
condition.
IMPORTANT: When this checkbox is checked
and an I/O Fault condition occurs, a Reset is
required before the valve can be energized.
Deengerize Valve Check this checkbox to deenergize the output Cfg_ShedOnTransitStall
on Transit Stall to the valve, attempting to return it to its fail
position, when a Transit Stall conditions
occurs.
valve in its current state (keep trying) on a
Transit Stall condition. (A Transit Stall means
the valve, when commanded to move, moved
off its original position, but did not reach its
commanded position before the Transit Stall
time expired.)
and a Transit Stall condition occurs, a Reset is
Deengerize Valve Check this checkbox to deenergize the output Cfg_ShedOnFullStall
on Full Stall to the valve, attempting to return it to its fail
position, when a Full Stall conditions occurs.
valve in its current state (keep trying) on a Full
Stall condition. (A Full Stall means the valve,
when commanded to move, did not move off
its original position before the Full Stall time
expired.)
and a Full Stall condition occurs, a Reset is
Deengerize Valve The valve outputs are always deenergized on None
on Interlock Trip an Interlock Trip. This item cannot be
unchecked. It is displayed as a reminder that
the Interlock Trip function always deenergizes
the valve.
Feedback delay in Sets the time delay (in seconds) for the Cfg_SimFdbkT
Simulation opened or closed status to be echoed back
(seconds) when Simulation is enabled or when limit
switch feedback is not used.

Alarms Tab
The Alarms tab displays each configured alarm for the P_ValveSO instruction.
The icon on the tab for the alarms page changes color based on the current active
alarms. A blinking alarm icon indicates that one or more alarms must be
acknowledged or the device must be reset.
Alarm Acknowledge
Command Button
Alarm Severity Indicator
Alarm Name
Reset and Acknowledge

All Alarms Command
Button
Clicking on the alarm opens the P_Alarm faceplate for that alarm. From the
P_Alarm faceplate, you can configure and perform additional operations on
the alarm.
If an alarm is active, the panel behind the alarm changes color to match the
severity of the alarm. The color of the bell icon at the top of the faceplate shows
the highest active alarm’s severity, and the icon blinks if any alarm is
unacknowledged or requires reset.

The following table shows the colors associated with alarm severity.
Table 14 - Alarm Color Definitions

Color Definition
Magenta Highest
Red High
Yellow Medium
Blue Low
White (bell icon) All alarms have cleared, but one or more alarms are
unacknowledged
Background (light gray) No alarm
The following table shows the functions on the Alarms tab.
Table 15 - Alarms Tab Descriptions

Button Action Security
Click to acknowledge the alarm. Acknowledge Alarms (Code F)
Click to reset and acknowledge all alarms.
Alarm Name Click an alarm name to display the Alarm

Operator faceplate.
Refer to the PlantPAx Library of Process
Objects: Common Alarm Block (P_Alarm)
Reference Manual, publication
SYSLIB-RM002, for more information.
The Reset and Acknowledge All Alarms button is enabled and the panel behind
the alarm blinks and the Alarm Acknowledge button is enabled if the alarm
requires acknowledgment. Click the button with the checkmark to acknowledge
the alarm.
Refer to the PlantPAx Library of Process Objects: Common Alarm Mode

information.

Solenoid-operated Valve Faceplate Help
The Faceplate Help is divided into two pages.
Faceplate Help Page 1

Faceplate Help Page 2

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 and application notes, sample code, and links to
software service packs. You can also visit our Support Center at https://rockwellautomation.custhelp.com/ for software
updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.
In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more
information, contact your local distributor or Rockwell Automation representative, or visit
http://www.rockwellautomation.com/services/online-phone.
Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this
manual. You can contact Customer Support for initial help in getting your product up and running.
United States or Canada 1.440.646.3434
Outside United States or Canada Use the Worldwide Locator at http://www.rockwellautomation.com/rockwellautomation/support/overview.page, or contact your local
Rockwell Automation representative.
New Product Satisfaction Return
Rockwell Automation tests all of its products to help ensure that they are fully operational when shipped from the
manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.
United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your
distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.
Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400
Publication SYSLIB-RM015D-EN-E - August 2013

Supersedes Publication SYSLIB-RM015C-EN-E - October 2011 Copyright © 2013 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.

Plantpax Library of Process Objects: Solenoid-Operated Valve (P - Valveso)

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Plantpax Library of Process Objects: Solenoid-Operated Valve (P - Valveso)

Uploaded by

Copyright:

Available Formats

Reference Manual

PlantPAx Library of Process Objects:

Labels may also be on or inside the equipment to provide specific precautions.

Preface Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Solenoid-operated Valve Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 3

4 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

This document applies to version 3.0 of the PlantPAx™ Library of Process

The Process Objects can be downloaded from Knowledgebase Answer ID 62682

For general library considerations, see PlantPAx Library of Process Objects,

Table 1 - Additional Resources

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 5

Table 1 - Additional Resources

You can view or download publications at

6 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

The P_ValveSO (Solenoid-operated Valve) Add-On Instruction is used to

Do not use this instruction in these situations:

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 7

The P_ValveSO provides the following capabilities:

8 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

• In Override mode, provide an Override State input that determines

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 9

The P_ValveSO_3_0-00_AOI.L5X Add-On instruction must be imported into

10 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Table 2 - P_ValveSO Visualization File Types

Optional Template Files

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 11

Solenoid-operated Valve Input Structure

12 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Table 3 - P_ValveSO Input Parameters

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 13

Table 3 - P_ValveSO Input Parameters

14 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Table 3 - P_ValveSO Input Parameters

Solenoid-operated Valve Output Structure

Output parameters include the following:

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 15

Table 4 - P_ValveSO Output Parameters

16 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Table 4 - P_ValveSO Output Parameters

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 17

Table 4 - P_ValveSO Output Parameters

Solenoid-operated Valve Local Configuration Tags

Table 5 - P_ValveSO Input Local Configuration Tags

18 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Refer to the PlantPAx Library of Process Objects: Common Mode Block

The following Alarms, implemented by using the P_Alarm Add-On Instruction,

Alarm Alarm Name Description

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 19

Refer to the PlantPAx Library of Process Objects: Common Alarm Block

Refer to the Logix5000 Controllers Add-On Instructions Programming Manual,

20 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Common attributes of the Solenoid Valve Graphic Symbols include the

Alarm Border State Indicator

Status/Quality Mode Indicator

Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013 21

Table 6 - Valve State Colors

Table 7 - Valve Actuator Colors

22 Rockwell Automation Publication SYSLIB-RM015D-EN-E - August 2013

Graphic Symbol Description

I/O Fault (status is ‘stale’).

The device is not ready to operate.

No symbol displayed I/O quality good and Configuration valid.