Rockwell Automation Library of Process Objects Reference Manual
Reference Manual
Rockwell Automation Library of Process Objects: Proportional + Integral + Derivative Enhanced (P_PIDE)
Version 3.5
IMPORTANT
This manual applies to the Rockwell Automation Library of Process Objects version 3.5 or earlier.
For Rockwell Automation Library of Process Objects version 5.0, see
• PROCES-RM200
For Rockwell Automation Library of Process Objects version 4.0 or later, use the following manuals:
• PROCES-RM013 contains logic instructions
• PROCES-RM014 contains display elements
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to
familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws,
and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required
to be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the
use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and
requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or
liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or
software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation,
Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
IMPORTANT
Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to
potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL
Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, and Rockwell Automation are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of Contents
Preface Software Compatibility and Content Revision. . . . . . . . . . . . . . . . . . . . 5
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Proportional + Integral +
Derivative Enhanced (P_PIDE)
Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Autotune . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Proportional + Integral + Derivative Enhanced
Input Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Proportional + Integral + Derivative Enhanced
Output Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Proportional + Integral + Derivative Enhanced
Local Configuration Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Loop Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Loop Mode Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Threshold Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Using Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Quick Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Proportional + Integral + Derivative Enhanced
Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 3
Table of Contents
Notes:
4 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Preface
Software Compatibility and Content Revision
Table 1 - Summary of Changes
Topic Page
Visualization Files: Global Objects (.ggfx) - Process Diagnostic Objects 10
Input Local Configuration Tags - Navigation Tags 23-24
For the latest compatible software information and to download the Rockwell
Automation® Library of Process Objects, see the Product Compatibility and
Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.
For general library considerations, see Rockwell Automation Library of Process
Objects, publication
PROCES-RM002.
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 5
Preface
Additional Resources
These documents contain additional information concerning related products
from Rockwell Automation.
Resource Description
PlantPAx® Distributed Control System Selection Guide,
publication
PlantPAx Distributed Control System Reference Manual,
publication
Rockwell Automation Library of Process Objects,
publication
FactoryTalk® View Machine Edition User Manual,
publication
FactoryTalk View Site Edition User Manual,
publication
Logix5000™ Process Control Drives Instructions Reference
Manual, publication
Logix5000 Controllers Add-On Instructions Programming
Manual, publication
Rockwell Automation Library of Process Objects: Common
Alarm Block (P_Alarm) Reference Manual, publication
SYSLIB-RM002
Rockwell Automation Library of Process Objects: Interlocks
with First Out and Bypass (P_Intlk) Reference Manual,
publication
Rockwell Automation Library of Process Objects: Common
Mode Block (P_Mode) Reference Manual, publication
SYSLIB-RM005
Rockwell Automation Library of Process Objects: Condition
Gate Delay (P_Gate) Reference Manual, publication
RM041
PROCES-SG001
PROCES-RM001
PROCES-RM002
VIEWME-UM004
VIEWSE-UM006
1756-RM006
1756-PM010
SYSLIB-RM004
SYSLIB-
Provides information to assist with equipment
procurement for your PlantPAx system.
Provides characterized recommendations for
implementing your PlantPAx system.
Provides general considerations for the PlantPAx system
library of process objects.
Provides details on how to use this software package for
creating an automation application.
Provides details on how to use this software package for
developing and running human-machine interface
(HMI) applications that can involve multiple users and
servers, distributed over a network.
Provides detailed information on the built-in
(firmware) PIDE instruction that is used within
the P_PIDE Add-On Instruction for PID
algorithm implementation.
Provides information for designing, configuring, and
programming Add-On Instructions.
Details how to monitor an input condition to raise an
alarm. Information includes acknowledging, resetting,
inhibiting, and disabling an alarm. Generally the
P_Alarm faceplate is accessible from the Alarms tab.
Explains how to collect (sum up) the interlock
conditions that stop or de-energize a running or
energized piece of equipment or prevent it from
starting or being energized.
Explains how to choose the Mode (owner) of an
instruction or control strategy. The Mode instruction is
usually embedded within other instructions to extend
their functionality. It is possible to use a standalone
Mode instruction to enhance a program where modes
are wanted.
Provides details of the P_Gate instruction for
processing status and alarm conditions, including gate
delay, on-delay, and off-delay timing.
You can view or download publications at
http:/www.rockwellautomation.com/literature/. To order paper copies of
technical documentation, contact your local Allen-Bradley distributor or
Rockwell Automation sales representative.
6 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Add-On Instruction
Proportional + Integral + Derivative Enhanced (P_PIDE)
The P_PIDE (Proportional + Integral + Derivative Enhanced) Add-On
Instruction provides the functionality of the Studio 5000 Logix Designer® PIDE
function block with a user experience consistent with the rest of the Rockwell
Automation Library of Process Objects. The global object and following
faceplate are examples of the graphical interface tools for this Add-On
Instruction.
Faceplate
Global Object
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 7
Proportional + Integral + Derivative Enhanced (P_PIDE)
Guidelines
Functional Description
Use this instruction when you plan to use the PIDE for loop control and provide
visualization to the operator.
The primary operations of the P_PIDE Add-On Instructions and its faceplate
include the following:
• All functions of the PIDE built-in instruction for PID loop control
• Process Library alarm objects for deviation alarms, and additional alarm
status information and functionality, including limits, deadbands, and
severities
• Additional context for display, including a description, label, tag, and
engineering units
• P_Mode (mode) object for ownership
• Links for the P_Intlk (interlocks) instruction for interlocking
• Power-up Setpoint, Output, and Loop mode settings
Autotune
You must have a license to edit the autotune tag entry field on the PIDE
instruction. Do these steps to enable the functionality.
1. Open the Logic routine of the ‘P_PIDE_only’ Add-On Instruction.
2. Edit the function block diagram to set the autotune tag to 'Ref_Autotune'.
3. Save your changes and download to your controller.
Once this change has been made, the outer P_PIDE instruction automatically
checks on powerup for response from the Autotune function and automatically
enables the Autotune button on the faceplate. This is a supported
end-user/solution-provider enhancement that does not void tech support.
For information on how to use the Autotune function, refer to the following
Logix Designer online help topics:
• Function Block Properties Dialog Box – Autotune Tab Overview (PIDE)
• PIDE Autotune Dialog Box Overview
8 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Proportional + Integral + Derivative Enhanced (P_PIDE)
Required Files
Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times in
your application code as needed.
Controller File
The P_PIDE_3_5-00_AOI.L5X Add-On Instruction must be imported into
the controller project to be used in the controller configuration. The service
release number (boldfaced) can change as service revisions are created.
Visualization Files
This Add-On Instruction has associated visualization files that provide a
common user interface. These files can be downloaded from the Product
Compatibility and Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.
IMPORTANT
The visualization file dependencies require Process Library content imports to
occur in a specific order as reflected in the following tables:
• Images
• Global Objects
• Standard Displays
• HMI Tags
• Macros
Images are external graphic files that can be used in displays. They must be
imported for FactoryTalk View to make use of them.
When PNG files are imported, they are renamed by FactoryTalk View with
a .bmp file extension, but retain a .png format.
Table 2 - Visualization Files: Images (.png)
FactoryTalk View SE Software FactoryTalk View ME Software Description
All .png files in the images folder All .png files in the images folder These are the common icons used in the global objects and
standard displays for all Process Objects.
The Global Object files (.ggfx file type) in the following table are Process Library
display elements that are created once and referenced multiple times on multiple
displays in an application. When changes are made to a Global Object, all
instances in the application are automatically updated.
Table 3 - Visualization Files: Global Objects (.ggfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) Common Faceplate Objects (RA-BAS-ME) Common Faceplate Objects Global objects used on process object faceplates.
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 9
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 3 - Visualization Files: Global Objects (.ggfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) P_PID Graphics Library (RA-BAS-ME) P_PID Graphics Library PID global object device symbols used to build
(RA-BAS) Process Alarm Objects (RA-BAS-ME) Process Alarm Objects Global objects used for managing alarms on process
(RA-BAS) Process Diagnostic Objects (RA-BAS-ME) Process Diagnostic Objects Diagnostic global objects used on process object
(RA-BAS) Process Faceplate Analog Objects (RA-BAS-ME) Process Faceplate Analog Objects Analog global objects used on process object faceplates.
(RA-BAS) Process Help Objects (RA-BAS-ME) Process Help Objects Global objects used for all process objects help displays.
(RA-BAS) Process Interlock Objects (RA-BAS-ME) Process Interlock Objects Global objects used for managing interlocks and
(RA-BAS) Process Mode Objects (RA-BAS-ME) Process Mode Objects Global objects used for managing modes on process
(RA-BAS) BuiltIn Faceplate Objects (RA-BAS-ME) BuiltIn Faceplate Objects Optional
(RA-BAS) BuiltIn Help Objects (RA-BAS-ME) BuiltIn Help Objects Optiional
process graphics.
object faceplates.
faceplates.
permissives on process object faceplates.
object faceplates.
Global objects for built-in instruction faceplates.
Global objects for built-in instruction Help displays.
The Standard Display files (.gfx file type) in the following table are the Process
Library displays that you see at runtime.
Table 4 - Visualization Files: Standard Displays (.gfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) Common-AnalogEdit N/A Faceplate used for analog input data entry. The FactoryTalk
(RA-BAS) P_Alarm-Faceplate (RA-BAS-ME) P_Alarm-Faceplate The faceplate that is used for managing alarms for
(RA-BAS) P_Alarm-Help (RA-BAS-ME) P_Alarm-Help Alarm Help information that is accessed from the
(RA-BAS) P_Gate-Faceplate (RA-BAS-ME) P_Gate-Faceplate The gate faceplate display used for the object.
(RA-BAS) P_Mode-Config (RA-BAS-ME) P_Mode-Config The Configuration Display used to configure the
(RA-BAS) P_Mode-Help (RA-BAS-ME) P_Mode-Help Mode Help information that is accessed from the
(RA-BAS) P_PIDE-Faceplate (RA-BAS-ME) P_PIDE-Faceplate The faceplate that is used for the object
(RA-BAS) P_PIDE-Quick (RA-BAS-ME) P_PIDE-Quick The Quick display that is used for the object
(RA-BAS) Process PID Family-Help (RA-BAS-ME) Process PID Family-Help The Help display for PID objects
(RA-BAS) Built-In Autotune-Faceplate (RA-BAS-ME) Built-In Autotune-Faceplate Optional
(RA-BAS) P_Intlk-Faceplate (RA-BAS-ME) P_Intlk-Faceplate Optional
View ME faceplates use the native analog input data entry
so no file is required.
the object.
P_AIarm faceplate.
P_Mode object.
Help faceplate.
The Autotune faceplate display that is used for the object
Use this file if the object has an associated Autotune object
and you enable navigation to the Autotune faceplate from
the object faceplate.
The interlock faceplate used for the object.
Use this file if your Discrete Output has an associated
P_Intlk object and you enable navigation to its faceplate
from the Discrete Output faceplate.
10 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 4 - Visualization Files: Standard Displays (.gfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) P_Perm-Faceplate (RA-BAS-ME) P_Perm-Faceplate Optional
Permissive faceplate that is used for the object
Use this file if your object has an associated P_Perm object
and you enable navigation to the P_Perm faceplate from
the object faceplate.
(RA-BAS) Process Interlock Family-Help (RA-BAS-ME) Process Interlock Family-Help Optional
Interlock/permissives help display that is used for
the object
Use this file if you use the P_Intlk or P_Perm faceplate.
HMI Tags are created in a FactoryTalk View ME application to support tab
switching on Process Library faceplates. The HMI tags may be imported via the
comma-separated values file (.csv file type) in the following table.
Table 5 - Visualization Files: HMI Tags (.csv)
FactoryTalk View SE Software FactoryTalk View ME Software Description
N/A FTVME_PlantPAxLib_Tags_3_5_xx.csv
where xx = the service release number.
These tags must be imported into the
FactoryTalk View ME project to support switching tabs on
any Process Object faceplate.
Controller Code
This section describes the parameter references for this Add-On Instruction.
Proportional + Integral + Derivative Enhanced Input Structure
Input parameters include the following:
• Input data elements (Inp_) are typically used to connect field inputs from
I/O modules or signals from other objects.
• Configuration data elements (Cfg_) are used to set configurable
capabilities and features of the instruction.
• Commands (PCmd_, OCmd_, MCmd_) are used by program logic,
operators, and maintenance personnel to request instruction actions.
• Settings (PSet_, OSet_, MSet_) are used by program logic, operators, and
maintenance personnel to establish runtime setpoints, thresholds, and so
forth. A Setting (without a leading P, O, or M) establishes runtime settings
regardless of role or mode.
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 11
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 7 - P_PIDE Input Parameters
Input Parameter Data
Type
EnableIn BOOL 1 Ladder Diagram:
Inp_PV REAL Wrk_PIDE.PV 0.0 Input signal Process Variable (PV) from sensor (PV engineering units).
Inp_CascSP REAL Wrk_PIDE.SPCascade 0.0 Setpoint in cascade, independent PV in Ratio (PV engineering units).
Inp_FF REAL Wrk_PIDE.FF 0.0 FeedForward term (Controlled Variable (CV)%).
Inp_FFPrev REAL Wrk_PIDE.FFPrevious 0.0 FeedForward feedback from downstream block (CV%).
Inp_CVInitVal REAL Wrk_PIDE.CVInitValue 0.0 Value to initialize the CV to when requested (CV engineering units).
Inp_CVPrev REAL Wrk_PIDE.CVPrevious 0.0 CV feedback from downstream block (CV%).
Inp_PVSrcQ SINT 0 Source and Quality of Inp_PV (enumeration)
Inp_OvrdCmd SINT 0 Override Loop mode command:
Inp_OvrdRatio REAL 1.0 Ratio to use in Override mode (unitless).
Inp_OvrdSP REAL 0.0 Setpoint (SP) to use in Override mode (PV engineering units).
Inp_OvrdCV REAL 0.0 CV to use in Override mode (CV%).
Inp_HandFdbk REAL Wrk_PIDE.HandFB 0.0 CV feedback used in Hand mode (CV%).
Inp_PVBad BOOL Wrk_PIDE.PVFault 0 Bad signal quality/communication status for inputs (1 = Bad, 0 = OK). If PV is
Inp_PVUncertain BOOL 0 Uncertain quality for inputs (1 = Uncertain, 0 = OK). This is optional status for
Inp_CVIOFault BOOL Wrk_PIDE.CVFault 0 1 = CV I/O communication status bad
Inp_UseFFPrev BOOL Wrk_PIDE.FFSetPrevious 0 1 = Use Inp_FFPrev as previous FF value
Inp_UseCVInitVal BOOL Wrk_PIDE.CVInitReq 0 1 = Initialize CV to Inp_CVInitValue
Inp_UseCVPrev BOOL Wrk_PIDE.CVSetPrevious 0 1 = Use Inp_CVPrev as previous CV value
Inp_WindupHi BOOL Wrk_PIDE.WindupHIn 0 Windup high signal
Inp_WindupLo BOOL Wrk_PIDE.WindupLIn 0 Windup low signal
Inp_Ovrd BOOL Mode.Inp_Ovrd 0 1 = Acquire Override (higher priority program logic) mode
Inp_Hand BOOL Mode.Inp_Hand 0 1 = Acquire Hand (hard-wired local) mode
Inp_HandFdbkBad BOOL Wrk_PIDE.HandFBFault 0 1 = Inp_HandFdbk input quality or I/O communication status bad
Alias For Default Description
If the rung-in condition is true, the instruction’s Logic routine executes. If the
rung-in condition is false, the instruction’s EnableInFalse routine executes.
Function Block Diagram:
If true, or not connected, the instruction’s Logic routine executes. If the
parameter is exposed as a pin and wired, and the pin is false, the instruction’s
EnableInFalse routine executes.
Structured Text:
No effect. The instruction’s Logic routine executes.
0 = None
1 = Manual
2 = Automatic
3 = Cascade
read from an analog input, then this is normally read from the analog input
channel fault status.
the input that can be used to drive the status of the output (Sts_PVUncertain).
0 = OK
0 = Use last scan value
0 = Use last scan value
1 = Regulator does not increase the output
1 = Regulator does not decrease the output
0 = Release Override mode
0 = Release Hand mode
0 = OK
12 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Table 7 - P_PIDE Input Parameters
Proportional + Integral + Derivative Enhanced (P_PIDE)
Input Parameter Data
Type
Inp_IntlkOK BOOL 1 1 = Interlocks and non-bypassable Interlocks OK, analog output can be set.
Inp_NBIntlkOK
Inp_HiHiDevGate BOOL HiHiDevGate.Inp_Gate 1 High-High deviation status gate:
Inp_HiDevGate HiDevGate.Inp_Gate High deviation status gate:
Inp_LoDevGate LoDevGate.Inp_Gate Low deviation status gate:
Inp_LoLoDevGate LoLoDevGate.Inp_Gate Low-Low deviation status gate:
Inp_Reset BOOL 0 Input parameter used to programmatically reset alarms. When set to 1, all
Cfg_HasRatio BOOL Wrk_PIDE.UseRatio 0 1 = Cascade Loop mode uses ratio
Cfg_HasCasc BOOL Wrk_PIDE.AllowCasRat 0 1 = Enable the loop to be placed into Cascade/ratio mode
Cfg_PVTrack BOOL Wrk_PIDE.PVTracking 1 1 = SP tracks PV in manual
Cfg_CtrlAction BOOL Wrk_PIDE.ControlAction 0 1 = Direct acting (E = PV-SP)
Cfg_Depend BOOL Wrk_PIDE.DependIndepend 1 1 = Dependent gains equation
Cfg_DerivSmooth BOOL Wrk_PIDE.DSmoothing 0 1 = Use derivative smoothing
Cfg_ZCOff BOOL Wrk_PIDE.ZCOff 0 1 = Need not cross zero error to be in deadband
Cfg_LimitManCV BOOL Wrk_PIDE.CVManLimiting 0 1 = CV limits enforced in manual
Cfg_InitToMan BOOL Wrk_PIDE.ManualAfterInit 0 1 = Go to Manual Loop mode when a CV initialization request is seen
Cfg_PropSPAct BOOL Wrk_PIDE.PVEProportional 0 Proportional action on SP change:
Cfg_DerivSPAct BOOL Wrk_PIDE.PVEDerivative 1 Derivative action on SP change:
Cfg_PwrupLM SINT 0 Powerup Loop mode:
Cfg_SetTrack BOOL 1 This parameter is used to set up bumpless behavior of setting parameters
Cfg_SetTrackOvrdHand BOOL 0 1 = Program/Operator settings track Override/Hand inputs (CV, SP, Ratio)
Alias For Default Description
1 = Enabled.
1 = Enabled
1 = Enabled
1 = Enabled
alarms requiring reset are reset.
0 = Cascade Loop mode does not use ratio
0 = No PV tracking
0 = Reverse acting (E = SP-PV)
0 = Independent gains
0 = Must cross zero error
0 = No CV limiting in manual
1 = None (PV only)
0 = Full (loop error)
1 = None (PV only)
0 = Full (loop error)
0 = No change (last)
1 = Manual (with CV)
2 = Automatic (with SP)
3 = Cascade/Ratio
when switching modes. When this parameter is 1, in Program mode the
operator settings track the program settings; in Operator mode the program
settings track the operator settings; and the simulation inputs match the
output values (transitions are bumpless).
When this parameter is 0, the operator settings and program settings are not
modified by this instruction. In this case, when the mode is changed, the
effective value of the setting can change depending on the program-set and
operator-set values.
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 13
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 7 - P_PIDE Input Parameters
Input Parameter Data
Type
Cfg_HasIntlkObj BOOL 0 1 = Tells HMI an interlock object (for example, P_Intlk) is used for Inp_IntlkOK
Cfg_HasCascSPNav BOOL 0 1 = Tells HMI to enable navigation to a connected cascade SP object
Cfg_HasPVNav BOOL 0 1 = Tells HMI to enable navigation to a connected PV object
Cfg_HasCVNav BOOL 0 1 = Tells HMI to enable navigation to a connected CV object
Cfg_OvrdIntlk BOOL 0 1 = Override ignores bypassable interlock
Cfg_PCmdClear BOOL Mode.Cfg_PCmdClear 1 When this parameter is 1, program commands are cleared once they are acted
Cfg_ProgDefault BOOL Mode.Cfg_ProgDefault 0 This parameter defines the default mode. When this parameter is 1, the mode
Cfg_HasHiHiDevAlm BOOL HiHiDev.Cfg_Exists 0 These parameters determine whether the corresponding alarm exists and is
Cfg_HasHiDevAlm HiDev.Cfg_Exists
Cfg_HasLoDevAlm LoDev.Cfg_Exists
Cfg_HasLoLoDevAlm LoLoDev.Cfg_Exists
Cfg_HasIntlkTripAlm IntlkTrip.Cfg_Exists
Cfg_HasFailAlm Fail.Cfg_Exists
Cfg_HiHiDevResetReqd BOOL HiHiDev.Cfg_ResetReqd 0 These parameters determine whether a reset is required to clear the alarm
Cfg_HiDevResetReqd HiDev.Cfg_ResetReqd
Cfg_LoDevResetReqd LoDev.Cfg_ResetReqd
Cfg_LoLoDevResetReqd LoLoDev.Cfg_ResetReqd
Cfg_IntlkTripResetReqd IntlkTrip.Cfg_ResetReqd
Cfg_FailResetReqd Fail.Cfg_ResetReqd
Cfg_HiHiDevAckReqd BOOL HiHiDev.Cfg_AckReqd 1 These parameters determine whether an acknowledgement is required for an
Cfg_HiDevAckReqd HiDev.Cfg_AckReqd
Cfg_LoDevAckReqd LoDev.Cfg_AckReqd
Cfg_LoLoDevAckReqd LoLoDev.Cfg_AckReqd
Cfg_IntlkTripAckReqd IntlkTrip.Cfg_AckReqd
Cfg_FailAckReqd Fail.Cfg_AckReqd
Alias For Default Description
and navigation to the interlock object’s faceplate is enabled
IMPORTANT: The name of the Interlock object in the controller must be this
object's name with the suffix ‘_Intlk’. For example, if your P_PIDE object has
the name ’PIDE123’, then its Interlock object must be named ‘PIDE123_Intlk’.
0 = Always use interlock
upon. When set to 0, program commands remain set until cleared by the
application program logic.
IMPORTANT: Clearing this parameter online can cause unintended program
command execution.
defaults to Program if no mode is being requested. When this parameter is 0,
the mode defaults to Operator if no mode is being requested.
IMPORTANT: Changing this parameter online can cause unintended mode
changes.
checked or if the alarm does not exist and is not used. When these parameters
are 1, the corresponding alarm exists.
status. When these parameters are 1, the alarm is latched ON when the alarm
occurs. After the alarm condition returns to normal, a reset is required to clear
the alarm status (for example, OCmd_Reset, Inp_Reset, or
HiHiDev.OCmd_Reset are required to clear Alm_HiHiDev alarm after the alarm
is set and the value returns to normal). When these parameters are 0, no reset
is required and the alarm status is cleared when the alarm condition returns to
normal.
IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.
alarm. When these parameters are 1, the acknowledge (ack) bit is cleared
when the alarm occurs. An acknowledge command (for example,
PCmd_FailAck or Fail.OCmd_Ack) is required to acknowledge the alarm. When
set to 0, the Acknowledge bit is set when an alarm occurs indicating an
acknowledged alarm and no acknowledge command is required.
14 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Table 7 - P_PIDE Input Parameters
Proportional + Integral + Derivative Enhanced (P_PIDE)
Input Parameter Data
Type
Cfg_HiHiDevSeverity INT HiHiDev.Cfg_Severity 750 These parameters determine the severity of each alarm. This drives the color
Cfg_HiDevSeverity HiDev.Cfg_Severity 500
Cfg_LoDevSeverity LoDev.Cfg_Severity 500
Cfg_LoLoDevSeverity LoLoDev.Cfg_Severity 750
Cfg_IntlkTripSeverity IntlkTrip.Cfg_Severity 500
Cfg_FailSeverity Fail.Cfg_Severity 1000
Cfg_MinRatio REAL Wrk_PIDE.RatioLLimit 1.0 Minimum and maximum allowed ratio (unitless).
Cfg_MaxRatio Wrk_PIDE.RatioHLimit 1.0
Cfg_MinSP REAL Wrk_PIDE.SPLLimit 0.0 Minimum allowed setpoint (SP) value (PV engineering units).
Cfg_MaxSP REAL Wrk_PIDE.SPHLimit 100.0 Maximum allowed setpoint (SP) value (PV engineering units).
Cfg_PVEUMin REAL Wrk_PIDE.PVEUMin 0.0 PV engineering units Minimum value (PV engineering units).
Cfg_PVEUMax REAL Wrk_PIDE.PVEUMax 100.0 PV (Output) maximum for scaling to engineering units.
Cfg_CVEUMin REAL Wrk_PIDE.CVEUMin 0.0 CV engineering units minimum value (CV engineering units).
Cfg_CVEUMax REAL Wrk_PIDE.CVEUMax 100.0 CV engineering units maximum value (CV engineering units).
Cfg_CVRoCLim REAL Wrk_PIDE.CVROCLimit 0.0 CV rate of change limit (CV%/s), zero means do not limit.
Cfg_PGain REAL Wrk_PIDE.PGain 0.0 Proportional (independent) or loop (dependent) gain (unitless).
Cfg_IGain REAL Wrk_PIDE.IGain Integral gain (1/min independent or min/repeat dependent).
Cfg_DGain REAL Wrk_PIDE.DGain Derivative gain (min).
Cfg_ZCDB REAL Wrk_PIDE.ZCDeadband 0.0 Normal zero crossing deadband (PV engineering units).
Cfg_MinCV REAL Wrk_PIDE.CVLLimit 0.0 Minimum or maximum allowed controlled variable (CV) value (CV%).
Cfg_MaxCV REAL Wrk_PIDE.CVHLimit 100.0
Cfg_MaxInactiveCV REAL 0.0 When Val_CV is greater than this value (CV%) set Sts_Active (for HMI).
Cfg_IntlkCV REAL Wrk_PIDE.CVOverride 0.0 CV to use when interlocks not OK (CV%).
Cfg_DevDB REAL Wrk_PIDE.DevDeadband 0.0 Deviation alarm deadband (PV engineering units).
Cfg_PwrupSP REAL 0.0 Loop SP on powerup, used if Cfg_PwrupLM = 1 (manual) or 2 (automatic).
Cfg_PwrupCV REAL 0.0 Loop CV (CV %) on powerup, used if Cfg_PwrupLM <> 0 (none).
Cfg_HiHiDevOnDly DINT HiHiDevGate.Cfg_OnDly 0 These parameters determine the minimum time (in seconds) the loop
Cfg_HiDevOnDly HiDevGate.Cfg_OnDly
Cfg_LoDevOnDly LoDevGate.Cfg_OnDly
Cfg_LoLoDevOnDly LoLoDevGate.Cfg_OnDly
Cfg_HiHiDevOffDly DINT HiHiDevGate.Cfg_OffDly 0 These parameters determine the amount of time (in seconds) the loop
Cfg_HiDevOffDly HiDevGate.Cfg_OffDly
Cfg_LoDevOffDly LoDevGate.Cfg_OffDly
Cfg_LoLoDevOffDly LoLoDevGate.Cfg_OffDly
Alias For Default Description
and symbol that are used to indicate alarm status on the faceplate and global
object.
The following are valid values:
1…250 = Low
251…500 = Medium
501…750 = High
751…1000 = Urgent
IMPORTANT: For FactoryTalk View software version 7.0, these severity
parameters drive only the indication on the global object and faceplate. The
FactoryTalk Alarms and Events definition of severity drives the color and
symbol that is used on the alarm banner and alarm summary as well as the
value returned by FactoryTalk Alarms and Events display commands.
TIP: The P_PIDE instruction supports reverse CV EU scaling, Cfg_CVEUMax can
be less than (but not equal to) Cfg_CVEUMin.
deviation must remain beyond the status threshold for the status to be set. Ondelay times are used to avoid unnecessary alarms when the deviation
momentarily overshoots its threshold (for example, Val_HiHiDevLim).
deviation must stay within each status threshold to clear the status. Off delay
times are used to reduce chattering alarms.
EXAMPLE: If Cfg_HiDevOffDly is 5 seconds, the loop deviation must be below
the status limit (Val_HiHiDevLim) minus deadband (Cfg_DevDB) for 5 seconds
before the status is returned to normal.
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 15
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 7 - P_PIDE Input Parameters
Input Parameter Data
Type
Cfg_HiHiDevGateDly DINT HiHiDevGate.Cfg_GateDly 0 These parameters determine the amount of time (in seconds) the gate input
Cfg_HiDevGateDly HiDevGate.Cfg_GateDly
Cfg_LoDevGateDly LoDevGate.Cfg_GateDly
Cfg_LoLoDevGateDly LoLoDevGate.Cfg_GateDly
PSet_Ratio REAL 1.0 Program setting for ratio (loop cascade and ratio enabled) (unitless).
PSet_SP 0.0 Program setting for setpoint (loop auto) (PV engineering units).
PSet_CV 0.0 Program setting for controlled variable (loop manual) (CV%).
PSet_HiHiDevLim REAL 3.40282347e+038 Program setting for High-High, High, Low, or Low-Low deviation status
PSet_HiDevLim
PSet_LoDevLim -3.40282347e+038
PSet_LoLoDevLim
PSet_Owner DINT 0 Program owner request ID (non-zero) or release (zero).
OSet_Ratio REAL 1.0 Operator setting for ratio (loop cascade and ratio enabled) (unitless).
OSet_SP 0.0 Operator setting for setpoint (loop auto) (PV engineering units).
OSet_CV 0.0 Operator setting for controlled variable (loop manual) (CV%).
OSet_HiHiDevLim 3.40282347e+038 Operator settings for High-High, High, Low, or Low-Low deviation status
OSet_HiDevLim
OSet_LoDevLim -3.40282347e+038
OSet_LoLoDevLim
PCmd_Casc BOOL 0 When Cfg_PCmdClear is 1:
PCmd_Auto
PCmd_Man
PCmd_Acq BOOL Mode.PCmd_Acq 0 When Cfg_PCmdClear is 1:
PCmd_Rel Mode.PCmd_Rel
PCmd_Lock BOOL Mode.PCmd_Lock 0 When Cfg_PCmdClear is 1:
PCmd_Unlock Mode.PCmd_Unlock
PCmd_Reset BOOL 0 • Set PCmd_Reset to 1 to reset all alarms requiring reset
Alias For Default Description
must be turned on for threshold detection to be enabled. On delays and off
delays are applied after the gate delay is complete.
threshold (PV engineering units).
threshold (PV engineering units).
• Set PCmd_Casc to 1 to select Cascade/Ratio Loop mode
• Set PCmd_Auto to 1 to select Automatic Loop mode
• Set PCmd_Man to 1 to select Manual Loop mode
• These parameters reset automatically
When Cfg_PCmdClear is 0:
• Set PCmd_Casc to 1 to select Cascade/Ratio Loop mode
• Set PCmd_Auto to 1 to select Automatic Loop mode
• Set PCmd_Auto and PCmd_Casc to 0 to select Manual Loop mode
• PCmd_Man is not used
• These parameters do not reset automatically
• Set PCmd_Acq to 1 to Acquire
• Set PCmd_Rel to 1 to Release
• These parameters reset automatically
When Cfg_PCmdClear is 0:
• Set PCmd_Acq to 1 to Acquire
• Set PCmd_Acq to 0 to Release
• PCmd_Rel is not used
• These parameters do not reset automatically
• Set PCmd_Lock to 1 to Lock
• Set PCmd_Unlock to 1 to Unlock
• These parameters reset automatically
When Cfg_PCmdClear is 0:
• Set PCmd_Lock to 1 to Lock
• Set PCmd_Lock to 0 to Unlock
• PCmd_Unlock is not used
• These parameters do not reset automatically
• This parameter is always reset automatically
16 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Table 7 - P_PIDE Input Parameters
Proportional + Integral + Derivative Enhanced (P_PIDE)
Input Parameter Data
Type
PCmd_HiHiDevAck BOOL HiHiDev.PCmd_Ack 0 • Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm
PCmd_HiDevAck HiDev.PCmd_Ack
PCmd_LoDevAck LoDev.PCmd_Ack
PCmd_LoLoDevAck LoLoDev.PCmd_Ack
PCmd_IntlkTripAck IntlkTrip.PCmd_Ack
PCmd_FailAck Fail.PCmd_Ack
PCmd_HiHiDevSuppress BOOL HiHiDev.PCmd_Suppress 0 When Cfg_PCmdClear is 1:
PCmd_HiDevSuppress HiDev.PCmd_Suppress
PCmd_LoDevSuppress LoDev.PCmd_Suppress
PCmd_LoLoDevSuppress LoLoDev.PCmd_Suppress
PCmd_IntlkTripSuppress IntlkTrip.PCmd_Suppress
PCmd_FailSuppress Fail.PCmd_Suppress
PCmd_HiHiDevUnsuppress BOOL HiHiDev.PCmd_Unsuppress 0
PCmd_HiDevUnsuppress HiDev.PCmd_Unsuppress
PCmd_LoDevUnsuppress LoDev.PCmd_Unsuppress
PCmd_LoLoDevUnsuppress LoLoDev.PCmd_Unsuppress
PCmd_IntlkTripUnsuppress IntlkTrip.PCmd_Unsuppress
PCmd_FailUnsuppress Fail.PCmd_Unsuppress
PCmd_HiHiDevUnshelve BOOL HiHiDev.PCmd_Unshelve 0 • Set PCmd_<Alarm>Unshelve to 1 to Unshelve alarm
PCmd_HiDevUnshelve HiDev.PCmd_Unshelve
PCmd_LoDevUnshelve LoDev.PCmd_Unshelve
PCmd_LoLoDevUnshelve LoLoDev.PCmd_Unshelve
PCmd_IntlkTripUnshelve IntlkTrip.PCmd_Unshelve
PCmd_FailUnshelve Fail.PCmd_Unshelve
OCmd_Casc BOOL 0 Operator commands to select Cascade/ratio (Casc), Automatic (Auto), or
OCmd_Auto BOOL 0
OCmd_Man BOOL 0
OCmd_Bypass BOOL 0 Operator command to bypass the bypassable interlocks.
OCmd_Check BOOL 0 Operator command to check (not bypass) all interlocks.
MCmd_Disable BOOL 0 Maintenance command to disable or enable PID loop.
MCmd_Enable
MCmd_Acq BOOL Mode.MCmd_Acq 0 Maintenance command to acquire ownership (operator/program/override to
MCmd_Rel BOOL Mode.MCmd_Rel 0 Maintenance command to release ownership (maintenance to operator/
OCmd_AcqLock BOOL Mode.OCmd_AcqLock 0 Operator command to acquire (program to operator)/lock ownership.
OCmd_Unlock BOOL Mode.OCmd_UnlockRel 0 Operator command to unlock/release (operator to program) ownership.
OCmd_Reset BOOL 0 Operator command to reset all alarms requiring reset.
OCmd_ResetAckAll BOOL 0 Operator command to reset all alarms and latched shed conditions.
Alias For Default Description
• The parameter is reset automatically
• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
• Set PCmd_<Alarm>Unsuppress to 1 to unsuppress alarm
• These parameters reset automatically
When Cfg_PCmdClear is 0:
• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
• Set PCmd_<Alarm>Suppress to 0 to unsuppress alarm
• PCmd_<Alarm>Unsuppress is not used
• These parameters do not reset automatically
• The parameter is reset automatically
Manual (Man) Loop mode.
Maintenance).
program/override).
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 17
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 8 - P_PIDE Output Parameters
Proportional + Integral + Derivative Enhanced Output Structure
Output parameters include the following:
• Output data elements (Out_) are the primary outputs of the instruction,
typically used by hardware output modules; however, they can be used by
other application logic.
• Value data elements (Val_) are numeric outputs of the instruction for use
by the HMI. Values can also be used by other application logic or software
packages.
• Source and Quality data elements (SrcQ_) are outputs of the instruction
used by the HMI to indicate PV source and quality.
• Status data elements (Sts_) are bit outputs of the instruction for use by the
HMI. Status bits can also be used by other application logic.
• Error data elements (Err_) are outputs of the instruction that indicate a
particular configuration error. If any Err_ bit is set, then the Sts_Err
configuration error summary status is set and the Invalid Configuration
indicator is displayed on the HMI.
• Not Ready data elements (Nrdy_) are bit outputs of the instruction for use
by the HMI for displaying the Device Not Ready indicator. Not Ready bits
can also be used by other application logic.
• Alarm data elements (Alm_) are outputs of the instruction that indicate a
particular alarm has occurred.
• Acknowledge data elements (Ack_) are outputs of the instruction that
indicate the corresponding alarm has been acknowledged.
• Ready data elements (Rdy_) are bit outputs of the instruction used by the
HMI to enable or disable Command buttons and Setting entry fields.
Output Parameter Data Type Alias For Description
EnableOut BOOL Enable output: The EnableOut signal is not manipulated by this instruction. Its output state
Out_CV REAL Wrk_PIDE.CVEU CV to final control element (CV engineering units).
Val_PV REAL Loop PV (PV engineering units).
Val_Ratio REAL Wrk_PIDE.Ratio The current ratio (unitless).
Val_SPSet REAL Value of selected SP (before clamping) (PV engineering units).
Val_SP REAL Wrk_PIDE.SP Value of SP being used (after clamping) (PV engineering units).
Val_E REAL Wrk_PIDE.E Loop error (PV-SP) (PV engineering units).
Val_CVSet REAL Value of CV output (before ramping and clamping (CV%).
Val_CVOut REAL Wrk_PIDE.CV Value of CV output (after ramping and clamping (CV%).
Val_PVPercent REAL Wrk_PIDE.PVPercent Loop PV (percent of span).
Val_SPPercent REAL Wrk_PIDE.SPPercent Loop SP (percent of span).
Val_EPercent REAL Wrk_PIDE.EPercent Loop error (PV-SP) (percent of span).
Val_ActExecT REAL Wrk_PIDE.DeltaT Actual PID algorithm execution time (elapsed time between updates) (seconds).
Val_Init REAL Initialization value for this loop's cascade primary (PV engineering units).
Val_PVEUMin REAL Minimum of PV scaled range (PV engineering units).
always reflects EnableIn input state.
18 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 8 - P_PIDE Output Parameters
Output Parameter Data Type Alias For Description
Val_PVEUMax REAL Maximum of PV scaled range (PV engineering units).
Val_CVEUMin REAL Minimum of CV scaled range (CV engineering units).
Val_CVEUMax REAL Maximum of CV scaled range (CV engineering units).
SrcQ_IO SINT I/O signal source and quality.
SrcQ Final source and quality.
GOOD 0 = I/O live and confirmed good quality
1 = I/O live and assumed good quality
2 = No feedback configured, assumed good quality
TEST 8 = Device simulated
9 = Device loopback simulation
10 = Manually entered value
UNCERTAIN 16 = Live input, off-specification
17 = Value substituted at device/bus
18 = Value substituted by maintenance (Has and not Use)
19 = Shed, using last good value
20 = Shed, using replacement value
BAD 32 = Signal failure (out-of-range, NaN, invalid combination)
33 = I/O channel fault
34 = I/O module fault
35 = Bad I/O configuration (for example, scaling parameters)
Val_Sts SINT Loop status enumeration:
0 = Unknown
1 = Manual
2 = Auto
3 = Cascade
4 = Ratio
33 = Disabled
Val_Fault SINT Loop fault status:
0 = None
22 = Low Deviation
23 = High Deviation
27 = Low-Low Deviation
28 = High-High Deviation
29 = Interlock Trip Shed
32 = FailShed
34 = Configuration Error
Val_State Loop algorithm state:
1 = In deadband
2 = Outside deadband controlling
5 = Ratio clamped
6 = SP clamped
7 = CV clamped
8 = Windup Low
9 = Windup High
13 = Interlocked
14 = Hand
15 = Initializing
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 19
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 8 - P_PIDE Output Parameters
Output Parameter Data Type Alias For Description
Val_Mode SINT Mode.Val The current mode is shown with status bits and also as an enumeration ‘Val_Mode’ as
Val_Owner DINT Current object owner ID (0 = not owned).
Val_Notify SINT Current alarm level and acknowledgement (enumeration):
Val_HiHiDevLim REAL Wrk_PIDE.DevHHLimit Current High-High, High, Low, Low-Low deviation status threshold (PV engineering units).
Val_HiDevLim Wrk_PIDE.DevHLimit
Val_LoDevLim Wrk.PIDE.DevLLimit
Val_LoLoDevLim Wrk.PIDE.DevLLLimit
Sts_InstrFaults1 DINT 2#0000_0000_0000_0000
_0000_0000_0000_0000
Sts_InstrFaults2 2#0000_0000_0000_0000
_0000_0000_0000_0000
Sts_Casc BOOL Wrk_PIDE.CasRat 1 = Loop mode is cascade/ratio, automatic, or manual.
Sts_Auto Wrk_PIDE.Auto
Sts_Man Wrk_PIDE.Manual
Sts_Initializing BOOL Wrk_PIDE.CVInitializing 1 = CV is initializing because of request from this loop's secondary.
Sts_InitReq BOOL Wrk_PIDE.InitPrimary 1 = CV initialize request to this loop's primary.
Sts_WindupHi BOOL Wrk_PIDE.WindupHOut 1 = This loop winding up High, to Inp_WindupHi of this loop's primary.
Sts_WindupLo BOOL Wrk_PIDE.WindupLOut 1 = This loop winding up Low, to Inp_WindupLo of this loop's primary.
Sts_ZCDBOn BOOL Wrk_PIDE.ZCDeadbandOn Deadband indicator:
Sts_RatioClamped BOOL 1 = Selected ratio (PSet/OSet_Ratio or Inp_OvrdRatio) has been clamped.
Sts_SPBad BOOL Wrk_PIDE.SPOperInv 1 = SP Value is bad (quality) or invalid or Casc SP communication fault.
Sts_SPClamped BOOL 1 = Selected SP is being clamped (for faceplate animation).
Sts_PVBad BOOL Wrk_PIDE.PVFaulted 1 = PV Value, communication, quality, or engineering units limit is bad.
Sts_PVUncertain BOOL 1 = PV Value is uncertain (quality).
Sts_FFBad BOOL Wrk_PIDE.FFInv 1 = Feedforward term value is invalid.
follows:
0 = No mode
1 = Hand
2 = Maintenance
3 = Override
4 = Program (locked)
5 = Operator (locked)
6 = Program (unlocked, Operator is default)
7 = Operator (unlocked, Program is default)
8 = Program (unlocked, Program is default)
9 = Operator (unlocked, Operator is default)
0 = No alarm
1 = Alarm cleared: a reset or acknowledge is required
2 = Low (acknowledged)
3 = Low (unacknowledged)
4 = Medium (acknowledged)
5 = Medium (unacknowledged)
6 = High (acknowledged)
7 = High (unacknowledged)
8 = Urgent (acknowledged)
9 = Urgent (unacknowledged)
These parameters are aliased to parameter DevHHLimit, DevHLimit, DevLLimit, or DevLLLimit
of the contained PIDE built-in instruction.
PIDE Block Status 1 Instruction Fault bits (see PIDE Instruction Help).
PIDE Block Status 2 Instruction Fault bits (see PIDE Instruction Help).
1 = Error is within zero-crossing deadband and CV does not change
20 Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017
Proportional + Integral + Derivative Enhanced (P_PIDE)
Table 8 - P_PIDE Output Parameters
Output Parameter Data Type Alias For Description
Sts_FFPrevBad BOOL Wrk_PIDE.FFPreviousInv 1 = Inp_FFPrev is <-100.0, >100.0, or not a number (NaN).
Sts_CVBad BOOL Wrk_PIDE.CVFaulted 1 = CV Value is bad (quality) or invalid or there is a CV communication fault.
Sts_CVPrevBad BOOL Wrk_PIDE.CVPreviousInv 1 = Inp_CVPrev is <0.0, >100.0, or not a number (NaN).
Sts_CVInitValBad BOOL 1 = Inp_CVInitVal is <0.0, >100.0, or not a number (NaN).
Sts_HandFdbkBad BOOL Wrk_PIDE.HandFBFaulted 1 = Hand feedback (tieback) value is bad (quality), invalid, or communication fault.
Sts_IntlkCV BOOL 1 = CV value being set by shed to Interlock CV.
Sts_CVClamped BOOL 1 = Selected CV is being clamped (for faceplate animation).
Sts_CVRamping BOOL Wrk_PIDE.CVROCAlarm 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’ (for example.
Sts_Available BOOL 1 = Instruction available for control by automation (Program).
Sts_Bypass BOOL 1 = Bypassable interlocks are bypassed.
Sts_BypActive BOOL 1 = Bypassing active (Bypassed or Maintenance).
Sts_Disabled BOOL 1 = Loop is disabled (held at configured Interlock CV).
Sts_NotRdy BOOL 1 = Loop is not ready to be operated. See detail Not Ready bit for reason.
Nrdy_Disabled BOOL 1 = Loop Not Ready:
Nrdy_CfgErr
Nrdy_Intlk
Nrdy_Init
Nrdy_IOFault
Nrdy_NoMode
Sts_MaintByp BOOL 1 = Loop has a maintenance bypass function active.
Sts_AlmInh BOOL 1 = One or more alarms shelved, disabled, or suppressed.
Sts_Err BOOL 1 = Error in configuration: see detail error bits for reason.
Err_RatioLim BOOL Wrk_PIDE.RatioLimitsInv 1 = Error in configuration: ratio clamping limits invalid.
Err_SPLim BOOL Wrk_PIDE.SPLimitsInv 1 = Error in configuration: setpoint clamping limits invalid.
Err_PVEU BOOL Wrk_PIDE.PVSpanInv 1 = Error in configuration: PV engineering units (EU) maximum/minimum invalid.
Err_CVLim BOOL Wrk_PIDE.CVLimitsInv 1 = Error in configuration: CV clamping limits invalid.
Err_CVEU BOOL Wrk_PIDE.CVEUSpanInv 1 = Error in configuration: CV engineering units (EU) maximum/minimum invalid.
Err_Timer BOOL 1 = Error in configuration: status on-delay or off-delay time invalid.
Err_DB BOOL Wrk_PIDE.ZCDeadbandInv 1 = Error in configuration: zero-crossing deadband invalid.
Err_Alarm BOOL 1 = Error in configuration: alarm severity, minimum on time, or shelf time invalid.
Sts_Hand BOOL Mode.Sts_Hand 1 = Mode is Hand (supersedes Operator, Program, Override, and Maintenance), Maintenance
Sts_Maint Mode.Sts_Maint
Sts_Ovrd Mode.Sts_Ovrd
Sts_Prog Mode.Sts_Prog
Sts_Oper Mode.Sts_Oper
Sts_ProgOperLock BOOL Mode.Sts_ProgOperLock 1 = Program or Operator has requested mode lock.
Sts_NoMode BOOL Mode.Sts_NoMode 1 = No mode selected (instruction scanned false).
valve open).
• Loop disabled by Maintenance
• Configuration error
• Interlock not OK
• Initialized to Manual mode
• I/O Fault (shed requires reset)
• Loop logic disabled/no mode
(supersedes Operator, Program, and Override), Override (supersedes Operator and Program),
Program, or Operator.
Rockwell Automation Publication SYSLIB-RM045D-EN-P - February 2017 21
Loading...