Process Mix Proof Valve (PVLVMP)

This information applies to the CompactLogix 5380P and ControlLogix 5580P controllers.
The Process Mix Proof Valve (PVLVMP) instruction controls and monitors feedback from a mix-proof valve in various modes and states, monitoring for fault conditions. This instruction supports mix-proof valves with or without additional connections for cleaning (CIP, clean-in-place) or steaming (SIP, sanitize in place).
Use the PVLVMP instruction to:
  • Operate a mix-proof valve with these positions:
    • Closed
    • Opened
    • CIP/SIP leakage cavity (optional)
  • Operate a mix-proof valve with these positions, which can pulse the seat being cleaned, or lifted opened and closed, to provide enhanced cleaning. (As the seat is popped open and closed, the flow velocity across the seat is increased compared to the fully open seat position.) Pulse times are configurable.
    • Lift upper seat (optional)
    • Lift lower seat (optional)
    • CIP/SIP upper seat (optional)
    • CIP/SIP lower seat (optional)eve
  • Operate using a state model that makes sure that valve seats are sequenced properly to avoid cross-contamination.
  • Provide six outputs and six inputs. The outputs in each valve state (including intermediate states) are configurable for on and off states. The inputs that verify each valve state are configurable for their required on, required off, and don't care states. Provides feedback checking to make sure that the valve reaches each position, including intermediate positions before moving to the next position. The time for feedback inputs to confirm each state is configurable.
  • Display graphic symbols for mix-proof valves in 2-D layouts and 3-D (isometric) layouts for ease in building valve array and routing manifold displays.
  • Allow maintenance personnel to take the valve out of service. Note that this capability is not a substitute for hard lockout/tagout (LOTO) procedures.
  • Provide inputs for Interlock conditions to drive the valve to the closed state.
  • Monitor for I/O communication faults, and close the valve and raise an alarm on a fault.
  • Provide an available status for Program command source logic so automation code can determine whether a valve can be controlled.
  • Provide a valve virtualization capability. When the mix-proof valve is set to virtual, outputs are left de-energized, and the instruction behaves as if a fully functioning valve were providing feedback.
  • Operate from Hand, Maintenance, Override, External, Program, and Operator command sources.
  • Provide a maintenance command to toggle a locator or beacon output.
Available Languages
Ladder Diagram
PVLVMP_avail_ladder_v35
Function Block Diagram
PVLVMP_avail_FBD_v35
Structured Text
PVLVMP(PVLVMPTag, BusObj);
Operands
IMPORTANT:
Unexpected operation may occur if:
  • Output tag operands are overwritten.
  • Members of a structure operand are overwritten.
  • Except when specified, structure operands are shared by multiple instructions.
There are data conversion rules for mixing numeric data types within an instruction. See Data conversions.
Configuration Operands
Operand
Type
Format
Description
PlantPAx Control
P_DISCRETE_MIX_PROOF
tag
Data structure required for proper operation of instruction.
BusObj
BUS_OBJ
tag
Bus component.
P_DISCRETE_MIX_PROOF Structure
Public members are standard, visible tag members that are programmatically accessible. Private, hidden members are used in HMI faceplates and are not programmatically accessible. Private members are listed in separate tables after public members.
Public Input Members
Data Type
FBD Default Visibility
FBD Wiring required
Usage
Description
EnableIn
BOOL
Not Visible
Not Required
Input
Enable Input - System Defined Parameter
Default is true.
Inp_InitializeReq
BOOL
Not Visible
Not Required
Input
1 = Request to initialize the instruction. The instruction is normally initialized in instruction first run. Use this request when reinitialization is needed. The instruction clears this operand automatically.
Default is true.
Inp_OwnerCmd
DINT
Not Visible
Not Required
Input
Owner device command (bitmapped): All bits off = None, .10 = Operator Lock, .11 = Operator Unlock, .12 = Program Lock, .13 = Program Unlock, .14 = Acquire Maintenance, .15 = Release Maintenance, .16 = Acquire External, .17 = Release External, .29 = Echo.
Default is 0.
Inp_OpenLSData
BOOL
Visible
Not Required
Input
Valve open limit switch: 1 = Confirmed opened.
Default is false.
Inp_ClosedLSData
BOOL
Visible
Not Required
Input
Valve closed limit switch: 1 = Confirmed fully closed.
Default is false.
Inp_LowerSeatLSData
BOOL
Visible
Not Required
Input
Valve lower seat lift limit switch: 1 = Confirmed lower seat lifted.
Default is false.
Inp_UpperSeatLSData
BOOL
Visible
Not Required
Input
Valve upper seat lift limit switch: 1 = Confirmed upper seat lifted.
Default is false.
Inp_CavityInletLSData
BOOL
Visible
Not Required
Input
Valve cavity inlet limit switch: 1 = Confirmed cavity inlet opened.
Default is false.
Inp_CavityOutletLSData
BOOL
Visible
Not Required
Input
Valve cavity outlet limit switch: 1 = Confirmed cavity output closed.
Default is false.
Inp_IOFault
BOOL
Visible
Not Required
Input
1 = I/O communication is faulted, 0 = I/O communication is OK.
Default is false.
Inp_OpenIntlkOK
BOOL
Visible
Not Required
Input
1 = Open interlocks OK, valve can open, 0 = Interlocks not OK, close valve if target/actual state is opened.
Default is true.
Inp_OpenNBIntlkOK
BOOL
Visible
Not Required
Input
1 = Open non-bypassable interlocks OK, valve can open, 0 = Interlocks not OK, close valve if target/actual state is open.
Default is true.
Inp_OpenIntlkAvailable
BOOL
Visible
Not Required
Input
1 = Open interlock availability is OK, show Sts_OpenIntlkAvailable if device is ready except for open interlocks.
Default is false.
Inp_LowerSeatIntlkOK
BOOL
Visible
Not Required
Input
1 = Lower seat interlocks OK, valve can lift or clean lower seat, 0 = Interlocks not OK, close valve if target/actual state has lower seat lifted.
Default is true.
Inp_LowerSeatNBIntlkOK
BOOL
Visible
Not Required
Input
1 = Lower seat non-bypassable interlocks OK, valve can lift or clean lower seat, 0 = Interlocks not OK, close valve if target/actual state has lower seat lifted.
Default is true.
Inp_LowerSeatIntlkAvailable
BOOL
Visible
Not Required
Input
1 = Lower seat interlock availability is OK, show Sts_LowerSeatIntlkAvailable if device is ready except for lower seat interlocks.
Default is false.
Inp_UpperSeatIntlkOK
BOOL
Visible
Not Required
Input
1 = Upper seat interlocks OK, valve can lift or clean upper seat, 0 = Interlocks not OK, close valve if target/actual state has upper seat lifted.
Default is true.
Inp_UpperSeatNBIntlkOK
BOOL
Visible
Not Required
Input
1 = Upper seat non-bypassable interlocks OK, valve can lift or clean upper seat, 0 = Interlocks not OK, close valve if target/actual state has upper seat lifted.
Default is true.
Inp_UpperSeatIntlkAvailable
BOOL
Visible
Not Required
Input
1 = Upper seat interlock availability is OK, show Sts_UpperSeatIntlkAvailable if device is ready except for upper seat interlocks.
Default is false.
Inp_CavityIntlkOK
BOOL
Not Visible
Not Required
Input
1 = Cavity interlocks OK, valve can clean cavity or seat, 0 = Interlocks not OK, close valve if target/actual state has cleaning via cavity.
Default is true.
Inp_CavityNBIntlkOK
BOOL
Not Visible
Not Required
Input
1 = Cavity non-bypassable interlocks OK, valve can clean cavity or seat, 0 = Interlocks not OK, close valve if target/actual state has cleaning via cavity.
Default is true.
Inp_CavityIntlkAvailable
BOOL
Not Visible
Not Required
Input
1 = Cavity interlock availability is OK, show Sts_CavityIntlkAvailable if device is ready except for cavity interlocks.
Default is false.
Inp_IntlkTripInh
BOOL
Visible
Not Required
Input
1 = Inhibit reporting of Sts_IntlkTrip and interlock trip alarm.
Default is false.
Inp_RdyReset
BOOL
Not Visible
Not Required
Input
1 = Related object, reset by this object, is ready to be reset.
Default is false.
Inp_Hand
BOOL
Not Visible
Not Required
Input
1 = Acquire Hand command source (typically hardwired local), 0 = Release Hand.
Default is false.
Inp_Ovrd
BOOL
Not Visible
Not Required
Input
1 = Acquire Override command source (higher priority program logic), 0 = Release Override.
Default is false.
Inp_OvrdCmd
SINT
Not Visible
Not Required
Input
Override device command: 0 = None, 1 = Close, 2 = Open, 3 = Lift lower seat, 4 = Lift upper seat, 5 = Clean cavity, 6 = Clean lower seat, 7 = Clean upper seat.
Default is 0.
Inp_ExtInh
BOOL
Not Visible
Not Required
Input
1 = Inhibit External command source acquisition, 0 = Allow External acquisition.
Default is false.
Inp_HornInh
BOOL
Not Visible
Not Required
Input
1 = Inhibit audible alert, 0 = Allow audible alert.
Default is false.
Inp_Reset
BOOL
Not Visible
Not Required
Input
1 = Reset shed latches and cleared alarms.
Default is false.
Cfg_AllowDisable
BOOL
Not Visible
Not Required
Input
1 = Allow Maintenance to disable alarms.
Default is true.
Cfg_AllowShelve
BOOL
Not Visible
Not Required
Input
1 = Allow Operator to shelve alarms.
Default is true.
Cfg_HasLiftLower
BOOL
Not Visible
Not Required
Input
1 = Valve supports lift lower seat state.
Default is false.
Cfg_HasLiftUpper
BOOL
Not Visible
Not Required
Input
1 = Valve supports lift upper seat state.
Default is false.
Cfg_HasCleanCavity
BOOL
Not Visible
Not Required
Input
1 = Valve supports clean cavity state.
Default is false.
Cfg_HasCleanLower
BOOL
Not Visible
Not Required
Input
1 = Valve supports clean lower seat state.
Default is false.
Cfg_HasCleanUpper
BOOL
Not Visible
Not Required
Input
1 = Valve supports clean upper seat state.
Default is false.
Cfg_bOutStateSt0
SINT
Not Visible
Not Required
Input
Outputs to valve in De-energized state (state 0).
Default is 2#0000_0000.
Cfg_bOutStateSt1
SINT
Not Visible
Not Required
Input
Outputs to valve in Closed state (state 1).
Default is 2#0000_0001.
Cfg_bOutStateSt2
SINT
Not Visible
Not Required
Input
Outputs to valve in Close cavity outlet state (state 2).
Default is 2#0010_0000.
Cfg_bOutStateSt3
SINT
Not Visible
Not Required
Input
Outputs to valve in Open state (state 3).
Default is 2#0010_0010.
Cfg_bOutStateSt4
SINT
Not Visible
Not Required
Input
Outputs to valve in Lift lower seat state (state 4).
Default is 2#0000_0100.
Cfg_bOutStateSt5
SINT
Not Visible
Not Required
Input
Outputs to valve in Lift upper seat state (state 5).
Default is 2#0000_1000.
Cfg_bOutStateSt6
SINT
Not Visible
Not Required
Input
Outputs to valve in Clean cavity state (state 6).
Default is 2#0001_0000.
Cfg_bOutStateSt7
SINT
Not Visible
Not Required
Input
Outputs to valve in Lift lower seat for cleaning state (state 7).
Default is 2#0001_0100.
Cfg_bOutStateSt8
SINT
Not Visible
Not Required
Input
Outputs to valve in Clean lower seat state (state 8).
Default is 2#0011_0100.
Cfg_bOutStateSt9
SINT
Not Visible
Not Required
Input
Outputs to valve in Lift upper seat for cleaning state (state 9).
Default is 2#0001_1000.
Cfg_bOutStateSt10
SINT
Not Visible
Not Required
Input
Outputs to valve in Clean upper seat state (state 10).
Default is 2#0011_1000.
Cfg_bFdbkStateSt0
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in De-energized state (state 0).
Default is 2#0000_0000.
Cfg_bFdbkStateSt1
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Closed state (state 1).
Default is 2#0000_0001.
Cfg_bFdbkStateSt2
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Close cavity outlet state (state 2).
Default is 2#0010_0000.
Cfg_bFdbkStateSt3
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Open state (state 3).
Default is 2#0010_0010.
Cfg_bFdbkStateSt4
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Lift lower seat state (state 4).
Default is 2#0000_0100.
Cfg_bFdbkStateSt5
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Lift upper seat state (state 5).
Default is 2#0000_1000.
Cfg_bFdbkStateSt6
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Clean cavity state (state 6).
Default is 2#0001_0000.
Cfg_bFdbkStateSt7
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Lift lower seat for cleaning state (state 7).
Default is 2#0001_0100.
Cfg_bFdbkStateSt8
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Clean lower seat state (state 8).
Default is 2#0011_0100.
Cfg_bFdbkStateSt9
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Lift upper seat for cleaning state (state 9).
Default is 2#0001_1000.
Cfg_bFdbkStateSt10
SINT
Not Visible
Not Required
Input
Feedback input states when valve is in Clean upper seat state (state 10).
Default is 2#0011_1000.
Cfg_bFdbkReqdSt0
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in De-energized state (state 0).
Default is 2#0000_1111.
Cfg_bFdbkReqdSt1
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Closed state (state 1).
Default is 2#0000_1111.
Cfg_bFdbkReqdSt2
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Close cavity outlet state (state 2).
Default is 2#0000_1111.
Cfg_bFdbkReqdSt3
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Open state (state 3).
Default is 2#0000_1111.
Cfg_bFdbkReqdSt4
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Lift lower seat state (state 4).
Default is 2#0000_0000.
Cfg_bFdbkReqdSt5
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Lift upper seat state (state 5).
Default is 2#0000_0000.
Cfg_bFdbkReqdSt6
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Clean cavity state (state 6).
Default is 2#0000_0000.
Cfg_bFdbkReqdSt7
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Lift lower seat for cleaning state (state 7).
Default is 2#0000_0000.
Cfg_bFdbkReqdSt8
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Clean lower seat state (state 8).
Default is 2#0000_0000.
Cfg_bFdbkReqdSt9
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Lift upper seat for cleaning state (state 9).
Default is 2#0000_0000.
Cfg_bFdbkReqdSt10
SINT
Not Visible
Not Required
Input
Feedback inputs required (checked) to verify valve is in Clean upper seat state (state 10).
Default is 2#0000_0000.
Cfg_FdbkTimeSt0
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached De-energized state (state 0) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt1
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Closed state (state 1) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt2
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Close cavity outlet state (state 2) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt3
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Opened state (state 3) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt4
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Lift lower seat state (state 4) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt5
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Lift upper seat state (state 5) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt6
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Clean cavity state (state 6) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt7
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Lift lower seat for cleaning state (state 7) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt8
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Clean lower seat state (state 8) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt9
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Lift upper seat for cleaning state (state 9) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_FdbkTimeSt10
REAL
Not Visible
Not Required
Input
Time feedbacks must match required pattern to confirm valve has reached Clean upper seat state (state 10) (seconds). Valid = 0.0 to 60.0.
Default is 1.0.
Cfg_PulseLiftLower
BOOL
Not Visible
Not Required
Input
1 = Pulse seat lift output when lifting lower seat, 0 = Do not pulse, lift seat continuously.
Default is false.
Cfg_PulseLiftUpper
BOOL
Not Visible
Not Required
Input
1 = Pulse seat lift output when lifting upper seat, 0 = Do not pulse, lift seat continuously.
Default is false.
Cfg_PulseCleanLower
BOOL
Not Visible
Not Required
Input
1 = Pulse seat lift output when cleaning lower seat, 0 = Do not pulse, clean continuously.
Default is false.
Cfg_PulseCleanUpper
BOOL
Not Visible
Not Required
Input
1 = Pulse seat lift output when cleaning upper seat, 0 = Do not pulse, clean continuously.
Default is false.
Cfg_HasOpenIntlkObj
BOOL
Not Visible
Not Required
Input
1 = Tells HMI an object is connected to Inp_OpenIntlkOK, Inp_OpenNBIntlkOK inputs, enable navigation.
Default is false.
Cfg_HasLowerSeatIntlkObj
BOOL
Not Visible
Not Required
Input
1 = Tells HMI an object is connected to Inp_LowerSeatIntlkOK, Inp_LowerSeatNBIntlkOK inputs, enable navigation.
Default is false.
Cfg_HasUpperSeatIntlkObj
BOOL
Not Visible
Not Required
Input
1 = Tells HMI an object is connected to Inp_UpperSeatIntlkOK, Inp_UpperSeatNBIntlkOK inputs, enable navigation.
Default is false.
Cfg_HasCavityIntlkObj
BOOL
Not Visible
Not Required
Input
1 = Tells HMI an object is connected to Inp_CavityIntlkOK, Inp_CavityNBIntlkOK inputs, enable navigation.
Default is false.
Cfg_HasStatsObj
BOOL
Not Visible
Not Required
Input
1 = Tells HMI a PVLVS object is monitoring this valve, enable navigation.
Default is false.
Cfg_HasMoreObj
BOOL
Not Visible
Not Required
Input
1 = Tells HMI an object with more information is available, enable navigation.
Default is false.
Cfg_OperClosePrio
BOOL
Not Visible
Not Required
Input
1 = OCmd_Close is accepted any time, 0 = OCmd_Close is accepted only when Operator command source is selected.
Default is false.
Cfg_ExtClosePrio
BOOL
Not Visible
Not Required
Input
1 = XCmd_Close is accepted any time, 0 = XCmd_Close is accepted only when External command source is selected.
Default is false.
Cfg_OCmdResets
BOOL
Not Visible
Not Required
Input
1 = A new Operator state command resets fault, 0 = A reset command is required to clear fault.
Default is false.
Cfg_XCmdResets
BOOL
Not Visible
Not Required
Input
1 = A new External state command resets fault, 0 = A reset command is required to clear fault.
Default is false.
Cfg_OvrdPermIntlk
BOOL
Not Visible
Not Required
Input
1 = Override ignores bypassable permissives and interlocks, 0 = Override uses all permissives and interlocks.
Default is false.
Cfg_ShedOnFail
BOOL
Not Visible
Not Required
Input
1 = Close valve and alarm on position fail, 0 = Alarm only.
Default is true.
Cfg_ShedOnIOFault
BOOL
Not Visible
Not Required
Input
1 = Close valve and alarm on I/O fault, 0 = Alarm only.
Default is true.
Cfg_HasOper
BOOL
Not Visible
Not Required
Input
1 = Operator (unlocked) command source exists, can be selected.
Default is true.
Cfg_HasOperLocked
BOOL
Not Visible
Not Required
Input
1 = Operator Locked command source exists, can be selected.
Default is true.
Cfg_HasProg
BOOL
Not Visible
Not Required
Input
1 = Program (unlocked) command source exists, can be selected.
Default is true.
Cfg_HasProgLocked
BOOL
Not Visible
Not Required
Input
1 = Program Locked command source exists, can be selected.
Default is true.
Cfg_HasExt
BOOL
Not Visible
Not Required
Input
1 = External command source exists, can be selected.
Default is false.
Cfg_HasMaint
BOOL
Not Visible
Not Required
Input
1 = Maintenance command source exists, can be selected.
Default is true.
Cfg_HasMaintOoS
BOOL
Not Visible
Not Required
Input
1 = Maintenance Out of Service exists, can be selected.
Default is true.
Cfg_OvrdOverLock
BOOL
Not Visible
Not Required
Input
1 = Override supersedes Program/Operator Locked, 0 = Don't supersede Program/Operator Locked.
Default is true.
Cfg_ExtOverLock
BOOL
Not Visible
Not Required
Input
1 = External supersedes Program/Operator Locked, 0 = Don't supersede Program/Operator Locked.
Default is false.
Cfg_ProgPwrUp
BOOL
Not Visible
Not Required
Input
1 = Power up to Program command source, 0 = Power up to Operator command source.
Default is false.
Cfg_ProgNormal
BOOL
Not Visible
Not Required
Input
Normal command source: 1 = Program, 0 = Operator.
Default is false.
Cfg_PCmdPriority
BOOL
Not Visible
Not Required
Input
Command priority: 1 = Program commands win, 0 = Operator commands win.
Default is false.
Cfg_PCmdProgAsLevel
BOOL
Not Visible
Not Required
Input
1 = Program/Operator selection follows PCmd_Prog as level (1 for Program, 0 for Operator), 0 = PCmd_Prog is used as edge to select Program, PCmd_Oper selects Operator.
Default is false.
Cfg_PCmdLockAsLevel
BOOL
Not Visible
Not Required
Input
1 = Program lock selection follows PCmd_Lock as level (1 for locked, 0 for unlocked), 0 = PCmd_Lock is used as edge to select Program Locked, PCmd_Unlock selects Program (unlocked).
Default is false.
Cfg_ExtAcqAsLevel
BOOL
Not Visible
Not Required
Input
1 = External selection follows XCmd_Acq as level (1 to acquire External, 0 to release External), 0 = XCmd_Acq is used as edge to acquire External, XCmd_Rel is used to release External.
Default is false.
Cfg_OpenPulseTime
REAL
Not Visible
Not Required
Input
Time to lift seat when pulsing for cleaning (seconds). Valid = 0.0 to 2147483.0, 0.0 = do not pulse.
Default is 10.0.
Cfg_ClosePulseTime
REAL
Not Visible
Not Required
Input
Time to close seat when pulsing for cleaning (seconds). Valid = 0.0 to 2147483.0, 0.0 = do not pulse.
Default is 5.0.
Cfg_StartHornTime
REAL
Not Visible
Not Required
Input
Time to sound audible on command to move from the closed position (seconds). Valid = 0.0 to 1000.0, 0.0 = Disabled.
Default is 0.0.
Cfg_FailTime
REAL
Not Visible
Not Required
Input
Time to receive state feedback before declaring failure (seconds). Valid = 0.0 to 2147483.0.
Default is 3.0.
Cfg_CnfrmReqd
SINT
Not Visible
Not Required
Input
Operator command confirmation or e-signature type required: 0 = None, 1 = Command confirmation required, 2 = Performer e-signature required, 3 = Performer and approver e-signature required.
Default is 0.
PSet_Owner
DINT
Not Visible
Not Required
Input
Program ownership request: Non-zero Owner ID = acquire, 0 = release.
Default is 0.
PCmd_Virtual
BOOL
Not Visible
Not Required
Input
Program Command to select Virtual (simulated) device operation. The instruction clears this operand automatically.
Default is false.
PCmd_Physical
BOOL
Not Visible
Not Required
Input
Program Command to select Physical device operation (not simulated). The instruction clears this operand automatically.
Default is false.
PCmd_Close
BOOL
Not Visible
Not Required
Input
Program Command to close valve. The instruction clears this operand automatically.
Default is false.
PCmd_Open
BOOL
Not Visible
Not Required
Input
Program Command to cpen valve. The instruction clears this operand automatically.
Default is false.
PCmd_LiftLower
BOOL
Not Visible
Not Required
Input
Program Command to lift lower seat. The instruction clears this operand automatically.
Default is false.
PCmd_LiftUpper
BOOL
Not Visible
Not Required
Input
Program Command to lift upper seat. The instruction clears this operand automatically.
Default is false.
PCmd_CleanCavity
BOOL
Not Visible
Not Required
Input
Program Command to clean valve leakage cavity. The instruction clears this operand automatically.
Default is false.
PCmd_CleanLower
BOOL
Not Visible
Not Required
Input
Program Command to clean lower seat. The instruction clears this operand automatically.
Default is false.
PCmd_CleanUpper
BOOL
Not Visible
Not Required
Input
Program Command to clean upper seat. The instruction clears this operand automatically.
Default is false.
PCmd_Reset
BOOL
Not Visible
Not Required
Input
Program Command to reset shed latches and returned-to-normal latched alarms. The instruction clears this operand automatically.
Default is false.
PCmd_Prog
BOOL
Not Visible
Not Required
Input
Program Command to select Program command source. The instruction clears this operand automatically if Cfg_PCmdProgAsLevel = 0.
Default is false.
PCmd_Oper
BOOL
Not Visible
Not Required
Input
Program Command to select Operator command source. The instruction clears this operand automatically.
Default is false.
PCmd_Lock
BOOL
Not Visible
Not Required
Input
Program Command to lock Program command source and disallow Operator. The instruction clears this operand automatically if Cfg_PCmdLockAsLevel = 0.
Default is false.
PCmd_Unlock
BOOL
Not Visible
Not Required
Input
Program Command to unlock Program command source and allow Operator to acquire. The instruction clears this operand automatically.
Default is false.
PCmd_Normal
BOOL
Not Visible
Not Required
Input
Program Command to select normal command source (Operator or Program). The instruction clears this operand automatically.
Default is false.
XCmd_Close
BOOL
Not Visible
Not Required
Input
External Command to close valve. The instruction clears this operand automatically.
Default is false.
XCmd_Open
BOOL
Not Visible
Not Required
Input
External Command to cpen valve. The instruction clears this operand automatically.
Default is false.
XCmd_LiftLower
BOOL
Not Visible
Not Required
Input
External Command to lift lower seat. The instruction clears this operand automatically.
Default is false.
XCmd_LiftUpper
BOOL
Not Visible
Not Required
Input
External Command to lift upper seat. The instruction clears this operand automatically.
Default is false.
XCmd_CleanCavity
BOOL
Not Visible
Not Required
Input
External Command to clean valve leakage cavity. The instruction clears this operand automatically.
Default is false.
XCmd_CleanLower
BOOL
Not Visible
Not Required
Input
External Command to clean lower seat. The instruction clears this operand automatically.
Default is false.
XCmd_CleanUpper
BOOL
Not Visible
Not Required
Input
External Command to clean upper seat. The instruction clears this operand automatically.
Default is false.
XCmd_Acq
BOOL
Not Visible
Not Required
Input
External Command to acquire command source. The instruction clears this operand automatically if Cfg_ExtAcqAsLevel = 0.
Default is false.
XCmd_Rel
BOOL
Not Visible
Not Required
Input
External Command to release command source, accepted if Cfg_ExtAcqAsLevel = 0. The instruction clears this operand automatically.
Default is false.
XCmd_Reset
BOOL
Not Visible
Not Required
Input
External Command to reset shed latches and returned-to-normal latched alarms. The instruction clears this operand automatically.
Default is false.
XCmd_ResetAckAll
BOOL
Not Visible
Not Required
Input
External Command to acknowledge all alarms and reset latched alarms and shed conditions. The instruction clears this operand automatically.
Default is false.
Public Output Members
Data Type
FBD Default Visibility
FBD Wiring required
Usage
Description
EnableOut
BOOL
Not Visible
Not Required
Output
Enable Output - System Defined Parameter
Out_OpenData
BOOL
Visible
Not Required
Output
Output to open valve: 1 = Open.
Out_CloseData
BOOL
Visible
Not Required
Output
Output to close valve: 1 = Close.
Out_LiftLowerData
BOOL
Visible
Not Required
Output
Output to lift lower valve seat: 1 = Lift.
Out_LiftUpperData
BOOL
Visible
Not Required
Output
Output to lift upper valve seat: 1 = Lift.
Out_CavityInletData
BOOL
Visible
Not Required
Output
Output to open leakage cavity cleaning inlet: 1 = Open.
Out_CavityOutletData
BOOL
Visible
Not Required
Output
Output to close leakage cavity drain/cleaning outlet: 1 = Close.
Out_LocatorData
BOOL
Not Visible
Not Required
Output
Output to valve locator lamp/beacon: 1 = Illuminated.
Out_HornData
BOOL
Not Visible
Not Required
Output
Output to sound horn prior to commanded state change.
Out_Reset
BOOL
Not Visible
Not Required
Output
1 = Reset command has been received and accepted.
Out_OwnerSts
DINT
Not Visible
Not Required
Output
Status of command source, owner command handshake and ready status (bitmapped): All bits off = None, .10 = Operator Lock, .11 = Operator Unlock, .12 = Program Lock, .13 = Program Unlock, .14 = Acquire Maintenance, .15 = Release Maintenance, .16 = Acquire External, .17 = Release External, .18 = Has Maintenance, .19 = External Override Lock, .20 = Has External, .21 = Has Operator, .22 = Has Operator Locked, .23 = Has Program, .24 = Has Program Locked, .29 = Echo, .30 = Not Ready.
Sts_Initialized
BOOL
Not Visible
Not Required
Output
1 = Instruction is initialized. 0 = Use Inp_InitializeReq to reinitialize.
Sts_Closed
BOOL
Visible
Not Required
Output
1 = Valve closed position achieved.
Sts_Opened
BOOL
Visible
Not Required
Output
1 = Valve opened position achieved.
Sts_LiftLower
BOOL
Visible
Not Required
Output
1 = Lift valve lower seat position achieved.
Sts_LiftUpper
BOOL
Visible
Not Required
Output
1 = Lift valve upper seat position achieved.
Sts_CleanCavity
BOOL
Not Visible
Not Required
Output
1 = Clean valve leakage cavity position achieved.
Sts_CleanLower
BOOL
Not Visible
Not Required
Output
1 = Clean valve lower seat position achieved.
Sts_CleanUpper
BOOL
Not Visible
Not Required
Output
1 = Clean valve upper seat position achieved.
Sts_Moving
BOOL
Visible
Not Required
Output
1 = Valve not yet confirmed in commanded position.
Sts_Pulsing
BOOL
Visible
Not Required
Output
1 = Pulsing valve seat for cleaning.
Sts_Locator
BOOL
Not Visible
Not Required
Output
1 = Locator/beacon for identifying valve is active.
Sts_Horn
BOOL
Not Visible
Not Required
Output
1 = Sounding horn prior to commanded state change.
Sts_Physical
BOOL
Not Visible
Not Required
Output
1 = The instruction is available to control the physical valve, 0 = Instruction is not controlling the physical valve, outputs are holding the valve closed.
Sts_Virtual
BOOL
Not Visible
Not Required
Output
1 = The instruction is available to control a virtual model of the valve, 0 = Instruction is not controlling the virtual model of the valve.
SrcQ_IO
SINT
Not Visible
Not Required
Output
Source and quality of primary input or output: 0=Good, live, confirmed good 1=Good, live, assumed good 2=Good, no feedback, assumed good 8=Test, virtualized 9=Test, loopback 10=Test, manually entered 16=Uncertain, live, off-spec 17=Uncertain, substituted at device or bus 18=Uncertain, substituted at instruction 19=Uncertain, using last known good 20=Uncertain, using replacement value 32=Bad, signal failure 33=Bad, channel fault 34=Bad, module or communication fault 35=Bad, invalid configuration
SrcQ
SINT
Not Visible
Not Required
Output
Source and quality of primary value or status: 0=Good, live, confirmed good 1=Good, live, assumed good 2=Good, no feedback, assumed good 8=Test, virtualized 9=Test, loopback 10=Test, manually entered 16=Uncertain, live, off-spec 17=Uncertain, substituted at device or bus 18=Uncertain, substituted at instruction 19=Uncertain, using last known good 20=Uncertain, using replacement value 32=Bad, signal failure 33=Bad, channel fault 34=Bad, module or communication fault 35=Bad, invalid configuration
Sts_eFdbk
SINT
Not Visible
Not Required
Output
Device feedback: 0 = None/Moving/Unknown, 1 = Closed, 3 = Opened, 4 = Lift lower seat, 5 = Lift upper seat, 6 = Clean cavity, 8 = Clean lower seat, 10 = Clean upper seat.
Sts_eCmd
SINT
Not Visible
Not Required
Output
Device command: 0 = None, 1 = Close, 3 = Open, 4 = Lift lower seat, 5 = Lift upper seat, 6 = Clean cavity, 8 = Clean lower seat, 10 = Clean upper seat.
Sts_eSts
SINT
Not Visible
Not Required
Output
Device status: 0 = Unknown, 1 = Closed, 3 = Opened, 4 = Lift lower seat, 5 = Lift upper seat, 6 = Clean cavity, 8 = Clean lower seat, 10 = Clean upper seat, 11 = Moving, 12 = Pulse lower seat, 13 = Pulse upper seat, 14 = Horn, 15 = Out of service.
Sts_eState
SINT
Not Visible
Not Required
Output
Device state for HMI state diagram: 0 = De-energized, 1 = Closed, 2 = Closed cavity outlet, 3 = Opened, 4 = Lift lower seat, 5 = Lift upper seat, 6 = Clean cavity, 7 = Lift lower seat for cleaning, 8 = Clean lower seat, 9 = Lift upper seat for cleaning, 10 = Clean upper seat.
Sts_eFault
SINT
Not Visible
Not Required
Output
Device fault status: 0 = None, 16 = Position fail, 32 = I/O fault, 34 = Configuration error.
Sts_eOutState
SINT
Not Visible
Not Required
Output
State of outputs to physical device: 0 = De-energized, 1 = Close, 2 = Close cavity outlet, 3 = Open, 4 = Lift lower seat, 5 = Lift upper seat, 6 = Clean cavity, 7 = Lift lower seat for cleaning, 8 = Clean lower seat, 9 = Lift upper seat for cleaning, 10 = Clean upper seat, 11 = Horn.
Sts_eNotify
SINT
Not Visible
Not Required
Output
Summary alarm status: 0 = Not in alarm, acknowledged, 1 = Not in alarm, unacknowledged or reset required, 2 = Low severity alarm, acknowledged, 3 = Low severity alarm, unacknowledged, 4 = Medium severity alarm, acknowledged, 5 = Medium severity alarm, unacknowledged, 6 = High severity alarm, acknowledged, 7 = High severity alarm, unacknowledged, 8 = Urgent severity alarm, acknowledged, 9 = Urgent severity alarm, unacknowledged.
Sts_eNotifyAll
SINT
Not Visible
Not Required
Output
Summary alarm status including related objects: 0 = Not in alarm, acknowledged, 1 = Not in alarm, unacknowledged or reset required, 2 = Low severity alarm, acknowledged, 3 = Low severity alarm, unacknowledged, 4 = Medium severity alarm, acknowledged, 5 = Medium severity alarm, unacknowledged, 6 = High severity alarm, acknowledged, 7 = High severity alarm, unacknowledged, 8 = Urgent severity alarm, acknowledged, 9 = Urgent severity alarm, unacknowledged.
Sts_eNotifyIOFault
SINT
Not Visible
Not Required
Output
I/O fault alarm status: 0 = Not in alarm, acknowledged, 1 = Not in alarm, unacknowledged or reset required, 2 = Low severity alarm, acknowledged, 3 = Low severity alarm, unacknowledged, 4 = Medium severity alarm, acknowledged, 5 = Medium severity alarm, unacknowledged, 6 = High severity alarm, acknowledged, 7 = High severity alarm, unacknowledged, 8 = Urgent severity alarm, acknowledged, 9 = Urgent severity alarm, unacknowledged.
Sts_eNotifyFail
SINT
Not Visible
Not Required
Output
Position fail alarm status: 0 = Not in alarm, acknowledged, 1 = Not in alarm, unacknowledged or reset required, 2 = Low severity alarm, acknowledged, 3 = Low severity alarm, unacknowledged, 4 = Medium severity alarm, acknowledged, 5 = Medium severity alarm, unacknowledged, 6 = High severity alarm, acknowledged, 7 = High severity alarm, unacknowledged, 8 = Urgent severity alarm, acknowledged, 9 = Urgent severity alarm, unacknowledged.
Sts_eNotifyIntlkTrip
SINT
Not Visible
Not Required
Output
Interlock trip alarm status: 0 = Not in alarm, acknowledged, 1 = Not in alarm, unacknowledged or reset required, 2 = Low severity alarm, acknowledged, 3 = Low severity alarm, unacknowledged, 4 = Medium severity alarm, acknowledged, 5 = Medium severity alarm, unacknowledged, 6 = High severity alarm, acknowledged, 7 = High severity alarm, unacknowledged, 8 = Urgent severity alarm, acknowledged, 9 = Urgent severity alarm, unacknowledged.
Sts_UnackAlmCount
SINT
Not Visible
Not Required
Output
Count of unacknowledged alarms.
Sts_eSrc
INT
Not Visible
Not Required
Output
Current command source: 0 = Logic not in use, 4 = Hand, 8 = Maintenance, 16 = Override, 32 = Program, 33 = Program Locked, 34 = Program default (Normal), 64 = Operator, 65 = Operator Locked, 66 = Operator default (Normal), 128 = Maintenance Out of Service, 129 = Programmed Out of Service (EnableIn false), 256 = External.
Sts_bSrc
INT
Not Visible
Not Required
Output
Active command source selections (bitmapped, for HMI): .0 = Hand, .1 = Programmed Out of Service (EnableIn false), .2= Maintenance Out of Service, .3 = Maintenance, .4 = Override, .5 = External, .6 = Program Locked, .7 = Program (unlocked), .8 = Operator Locked, .9 = Operator (unlocked).
Sts_Available
BOOL
Not Visible
Not Required
Output
1 = Valve has been acquired by Program and is ready and available for control.
Sts_OpenIntlkAvailable
BOOL
Not Visible
Not Required
Output
1 = Valve can be acquired by Program and is available to open when open interlocks are OK.
Sts_LowerSeatIntlkAvailable
BOOL
Not Visible
Not Required
Output
1 = Valve can be acquired by Program and is available to lift lower seat when lower seat interlocks are OK.
Sts_UpperSeatIntlkAvailable
BOOL
Not Visible
Not Required
Output
1 = Valve can be acquired by Program and is available to lift upper seat when upper seat interlocks are OK.
Sts_CavityIntlkAvailable
BOOL
Not Visible
Not Required
Output
1 = Valve can be acquired by Program and is available to clean seat or cavity when cavity interlocks are OK.
Sts_Bypass
BOOL
Not Visible
Not Required
Output
1 = Bypassable interlocks and permissives are bypassed.
Sts_BypActive
BOOL
Visible
Not Required
Output
1 = Interlock/permissive bypassing is active (bypassed by command or in Maintenance command source).
Sts_MaintByp
BOOL
Not Visible
Not Required
Output
1 = Device has a maintenance bypass function active.
Sts_NotRdy
BOOL
Visible
Not Required
Output
1 = Device not ready, see Sts_NrdyXxx detail bits for reason.
Sts_NrdyCfgErr
BOOL
Not Visible
Not Required
Output
1 = Device not ready, configuration error.
Sts_NrdyFail
BOOL
Not Visible
Not Required
Output
1 = Device not ready, position fail, shed requires reset.
Sts_NrdyOpenIntlk
BOOL
Not Visible
Not Required
Output
1 = Device not ready, open interlock not OK, valve cannot open, and if opened, valve will close.
Sts_NrdyLowerSeatIntlk
BOOL
Not Visible
Not Required
Output
1 = Device not ready, lower seat interlock not OK, valve cannot lift or clean lower seat, and if seat lifted, valve will close.
Sts_NrdyUpperSeatIntlk
BOOL
Not Visible
Not Required
Output
1 = Device not ready, upper seat interlock not OK, valve cannot lift or clean upper seat, and if seat lifted, valve will close.
Sts_NrdyCavityIntlk
BOOL
Not Visible
Not Required
Output
1 = Device not ready, cavity Interlock not OK, valve cannot clean cavity or seats, and if cleaning, valve will close.
Sts_NrdyIOFault
BOOL
Not Visible
Not Required
Output
1 = Device not ready, I/O fault, shed requires reset.
Sts_NrdyOoS
BOOL
Not Visible
Not Required
Output
1 = Device not ready, device is Out of Service.
Sts_NrdyPrioClose
BOOL
Not Visible
Not Required
Output
1 = Device not ready, Operator or External priority Close Command, shed requires reset.
Sts_NrdyVirtualPhysical
BOOL
Not Visible
Not Required
Output
1 = Device not ready, valve is transitioning between physical and virtual operation.
Sts_Err
BOOL
Not Visible
Not Required
Output
1 = Error in configuration, see Sts_ErrXxx detail bits for reason.
Sts_ErrAlm
BOOL
Not Visible
Not Required
Output
1 = Error in configuration, Logix tag-based alarm settings invalid.
Sts_bErrFdbkTime
INT
Not Visible
Not Required
Output
Error in configuration, bit = 1 indicates which state’s Cfg_FdbkTimeStX is invalid. Valid = 0.0 to 60.0.
Sts_ErrOpenPulseTime
BOOL
Not Visible
Not Required
Output
1 = Error in configuration, Cfg_OpenPulseTime invalid. Valid = 0.0 to 2147483.0.
Sts_ErrClosePulseTime
BOOL
Not Visible
Not Required
Output
1 = Error in configuration, Cfg_ClosePulseTime invalid. Valid = 0.0 to 2147483.0.
Sts_ErrFailTime
BOOL
Not Visible
Not Required
Output
1 = Error in configuration, Cfg_FailTime invalid. Valid = 0.0 to 2147483.0.
Sts_Hand
BOOL
Visible
Not Required
Output
1 = Hand command source is selected.
Sts_OoS
BOOL
Visible
Not Required
Output
1 = Out of Service command source is selected.
Sts_Maint
BOOL
Visible
Not Required
Output
1 = Maintenance command source is selected.
Sts_Ovrd
BOOL
Visible
Not Required
Output
1 = Override command source is selected.
Sts_Ext
BOOL
Visible
Not Required
Output
1 = External command source is selected.
Sts_Prog
BOOL
Visible
Not Required
Output
1 = Program (unlocked) command source is selected.
Sts_ProgLocked
BOOL
Not Visible
Not Required
Output
1 = Program Locked command source is selected.
Sts_Oper
BOOL
Visible
Not Required
Output
1 = Operator (unlocked) command source is selected.
Sts_OperLocked
BOOL
Not Visible
Not Required
Output
1 = Operator Locked command source is selected.
Sts_ProgOperSel
BOOL
Not Visible
Not Required
Output
Program/Operator selection (latch) state: 1 = Program, 0 = Operator.
Sts_ProgOperLock
BOOL
Visible
Not Required
Output
Program/Operator lock (latch) state: 1 = Locked, 0 = Unlocked.
Sts_Normal
BOOL
Not Visible
Not Required
Output
1 = Selected command source is the normal source (Program or Operator).
Sts_ExtReqInh
BOOL
Not Visible
Not Required
Output
1 = External command source selection is inhibited, External is not available in current state.
Sts_ProgReqInh
BOOL
Not Visible
Not Required
Output
1 = Program command source selection is inhibited, Program is not available in current state.
Sts_MAcqRcvd
BOOL
Not Visible
Not Required
Output
1 = Command to acquire Maintenance command source was received this scan.
Sts_CmdConflict
BOOL
Not Visible
Not Required
Output
1 = Conflicting commands received this scan.
Sts_Alm
BOOL
Not Visible
Not Required
Output
1 = An alarm is active.
Sts_AlmInh
BOOL
Not Visible
Not Required
Output
1 = An alarm is shelved or disabled.
Sts_IOFault
BOOL
Not Visible
Not Required
Output
1 = I/O communication fault. There is a predefined default discrete Logix tag-based alarm for the status. Set standard configuration members of the discrete Logix tag-based alarm. Alarm elements can be accessed as follows: PVLVMP_Tag.@Alarms.Alm_IOFault.AlarmElement.
Sts_Fail
BOOL
Visible
Not Required
Output
1 = Valve position failure. There is a predefined default discrete Logix tag-based alarm for the status. Set standard configuration members of the discrete Logix tag-based alarm. Alarm elements can be accessed as follows: PVLVMP_Tag.@Alarms.Alm_Fail.AlarmElement.
Sts_IntlkTrip
BOOL
Not Visible
Not Required
Output
1 = Valve closed by an interlock not OK. There is a predefined default discrete Logix tag-based alarm for the status. Set standard configuration members of the discrete Logix tag-based alarm. Alarm elements can be accessed as follows: PVLVMP_Tag.@Alarms.Alm_IntlkTrip.AlarmElement.
Sts_RdyAck
BOOL
Not Visible
Not Required
Output
1 = An alarm is ready to be acknowledged.
Sts_RdyReset
BOOL
Visible
Not Required
Output
1 = A latched alarm or shed condition is ready to be reset.
XRdy_Acq
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_Acq, enable HMI button.
XRdy_Rel
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_Rel, enable HMI button.
XRdy_Close
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_Close, enable button.
XRdy_Open
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_Open, enable button.
XRdy_LiftLower
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_LiftLower, enable button.
XRdy_LiftUpper
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_LiftUpper, enable button.
XRdy_CleanCavity
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_CleanCavity, enable button.
XRdy_CleanLower
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_CleanLower, enable button.
XRdy_CleanUpper
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_CleanUpper, enable button.
XRdy_Reset
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_Reset, enable button.
XRdy_ResetAckAll
BOOL
Not Visible
Not Required
Output
1 = Ready for XCmd_ResetAckAll, enable button.
Val_Owner
DINT
Not Visible
Not Required
Output
Current object Owner ID, 0 = not owned.
Private Input Members
Data Type
Description
CmdSrc
P_COMMAND_SOURCE
Command source selection.
MCmd_Acq
BOOL
Maintenance Command to acquire Maintenance command source. The instruction clears this operand automatically.
Default is false.
MCmd_Bypass
BOOL
Maintenance Command to bypass all bypassable interlocks and permissives. The instruction clears this operand automatically.
Default is false.
MCmd_Check
BOOL
Maintenance Command to remove bypass and check all interlocks and permissives. The instruction clears this operand automatically.
Default is false.
MCmd_IS
BOOL
Maintenance Command to select In Service. The instruction clears this operand automatically.
Default is false.
MCmd_OoS
BOOL
Maintenance Command to select Out of Service. The instruction clears this operand automatically.
Default is false.
MCmd_Physical
BOOL
Maintenance Command to select Physical device operation. The instruction clears this operand automatically.
Default is false.
MCmd_Rel
BOOL
Maintenance Command to release Maintenance command source. The instruction clears this operand automatically.
Default is false.
MCmd_ToggleLocator
BOOL
Maintenance Command to toggle on/off valve locator/beacon.
Default is false.
MCmd_Virtual
BOOL
Maintenance Command to select Virtual device operation. The instruction clears this operand automatically.
Default is false.
OCmd_CleanCavity
BOOL
Operator Command to clean valve leakage cavity. The instruction clears this operand automatically.
Default is false.
OCmd_CleanLower
BOOL
Operator Command to clean valve lower seat. The instruction clears this operand automatically.
Default is false.
OCmd_CleanUpper
BOOL
Operator Command to clean valve upper seat. The instruction clears this operand automatically.
Default is false.
OCmd_Close
BOOL
Operator Command to close valve. The instruction clears this operand automatically.
Default is false.
OCmd_LiftLower
BOOL
Operator Command to lift lower valve seat. The instruction clears this operand automatically.
Default is false.
OCmd_LiftUpper
BOOL
Operator Command to lift upper valve seat. The instruction clears this operand automatically.
Default is false.
OCmd_Lock
BOOL
Operator Command to select Operator Locked command source and disallow Program. The instruction clears this operand automatically.
Default is false.
OCmd_Normal
BOOL
Operator Command to select configured normal command source (Operator or Program). The instruction clears this operand automatically.
Default is false.
OCmd_Open
BOOL
Operator Command to open valve. The instruction clears this operand automatically.
Default is false.
OCmd_Oper
BOOL
Operator Command to select Operator (unlocked) command source. The instruction clears this operand automatically.
Default is false.
OCmd_Prog
BOOL
Operator Command to select Program (unlocked) command source. The instruction clears this operand automatically.
Default is false.
OCmd_Reset
BOOL
Operator Command to reset shed latches and returned-to-normal latched alarms. The instruction clears this operand automatically.
Default is false.
OCmd_ResetAckAll
BOOL
Operator Command to acknowledge all alarms and reset latched alarms and shed conditions. The instruction clears this operand automatically.
Default is false.
OCmd_Unlock
BOOL
Operator Command to unlock Operator command source and allow Program to acquire. The instruction clears this operand automatically.
Default is false.
Private Output Members
Data Type
Description
HMI_BusObjIndex
DINT
This object's index in the bus array, for use by HMI display.
HMI_eCmdState
SINT
Command to valve, for use on HMI/dialog: 0 = None, 1 = Close, 3 = Open, 4 = Lift lower seat, 5 = Lift upper seat, 6 = Clean cavity, 8 = Clean lower seat, 10 = Clean upper seat.
MRdy_Acq
BOOL
1 = Ready for MCmd_Acq, enable HMI button.
MRdy_Bypass
BOOL
1 = Ready for MCmd_Bypass, enable HMI button.
MRdy_Check
BOOL
1 = Ready for MCmd_Check, enable HMI button.
MRdy_IS
BOOL
1 = Ready for MCmd_IS, enable HMI button.
MRdy_OoS
BOOL
1 = Ready for MCmd_OoS, enable HMI button.
MRdy_Physical
BOOL
1 = Ready for MCmd_Physical, enable HMI button.
MRdy_Rel
BOOL
1 = Ready for MCmd_Rel, enable HMI button.
MRdy_ToggleLocator
BOOL
1 = Ready for MCmd_ToggleLocator, enable HMI button.
MRdy_Virtual
BOOL
1 = Ready for MCmd_Virtual, enable HMI button.
ORdy_CleanCavity
BOOL
1 = Ready for OCmd_CleanCavity, enable HMI button.
ORdy_CleanLower
BOOL
1 = Ready for OCmd_CleanLower, enable HMI button.
ORdy_CleanUpper
BOOL
1 = Ready for OCmd_CleanUpper, enables HMI button.
ORdy_Close
BOOL
1 = Ready for OCmd_Close, enable HMI button.
ORdy_LiftLower
BOOL
1 = Ready for OCmd_LiftLower, enable HMI button.
ORdy_LiftUpper
BOOL
1 = Ready for OCmd_LiftUpper, enable HMI button.
ORdy_Lock
BOOL
1 = Ready for OCmd_Lock, enable HMI button.
ORdy_Normal
BOOL
1 = Ready for OCmd_Normal, enable HMI button.
ORdy_Open
BOOL
1 = Ready for OCmd_Open, enable HMI button.
ORdy_Oper
BOOL
1 = Ready for OCmd_Oper, enable HMI button.
ORdy_Prog
BOOL
1 = Ready for OCmd_Prog, enable HMI button.
ORdy_Reset
BOOL
1 = Ready for OCmd_Reset, enable HMI button.
ORdy_ResetAckAll
BOOL
1 = Ready for OCmd_ResetAckAll, enable HMI button.
ORdy_Unlock
BOOL
1 = Ready for OCmd_Unlock, enable HMI button.
Public InOut Members
Data Type
FBD Default Visibility
FBD Wiring required
Usage
Description
BusObj
BUS_OBJ
Visible
Required
InOut
Bus component
BUS_OBJ Structure
The BUS_OBJ structure links the device to other devices and instructions in a complex control strategy, typically into a hierarchy. A Bus Object rolls up status and alarm information from lower level devices to higher level control and fans out commands from higher level control to lower level devices, and items link to the bus by referencing a single member of the BUS_OBJ array associated with the bus.
This parameter links the instruction to an external tag that contains necessary data for the instruction to operate. The external tag must be of the data type shown, or may be NULL. If NULL, the Bus functions of this instruction are not available.
Members
Data Type
Description
Inp_Cmd
DINT
Input to assert commands
Out_Cmd
DINT
Resultant commands
Inp_CmdLLH
DINT
Input for level normally high commands
Out_CmdLLH
DINT
Resultant line level high commands
Inp_Sts
DINT
Input to assert status
Out_Sts
DINT
Resultant status
Inp_CmdAck
DINT
Input to assert a command acknowledgement
Out_CmdAck
DINT
Resultant command acknowledgements
Inp_SeverityMax
DINT
Input: maximum alarm severity
Out_SeverityMax
DINT
Resultant of maximum alarm severity
Cfg_CmdMask
DINT
Propagation mask for commands
Cfg_CmdLLHMask
DINT
Propagation mask for line level high commands
Cfg_StsMask
DINT
Propagation mask for status
Ref_Index
DINT
Bus array index
Alarms
Discrete
Logix Designer
 tag-based alarms are defined for these members:
Member
Alarm Name
Description
Sts_IntlkTrip
Alm_IntlkTrip
Device de-energized or set to Position 1 by an interlock Not OK.
Sts_IOFault
Alm_IOFault
I/O fault.
Sts_Fail
Alm_Fail
Device failure.
Mark the alarm as used or unused and set standard configuration members of the discrete Logix Tag based alarm. Use this format to access alarm elements:
Tag.@Alarms.AlarmName.AlarmElement
The PVLVMP instruction uses these alarms:
  • Raises the Interlock Trip alarm when an interlock not-OK condition occurs for a particular state and the device is currently commanded to that state. The device will be commanded to close when an interlock trip occurs. If interlocks are not bypassed, a bypassable interlock or a non-bypassable interlock not-OK condition initiates an interlock trip. If interlocks are bypassed, only a non-bypassable interlock not-OK condition initiates an interlock trip.
  • Raises the I/O Fault alarm when the Inp_IOFault input is true. This input is usually used to indicate to the instruction that a communication failure has occurred for its I/O. If the I/O Fault is configured as a shed fault, the device will be commanded to close and will remain closed until reset.
  • Raises the Fail alarm when the valve is commanded to a new position and the device feedbacks fail to confirm that the valve reached each required position within the configured failure time. If the Failure is configured as a shed fault, the valve will be commanded closed and cannot be opened until reset.
Program, Operator, and External commands reset latched alarms, and reset and acknowledge all alarms of the instruction (Alarm Set) at the same time. This diagram shows how the commands interact with the PVLVMP instruction.
PVLVMP_alarms_v35
Operation
The PVLVMP instruction operates by using a state model, as shown in this diagram.
PVLVMP_statemodel_v35
This diagram illustrates functionality of the PVLVMP instruction.
PVLVMP_Operation_v35
This diagram shows logic of interlocks associated with commands of the PVLVMP instruction.
PVLVMP_interlocks_v35
Operator command request confirmation
The PVLVMP instruction enables these operator commands and settings:
  • OCmd_CleanCavity
  • OCmd_CleanLower
  • OCmd_CleanUpper
  • OCmd_Close
  • OCmd_LiftLower
  • OCmd_LiftUpper
  • OCmd_Open
Enforced security might require the request to be confirmed or canceled before the selected command executes or setting is accepted. The instruction checks the security rules by inspecting Cfg_CnfrmReqd. If Cfg_CnfrmReqd = 0, no confirmation is required and the request executes immediately. If Cfg_CnfrmReqd = 1, the instruction waits for operator confirmation or cancelation of the command. If Cfg_CnfrmReqd = 2 or 3, eSignature is needed before command confirmation is enabled.
Virtualization
Use virtualization for instruction testing and operator training. Command virtual operation using program command PCmd_Virtual or maintenance command MCmd_Virtual. After finishing virtual operation, use program command PCmd_Physical or maintenance command MCmd_Physical to return to normal physical device operation.
When Virtualization is active, the device outputs of the PVLVMP instruction hold at 0, virtual feedback of a working device is provided, and I/O faults are ignored. Manipulate the instruction to operate as if a working valve is present.
Initialization
The instruction is normally initialized in the instruction first run. Request re-initialization by setting Inp_InitializeReq = 1. For proper initialization, when adding the instruction while performing an online edit of the code, make sure that Inp_InitializeReq = 1, the default value.
Configuration of Strings for HMI
Configure strings for HMI faceplates, displayed in
FactoryTalk View
, and for the
Logix Designer
 configuration dialog box. The strings are set to extended properties of tag items.
  • Description
  • Label for graphic symbol
  • Display Library for HMI Faceplate call-up
  • Instruction name
  • Area name
  • URL link
  • Navigation to an object with more information
  • Name of Interlock Trip Alarm
  • Name of I/O Fault Alarm
  • Name of Fail Alarm
Command Source
The instruction uses these command sources. The command sources are prioritized in order from highest to lowest in this table.
Command Source
Description
Hand
Hardwired logic or other logic outside the instruction controls the device. The instruction tracks the state of the device for bumpless transfer back to one of the other command sources.
This is the highest priority command source.
Out-of-Service
The instruction is disabled. Outputs are de-energized. Valve commands from any source are discarded. On return to In Service, the valve is commanded closed.
Maintenance
Maintenance controls the device and supersedes Operator, Program, External and Override control. Operator commands and settings from the HMI are accepted.
Override
Priority logic controls the device and supersedes Operator, Program and External control. Override Input (Inp_Ovrd) is accepted.
External
External logic (for example, field pilot control or upstream SCADA) controls the device. External commands (XCmd_) are accepted.
Program locked
Program logic controls the device. Program commands (PCmd_) are accepted. Operator cannot take control from the Program. Override cannot take control from theProgram unless Cfg_OvrdOverLock = 1.
Program
Program logic controls the device. Program commands (PCmd_) are accepted.
Operator locked
The Operator controls the device. Operator commands (OCmd_) from the HMI are accepted. Program cannot take control from Operator. Override cannot take control from Operator unless Cfg_OvrdOverLock = 1.
Operator
The Operator controls the device. Operator commands (OCmd_) from the HMI are accepted.
This is the lowest priority command source.
The instruction enables or disables these operations:
  • Maintenance Out-of-Service exists
  • Maintenance exists
  • External exists
  • Program (unlocked) exists
  • Program locked exists
  • Operator (unlocked) exists
  • Operator locked exists
  • PCmd_Lock used as a Level (1 = Lock, 0 = Unlock)
The instruction checks for invalid configurations of control and forces the nearest valid configuration.
The core control model arbitrates the source of the commands and parameters that the receiving function accepts. The core control model determines if the source is:
  • A programmatic entity which resides entirely within the processing environment, or
  • An external interface entity which issues commands and parameters external and asynchronously to the processing environment.
Locking a control source prevents the other control source from acquiring privilege.
Core Command Source Model
The core control model consists of these control sources:
  • Oper
  • OperLocked
  • Prog
  • ProgLocked
The control model defaults to this configuration. Other control sources may be present in the model but act as overriding control sources, acting independent of the base Operator/Program state machine.
Enable control sources as Configuration
The user can enable and disable individual control sources. The default configuration uses the entire base model; upon power-up of the processing environment the control source will be the designated default. Some combinations of enabled control sources are disallowed as they are either unnecessary or could create unintended changes.
Prog Power Up
Configuration allows the user to specify whether Operator or Program is the power-up default.
Prog Priority
Configuration allows the user to specify whether Operator or Program commands take priority when simultaneously asserted.
Automatic reset of commands
All commands are treated as one-shot-latched. Commands are automatically cleared when the instruction executes and processes them.
Change Destination States
Under certain configurations the destination command source for some commands may change. This is in keeping with the intent of the command. For example, if the Program state is disabled, the destination of the OCmd_Prog command becomes the Program Locked state instead of the Program state. This maintains the intent of the OCmd_Prog command: the operator entity wishes to place the function in control of the program. If the command was eliminated there would be no way to accomplish this. This is only done in configurations where it would cause no conflict or race condition, but serves to preserve as much user functionality as is practical.
Higher Priority Command Sources
These Higher priority command sources operate independently within the model:
  • External
  • Override
  • Maintenance
  • Out-of-Service
  • In-Service
  • Hand
Monitor the PVLVMP Instruction
Use the operator faceplate from the PlantPAx library of Process objects for monitoring.
Affects Math Status Flags
No.
Major/Minor Faults
None specific to this instruction. See Index through arrays in the Logix 5000 General Instructions manual for array-indexing faults.
Execution
Ladder Diagram
Condition/State
Action Taken
Prescan
Any commands received before first scan are discarded. The device is de-energized.
Instruction first run
Any commands received before first scan are discarded. The device is commanded to the closed state.
Rung-condition-in is false
Handled the same as if the device is taken Out of Service by command. The device outputs are de-energized, and the device Command Source is shown as Program Out of Service on the HMI. All alarms are cleared. The rung-condition-out continues as false.
Rung-condition-in is true
Set rung-condition-out to rung-condition-in.
The instruction executes.
Postscan
Rung-condition-out is cleared to false.
Function Block Diagram
Condition/State
Action Taken
Prescan
Any commands received before first scan are discarded. The device is de-energized.
Instruction first run
Any commands received before first scan are discarded. The device is commanded to the closed state.
Instruction first scan
See instruction first run in the function block diagram table.
EnableIn is false
Handled the same as if the device is taken Out of Service by command. The device outputs are de-energized, and the device Command Source is shown as Program Out of Service on the HMI. All alarms are cleared. EnableOut is set to false.
EnableIn is true
EnableOut is set to true.
The instruction executes.
Postscan
EnableIn and EnableOut bits are cleared to false.
Structured Text
In Structured Text, EnableIn is always true during normal scan. Therefore, if the instruction is in the control path activated by the logic, it executes.
Condition/State
Action taken
Prescan
See Prescan in the Function Block Diagram table.
Instruction first run
See Instruction first run in the Function Block Diagram table.
EnableIn is true
See EnableIn is true in the Function Block Diagram table.
Postscan
See Postscan in the Function Block Diagram table.
Example
In this example, the PVLVMP instruction is used to implement a mix-proof valve feeding bulk material from a storage silo into a mixer. For this example, the mix-proof valve connects to the control system by using two inputs and three outputs. The valve state configurations are shown in these tables
State 0 (De-energized). Note: Close output is set for display purposes only:
Output
Feedback
State
Required
State
Close
1
0
0
Open
0
0
0
Lift lower seat
0
1
0
Lift upper seat
0
1
0
Cavity in
0
0
0
Cavity out
0
0
0
State 1 (Close):
Output
Feedback
State
Required
State
Close
0
0
0
Open
0
0
0
Lift lower seat
0
1
0
Lift upper seat
0
1
0
Cavity in
0
0
0
Cavity out
0
0
0
State 2 (Close cavity out):
Output
Feedback
State
Required
State
Close
0
0
0
Open
1
0
0
Lift lower seat
0
1
1
Lift upper seat
0
1
1
Cavity in
0
0
0
Cavity out
0
0
0
State 3 (Open):
Output
Feedback
State
Required
State
Close
0
0
0
Open
1
0
0
Lift lower seat
0
1
1
Lift upper seat
0
1
1
Cavity in
0
0
0
Cavity out
0
0
0
State 4 (Lift lower seat):
Output
Feedback
State
Required
State
Close
0
0
0
Open
0
0
0
Lift lower seat
1
1
1
Lift upper seat
0
1
0
Cavity in
0
0
0
Cavity out
0
0
0
State 5 (Lift upper seat):
Output
Feedback
State
Required
State
Close
0
0
0
Open
0
0
0
Lift lower seat
0
1
0
Lift upper seat
1
1
1
Cavity in
0
0
0
Cavity out
0
0
0
Ladder Diagram
PVLVMP_LDexample1_v35
PVLVMP_LDexample2_v35
Function Block Diagram
PVLVMP_FBDexample_v35
Structured Text
XV5047.Inp_LowerSeatLSData:=XV5047_ZSL
XV5047.Inp_UpperSeatLSData:=XV5047_ZSU
PVLVMP(XV5047, 0);
XV5047_OP:=XV5047.Out_OpenData;
XV5047_LL:=XV5047.Out_LiftLowerData;
XV5047_LU:=XV5047.Out_LiftUpperData;
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.