Process Proportional + Integral + Derivative (PPID)

Calculates CV with velocity PID algorithm. Velocity algorithm is also known as incremental algorithm. Velocity algorithm computes the CV value by summing
D
PTerm,
D
ITerm,
D
DTerm,
D
FF, and CV from the previous execution of the instruction. When Inp_UseCVPrev is set, CV previous is set equal to Inp_CVPrev. When Inp_UseFFPrev is set, previous FF is set equal to Inp_FFPrev. This lets you preset CV to a specified value before output CV value is computed, CV = CV previous +
D
PTerm +
D
ITerm +
D
DTerm +
D
FF. Velocity form of the PID algorithm supports bumpless transfer in parameter change.
Provides an option to suppress bumpless transfer in gain change. When this option is selected the PID calculation behaves as a position PID algorithm where control action changes with loop error and not error change.
Uses a two degrees of freedom PID formula for calculating CV with proportional PTerm action derived from weighted SP and PV difference (b*SP-PV), integral ITerm action derived from control error (SP-PV), and derivative DTerm action derived from change in weighted SP and PV difference (c*SP-PV). The change in weight setting in run-time is bumpless.
Uses an error-squared (option) algorithm with CV more aggressive when error rises. The use of error square is restricted to PTerm.
Provides Direct/Reverse action (option). The action is Direct when CV rises with PV increase (Cfg_CtrlAction=1). The action is Reverse if CV decreases with PV increase (Cfg_CtrlAction=0).
Allows deviation deadband. CV is not sensitive to loop error variation when within the band around zero error. Configured band levels allow for additional hysteresis. The deadband level for PV approaching SP (Cfg_DevDBEnter) may be set lower than deadband level for PV going away from SP (Cfg_DevDB). The active deadband status is set for PV within deadband. Provides an option to stop CV moves or just stop the integration while leaving proportional and derivative action live when in deadband (Cfg_UseIntegDevDB).
Displays engineering units on the
Logix Designer
application interface. SP and PV values are displayed and entered in PV engineering units. Val_CVSet for CV target and Val_CVOut for CV output are displayed and entered in CV engineering units. The PID algorithm uses all variables scaled to percent of span internally and these values are also available as outputs Val_PVPercent, Val_SPPercent, Val_EPercent, and Val_CVPercent.
Is configurable for Independent and Dependent gains. Interpretation of values stored in PGain, IGain and DGain tags depends on the instruction configuration.
Independent gains configuration: PGain = Kp … proportional gain, IGain = Ki … integral gain [1/minute], DGain = Kd … derivative gain [minutes].
Dependent gains configuration: PGain = K … controller gain, IGain = Ti … reset time [minutes], DGain = Td … rate time [minutes].
Use independent gains when you want the three gains for the proportional, integral, and derivative terms to operate independently. Use dependent gains when you want an overall controller gain that affects all three terms (P, I, and D).
Provides optional derivative smoothing (derivative limit at high frequencies). A pure derivative gives a very large amplification of measurement noise. Both dependent and independent PID algorithms can be configured for limiting the derivative term gain at high frequencies.
Guarantees anti-windup. The PID algorithm is equipped with integral (reset) windup prevention (reset feedback). Internal windup when CV saturates is treated automatically. External windup of the inner loop indicated by Inp_WindupHi or Inp_WindupLo is also treated if the inputs are in use.
Allows external CV tracking (option). When Cfg_UseCVTrack is set or the inner loop is not available for the PPID instruction (Inp_InnerAvailable is false), the CV tracks Inp_CVTrack value. The option is useful when the inner (secondary) loop in cascade is not able to follow CV value calculated by this outer (primary) loop PID, and Inp_WindupHi or Inp_WindupLo is either not used or not true. Tracking is allowed with configured dynamics specified in Cfg_CVTrackGain. CVTrackGain is treated as tracking gain Kt (1/minute) for independent or tracking time constant Tt (minutes) for dependent gains.
Provides configured SP clamping and ramping: clamping (in PVEU) and ramping (in PVEU/second) of the setpoint at specified limits (separate increase and decrease rate of change limits).
Provides configured CV clamping and ramping: clamping (in CVEU) and ramping (in CVEU/second) of CV at specified limits (separate increase and decrease rate of change limits).
Enables CV Hand feedback.
Supports operation from these command sources: Hand, Maintenance, Override, and full loop control (Cascade, Auto with Setpoint, Manual with CV) from External, Program, and Operator.
Supports three automatic (Auto, Cascade, Cascade/Ratio) loop modes and one manual (Manual) loop mode.
In Auto loop mode, setpoint (SP) in engineering units (PVEU) is read from the Program, Operator, Override or External entry. You can also enter a setpoint target in PV engineering units (PVEU) and ramp time (seconds) and use a command to trigger a built-in setpoint ramp.
In Manual loop mode the control variable (CV) in engineering units is read from the Program, Operator, Override, or External entry.
Monitors interlock conditions which cause output CV and SP to shed. CV shed can be configured to hold the last good CV value or to use the configured safe value. SP is shed to current PV.
Monitors I/O communication faults.
Supports Power-up and Initialize operations. In Power-up, the SP, CV, and Loop modes are set to configured values.
Monitors alarm conditions for Interlock Trip, Loop Failure, High-High Deviation, High Deviation, Low Deviation, and Low-Low Deviation from the setpoint.
High-High Deviation status is raised when the difference between the setpoint and the process variable calculated as PV-SP exceeds configured thresholds.
High Deviation status is raised when the difference between the setpoint and the process variable calculated as PV-SP exceeds configured thresholds.
Low Deviation status is raised when the difference between the setpoint and the process variable calculated as PV-SP exceeds configured thresholds.
Low-Low Deviation status is raised when the difference between the setpoint and the process variable calculated as PV-SP exceeds configured thresholds.
Loop Failure status is raised when the PPID indicates a severe configuration error, such as invalid clamping limits, scaling limits, and deadbands. This status is also raised when PV quality is not good enough for the PID loop to work with, and when the I/O Fault input/status is true. This status is also raised when the hand feedback input is reported bad in hand.
Interlock Trip status is raised when an interlock not-OK condition causes the output CV to be changed to the configured Interlock CV value or held at its last value. 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.

Operand	Type	Format	Description
PlantPAx Control	P_PID	tag	Data structure required for proper operation of instruction.
BusObj	BUS_OBJ	tag	Bus component. May be null.

Public input member	Data Type	Default Value	Description
EnableIn	BOOL	True	Enable input. Ladder Diagram: Corresponds to the rung condition. Default is true.
Inp_InitializeReq	BOOL	True	1 = Request to initialize the instruction. The instruction is normally initialized in instruction first run. Use this request to re-initialize. When Inp_InitializeReq = 1, power up configuration values are used. The instruction clears this operand automatically. Default is true.
Inp_OwnerCmd	DINT	0	Owner device command: 0 = None, Inp_OwnerCmd.10 = Operator Lock, Inp_OwnerCmd.11 = Operator Unlock, Inp_OwnerCmd.12 = Program Lock, Inp_OwnerCmd.13 = Program Unlock, Inp_OwnerCmd.14 = Acquire Maintenance, Inp_OwnerCmd.15 = Release Maintenance, Inp_OwnerCmd.16 = Acquire External, Inp_OwnerCmd.17 = Release External, Inp_OwnerCmd.29 = Echo. Default is 0.
Inp_PV	REAL	0.0	Process Variable (PVEU). Valid any float. Default is 0.0.
Inp_CascSP	REAL	0.0	SP in Cascade loop mode, independent PV in Ratio loop mode (PVEU). Valid any float. Default is 0.0.
Inp_FF	REAL	0.0	FeedForward term (CVEU). Valid any float between -(Cfg_CVEUMax-Cfg_CVEUMin) and (Cfg_CVEUMax-Cfg_CVEUMin). Default is 0.0.
Inp_FFPrev	REAL	0.0	Previous scan FeedForward (CVEU) when Inp_UseFFPrev = 1. Valid any float between -(Cfg_CVEUMax-Cfg_CVEUMin) and (Cfg_CVEUMax-Cfg_CVEUMin). Default is 0.0.
Inp_CVTrack	REAL	0.0	CV to track if Cfg_UseCVTrack = 1 or if Inp_InnerAvailable = 0 (CVEU). Valid any float. Default is 0.0.
Inp_CVInitialVal	PVREAL	0.0	Value to initialize the CV to per request Inp_UseCVInitialVal=1 (CVEU). Valid any float. Default is 0.0.
Inp_CVPrev	REAL	0.0	Previous scan CV, Val_CVOut (CVEU). Valid any float between Cfg_CVEUMin and Cfg_CVEUMax. Default is 0.0.
Inp_UseFFPrev	BOOL	False	1 = Use Inp_FFPrev as previous FF value, 0 = Use last scan Inp_FF value as previous FF value. Default is false.
Inp_UseCVInitialVal	BOOL	False	1 = Initialize CV to Inp_CVInitialVal. Default is false.
Inp_UseCVPrev	BOOL	False	1 = Use Inp_CVPrev as previous CV value, 0 = Use last scan value. Default is false.
Inp_WindupHi	BOOL	False	Windup high signal. When true, the CV cannot integrate in a positive direction. The signal is typically obtained from the Windup hi output from a inner loop. Default is false.
Inp_WindupLo	BOOL	False	Windup low signal. When true, the CV cannot integrate in a negative direction. The signal is typically obtained from the Windup low output from a inner loop. Default is false.
Inp_InnerAvailable	BOOL	True	1 = Inner loop is available. 0 = Inner loop is not available, PPID tracks Inp_CVTrack, typically inner loop SP or actuator position. Default is true.
Inp_IntlkOK	BOOL	True	1 = Bypassable interlocks OK, CV can be set. Default is true.
Inp_NBIntlkOK	BOOL	True	1 = Non-Bypassable interlocks OK, CV can be set. Default is true.
Inp_IntlkAvailable	BOOL	False	1 = Interlock availability OK. Default is false.
Inp_IntlkTripInh	BOOL	False	1 = Inhibit interlock trip status. Default is false.
Inp_RdyReset	BOOL	False	1 = Related object, reset by this object, is ready to be reset. Ready for ORdy_Reset, enables HMI button. Default is false.
Inp_CVIOFault	BOOL	False	1 = CV I/O communications status bad, 0 = OK. Default is false.
Inp_PVBad	BOOL	False	1 = PV quality or PV I/O communications status bad, 0 = OK. Default is false.
Inp_PVUncertain	BOOL	False	1 = PV value not reliable, 0 = OK. Default is false.
Inp_PVSrcQ	SINT	0	Inp_PV source status and quality: 0 = Good, live, confirmed good, 1 = Good, live, assumed good, 2 = Good, no feedback, assumed good, 8 = Test, simulated, 9 = Test, loopback, 10 = Test, manually entered, 16 = Uncertain, live, off-spec, 17 = Uncertain, substituted at device, 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/communications fault, 35 = Bad, invalid configuration. Default is 0.
Inp_PVNotify	SINT	0	Related PV object alarm priority and acknowledgement 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. Default is 0.
Inp_CVNotify	SINT	0	Related CV object alarm priority and acknowledgement 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. Default is 0.
Inp_CascSPNotify	SINT	0	Related Cascade SP object alarm priority and acknowledgement 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. Default is 0.
Inp_HiHiDevGate	BOOL	True	The gate input used for HiHi deviation status detection: 1 = The corresponding analog input threshold monitoring is enabled, 0 = Detection is disabled and the corresponding status output is forced off. Default is true.
Inp_HiDevGate	BOOL	True	The gate input used for Hi deviation status detection: 1 = The corresponding analog input threshold monitoring is enabled, 0 = Detection is disabled and the corresponding status output is forced off. Default is true.
Inp_LoDevGate	BOOL	True	The gate input used for Lo deviation status detection: 1 = The corresponding analog input threshold monitoring is enabled, 0 = Detection is disabled and the corresponding status output is forced off. Default is true.
Inp_LoLoDevGate	BOOL	True	The gate input used for LoLo deviation status detection: 1 = The corresponding analog input threshold monitoring is enabled, 0 = Detection is disabled and the corresponding status output is forced off. Default is true.
Inp_Hand	BOOL	False	1 = Acquire Hand, 0 = Release Hand. Default is false.
Inp_HandFdbk	REAL	0.0	CV feedback used when owner is Hand (CVEU). Valid any float. Default is 0.0. Default is false.
Inp_HandFdbkBad	BOOL	False	1 = CV hand feedback quality or CV hand feedback I/O communications status bad, 0 = OK. Default is false.
Inp_Ovrd	BOOL	False	1 = Acquire Override (higher priority program logic), 0 = Release Override. Default is false.
Inp_OvrdCmd	SINT	0	Loop mode command in Override: 0 = None, 1 = Manual, 2 = Auto, 3 = Cascade, 4 = Normal, 5 = Start SP ramp, 6 = Stop SP ramp. Default is 0.
Inp_OvrdSP	REAL	0.0	Loop Auto SP in Override (PVEU). Valid any float. Default is 0.0.
Inp_OvrdSPTarget	REAL	0.0	Override setting for SP target in ramp wizard (PVEU). Valid any float. Default is 0.0.
Inp_OvrdSPRampTime	REAL	0.0	Override setting for time to reach SP target in ramp wizard (seconds). Valid = 0.0 to 28800.0 seconds. Default is 0.0.
Inp_OvrdRatio	REAL	1.0	Loop Ratio in Override (unitless). Valid = 0.0 to maximum positive float. Default is 1.0.
Inp_OvrdCV	REAL	0.0	Loop Manual CV in Override (CVEU). Valid any float. Default is 0.0.
Inp_ExtInh	BOOL	False	1 = Inhibit External acquisition, 0 = Allow External acquisition. Default is false.
Inp_Reset	BOOL	False	1 = Reset shed latches and latched alarms whose conditions have returned to normal. Default is false.
Cfg_AllowDisable	BOOL	True	1 = Allow Maintenance to disable alarms. Default is true.
Cfg_AllowShelve	BOOL	True	1 = Allow Operator to shelve alarms.
Cfg_HasRatio	BOOL	False	1 = Cascade loop mode is Ratio, 0 = Cascade loop mode is Cascade. Default is false.
Cfg_HasCasc	BOOL	False	1 = Enable the loop to be placed into Cascade/Ratio mode. Default is false.
Cfg_HasAuto	BOOL	True	1 = Enable the loop to be placed into Auto mode. Default is true.
Cfg_HasMan	BOOL	True	1 = Enable the loop to be placed into Manual mode. Default is true.
Cfg_HasSPRamp	BOOL	False	1 = Enable the SP ramp wizard function. Default is false.
Cfg_ExecTime	REAL	0.0	Execution period for PID algorithm (second). Configuring the instruction for execution period = 0.0 (default) or period shorter than instruction scan time has no effect and the PID algorithm executes every scan. For the real execution period check Val_ExecTime. Valid = 0.0 to 2147483.0 seconds. Default is 0.0.
Cfg_PGain	REAL	0.0	Proportional gain Kp for independent gains or loop gain Kc for dependent gains (unitless). Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_IGain	REAL	0.0	Integral gain Ki (1/minute) for independent or reset time Ti (minutes/repeat) for dependent gains. Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_DGain	REAL	0.0	Derivative gain Kd (minute) for independent or rate time Td (minute) for dependent gains. Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_CVTrackGain	REAL	0.0	Tracking gain Kt (1/minute) for independent or tracking time constant Tt (minutes) for dependent gains for CV to track Inp_CVTrack if Cfg_UseCVTrack = 1. Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_UseCVTrack	BOOL	False	1 = Use Inp_CVTrack reset feedback in tracking, e.g. if PPID output is significantly faster than actuator or inner loop or in override select control.
Cfg_PSPWeight	REAL	1.0	Weight on SP in proportional term in 2DOF PID, beta gain. Valid = 0.0 to 1.5. Default is 1.0.
Cfg_DSPWeight	REAL	0.0	Weight on SP in derivative term in 2DOF PID, gamma gain. Valid = 0.0 to 1.5. Default is 0.0.
Cfg_PVTrack	BOOL	False	1 = SP tracks PV in Manual, 0 = No PV tracking. Default is false.
Cfg_GainBumpless	BOOL	True	1 = CV response to PGain and DGain change is bumpless, 0 = CV response to PGain and DGain change is not bumpless (like in position algorithm). Default is true.
Cfg_PositionBump	BOOL	False	1 = Position form of PD algorithm without bumpless transfer from Manual to Auto or Cascade. Enabled only when Cfg_IGain = 0. Change of proportional gain is not bumpless. 0 = Velocity form of PID algorithm with bumpless transfer from Manual to Auto or Cascade. Default is false.
Cfg_UseESquared	BOOL	False	1 = Use error squared for proportional action. Default is false.
Cfg_CtrlAction	BOOL	False	1 = Control action on E = PV-SP, direct action 0 = Control action on E = SP-PV, reverse action. Default is false.
Cfg_Dependent	BOOL	False	1 = Dependent gains equation, 0 = Independent gains equation. Default is false.
Cfg_UseDSmoothing	BOOL	False	1 = Use derivative smoothing. Default is false.
Cfg_DevDB	REAL	0.0	PV deviation deadband for PV going away from SP (PVEU). Valid = 0.0 to maximum positive float.
Cfg_DevDBEnter	REAL	0.0	PV deviation deadband for PV approaching SP (PVEU). Valid = 0.0 to Cfg_DevDB.
Cfg_UseIntegDevDB	BOOL	False	1 = Only integral term is suspended when PV deviation deadband status is active, proportional and derivative terms remain operational, 0 = All PID terms are suspended and CV does not move when PV deviation deadband status is active. Default is false.
Cfg_SkipCVManLim	BOOL	True	1 = Skip CV clamping in Manual loop mode and for CV from shed, 0 = Always apply CV clamping.
Cfg_SkipCVManRoC	BOOL	True	1 = Skip CV rate-of-change limiting in Manual loop mode and for CV from shed, 0 = Always apply CV rate-of-change limiting.
Cfg_InitializeToMan	BOOL	False	1 = Go to Manual loop mode when initialization is requested (Inp_UseCVInitialVal=1). Default is false.
Cfg_SetTrack	BOOL	True	1 = Program/Operator/External settings tracking, 0 = No settings tracking. Default is true.
Cfg_SetTrackOvrdHand	BOOL	False	1 = Program/Operator/External settings track Override/Hand inputs (CV, SP, Ratio). Default is false.
Cfg_HasIntlkObj	BOOL	False	1 = Tells HMI an interlock object (PINTLK) is connected to Inp_IntlkOK, InpNBIntlkOK, Inp_IntlkAvailable, Inp_IntlkTripInh and Inp_RdyReset. Default is false.
Cfg_HasMoreObj	BOOL	False	1 = Tells HMI an object with more info is available. Default is false.
Cfg_HasHistTrend	SINT	0	Has historical trend. This enables navigation to the device historical trend faceplate from the HMI. 0 = No external historical trend, 1 = Datalog historical trend, 2 = Historian historical trend. Default is 0.
Cfg_HasCascSPNav	BOOL	False	1 = Tells HMI to enable navigation to a connected cascade SP object. Default is false.
Cfg_HasPVNav	BOOL	False	1 = Tells HMI to enable navigation to a connected PV object. Default is false.
Cfg_HasCVNav	BOOL	False	1 = Tells HMI to enable navigation to a connected CV object. Default is false.
Cfg_HasOper	BOOL	True	1 = Operator (unlocked) exists, can be selected. Default is true.
Cfg_HasOperLocked	BOOL	True	1 = Operator Locked exists, can be selected. Default is true.
Cfg_HasProg	BOOL	True	1 = Program (unlocked) exists, can be selected. Default is true.
Cfg_HasProgLocked	BOOL	True	1 = Program Locked exists, can be selected. Default is true.
Cfg_HasExt	BOOL	False	1 = External exists, can be selected. Default is false.
Cfg_HasMaint	BOOL	True	1 = Maintenance exists, can be selected. Default is true.
Cfg_HasMaintOoS	BOOL	True	1 = Maintenance Out of Service exists, can be selected. Default is true.
Cfg_OvrdOverLock	BOOL	True	1 = Override supersedes Program/Operator Lock, 0 = Do not override Lock. Default is true.
Cfg_ExtOverLock	BOOL	False	1 = External supersedes Program/Operator Lock, 0 = Do not override Lock. Default is false.
Cfg_eKeepLM	SINT	0	Loop mode ownership: 0 = Follows command source, 1 = Operator, 2 = Program, 3 = External. Default is 0.
Cfg_eKeepCV	SINT	0	CV ownership: 0 = Follows command source, 1 = Operator, 2 = Program, 3 = External. Default is 0.
Cfg_eKeepSP	SINT	0	SP ownership: 0 = Follows command source, 1 = Operator, 2 = Program, 3 = External. Default is 0.
Cfg_eKeepRatio	SINT	0	Ratio ownership: 0 = Follows command source, 1 = Operator, 2 = Program, 3 = External. Default is 0.
Cfg_ProgPwrUp	BOOL	False	1 = Power up to Program, 0 = Power up to Operator. Default is false.
Cfg_ProgNormal	BOOL	False	Normal source: 1 = Program if no requests, 0 = Operator if no requests. Default is false.
Cfg_PCmdPriority	BOOL	False	Command priority: 1 = Program commands win, 0 = Operator commands win. Default is false.
Cfg_PCmdProgAsLevel	BOOL	False	1 = PCmd_Prog used as Level (1 = Prog, 0 = Oper). Default is false.
Cfg_PCmdLockAsLevel	BOOL	False	1 = PCmd_Lock used as Level (1 = Lock, 0 = Unlock). Default is false.
Cfg_ExtAcqAsLevel	BOOL	False	1 = XCmd_Acq used as Level (XCmd_Acq = 1 acquire external command, XCmd_Acq = 0 release external command). Default is false.
Cfg_OvrdIntlk	BOOL	False	1 = Override bypasses (ignores) bypassable interlocks. 0 = Override abides by all interlock conditions. Default is false.
Cfg_SPFailLatch	BOOL	False	1 = Latch in SP fail shed action until Reset, 0 = Return when SP is good. Default is false.
Cfg_PVFailLatch	BOOL	False	1 = Latch in PV fail shed action until Reset, 0 = Return when PV is good. Default is false.
Cfg_CVFailLatch	BOOL	False	1 = Latch in CV fail shed action until Reset, 0 = Return when CV is good. Default is false.
Cfg_LockLM	BOOL	False	Lock loop mode: 1 = Locked in loop mode configured as Normal (see Cfg_NormLM), 0 = Not locked. Default is false.
Cfg_NormLM	SINT	1	Loop mode defined as Normal: 0 = Disable Normal selection, 1 = Manual, 2 = Auto, 3 = Cascade. Default is 1.
Cfg_PwrUpLM	SINT	4	Loop mode defined for Powerup: 0 = No change - loop mode, CV and SP are initialized using last (powerdown) values, 1 = Manual, 2 = Auto, 3 = Cascade, 4 = Normal. Default is 4.
Cfg_PVFailTrigger	SINT	1	PV fail status response on PV quality: 0 = PV fail response on Inp_PVBad OR Inp_PVSrcQ >= 32 (PV bad), 1 = PV fail response on Inp_PVBad OR Inp_PVSrcQ >= 17 AND Inp_PVSrcQ <> 18, 2 = PV fail response on Inp_PVBad OR Inp_PVUncertain OR Inp_PVSrcQ >= 16 AND Inp_PVSrcQ <> 18. Default is 1.
Cfg_IntlkTripSPAction	SINT	0	Interlock Trip SP action: 0 = None, 1 = Hold last good, 2 = Use Cfg_SPIntlk, 3 = Set SP to current PV. Default is 0.
Cfg_SPFailSPAction	SINT	1	SP Fail SP action: 1 = Hold last good, 2 = Use Cfg_SPIntlk, 3 = Set SP to current PV. Default is 1.
Cfg_PVFailSPAction	SINT	0	PV Fail SP action: 0 = None, 1 = Hold last good, 2 = Use Cfg_SPIntlk. Default is 0.
Cfg_CVFailSPAction	SINT	0	CV Fail SP action: 0 = None, 1 = Hold last good, 2 = Use Cfg_SPIntlk, 3 = Set SP to current PV. Default is 0.
Cfg_IntlkTripCVAction	SINT	2	Interlock trip CV action: 0 = None, 1 = Hold last good, 2 = Use Cfg_CVIntlk. Default is 2.
Cfg_SPFailCVAction	SINT	1	SP Fail CV action: 0 = None, 1 = Hold last good, 2 = Use Cfg_CVIntlk. Default is 1.
Cfg_PVFailCVAction	SINT	1	PV Fail CV action: 1 = Hold last CV, 2 = Use Cfg_CVIntlk. Default is 1.
Cfg_CVFailCVAction	SINT	1	CV Fail CV action: 1 = Hold last good, 2 = Use Cfg_CVIntlk. Default is 1.
Cfg_IntlkTripLMAction	SINT	0	Interlock trip loop mode action: 0 = None, 1 = Manual only, 2 = Auto or Manual only. Default is 0.
Cfg_SPFailLMAction	SINT	0	SP Fail loop mode action: 0 = None, 1 = Manual only, 2 = Auto or Manual only. Default is 0.
Cfg_PVFailLMAction	SINT	0	PV Fail loop mode action: 0 = none, 1 = Manual only, 2 =Auto or Manual only. Default is 0.
Cfg_CVFailLMAction	SINT	0	CV Fail loop mode action: 0 = None, 1 = Manual only, 2 = Auto or Manual only. Default is 0.
Cfg_PVDecPlcs	SINT	2	Number of decimal places for display of PV / SP (up to six). Default is 2.
Cfg_CVDecPlcs	SINT	2	Number of decimal places for display of CV (up to six). Default is 2.
Cfg_RatioDecPlcs	SINT	2	Number of decimal places for display of Ratio (up to six). Default is 2.
Cfg_RatioLoLim	REAL	0.0	Minimum allowed Ratio value (unitless). Valid any float less than or equal to Cfg_RatioHiLim. Default is 0.0.
Cfg_RatioHiLim	REAL	1.0	Maximum allowed Ratio value (unitless). Valid any float greater than or equal to Cfg_RatioLoLim. Default is 1.0.
Cfg_SPLoLim	REAL	0.0	Minimum allowed SP value (PVEU). Valid any float less than or equal to Cfg_SPHiLim and greater than or equal to Cfg_PVEUMin. Default is 0.0.
Cfg_SPHiLim	REAL	100.0	Maximum allowed SP value (PVEU). Valid any float greater than or equal to Cfg_SPLoLim and less than or equal to Cfg_PVEUMax. Default is 100.0.
Cfg_SPRoCIncrLim	REAL	0.0	Maximum allowed SP rate of change increasing value (PVEU/second). The SP rate of change is unlimited when increasing if Cfg_SPRoCIncrLim = 0.0. Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_SPRoCDecrLim	REAL	0.0	Maximum allowed SP rate of change decreasing value (PVEU/second). The SP rate of change is unlimited when decreasing if Cfg_SPRoCDecrLim = 0.0. Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_SkipSPRoCLim	BOOL	False	1 = Skip setpoint RoC limiting in interlock, maintenance and override. Default is false.
Cfg_SPRampMaxDev	REAL	100.0	If absolute value of deviation exceeds this value, pause SP ramp, 0.0 = Never pause (PVEU). Valid = 0.0 to maximum positive float. Default is 100.0.
Cfg_PVEUMin	REAL	0.0	PV minimum value for scaling from engineering units to %, PV at 0% (PVEU). Valid any float less than Cfg_PVEUMax. Default is 0.0.
Cfg_PVEUMax	REAL	100.0	PV maximum value for scaling from engineering units to %, PV at 100% (PVEU). Valid any float greater than Cfg_PVEUMin. Default is 100.0.
Cfg_CVEUMin	REAL	0.0	CV minimum value for scaling from % to engineering units (CVEU). Valid any float less than Cfg_CVEUMax. Default is 0.0.
Cfg_CVEUMax	REAL	100.0	CV maximum value for scaling from % to engineering units (CVEU). Valid any float greater than Cfg_CVEUMin.
Cfg_CVLoLim	REAL	0.0	Minimum allowed CV value (CVEU). Valid any float less than or equal to Cfg_CVHiLim and greater than or equal to Cfg_CVEUMin. Default is 0.0.
Cfg_CVHiLim	REAL	100.0	Maximum allowed CV value (CVEU). Valid any float greater than or equal to Cfg_CVLoLim and less than or equal to Cfg_CVEUMax. Default is 100.0.
Cfg_CVRoCIncrLim	REAL	0.0	Maximum allowed CV rate of change increasing value (CVEU/second). The CV rate of change is unlimited when increasing if Cfg_CVRoCIncrLim = 0.0 Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_CVRoCDecrLim	REAL	0.0	Maximum allowed CV rate of change decreasing value (CVEU/second). The CV rate of change is unlimited when decreasing if Cfg_CVRoCDecrLim = 0.0. Valid = 0.0 to maximum positive float. Default is 0.0.
Cfg_MaxInactiveCV	REAL	0.0	When Val_CVOut is greater than this value, set Sts_Active for HMI (CVEU). Valid any float. Default is 0.0.
Cfg_SPIntlk	REAL	0.0	SP value to use with interlock / bad value SP action (PVEU). Valid any float between Cfg_PVEUMin and Cfg_PVEUMax.
Cfg_CVIntlk	REAL	0.0	CV value to use with interlock / bad value CV action (CVEU). Valid any float between Cfg_CVEUMin and Cfg_CVEUMax.
Cfg_SPPwrUp	REAL	0.0	Loop SP on Powerup (PVEU) used when Cfg_PwrUpLM is not 0. The value is clamped to the SP range (Cfg_SPLoLim, Cfg_SPHiLim). Valid any float between Cfg_PVEUMin and Cfg_PVEUMax.
Cfg_CVPwrUp	REAL	0.0	Loop CV on Powerup (CVEU) used when Cfg_PwrUpLM is not 0. Value may be clamped to the configured limits (Cfg_CVLoLim, CfgHiLim) in cascade or auto, and in manual if so configured. Valid any float between Cfg_CVEUMin and Cfg_CVEUMax.
Cfg_CVPwrUpSel	SINT	0	Selection of Powerup (first run) CV in Auto or Cascade. 0 = Ignore Inp_InnerAvailable and always use Cfg_CVPwrUp or last (Powerdown) CV (if Cfg_PwrpUpLM = 0), 1 = Process Inp_InnerAvailable. Default is false.
Cfg_HiHiDevLim	REAL	1.5e+38	High-High PV deviation status threshold (PVEU). Valid = 0.0 to maximum positive float. Default is 1.5e+38.
Cfg_HiHiDevDB	REAL	0.0	High-High PV deviation status deadband (PVEU). Valid = 0.0 to Cfg_HiHiDevLim. Default is 0.0.
Cfg_HiHiDevGateDly	REAL	0.0	High-High PV deviation status gate delay (second). Valid = 0.0 to 2147483.0 seconds. Default is 0.0.
Cfg_HiDevLim	REAL	1.5e+38	High PV deviation status threshold (PVEU). Valid = 0.0 to maximum positive float. Default is 1.5e+38.
Cfg_HiDevDB	REAL	0.0	High PV deviation status deadband (PVEU). Valid = 0.0 to Cfg_HiDevLim. Default is 0.0.
Cfg_HiDevGateDly	REAL	0.0	High PV deviation status gate delay (second). Valid = 0.0 to 2147483.0 seconds. Default is 0.0.
Cfg_LoDevLim	REAL	-1.5e+38	Low PV deviation status threshold (PVEU). Valid = -maximum positive float to 0.0. Default is -1.5e+38.
Cfg_LoDevDB	REAL	0.0	Low PV deviation status deadband (PVEU). Valid = 0.0 to abs(Cfg_LoDevLim). Default is 0.0.
Cfg_LoDevGateDly	REAL	0.0	Low PV deviation status gate delay (second). Valid = 0.0 to 2147483.0 seconds. Default is 0.0.
Cfg_LoLoDevLim	REAL	-1.5e+38	Low-Low PV deviation status threshold (PVEU). Valid = -maximum positive float to 0.0. Default is -1.5e+38.
Cfg_LoLoDevDB	REAL	0.0	Low-Low PV deviation status deadband (PVEU). Valid = 0.0 to abs(Cfg_LoLoDevLim). Default is 0.0.
Cfg_LoLoDevGateDly	REAL	0.0	Low-Low PV deviation status gate delay (second). Valid = 0.0 to 2147483.0 seconds. Default is 0.0.
Cfg_CnfrmReqd	SINT	0	Operator command confirmation required. Represents the type of command confirmation required. 0 = None, 1 = Command confirmation required, 2 = Performer e-signature required, 3 = Performer and approver e-signature required. Default is 0.
PSet_Ratio	REAL	1.0	Program setting for Ratio, loop mode Cascade/Ratio and Ratio enabled (unitless). Valid = 0.0 to maximum positive float. Default is 1.0.
PSet_SP	REAL	0.0	Program setting for SP, loop mode Auto (PVEU). Valid any float. Default is 0.0.
PSet_SPTarget	REAL	0.0	Program setting for SP target in ramp wizard (PVEU). Valid any float. Default is 0.0.
PSet_SPRampTime	REAL	0.0	Program setting for time to reach SP target in ramp wizard (second). Valid = 0.0 to 28800.0 seconds. Default is 0.0.
PSet_CV	REAL	0.0	Program setting for CV when loop mode is Manual (CVEU). Valid any float. Default is 0.0.
PSet_Owner	DINT	0	Program owner request ID (non-zero) or release (zero). Default is 0.
XSet_Ratio	REAL	1.0	External setting for Ratio, loop mode Cascade/Ratio and Ratio enabled (unitless). Valid = 0.0 to maximum positive float. Default is 1.0.
XSet_SP	REAL	0.0	External setting for SP, loop mode Auto (PVEU). Valid any float. Default is 0.0.
XSet_SPTarget	REAL	0.0	External setting for SP target in ramp wizard (PVEU). Valid any float. Default is 0.0.
XSet_SPRampTime	REAL	0.0	External setting for time to reach SP target in ramp wizard (seconds). Valid = 0.0 to 28800.0 seconds. Default is 0.0.
XSet_CV	REAL	0.0	External setting for CV, loop mode Manual (CVEU). Valid any float. Default is 0.0.
PCmd_Casc	BOOL	False	Program command to select Cascade/Ratio loop mode. The instruction clears this operand automatically. Default is false.
PCmd_Auto	BOOL	False	Program command to select Auto loop mode. The instruction clears this operand automatically. Default is false.
PCmd_Man	BOOL	False	Program command to select Manual loop mode. The instruction clears this operand automatically. Default is false.
PCmd_NormLM	BOOL	False	Program command to select loop mode defined as Normal, see Cfg_NormLM. The instruction clears this operand automatically. Default is false.
PCmd_SPRampStart	BOOL	False	Program command to initiate SP ramping. The instruction clears this operand automatically. Default is false.
PCmd_SPRampStop	BOOL	False	Program command to stop SP ramping. The instruction clears this operand automatically. Default is false.
PCmd_Oper	BOOL	False	Program command to select Operator (Program to Operator). The instruction clears this operand automatically. Default is false.
PCmd_Prog	BOOL	False	Program command to select Program (Operator to Program). The instruction clears this operand automatically. Default is false.
PCmd_Lock	BOOL	False	Program command to lock Program (disallow Operator). The instruction clears this operand automatically if Cfg_PCmdLockAsLevel = 0. Default is false.
PCmd_Unlock	BOOL	False	Program command to unlock Program (allow Operator to acquire). The instruction clears this operand automatically. Default is false.
PCmd_Normal	BOOL	False	Program command to select Normal command source (Operator or Program). The instruction clears this operand automatically. Default is false.
PCmd_Reset	BOOL	False	Program command to reset all alarms and latched shed conditions requiring reset. The instruction clears this operand automatically. Default is false.
XCmd_Casc	BOOL	False	External command to select Cascade/Ratio loop mode. The instruction clears this operand automatically. Default is false.
XCmd_Auto	BOOL	False	External command to select Auto loop mode. The instruction clears this operand automatically. Default is false.
XCmd_Man	BOOL	False	External command to select Manual loop mode. The instruction clears this operand automatically. Default is false.
XCmd_NormLM	BOOL	False	External command to select loop mode defined as Normal, see Cfg_NormLM. The instruction clears this operand automatically. Default is false.
XCmd_SPRampStart	BOOL	False	External command to initiate SP ramping. The instruction clears this operand automatically. Default is false.
XCmd_SPRampStop	BOOL	False	External command to stop SP ramping. The instruction clears this operand automatically. Default is false.
XCmd_Acq	BOOL	False	External command to acquire ownership (Operator/Program/Override/Maintenance to External). The instruction clears this operand automatically if Cfg_ExtAcqAsLevel = 0. Default is false.
XCmd_Rel	BOOL	False	External command to release ownership if Cfg_ExtAcqAsLevel = 0 (External to Operator/Program/Override/Maintenance). The instruction clears this operand automatically. Default is false.
XCmd_Reset	BOOL	False	External command to reset all alarms and latched shed conditions. The instruction clears this operand automatically. Default is false.
XCmd_ResetAckAll	BOOL	False	External command to acknowledge and reset all alarms and latched shed conditions. The instruction clears this operand automatically. Default is false.

Public output member	Data Type	Description
EnableOut	BOOL	Enable output. This output state always reflects EnableIn input state.
Val_PV	REAL	Value of loop PV (PVEU).
Val_Ratio	REAL	Value of loop Ratio (unitless).
Val_SPSet	REAL	Value of selected SP after clamping and before ramping (PVEU).
Val_SP	REAL	Value of SP being used after clamping and ramping (PVEU).
Val_SPTarget	REAL	Accepted setting for SP ramp target, endpoint for ramp wizard (PVEU).
Val_SPRampTime	REAL	Accepted setting for SP ramp time, time to reach target for ramp wizard (second).
Val_SPRampRoC	REAL	Calculated value of SP rate of change for ramping, from ramp wizard (PVEU/second).
Val_SPRoCIncr	REAL	Current value of SP rate of change limit increasing (PVEU/second). 0.0 = rate of change not limited.
Val_SPRoCDecr	REAL	Current value of SP rate of change limit decreasing (PVEU/second). 0.0 = rate of change not limited.
Val_E	REAL	Loop error, SP-PV for reverse action Cfg_CtrlAction = 0, PV-SP for direct action Cfg_CtrlAction = 1 (PVEU).
Val_CVSet	REAL	Loop CV after clamping and before ramping (CVEU).
Val_CVOut	REAL	Loop CV after clamping and ramping (CVEU).
Val_PVPercent	REAL	Loop PV (percent of span).
Val_SPPercent	REAL	Loop SP (percent of span).
Val_EPercent	REAL	Loop error, SP-PV for reverse action Cfg_CtrlAction = 0, PV-SP for direct action Cfg_CtrlAction = 1 (percent of span).
Val_CVOutPercent	REAL	Loop CV after ramping and clamping (percent of span).
Val_ExecTime	REAL	Actual PID algorithm execution period (second).
Out_Reset	BOOL	1 = Reset command has been received and accepted.
Out_OwnerSts	DINT	Status of command source, owner command handshake and ready status: 0 = 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	1 = Instruction is initialized. Use Inp_InitializeReq to reinitialize.
SrcQ_IO	SINT	Source and quality of primary I/O PV quality (enumerated): 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	Source and quality of primary PV and CV value or status (enumerated): 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_eSts	SINT	Loop mode: 0 = Unknown, 1 = Manual, 2 = Auto, 3 = Cascade (no Ratio), 4 = Ratio.
Sts_eFault	SINT	Loop fault: 0 = none, 1 = PV uncertain, 2 = Low PV deviation, 3 = High PV deviation, 4 = Low-Low PV deviation, 5 = High-High PV deviation, 6 = PV substituted, 7 = Interlock trip, 8 = SP fail, 9 = PV fail, 10 = CV fail, 11 = Configuration error.
Sts_eState	SINT	Internal logic state for animating state diagram on faceplate. 0 = Manual, 1 = PV deviation in deadband, 2 = PV deviation not in deadband, 3 = SP ramping, 4 = CV ramping, 5 = Ratio clamped, 6 = SP clamped, 7 = CV clamped, 8 = Windup Lo, 9 = Windup Hi, 10 = SP held, 11 = SP set to IntlkSP, 12 = CV held, 13 = CV set to IntlkCV, 14 = Hand, 15 = Initializing.
Sts_eNotify	SINT	Highest severity alarm status. All alarm status enumerated values: 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	Highest severity alarm status. All alarm status enumerated values including related objects for CV, PV, SP, CascSP: 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_eNotifyHiHiDev	SINT	High-High PV deviation alarm status enumerated values: 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_eNotifyHiDev	SINT	High PV deviation alarm status enumerated values: 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_eNotifyLoDev	SINT	Low PV deviation alarm status enumerated values: 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_eNotifyLoLoDev	SINT	Low-Low PV deviation alarm status enumerated values: 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	Fail alarm status enumerated values: 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	Interlock trip alarm status enumerated values: 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	DINT	Count of unacknowledged alarms.
Sts_Casc	BOOL	1 = Loop is in Cascade/Ratio mode.
Sts_Auto	BOOL	1 = Loop is in Auto mode.
Sts_Man	BOOL	1 = Loop is in Manual mode.
Sts_NormLM	BOOL	1 = Loop is in Normal loop mode configured in Cfg_NormLM.
Sts_Initializing	BOOL	1 = CV is initializing because of request Inp_UseCVInitialVal or when Inp_InnerAvailable=0.
Sts_WindupHi	BOOL	1 = This loop winding up High, usually connects to Inp_WindupHi of outer loop.
Sts_WindupLo	BOOL	1 = This loop winding up Low, usually connects to Inp_WindupLo of outer loop.
Sts_RatioClamped	BOOL	1 = Selected Ratio is being clamped, used in faceplate animation.
Sts_IntlkSP	BOOL	1 = SP value is being set by shed to Interlock SP.
Sts_SPHeld	BOOL	1 = SP value is being set by shed to hold last good SP.
Sts_SPShedPV	BOOL	1 = SP value is being set by shed to current PV.
Sts_SPShed	BOOL	1 = SP value from Shed, 0 = SP from Program, Operator, Override (Auto), Casc SP Input (Cascade) or PV Track (Manual).
Sts_SPTrackPV	BOOL	1 = SP value is being set by PV tracking in Manual loop mode.
Sts_SPHiClamped	BOOL	1 = Selected SP is being clamped at high limit.
Sts_SPLoClamped	BOOL	1 = Selected SP is being clamped at low limit.
Sts_SPClamped	BOOL	1 = Selected SP is being clamped, for faceplate animation.
Sts_SPRampingUp	BOOL	1 = SP is ramping up toward Val_SPSet.
Sts_SPRampingDown	BOOL	1 = SP is ramping down toward Val_SPSet.
Sts_SPRamping	BOOL	1 = SP is ramping toward Val_SPSet, 0 = Ramp complete.
Sts_SPRampWizardInProgress	BOOL	1 = SP is ramping toward SP target set by the owner in ramp wizard, 0 = Ramp complete.
Sts_SkipSPRoCLim	BOOL	1 = SP rate limiting is being skipped, for faceplate animation.
Sts_DevDBAct	BOOL	1 = PV deviation deadband active.
Sts_PVUncertain	BOOL	1 = PV input value quality is uncertain.
Sts_PVBad	BOOL	1 = PV input value, communications, quality or EU limit is bad.
Sts_SPBad	BOOL	1 = Cascade SP input value quality is bad.
Sts_FFBad	BOOL	1 = Feedforward term Inp_FF value is invalid.
Sts_FFPrevBad	BOOL	1 = Feedforward term Inp_FFPrev value is invalid.
Sts_CVInfNaN	BOOL	1 = CV value equal to +/- infinity or NaN detected.
Sts_CVBad	BOOL	1 = CV value quality is bad or invalid or CV comms fault.
Sts_CVPrevBad	BOOL	1 = Inp_CVPrev value is invalid.
Sts_HandFdbkBad	BOOL	1 = Hand FB (Tieback) value quality is bad or invalid or communication fault.
Sts_IntlkCV	BOOL	1 = CV value is being set by shed to Interlock CV.
Sts_CVHeld	BOOL	1 = CV value is being set by shed to hold last good CV.
Sts_CVShed	BOOL	1 = CV from shed, 0 = CV from Program, Operator, Override (Manual), or PID (Auto, Cascade).
Sts_CVHiClamped	BOOL	1 = CV is being clamped at high limit.
Sts_CVLoClamped	BOOL	1 = CV is being clamped at low limit.
Sts_CVClamped	BOOL	1 = Selected CV is being clamped, used in faceplate animation.
Sts_CVRampingUp	BOOL	1 = CV is ramping up toward Val_CVSet.
Sts_CVRampingDown	BOOL	1 = CV is ramping down toward Val_CVSet.
Sts_CVRamping	BOOL	1 = CV is ramping toward Val_CVSet, 0 = Ramp complete.
Sts_Active	BOOL	1 = CV is greater than Cfg_MaxInactiveCV, show graphic symbol as active.
Sts_Available	BOOL	1 = PID loop can be acquired by Program and is available for control.
Sts_CascAvailable	BOOL	1 = PID inner loop is available for cascade control with an outer loop. 0 = PID inner loop is not available, initialize outer loop to Val_SP.
Sts_ExtAvailable	BOOL	1 = PID is available for external control. 0 = PID is not available, initialize outer loop to Val_SP.
Sts_IntlkAvailable	BOOL	1 = Interlock availability OK. Device can be acquired by program and is available for control when interlocks are OK.
Sts_Bypass	BOOL	1 = Bypassable interlocks are bypassed.
Sts_BypActive	BOOL	1 = Interlock bypassing is active (bypassed or Maintenance).
Sts_NotRdy	BOOL	1 = PPID is not ready, see detail bits for reason.
Sts_NrdyCfgErr	BOOL	1 = PPID is not ready: Configuration error.
Sts_NrdyInit	BOOL	1 = PPID is not ready while CV is initialized (Inp_UseCVInitVal = 1).
Sts_NrdyIntlk	BOOL	1 = PPID is not ready: Interlock Not OK (Shed requires reset).
Sts_NrdyFail	BOOL	1 = PPID is not ready: Fail status is on (Shed requires reset).
Sts_NrdyCVFail	BOOL	1 = PPID is not ready: CV Fail (Shed requires reset).
Sts_NrdyPVFail	BOOL	1 = PPID is not ready: PV Fail (Shed requires reset).
Sts_NrdySPFail	BOOL	1 = PPID is not ready: SP Fail (Shed requires reset).
Sts_NrdyOoS	BOOL	1 = PPID is not ready: Out of Service.
Sts_MaintByp	BOOL	1 = Device has a Maintenance bypass function active.
Sts_NrdyInner	BOOL	1 = Inner loop object is not available (Inp_InnerAvailable = 0) for this PPID.
Sts_Err	BOOL	1 = Error in PPID configuration: see detail Err bits for reason.
Sts_ErrRatioLim	BOOL	1 = Error in PPID configuration: Ratio clamping limits invalid. Cfg_RatioLoLim > Cfg_RatioHiLim.
Sts_ErrSPLim	BOOL	1 = Error in PPID configuration: SP clamping limits invalid. Cfg_SPLoLim < Cfg_PVEUMin or Cfg_SPHiLim > Cfg_PVEUMax or Cfg_SPLoLim > Cfg_SPHiLim.
Sts_ErrCVLim	BOOL	1 = Error in PPID configuration: CV clamping limits invalid. Cfg_CVLoLim < Cfg_CVEUMin or Cfg_CVHiLim > Cfg_CVEUMax or Cfg_CVLoLim > Cfg_CVHiLim.
Sts_ErrPVEU	BOOL	1 = Error in PPID configuration: PV scaling limits invalid. Cfg_PVEUMin >= Cfg_PVEUMax or Cfg_PVEUMin is +-Inf.
Sts_ErrCVEU	BOOL	1 = Error in PPID configuration: CV scaling limits invalid. Cfg_CVEUMin >= Cfg_CVEUMax or Cfg_CVEUMin is +-Inf.
Sts_ErrDevDB	BOOL	1 = Error in PPID configuration: PV deviation deadband invalid. Cfg_DevDBEnter > Cfg_DevDB, or Cfg_DevDB < 0, or Cfg_DevDBEnter < 0.
Sts_ErrExecTime	BOOL	1 = Error in PPID configuration: Execution time invalid, Cfg_ExecTime < 0.0 or Cfg_ExecTime > 2147483.0 seconds.
Sts_ErrPGain	BOOL	1 = Error in PPID configuration: PGain invalid, Cfg_PGain < 0.
Sts_ErrIGain	BOOL	1 = Error in PPID configuration: IGain invalid, Cfg_IGain < 0.
Sts_ErrDGain	BOOL	1 = Error in PPID configuration: DGain invalid, Cfg_DGain < 0.
Sts_ErrCVTrackGain	BOOL	1 = Error in PPID configuration: CV TrackGain invalid, Cfg_CVTrackGain < 0.
Sts_ErrPSPWeight	BOOL	1 = Error in PPID configuration: SP weight in proportional term invalid, Cfg_PSPWeight < 0 or Cfg_PSPWeight > 1.5.
Sts_ErrDSPWeight	BOOL	1 = Error in PPID configuration: SP weight in derivative term invalid, Cfg_DSPWeight < 0 or Cfg_DSPWeight > 1.5.
Sts_ErrSPRoCIncrLim	BOOL	1 = Error in PPID configuration: Maximum allowed SP rate of change increasing value invalid, Cfg_SPRoCIncrLim < 0.
Sts_ErrSPRoCDecrLim	BOOL	1 = Error in PPID configuration: Maximum allowed SP rate of change decreasing value invalid, Cfg_SPRoCDecrLim < 0.
Sts_ErrCVRoCIncrLim	BOOL	1 = Error in PPID configuration: Maximum allowed CV rate of change increasing value invalid, Cfg_CVRoCIncrLim < 0.
Sts_ErrCVRoCDecrLim	BOOL	1 = Error in PPID configuration: Maximum allowed CV rate of change decreasing value invalid, Cfg_CVRoCDecrLim < 0.
Sts_ErrSPIntlk	BOOL	1 = Error in PPID configuration: SP value to use with Interlock or bad value SP action invalid, value out of scale, Cfg_SPIntlk > Cfg_PVEUMax or < Cfg_PVEUMin.
Sts_ErrCVIntlk	BOOL	1 = Error in PPID configuration: CV value to use with Interlock or bad value CV action invalid, value out of scale, Cfg_CVIntlk > Cfg_CVEUMax or < Cfg_CVEUMin.
Sts_ErrSPPwrUp	BOOL	1 = Error in PPID configuration: SP value to use in Powerup invalid, value out of scale, Cfg_SPPwrUp > Cfg_PVEUMax or < Cfg_PVEUMin.
Sts_ErrCVPwrUp	BOOL	1 = Error in PPID configuration: CV value to use in Powerup invalid, value out of scale, Cfg_CVIntlk > Cfg_CVEUMax or < Cfg_CVEUMin.
Sts_ErrAlm	BOOL	1 = Error in PPID configuration: At least one Logix tag-based alarm has invalid settings.
Sts_ErrHiHiDevLim	BOOL	1 = Error in PPID configuration: High-High PV deviation threshold invalid, Cfg_HiHiDevLim < 0.
Sts_ErrHiHiDevGateDly	BOOL	1 = Error in PPID configuration: Invalid High-High PV deviation gate delay timer preset (use 0.0 to 2147483.0).
Sts_ErrHiHiDevDB	BOOL	1 = Error in PPID configuration: High-High PV deviation deadband invalid, Cfg_HiHiDevDB < 0 or Cfg_HiHiDevDB > Cfg_HiHiDevLim.
Sts_ErrHiDevLim	BOOL	1 = Error in PPID configuration: High PV deviation threshold invalid, Cfg_HiDevLim < 0.0.
Sts_ErrHiDevGateDly	BOOL	1 = Error in PPID configuration: Invalid High PV deviation gate delay timer preset (use 0.0 to 2147483.0).
Sts_ErrHiDevDB	BOOL	1 = Error in PPID configuration: High PV deviation deadband invalid, Cfg_HiDevDB < 0 or Cfg_HiDevDB > Cfg_HiDevLim.
Sts_ErrLoDevLim	BOOL	1 = Error in PPID configuration: Low PV deviation threshold invalid, Cfg_LoDevLim > 0.
Sts_ErrLoDevGateDly	BOOL	1 = Error in PPID configuration: Invalid Low PV deviation gate delay timer preset (use 0.0 to 2147483.0).
Sts_ErrLoDevDB	BOOL	1 = Error in PPID configuration: Low PV deviation deadband invalid, Cfg_LoDevDB < 0, or > -Cfg_LoDevLim.
Sts_ErrLoLoDevLim	BOOL	1 = Error in PPID configuration: Low-Low PV deviation threshold invalid, Cfg_LoLoDevLim > 0.0.
Sts_ErrLoLoDevGateDly	BOOL	1 = Error in PPID configuration: Invalid Low-Low PV deviation gate delay timer preset (use 0.0 to 2147483.0).
Sts_ErrLoLoDevDB	BOOL	1 = Error in PPID configuration: Low-Low PV deviation deadband invalid, Cfg_LoLoDevDB < 0, or > -Cfg_LoLoDevLim.
Sts_eSrc	INT	The current command source enumerated values: 0 = Logic not in use, 4 = Hand, 8 = Maintenance, 16 = Override, 32 = Program, 33 = Program locked, 34 = Program by default (Normal), 64 = Operator, 65 = Operator locked, 66 = Operator by default (Normal), 128 = Maintenance Out of Service, 129 = Programmed Out of Service (rung false), 256 = External.
Sts_bSrc	INT	Active selection bitmap (for HMI totem pole with command source request selection): Sts_bSrc.0: Hand, Sts_bSrc.1: Programmed Out of Service (rung false), Sts_bSrc.2: Maintenance Out of Service, Sts_bSrc.3: Maintenance, Sts_bSrc.4: Override, Sts_bSrc.5: External, Sts_bSrc.6: Program locked, Sts_bSrc.7: Program, Sts_bSrc.8: Operator locked, Sts_bSrc.9: Operator.
Sts_Hand	BOOL	1 = Hand is selected, supersedes OoS, Maint, Ovrd, Ext, Prog, Oper.
Sts_OoS	BOOL	1 = Out of Service is selected, supersedes Maint, Ovrd, Ext, Prog, Oper.
Sts_Maint	BOOL	1 = Maintenance is selected, supersedes Ovrd, Ext, Prog, Oper.
Sts_Ovrd	BOOL	1 = Override is selected, supersedes Ext, Prog, Oper.
Sts_Ext	BOOL	1 = External is selected, supersedes Prog, Oper.
Sts_Prog	BOOL	1 = Program is selected.
Sts_ProgLocked	BOOL	1 = Program is selected and locked.
Sts_Oper	BOOL	1 = Operator is selected.
Sts_OperLocked	BOOL	1 = Operator is selected and locked.
Sts_ProgOperSel	BOOL	Program/Operator selection (latch) state: 1 = Program, 0 = Operator.
Sts_ProgOperLock	BOOL	Program/Operator lock (latch) state: 1 = Locked, 0 = Unlocked.
Sts_Normal	BOOL	1 = Owner selection equals what is configured as Normal (Prog or Oper).
Sts_ExtReqInh	BOOL	1 = External request inhibited.
Sts_ProgReqInh	BOOL	1 = Program request inhibited, cannot get to Program from current owner.
Sts_MAcqRcvd	BOOL	1 = Maintenance acquire command received this scan.
Sts_Alm	BOOL	1 = An alarm is active.
Sts_AlmInh	BOOL	1 = An alarm is shelved or disabled.
Sts_HiHiDevCmp	BOOL	1 = PV deviation is above High-High limit, (Val_PV-Val_SP)>Cfg_HiHiDevLim.
Sts_HiHiDevGate	BOOL	1 = PV deviation High-High gate is open.
Sts_HiHiDev	BOOL	1 = PV deviation is above High-High limit, (Val_PV-Val_SP)>Cfg_HiHiDevLim, for gate open. There is a predefined default discrete tag-based alarm for the status. Set standard configuration members of the discrete tag-based alarm. Access alarm elements using this format: PPIDTag.@Alarms.Alm_HiHiDev.AlarmElement
Sts_HiDevCmp	BOOL	1 = PV deviation is above High limit, (Val_PV-Val_SP)>Cfg_HiDevLim.
Sts_HiDevGate	BOOL	1 = PV deviation High gate is open.
Sts_HiDev	BOOL	1 = PV deviation is above High limit, (Val_PV-Val_SP)>Cfg_HiDevLim, for gate open. There is a predefined default discrete tag-based alarm for the status. Set standard configuration members of the discrete tag-based alarm. Access alarm elements using this format: PPIDTag.@Alarms.Alm_HiDev.AlarmElement
Sts_LoDevCmp	BOOL	1 = PV deviation is below Low limit, (Val_PV-Val_SP)<Cfg_LoDevLim.
Sts_LoDevGate	BOOL	1 = PV deviation Low gate is open.
Sts_LoDev	BOOL	1 = PV deviation (loop error) is below Low limit, (Val_PV-Val_SP)<Cfg_LoDevLim, for gate open. There is a predefined default discrete tag-based alarm for the status. Set standard configuration members of the discrete tag-based alarm. Access alarm elements using this format: PPIDTag.@Alarms.Alm_LoDev.AlarmElement
Sts_LoLoDevCmp	BOOL	1 = PV deviation is below Low-Low limit, (Val_PV-Val_SP)<Cfg_LoLoDevLim.
Sts_LoLoDevGate	BOOL	1 = PV deviation Low-Low gate is open.
Sts_LoLoDev	BOOL	1 = PV deviation (loop error) is below Low-Low limit, (Val_PV-Val_SP)<Cfg_LoLoDevLim, for gate open. There is a predefined default discrete tag-based alarm for the status. Set standard configuration members of the discrete tag-based alarm. Access alarm elements using this format: PPIDTag.@Alarms.Alm_LoLoDev.AlarmElement
Sts_Fail	BOOL	1 = Loop failure: PV bad, SP bad, CV bad or Hand feedback bad statuses are on or are latched on without reset. There is a predefined default discrete tag-based alarm for the status. Set standard configuration members of the discrete tag-based alarm. Access alarm elements using this format: PPIDTag.@Alarms.Alm_Fail.AlarmElement
Sts_IntlkTrip	BOOL	1 = Interlock Not OK caused loop output to hold or change. There is a predefined default discrete tag-based alarm for the status. Set standard configuration members of the discrete tag-based alarm. Access alarm elements using this format: PPIDTag.@Alarms.Alm_IntlkTrip.AlarmElement
Sts_RdyReset	BOOL	1 = A latched alarm or shed condition is ready to be reset.
Sts_RdyAck	BOOL	1 = An alarm is ready to be acknowledged.
XRdy_Acq	BOOL	1 = Ready for XCmd_Acq, enable HMI button.
XRdy_Rel	BOOL	1 = Ready for XCmd_Rel, enable HMI button.
XRdy_Casc	BOOL	1 = Ready for XCmd_Casc, enable HMI button.
XRdy_Auto	BOOL	1 = Ready for XCmd_Auto, enable HMI button.
XRdy_Man	BOOL	1 = Ready for XCmd_Man, enable HMI button.
XRdy_NormLM	BOOL	1 = Ready for XCmd_NormLM, enable HMI button.
XRdy_SPRampStart	BOOL	1 = Ready for XCmd_SPRampStart, enable HMI button.
XRdy_SPRampStop	BOOL	1 = Ready for XCmd_SPRampStop, enable HMI button.
XRdy_Reset	BOOL	1 = Ready for XCmd_Reset, enable HMI button.
XRdy_ResetAckAll	BOOL	1 = Ready for XCmd_ResetAckAll, enable HMI button.
Val_Owner	DINT	Current object owner ID, 0 = Not owned.

Private input member	Data Type	Default Value	Description
CmdSrc	P_COMMAND_SOURCE		Control or Command Source Selection.
OCmd_SPRampStart	BOOL	0	Operator command to initiate SP ramping. The instruction clears this operand automatically. Default is 0.
OCmd_SPRampStop	BOOL	0	Operator command to stop SP ramping. The instruction clears this operand automatically. Default is 0.
OSet_Ratio	REAL	1.0	Operator setting for Ratio, loop mode Cascade/Ratio and Ratio enabled (unitless). Valid = 0.0 to maximum positive float. Default is 1.0.
OSet_SP	REAL	0.0	Operator setting for Setpoint, loop mode Auto (PVEU). Valid any float. Default is 0.0.
OSet_SPTarget	REAL	0.0	Operator setting for Setpoint ramp target, endpoint for ramp wizard (PVEU). Valid any float. Default is 0.0.
OSet_SPRampTime	REAL	0.0	Operator setting for Setpoint ramp time, time to reach target for ramp wizard (seconds). Valid = 0.0 to 28800.0 seconds. Default is 0.0.
OSet_CV	REAL	0.0	Operator setting for CV, loop mode Manual (CVEU). Valid any float. Default is 0.0.
MCmd_Bypass	BOOL	0	Maintenance command to bypass all bypassable interlocks. The instruction clears this operand automatically. Default is 0.
MCmd_Check	BOOL	0	Maintenance command to check, not bypass, all interlocks. The instruction clears this operand automatically. Default is 0.
MCmd_OoS	BOOL	0	Maintenance command to select Out of Service. The instruction clears this operand automatically. Default is 0.
MCmd_IS	BOOL	0	Maintenance command to select In Service. The instruction clears this operand automatically. Default is 0.
MCmd_Acq	BOOL	0	Maintenance command to acquire ownership (Operator/Program/External/Override to Maintenance). The instruction clears this operand automatically. Default is 0.
MCmd_Rel	BOOL	0	Maintenance command to release ownership (Maintenance to Operator/Program/External/Override). The instruction clears this operand automatically. Default is 0.
OCmd_Oper	BOOL	0	Operator command to select Operator (Program to Operator). The instruction clears this operand automatically. Default is 0.
OCmd_Prog	BOOL	0	Operator command to select Program (Operator to Program). The instruction clears this operand automatically. Default is 0.
OCmd_Lock	BOOL	0	Operator command to lock Operator (disallow Program). The instruction clears this operand automatically. Default is 0.
OCmd_Unlock	BOOL	0	Operator command to unlock or release (allow Program to acquire) ownership. The instruction clears this operand automatically. Default is 0.
OCmd_Normal	BOOL	0	Operator command to select Normal (Operator or Program). The instruction clears this operand automatically. Default is 0.
OCmd_Auto	BOOL	0	Operator command to select Automatic loop mode. The instruction clears this operand automatically. Default is 0.
OCmd_Casc	BOOL	0	Operator command to select Cascade/Ratio loop mode. The instruction clears this operand automatically. Default is 0.
OCmd_Man	BOOL	0	Operator command to select Manual loop mode. The instruction clears this operand automatically. Default is 0.
OCmd_NormLM	BOOL	0	Operator command to select loop mode configured as Normal (see Cfg_NormLM). The instruction clears this operand automatically. Default is 0.
OCmd_Reset	BOOL	0	Operator command to reset all alarms and latched shed conditions. The instruction clears this operand automatically. Default is 0.
OCmd_ResetAckAll	BOOL	0	Operator command to acknowledge and reset all alarms and latched shed conditions. The use of OCmd_ResetAckAll is restricted to HMI. The instruction clears this operand automatically. Default is 0.

Private output member	Data Type	Description
HMI_BusObjIndex	DINT	HMI bus object index. Default is 0.
MRdy_Bypass	BOOL	1 = Ready for MCmd_Bypass, enable HMI button.
MRdy_Check	BOOL	1 = Ready for MCmd_Check, enable HMI button.
MRdy_OoS	BOOL	1 = Ready for MCmd_OoS, enable HMI button.
MRdy_IS	BOOL	1 = Ready for MCmd_IS, enable HMI button.
MRdy_Acq	BOOL	1 = Ready for MCmd_Acq, enable HMI button.
MRdy_Rel	BOOL	1 = Ready for MCmd_Rel, 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_Lock	BOOL	1 = Ready for OCmd_Lock, enable HMI button.
ORdy_Unlock	BOOL	1 = Ready for OCmd_Unlock, enable HMI button.
ORdy_Normal	BOOL	1 = Ready for OCmd_Normal, enable HMI button.
ORdy_Auto	BOOL	1 = Ready for OCmd_Auto, enables HMI button.
ORdy_Casc	BOOL	1 = Ready for OCmd_Casc, enables HMI button.
ORdy_CV	BOOL	1 = Ready for OSet_CV, enables data entry field.
ORdy_Man	BOOL	1 = Ready for OCmd_Man, enables HMI button.
ORdy_NormLM	BOOL	1 = Ready for OCmd_NormLM, enables HMI button.
ORdy_Ratio	BOOL	1 = Ready for OSet_Ratio, enables data entry field.
ORdy_SP	BOOL	1 = Ready for OSet_SP, enables data entry field.
ORdy_SPRampStart	BOOL	1 = Ready for OCmd_SPRampStart, enables HMI button.
ORdy_SPRampStop	BOOL	1 = Ready for OCmd_SPRampStop, enables HMI button.
ORdy_SPTarget	BOOL	1 = Ready for OSet_SPTarget, enables data entry field.
ORdy_SPRampTime	BOOL	1 = Ready for OSet_SPRampTime, enables data entry field.
ORdy_Reset	BOOL	1 = Ready for OCmd_Reset, enables HMI button.
ORdy_ResetAckAll	BOOL	1 = At least one alarm or latched shed condition requires Reset or Acknowledgement.

Public InOut member	Data Type	Description
BusObj	BUS_OBJ	Bus component

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

Member	Alarm Name	Description
Sts_Fail	Alm_Fail	Instruction Failure. Raised when the PPID instruction reports an Instruction Fault. The Fault is reported under any of these conditions: Setpoint (SP) bad quality, Sts_SPBad = 1, Process variable (PV) bad quality, Sts_PVBad = 1, Control variable (CV) bad quality, Sts_CVBad = 1, Hand feedback (HandFdbk) bad quality, Sts_HandFdbkBad = 1.
Sts_IntlkTrip	Alm_IntlkTrip	Interlock Trip alarm. Raised when non-bypassable interlocks are not OK or bypassable interlocks are not OK when not bypassed. NAND(Inp_NBIntlkOK,(OR(Inp_IntlkOK,Stst_BypActive))).
Sts_HiHiDev	Alm_HiHiDev	High-High Deviation. Raised when the amount by which the PV exceeds the setpoint or reference is above the High-High Deviation threshold. The threshold, deadband, gating, and timing are set in configuration.
Sts_HiDev	Alm_HiDev	High Deviation. Raised when the amount by which the PV exceeds the setpoint or reference is above the High Deviation threshold. The threshold, deadband, gating, and timing are set in configuration.
Sts_LoDev	Alm_LoDev	Low Deviation. Raised when the amount by which the PV exceeds the setpoint or reference is below the Low Deviation threshold. (Since the threshold is a negative number, this reading is the amount the PV falls below the setpoint or reference.) The threshold, deadband, gating, and timing are set in configuration.
Sts_LoLoDev	Alm_LoLoDev	Low-Low Deviation. Raised when the amount by which the PV exceeds the setpoint or reference is below the Low-Low Deviation threshold. (Since the threshold is a negative number, this reading is the amount the PV falls below the setpoint or reference.) The threshold, deadband, gating, and timing are set in configuration.

Val_SP,
Inp_PV,
Inp_CVPrev,
Inp_CVTrack,
Cfg_CVHiLim,
Cfg_LoLim,
Cfg_CVRoCIncrLim,
Cfg_CVRoCDecrLim

If the internal CV is above the currently applied upper limit, do not integrate upward.
If the internal CV is within the currently applied limits, integrate but do not violate limits.
If the internal CV is below the currently applied lower limit, do not integrate downward.

SP clamping limits are invalid (Sts_ErrSPLim=1), or
PV scaling limits are invalid (Sts_ErrPVEU=1), or
The loop mode is Cascade and cascade SP is NaN or Inf, or
Cascade is Ratio (Cfg_HasRatio=1) and ratio clamping limits are invalid.

Interlock trips and the follow up action is to use Cfg_SPIntlk as the setpoint value(Cfg_IntlkTripSPAction=2), or
SP fails and the instruction is configured to follow with using Cfg_SPIntlk as the setpoint (Cfg_SPFailSPAction=2), or
PV fails and the instruction is configured to use Cfg_SPIntlk as the setpoint value (Cfg_PVFailSPAction=2), or
CV fails and the instruction is configured to use Cfg_SPIntlk as the setpoint value (Cfg_CVFailSPAction=2).

Interlock trips and the follow up action is to leave the value unchanged (Cfg_IntlkTripSPAction=1), or
SP fails and the instruction is configured to follow with the setpoint not changed (Cfg_SPFailSPAction=1), or
PV fails and the instruction is configured to follow with the setpoint not changed (Cfg_PVFailSPAction=1), or
CV fails and the instruction is configured to follow with the setpoint not changed (Cfg_CVFailSPAction=1) and higher shed priority is not applied (Sts_IntlkSP=0).

Interlock trips and the follow up action is to leave the value unchanged (Cfg_IntlkTripSPAction=3), or
SP fails and the instruction is configured to follow with the setpoint not changed (Cfg_SPFailSPAction=3), or
CV fails and the instruction is configured to follow with the setpoint not changed (Cfg_CVFailSPAction=3) and higher shed priority is not applied (Sts_IntlkSP=0 & Sts_SPHeld=0) and PV is good (Sts_PVBad=0).

Tracking is not enabled (Cfg_SetTrack=0), or
Operator has loop mode in Auto, or Operator has loop mode in Manual and SP does not track PV in Manual (Cfg_PVTrack=0), or
Command source is Hand in Auto, or command source is Hand in Manual and SP does not track PV in Manual (Cfg_PVTrack=0), or
Command source is Override and SP is not configured for tracking in Override (Cfg_SetTrackOvrdHand=0).

Setpoint ramp wizard is permitted (Cfg_HasSPRamp=1), and Program/Operator/External setting is not tracked (Cfg_SetTrack=0), or
Operator has SP in Auto, or command source is Hand in Auto loop mode.

Setpoint clamping limits are invalid, Sts_ErrSPLim=1, or
PPID is Out of Service, or
PPID is configured to skip RoC limiting Cfg_SkipSPRoCLim=1 and the PPID is in Interlock/Maintenance/Override, or
SP value tracks PV value in Manual loop mode (Sts_SPTrackPV=1), or
Current value of SP rate of change limit increasing is zero (Val_SPRoCIncr=0) and current SP target (Val_SPSet) is above current SP, or
Current value of SP rate of change limit decreasing is zero (Val_SPRoCDecr=0) and current SP target (Val_SPSet) is below current SP.

not skipped (Sts_SkipSPRoCLim=0),
the setpoint has not reached its target Val_SPSet,
absolute value of loop deviation (|Val_E|) does not exceed configured maximum ramp deviation, |Val_E|≤ Cfg_SPRampMaxDev.

PSet_Ratio if Program has Ratio,
OSet_Ratio if Operator has Ratio,
XSet_Ratio if External has Ratio,
Inp_OvrdRatio if Override is selected.

Loop mode is not in Override nor Hand, or
Loop mode is in Override or Hand and PPID is configured to track in Override and Hand loop mode (Cfg_SetTrackOvrdHand=1), or
Loop mode is in Cascade, or
Loop mode is in Manual and Cfg_PVTrack=1.

Interlock trips and CV action is configured for last good CV value (Cfg_IntlkTripCVAction=1), or
SP fails and follow up action on CV is configured for last good CV value (Cfg_SPFailCVAction=1) and the loop mode is Auto or Cascade or SP did not fail in previous scan (SP fail rising edge), or
PV fails and follow up action on CV is configured for last good CV value (Cfg_PVFailCVAction=1) and the loop mode is Auto or Cascade or PV did not fail in previous scan (PV fail rising edge), or
PV substituted at PAI (Inp_PVSrcQ=18) and the loop mode is Auto or Cascade, or
CV fails and follow up action on CV is configured for last good CV value (Cfg_CVFailCVAction=1) and the loop mode is Auto or Cascade or CV did not fail in previous scan (CV fail rising edge).

Interlock trips and CV action is configured for Cfg_CVIntlk (Cfg_IntlkTripCVAction=2), or
SP fails and follow up action on CV is configured for Cfg_CVIntlk (Cfg_SPFailCVAction=2) and loop mode is Auto or Cascade or SP did not fail in previous scan (SP fail rising edge), or
PV fails and follow up action on CV is configured for Cfg_CVIntlk (Cfg_PVFailCVAction=2) and loop mode is Auto or Cascade or PV did not fail in previous scan (PV fail rising edge), or
CV fails and follow up action on CV is configured for Cfg_CVIntlk (Cfg_CVFailCVAction=2), and loop mode is Auto or Cascade or CV did not fail in previous scan (CV fail rising edge), or
PPID is out of service.
NOTE:
When PV, CV, or SP fails, the Cfg_CVIntlk value stays at output, but it can be still overwritten in Manual loop mode.

Owner command set to None,
Override command set to None,
Maintenance commands to bypass and check interlocks are cleared,
Operator, Program and External commands are cleared,
latched shed faults are cleared,
all timers are reset.

Normal loop mode is disabled (Cfg_NormLM=0) if loop mode defined as normal is invalid (Cfg_NormLM<0 | >3), or normal loop mode is set Cascade but the instruction does not allow Cascade in configuration (Cfg_HasCasc ≠ 1 & Cfg_NormLM = 3),
Loop mode is set to Manual if loop mode for Power up (Cfg_PwrUpLM) is Normal and normal loop mode is Manual, or loop mode for Power up in Manual,
Loop mode is set to Auto if normal loop mode for Power up is Normal and normal loop mode is Auto, or loop mode for Power up in Auto,
Loop mode is set to Cascade if normal loop mode for Power up is Normal and normal loop mode is Cascade, or loop mode for Power up in Cascade.

Inp_CascSP = Cfg_SPPwrUp if loop mode in Powerup (Cfg_PwrUpLM) is explicitly provided as Manual/ Auto/ Cascade/ Normal and the Cascade loop mode is not Ratio, or Val_Ratio = 0,
Inp_CascSP = Cfg_SPPwrUp × Val_Ratio if loop mode in Powerup is explicitly provided as Manual/ Auto/ Cascade/ Normal and the Cascade loop mode is Ratio and Val_Ratio ≠ 0.

Cfg_SPPwrUp → PSet_SP, OSet_SP, XSet_SP, Inp_OvrdSP,
Cfg_SPPwrUp → PSet_SPTarget, OSet_SPTarget, XSet_SPTarget, Inp_OvrdSPTarget,
Cfg_SPPwrUp → Val_SPTarget, Val_SPSet, Val_SP.

Cfg_CVPwrUp → PSet_CV, OSet_CV, XSet_CV, Inp_OvrdCV, Inp_CVPrev, Val_CVSet, Val_CVOut.

The current command source is Operator (Sts_Oper=1) and the configuration is set to follow the command source (Cfg_eKeepCV=0), or
the command source is Operator/Program/External and the configuration keeps the CV for Operator (Cfg_eKeepCV=1),
or the command source is Maintenance (Sts_Maint=1).

The current owner is Operator (Sts_Oper=1) and the configuration is set to follow the command source (Cfg_eKeepLM=0), or
the owner is Operator/Program/External and the configuration keepd the loop mode for Operator (Cfg_eKeepLM=1), or
the owner is Maintenance (Sts_Maint=1).

The current owner is Operator (Sts_Oper=1) and the configuration is set to follow the command source (Cfg_eKeepRatio=0), or
the owner is Operator/Program/External and the configuration keeps the Ratio for Operator (Cfg_eKeepRatio=1), or
the owner is Maintenance (Sts_Maint=1).

The current owner is Operator (Sts_Oper=1) and the configuration is set to follow the command source (Cfg_eKeepSP=0), or
the owner is Operator/Program/External and the configuration keeps the SP for Operator (Cfg_eKeepSP=1), or
the owner is Maintenance (Sts_Maint=1).

The current owner is Program (Sts_Prog=1) and the configuration is set to follow the command source (Cfg_eKeepCV=0), or
the owner is Operator/Program/External and the configuration keeps the CV for Program (Cfg_eKeepCV=2).

The current owner is Program (Sts_Prog=1) and the configuration is set to follow the command source (Cfg_eKeepLM=0), or
the owner is Operator/Program/External and the configuration keeps the loop mode for Program (Cfg_eKeepLM=2).

The current owner is Program (Sts_Prog=1) and the configuration is set to follow the command source (Cfg_eKeepRatio=0), or
the owner is Operator/Program/External and the configuration keeps the Ratio for Program (Cfg_eKeepRatio=2).

The current owner is Program (Sts_Prog=1) and the configuration is set to follow the command source (Cfg_eKeepSP=0), or
the owner is Operator/Program/External and the configuration keeps the SP for Program (Cfg_eKeepSP=2).

The current owner is External (Sts_Ext=1) and the configuration is set to follow the command source (Cfg_eKeepCV=0), or
the owner is Operator/Program/External and the configuration keeps the CV for External (Cfg_eKeepCV=3).

The current owner is External (Sts_Ext=1) and the configuration is set to follow the command source (Cfg_eKeepLM=0), or
the owner is Operator/Program/External and the configuration keeps the loop mode for External (Cfg_eKeepLM=3).

The current owner is External (Sts_Ext=1) and the configuration is set to follow the command source (Cfg_eKeepRatio=0), or
the owner is Operator/Program/External and the configuration keeps the Ratio for External (Cfg_eKeepRatio=3).

The current owner is Program (Sts_Prog=1) and the configuration is set to follow the command source (Cfg_eKeepSP=0), or
the owner is Operator/Program/External and the configuration keeps the SP for External (Cfg_eKeepSP=3).

SP clamping limits are invalid (Sts_ErrSPLim=1), or
PV limits used in scaling are invalid (Sts_ErrPVEU=1, Max<=Min).

Inp_CVIOFault=1, or
CV clamping limits are invalid (Sts_ErrCVLim=1), or
CV scaling limits are invalid (Sts_ErrCVEU=1),or
Hand feedback is bad and the PPID is in Hand mode.

Selected SP is clamped at high limit (Sts_SPHiClamped=1), or
CV is clamped at high limit (Sts_CVHiClamped=1) if the PPID is configured for reverse control action (Cfg_CtrlAction=0), or
CV is clamped at low limit (Sts_CVLoClamped=1) if the PPID is configured for direct control action (Cfg_CtrlAction=1).

Selected SP is clamped at low limit (Sts_SPLoClamped=1), or
CV is clamped at low limit (Sts_CVLoClamped=1) if the PPID is configured for reverse control action (Cfg_CtrlAction=0), or
CV is clamped at high limit (Sts_CVHiClamped=1) if the PPID is configured for direct control action (Cfg_CtrlAction=1).

PPID is out of service (Sts_NrdyOoS=1), or
PPID goes to Manual loop mode when initialized and Inp_CVInitialVal is used to initialize CV (Sts_NrdyInit=1), or
PPID configuration error (Sts_NRdyCfgErr=1), or Interlock not OK (Sts_NrdyIntlk=1), or
Inner object to this PPID, typically PID of the secondary loop, is not available (Inp_InnerAvailable=0) for Auto or Cascade mode of the PPID (Sts_Auto=1 | Sts_Casc=1), or
Loop fails (Sts_Fail=1) because of PV/SP/CV bad value or communication failure, or Hand feedback value is invalid.

Description
Label for graphic symbol
Display Library for HMI Faceplate call-up
Instruction name
Area name
URL link
Path to an object with more information
Path to an object providing Cascade SP
Path to an object providing PV
Path to an object consuming CV
PV/SP engineering units
CV engineering units

Command source	Description
Hand	Hardwired logic or other logic outside the instruction owns control of the device. The instruction tracks the state of the device for bumpless transfer back to one of the other command sources. While in Hand mode the PID algorithm does not compute the change in CV. Val_CVOut = Inp_HandFdbk (Inp_Tieback), regardless of the control mode. Hand mode is typically used to indicate that control of the final control element was taken over by a field hand/auto station. Set Inp_Hand to request hand mode. This value is usually read as a digital input from a hand/auto station. (Highest Priority command source)
Out-of-Service	The instruction is disabled and has no owner.
Maintenance	Maintenance owns control of the device and supersedes Operator, Program, External and Override control. Operator commands and settings from the HMI are accepted. Bypassable interlocks are bypassed, and device timeout checks are not processed.
Override	Priority logic owns control of the device and supersedes Operator, Program and External control. Override Input (Inp_OvrdCmd) is accepted. If so configured, bypassable interlocks are bypassed.
External	External logic owns control of the device. External commands (XCmd_) are accepted.
Program locked	Program logic owns control of the device. Program commands (PCmd_) are accepted. Operator cannot take from Program. Override cannot take from Program unless Cfg_OvrdOverLock = 1.
Program	Program logic owns control of the device. Program commands (PCmd_) are accepted.
Operator locked	The Operator owns control of the device. Operator commands (OCmd_) from the HMI are accepted. Program cannot take from Operator. Override cannot take from Operator unless Cfg_OvrdOverLock = 1.
Operator	The Operator owns control of the device. Operator commands (OCmd_) from the HMI are accepted. (Lowest Priority command source)

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)
XCmd_Acq used as a Level (1 = Acquire External, 0 = Release External)

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.

Oper
OperLocked
Prog
ProgLocked

Condition/State	Action Taken
Prescan	Rung-condition-out is cleared to false. Sts_eSrc is set to 0. Sts_bSrc is set to 0.
Instruction first run	All commands that are automatically cleared each execution are cleared and ignored. The Program/Operator selection is set based on the configuration (Cfg_ProgPwrUp). The Program or Operator lock selection is set to unlocked. Loop mode is set according to configuration (Cfg_PwrUpLM). Initial value pf SP and CV are set according to Cfg_SPPwrUp and Cfg_CVPwrUp and selected loop mode. If Cfg_PwrUpLM=0 (no change), SP and CV initial values are equal to values from last scan (e.g. before power down). PSet_Owner and Sts_Owner are set to 0.
Rung-condition-in is false	The instruction is put Out of Service if Inp_Hand=0. The output is de-energized. All alarms are cleared. Command source selection processing proceeds as normal except that all ownership status bits (Sts_Maint, Sts_Ovrd, Sts_Ext, Sts_Prog and Sts_Oper) are cleared to 0. When rung-condition-in becomes true, the instruction takes into account the commands received and sets the active command source accordingly.
Rung-condition-in is true	Set rung-condition-out to rung-condition-in. The instruction executes.
Postscan	Rung-condition-out is cleared to false.

Condition/State	Action Taken
Prescan	See Prescan in the Ladder Diagram table.
Instruction first run	See Instruction first run in the Ladder Diagram table.
Instruction first scan	See Instruction first run in the Function Block Diagram table.
EnableIn is false	See Rung-condition-in is false in the Ladder Diagram table.
EnableIn is true	See Rung-condition-in is true in the Ladder Diagram table.
Postscan	EnableIn and EnableOut bits are cleared to false.

Condition/State	Action Taken
Prescan	See Prescan in the Ladder Diagram table.
Instruction first run	See Instruction first run in the Ladder Diagram table.
EnableIn is true	See Rung-condition-in is true in the Ladder Diagram table.
Postscan	EnableIn and EnableOut bits are cleared to false.

Dependent gains (Cfg_Dependent = 1). Set Cfg_CVTrackGain = Cfg_IGain.
Independent gains (Cfg_Dependent = 0). Set Cfg_CVTrackGain = Cfg_IGain/Cfg_PGain.