Vous êtes sur la page 1sur 314

NORTHEAST OHIO REGIONAL

SEWER DISTRICT

CLEVELAND, OHIO

BID FORM
AND
CONTRACT DOCUMENTS
FOR

CONTRACT SFPI-1
SOUTHERLY PRELIMINARY TREATMENT
FACILITY IMPROVEMENTS

SOUTHERLY WASTEWATER TREATMENT CENTER

NORTHEAST OHIO REGIONAL SEWER DISTRICT


JULIUS CIACCIA, EXECUTIVE DIRECTOR

May 11, 2012

APPENDIX F

NEORSD STANDARD OBJECT LIBRARY

Bid Contract Documents


Title: NEORSD Standard Object Library - Introduction

NEORSD Standard Object Library

Introduction

_NEORSD_OL_Introduction.doc Page 1 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 28-Jan-2011 PSIM All For Use
1.1.0 25-Apr-2012 PSIM All Added objects to list in 1.4.1

_NEORSD_OL_Introduction.doc Page 2 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

Table of Contents:
1.0  INTRODUCTION............................................................................................................. 4 
1.1  REFERENCES .................................................................................................................... 4 
1.2  DEFINITIONS .................................................................................................................... 4 
1.3  OPERATING PRINCIPLE ..................................................................................................... 5 
1.4  OBJECT LIBRARY ............................................................................................................. 5 
1.4.1  Object Library Templates ........................................................................................... 6 
1.5  WONDERWARE OBJECT INSTANCE CREATION STEPS ....................................................... 7 
1.5.1  How to create a new instance: .................................................................................... 7 
1.5.2  Use of UDA “Me.Placeholder” .................................................................................. 8 
1.5.3  Object Instance Descriptions and State Labels .......................................................... 8 
1.6  CONTROLLOGIX AOI CONFIGURATION ........................................................................... 9 
1.6.1  Trouble Indication ...................................................................................................... 9 
1.6.2  Simulation Monitoring ................................................................................................ 9 
2.0  SOFTWARE COMPONENT TRACKING ................................................................. 10 
2.1  SOFTWARE CONFIGURATION MANAGEMENT ................................................................. 10 
2.1.1  PLC Code – ControlLogix / CompactLogix ............................................................. 10 
2.1.2  OIT Code – PanelView Plus ..................................................................................... 11 
2.1.3  HMI Code - Wonderware.......................................................................................... 12 

_NEORSD_OL_Introduction.doc Page 3 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

1.0 Introduction
This document provides the common details of the NEORSD Standard Object Library. The
library is a set of custom objects designed to accomplish data transfer and process control
between the Control Logix PLC (CLX), the Wonderware HMI (WW) and the PanelView
Plus OIT (PV+).
A separate documents is created for each object, that will review the function and specific
attributes of that object. It is assumed the reader has a working knowledge of Rockwell
Logix5000 programming software, Wonderware System Platform 3, and Rockwell
FactoryView Studio.

1.1 References
Refer to the following NEORSD Automation Standards and Conventions sections:
 Part V Section 2 – Wonderware Programming Standards
 Part V Section 3 – ControlLogix Programming Standards
 Part V Section 4 – PanelView Plus Programming Standards

1.2 Definitions
Abbreviations &
Definition
Acronyms
Monitor and Control System; the fully integrated HMI/PLC/OIT system used for
MCS
process control at the NEORSD.
Common term for Wonderware Template Object, ControlLogix Add-On-
Object
Instructions, and PanelView Global Objects.
Attribute that begin with the CFG prefix are tags that need to be configured in the
CFG_*
PLC.
SME Subject Matter Expert
WRK_* Attributes that begin with the WRK prefix are PLC local variable.

_NEORSD_OL_Introduction.doc Page 4 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

1.3 Operating Principle


The control scheme at the NEORSD makes use of special features available in the
Wonderware System Platform 3 software. Using the manufacturer provided Base Template
Library (BTL) scripts, an object created in Wonderware may have all of its attributes linked
to the parameters of a similar object in a ControlLogix PLC. The same principle also applies
to OIT graphics when global objects are used in the PanelView Plus configuration.
The ControlLogix object is a custom developed Add On Instruction (AOI). The parameters
of this object become the attributes of the Wonderware template object. When the name of
the ControlLogix and Wonderware objects are identical, the Wonderware BTL scripts will
create the connections between parameters and attributes. This bypasses the manual step
normally performed to link PLC and HMI programming.
This programming technique also assists in streamlining the testing phase as the
combination of standard library object AOIs, Wonderware templates, and BTL scripted
environment enforces matching instance configuration details between the PLC and HMI
layers. The only caveat is that all communication between the HMI and the PLC must be
done through a matching Wonderware Template Object and a ControlLogix AOI (or UDT –
user defined data type which can be constructed to meet the needs of the template object).

1.4 Object Library


For ease of use and distribution the NEORSD Standard Object Library has been organized
into a series of per object library documents. Each provides the functional, design, and use
configuration details. The following document sections are typically found within each:
1. Object Features – highlights functional features of the object
2. Object Attributes – table that details the AOI / WW object parameters / attributes
 Columns under “Wonderware” are those found in the associated derived
object template.
 Only the parameters with direction indication are communicated between
the PLC and HMI layers. Direction indications of “UDA” are configured at
the Wonderware layer and PLC independently, but should match.
 List items that begin with the prefix CFG_ are PLC configuration
parameters. The local PLC variable (beginning with a prefix WRK_) are
not displayed in the tables.
3. Wonderware HMI – design details, instance configuration notes, and graphic
details
4. ControlLogix PLC – design details and instance configuration notes
5. PanelView OIT – design details, instance configuration notes, and graphic details

_NEORSD_OL_Introduction.doc Page 5 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

1.4.1 Object Library Templates


The following list identifies the objects in the NEORSD Standard Object Library,
at the time of printing.
 Analog
 Analog_Basic
 Analog_RW
 Analog_Setpoint
 Analog_Setpoint_Mode
 Diagnostics
 Discrete
 Discrete_RW
 Discrete_Setpoint
 Motor_Discrete
 Motor_Discrete_Indicator
 Motor_VFD
 Multistate_Indicator
 PB_Single_Select
 PID
 PIDE
 PLC_Status
 Restart_Inhibit
 RunTime
 Valve_Actuator
 Valve_Analog
 Valve_Analog_Indicator
 Valve_Discrete
 Valve_Discrete_Indicator

Note that the library is constantly growing by both in-house and contractor collaborative
development efforts. The programmer should contact the NEORSD for the latest set of
library objects.

_NEORSD_OL_Introduction.doc Page 6 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

1.5 Wonderware Object Instance Creation Steps


The following common steps are required to create new object instances from any of the
standard NEORSD Wonderware Object Library Templates. Additional instance creation
steps that are specific to a particular object template are found within that templates section.

1.5.1 How to create a new instance:


1) Find the template type you wish your instance to be derived from in the
Template Toolbox in the toolset: NEORSD
2) Right click on the template and choose New – Instance. In the Deployment
View a new instance is created. Name this instance following the NEORSD
object naming conventions.
3) Drag and drop the new instance into the desired deployment area. If an
identical area exists in the model view this instance will also be placed there.
Verify proper placement by checking to see all the errors/warnings are cleared
from the instance. If within a minute they don’t clear click on the instance
and Validate.
4) DO NOT modify the extended attributes – see example below.

The EUMax/EUMin UDAs overwrite the defaulted Max/Mins on the Ind


attribute through extensions. These values are left default from 0 – 100 for
scaling and 0 – 10 for trending. They are left unlocked and must remain
unlocked to allow the extensions to overwrite the values.

An example of where the extensions are defined is shown below. These


values are locked and cannot be altered on the instances level.

_NEORSD_OL_Introduction.doc Page 7 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

It is important to understand the concept and therefore not attempt to


overwrite or lock the Max/Min values or change any of the inherited
extensions.

1.5.2 Use of UDA “Me.Placeholder”


If there is an attribute that is not being used the UDA “Placeholder” to take the
attribute off scan. To do so change the Input Source of the attribute from “---“ to
Me.Placeholder.

This will overwrite the Input Script and instead of looking to the PLC for
information it will look internally at the UDA. The UDA exists so there will not
be an error but does not provide any information. If Me.Placeholder is being used
no additional configuration is required on that attribute.

1.5.3 Object Instance Descriptions and State Labels


Descriptions and State labels left unlocked can be customized on a per instance
level. This will often improve the user’s ability to understand and manage the
system. However, be aware when specifying unique descriptions and labels that
while there is technically no limit to message lengths those with long character
counts may make some displays too long to be properly displayed.

_NEORSD_OL_Introduction.doc Page 8 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

1.6 ControlLogix AOI Configuration


Common configuration for ControlLogix AOI instances are as follows:

1.6.1 Trouble Indication


Create logic to set the Trouble_Bit parameter. The Trouble indicator should be
tied to any hardware condition that could affect the quality of the associated
object data.

The Trouble_Desc is a InOut Reference Tag that will link to a string variable that
is set within the PLC logics, to provide additional information regarding the
reason for the active Trouble indication. A tag must be assigned to Trouble_Desc
for proper operation.

1.6.2 Simulation Monitoring


Most AOI have simulation logic built in to the block. When simulation is active it
must be annunciated at the HMI and OIT. Consolidate the Simulation enable bit
into the PLC Status object.

_NEORSD_OL_Introduction.doc Page 9 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

2.0 Software Component Tracking


All developed software components will be tracked by NEORSD. This is done to preserve
revision history control and to control distribution of the various software code bases in
use within NEORSD. At a minimum the following software configuration information
will be identified and tracked in a spreadsheet format:
1. Item Number / Description
2. Revision / Date / Reason
3. Application Software Version Used to Develop the Code
4. Software Code Filename / Location

2.1 Software Configuration Management


The following sections identify and define the required software configuration
management elements.

2.1.1 PLC Code – ControlLogix / CompactLogix


The following requirements apply for PLC supplied programming:
1. PLC Sample Project
a. Revision = X.Y.Z
i. X = Major revision change due to functional changes to the
software object that affects compatibility with
corresponding HMI / OIT elements. SME review and
approvals are required.
ii. Y = Minor revision change which can be functional but
does not alter the original functional intent of the software
object. SME review is typically not required.
iii. Z = Typographical corrections, or similar corrections.

2. PLC AOI
a. Revision = X.Y.Z
i. X = Major revision change due to functional changes to the
software object that affects compatibility with
corresponding HMI / OIT elements. SME review and
approvals are required.
ii. Y = Minor revision change which can be functional but
does not alter the original functional intent of the software
object. SME review is typically not required.

_NEORSD_OL_Introduction.doc Page 10 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

b. Extended Text
i. “NEORSD – Draft” – non-production release indicator
*object is not fully tested/approved
ii. “NEORSD” – programming/production release indicator
*object is fully tested/approved for general use
iii. Z = Typographical corrections, or similar corrections.

2.1.2 OIT Code – PanelView Plus


1. OIT Sample Project
a. Revision = X.Y.Z
i. X = Major revision change due to functional changes to the
software object that affects compatibility with
corresponding PLC / HMI elements. SME review and
approvals are required.
ii. Y = Minor revision change which can be functional but
does not alter the original functional intent of the software
object. SME review is typically not required.
iii. Z = Typographical corrections, or similar corrections.

2. OIT Global Objects


a. Revision = X.Y.Z
i. X = Major revision change due to functional changes to the
software object that affects compatibility with
corresponding PLC / HMI elements. SME review and
approvals are required.
ii. Y = Minor revision change which can be functional but
does not alter the original functional intent of the software
object. SME review is typically not required.
iii. Z = Typographical corrections, or similar corrections.

b. Extended Text
i. “NEORSD – Draft” – non-production release indicator
*object is not fully tested/approved
ii. “NEORSD” – programming/production release indicator
*object is fully tested/approved for general use

_NEORSD_OL_Introduction.doc Page 11 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Introduction

2.1.3 HMI Code - Wonderware


1. ArchestrA Library Objects and System Platform Objects – the COTS
software application automatically assigns an incrementing revision
number each time the code base changes. This number will be used for
the revision number.
2. Sample Operator Displays – will be tracked by the revision number
contained in the InTouch window script.
a. Revision = X.Y
i. X = Major revision change due to functional changes to the
software object that affects compatibility with
corresponding PLC / OIT elements. SME review and
approvals are required.
ii. Y = Minor revision change which can be functional but
does not alter the original functional intent of the software
object. SME review is typically not required.
iii. Z = Typographical corrections, or similar corrections.

_NEORSD_OL_Introduction.doc Page 12 of 12 Revision: 1.1.0


Title: NEORSD Standard Object Library - Analog

NEORSD Standard Object Library

Analog

NEORSD_OL_Analog.doc Page 1 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 25-Jan-2011 PSIM All Issue for Use

Added new attributes FillColor and FillColor_Note to


1.1.0 08-Feb-2011 PSIM 1.2.1
the Object Attribute list.

Removed EUMax/Min buttons from faceplate


1.1.0 08-Feb-2011 PSIM 1.3.6
graphic.
Updated Vert_Meter graphic symbol: removed dial
1.1.0 08-Feb-2011 PSIM 1.3.7
and added FillColor bar.
1.1.0 03-Mar-2011 PSIM 1.3.7 Added Chem_Tank graphic symbol
1.2.0 23-Mar-2011 PSIM 1.3.7 Added Fill_box graphic symbol
Updated OIT faceplate to display scaled engineering
1.3.0 02-May-2011 PSIM 1.5.2
unit midpoint value on bar graph.
1.4.0 14-Dec-2011 PSIM 1.1 Revised object feature descriptions
Added new attribute Inp_Gate and
1.4.0 14-Dec-2011 PSIM 1.2.1
Inp_PLC_STATUS to Object Attribute List.
Extended attribute Trouble_Desc default destination
1.4.0 14-Dec-2011 PSIM 1.3.4
is now Me.Placeholder
1.4.0 14-Dec-2011 PSIM 1.4.1 Updated Ladder and Function Block
1.4.0 14-Dec-2011 PSIM 1.5.2 Updated OIT faceplates
1.4.0 14-Dec-2011 PSIM 1.5.3 Updated standard Analog symbols

NEORSD_OL_Analog.doc Page 2 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

Table of Contents:
1.0 ANALOG ........................................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Input Scaling ............................................................................................................... 4
1.1.2 Alarming ..................................................................................................................... 4
1.1.3 Simulation ................................................................................................................... 4
1.1.4 Trouble ........................................................................................................................ 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 7
1.3.1 Hierarchical Name - $Analog ..................................................................................... 7
1.3.2 Derived from - $NEORSDUserDefined ...................................................................... 7
1.3.3 Container - None......................................................................................................... 7
1.3.4 Extensions ................................................................................................................... 7
1.3.5 Instance Configuration ............................................................................................... 8
1.3.6 Faceplates ................................................................................................................. 10
1.3.7 Graphic Symbols ....................................................................................................... 11
1.4 CONTROLLOGIX PLC..................................................................................................... 12
1.4.1 Available Languages ................................................................................................. 12
1.5 PANELVIEW OIT............................................................................................................ 13
1.5.1 Object Instance ......................................................................................................... 13
1.5.2 Faceplates ................................................................................................................. 14
1.5.3 Graphic Symbols ....................................................................................................... 17

NEORSD_OL_Analog.doc Page 3 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.0 Analog
The analog template provides a standard method for handling the scaling, display, and
alarming for analog values throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Input Scaling


Analog scaling is performed within the local PLC. This object can perform the
scaling if not being done at the card level. This object provides decimal point
resolution by configuring the Decimal UDA values. This object uses EuMax and
EuMin UDAs to set the engineering value limits for display and trending.

1.1.2 Alarming
Up to four limit alarms (HiHi_ALM, Hi_ALM, Lo_ALM, and LoLo_ALM) and
two rate of changes alarms (ROCPos_ALM, ROCNeg_ALM) can be generated
by the object based on the input process value. Alarms are configured and
generated within the PLC logic. The warning limits (Hi_Limit, Lo_Limit) can be
modified at the HMI.

The object also provides the ability to generate out of range alarms and instruction
faults when configuration parameters are invalid.

1.1.3 Simulation
This object supports setting a simulated input signal for process simulation

1.1.4 Trouble
This object supports hardware trouble indication.

NEORSD_OL_Analog.doc Page 4 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Out-of-Range (fail) High/Low Deadband
1 Cfg_FailDB REAL IN
(EU)
Out-of-Range (fail) High Limit of input value
2 Cfg_FailHiLim REAL IN
(Inp_PV)
Out-of-Range (fail) Low Limit (EU) of input
3 Cfg_FailLoLim REAL IN
value (Inp_PV)
Minimum time Bad or Out of Range to raise
4 Cfg_FailMinDuration DINT IN
Fail Alarm (sec)
PV Filter Time Constant (sec), 0.0 =
5 Cfg_FiltTC REAL IN
unfiltered
1=Analog Input Failure Alarm exists and will
6 Cfg_HasFailAlm BOOL IN
be checked
7 Cfg_HasHiAlm BOOL IN 1=High Alarm exists and will be checked
1=High-High Alarm exists and will be
8 Cfg_HasHiHiAlm BOOL IN
checked
9 Cfg_HasLoAlm BOOL IN 1=Low Alarm exists and will be checked
1=Low-Low Alarm exists and will be
10 Cfg_HasLoLoAlm BOOL IN
checked
11 Cfg_HiDB REAL IN High Alarm Deadband (EU)
12 Cfg_HiHiDB REAL IN High-High Alarm Deadband (EU)
Minimum time above High-High Limit to
13 Cfg_HiHiMinDuration DINT IN
raise Alarm (sec)
Minimum time above High Limit to raise
14 Cfg_HiMinDuration DINT IN
Alarm (sec)
15 Cfg_InpRawMax REAL IN Input (unscaled) Maximum for Scaling
16 Cfg_InpRawMin REAL IN Input (unscaled) Minimum for Scaling
17 Cfg_LoDB REAL IN Low Alarm Deadband (EU)
18 Cfg_LoLoDB REAL IN Low-Low Alarm Deadband (EU)
Minimum time below Low-Low Limit to raise
19 Cfg_LoLoMinDuration DINT IN
Alarm (sec)
Minimum time below Low Limit to raise
20 Cfg_LoMinDuration DINT IN
Alarm (sec)
21 Cfg_PVEUMax REAL IN PV (Output) Maximum for Scaling to EU
22 Cfg_PVEUMin REAL IN PV (Output) Minimum for Scaling to EU
Limit for a decreasing rate-of-change in
units(negative) per second. Detection is
23 Cfg_ROCNegLimit REAL IN
enabled for any value < 0.0 if ROCPeriod is
also > 0.0.
Time period in seconds for calculation
24 Cfg_ROCPeriod DINT IN (sampling interval) of the rate of change
value. A value of 0 disables ROC checking
Limit for an increasing rate-of-change in
units(negative) per second. Detection is
25 Cfg_ROCPosLimit REAL IN
enabled for any value < 0.0 if ROCPeriod is
also > 0.0.

NEORSD_OL_Analog.doc Page 5 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1=Use simulated PV (Set_SimPV); 0=Use
26 Cfg_Sim BOOL IN
Input (Inp_PV)
1= Scale Inp_PV based on Raw Min/Max,
27 Cfg_UseScaling BOOL IN
EU Min/Max
Number of decimal places configured for
28 Decimal DINT IN UDA
display on output
29 EnableIn BOOL IN Enable Input - System Defined Parameter
30 EnableOut BOOL OUT Enable Output - System Defined Parameter
Maximum of scaled range = MAX
31 EUMax REAL OUT UDA
(Cfg_PVEUMin, Cfg_PVEUMax)
Minimum of scaled range = MIN
32 EUMin REAL OUT UDA
(Cfg_PVEUMin, Cfg_PVEUMax)
33 Fail_ALM BOOL OUT 1=Analog Input is in Fail Alarm
34 FillColor STRING NA UDA Determines the process color
35 FillColor_Note STRING NA UDA Instructions for FillColor UDA
36 Hi_ALM BOOL OUT DI X 1=Analog Input is in High Alarm
AI/O
37 Hi_Limit REAL IN
Float
X Config High Alarm Threshold

38 HiHi_ALM BOOL OUT DI X 1=Analog Input is in High-High Alarm


AI
39 HiHi_Limit REAL IN
Float
X Config High-High Alarm Threshold
AI Analog Value (after scaling, filtering, and
40 Ind REAL OUT
Float
X
Sim, if used)
Gate Condition to Enable/Disable Alarms
41 Inp_Gate BOOL IN
(1=enable Alarms)
CLX InOut Paramter – PLC_STATUS
PLC_ IO
42 Inp_PLC_STATUS STATUS Param
reference for setting Inp_TroubleActive and
Inp_SimActive

43 Inp_PV REAL IN Input Signal (process variable)


44 Inp_PVBad BOOL IN 1=PV or I/O Comms Status Bad, 0=OK
45 Inp_SimValue REAL IN PV used in Simulation (Inp_Sim=1) (EU)
46 Inp_Trouble BOOL IN Trouble indication
CLX InOut parameter – use a unique tag to
IO
47 Inp_Trouble_Desc STRING
Param
hold the trouble description string, that
appears on the faceplate
1=Error in Config, see detail Err_ bits for
48 InstructFault BOOL OUT
reason
49 Lo_ALM BOOL OUT DI X 1=Analog Input is in Low Alarm
AI/O
50 Lo_Limit REAL IN
Float
X Config Low Alarm Threshold

51 LoLo_ALM BOOL OUT DI X 1=Analog Input is in Low-Low Alarm


AI
52 LoLo_Limit REAL IN
Float
X Config Low-Low Alarm Threshold

1=Analog Input has generated Negative


53 ROCNeg_ALM BOOL OUT
Rate-of-Change Alarm. Momentary output

NEORSD_OL_Analog.doc Page 6 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1=Analog Input has generated a Rate-of-
54 ROCPos_ALM BOOL OUT
Change Alarm. Momentary output
55 Sim BOOL OUT 1=Simulation Active
56 Sts_Fail BOOL OUT 1=Analog Input is Out of Range or PV Bad
57 Sts_Hi BOOL OUT 1=Analog Input is above High limit
58 Sts_HiHi BOOL OUT 1=Analog Input is above High-High limit
59 Sts_Lo BOOL OUT 1=Analog Input is below Low limit
60 Sts_LoLo BOOL OUT 1=Analog Input is below Low-Low limit
61 Sts_PVBad BOOL OUT 1=PV Bad quality or Out of Range
62 Trouble BOOL OUT DI X 1=Specified trouble condition active
63 Trouble_Desc STRING Local UDA Active trouble description by the HMI

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Analog

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
Hi_Limit.EngUnitsMax Me.EUMax X
Hi_Limit.EngUnitsMin Me.EUMin X
Hi_Limit.EngUnitsRangeMax Me.EUMax X
Hi_Limit.EngUnitsRangeMin Me.EUMin X
Hi_Limit.RawMax Me.EUMax X
Hi_Limit.RawMin Me.EUMin X
HiHi_Limit.EngUnitsMax Me.EUMax X
HiHi_Limit.EngUnitsMin Me.EUMin X
HiHi_Limit.EngUnitsRangeMax Me.EUMax X
HiHi_Limit.EngUnitsRangeMin Me.EUMin X
HiHi_Limit.RawMax Me.EUMax X
HiHi_Limit.RawMin Me.EUMin X
Ind_Limit.EngUnitsMax Me.EUMax X
Ind_Limit.EngUnitsMin Me.EUMin X
Ind_Limit.EngUnitsRangeMax Me.EUMax X
Ind_Limit.EngUnitsRangeMin Me.EUMin X

NEORSD_OL_Analog.doc Page 7 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

Extended Attribute Destination Locked


Ind_Limit.RawMax Me.EUMax X
Ind_Limit.RawMin Me.EUMin X
Ind.TrendHi Me.EUMax X
Ind.TrendLo Me.EUMin X
Lo_Limit.EngUnitsMax Me.EUMax X
Lo_Limit.EngUnitsMin Me.EUMin X
Lo_Limit.EngUnitsRangeMax Me.EUMax X
Lo_Limit.EngUnitsRangeMin Me.EUMin X
Lo_Limit.RawMax Me.EUMax X
Lo_Limit.RawMin Me.EUMin X
LoLo_Limit.EngUnitsMax Me.EUMax X
LoLo_Limit.EngUnitsMin Me.EUMin X
LoLo_Limit.EngUnitsRangeMax Me.EUMax X
LoLo_Limit.EngUnitsRangeMin Me.EUMin X
LoLo_Limit.RawMax Me.EUMax X
LoLo_Limit.RawMin Me.EUMin X
Trouble_Desc Me.Placeholder

1.3.5 Instance Configuration


All of the necessary configuration for Analog must also be done on any instance
derived from this template.
1) Alarm Priority – Each configured (non Me.Placeholder input source) alarms
(Hi_ALM, HiHi_ALM, Lo_ALM, and LoLo_ALM) need to have a priority
defined.
2) Alarm State Labels – Each configured alarm (Hi_ALM, HiHi_ALM,
Lo_ALM, and LoLo_ALM) have defaulted state labels of False = OK and
True = ALARM. If different labels are desired these need to be configured on
the instance.
3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Hi_Limit
b. HiHi_Limit
c. Lo_Limit
d. LoLo_Limit
e. Hi_ALM
f. HiHi_ALM

NEORSD_OL_Analog.doc Page 8 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

g. Lo_ALM
h. LoLo_ALM

NEORSD_OL_Analog.doc Page 9 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.3.6 Faceplates
Analog_Faceplate
1
2

Graphic Design Element


Number Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.
This box displays the process variable value used for the Analog device.
When an alarm is active the background color will be yellow.
3 Process Variable
When no alarm is active the background will be white.
This graphic symbol displays the Engineering Units for the Process Variable.
Engineering Units Displays the 0%, 25%, 50%, 75%, and 100% value of the analog input range
Scale A bar-graph provides a graphical representation of the process variable
4
Bar Graph Pointers to the bottom of the PV bar-graph indicate the current alarm limit values (LoLo,
Alarm Pointers Lo, Hi, HiHi)
5 Alarm Limit Values Current value of the alarm limits. The box will blink yellow when that alarm is active.
These buttons are only selectable when the logged in user has proper control level
Alarm Limit Lo and Hi access. If not logged in with the proper control level the buttons will not be visible and
6
Buttons only static text will be shown on the template. Pressing the Lo or Hi button will display
an entry box that can be used to set the value.
7 Engineering Units Displays the value of the maximum and minimum engineering units.
8 Trouble Indicates if the object is in trouble and shows the trouble description message below.

NEORSD_OL_Analog.doc Page 10 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.3.7 Graphic Symbols

Analog_Display

Chem_Tank
Vert_Meter
Fill_Box

NEORSD_OL_Analog.doc Page 11 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Analog.doc Page 12 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
4 Engineering Units
5 Key Assignment (For Display Only; match to actual)

NEORSD_OL_Analog.doc Page 13 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.5.2 Faceplates
Note: Shortcut key assignments may differ between PanelView models.

FP_ANALOG
1
2
3

4
7
6
8

10

Graphic Design Element


Number Function Description
1 Display Name Displays the object name
2 Device Description Displays the device description
Provides navigation to the other sections of the faceplate; restricted to higher
3 Tabs
level access.
4 Alarm Limit Values Current values of the alarm limits.
This box displays the value of the process variable. The Engineering Units are
5 Process Variable
configured with the object instance.
The bar-graph provides a graphical representation of the process variable. It
6 Bar Graph
can change colors from green (good) to yellow (alarm).
7 Alarm Gate Status Displays “Alarming Disabled” text when the alarm input gate is not active.
8 Rate of Change Indicates when a positive or negative rate of change alarm is active
9 Alarms Displays additional active alarms/status
10 Exit Button Pressing this button closes the faceplate display.

NEORSD_OL_Analog.doc Page 14 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

FP_ANALOG_STATUS

Graphic Design Element


Number Function Description
1 Object Configurations Displays various object configuration settings
2 Trouble Trouble indication and message.

NEORSD_OL_Analog.doc Page 15 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

FP_ANALOG_DETAIL

2 1

3
4

Note: Changing configuration settings requires administrator level access.

Graphic Design Element


Number Function Description
1 Tag Name Displays the PLC tag
Displays whether or not a particular alarm field is configured (red) or not
Alarm Configured
2 Status
configured (gray) for the Analog instance. Fields that are not configured will
not be generate alarms during runtime.
Displays the associated alarm limit for each field. High and low alarm limits
3 Alarm Limits
can be edited by the user from the OIT.
Displays the deadband associated with each alarm limit. High and low alarm
4 Deadband
limit deadbands can be edited by the user from the OIT.
Displays the minimum duration (in seconds) that the process value must
5 Minimum Duration exceed the alarm limit before the alarm is generated. High and low alarm
minimum durations can be edited by the user from the OIT.
Displays the upper and lower limits as well as the associated minimum
6 Failure (Out of Range)
duration for the analog process failure alarm.
7 Instruction Fault Indicates if the object has an Instruction Fault (configuration error).

NEORSD_OL_Analog.doc Page 16 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog

1.5.3 Graphic Symbols


Note: Multiple sizes are offered as the box length is locked.

NEORSD_OL_Analog.doc Page 17 of 17 Revision: 1.4.0


Title: NEORSD Standard Object Library - Analog Basic

NEORSD Standard Object Library

Analog Basic

NEORSD_OL_Analog_Basic.doc Page 1 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 17-Jan-2011 PSIM All Issue for Use
Removed EU Max/Min buttons from faceplate
1.1.0 14-Feb-2011 PSIM 1.3.6
graphic.
Added new attribute Inp_PLC_STATUS to Object
1.2.0 03-May-2011 PSIM 1.2.1
Attribute List.

NEORSD_OL_Analog_Basic.doc Page 2 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

Table of Contents:
1.0  ANALOG BASIC .............................................................................................................. 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Input Indication ........................................................................................................... 4 
1.1.2  Alarming ..................................................................................................................... 4 
1.1.3  Simulation ................................................................................................................... 4 
1.1.4  Trouble ........................................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 4 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 4 
1.3  WONDERWARE HMI ........................................................................................................ 5 
1.3.1  Hierarchical Name - $Analog_Basic .......................................................................... 5 
1.3.2  Derived from - $NEORSDUserDefined ...................................................................... 5 
1.3.3  Container – None ........................................................................................................ 5 
1.3.4  Extensions ................................................................................................................... 5 
1.3.5  Instance Configuration ............................................................................................... 5 
1.3.6  Faceplates ................................................................................................................... 6 
1.3.7  Graphic Symbols ......................................................................................................... 7 
1.4  CONTROLLOGIX PLC....................................................................................................... 7 
1.4.1  Available Languages................................................................................................... 7 
1.5  PANELVIEW OIT.............................................................................................................. 7 
1.5.1  Object Instance ........................................................................................................... 7 
1.5.2  Faceplates ................................................................................................................... 8 
1.5.3  Graphic Symbols ......................................................................................................... 8 

NEORSD_OL_Analog_Basic.doc Page 3 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

1.0 Analog Basic


The analog basic template provides a simple method for the display of analog values
throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Input Indication


All analog scaling is performed within the local PLC. This object provides
decimal point resolution formatting per instance by configuring the Decimal
parameter. The object EuMax and EuMin parameters set the engineering value
limits for display and trending.

1.1.2 Alarming
A configuration fault is available in the PLC. No alarms are mapped to the HMI.

1.1.3 Simulation
This object supports setting a simulated input signal for process simulation

1.1.4 Trouble
No trouble status is available on this object (see the Analog object if Trouble
indication is required). A process variable bad quality status is available in the
PLC.

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware
Direction

Direction

Alarm

Event

Data
Item

Hist

Attributes Type Notes


PV Filter Time Constant (sec),
1 Cfg_FiltTC REAL IN
0.0 = unfiltered
2 Cfg_PVEUMax REAL IN Ind (PV) Maximum EU (for indication only)
3 Cfg_PVEUMin REAL IN Ind (PV) Minimum EU (for indication only)
1=Use simulated PV (Inp_SimValue); 0=Use
4 Cfg_Sim BOOL IN
Input (Inp_PV)
Number of decimal places configured for
5 Decimal DINT IN UDA
display on output
6 EnableIn BOOL IN Enable Input - System Defined Parameter
7 EnableOut BOOL OUT Enable Output - System Defined Parameter
Maximum of EU range = MAX (PLC: based
upon both Cfg_PVEUMin, Cfg_PVEUmax,
8 EUMax REAL OUT UDA
HMI: enter manually).
Clamping at the HMI only. Default = 1000

NEORSD_OL_Analog_Basic.doc Page 4 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Minimum of EU range = MIN (PLC: based on
both Cfg_PVEUMin, Cfg_PVEUmax, HMI:
9 EUMin REAL OUT UDA
enter manually).
Clamping at the HMI only. Default = 0
AI Analog Value (after filtering and Simulation, if
10 Ind REAL OUT
Float
X
used)
PLC_ IO CLX InOut Paramter – PLC_STATUS
11 Inp_PLC_STATUS STATU Para reference for setting Inp_TroubleActive and
S m Inp_SimActive
Input signal (PV). Link to signal through
12 Inp_PV REAL IN
external code.
1=PV or I/O Comms Status Bad, 0=OK (not
13 Inp_PVBad BOOL IN
linked to HMI)
14 Inp_SimValue REAL IN PV used in Simulation (Inp_Sim=1)
15 InstructFault BOOL OUT 1=Config has generated an error
16 Sim BOOL OUT 1=Simulation Active
17 Sts_PVBad BOOL OUT 1=PV Bad quality or Out of Range

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Analog_Basic

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container – None

1.3.4 Extensions
Extended Attribute Destination Locked
Ind.EngUnitsMax Me.EUMax X
Ind.EngUnitsMin Me.EUMin X
Ind.EngUnitsRangeMax Me.EUMax X
Ind.EngUnitsRangeMin Me.EUMin X
Ind.RawMax Me.EUMax X
Ind.RawMin Me.EUMin X
Ind.TrendHi Me.EUMax X
Ind.TrendLo Me.EUMin X

1.3.5 Instance Configuration


1) EUMax/EUMin – UDAs that control the range of the analog Ind and the
default Max and Min of the trends. The default values are 1000 and 0

NEORSD_OL_Analog_Basic.doc Page 5 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

respectively and need to be specified on the instance. These can be altered on


the UDA tab or through the faceplate with security level 9999.
2) Engineering Units – The Engineering Units of Ind must be defined on the
Field Attributes tab.
3) Decimal – Defined as how many decimal points are shown. The default value
is 0 and need to be specified on the instance.
4) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. None

1.3.6 Faceplates
Analog_Basic_Faceplate

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.

3 Indication Displays the current analog value associated with the tag name.
4 Engineering Units Displays the value of the maximum and minimum engineering units.

NEORSD_OL_Analog_Basic.doc Page 6 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

1.3.7 Graphic Symbols


Analog_Display

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 Tag Address
2 Tag Name
3 Device Description
4 Engineering Units

NEORSD_OL_Analog_Basic.doc Page 7 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Basic

1.5.2 Faceplates
No faceplates are currently configured for the Analog Basic display.

1.5.3 Graphic Symbols


Note: Multiple sizes are offered as the box length is locked.

NEORSD_OL_Analog_Basic.doc Page 8 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog RW

NEORSD Standard Object Library

Analog RW

NEORSD_OL_Analog_RW.doc Page 1 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 24-Jan-2011 PSIM All Issue for Use
Removed EU Max/Min and OP Max/Min buttons
1.1.0 14-Feb-2011 PSIM 1.3.6
from faceplate graphic.
Added new attribute Inp_PLC_STATUS to Object
1.2.0 03-May-2011 PSIM 1.2.1
Attribute List.
1.3.0 29-June-2011 PSIM 1.3.7 Updated Wonderware graphic Analog_RW_Display.

NEORSD_OL_Analog_RW.doc Page 2 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

Table of Contents:
1.0  ANALOG RW ................................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Control ...................................................................................................................... 4 
1.1.2  Analog Indication...................................................................................................... 4 
1.1.3  Output Tracking ........................................................................................................ 4 
1.1.4  Alarming ................................................................................................................... 4 
1.1.5  Simulation ................................................................................................................. 4 
1.1.6  Trouble ...................................................................................................................... 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 5 
1.2.1  Table of Attributes & WW UDAs .............................................................................. 5 
1.3  WONDERWARE HMI ........................................................................................................ 6 
1.3.1  Hierarchical Name - $Analog_RW ........................................................................... 6 
1.3.2  Derived from - $NEORSDUserDefined/$Analog_Basic .......................................... 6 
1.3.3  Container - None....................................................................................................... 6 
1.3.4  Extensions ................................................................................................................. 6 
1.3.5  Instance Configuration ............................................................................................. 6 
1.3.6  Faceplates ................................................................................................................. 8 
1.3.7  Graphic Symbols ....................................................................................................... 9 
1.4  CONTROLLOGIX PLC....................................................................................................... 9 
1.4.1  Available Languages................................................................................................. 9 
1.5  PANELVIEW OIT............................................................................................................ 10 
1.5.1  Object Instance ....................................................................................................... 10 
1.5.2  Faceplates ............................................................................................................... 10 
1.5.3  Graphic Symbols ..................................................................................................... 10 

NEORSD_OL_Analog_RW.doc Page 3 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

1.0 Analog RW
The Analog_RW template provides a standard method for reading and writing analog values
to and from the PLC. It offers indication of both the value written at the HMI and the value
in use at the PLC.

1.1 Object Features

1.1.1 Control
This object facilitates the writing of an analog value from the HMI to the PLC.
The value must be within the configured OpMax and OpMin UDA parameters.
The object also displays the current output of the PLC block as confirmation of
the write.

1.1.2 Analog Indication


This object provides an input parameter for any selected process variable. This
object provides decimal point resolution formatting per instance by configuring
the Decimal parameter. The object EuMax and EuMin parameters set the
engineering value limits for display and trending.

1.1.3 Output Tracking


The track enable and track value parameters allow programmatically
manipulating the write command.

1.1.4 Alarming
An alarm for configuration error exist in the PLC, along with EU Min/Max
alarms.

1.1.5 Simulation
This object support simulation of discrete valve operation.

1.1.6 Trouble
This object supports hardware trouble indication at the HMI. Bad quality is also
displayed on the OIT.

NEORSD_OL_Analog_RW.doc Page 4 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Cfg_FiltTC REAL IN PV Filter Time Constant (sec), 0.0 = unfiltered
High Limit of Input. Upper bound at which Out is
2 Cfg_OpMax REAL IN
clamped.
Low Limit of Input. Lower bound at whcih Out is
3 Cfg_OpMin REAL IN
clamped.
Ind (PV) Maximum EU. Upper bound at which Ind is
4 Cfg_PVEUMax REAL IN
clamped.
Ind (PV) Minimum EU. Lower bound at which Ind is
5 Cfg_PVEUMin REAL IN
clamped.
1=Use simulated PV based on block Output, 0=Use
6 Cfg_Sim BOOL IN
Input (Inp_PV)
AO
7 CMD REAL IN
Float
X Value written by HMI for requested output
Number of configured decimal places configured on
8 Decimal DINT IN UDA
output value (Ind)
9 EnableIn BOOL IN Enable Input - System Defined Parameter
10 EnableOut BOOL OUT  Enable Output - System Defined Parameter
Maximum of EU range. PLC will clamp at this value.
11 EUMax REAL OUT UDA HMI will prevent entering values outside the range.
Default = 1000
Minimum of EU range. PLC will clamp at this value.
12 EUMin REAL OUT UDA
HMI will prevent entering values outside the range
AI
13 Ind REAL OUT 
Float
X Output variable from the block
PLC_ IO
CLX InOut Paramter – PLC_STATUS reference for
14 Inp_PLC_STATUS STAT Para
setting Inp_TroubleActive and Inp_SimActive
US m
15 Inp_PV REAL IN Input Signal (process variable)
16 Inp_PVBad BOOL IN 1=PV or I/O Comms Status Bad, 0=OK
17 Inp_SimValue REAL IN PV used in Simulation (when Cfg_Sim=1)
18 Inp_TrackEnable BOOL IN Input for program control of output variable
19 Inp_TrackValue REAL IN Output value when program control (tracking) enabled
20 Inp_Trouble BOOL IN Trouble indication
IO CLX InOut Parameter: Use a Unique Tag to Hold the
21 Inp_Trouble_Desc STRING
Param Trouble Description String
22 InstructFault BOOL OUT  1=Error in configuration
0 = administrator can only change the set point, 1=
23 Op_Control_Perm BOOL IN UDA operators or greater can change the set point. WW
only
24 OpMax REAL OUT Upper Bound of Output Value
25 OpMin REAL OUT Lower Bound of Output Value
AI
26 Out REAL OUT
Float
Output variable from the block

27 Sim BOOL OUT 1=Simulation Active


28 Sts_HighLimit BOOL OUT  1=Output variable is at its configured high limit

NEORSD_OL_Analog_RW.doc Page 5 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
29 Sts_LowLimit BOOL OUT  1=Output variable is at its configured low limit
30 Sts_PVBad BOOL OUT 1=PV Bad quality or Out of Range
31 Sts_TrackEnable BOOL OUT  1=Tracking active
32 Trouble BOOL OUT DI x 1=Specified trouble condition active
33 Trouble_Desc STRING Local UDA Active trouble description read by the HMI

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Analog_RW

1.3.2 Derived from - $NEORSDUserDefined/$Analog_Basic

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
CMD.EngUnitsMax Me.EUMax X
CMD.EngUnitsMin Me.EUMin X
CMD.EngUnitsRangeMax Me.EUMax X
CMD.EngUnitsRangeMin Me.EUMin X
CMD.RawMax Me.EUMax X
CMD.RawMin Me.EUMin X
CMD.TrendHi Me.EUMax X
CMD.TrendLo Me.EUMin X
Out.EngUnitsMax Me.EUMax X
Out.EngUnitsMin Me.EUMin X
Out.EngUnitsRangeMax Me.EUMax X
Out.EngUnitsRangeMin Me.EUMin X
Out.RawMax Me.EUMax X
Out.RawMin Me.EUMin X
Out.TrendHi Me.EUMax X
Out.TrendLo Me.EUMin X
Trouble_Desc ---

1.3.5 Instance Configuration


All of the necessary configuration for Analog_RW must also be done on any
instance derived from this template.

NEORSD_OL_Analog_RW.doc Page 6 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

1) EUMax/EUMin – UDAs that control the range of the analog Ind and the
default Max and Min of the trends. The default values are 1000 and 0
respectively and need to be specified on the instance. These can be altered on
the UDA tab or through the faceplate with security level 9999.
2) Decimal – Defined as how many decimal points are shown. The default value
is 0 and need to be specified on the instance.
3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. None

Note: The Engineering Units for CMD are designed to match those of IND.
Therefore it is not necessary to configure the Engineering Units for CMD.

NEORSD_OL_Analog_RW.doc Page 7 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

1.3.6 Faceplates
Analog_RW_Faceplate
1
2

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.
3 Indication Displays the current analog value associated with the tag name (Value in the PLC).
This button is only selectable when the logged in user has proper control level access.
Pressing the Setpoint button will display an entry box that can be used to set the value.
4 Setpoint If not logged in with the proper control level access the box is not selectable and the text
becomes a very light shade of grey indicating it is inactive. Displayed value is the value
stored in the HMI.
5 Engineering Units Displays the value of the maximum and minimum engineering units.
6 Operator Limits Displays the values of the Operator Maximum and Minimum limits.

7 Trouble Indicates if the object is in trouble and shows the trouble description message below.

NEORSD_OL_Analog_RW.doc Page 8 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

1.3.7 Graphic Symbols


Analog_RW_Display

**
** Blue background on analog diplay indicates operator action possible.

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Analog_RW.doc Page 9 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog RW

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Tag Description
4 Engineering Units
5 Key Assignment (For Display Only)

1.5.2 Faceplates
No faceplates are currently configured for the Analog RW display.

1.5.3 Graphic Symbols


Note: Multiple sizes are offered as the box length is locked.

NEORSD_OL_Analog_RW.doc Page 10 of 10 Revision: 1.3.0


Title: NEORSD Standard Object Library - Analog Setpoint

NEORSD Standard Object Library

Analog Setpoint

NEORSD_OL_Analog_Setpoint.doc Page 1 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 24-Jan-2011 PSIM All Issue for Use
Removed OP Max/Min buttons from faceplate
1.1.0 14-Feb-2011 PSIM 1.3.6
graphic
Updated Wonderware graphic
1.2.0 29-June-2011 PSIM 1.3.7
Analog_Setpoint_Display.

NEORSD_OL_Analog_Setpoint.doc Page 2 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

Table of Contents:
1.0  ANALOG SETPOINT ...................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Analog Write ............................................................................................................. 4 
1.1.1  Output Tracking ........................................................................................................ 4 
1.1.2  Alarming ................................................................................................................... 4 
1.1.3  Trouble ...................................................................................................................... 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 4 
1.2.1  Table of Attributes & WW UDAs .............................................................................. 4 
1.3  WONDERWARE HMI ........................................................................................................ 5 
1.3.1  Hierarchical Name - $Analog_Setpoint.................................................................... 5 
1.3.2  Derived from - $NEORSDUserDefined .................................................................... 5 
1.3.3  Container - None....................................................................................................... 5 
1.3.4  Extensions ................................................................................................................. 5 
1.3.5  Instance Configuration ............................................................................................. 5 
1.3.6  Faceplates ................................................................................................................. 6 
1.3.7  Graphic Symbols ....................................................................................................... 7 
1.4  CONTROLLOGIX PLC....................................................................................................... 7 
1.4.1  Available Languages................................................................................................. 7 
1.5  PANELVIEW OIT.............................................................................................................. 8 
1.5.1  Object Instance ......................................................................................................... 8 
1.5.2  Faceplates ................................................................................................................. 8 
1.5.3  Graphic Symbols ....................................................................................................... 8 

NEORSD_OL_Analog_Setpoint.doc Page 3 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

1.0 Analog Setpoint


The Analog Setpoint template provides a standard method for writing analog values to the
PLC. It offers indication of both the value written at the HMI and the value in use at the
PLC.

1.1 Object Features

1.1.1 Analog Write


This object facilitates the writing of an analog value from the HMI to the PLC.
The value must be within the configured operating parameters.

1.1.1 Output Tracking


The track enable and track value parameters allow programmatically
manipulating the set point.

1.1.2 Alarming
An alarm for configuration error and output value at operator limits, exist in the
PLC.

1.1.3 Trouble
No trouble indication is available on this object.

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware
Direction

Direction

Alarm

Event

Data
Item

Hist

Attributes Type Notes


High Limit of Input. Upper bound at which Out is
1 Cfg_OpMax REAL IN
clamped.
Low Limit of Input. Lower bound at which Out is
2 Cfg_OpMin REAL IN
clamped.
AO
3 CMD REAL IN
Float
X Value written by HMI for requested output
Number of configured decimal places configured on
4 Decimal DINT IN UDA
output value (Ind)
5 EnableIn BOOL IN Enable Input - System Defined Parameter
6 EnableOut BOOL OUT  Enable Output - System Defined Parameter
7 Inp_TrackEnable BOOL IN Input for program control of output variable
8 Inp_TrackValue REAL IN Output value when program control (tracking) enabled
9 InstructFault BOOL OUT  1=Error in configuration
0 = administrator can only change the set point, 1=
10 Op_Control_Perm BOOL IN UDA operators or greater can change the set point. WW
only

NEORSD_OL_Analog_Setpoint.doc Page 4 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
11 OpMax REAL OUT UDA Upper Bound of Output Value
12 OpMin REAL OUT UDA Lower Bound of Output Value
AI
13 Out REAL OUT 
Float
x Output variable from the block

14 Sts_HighLimit BOOL OUT  1=Output variable is at its configured high limit


15 Sts_LowLimit BOOL OUT  1=Output variable is at its configured low limit
16 Sts_TrackEnable BOOL OUT  1=Tracking active

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Analog_Setpoint

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
CMD.EngUnitsMax Me.OpMax X
CMD.EngUnitsMin Me.OpMin X
CMD.EngUnitsRangeMax Me.OpMax X
CMD.EngUnitsRangeMin Me.OpMin X
CMD.RawMax Me.OpMax X
CMD.RawMin Me.OpMin X
CMD.TrendHi Me.OpMax X
CMD.TrendLo Me.OpMin X
Out.EngUnitsMax Me.OpMax X
Out.EngUnitsMin Me.OpMin X
Out.EngUnitsRangeMax Me.OpMax X
Out.EngUnitsRangeMin Me.OpMin X
Out.RawMax Me.OpMax X
Out.RawMin Me.OpMin X
Out.TrendHi Me.OpMax X
Out.TrendLo Me.OpMin X

1.3.5 Instance Configuration


All of the necessary configuration for Analog_Setpoint must also be done on any
instance derived from this template.

NEORSD_OL_Analog_Setpoint.doc Page 5 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

1) OPMax/OPMin – UDAs that control the range of the analog Out and the
default Max and Min of the trends. The default values are 1000 and 0
respectively and need to be specified on the instance. These can be altered on
the UDA tab or through the faceplate with security level 9999.
2) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. None

Note: The engineering units for CMD are designed to match those of Out.
Therefore it is not necessary to configure the engineering units for CMD.

1.3.6 Faceplates
Analog_Setpoint_Faceplate

1
2

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.

2 Tag Name Displays the object name.


This button is only selectable when the logged in user has proper control level access.
Pressing the Setpoint button will display an entry box that can be used to set the value.
3 Setpoint If not logged in with the proper control level access the box is not selectable and the text
becomes a very light shade of grey indicating it is inactive. Displayed value is the value
read from the PLC.

4 Operator Limits Displays the values of the Operator Maximum and Minimum limits.

NEORSD_OL_Analog_Setpoint.doc Page 6 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

1.3.7 Graphic Symbols

Analog_Setpoint_Display
**

** Blue background on analog diplay indicates operator action possible.

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Analog_Setpoint.doc Page 7 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Tag Description
4 Engineering Units
5 Key Assignment (For Display Only)

1.5.2 Faceplates
No faceplates are currently configured for the Analog Setpoint display.

1.5.3 Graphic Symbols


Note: Multiple sizes are offered as the box length is locked.

NEORSD_OL_Analog_Setpoint.doc Page 8 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

NEORSD Standard Object Library

Analog Setpoint Mode

NEORSD_OL_Analog_Setpoint_Mode.doc Page 1 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Mar-2011 PSIM All Issue for Use

NEORSD_OL_Analog_Setpoint_Mode.doc Page 2 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

Table of Contents:
1.0  ANALOG SETPOINT MODE ........................................................................................ 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Control ........................................................................................................................ 4 
1.1.2  Indications................................................................................................................... 4 
1.1.3  Simulation - None ....................................................................................................... 4 
1.1.4  Trouble - None ............................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 5 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 5 
1.3  WONDERWARE HMI ........................................................................................................ 5 
1.3.1  Hierarchical Name - $Analog_Setpoint_Mode .......................................................... 5 
1.3.2  Derived from - $NEORSDUserDefined/$Analog_Setpoint ........................................ 5 
1.3.3  Container - None......................................................................................................... 5 
1.3.4  Extensions - None ....................................................................................................... 5 
1.3.5  Instance Configuration ............................................................................................... 5 
1.3.6  Faceplates ................................................................................................................... 7 
1.3.7  Graphic Symbols ......................................................................................................... 8 
1.4  CONTROLLOGIX PLC....................................................................................................... 8 
1.1  PANELVIEW OIT.............................................................................................................. 8 

NEORSD_OL_Analog_Setpoint_Mode.doc Page 3 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

1.0 Analog Setpoint Mode


The Analog Setpoint Mode template object is a simplified control interface, that provides a
standard method to read and change the Mode and Setpoint of a control system, or
individual piece of equipment.
This template consists of an HMI portion only, and has no corresponding PLC or OIT
component.

1.1 Object Features

1.1.1 Control
Control mode can be set from the faceplate. Separate set points can be entered for
each mode.

1.1.2 Indications
This object provides indication of the mode (Auto = 1, Manual = 0), and each set
point.

1.1.3 Simulation - None

1.1.4 Trouble - None

NEORSD_OL_Analog_Setpoint_Mode.doc Page 4 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Auto BOOL NA DI X Auto Indication; 1=A, 0=M

2 Auto_CMD BOOL NA DO X Command to set Auto mode

AO
3 CMD REAL NA
Float
X Auto mode Setpoint, written by HMI

Number of configured decimal places


4 Decimal DINT NA UDA
configured on output value (Ind)
AI
5 Manual_Pos Float NA
Float
X Feedback of the Manual mode output.

AO
6 Manual_Pos_CMD Float NA
Float
X Writes the Manual Value

0 = administrator can only change the set


7 Op_Control_Perm BOOL NA UDA point, 1= operators or greater can change
the set point. WW only

8 OpMax REAL NA UDA Upper Bound of the Manual output value

9 OpMin REAL NA UDA Lower Bound of the Manual output value

AI
10 Out REAL NA
Float
X Feedback of the Auto mode output.

11 REM BOOL NA DI X 1=object is in Remote control (0-local)

Restricts the CMD on the


12 Restrict INT NA UDA Analog_Faceplate_Mode graphic. 0 = not
restricted, 1 = restricted unless auto.

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Analog_Setpoint_Mode

1.3.2 Derived from - $NEORSDUserDefined/$Analog_Setpoint

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration


All of the necessary configuration for Analog Setpoint Mode must also be done
on any instance derived from this template.

NEORSD_OL_Analog_Setpoint_Mode.doc Page 5 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

1) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Auto_CMD
b. REM

NEORSD_OL_Analog_Setpoint_Mode.doc Page 6 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

1.3.6 Faceplates

Analog_Faceplate_Mode
1
2

3
4
5

Graphic Design Element


Number Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.

The Setpoint is entered as a target value for the Out attribute.


This button is only selectable when the logged in user has proper control level access.
Pressing the Setpoint button will display an entry box that can be used to set the value.
3 Setpoint
If not logged in with the proper control level access the box is not selectable and the text
becomes a very light shade of grey indicating it is inactive. Displayed value is the value
read from the PLC.

Indicates the current mode. Allows for the toggling between automatic and manual
states. This button is only selectable when the logged in user has proper control level
access. If the user is not logged in with the proper control level access the switch is not
4 Auto / Manual Switch
selectable and becomes grey indicating it is not selectable. Regardless if the user is
logged in with the proper control level the switch will indicate the current state of the
mode.
The Manual value is displayed as the percentage of the output.
This button is only selectable when the logged in user has proper control level access
and the mode is set to manual. Pressing the Manual button will display an entry box that
5 Manual
can be used to set the value. If not logged in with the proper control level access the box
is not selectable and the text becomes a very light shade of grey indicating it is inactive.
Displayed value is the value read from the PLC.
6 Operator Limits Displays the limits of the Manual mode Maximum and Minimum entered value.

NEORSD_OL_Analog_Setpoint_Mode.doc Page 7 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Analog Setpoint Mode

1.3.7 Graphic Symbols

Auto_Rem  Analog_Setpoint_Button Analog_Display_Out_Mode


(Auto mode command)

Analog_Display_Manual_Pos_Mode
(Manual mode command feedback)

1.4 ControlLogix PLC


No ControlLogix component (AOI) exists for this tempalte. A UDT may be used to
integrate the object with a ControlLogix program.

1.1 PanelView OIT


No PanelView component (Global Object) exists for this template. An interface may be
constructed using standard Rockwell FactroyTalk View components.

NEORSD_OL_Analog_Setpoint_Mode.doc Page 8 of 8 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

NEORSD Standard Object Library

Diagnostics

NEORSD_OL_Diagnostics.doc Page 1 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 19-April-2011 PSIM All Issue for Use

NEORSD_OL_Diagnostics.doc Page 2 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

Table of Contents:
1.0  DIAGNOSTICS................................................................................................................. 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Status ........................................................................................................................... 4 
1.1.2  Alarming - None.......................................................................................................... 4 
1.1.3  Simulation - None ....................................................................................................... 4 
1.1.4  Trouble - None ............................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 4 
1.3  WONDERWARE HMI ........................................................................................................ 4 
1.4  CONTROLLOGIX PLC....................................................................................................... 5 
1.5  PANELVIEW OIT.............................................................................................................. 5 
1.5.1  Object Instance ........................................................................................................... 5 
1.5.2  Faceplates ................................................................................................................... 5 
1.5.3  Graphic Symbols ......................................................................................................... 8 

NEORSD_OL_Diagnostics.doc Page 3 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

1.0 Diagnostics
The diagnostic object templates are OIT level objects that provide hardware diagnostic
information for ControlLogix and CompactLogix hardware modules. There is no
corresponding HMI component.
Templates have been created for the most common modules in use at the NEORSD.

1.1 Object Features

1.1.1 Status
These objects provide detailed diagnostic level status information for
ControlLogix and CompactLogix hardware modules.

1.1.2 Alarming - None

1.1.3 Simulation - None

1.1.4 Trouble - None

1.2 Object Attributes


Diagnostic templates on the OIT do not partner with a PLC (AOI) or HMI object. The
templates instead rely on the module-defined tags created within the Logix processor
during I/O Configuration and RSLinx Enterprise Diagnostic information available on the
PanelView Plus terminals. Module-defined tags are unique among the hardware
templates.

1.3 Wonderware HMI


There is no Wonderware component to this object.

NEORSD_OL_Diagnostics.doc Page 4 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

1.4 ControlLogix PLC


Not applicable.

1.5 PanelView OIT

1.5.1 Object Instance


Each object is unique depending on the hardware template module selected.
Below is a typical configuration of the global object properties, as seen from the
1756-IF8H template:
Name Description Example
1 PLC Tag ::[PLC]Local:4
2 Channel 0 Device Tag AIT-1211
3 Channel 0 Description EXHAUST GAS O2 CONCENTRATION
4 Channel 0 Units %
5 Channel 1 Device Tag AIT-1800
6 Channel 1 Description CARBON MONOXIDE CONCENTRATION
7 Channel 1 Units PPM
8 Channel 2 Device Tag TIT-1109
9 Channel 2 Description PRIM HEAT EXCHGR EXHAUST TEMP
10 Channel 2 Units F
11 Channel 3 Device Tag FIT-2500
12 Channel 3 Description NATURAL GAS SUPPLY
13 Channel 3 Units SCFM
14 Channel 4 Device Tag LIT-9506
15 Channel 4 Description POLYMER STORAGE TANK 2 LEVEL
16 Channel 4 Units FT
17 Channel 5 Device Tag SPARE
18 Channel 5 Description -
19 Channel 5 Units -
20 Channel 6 Device Tag SPARE
21 Channel 6 Description -
22 Channel 6 Units -
23 Channel 7 Device Tag SPARE
24 Channel 7 Description -
25 Channel 7 Units -

1.5.2 Faceplates
Each object is unique depending on the hardware template module selected.
Below is a typical faceplate display, as seen from the 1756-IF8H template:

NEORSD_OL_Diagnostics.doc Page 5 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

1
2
3

Graphic Design Element


Number Function Description
1 Tag Name Tag name (rack location) for the diagnostic template object
2 Description User defined description text for display only.
3 Navigation Buttons Opens second faceplate with additional information.
Device information wired to channel. Includes device tag, device description,
4 Device Information
and units
Current value registered on the input channel. Value shown reflects scaling
5 Input Value
on input card.
6 Fault Indication Indicates whether a fault is active on the respective input channel.
Displays fault type. Fault types include Broken Wire, UnderRange,
7 Fault Description
OverRange, Calibration Fault, and HART Fault.
8 Exit Button to close the faceplate.

NEORSD_OL_Diagnostics.doc Page 6 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

1
 1 

2 2

Graphic Design Element


Number Function Description
Signal input range selected for channel. Valid ranges are -10 to 10V, 0 to 5V,
1 Input Range
0 to 10V, 0 to 20mA, and 4 to 20mA for this hardware module.
User defined input scaling selected for channel. High and low signal are
2 Input Scaling displayed on the left, followed by the corresponding high and low engineering
is displayed on the right.

NEORSD_OL_Diagnostics.doc Page 7 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

1.5.3 Graphic Symbols


Several Global Object symbol displays are provided for developing the OIT
diagnostics screens in conjunction with the requirements set by the NEORSD
Automation Standards and Conventions manual.
STANDARD_DIAGNOSTICS_OVERVIEW
The Overview symbols are provided for developing the 200 – MAINTENANCE
OVERVIEW display. This display is intended to provide a high level hardware
architecture overview of the PLC rack and network configuration without the
details of individual hardware modules. The following objects are graphical
representations only and do not provide diagnostic status information or
animation.

NEORSD_OL_Diagnostics.doc Page 8 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

STANDARD_DIAGNOSTICS_1756_CHASSIS
The objects presented on this global object display are intended for development
of the detailed rack diagnostic displays (201 – MAINTENANCE – RACK 0
through 209 – MAINTENANCE – RACK 8, depending on the number of
distributed IO racks within the system). The CHASSIS objects are static objects
and do not require specific configuration.

NEORSD_OL_Diagnostics.doc Page 9 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

STANDARD_DIAGNOSTICS_176x_CHASSIS
Objects on this display are similar to
STANDARD_DIAGNOSTICS_1756_CHASSIS described above, except they
pertain to CompactLogix system components.

NEORSD_OL_Diagnostics.doc Page 10 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

STANDARD_DIAGNOSTICS_1756_MODULES
The objects presented on this display are intended to represent individual
hardware modules in a controller rack. Each global object symbol requires
configuration and has an associated faceplate that features hardware diagnostic
information. Objects should be selected and aligned within the graphic display
according to the module’s location in each rack.
At this time scanner module object templates are static and do not provide
diagnostic information.

NEORSD_OL_Diagnostics.doc Page 11 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

STANDARD_DIAGNOSTICS_176x_MODULES
Objects on this display are similar to
STANDARD_DIAGNOSTICS_1756_MODULES described above, except they
pertain to CompactLogix system components.

NEORSD_OL_Diagnostics.doc Page 12 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

Example Configured Displays


The following figure is an example of a typical 200 – MAINTENANCE
OVERVIEW display graphic developed from the global objects provided in
STANDARDS_DIAGNOSTICS_OVERVIEW.

NEORSD_OL_Diagnostics.doc Page 13 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Diagnostics

The following figure is an example of a typical 20X – MAINTENANCE RACK


X display graphic developed from the global objects provided in
STANDARDS_DIAGNOSTICS_1756_CHASSIS and
STANDARDS_DIAGNOSTICS_1756_MODULES.

NEORSD_OL_Diagnostics.doc Page 14 of 14 Revision: 1.0.0


Title: NEORSD Standard Object Library - Discrete

NEORSD Standard Object Library

Discrete

NEORSD_OL_Discrete.doc Page 1 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Jan-2011 PSIM All Issue for Use
Added Me.Placeholder functionality to the
1.1.0 28-Feb-2011 PSIM 1.3.5
Discrete_Faceplate for the State attribute.
1.2.0 07-Apr-2011 PSIM 1.3.5 Added Invert to the Instance Configuration
Added new attribute Inp_PLC_STATUS to Object
1.3.0 03-May-2011 PSIM 1.2.1
Attribute List.
Inserted Wonderware graphic
1.4.0 03-June-2011 PSIM 1.3.7
Alarm_TextDisplay_Invis.
Inserted Wonderware graphic
1.4.0 03-June-2011 PSIM 1.3.7
State_TextDisplay_Invis.
1.5.0 16-JUN-2011 PSIM 1.1.1 Corrected statements regarding object alarming
Updated OIT symbols and added OIT symbol color
1.5.0 16-JUN-2011 PSIM 1.5.3
and invisibility animation information
Added global object parameter listings for each type
1.6.0 19-AUG-2011 PSIM 1.5.1
of OIT symbol
Added OIT interlock/permissive status object symbol
1.6.0 19-AUG-2011 PSIM 1.5.3
to library.
1.6.0 19-AUG-2011 PSIM 1.3.7 Added Discrete_Interlock graphic

NEORSD_OL_Discrete.doc Page 2 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

Table of Contents:
1.0 DISCRETE ........................................................................................................................ 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Alarming ..................................................................................................................... 4
1.1.2 Simulation ................................................................................................................... 4
1.1.3 Trouble ........................................................................................................................ 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 4
1.2.1 Table of Attributes & WW UDAs ................................................................................ 4
1.3 WONDERWARE HMI ........................................................................................................ 5
1.3.1 Hierarchical Name - $Discrete ................................................................................... 5
1.3.2 Derived from - $NEORSDUserDefined ...................................................................... 5
1.3.3 Container - None......................................................................................................... 5
1.3.4 Extensions ................................................................................................................... 5
1.3.5 Instance Configuration ............................................................................................... 5
1.3.6 Faceplates ................................................................................................................... 6
1.3.7 Graphic Symbols ......................................................................................................... 6
1.4 CONTROLLOGIX PLC....................................................................................................... 7
1.4.1 Available Languages ................................................................................................... 7
1.5 PANELVIEW OIT.............................................................................................................. 8
1.5.1 Object Instance ........................................................................................................... 8
1.5.2 Faceplates ................................................................................................................... 8
1.5.3 Graphic Symbols ......................................................................................................... 9

NEORSD_OL_Discrete.doc Page 3 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

1.0 Discrete
The discrete object template provides a standard method for handling the indication and
alarming for simple discrete object instances throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Alarming
This object contains a single discrete alarm indicator (Fault) which is provided by
PLC logic. Fault is issued when the feedback matches a preconfigured alarm state
for a configurable period of time within the logic.

1.1.2 Simulation
This object supports simulation of a simulated input signal for process simulation.

1.1.3 Trouble
This object supports hardware trouble indication.

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware
Direction

Direction

Alarm

Event

Data
Item

Hist

Attributes Type Notes


Minimum time Input must disagree with
1 Cfg_AlarmTime DINT IN
Target to generate an alarm Fault (sec)
Minimum time Status will maintain initial state
2 Cfg_Debounce REAL IN
transition (sec)
3 Cfg_DisableAlarming BOOL IN 1= Disables fault alarms
Time Inp_Gate must be true before Alarm is
4 Cfg_GateDly DINT IN
checked (sec)
1= Use simulated PV (Inp_SimValue); 0=Use
5 Cfg_Sim BOOL IN
Input (Inp_PV)
Target State of Input (Alarm if not in Target
6 Cfg_Target BOOL IN State); used to specify alarm state when
alarming is enabled
7 EnableIn BOOL IN Enable Input - System Defined Parameter
8 EnableOut BOOL OUT Enable Output - System Defined Parameter
9 Fault BOOL OUT DI X 1 = Alarm Active
Gate Condition to actively enable /disable
10 Inp_Gate BOOL IN
alarms (=1 to enable Alarm)
IO CLX InOut Paramter – PLC_STATUS
PLC_
11 Inp_PLC_STATUS STATUS
Para reference for setting Inp_TroubleActive and
m Inp_SimActive
12 Inp_PV BOOL IN Input Signal (process variable)
Input Comm Status or Quality 1=Bad, 0=OK;
13 Inp_PVBad BOOL IN
sets sts_PVBad

NEORSD_OL_Discrete.doc Page 4 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
14 Inp_SimValue BOOL IN PV used in Simulation (Cfg_Sim=1)
15 Inp_Trouble BOOL IN Trouble indication
CLX InOut parameter – Use a unique tag to
IO
16 Inp_Trouble_Desc STRING Param
hold the trouble description string, that
appears on the faceplate
17 InstructFault BOOL OUT 1=Config has generated an error
18 Sim BOOL OUT 1=Simulation Active
Discrete Input Status (incl. Debounce,
19 State BOOL OUT DI X
Manual Override, if used)
Discrete Input Status (actual, not subject to
20 Sts_PV BOOL OUT
Override)
21 Sts_PVBad BOOL OUT Input Comm Status/ Quality (0=OK, 1=Bad)
22 Sts_TgtDisagree BOOL OUT 1=Input is not in Target state
23 Trouble BOOL OUT DI X 1=Specified trouble condition active
24 Trouble_Desc STRING Local UDA Active trouble description read by the HMI

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Discrete

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
Trouble_Desc ---

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) State Labels – The default state labels are true/false. Although not required it
is recommended to specify a more meaningful label.

3) Invert – The invert checkbox is unlocked on the Fault and State field attribute.
If the Fault or State value on the instance needs to be inverted to match the
PLC, check this box.

NEORSD_OL_Discrete.doc Page 5 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

4) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Fault
b. State

1.3.6 Faceplates
Discrete_Faceplate
1

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tagname Displays the object name
3 State Indicates the discrete input state
4 Fault Indicates if the discrete object is in fault
Indicates if the discrete object is in trouble and shows the trouble description message
5 Trouble
below

1.3.7 Graphic Symbols

Alarm_TextDisplay Alarm_Light State_Light State_TextDisplay

NEORSD_OL_Discrete.doc Page 6 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

State_TextDisplay_Invis Alarm_TextDisplay_Invis Discrete_Interlock

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Discrete.doc Page 7 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

1.5 PanelView OIT

1.5.1 Object Instance


For text-based Discrete object symbols, configure the global object parameters as
shown below:
Name Description
1 PLC Tag
2 State 0 (Off) Text
3 State 1 (On) Text
4 Fault Text

For circular true/false indication only object symbols, the PLC tag is the only
required global object parameter
Name Description
1 PLC Tag

For the interlock/permissive status object symbol, configure the global parameters
as shown below:
Name Description
1 PLC Tag
2 Invert (Default=0: .State=1 X, .State=0 Check)

1.5.2 Faceplates
No faceplates are currently configured for the Discrete display.

NEORSD_OL_Discrete.doc Page 8 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete

1.5.3 Graphic Symbols

OIT Object Animations:


• OIT DISCRETE symbols are fixed in size. Multiple symbols of varying widths and
lengths are provided to accommodate application needs.
• Two sets of symbols are provided that differ in color animation:
o Symbols in shown in green above alternate between green (state=0, fault=0), red
(state=1, fault=0), or yellow (fault =1) during runtime
o Symbols shown in gray above alternate between invisible (state=0, fault=0), red
(state=1, fault=0), or yellow (fault=1) during runtime.

Interlock/Permissive OIT Object:


• Use the interlock/permissive object only for interlock status indication as shown on
equipment interlock/startup displays. Typically, these objects are shown on a
dedicated display in tabular format.
• Object has 2 states:
o Green checkmark, indicating the associated permissive/interlock condition is
satisfied.
o Red “X”, indicating that the associated permissive/interlock condition has not
been satisfied and that system operation/startup is prohibited.
• Object has the ability to invert the displayed state:
o Invert False (0 - Default): When DISCRETE.State = 1, display red “X”
o Invert True (1): When DISCRETE.State = 1, display green checkmark.

NEORSD_OL_Discrete.doc Page 9 of 9 Revision: 1.6.0


Title: NEORSD Standard Object Library - Discrete_RW

NEORSD Standard Object Library

Discrete_RW

NEORSD_OL_Discrete_RW.doc Page 1 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Jan-2011 PSIM All Issue for Use
Updated attribute list with Wonderware logging
1.0.1 14-Feb-2011 PSIM 1.2.1
details (“x” marks)
Added new attribute Inp_PLC_STATUS to Object
1.1.0 03-May-2011 PSIM 1.2.1
Attribute List.
Added PulseTime and TriggerTime UDAs to Object
1.2.0 29-June-2011 PSIM 1.2.1
Attributes List.

NEORSD_OL_Discrete_RW.doc Page 2 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

Table of Contents:
1.0  DISCRETE_RW ............................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Control ........................................................................................................................ 4 
1.1.2  Alarming ..................................................................................................................... 4 
1.1.3  Simulation ................................................................................................................... 4 
1.1.4  Trouble ........................................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 4 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 4 
1.3  WONDERWARE HMI ........................................................................................................ 5 
1.3.1  Hierarchical Name - $Discrete_RW ........................................................................... 5 
1.3.2  Derived from - $NEORSDUserDefined/$Discrete ..................................................... 5 
1.3.3  Container - None......................................................................................................... 5 
1.3.4  Extensions - None ....................................................................................................... 5 
1.3.5  Instance Configuration ............................................................................................... 5 
1.3.6  Faceplates ................................................................................................................... 6 
1.3.7  Graphic Symbols ......................................................................................................... 6 
1.4  CONTROLLOGIX PLC....................................................................................................... 7 
1.4.1  Available Languages................................................................................................... 7 
1.5  PANELVIEW OIT.............................................................................................................. 8 
1.5.1  Object Instance ........................................................................................................... 8 
1.5.2  Faceplates ................................................................................................................... 8 
1.5.3  Graphic Symbols ......................................................................................................... 8 

NEORSD_OL_Discrete_RW.doc Page 3 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

1.0 Discrete_RW
The Discrete_RW (read/write) object provides a standard method for setting a discrete
output and monitoring a corresponding state input throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Control
This object writes a command from the HMI and reads back the device state. It
also supports output tracking to a configurable state. Output retains current state
when tracking is disabled.

1.1.2 Alarming
This object contains one discrete alarm indicator (Fault). Fault is issued when the
commanded state does not match the feedback state, for a configurable period of
time. Fault does not unlatch the output.

1.1.3 Simulation
This object supports simulation. State feedback matches command output.

1.1.4 Trouble
This object supports hardware trouble indication. A trouble description tag must
be configured.

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware
Direction

Direction

Alarm

Event

Data
Item

Hist

Attributes Type Notes


Minimum time Input must disagree with
1 Cfg_AlarmTime DINT In
target to generate an Alarm (sec)
2 Cfg_DisableAlarming BOOL In 1=Disables all fault alarms
1=Use simulated PV (State matches output);
3 Cfg_Sim BOOL In
0=Use Input (Inp_PV)
4 EnableIn BOOL In Enable Input - System Defined Parameter
5 EnableOut BOOL Out Enable Output - System Defined Parameter
6 Fault BOOL Out DI X 1 = Alarm Active
CLX InOut Paramter – PLC_STATUS
PLC_ IO
7 Inp_PLC_STATUS STATUS Param
reference for setting Inp_TroubleActive and
Inp_SimActive
8 Inp_PV BOOL In Input Signal (process variable)
Input Comm Status or Quality 1=Bad, 0=OK;
9 Inp_PVBad BOOL In
sets sts_PVBad

NEORSD_OL_Discrete_RW.doc Page 4 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
10 Inp_TrackEnable BOOL In Input for program control of output variable
Output value when program control (tracking)
11 Inp_TrackValue BOOL In
enabled
12 Inp_Trouble BOOL In Trouble indication
IO CLX InOut Parameter: Use a Unique Tag to
13 Inp_Trouble_Desc STRING
Param Hold the Trouble Description String
14 InstructFault BOOL Out 1=Config Has Generated an Error
15 Out BOOL Out Output variable from the block
Amount of time (sec) the setpoint will be
16 PulseTime FLOAT IN UDA
written to the PLC before unlatch.
17 Sim BOOL Out 1=Simulation Active
18 State BOOL Out DI X Output variable from the block
19 State_CMD BOOL In DO X HMI request to set output from block
20 Sts_PVBad BOOL Out Input Comm Status/ Quality (0=OK, 1=Bad)
21 Sts_TgtDisagree BOOL Out 1=Input is not in Target state
22 Sts_TrackEnable BOOL Out 1=Tracking active
The current time, used in script with
23 TriggerTime TIME IN UDA
PulseTime for setpoint unlatch.
24 Trouble BOOL Out DI X 1=Specified trouble condition active
25 Trouble_Desc STRING Local UDA Active trouble description

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Discrete_RW

1.3.2 Derived from - $NEORSDUserDefined/$Discrete

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) State Labels – The default state labels are true/false. Although not required it
is recommended to specify a more meaningful label.

3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total

NEORSD_OL_Discrete_RW.doc Page 5 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

I/O scan counts. The allowed attributes for this template include the
following:
a. Fault

1.3.6 Faceplates
Discrete_RW_Faceplate

1
2

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name

3 State Indicates the discrete input state


4 Fault Indicates if the discrete object is in fault
Indicates if the discrete object is in trouble and shows the trouble description message
5 Trouble
below

1.3.7 Graphic Symbols

Discrete_RW_State_TextDisplay

NEORSD_OL_Discrete_RW.doc Page 6 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Discrete_RW.doc Page 7 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete_RW

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 State 0 Text
3 State 1 Text
4 Fault Text
5 Key Assignment (For Display Only)

1.5.2 Faceplates
No faceplates are currently configured for the Discrete_RW display.

1.5.3 Graphic Symbols


Note: Multiple sizes are offered as the box length is locked.

Actual field displays State or Fault.

NEORSD_OL_Discrete_RW.doc Page 8 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

NEORSD Standard Object Library

Discrete Setpoint

NEORSD_OL_Discrete_Setpoint.doc Page 1 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Jan-2011 PSIM All Issue for Use
1.0.1 14-Feb-2011 PSIM 1.2.1 Updated attribute table with event logging.
Added PulseTime and TriggerTime UDAs to Object
1.1.0 29-June-2011 PSIM 1.2.1
Attributes List.
Inserted Wonderware graphics
Discrete_Stpnt_Faceplate_Active,
Discrete_Stpnt_Faceplate_Passive,
1.2.0 19-Aug-2011 PSIM 1.3.7
Discrete_Stpnt_Momentary_Active,
Discrete_Stpnt_Momentary_Grey, and
Discrete_Stpnt_Momentary_Passive.

NEORSD_OL_Discrete_Setpoint.doc Page 2 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

Table of Contents:
1.0  DISCRETE SETPOINT ................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Output ......................................................................................................................... 4 
1.1.2  Trouble ........................................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 4 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 4 
1.3  WONDERWARE HMI ........................................................................................................ 5 
1.3.1  Hierarchical Name - $Discrete_Setpoint.................................................................... 5 
1.3.2  Derived from - $NEORSDUserDefined ...................................................................... 5 
1.3.3  Container - None......................................................................................................... 5 
1.3.4  Extensions - None ....................................................................................................... 5 
1.3.5  Instance Configuration ............................................................................................... 5 
1.3.6  Faceplates ................................................................................................................... 5 
1.3.7  Graphic Symbols ......................................................................................................... 6 
1.4  CONTROLLOGIX PLC....................................................................................................... 6 
1.4.1  Available Languages................................................................................................... 6 
1.5  PANELVIEW OIT.............................................................................................................. 8 
1.5.1  Functionality ............................................................................................................... 8 
1.5.2  Faceplates ................................................................................................................... 8 
1.5.3  Graphic Symbols ......................................................................................................... 8 

NEORSD_OL_Discrete_Setpoint.doc Page 3 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

1.0 Discrete Setpoint


The discrete setpoint template provides a standard method for writing a discrete output from
the HMI.

1.1 Object Features

1.1.1 Output
This object supports maintained or pulsed outputs and programmatically
inhibiting the output state. Note that the output state reflects the state of the object
and not any resulting latched logic.

1.1.2 Trouble
This object does not support hardware trouble indication or alarming.

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware
Direction

Direction

Alarm

Event

Data
Item

Hist

Attributes Type Notes


1=Toggle Out every Out_CMD press, 0 =
1 Cfg_MaintainedOutput BOOL In
Unlatch Out after 1 program scan
2 EnableIn BOOL In Enable Input - System Defined Parameter
3 EnableOut BOOL Out Enable Output - System Defined Parameter
4 Inp_Inhibit BOOL In Input for program to inhibit (unlatch) output
Amount of time (sec) the setpoint will be
5 PulseTime FLOAT IN UDA
written to the PLC before unlatch.
6 State BOOL Out DI X Output variable from the block
7 State_CMD BOOL In DO X HMI request to set output from block
8 Sts_Inhibited BOOL Out 1=Tracking active
The current time, used in script with
9 TriggerTime TIME IN UDA
PulseTime for setpoint unlatch.

NEORSD_OL_Discrete_Setpoint.doc Page 4 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Discrete_Setpoint

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration

1) State’s State Labels – The default state labels are true/false. Although not
required it is recommended to specify a more meaningful label.

2) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. None

1.3.6 Faceplates

Discrete_Setpoint_Faceplate
1
2

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name

NEORSD_OL_Discrete_Setpoint.doc Page 5 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

Graphic Design Element


Number
Function Description
This button is only selectable when the logged in user has proper control level access.
If the user is not logged in with the proper control level access the button is disabled and
the text becomes a light shade of grey indicating it is inactive. Pressing the button will
3 State Change display a pop up which will allow the user to change the state. The label on the button
indicated the direction the user will move the instance while the light indicates the
current state. Note that unless the block is configured to maintain the output, the user
will not see the state indication.

1.3.7 Graphic Symbols

Discrete_Stpnt_State_TextDisplay Discrete_Stpnt_Momentary_Active

Discrete_Stpnt_Faceplate_Active
Discrete_Stpnt_Momentary_Passive

Discrete_Stpnt_Momentary_Grey

Discrete_Stpnt_Faceplate_Passive

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

NEORSD_OL_Discrete_Setpoint.doc Page 6 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Discrete_Setpoint.doc Page 7 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Discrete Setpoint

1.5 PanelView OIT

1.5.1 Functionality

1.5.2 Faceplates
No faceplates are currently configured for the Discrete_Setpoint display.

1.5.3 Graphic Symbols


Note: Multiple sizes are offered as the box length is locked.

NEORSD_OL_Discrete_Setpoint.doc Page 8 of 8 Revision: 1.2.0


Title: NEORSD Standard Object Library - Motor Discrete

NEORSD Standard Object Library

Motor Discrete

NEORSD_OL_Motor_Discrete.doc Page 1 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 31-Jan-2011 PSIM All Issue for Use
1.0.1 07-Feb-2011 PSIM 1.2.1 Updated attribute table Auto_CMD direction.
1.0.1 07-Feb-2011 PSIM 1.3.4 Updated extensions list
1.1.0 07-Apr-2011 PSIM 1.3.5 Updated Me.Placeholder list to include REM
Updated OIT faceplates to include longer interlock
1.2.0 20-Apr-2011 PSIM 1.5.2
description field length.
Inserted OIT graphical symbols for grinder and
1.2.0 20-Apr-2011 PSIM 1.5.3
generic run status.
Added new attribute Inp_PLC_STATUS to Object
1.3.0 04-May-2011 PSIM 1.2.1
Attribute List.
1.4.0 13-May-2011 PSIM 1.3.5 Updated instance visibility configuration.
Added PulseTime and TriggerTime UDAs to Object
1.5.0 29-June-2011 PSIM 1.2.1
Attributes List.
Inserted Wonderware graphics Discrete_Compressor
1.5.0 29-June-2011 PSIM 1.3.7
and Discrete_Grinder.
1.6.0 19-Aug-2011 PSIM 1.5.3 Added blower objects to OIT symbol library.
1.7.0 14-Dec-2011 PSIM 1.1 Revised object feature descriptions
Added new attribute Cfg_OutputPulseTime,
1.7.0 14-Dec-2011 PSIM 1.2.1
Out_Start and Out_Stop, to Object Attribute List.
Inserted Wonderware graphics
Discrete_Running_RO, Discrete_Blower_Fan_RO,
1.7.0 14-Dec-2011 PSIM 1.3.7
Discrete_Pump_RO, Discrete_Motor_RO,
Discrete_Grinder_RO, and Discrete_Compressor_RO
1.7.0 14-Dec-2011 PSIM 1.4.1 Updated Ladder and Function Block
1.7.0 14-Dec-2011 PSIM 1.5.3 Updated standard Motor Discrete symbols

NEORSD_OL_Motor_Discrete.doc Page 2 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

Table of Contents:
1.0 MOTOR DISCRETE........................................................................................................ 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Controls ................................................................................................... 4
1.1.2 Alarming ................................................................................................................. 4
1.1.3 Simulation ............................................................................................................... 4
1.1.4 Trouble .................................................................................................................... 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ............................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 7
1.3.1 Hierarchical Name - $Motor_Discrete................................................................... 7
1.3.2 Derived from - $NEORSDUserDefined /$Motor_Discrete_Indicator ................... 7
1.3.3 Container - None..................................................................................................... 7
1.3.4 Extensions - None ................................................................................................... 7
1.3.5 Instance Configuration ........................................................................................... 7
1.3.6 Faceplates ............................................................................................................... 8
1.3.7 Graphic Symbols ................................................................................................... 10
1.4 CONTROLLOGIX PLC..................................................................................................... 11
1.4.1 Available Languages ............................................................................................. 11
1.5 PANELVIEW OIT............................................................................................................ 12
1.5.1 Object Instance ..................................................................................................... 12
1.5.2 Faceplates ............................................................................................................. 13
1.5.3 Graphic Symbols ................................................................................................... 16

NEORSD_OL_Motor_Discrete.doc Page 3 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.0 Motor Discrete


The motor discrete template provides a standard method for controlling the operation,
indication, and alarming of a 2-state motor throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Standard Controls


This object supports the following standard device control elements and
indications:
Local – Device controlled at local control station, outside of PLC logic.
Remote Manual – Device controlled by operator via faceplates and PLC.
Remote Auto – Device controlled by PLC logic.
OOS – Device is out of service and alarms are disabled.

The object allows for as many as five custom interlocks to be connected through
external logic. Interlocks prevent device operation.

If a device fault is generated, the object fails to it’s safe state (stopped, manual).

1.1.2 Alarming
This object provides the following alarm indications:
Fault – Object Fault, active when any fault condition is active.
High Temp – High Temperature alarm, from external logic.
High Vib – High Vibration alarm, from external logic.
Overload – Motor Overload alarm, from external logic.

Additional alarming is provided for in the PLC:


Start – Failure to Start alarm
Stop – Failure to Stop alarm
External – External Fault alarm, from external logic (such as motor
management module input)
Interlock Trip – Interlock Trip alarm, generated if an interlock condition
becomes true while the device is on or running.

1.1.3 Simulation
This object provides feedback of a working motor while disabling the outputs.

1.1.4 Trouble
This object supports hardware trouble indication. The text string for the trouble
description must be mapped to a user defined tag and configured in the object.

NEORSD_OL_Motor_Discrete.doc Page 4 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Auto BOOL OUT DI X 1=Auto Mode Active
2 Auto_CMD BOOL IN DO X HMI command to place valve in Auto
3 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
Delay before device fault is reset if not
4 Cfg_FaultActiveTime DINT IN
configured to latch
1=Require HMI Reset_CMD toggle to reset
5 Cfg_LatchFault BOOL IN fault, 0 =Automatically clear fault after
configurable delay
1=Manual only device, device cannot be
6 Cfg_ManOnlyDevice BOOL IN
placed in auto
Time in seconds pulsed outputs are held
7 Cfg_OutputPulseTime DINT IN active (until feedback met). Enter 0 to
maintain outputs.
1=Simulate motor feedback inputs;
8 Cfg_Sim BOOL IN
0=Start/Stop/Monitor actual motor
Time after Start to get Run Feedback
9 Cfg_StartTime DINT IN
before Fault (sec)
Time after Stop to drop Run Feedback
10 Cfg_StopTime DINT IN
before Fault (sec)
11 Cfg_UseRemote BOOL IN 1=Motor has LOCAL/OFF/REMOTE control
1=Motor run feedback should be used for
12 Cfg_UseRunFdbk BOOL IN
failure checking
13 EnableIn BOOL IN Enable Input - System Defined Parameter
14 EnableOut BOOL OUT Enable Output - System Defined Parameter
15 ExternalFault BOOL OUT Motor External Fault Indicator
16 Fault BOOL OUT DI X 1 = Alarm Active
17 HighTemp BOOL OUT DI X Motor/Bearing High Temperature Indicator
18 HighVib BOOL OUT DI X Motor High Vibration Indicator
19 Inp_AutoCMD BOOL IN Program Command to Start Motor
1=External Fault Condition Active. Faults
20 Inp_ExternalFault BOOL IN
Motor Object
1=Motor/Bearing high temperature. Faults
21 Inp_HighTemp BOOL IN
Motor Object.
1=High Motor Vibration Detected. Faults
22 Inp_HighVib BOOL IN
Motor Object.
1=Interlock 1 condition active, do not permit
23 Inp_Interlock1 BOOL IN
operation
1=Interlock 2 condition active, do not permit
24 Inp_Interlock2 BOOL IN
operation
1=Interlock 3 condition active, do not permit
25 Inp_Interlock3 BOOL IN
operation
1=Interlock 4 condition active, do not permit
26 Inp_Interlock4 BOOL IN
operation
1=Interlock 5 condition active, do not permit
27 Inp_Interlock5 BOOL IN
operation

NEORSD_OL_Motor_Discrete.doc Page 5 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1= Overload Trip Detected. Faults Motor
28 Inp_Overload BOOL IN
Object.
PLC_ CLX InOut Paramter – PLC_STATUS
IO
29 Inp_PLC_STATUS STATU
Param
reference for setting Inp_TroubleActive and
S Inp_SimActive
LOCAL/OFF/REMOTE position feedback
30 Inp_Remote BOOL IN
(1=Valve in Remote)
31 Inp_RunFdbk BOOL IN Input Signal: RUN feedback from motor
32 Inp_Trouble BOOL IN Trouble indication
IO CLX InOut Parameter: Use a Unique Tag
33 Inp_Trouble_Desc STRING
Param to Hold the Trouble Description String
34 InstructFault BOOL OUT 1=Config Has Generated an Error
1=Interlock 1 active, operation not
35 Interlock1 BOOL OUT DI X
permitted
1=Interlock 2 active, operation not
36 Interlock2 BOOL OUT DI X
permitted
1=Interlock 3 active, operation not
37 Interlock3 BOOL OUT DI X
permitted
1=Interlock 4 active, operation not
38 Interlock4 BOOL OUT DI X
permitted
1=Interlock 5 active, operation not
39 Interlock5 BOOL OUT DI X
permitted
40 OOS BOOL OUT DI X 1=OOS (Out of Service) Mode Active
41 OOS_CMD BOOL IN DO X HMI command to place valve in OOS
42 Out BOOL OUT 1=Energize Motor
1=Start Motor (pulse), 0=Leave Motor in
43 Out_Start BOOL OUT
current state
1=Stop Motor (pulse), 0=Leave Motor in
44 Out_Stop BOOL OUT
current state
45 Overload BOOL OUT DI X Motor Overload Indicator
Amount of time (sec) the setpoint will be
46 PulseTime FLOAT IN UDA
written to the PLC before unlatch.
47 Rem BOOL OUT DI X 1=Motor is in Remote
48 ResetAlarm_CMD BOOL IN 1=Reset alarm command from HMI
49 Running BOOL OUT DI X 1=Motor confirmed running
50 Sim BOOL OUT 1=Simulation Active
51 Start_CMD BOOL IN DO X HMI command to start motor in Manual
52 Stop_CMD BOOL IN DO X HMI command to stop motor in Manual
53 Sts_Interlocked BOOL OUT 1 or more device interlocks are active
The current time, used in script with
54 TriggerTime TIME IN UDA
PulseTime for setpoint unlatch.
55 Trouble BOOL OUT DI X 1=Specified trouble condition active
56 Trouble_Desc STRING Local UDA Active trouble description
1=Block has produced new fault that has
57 UnackedAlarm BOOL OUT
not been ackowledged/reset

NEORSD_OL_Motor_Discrete.doc Page 6 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Motor_Discrete

1.3.2 Derived from - $NEORSDUserDefined /$Motor_Discrete_Indicator

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault, HighTemp, HighVib and Overload need
to have a priority defined.

2) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. HighTemp
b. HighVib
c. Interlock1 to Interlock5
d. OOS
e. OOS_CMD
f. Overload
g. Fault
h. REM
i. Start_CMD
j. Stop_CMD

NEORSD_OL_Motor_Discrete.doc Page 7 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.3.6 Faceplates
Motor_Discrete_Faceplates

8
1
9
2
10
3

5
11

12

NEORSD_OL_Motor_Discrete.doc Page 8 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

Graphic Design Element


Number
Function Description
1 Tag Name Displays the object name.
Indicates the current mode. Allows for the toggling between automatic and manual
states. This button is only selectable when the logged in user has proper control level
access. If the user is not logged in with the proper control level access the switch is not
2 Auto / Manual Switch
selectable and becomes grey indicating it is not selectable. Regardless if the user is
logged in with the proper control level the switch will indicate the current state of the
mode.
Indicates if the motor is in remote mode. Remote mode allows the faceplate to be
3 Remote
manipulated by the HMI.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
any of those conditions are not met the button will be disabled and the text will appear
4 Start
grey indicating it is not selectable. If the conditions are met, pressing the Start button
will start the motor. The light is visible regardless if the conditions are met and is bright
red when running and dark when not running.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
any of those conditions are not met the button will be disabled and the text will appear
5 Stop
grey indicating it is not selectable. If the conditions are met, pressing the Stop button
will stop the motor. The light is visible regardless if the conditions are met and is bright
green when stopped and dark when not stopped.
This button is only selectable when the logged in user has proper control level access.
If the user is not logged in with the proper control level access the switch is not
6 Out of Service selectable and becomes grey indicating it is not selectable. Pressing the OOS button
will put the motor in out of service mode. The light is visible regardless if the conditions
are met and is bright red when out of service and dark when not out of service.
7 Interlock Indicates if the motor has an active interlock. Interlocks prevent operating the motor.
8 Close Button Pressing this button closes the faceplate display.
Provides navigation to the other sections of the faceplate. The status tab will also
9 Tabs
become animated upon alarms.
10 Alarms Indicates if the motor is has a Fault, HighTemp, HighVib, or Overload alarm.
11 Interlocks Status Displays the status of the configured interlocks.
12 Trouble Indicates if the object is in trouble and shows the trouble description message below.

NEORSD_OL_Motor_Discrete.doc Page 9 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.3.7 Graphic Symbols

Auto_Rem Discrete_Running Discrete_Running_RO

Discrete_Blower_Fan Discrete_Blower_Fan_RO

Discrete_Motor Discrete_Pump Discrete_Pump_RO Discrete_Motor_RO

Discrete_Grinder Discrete_Grinder_RO

Discrete_Compressor Discrete_Compressor_RO

NEORSD_OL_Motor_Discrete.doc Page 10 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

Note: For object faults to trigger off the following attribute settings are required:
Cfg_DisableAlarming = 0

NEORSD_OL_Motor_Discrete.doc Page 11 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
Keypad Assignment (For Display
4
Only)
5 Interlock 1 Description
6 Interlock 2 Description
7 Interlock 3 Description
8 Interlock 4 Description
9 Interlock 5 Description

NEORSD_OL_Motor_Discrete.doc Page 12 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.5.2 Faceplates
FP_MOTOR_DISCRETE
1
2

4
5

8
7

10

Graphic Design Element


Number Function Description
1 Tag Name Tag name for the motor object.
2 Description User defined description text for display only.
3 Navigation Buttons Opens second faceplate with additional information.
4 Device Status Displays mode (Auto/Manual), (Local/Remote) (and Out of Service (OOS).
Buttons to start and stop the motor. Command state is indicated by the black
5 Start/Stop
triangle.
6 Feedback Indicates if motor is running or stopped.
7 Mode Control Toggle the motor between Manual and Auto mode.
8 Alarm Indicators Lights indicate if a Fault, Trouble, or Interlock conditions is active.
9 Exit Button to close the faceplate.
Button to reset latched faults and interlocks; only visible if configured to latch
10 Reset
defaults

NEORSD_OL_Motor_Discrete.doc Page 13 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

FP_MOTOR_DISCRETE_DETAIL

1 2

Graphic Design Element


Number Function Description
1 Object Configurations Displays various object configuration settings within the PLC.
2 Instruction Fault Indicates a configuration error in the PLC.
Indicates the device has been placed out of service (OOS). OOS status may
3 Out of Service Status
be toggled from command button shown.

NEORSD_OL_Motor_Discrete.doc Page 14 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

FP_MOTOR_DISCRETE_STATUS

2
3

Graphic Design Element


Number Function Description
1 Interlock Status Displays the status for the configured Interlocks.
2 Trouble Displays the Trouble indication and Trouble message.
Lights indicate if a Fail to Start, Fail to Stop, Overload, High Temp, High Vib,
3 Fault Status
External or Interlock Trip is active.

NEORSD_OL_Motor_Discrete.doc Page 15 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete

1.5.3 Graphic Symbols

NEORSD_OL_Motor_Discrete.doc Page 16 of 16 Revision: 1.7.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

NEORSD Standard Object Library

Motor Discrete Indicator

NEORSD_OL_Motor_Discrete_Indicator.doc Page 1 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 01-Feb-2011 PSIM All Issue for Use
Inserted OIT graphical symbols for grinder and
1.1.0 04-May-2011 PSIM 1.5.3
generic run status.
Added new attribute Inp_PLC_STATUS to Object
1.1.0 04-May-2011 PSIM 1.2.1
Attribute List.
Inserted Wonderware graphic
1.2.0 03-June-2011 PSIM 1.3.7
Discrete_Indicator_Motor.
Inserted Wonderware graphics
1.3.0 29-June-2011 PSIM 1.3.7 Discrete_Indicator_Compressor and
Discrete_Indicator_Grinder.
1.4.0 19-Aug-2011 PSIM 1.5.3 Added blower objects to OIT symbol library.
Added new attribute Inp_ExternalFault to Object
1.5.0 14-Dec-2011 PSIM 1.2.1
Attribute List. Removed Auto.
Extended attribute Trouble_Desc default destination
1.5.0 14-Dec-2011 PSIM 1.3.4
is now Me.Placeholder
1.5.0 14-Dec-2011 PSIM 1.3.6 Updated Wonderware faceplates
1.5.0 14-Dec-2011 PSIM 1.4.1 Updated Ladder and Function Block

NEORSD_OL_Motor_Discrete_Indicator.doc Page 2 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

Table of Contents:
1.0 MOTOR DISCRETE INDICATOR ............................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Indications............................................................................................................... 4
1.1.2 Alarming ................................................................................................................. 4
1.1.3 Simulation ............................................................................................................... 4
1.1.4 Trouble .................................................................................................................... 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ............................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 6
1.3.1 Hierarchical Name - $Motor_Discrete_Indicator .................................................. 6
1.3.2 Derived from - $NEORSDUserDefined .................................................................. 6
1.3.3 Container - None..................................................................................................... 6
1.3.4 Extensions ............................................................................................................... 6
1.3.5 Instance Configuration ........................................................................................... 6
1.3.6 Faceplates ............................................................................................................... 7
1.3.7 Graphic Symbols ..................................................................................................... 7
1.4 CONTROLLOGIX PLC....................................................................................................... 8
1.4.1 Available Languages ............................................................................................... 8
1.5 PANELVIEW OIT.............................................................................................................. 9
1.5.1 Object Instance ....................................................................................................... 9
1.5.2 Faceplates ............................................................................................................... 9
1.5.3 Graphic Symbols ................................................................................................... 10

NEORSD_OL_Motor_Discrete_Indicator.doc Page 3 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.0 Motor Discrete Indicator


The motor discrete indicator template provides a standard method for monitoring the status
and alarming for discrete field operated motors, throughout the NEORSD MCS systems.
The object is not intended for the control of a motor.

1.1 Object Features

1.1.1 Indications
This object supports Running and Stopped feedback indicators.

1.1.2 Alarming
This object contains one discrete alarm indicator (Fault) which is based upon the
inputs for command state and feedback. If command state is unknown, alarming
should be disabled.

1.1.3 Simulation
This object provides simulated feedback for a discrete motor.

1.1.4 Trouble
This object supports hardware trouble indication. The Trouble_Desc tag must be
configured.

NEORSD_OL_Motor_Discrete_Indicator.doc Page 4 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
1=Simulate working valve; 0=Open/Close/
2 Cfg_Sim BOOL IN
Monitor actual valve
3 EnableIn BOOL IN Enable Input - System Defined Parameter

4 EnableOut BOOL OUT Enable Output - System Defined Parameter

5 Fault BOOL OUT DI X 1 = Alarm Active


1=External Fault Condition Active. Faults
6 Inp_ExternalFault BOOL IN
Motor Object
7 Inp_RunFdbk BOOL IN Input Signal: RUN feedback from motor
Device state (1=running) to display while in
8 Inp_SimValue BOOL IN
simulate mode
9 Inp_Trouble BOOL IN Trouble indication
IO CLX InOut Parameter: Use a Unique Tag to
10 Inp_Trouble_Desc STRING
Param Hold the Trouble Description String
11 InstructFault BOOL OUT 1=Config Has Generated an Error

12 Running BOOL OUT DI X 1=Motor confirmed running

13 Sim BOOL OUT 1=Simulation Active

14 Trouble BOOL OUT DI X 1=Specified trouble condition active

15 Trouble_Desc STRING Local UDA Active trouble description

NEORSD_OL_Motor_Discrete_Indicator.doc Page 5 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Motor_Discrete_Indicator

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
Trouble_Desc Me.Placeholder

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Fault

NEORSD_OL_Motor_Discrete_Indicator.doc Page 6 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.3.6 Faceplates

Motor_Disc_Ind_Faceplate
1

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.
3 Running Indicates if the motor is running.
4 Fault Indicates if the motor is in fault (command and state mismatch).
Indicates if the discrete object is in trouble and shows the trouble description message
5 Trouble
below

1.3.7 Graphic Symbols

Discrete_Indicator_Motor Discrete_Indicator_Grinder Discrete_Indicator_Compressor

Discrete_Indicator_Running

NEORSD_OL_Motor_Discrete_Indicator.doc Page 7 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Motor_Discrete_Indicator.doc Page 8 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description

1.5.2 Faceplates
No faceplates are currently configured for the Motor Discrete Indicator display.

NEORSD_OL_Motor_Discrete_Indicator.doc Page 9 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor Discrete Indicator

1.5.3 Graphic Symbols

NEORSD_OL_Motor_Discrete_Indicator.doc Page 10 of 10 Revision: 1.5.0


Title: NEORSD Standard Object Library - Motor VFD

NEORSD Standard Object Library

Motor VFD

NEORSD_OL_Motor_VFD.doc Page 1 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 07-Feb-2011 PSIM All Issue for Use
Added new attribute Op_Control_Perm to the Object
1.1.0 23-Feb-2011 PSIM 1.2.1
Attribute list.
1.1.0 23-Feb-2011 PSIM 1.3.4 Added Speed_Ind to extension list
1.2.0 07-Apr-2011 PSIM 1.0 Updated template introduction.
Added Motor_VFD_Spd_Display &
1.2.0 07-Apr-2011 PSIM 1.3.5
Motor_VFD_TxtStatus graphic symbol
1.2.0 07-Apr-2011 PSIM 1.3.7 Updated Me.Placeholder list to include REM
Updated OIT faceplates to include longer interlock
1.3.0 20-Apr-2011 PSIM 1.5.2
description field length.
Inserted OIT graphical symbols for grinder and
1.3.0 20-Apr-2011 PSIM 1.5.3
generic run status.
Added new attribute Inp_PLC_STATUS to Object
1.4.0 04-May-2011 PSIM 1.2.1
Attribute List.
1.5.0 13-May-2011 PSIM 1.3.5 Updated instance visibility configuration.
Added PulseTime and TriggerTime UDAs to Object
1.6.0 29-June-2011 PSIM 1.2.1
Attributes List.
Updated Wonderware graphic
1.6.0 29-June-2011 PSIM 1.3.7
Motor_VFD_Spd_Display.
1.7.0 19-Aug-2011 PSIM 1.5.3 Added blower objects to OIT symbol library.
1.7.0 19-Aug-2011 PSIM 1.2.1 Removed Wonderware Field Attribute Stopped.
1.7.0 19-Aug-2011 PSIM 1.3.7 Inserted Wonderware graphic Motor_VFD_PEPS.
1.8.0 14-Dec-2011 PSIM 1.1 Revised object feature descriptions
Added new attribute Stopped to the Object Attribute
1.8.0 14-Dec-2011 PSIM 1.2.1
list.
Extended attribute Trouble_Desc default destination
1.8.0 14-Dec-2011 PSIM 1.3.4
is now Me.Placeholder
1.8.0 14-Dec-2011 PSIM 1.3.7 Inserted Wonderware graphics w/o Faceplates (_RO).
1.8.0 14-Dec-2011 PSIM 1.4.1 Updated Ladder and Function Block
1.8.0 14-Dec-2011 PSIM 1.5.3 Updated standard Motor VFD symbols

NEORSD_OL_Motor_VFD.doc Page 2 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

Table of Contents:
1.0 MOTOR VFD .................................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Controls ................................................................................................... 4
1.1.2 Indications............................................................................................................... 4
1.1.3 Alarming ................................................................................................................. 4
1.1.4 Simulation ............................................................................................................... 4
1.1.5 Trouble .................................................................................................................... 5
1.2 OBJECT ATTRIBUTES........................................................................................................ 6
1.2.1 Table of Attributes & WW UDAs ............................................................................ 6
1.3 WONDERWARE HMI ...................................................................................................... 10
1.3.1 Hierarchical Name - $Motor_VFD ...................................................................... 10
1.3.2 Derived from - $VFD ............................................................................................ 10
1.3.3 Container - None................................................................................................... 10
1.3.4 Extensions ............................................................................................................. 10
1.3.5 Instance Configuration ......................................................................................... 10
1.3.6 Faceplates ............................................................................................................. 12
1.3.7 Graphic Symbols ................................................................................................... 14
1.4 CONTROLLOGIX PLC..................................................................................................... 16
1.4.1 Available Languages ............................................................................................. 16
1.5 PANELVIEW OIT............................................................................................................ 17
1.5.1 Object Instance ..................................................................................................... 17
1.5.2 Faceplates ............................................................................................................. 18
1.5.3 Graphic Symbols ................................................................................................... 22

NEORSD_OL_Motor_VFD.doc Page 3 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.0 Motor VFD


The Motor VFD template provides a standard method for controlling the operation,
indication, and alarming of VFD motors, fans and blowers throughout the NEORSD MCS
systems. The Motor_VFD is derived from the VFD template. The VFD template is only to
be used for further template derivation, and should never be used in the derivation of
instances.

1.1 Object Features

1.1.1 Standard Controls


This object supports the following standard device control elements:
Local – Device controlled at local control station, outside of PLC logic.
Remote Manual – Device controlled by operator via faceplates and PLC.
Remote Auto – Device controlled by PLC logic.
OOS – Device is out of service and alarms are disabled.
Drive Ready – IO from the drive indicates that it is ready to operate.

The object allows for as many as five custom interlocks to be connected through
external logic. Interlocks prevent device operation.

The object provides the capability to run the VFD in forward and reverse
direction. Direction is indicated at the OIT.

If a device fault is generated, the object fails to it’s safe state (stopped, manual).

1.1.2 Indications
This object provides speed feedback in both percent of full speed and RPM.
Scaling parameters are entered at the PLC. OIT faceplates also provide details on
drive parameters and status.

1.1.3 Alarming
This object provide for four discrete alarm indicators:
Fault – Object Fault, active when any fault condition is active.
High Temp – High Temperature alarm, from external logic.
High Vib – High Vibration alarm, from external logic.
DriveFault – IO from the drive indicates if there is a local drive fault.

If alarm indications, outside of those configured, are desired at the HMI or OIT,
Discrete or Analog Indicator objects can be used.

1.1.4 Simulation
This object provides feedback of a working motor while disabling the outputs.

NEORSD_OL_Motor_VFD.doc Page 4 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.1.5 Trouble
This object supports hardware trouble indication. The text string for the trouble
description must be mapped to a user defined tag and configured in the object.

NEORSD_OL_Motor_VFD.doc Page 5 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Auto BOOL OUT DI X 1=Auto Mode Active
2 Auto_CMD BOOL IN DO X HMI command to place drive in Auto
3 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
Time after Start to get Run Feedback
4 Cfg_FailToStartTime DINT IN
before Fault (sec)
Time after Stop to drop Run Feedback
5 Cfg_FailToStopTime DINT IN
before Fault (sec)
Delay before device fault is reset if not
6 Cfg_FaultActiveTime DINT IN
configured to latch
1=Drive can be run reverse, 0=Forward
7 Cfg_HasReverse BOOL IN
only
1=Drive provides speed feedback and run
8 Cfg_HasRunFdbk BOOL IN
signal
1=Require HMI Reset_CMD toggle to reset
9 Cfg_LatchFault BOOL IN fault, 0 =Automatically clear fault after
configurable delay
1=Manual only device, device cannot be
10 Cfg_ManOnlyDevice BOOL IN
placed in auto
Maximum Speed Reference Output to Drive
11 Cfg_MaxSpdRef REAL IN
(0-100%)
Minimum Speed Reference Output to Drive
12 Cfg_MinSpdRef REAL IN
(0-100%)
13 Cfg_ResetPulseTime DINT IN Time to pulse Out_Reset to clear drive fault
RPM at Maximum Speed Feedback in the
14 Cfg_RPMMax DINT IN
Drive (for scaling)
RPM at Minimum Speed Feedback in the
15 Cfg_RPMMin DINT IN
Drive (for scaling)
1=Simulate working drive; 0=Start/Stop/
16 Cfg_Sim BOOL IN
Monitor actual drive
Time to ramp speed fdbk when in
17 Cfg_SimRampTime DINT IN
Simulation (sec)
Speed Feedback Maximum in Drive (raw)
18 Cfg_SpeedFdbkRawMax INT IN
Units (for scaling)
Speed Feedback Minimum in Drive (raw)
19 Cfg_SpeedFdbkRawMin INT IN
Units (for scaling)
Speed Reference Maximum in Drive (raw)
20 Cfg_SpeedRefRawMax INT IN
Units (for scaling)
Speed Reference Minimum in Drive (raw)
21 Cfg_SpeedRefRawMin INT IN
Units (for scaling)
22 Cfg_UseRemote BOOL IN 1=Drive has LOCAL/OFF/REMOTE control
23 Current REAL OUT Drive Current Reading
Number of decimal places configured on
24 Decimal DINT IN UDA
the output value (Speed_Ind)
25 DriveFault BOOL OUT DI X Drive Fault Status (0=Ok, 1=Faulted)
26 EnableIn BOOL IN Enable Input - System Defined Parameter
27 EnableOut BOOL OUT Enable Output - System Defined Parameter

NEORSD_OL_Motor_VFD.doc Page 6 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
28 ExternalFault BOOL OUT Motor External Fault Indicator
29 Fault BOOL OUT DI X 1 = Alarm Active
Operator Command to set direction to
30 Fwd_CMD BOOL IN
Forward
31 HighTemp BOOL OUT DI X Motor/Bearing High Temperature Indicator
32 HighVib BOOL OUT DI X Motor High Vibration Indicator
1=Drive is running Forward, 0=Drive is
33 Inp_ActualDir BOOL IN
running Reverse
1=Drive has an Alarm Condition (see drive
34 Inp_Alarm BOOL IN
display or manual)
35 Inp_AtSpeed BOOL IN 1=Drive is at commanded speed
36 Inp_AutoCMD BOOL IN Program Command to Start Drive
Program Command to set direction to
37 Inp_AutoRev BOOL IN
Reverse
38 Inp_AutoSpeedRef REAL IN Program Setting of Speed Reference
39 Inp_Current REAL IN Input for Drive Current (Amps)
40 Inp_DriveFaulted BOOL IN 1=Drive has Faulted. Faults Motor Object.
1=External Fault Condition Active. Faults
41 Inp_ExternalFault BOOL IN
Motor Object
1=Motor/Bearing high temperature. Faults
42 Inp_HighTemp BOOL IN
Motor Object.
1=High Motor Vibration Detected. Faults
43 Inp_HighVib BOOL IN
Motor Object.
1=Interlock 1 condition active, do not permit
44 Inp_Interlock1 BOOL IN DI X
operation
1=Interlock 2 condition active, do not permit
45 Inp_Interlock2 BOOL IN DI X
operation
1=Interlock 3 condition active, do not permit
46 Inp_Interlock3 BOOL IN DI X
operation
1=Interlock 4 condition active, do not permit
47 Inp_Interlock4 BOOL IN DI X
operation
1=Interlock 5 condition active, do not permit
48 Inp_Interlock5 BOOL IN DI X
operation
Input Communication Status 0=OK, 1=Fail.
49 Inp_IOFault BOOL IN
Faults Motor Object.
CLX InOut Paramter – PLC_STATUS
PLC_ IO
50 Inp_PLC_STATUS reference for setting Inp_TroubleActive and
STATUS Param
Inp_SimActive
51 Inp_Ready BOOL IN 1=Drive is ready to run
LOCAL/OFF/REMOTE position feedback
52 Inp_Remote BOOL IN
(1=Drive in Remote)
53 Inp_Running BOOL IN 1=Drive is Running (active)
Speed Feedback in Drive Units (typ. 0-
54 Inp_SpeedFdbk INT IN
32767 = 0 to max freq.)
Input for Drive Torque (% Motor Nominal
55 Inp_Torque REAL IN
Torque)
56 Inp_Trouble BOOL IN Trouble indication
IO CLX InOut Parameter: Use a Unique Tag
57 Inp_Trouble_Desc STRING
Param to Hold the Trouble Description String
58 InstructFault BOOL OUT 1=Config Has Generated an Error

NEORSD_OL_Motor_VFD.doc Page 7 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1=Interlock 1 active, operation not
59 Interlock1 BOOL OUT
permitted
1=Interlock 2 active, operation not
60 Interlock2 BOOL OUT
permitted
1=Interlock 3 active, operation not
61 Interlock3 BOOL OUT
permitted
1=Interlock 4 active, operation not
62 Interlock4 BOOL OUT
permitted
1=Interlock 5 active, operation not
63 Interlock5 BOOL OUT
permitted
64 Jog_CMD BOOL IN Operator Command to Jog Drive
65 OOS BOOL OUT DI X 1=OOS (Out of Service) Mode Active
66 OOS_CMD BOOL IN DO X HMI command to place valve in OOS
Determines whether the operator or admin
67 Op_Control_Perm BOOL NA UDA
can change the setpoint
Maximum Speed Reference (for limiting);
68 Operator_HiLimit REAL OUT UDA
from Cfg_MaxSpdRef
Minimum Speed Reference (for limiting);
69 Operator_LoLimit REAL OUT UDA
from Cfg_MinSpdRef
70 Out_ClearFault BOOL OUT 1=Attempt to clear Drive Fault
71 Out_Fwd BOOL OUT 1=Set drive direction to Forward
1=Jog drive at Jog Speed, -->0=Stop
72 Out_Jog BOOL OUT
jogging
73 Out_Rev BOOL OUT 1=Set drive direction to Reverse
1=Start/Run Drive, 0=Stop Drive (for held
74 Out_Run BOOL OUT
starter type)
Drive Speed Reference in Drive Units (typ.
75 Out_SpeedRef INT OUT
0-32767 = 0 to max freq.)
76 Out_Start BOOL OUT 1=Start Drive, 0=drive left in current state
77 Out_Stop BOOL OUT 1=Stop Drive, 0=drive left in current state
Amount of time (sec) the setpoint will be
78 PulseTime FLOAT IN UDA
written to the PLC before unlatch.
79 Rem BOOL OUT DI X 1=Drive is in Remote
80 ResetAlarm_CMD BOOL IN Operator Command to Reset Drive fault
81 ResetDriveFault_CMD BOOL IN Operator Command to Reset Drive
Operator Command to set direction to
82 Rev_CMD BOOL IN
Reverse
AI
83 RPM DINT OUT Speed Feedback referenced in RPM units
Float X
84 RPMMax DINT OUT UDA Drive Engineering Units (RPM) Maximum
85 RPMMin DINT OUT UDA Drive Engineering Units (RPM) Minimum
1=Drive requested to run and is confirmed
86 Running BOOL OUT DI
X running
87 Sim BOOL OUT 1=Simulation Active
AI/O
88 Speed_CMD REAL IN Operator Setting of Speed Reference (EU)
Float X
AI Speed Feedback (actual) from drive (0-
89 Speed_Ind REAL OUT
Float X 100%)
Speed Reference (target) to drive (0 -
90 Speed_Ref REAL OUT
100%)

NEORSD_OL_Motor_VFD.doc Page 8 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
91 Start_CMD BOOL IN DO X Operator Command to Start Drive
92 Stop_CMD BOOL IN DO X Operator command to Stop Drive
93 Stopped BOOL OUT 1=Drive is confirmed stopped
1=Drive Actual direction is Forward,
94 Sts_ActualDir BOOL OUT
0=Reverse
1=Drive has an Alarm (see drive display or
95 Sts_Alarm BOOL OUT
manual)
96 Sts_AtSpeed BOOL OUT 1=Drive is running at reference speed
1=Drive commanded to Forward,
97 Sts_CommandDir BOOL OUT
0=Reverse
98 Sts_Interlocked BOOL OUT 1 or more device interlocks are active
99 Sts_IOFault BOOL OUT I/O Comm Fault Status (0=OK, 1=Bad)
100 Sts_Jogging BOOL OUT 1=Drive requested to Jog
1=Drive is Not Ready (cannot be
101 Sts_NotReady BOOL OUT
started)$NCheck alarms, stops, faults
1=Speed Reference is at configured Max or
102 Sts_SpeedLimited BOOL OUT
Min limit
103 Torque DINT OUT Drive Motor Torque Reading
The current time, used in script with
104 TriggerTime TIME IN UDA
PulseTime for setpoint unlatch.
105 Trouble BOOL OUT DI X 1=Specified trouble condition active
106 Trouble_Desc STRING Local String Active trouble description
1=Block has produced new fault that has
107 UnackedAlarm BOOL OUT
not been ackowledged/reset

NEORSD_OL_Motor_VFD.doc Page 9 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Motor_VFD

1.3.2 Derived from - $VFD

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
RPM.EngUnitsMax Me.EUMax x
RPM.EngUnitsMin Me.EUMin x
RPM.EngUnitsRangeMax Me.EUMax x
RPM.EngUnitsRangeMin Me.EUMin x
RPM.RawMax Me.EUMax x
RPM.RawMin Me.EUMin x
RPM.TrendHi Me.EUMax x
RPM.TrendLo Me.EUMin x
Speed_CMD.EngUnitsMax Me.Operator_HiLimit x
Speed_CMD.EngUnitsMin Me.Operator_LoLimit x
Speed_CMD.EngUnitsRangeMax Me.Operator_HiLimit x
Speed_CMD.EngUnitsRangeMin Me.Operator_LoLimit x
Speed_CMD.RawMax Me.Operator_HiLimit x
Speed_CMD.RawMin Me.Operator_LoLimit x
Speed_Ind.EngUnitsMax Me.Operator_HiLimit x
Speed_Ind.EngUnitsMin Me.Operator_LoLimit x
Speed_Ind.EngUnitsRangeMax Me.Operator_HiLimit x
Speed_Ind.EngUnitsRangeMin Me.Operator_LoLimit x
Speed_Ind.RawMax Me.Operator_HiLimit x
Speed_Ind.RawMin Me.Operator_LoLimit x
Speed_Ind.TrendHi Me.Operator_HiLimit x
Speed_Ind.TrendLo Me.Operator_LoLimit x
Trouble_Desc Me.Placeholder x

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault, HighTemp, HighVib and DriveFault
need to have a priority defined.

NEORSD_OL_Motor_VFD.doc Page 10 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

2) Operator_HiLimit/Operator_LoLimit – UDAs that control the allowable input


values of the CMD attribute. The default values are 100 and 0 respectively
and need to be specified on the instance. These can be altered on the UDA tab.

3) Engineering Units - The Engineering Units of Speed_Ind must be defined on


the Field Attributes tab.

4) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Fault
b. HighTemp
c. HighVib
d. Interlock1 to Interlock5
e. OOS
f. OOS_CMD
g. DriveFault
h. RPM
i. Speed_CMD
j. Speed_Ind
k. REM
l. Start_CMD
m. Stop_CMD

Note: The Engineering Units for Speed_CMD are designed to match those of Speed_Ind.
Therefore it is not necessary to configure the Engineering Units for CMD.

NEORSD_OL_Motor_VFD.doc Page 11 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.3.6 Faceplates
Motor_VFD_Faceplates

1
2
3 9

4 10

11
5

6 12

7 13

14

15

16

NEORSD_OL_Motor_VFD.doc Page 12 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

Graphic Design Element


Number
Function Description
1 Tag Name Displays the object name.
Provides navigation to the other sections of the faceplate. The status tab will also
2 Tabs
become animated upon alarms.
Indicates the current mode. Allows for the toggling between automatic and manual
states. This button is only selectable when the logged in user has proper control level
access. If the user is not logged in with the proper control level access the switch is not
3 Auto / Manual Switch
selectable and becomes grey indicating it is not selectable. Regardless if the user is
logged in with the proper control level the switch will indicate the current state of the
mode.
Indicates if the motor is in remote mode. Remote mode allows the faceplate to be
4 Remote
manipulated by the HMI.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
any of those conditions are not met the button will be disabled and the text will appear
5 Start
grey indicating it is not selectable. If the conditions are met, pressing the Start button
will start the motor. The light is visible regardless if the conditions are met and is bright
red when running and dark when not running.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
any of those conditions are not met the button will be disabled and the text will appear
6 Stop
grey indicating it is not selectable. If the conditions are met, pressing the Stop button
will stop the motor. The light is visible regardless if the conditions are met and is bright
green when not running and dark when running.
This button is only selectable when the logged in user has proper control level access.
If the user is not logged in with the proper control level access the switch is not
7 Out of Service selectable and becomes grey indicating it is not selectable. Pressing the OOS button
will put the motor in out of service mode. The light is visible regardless if the conditions
are met and is bright red when out of service and dark when not out of service.
8 Interlock Indicates if the motor has an active interlock. Interlocks prevent operating the motor.
9 Speed Indication Displays the Speed as a percentage of full speed.
The setpoint is entered as a percent of full speed.
This button is only selectable when the logged in user has proper control level access.
Pressing the Setpoint button will display an entry box that can be used to set the value.
10 Setpoint
If not logged in with the proper control level access the box is not selectable and the text
becomes a very light shade of grey indicating it is inactive. Displayed value is the value
read from the PLC.
Displays the values of the Operator High and Low limits. These are configured in the
11 Operator Limits
PLC.
12 RPM Displays the value of the motor RPM.
13 RPM Limits Displays the values of the RPM Min and Max limits, for trending and display purpose.
14 Alarms Indicates if the motor is has a Fault, HighTemp, HighVib, or Overload alarm.
15 Interlocks Status Displays the status of the configured interlocks.
16 Trouble Indicates if the object is in trouble and shows the trouble description message below.

NEORSD_OL_Motor_VFD.doc Page 13 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.3.7 Graphic Symbols

Motor_VFD_Fan Motor_VFD_Fan_RO

Motor_VFD_Motor Motor_VFD_Motor_RO

Motor_VFD_Pump Motor_VFD_Pump_RO

Motor_VFD_PEPS Motor_VFD_PEPS_RO

NEORSD_OL_Motor_VFD.doc Page 14 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

Motor_VFD_Spd_Display Motor_VFD_Spd_Display_RO

Motor_VFD_TxtStatus Motor_VFD_TxtStatus_RO

Auto_REM

** Blue background on Speed Display indicates operator action possible.

NEORSD_OL_Motor_VFD.doc Page 15 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Motor_VFD.doc Page 16 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
#1 PLC Tag
#2 Display Name (Device Tag)
#3 Device Description
#4 Keypad Assignment (For Display Only)
#5 Interlock 1 Description
#6 Interlock 2 Description
#7 Interlock 3 Description
#8 Interlock 4 Description
#9 Interlock 5 Description

NEORSD_OL_Motor_VFD.doc Page 17 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.5.2 Faceplates
FP_MOTOR_VFD
1
2
3

5 6

7
8

9 10

11
12
13
14
15

Graphic Design Element


Number Function Description
User entered tag name for the motor object. Does not have to be the actual
1 Tag Name
tag name; may reflect the device tag name is desired.
2 Description User defined description text for display only.
3 Navigation Buttons Opens second faceplate with additional information.
4 Device Status Displays mode (Auto/Manual), (Local/Remote) and Out of Service (OOS).
Buttons to start and stop the motor. Command state is indicated by the black
5 Start/Stop
triangle.
Indicates if motor is running or stopped, based on command state and
6 Feedback
feedback IO.
7 Drive Status Indicates drive ready status, drive alarm status, and operating direction.
8 Speed Bar Graphical indication of device speed.

NEORSD_OL_Motor_VFD.doc Page 18 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

Graphic Design Element


Number Function Description
Pressing the indicated function key will open a numeric keypad for entering the
9 Setpoint Entry
operator set point.
Allows the user to set the direction of the motor. Secured function; requires
10 Direction Command
proper access level.
Provides indication of common data from the drive: RPM, Current, and
11 Drive Data
Torque.
12 Mode Control Toggle the motor between Manual and Auto mode.
13 Alarm Indicators Lights indicate if a Fault, or Trouble or Interlock is active.
14 Exit Button to close the faceplate.
Button to reset latched faults and interlocks; only visible if configured to latch
15 Reset
defaults

NEORSD_OL_Motor_VFD.doc Page 19 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

FP_MOTOR_VFD_DETAIL

3 2
4

Graphic Design Element


Number Function Description
Indicates the actual PLC tag for informational purposes. Note: the Tag Name
1 Actual PLC Tag
in the top header is text entered during the setup of the graphic instance.
2 Instruction Fault Indicates a configuration error in the PLC.
3 Object Configurations Displays various configuration settings within the PLC.
Indicates the device has been placed out of service (OOS). OOS status may
4 Out of Service Status
be toggled from command button shown.
5 Speed Configurations Displays speed scaling data from within the PLC.
6 RPM Configurations Displays the RPM Min and Max settings
7 Drive Indicators Indicates if the Drive is in Alarm or Fault.
8 Reset Drive Resets the VFD Alarm or Fault.

NEORSD_OL_Motor_VFD.doc Page 20 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

FP_MOTOR_VFD_STATUS

2
3

Graphic Design Element


Number Function Description
1 Interlock Status Displays the status for the configured Interlocks.
2 Trouble Displays the Trouble indication and Trouble message.
Lights indicate if a Fail to Start, Fail to Stop, Overload, High Temp, High Vib,
3 Fault Status
External, IO Fault or Interlock Trip is active.

NEORSD_OL_Motor_VFD.doc Page 21 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - Motor VFD

1.5.3 Graphic Symbols

NEORSD_OL_Motor_VFD.doc Page 22 of 22 Revision: 1.8.0


Title: NEORSD Standard Object Library - MultiState Ind

NEORSD Standard Object Library

MultiState Ind

NEORSD_OL_MultiState_Ind.doc Page 1 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 13-May-2011 PSIM All Issue for Use
1.1.0 17-Oct-2011 PSIM 1.2.1 Updated attribute Ind_Desc to Ind.

NEORSD_OL_MultiState_Ind.doc Page 2 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

Table of Contents:
1.0  MULTISTATE IND.......................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Control ........................................................................................................................ 4 
1.1.2  Indications................................................................................................................... 4 
1.1.3  Simulation - None ....................................................................................................... 4 
1.1.4  Trouble - None ............................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 5 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 5 
1.3  WONDERWARE HMI ........................................................................................................ 6 
1.3.1  Hierarchical Name - $MultiState_Ind ........................................................................ 6 
1.3.2  Derived from - $NEORSDUserDefined ...................................................................... 6 
1.3.3  Container - None......................................................................................................... 6 
1.3.4  Extensions - None ....................................................................................................... 6 
1.3.5  Instance Configuration ............................................................................................... 7 
1.3.6  Faceplates – None....................................................................................................... 7 
1.3.7  Graphic Symbols ......................................................................................................... 7 
1.4  CONTROLLOGIX PLC....................................................................................................... 8 
1.1  PANELVIEW OIT.............................................................................................................. 8 

NEORSD_OL_MultiState_Ind.doc Page 3 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

1.0 MultiState Ind


The MultiState Ind template provides a standard method for displaying multiple states
through text displays. It also allows the user to manually increment to the next step.
This template consists of an HMI portion only, and has no corresponding PLC (AOI) or OIT
component.

1.1 Object Features

1.1.1 Control
This object is designed to interface with a specific section of logic in use at the
NEORSD. The object functionality allows the user to force a transition to the next
state of a defined sequence. After reaching the last state, it will reset to the initial
state.

The configuration is done through the input of a single word and through scripting
broken apart into individual bits which are passed into UDAs within the template.
The graphics then change state based upon the bit status with the controller.
Therefore all of the indication bits need to be contained in order in the same word
within the controller. Any bits after the bits being used for the MultiState are free
to be used for other functionality.

One preconfigured application is for Lead/Lag logic. The states are incremented
by logic, or manually, to configure a set of pumps. These are just the default texts
and colors and can be changed within the UDAs. To change the text change the
BitX_Text UDA, for color change BitX_Box_Color. For unused bits enter
Me.Placeholder into the BixX_Text UDA. If a situation occurs where none of the
configured bits are active and an non configured bit is active, a Not Configured
notification will be displayed.

1.1.2 Indications
This object provides indication of the various states of an object through text
display. The text and background color is configurable at the instance level. The
text box colors should be used as such: Red for Active State, Green for Inactive,
Yellow for Alarm, and White for Other.

The Operator changes the state by selecting the Lead_Select_Button. The text on
the button comes from the string entered in the Button_Text UDA.

1.1.3 Simulation - None

1.1.4 Trouble - None

NEORSD_OL_MultiState_Ind.doc Page 4 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
The Bit_Note includes instance
1  Bit_Note BOOL NDA UDA configuration instructions for the
BitX_Box_Color and BitX_Text.
2  Bit0 BOOL NA UDA State 1
3  Bit0_Box_Color BOOL NA UDA State 1 box color
4  Bit0_Text BOOL NA UDA State 1 string that appears on the grahic
5  Bit1 BOOL NA UDA State 2
6  Bit1_Box_Color BOOL NA UDA State 2 box color
7  Bit1_Text BOOL NA UDA State 2 string that appears on the grahic
8  Bit2 BOOL NA UDA State 3
9  Bit2_Box_Color BOOL NA UDA State 3 box color
10  Bit2_Text BOOL NA UDA State 3 string that appears on the grahic
11  Bit3 BOOL NA UDA State 4
12  Bit3_Box_Color BOOL NA UDA State 4 box color
13  Bit3_Text BOOL NA UDA State 4 string that appears on the grahic
14  Bit4 BOOL NA UDA State 5
15  Bit4_Box_Color BOOL NA UDA State 5 box color
16  Bit4_Text BOOL NA UDA State 5 string that appears on the grahic
17  Bit5 BOOL NA UDA State 6
18  Bit5_Box_Color BOOL NA UDA State 6 box color
19  Bit5_Text BOOL NA UDA State 6 string that appears on the grahic
20  Bit6 BOOL NA UDA State 7
21  Bit6_Box_Color BOOL NA UDA State 7 box color
22  Bit6_Text BOOL NA UDA State 7 string that appears on the grahic
23  Bit7 BOOL NA UDA State 8
24  Bit7_Box_Color BOOL NA UDA State 8 box color
25  Bit7_Text BOOL NA UDA State 8 string that appears on the grahic
26  Bit8 BOOL NA UDA State 9
27  Bit8_Box_Color BOOL NA UDA State 9 box color
28  Bit8_Text BOOL NA UDA State 9 string that appears on the grahic
29  Bit9 BOOL NA UDA State 10
30  Bit9_Box_Color BOOL NA UDA State 10 box color
31  Bit9_Text BOOL NA UDA State 10 string that appears on the grahic
32  Bit10 BOOL NA UDA State 11

NEORSD_OL_MultiState_Ind.doc Page 5 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
33  Bit10_Box_Color BOOL NA UDA State 11 box color
34  Bit10_Text BOOL NA UDA State 11 string that appears on the grahic
35  Bit11 BOOL NA UDA State 12
36  Bit11_Box_Color BOOL NA UDA State 12 box color
37  Bit11_Text BOOL NA UDA State 12 string that appears on the grahic
38  Bit12 BOOL NA UDA State 13
39  Bit12_Box_Color BOOL NA UDA State 13 box color
40  Bit12_Text BOOL NA UDA State 13 string that appears on the grahic
41  Bit13 BOOL NA UDA State 14
42  Bit13_Box_Color BOOL NA UDA State 14 box color
43  Bit13_Text BOOL NA UDA State 14 string that appears on the grahic
44  Bit14 BOOL NA UDA State 15
45  Bit14_Box_Color BOOL NA UDA State 15 box color
46  Bit14_Text BOOL NA UDA State 15 string that appears on the grahic
47  Bit15 BOOL NA UDA State 16
48  Bit15_Box_Color BOOL NA UDA State 16 box color
49  Bit15_Text BOOL NA UDA State 16 string that appears on the grahic
50 Button_Text STRING NA UDA Displays text on the button
AI Word that is broken into bits to determine
51 Ind REAL NA
Int
X
the state of the device
Manual command to change the state of
52 Ind_Select REAL NA DO X
the device.

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $MultiState_Ind

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions - None

NEORSD_OL_MultiState_Ind.doc Page 6 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

1.3.5 Instance Configuration


All of the necessary configuration for MultiState Ind must also be done on any
instance derived from this template.
1) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. Ind_Select can use Me.Placeholder for the input source if the
multistate device is read only. The allowed attributes for this template include
the following:
a. Bit0_Text
b. Bit1_Text
c. Bit2_Text
d. Bit3_Text
e. Bit4_Text
f. Bit5_Text
g. Bit6_Text
h. Bit7_Text
i. Bit8_Text
j. Bit9_Text
k. Bit10_Text
l. Bit11_Text
m. Bit12_Text
n. Bit13_Text
o. Bit14_Text
p. Bit15_Text
q. Ind_Select

1.3.6 Faceplates – None

1.3.7 Graphic Symbols

MultiState_Ind_Display MultiState_Ind_Button

NEORSD_OL_MultiState_Ind.doc Page 7 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - MultiState Ind

1.4 ControlLogix PLC


No ControlLogix component (AOI) exists for this template. A UDT may be used to
integrate the object with a ControlLogix program.

1.1 PanelView OIT


No PanelView component (Global Object) exists for this template. An interface may be
constructed using standard Rockwell FactroyTalk View components.

NEORSD_OL_MultiState_Ind.doc Page 8 of 8 Revision: 1.1.0


Title: NEORSD Standard Object Library - PB_Single_Select

NEORSD Standard Object Library

PB_Single_Select

NEORSD_OL_PB_Single_Select.doc Page 1 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 24-Jan-2012 PSIM All Issue for Use

NEORSD_OL_PB_Single_Select.doc Page 2 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

Table of Contents:
1.0  PB_SINGLE_SELECT .................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Alarming - None.......................................................................................................... 4 
1.1.2  Simulation - None ....................................................................................................... 4 
1.1.3  Trouble - None ............................................................................................................ 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 5 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 5 
1.3  WONDERWARE HMI ........................................................................................................ 6 
1.3.1  Hierarchical Name - $PB_Single_Select .................................................................... 6 
1.3.2  Derived from - $NEORSDUserDefined ...................................................................... 6 
1.3.3  Container - None......................................................................................................... 6 
1.3.4  Extensions - None ....................................................................................................... 6 
1.3.5  Instance Configuration - None.................................................................................... 6 
1.3.6  Faceplates ................................................................................................................... 7 
1.3.7  Graphic Symbols ......................................................................................................... 7 
1.4  CONTROLLOGIX PLC....................................................................................................... 8 
1.4.1  Available Languages................................................................................................... 8 
1.5  PANELVIEW OIT.............................................................................................................. 9 
1.5.1  Object Instance ........................................................................................................... 9 
1.5.2  Faceplates ................................................................................................................. 10 
1.5.3  Graphic Symbols ....................................................................................................... 10 

NEORSD_OL_PB_Single_Select.doc Page 3 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

1.0 PB_Single_Select
The PB_Single_Select template provides a standard pushbutton dialogue box for operator
input or selection. The instruction supports up to 10 maintained, interlocking pushbutton
states. Upon selection of a state, all other states are unlatched, allowing only a single state
to be selected at any given time.

1.1 Object Features

1.1.1 Alarming - None

1.1.2 Simulation - None

1.1.3 Trouble - None

NEORSD_OL_PB_Single_Select.doc Page 4 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Cfg_NumberPB DINT IN Number of Pushbuttons Available for Selection
2 EnableIn BOOL IN Enable Input - System Defined Parameter
3 EnableOut BOOL OUT Enable Output - System Defined Parameter

4 Inhibit1_Ind BOOL OUT DI X State 1 Inhibited Status (1=Inhibited)

5 Inhibit10_Ind BOOL OUT DI X State 10 Inhibited Status (1=Inhibited)

6 Inhibit2_Ind BOOL OUT DI X State 2 Inhibited Status (1=Inhibited)

7 Inhibit3_Ind BOOL OUT DI X State 3 Inhibited Status (1=Inhibited)

8 Inhibit4_Ind BOOL OUT DI X State 4 Inhibited Status (1=Inhibited)

9 Inhibit5_Ind BOOL OUT DI X State 5 Inhibited Status (1=Inhibited)

10 Inhibit6_Ind BOOL OUT DI X State 6 Inhibited Status (1=Inhibited)

11 Inhibit7_Ind BOOL OUT DI X State 7 Inhibited Status (1=Inhibited)

12 Inhibit8_Ind BOOL OUT DI X State 8 Inhibited Status (1=Inhibited)

13 Inhibit9_Ind BOOL OUT DI X State 9 Inhibited Status (1=Inhibited)

14 Inp_Inhibit1 BOOL IN Input To Inhibit State 1 (1=Inhibit)

15 Inp_Inhibit10 BOOL IN Input To Inhibit State 10 (1=Inhibit)

16 Inp_Inhibit2 BOOL IN Input To Inhibit State 2 (1=Inhibit)

17 Inp_Inhibit3 BOOL IN Input To Inhibit State 3 (1=Inhibit)

18 Inp_Inhibit4 BOOL IN Input To Inhibit State 4 (1=Inhibit)

19 Inp_Inhibit5 BOOL IN Input To Inhibit State 5 (1=Inhibit)

20 Inp_Inhibit6 BOOL IN Input To Inhibit State 6 (1=Inhibit)

21 Inp_Inhibit7 BOOL IN Input To Inhibit State 7 (1=Inhibit)

22 Inp_Inhibit8 BOOL IN Input To Inhibit State 8 (1=Inhibit)

23 Inp_Inhibit9 BOOL IN Input To Inhibit State 9 (1=Inhibit)

24 InstructFault BOOL OUT 1=Config Has Generated an Error

25 Out_1 BOOL OUT Pushbutton 1 Status Output (1=Selected)


26 Out_10 BOOL OUT Pushbutton 10 Status Output (1=Selected)
27 Out_2 BOOL OUT Pushbutton 2 Status Output (1=Selected)
27 Out_3 BOOL OUT Pushbutton 3 Status Output (1=Selected)

NEORSD_OL_PB_Single_Select.doc Page 5 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
28 Out_4 BOOL OUT Pushbutton 4 Status Output (1=Selected)
29 Out_5 BOOL OUT Pushbutton 5 Status Output (1=Selected)
30 Out_6 BOOL OUT Pushbutton 6 Status Output (1=Selected)
31 Out_7 BOOL OUT Pushbutton 7 Status Output (1=Selected)
32 Out_8 BOOL OUT Pushbutton 8 Status Output (1=Selected)
33 Out_9 BOOL OUT Pushbutton 9 Status Output (1=Selected)
34 PB DINT OUT AI X Currently Selected Active Pushbutton
35 PB_CMD DINT IN AO X HMI Pushbutton Select Command
Configures the number of pushbuttons visible
36 PB_Count Int NA UDA
on the HMI faceplate
37 Text_1 String NA UDA Configures pushbutton 1 state description
38 Text_10 String NA UDA Configures pushbutton 10 state description
39 Text_2 String NA UDA Configures pushbutton 2 state description
40 Text_3 String NA UDA Configures pushbutton 3 state description
41 Text_4 String NA UDA Configures pushbutton 4 state description
42 Text_5 String NA UDA Configures pushbutton 5 state description
43 Text_6 String NA UDA Configures pushbutton 6 state description
44 Text_7 String NA UDA Configures pushbutton 7 state description
45 Text_8 String NA UDA Configures pushbutton 8 state description
46 Text_9 String NA UDA Configures pushbutton 9 state description

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $PB_Single_Select

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration - None

NEORSD_OL_PB_Single_Select.doc Page 6 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

1.3.6 Faceplates
PB_Single_Select_Faceplate
1
2

Graphic Design Element


Number Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.
Individual configurable descriptions displayed next to each selectable
3 State Description
state. This text is customized through the use of the UDAs Text_X.
State Select Interlocking pushbutton array allowing the operator to select one of up to ten
4
Pushbutton possible states.
5 State Status Indication of the currently selected state. The active state displays red.
6 Inhibit Pushbutton Read only Inhibit which disables pushbutton selection.

1.3.7 Graphic Symbols

PFP4_Backup_Select_Button

NEORSD_OL_PB_Single_Select.doc Page 7 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_PB_Single_Select.doc Page 8 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Symbol PB Description
3 Faceplate Description
4 Keypad Assignment (For Display Only)
5 Faceplate Pushbutton State 0 Description (E.g. Disabled)
6 Faceplate Pushbutton State 1 Description (E.g. Online)
7 Faceplate Selection 1 Description
8 Faceplate Selection 2 Description
9 Faceplate Selection 3 Description
10 Faceplate Selection 4 Description
11 Faceplate Selection 5 Description
12 Faceplate Selection 6 Description
13 Faceplate Selection 7 Description
14 Faceplate Selection 8 Description
15 Faceplate Selection 9 Description
16 Faceplate Selection 10 Description

NEORSD_OL_PB_Single_Select.doc Page 9 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PB_Single_Select

1.5.2 Faceplates
Note: Shortcut key assignments may differ between PanelView models.

FP_PB_SINGLE_SELECT

1 2

Graphic Design Element


Number Function Description
1 Device Description Displays the dialogue description
State Select Interlocking pushbutton array allowing the operator to select one of up to ten
2
Pushbutton possible states. Pushbutton active and inactive state texts are configurable.
3 State Description Individual configurable descriptions displayed next to each selectable state.
Indication of the currently selected state. The active state displays red. All
4 State Status
non-active states display green.
5 Exit Button Pressing this button closes the faceplate display.
6 Inhibit Pushbutton Read only Inhibit which disables pushbutton selection.

1.5.3 Graphic Symbols

NEORSD_OL_PB_Single_Select.doc Page 10 of 10 Revision: 1.0.0


Title: NEORSD Standard Object Library - PID

NEORSD Standard Object Library

PID

NEORSD_OL_PID.doc Page 1 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 15-FEB-2011 PSIM All Issue for Use
1.1.0 03-MAR-2011 PSIM 1.2.1 Updated the Object Attribute list
1.2.0 16-JUN-2011 PSIM 1.0 Updated PID Instruction Summary
1.2.0 16-JUN-2011 PSIM 1.1.1 Updated Standard Control Methodology
1.2.0 16-JUN-2011 PSIM 1.1.2 Removed Support for Alarming
1.2.0 16-JUN-2011 PSIM 1.2.1 Updated Tags Accessed by WonderWare
1.2.0 16-JUN-2011 PSIM 1.3.4 Removed Extensions no longer available
1.2.0 16-JUN-2011 PSIM 1.3.5 Updated available attributes for Me.Placeholder
1.2.0 16-JUN-2011 PSIM 1.3.6 Updated faceplate graphics
1.2.0 16-JUN-2011 PSIM 1.3.7 Updated PID graphics
1.2.0 16-JUN-2011 PSIM 1.5.2 Removed OIT Faceplate (No Longer Used)
1.2.0 16-JUN-2011 PSIM 1.5.3 Updated OIT Symbols
1.2.0 16-JUN-2011 PSIM 1.6 Added example

NEORSD_OL_PID.doc Page 2 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

Table of Contents:
1.0 PID ...................................................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Control ........................................................................................................ 4
1.1.2 Alarming ..................................................................................................................... 4
1.1.3 Simulation - None ....................................................................................................... 4
1.1.4 Trouble – None ........................................................................................................... 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 7
1.3.1 Hierarchical Name - $PID.......................................................................................... 7
1.3.2 Derived from - $NEORSDUserDefined ...................................................................... 7
1.3.3 Container - None......................................................................................................... 7
1.3.4 Extensions ................................................................................................................... 7
1.3.5 Instance Configuration ............................................................................................... 8
1.3.6 Faceplates ................................................................................................................... 9
1.3.7 Graphic Symbols ....................................................................................................... 10
1.4 CONTROLLOGIX PLC..................................................................................................... 10
1.4.1 Available Languages ................................................................................................. 10
1.5 PANELVIEW OIT............................................................................................................ 11
1.5.1 Object Instance ......................................................................................................... 11
1.5.2 Faceplates ................................................................................................................. 11
1.5.3 Graphic Symbols ....................................................................................................... 12
1.6 PID CONTROLLED VALVE EXAMPLE ............................................................................. 13

NEORSD_OL_PID.doc Page 3 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.0 PID
The Rockwell PID instruction receives the process variable (PV) signal from an analog input
source within logic and modulates a control variable output (CV) in order to maintain the
process variable at the desired setpoint.
The graphical components of the object template are built to interface with the standard
Rockwell Software PID instruction. There is no custom PLC component to the object.

1.1 Object Features


The Rockwell PID function block is well documented within the Rockwell programming
software. The features listed below are those pertinent to the HMI and OIT components of
the object.

1.1.1 Standard Control


Traditional values such as set point, process value, and control mode are
displayed at the HMI. The OIT object has been simplified to provide only set
point entry.
Neither the HMI nor the OIT will provide mode control for this object. PID mode
control will be governed within the PLC logic, generally programmed to match
the mode (Auto/Manual) of the interfacing VALVE_ANALOG, MOTOR_VFD,
or similar, object.
The engineering units are displayed at the HMI, but configured in the PLC.

1.1.2 Alarming
Alarming is no longer supported in the PID HMI and OIT objects. Alarms
configured and generated in the PID instruction will not be displayed on the HMI
or OIT. Instead, alarm capabilities within the ANALOG standard object template
or similar should be utilized.

1.1.3 Simulation - None

1.1.4 Trouble – None

NEORSD_OL_PID.doc Page 4 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.2 Object Attributes


Refer to Rockwell Software Instruction Help for additional parameter details.

1.2.1 Table of Attributes & WW UDAs


INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 BIAS REAL IN feedforward or bias %
2 CA BOOL IN control action (0 for E=SP-PV; 1 for E=PV-SP)
3 CL BOOL IN cascade loop (0=no; 1=yes)
4 CT BOOL IN cascade type (0=slave; 1=master)
The .CTL member provides access to the status
5 CTL DINT OUT members (bits) in one, 32-bit word. The PID
instruction sets bits 07-15.
6 DB REAL IN deadband engineering units
7 DOE BOOL IN derivative of (0=PV; 1=error)
8 DVDB REAL IN deviation alarm deadband
9 DVN REAL IN negative deviation alarm limit
10 DVNA BOOL OUT deviation is alarmed low (0=no; 1=yes)
11 DVP REAL IN positive deviation alarm limit
12 DVPA BOOL OUT deviation is alarmed high (0=no; 1=yes)
13 EN BOOL IN Enabled
14 ERR REAL OUT scaled error value
15 EWD BOOL OUT error is within deadband (0=no; 1=yes)
16 INI BOOL OUT PID initialized (0=no; 1=yes)
independent, derivative gain (seconds). Dependent,
17 KD REAL IN
rate time (minutes).
independent, integral gain (1/sec). Dependent, reset
18 KI REAL IN
time (minutes per repeat)
independent, proportional gain (unitless). Dependent,
19 KP REAL IN
controller gain (unitless).
20 MAXCV REAL IN maximum CV value (corresponding to 100%)
21 MAXI REAL IN maximum PV value (unscaled input)
22 MAXO REAL IN maximum output limit (% of output)
AI
23 MAXS REAL IN maximum engineering unit scaling value
Float
24 MAXTIE REAL IN maximum tieback value (corresponding to 0%)
25 MINCV REAL IN minimum CV value (corresponding to 0%)
26 MINI REAL IN minimum PV value (unscaled input)
27 MINO REAL IN minimum output limit (% of output)
AI
28 MINS REAL IN minimum engineering unit scaling value
Float
29 MINTIE REAL IN minimum tieback value (corresponding to 100%)
30 MO BOOL IN DI X station mode (0=automatic; 1=manual)

NEORSD_OL_PID.doc Page 5 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
no derivative smoothing (0=derivative smoothing filter
31 NDF BOOL IN
enabled; 1=derivative smoothing filter disabled)
no bias back calculation (0=bias back calculation
32 NOBC BOOL IN
enabled; 1=bias back calculation disabled)
no zero crossing deadband (0=deadband is zero
33 NOZC BOOL IN
crossing; 1=deadband is not zero crossing)
34 OLH BOOL OUT CV is above maximum output limit (0=no; 1=yes)
35 OLL BOOL OUT CV is below minimum output limit (0=no; 1=yes)
36 OUT REAL OUT output %
37 PE BOOL IN PID equation (0=independent; 1=dependent)
AI
38 PV REAL OUT X scaled PV value
Float
39 PVDB REAL IN process variable alarm deadband
40 PVH REAL IN process variable high alarm limit
41 PVHA BOOL OUT PV is alarmed high (0=no; 1=yes)
42 PVL REAL IN process variable low alarm limit
43 PVLA BOOL OUT PV is alarmed low (0=no; 1=yes)
44 PVT BOOL IN process variable tracking (0=no; 1=yes)
45 SO REAL OUT set output %
AI/O
46 SP REAL IN X Setpoint
Float
47 SPOR BOOL OUT setpoint out of range (0=no; 1=yes)
48 SWM BOOL IN DI X software manual mode (0-no-auto; 1=yes-sw manual)
49 TIE REAL OUT tieback value for manual control
50 UPD REAL IN loop update time (seconds)

NEORSD_OL_PID.doc Page 6 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $PID

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
PV.EngUnitsMax Me.MAXS X
PV.EngUnitsMin Me.MINS X
PV.EngUnitsRangeMax Me.MAXS X
PV.EngUnitsRangeMin Me.MINS X
PV.RawMax Me.MAXS X
PV.RawMin Me.MINS X
PV.TrendHi Me.MAXS X
PV.TrendLo Me.MINS X
SP.EngUnitsMax Me.MAXS X
SP.EngUnitsMin Me.MINS X
SP.EngUnitsRangeMax Me.MAXS X
SP.EngUnitsRangeMin Me.MINS X
SP.RawMax Me.MAXS X
SP.RawMin Me.MINS X

NEORSD_OL_PID.doc Page 7 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.3.5 Instance Configuration


All of the necessary configuration the PID must also be done on any instance
derived from this template.
1) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. This template does not have any attributes available for
Me.Placeholder functionality.

NEORSD_OL_PID.doc Page 8 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.3.6 Faceplates
PID_Faceplate

1 7
2

4
8
5
3
6

Graphic Design Element


Number
Function Description
1 Tag Name Displays the object name.
2 Tabs Provides navigation to the other sections of the faceplate.
A bar-graph that provides a graphical representation of the set point and process
3 SP/PV Bar Graph
variable.
4 Set Point Displays the current value of the set point. Can be changed when in the Auto Mode.
5 Process Variable Displays the current value of the process variable.
6 Mode Displays the mode of the loop. Options include Auto, Manual, and SWMan
7 Close Button Pressing this button closes the faceplate display.
8 Engineering Units EUMax and EUMin value, read from the PLC.

NEORSD_OL_PID.doc Page 9 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.3.7 Graphic Symbols

PID_Display

1.4 ControlLogix PLC


Refer to Rockwell documentation for additional details on PID usage.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – This instruction is not available in function block.

NEORSD_OL_PID.doc Page 10 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
4 Engineering Units
5 Key Assignment (For Display Only)

1.5.2 Faceplates
No faceplates are currently configured for the PID OIT object.

NEORSD_OL_PID.doc Page 11 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.5.3 Graphic Symbols

OIT Object Animations:


Set point entry (white on black background) is enabled when the PID
instruction is in auto (not in station manual or software manual modes)
Set point indication (black on gray background) is displayed when the PID
instruction is either in station manual or software manual mode.
NOTE: Only set point display and entry is provided on the OIT. Other OIT
standard library objects must be used to display other PID elements, such as:
PV: Use ANALOG standard object to provide PV value and associated
alarms (PV hihi, hi, lo, and lolo).
CV: Displayed within VALVE_ANALOG, MOTOR_VFD, or similar, as
the auto command.
Mode: PID mode should be programmed within logic to correspond with
the mode of VALVE_ANALOG, MOTOR_VFD, or similar.

NEORSD_OL_PID.doc Page 12 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

1.6 PID Controlled Valve Example

Tank Level Control


Example

PID

VALVE_ANALOG
ANALOG

NEORSD_OL_PID.doc Page 13 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

Key Operational Concepts


PID/PIDE symbol have been simplified to show only SP (removed CV, PV & valve
symbol)
PID mode based on VALVE_ANALOG mode; no independent PIDE/PID Auto/Manual
mode
Separate ANALOG block required to display PV and associated alarms (HiHi, Hi, etc.)

Mode control only on


VALVE_ANALOG

PID/PIDE only displays


SP information

ANALOG (or ANALOG_BASIC)


to display PV

OIT: Numeric entry of SP


only; No PID/PIDE FP.

HMI: Opens faceplate; SP


available in Auto mode.

NEORSD_OL_PID.doc Page 14 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

Key Programming Concepts


Requires the 3 objects (ANALOG, VALVE_ANALOG, and PIDE/PID) described above:

ANALOG
Task: IO_Mapping (Typical)
Maps PV value from analog input card or
calculation with logic
.Ind parameter referenced by PIDE/PID
Typically no additional AOI configuration
required for PID loop programming

VALVE_ANALOG
Task: Process_Control
VALVE_ANALOG.Out mapped to analog
output card in associated mapping routine for
valve control
.Inp_AutoPositionCMD, .Auto, and .Position
typically referenced by PIDE/PID
Typically no additional AOI configuration
required for PID loop programming

PIDE/PID
Task: PID_Control
References ANALOG and
VALVE_ANALOG attributes typically
within the routine
Not directly linked to any hardwire IO
See below for standard configuration

NEORSD_OL_PID.doc Page 15 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PID

PID Configuration
The suggested PID configuration is shown below. Similar to the functions of .CVInitReq and
.CVInitValue shown for the PIDE above, the station control mode (.MO) and tieback parameters
will be used to seamlessly integrate the Auto/Manual modes of the VALVE_ANALOG AOI
block.

Links to ANALOG AOI


(ANALOG).Ind -> Process Variable

Links to VALVE_ANALOG AOI


Control Variable -> (VALVE_ANALOG).Inp_AutoPositionCMD
(VALVE_ANALOG).Position -> Tieback
No connection to SP within
On ladder rung below instruction, XIO (VALVE_ANALOG).Auto ->
program. SP mapped directly
OTE (PID).MO from graphics.

PID Key Settings:


(PID).SWM = 0
PID Setup, Configuration Tab
Loop Update Time = PID_Control Periodic Task Update Time (default = 1 sec)
PID Setup, Scaling Tab
Process Variable Unscaled Max = Engineering Unit Max = (ANALOG).EUMax
Process Variable Unscaled Min = Engineer Unit Min = (ANALOG).EUMin
Control Variable (CV) Max (at 100%) = 100
Control Variable (CV) Min (at 0%) = 0
Tieback Max (at 100%) = 100
Tieback Min (at 0%) = 0

NEORSD_OL_PID.doc Page 16 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PIDE

NEORSD Standard Object Library

PIDE

NEORSD_OL_PIDE.doc Page 1 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 15-FEB-2011 PSIM All Issue for Use
1.1.0 16-JUN-2011 PSIM 1.1.1 Updated Standard Control Methodology
1.1.0 16-JUN-2011 PSIM 1.1.2 Removed Support for Alarming
1.1.0 16-JUN-2011 PSIM 1.2.1 Updated Tags Accessed by WonderWare
1.1.0 16-JUN-2011 PSIM 1.3.4 Removed Extensions no longer available
1.1.0 16-JUN-2011 PSIM 1.3.5 Updated available attributes for Me.Placeholder
1.1.0 16-JUN-2011 PSIM 1.3.6 Updated faceplate graphics
1.1.0 16-JUN-2011 PSIM 1.3.7 Updated PID graphics
1.1.0 16-JUN-2011 PSIM 1.5.2 Removed OIT Faceplate (No Longer Used)
1.1.0 16-JUN-2011 PSIM 1.5.3 Updated OIT Symbols
1.1.0 16-JUN-2011 PSIM 1.6 Added example

NEORSD_OL_PIDE.doc Page 2 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

Table of Contents:
1.0 PIDE ................................................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Control ........................................................................................................ 4
1.1.2 Alarming ..................................................................................................................... 4
1.1.3 Tuning ......................................................................................................................... 4
1.1.4 Simulation - None ....................................................................................................... 4
1.1.5 Trouble – None ........................................................................................................... 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ...................................................................................................... 14
1.3.1 Hierarchical Name - $PIDE ..................................................................................... 14
1.3.2 Derived from - $NEORSDUserDefined .................................................................... 14
1.3.3 Container - None....................................................................................................... 14
1.3.4 Extensions ................................................................................................................. 14
1.3.5 Instance Configuration ............................................................................................. 15
1.3.6 Faceplates ................................................................................................................. 16
1.3.7 Graphic Symbols ....................................................................................................... 17
1.4 CONTROLLOGIX PLC..................................................................................................... 18
1.4.1 Available Languages ................................................................................................. 18
1.5 PANELVIEW OIT............................................................................................................ 19
1.5.1 Object Instance ......................................................................................................... 19
1.5.2 Faceplates ................................................................................................................. 19
1.5.3 Graphic Symbols ....................................................................................................... 20
1.6 PID CONTROLLED VALVE EXAMPLE ............................................................................. 21

NEORSD_OL_PIDE.doc Page 3 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.0 PIDE
The PIDE template provides enhanced capabilities over the standard PID instruction. The
PIDE uses the velocity form of the PID algorithm. The gain terms are applied to the change
in the value of error instead of the value of error.
The graphical components of the object are built to interface with the standard Rockwell
Software PIDE function block. There is no custom PLC component to the object.

1.1 Object Features


The Rockwell PIDE function block is well documented within the Rockwell programming
software. The features listed below are those pertinent to the HMI and OIT components of
the object.

1.1.1 Standard Control


Traditional values such as set point, process value, and control mode are
displayed at the HMI. The OIT object has been simplified to provide only set
point entry.
Operator limits can be entered at the HMI for limiting set point entry.
Neither the HMI nor the OIT will provide mode control for this object. PID mode
control will be governed within the PLC logic, generally programmed to match
the mode (Auto/Manual) of the interfacing VALVE_ANALOG, MOTOR_VFD,
or similar, object.
The engineering units are displayed at the HMI, but configured in the PLC.

1.1.2 Alarming
Alarming is no longer supported in the PIDE HMI and OIT objects. Alarms
configured and generated in the PIDE instruction will not be displayed on the
HMI or OIT. Instead, alarm capabilities within the ANALOG standard object
template or similar should be utilized.

1.1.3 Tuning
All PID loop tuning is performed in the PLC.

1.1.4 Simulation - None

1.1.5 Trouble – None

NEORSD_OL_PIDE.doc Page 4 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Allow cascade/ratio mode permissive. Set to allow
1 AllowCasRat BOOL IN Cascade/Ratio mode to be selected using either
ProgCascadeRatioReq or OperCascadeRatioReq.
2 Auto BOOL OUT DI X Auto mode indicator. Set when in the Auto mode.
Cascade/ratio mode indicator. Set when in the
3 CasRat BOOL OUT DI X
Cascade/Ratio mode.
Control action request. Set to calculate error as E = PV
4 ControlAction BOOL IN
- SP; clear to calculate error as E = SP - PV.
Control variable output. This value is expressed as 0 to
100 percent. CV is limited by CVHLimit and CVLLimit
when in auto or cascade/ratio mode or manual mode if
5 CV REAL OUT
CVManLimiting is set. Otherwise this value is limited by
0 and 100 percent. Arithmetic flags are set for this
output.
Scaled control variable output. Scaled using CVEUMax
and CVEUMin, where CVEUMax corresponds to 100
6 CVEU REAL OUT percent and CVEUMin corresponds to 0 percent. This
output typically controls an analog output module or a
secondary loop. Arithmetic flags are set for this output.
Maximum value for CVEU. The value of CVEU which
corresponds to 100 percent CV. If CVEUMax =
7 CVEUMax REAL IN
CVEUMin, the instruction sets the appropriate bit in
Status.
Minimum value of CVEU. The value of CVEU which
corresponds to 0 percent CV. If CVEUMax =
8 CVEUMin REAL IN
CVEUMin, the instruction sets the appropriate bit in
Status.
9 CVEUSpanInv BOOL OUT Invalid CVEU span. The instruction uses a value of
Control variable bad health indicator. If CVEU controls
an analog output, then CVFault normally comes from
10 CVFault BOOL IN the analog output’s fault status. When set, CVFault
indicates an error on the output module and the
instruction sets the appropriate bit in Status.
11 CVFaulted BOOL OUT Control variable (CV) health bad.
CV high alarm indicator. Set when the calculated value
12 CVHAlarm BOOL OUT
of
CV high limit value. This is used to set the CVHAlarm
output. It is also used for limiting CV when in Auto or
Cascade/Ratio mode, or Manual mode if
13 CVHLimit REAL IN CVManLimiting is set. If CVHLimit > 100 or < CVLLimit,
the instruction sets the appropriate bit in Status. If
CVHLimit < CVLLimit, the instruction limits CV using
the value of CVLLimit.
Initialization mode indicator. CVInitializing is set when
CVInitReq is set, during instruction first scan, and on a
14 CVInitializing BOOL OUT DI X set to cleared transition of CVHealth (bad to good).
CVInitializing is cleared after the instruction has been
initialized and CVInitReq is cleared.
CV initialization request. This signal is normally
controlled by the "In Hold" status on the analog output
15 CVInitReq BOOL IN
module controlled by CVEU or from the InitPrimary
output of a secondary PID loop.

NEORSD_OL_PIDE.doc Page 5 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
CVEU initialization value, scaled in CVEU units. When
CVInitializing is set, CVEU = CVInitValue and CV
equals the corresponding percentage value.
16 CVInitValue REAL IN CVInitValue comes from the feedback of the analog
output controlled by CVEU or from the setpoint of a
secondary loop. Instruction initialization is disabled
when CVFaulted or CVEUSpanInv is set.
CV low alarm indicator. Set when the calculated value
17 CVLAlarm BOOL OUT
of
CVLLimit < 0, CVHLimit > 100, or CVHLimit <
18 CVLimitsInv BOOL OUT CVLLimit. If CVHLimit < CVLLimit, the instruction limits
CV using CVLLimit.
CV low limit value. This is used to set the CVLAlarm
output. It is also used for limiting CV when in Auto or
Cascade/Ratio mode, or Manual mode if
19 CVLLimit REAL IN CVManLimiting is set. If CVLLimit < 0 or CVHLimit <
CVLLimit, the instruction sets the appropriate bit in
Status. If CVHLimit < CVLLimit, the instruction limits
CV using the value of CVLLimit.
Limit CV in manual mode request. If Manual mode and
20 CVManLimiting BOOL IN CVManLimiting is set, CV is limited by the CVHLimit
and CVLLimit values.
CV operator manual value. CV equals this value when
in Operator Manual mode. If not Operator Manual
mode, the instruction sets CVOper = CV at the end of
21 CVOper REAL IN each instruction execution. If CVOper < 0 or > 100, or
< CVLLimit or > CVHLimit when CVManLimiting is set,
the instruction sets the appropriate bit in Status and
limits the CV value.
CVOper < 0 or CVOper > 100, or CVOper < CVLLimit
22 CVOperInv BOOL OUT or CVOper > CVHLimit when CVManLimiting is set.
The instruction limits the value for CV.
CV override value. CV equals this value when in
override mode. This value should correspond to a safe
23 CVOverride REAL IN state output of the PID loop. If CVOverride < 0 or >100,
the instruction sets the appropriate bit in Status and
limits the CV value.
CVOverride < 0 or CVOverride > 100. The instruction
24 CVOverrideInv BOOL OUT
limits the value for CV.
CV(n-1) value. If CVSetPrevious is set, CV(n-1) equals
this value. CV(n-1) equals the CV from the previous
25 CVPrevious REAL IN
execution. CVPrevious is ignored when in manual,
override or hand mode or when CVInitializing is set.
CVPrevious < 0 or CVPrevious > 100, or < CVLLimit or
26 CVPreviousInv BOOL OUT > CVHLimit when in auto or cascade/ration mode. The
instruction uses the limited value for CV(n-1)
CV program manual value. CV equals this value when
in Program Manual mode. If CVProg < 0 or > 100, or <
27 CVProg REAL IN CVLLimit or > CVHLimit when CVManLimiting is set,
the instruction sets the appropriate bit in Status and
limits the CV value.
CVProg < 0 or CVProg > 100, or CVProg < CVLLimit
28 CVProgInv BOOL OUT or CVProg > CVHLimit when CVManLimiting is set.
The instruction limits the value for CV.
CV rate of change alarm indicator. Set when the
29 CVROCAlarm BOOL OUT calculated rate of change for CV exceeds
CVROCLimit.

NEORSD_OL_PIDE.doc Page 6 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
CV rate of change limit, in percent per second. Rate of
change limiting is only used when in Auto or
Cascade/Ratio modes or Manual mode if
30 CVROCLimit REAL IN
CVManLimiting is set. Enter 0 to disable CV ROC
limiting. If CVROCLimit < 0, the instruction sets the
appropriate bit in Status and disables CV ROC limiting.
CVROCLimit < 0. The instruction disables ROC
31 CVROCLimitInv BOOL OUT
limiting.
Request to use CVPrevious. If set, CV(n-1) =
32 CVSetPrevious BOOL IN
CVPrevious. Default is cleared.
Elapsed time between updates. This is the elapsed
33 DeltaT REAL OUT time in seconds used by the control algorithm to
calculate the process output.
34 DeltaTInv BOOL OUT Invalid DeltaT value.
Dependent/independent control request. When set, use
35 DependIndepend BOOL IN the dependent form of the PID equation; when cleared,
use the independent form of the equations.
The deadband value for the Deviation alarm limits,
scaled in PV units. Deadband is the delta value
between the turn-on and turn-off value for each of the
36 DevDeadband REAL IN
Deviation alarm limits. If DevDeadband < 0.0, the
instruction sets the appropriate bit in Status and sets
DevDeadband = 0.0.
Deviation deadband < 0. The instruction uses a value
37 DevDeadbandInv BOOL OUT
of DevDeadband = 0.
38 DevHAlarm BOOL OUT Deviation high alarm indicator. Set when
39 DevHHAlarm BOOL OUT Deviation high-high alarm indicator. Set when
Deviation high-high alarm limit value, scaled in PV
units. Deviation is the difference in value between the
process variable (PV) and the setpoint (SP). Deviation
40 DevHHLimit REAL IN alarming alerts the operator to a discrepancy between
the process variable and the setpoint value. If
DevHHLimit < 0.0, the instruction sets the appropriate
bits in Status and sets DevHHLimit = 0.0.
Deviation high alarm limit value, scaled in PV units.
Deviation is the difference in value between the
process variable (PV) and the setpoint (SP). Deviation
41 DevHLimit REAL IN alarming alerts the operator to a discrepancy between
the process variable and the setpoint value. If
DevHLimit < 0.0, the instruction sets the appropriate bit
in Status and sets DevHLimit = 0.0.
42 DevHLLimitsInv BOOL OUT Deviation high-low limits invalid. Low-low limit < 0,
43 DevLAlarm BOOL OUT Deviation low alarm indicator. Set when
44 DevLLAlarm BOOL OUT Deviation low-low alarm indicator. Set when
Deviation low alarm limit value, scaled in PV units.
Deviation is the difference in value between the
process variable (PV) and the setpoint (SP). Deviation
45 DevLLimit REAL IN alarming alerts the operator to a discrepancy between
the process variable and the setpoint value. If
DevLLimit < 0.0, the instruction sets the appropriate bit
in Status and sets DevLLimit = 0.0.

NEORSD_OL_PIDE.doc Page 7 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Deviation low-low alarm limit value, scaled in PV units.
Deviation is the difference in value between the
process variable (PV) and the setpoint (SP). Deviation
46 DevLLLimit REAL IN alarming alerts the operator to a discrepancy between
the process variable and the setpoint value. If
DevLLLimit < 0.0, the instruction sets the appropriate
bit in Status and sets DevLLLimit = 0.0.
Derivative gain. When the independent form of the PID
algorithm is selected, enter the derivative gain in units
of minutes into this value. When the dependent PID
algorithm is used, enter the derivative time constant in
47 DGain REAL IN
units of minutes into this value. Enter 0 to disable the
derivative control. If DGain < 0, the instruction sets the
appropriate bit in Status and uses a value of DGain =
0.
48 DGainInv BOOL OUT DGain < 0. The instruction uses a value of DGain = 0.
Derivative Smoothing request. When set, changes in
the derivative term are smoothed. Derivative smoothing
49 DSmoothing BOOL IN causes less output "jitters" as a result of a noisy PV
signal but also limits the effectiveness of high
derivative gains.
Process error. Difference between SP and PV, scaled
50 E REAL OUT
in PV units.
Function Block: Enable input. If cleared, the instruction
51 EnableIn BOOL IN does not execute and outputs are not updated.
Structured Text: No effect. The instruction executes.
52 EnableOut BOOL OUT Enable output.
53 EPercent REAL OUT The error expressed as a percent of span.
Feed forward value. The value of feed forward is
summed with CV after the zero-crossing deadband
limiting has been applied to CV. Therefore changes in
54 FF REAL IN FF are always reflected in the final output value of CV.
If FF < -100 or > 100, the instruction sets the
appropriate bit in Status and limits the value used for
FF.
FF < -100 or FF > 100. The instruction uses the limited
55 FFInv BOOL OUT
value for FF.
56 FFPrevious REAL IN
57 FFPreviousInv BOOL OUT
58 FFSetPrevious BOOL IN
59 Hand BOOL OUT Hand mode indicator. Set when in the Hand mode.
CV Hand feedback value. CV equals this value when in
Hand mode and HandFBFault is cleared (good health).
This value typically comes from the output of a field
60 HandFB REAL IN mounted hand/ auto station and is used to generate a
bumpless transfer out of hand mode. If HandFB < 0 or
> 100, the instruction sets the appropriate bit in Status
and limits the value used for CV.
HandFB value bad health indicator. If the HandFB
value is read from an analog input, then HandFBFault
is typically controlled by the status of the analog input
61 HandFBFault BOOL IN
channel. When set, HandFBFault indicates an error on
the input module and the instruction sets the
appropriate bit in Status.
62 HandFBFaulted BOOL OUT HandFB value health bad.

NEORSD_OL_PIDE.doc Page 8 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
HandFB < 0 or HandFB > 100. The instruction uses the
63 HandFBInv BOOL OUT
limited value for CV.
Integral gain. When the independent form of the PID
algorithm is selected, enter the integral gain in units of
1/minutes into this value. When the dependent PID
algorithm is selected, enter the integral time constant in
64 IGain REAL IN
units of minutes/repeat into this value. Enter 0 to
disable the integral control. If IGain < 0, the instruction
sets the appropriate bit in Status and uses a value of
IGain = 0.
65 IGainInv BOOL OUT IGain < 0. The instruction uses a value of IGain = 0.
Initialize primary loop command. Set when not in
Cascade/Ratio mode or when CVInitializing is set. This
66 InitPrimary BOOL OUT
signal is normally used by the CVInitReq input of a
primary PID loop.
The instruction detected one of the following execution
errors. This is not a minor or major controller error.
67 InstructFault BOOL OUT
Check the remaining status bits to determine what
occurred.
68 Manual BOOL OUT DI X Manual mode indicator. Set when in the Manual mode.
Manual mode after initialization request. When set, the
instruction is placed in Manual mode when
CVInitializing is set, unless the current mode is
69 ManualAfterInit BOOL IN
Override or Hand. When ManualAfterInit is cleared, the
instruction’s mode is not changed, unless requested to
do so.
Operator auto mode request. Set by the operator
70 OperAutoReq BOOL IN interface to request Auto mode. The instruction clears
the input each execution.
Operator cascade/ratio mode request. Set by the
71 OperCasRatReq BOOL IN operator interface to request Cascade/ Ratio mode.
The instruction clears this input each execution.
Operator manual mode request. Set by the operator
72 OperManualReq BOOL IN interface to request Manual mode. The instruction
clears the input each execution.
Operator operator request. Set by the operator
73 OperOperReq BOOL IN interface to request Operator control. The instruction
clears this input each execution.
Operator program request. Set by the operator
74 OperProgReq BOOL IN interface to request Program control. The instruction
clears this input each execution.
Override mode indicator. Set when in the Override
75 Override BOOL OUT DI X
mode.
76 OversampleDT REAL IN Execution time for oversample mode.
Proportional gain. When the independent form of the
PID algorithm is selected, enter the unitless
proportional gain into this value. When the dependent
PID algorithm is selected, enter the unitless controller
77 PGain REAL IN
gain into this value. Enter 0 to disable the proportional
control. If PGain < 0, the instruction sets the
appropriate bit in Status and uses of value of PGain =
0.
78 PGainInv BOOL OUT PGain < 0. The instruction uses a value of PGain = 0.
Program auto mode request. Set by the user program
79 ProgAutoReq BOOL IN to request Auto mode. When ProgValueReset is set,
the instruction clears the input each execution.

NEORSD_OL_PIDE.doc Page 9 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Program cascade/ratio mode request. Set by the user
program to request Cascade/Ratio mode. When
80 ProgCasRatReq BOOL IN
ProgValueReset is set, the instruction clears the input
each execution.
Program hand mode request. Set by the user program
to request Hand mode. This value is usually read as a
81 ProgHandReq BOOL IN digital input from a hand/auto station. When
ProgValueReset is set, the instruction clears the input
each execution.
Program manual mode request. Set by the user
program to request Manual mode. When
82 ProgManualReq BOOL IN
ProgValueReset is set, the instruction clears the input
each execution.
Program/operator control indicator. Set when in
83 ProgOper BOOL OUT
Program control. Cleared when in Operator control.
Program operator request. Set by the user program to
request Operator control. Holding this set locks the
84 ProgOperReq BOOL IN
instruction in Operator control. When ProgValueReset
is set, the instruction clears the input each execution.
Program override mode request. Set by the user
program to request Override mode. When
85 ProgOverrideReq BOOL IN
ProgValueReset is set, the instruction clears the input
each execution.
Program program request. Set by the user program to
request Program control. Ignored if ProgOperReq is
set. Holding this set and ProgOperReq cleared locks
86 ProgProgReq BOOL IN
the instruction in Program control. When
ProgValueReset is set, the instruction clears the input
each execution.
Reset program control values. When set, all the
program request inputs are cleared by the instruction
87 ProgValueReset BOOL IN each execution. When set and in Operator control, the
instruction sets SPProgram = SP and CVProgram =
CV.
Scaled process variable input. This value is typically
88 PV REAL IN AI X
read from an analog input module.
PV alarm limit deadband value, scaled in PV units.
Deadband is the delta value between the turn-on and
89 PVDeadband REAL IN turn-off value for each of the PV alarm limits. If
PVDeadband < 0.0, the instruction sets the appropriate
bit in Status and limits PVDeadband to zero.
90 PVDeadbandInv BOOL OUT PVDeadband < 0.
Derivative PV control request. When set, calculate the
derivative term (DeltaDTerm) using the change in
91 PVEDerivative BOOL IN
process variable (PVPercent). When cleared, use the
change in error (EPercent).
Proportional PV control request. When set, calculate
the proportional term (DeltaPTerm) using the change in
92 PVEProportional BOOL IN
process variable (PVPercent). When cleared, use the
change in error (EPercent).
Maximum scaled value for PV. The value of PV and SP
93 PVEUMax REAL IN AI X which corresponds to 100 percent span of the Process
Variable.
Minimum scaled value for PV. The value of PV and SP
94 PVEUMin REAL IN AI X which corresponds to 0 percent span of the Process
Variable.

NEORSD_OL_PIDE.doc Page 10 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
PV bad health indicator. If PV is read from an analog
input, then PVFault is normally controlled by the analog
95 PVFault BOOL IN
input fault status. When PVFault is set, it indicates the
input signal has an error.
96 PVFaulted BOOL OUT DI X Process variable (PV) health bad.
PV high alarm indicator. Set when PV ³ PVHLimit.
97 PVHAlarm BOOL OUT
Cleared when PV < (PVHLimit - PVDeadband)
PV high-high alarm indicator. Set when PV ³
98 PVHHAlarm BOOL OUT PVHHLimit. Cleared when PV < (PVHHLimit -
PVDeadband)
99 PVHHLimit REAL IN PV high-high alarm limit value, scaled in PV units.
100 PVHLimit REAL IN PV high alarm limit value, scaled in PV units.
PV low alarm indicator. Set when PV £ PVLLimit.
101 PVLAlarm BOOL OUT
Cleared when PV > (PVLLimit + PVDeadband)
PV low-low alarm indicator. Set when PV £ PVLLLimit.
102 PVLLAlarm BOOL OUT
Cleared when PV > (PVLLLimit + PVDeadband)
103 PVLLimit REAL IN PV low alarm limit value, scaled in PV units.
104 PVLLLimit REAL IN PV low-low alarm limit value, scaled in PV units.
105 PVPercent REAL OUT PV expressed in percent of span.
PVROCPosLimit < 0, PVROCNegLimit < 0, or
106 PVROCLimitsInv BOOL OUT
PVROCPeriod < 0.
PV negative rate-of-change alarm indicator. Set when
107 PVROCNegAlarm BOOL OUT
calculated PV rate-of-change £ (PVROCNegLimit x -1).
PV negative rate of change alarm limit. The limit value
for a negative (decreasing) change in PV, scaled in PV
units per seconds. Enter 0.0 to disable negative
108 PVROCNegLimit REAL IN
PVROC alarm checking. If PVROCNegLimit < 0, the
instruction sets the appropriate bit in Status and
disables negative PVROC checking.
PV rate of change sample period. The time period, in
seconds, over which the rate of change for PV is
evaluated. Enter 0 to disable PVROC alarm checking If
109 PVROCPeriod REAL IN
PVROCPeriod < 0.0, the instruction sets the
appropriate bit in Status, and disables positive and
negative PVROC checking.
PV positive rate-of-change alarm indicator. Set when
110 PVROCPosAlarm BOOL OUT
calculated PV rate-of-change ³ PVROCPosLimit.
PV positive rate of change alarm limit. The limit value
for a positive (increasing) change in PV, scaled in PV
units per seconds. Enter 0.0 to disable positive PVROC
111 PVROCPosLimit REAL IN
alarm checking. If PVROCPosLimit < 0.0, the
instruction sets the appropriate bit in Status and
disables PVROC checking.
112 PVSpanInv BOOL OUT Invalid span of PV. PVEUMax £ PVEUMin.
SP track PV request. Set to cause SP to track PV
113 PVTracking BOOL IN when in manual mode. Ignored when in Cascade/Ratio
or Auto mode.
114 Ratio REAL OUT Current ratio multiplier.
Ratio high alarm indicator. Set when Ratio >
115 RatioHAlarm BOOL OUT
RatioHLimit.
Ratio high limit value. Limits the value of Ratio
obtained from RatioProg or RatioOper. If RatioHLimit <
116 RatioHLimit REAL IN
RatioLLimit, the instruction sets the appropriate bit in
Status and limits Ratio using the value of RatioLLimit.

NEORSD_OL_PIDE.doc Page 11 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Ratio low alarm indicator. Set when Ratio <
117 RatioLAlarm BOOL OUT
RatioLLimit.
118 RatioLimitsInv BOOL OUT Low limit < 0 or High limit < low limit.
Ratio low limit value. Limits the value of Ratio obtained
from RatioProg or RatioOper. If RatioLLimit < 0, the
instruction sets the appropriate bit in Status and limits
119 RatioLLimit REAL IN
the value to zero. If RatioHLimit < RatioLLimit, the
instruction sets the appropriate bit in Status and limits
Ratio using the value of RatioLLimit.
Ratio operator multiplier. Ratio is set equal to this value
when in Operator control. If RatioOper < RatioLLimit or
120 RatioOper REAL IN
> RatioHLimit, the instruction sets the appropriate bit in
Status and limits the value used for Ratio.
RatioOper < RatioLLimit or RatioOper > RatioHLimit.
121 RatioOperInv BOOL OUT
The instruction limits the value for Ratio.
Ratio program multiplier. Ratio and RatioOper are set
equal to this value when in Program control. If
122 RatioProg REAL IN RatioProg < RatioLLimit or > RatioHLimit, the
instruction sets the appropriate bit in Status and limits
the value used for Ratio.
RatioProg < RatioLLimit or RatioProg > RatioHLimit.
123 RatioProgInv BOOL OUT
The instruction limits the value for Ratio.
124 RTSMissed BOOL OUT Only used in real time sampling mode. Set when
125 RTSTime DINT IN Module update period for real time sampling mode
126 RTSTimeInv BOOL OUT Invalid RTSTime value.
127 RTSTimeStamp DINT IN Module time stamp value for real time sampling mode.
RTSTimeStampIn
128 BOOL OUT Invalid RTSTimeStamp value.
v
Current setpoint value. The value of SP is used to
129 SP REAL OUT AI X
control CV when in Auto or Cascade/ Ratio mode.
SP Cascade value, scaled in PV units. If CascadeRatio
is set and UseRatio is cleared, then SP = SPCascade.
This is typically the CVEU of a primary loop. If
130 SPCascade REAL IN CascadeRatio and UseRatio are set, then SP =
(SPCascade x Ratio). If the value of SPCascade <
SPLLimit or > SPHLimit, set the appropriate bit in
Status and limit the value used for SP.
SPCascade < SPLLimit or SPCascade > SPHLimit.
131 SPCascadeInv BOOL OUT
The instruction uses the limited value for SP.
132 SPHAlarm BOOL OUT SP high alarm indicator.
SP high limit value, scaled in PV units. If SPHLimit >
AI/O
133 SPHLimit REAL IN
Float
X PVEUMax, the instruction sets the appropriate bit in
Status.
134 SPLAlarm BOOL OUT SP low alarm indicator.
Limits invalid: SPLLimit < PVEUMin, SPHLimit >
PVEUMax, or SPHLimit < SPLLimit. If SPHLimit <
135 SPLimitsInv BOOL OUT
SPLLimit, the instruction limits the value using
SPLLimit
SP low limit value, scaled in PV units. If SPLLimit <
PVEUMin, the instruction sets the appropriate bit in
AI/O
136 SPLLimit REAL IN
Float
X Status. If SPHLimit < SPLLimit, the instruction sets the
appropriate bit in Status and limits SP using the value
of SPLLimit.

NEORSD_OL_PIDE.doc Page 12 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

INS Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
SP operator value, scaled in PV units. SP is set to this
value when in Operator control and not Cascade/Ratio
AO
137 SPOper REAL IN
Float
X mode. If the value of SPOper < SPLLimit or >
SPHLimit, the instruction sets the appropriate bit in
Status and limits the value used for SP.
SPOper < SPLLimit or SPOper > SPHLimit. The
138 SPOperInv BOOL OUT
instruction uses the limited value for SP.
139 SPPercent REAL OUT The value of SP expressed in percent of span of PV.
SP program value, scaled in PV units. SP is set to this
value when in Program control and not Cascade/Ratio
140 SPProg REAL IN mode. If the value of SPProg < SPLLimit or >
SPHLimit, the instruction sets the appropriate bit in
Status and limits the value used for SP.
SPProg < SPLLimit or SPProg > SPHLimit. The
141 SPProgInv BOOL OUT
instruction uses the limited value for SP.
142 Status1 DINT OUT Status of the function block.
143 Status2 DINT OUT Timing status of the function block.
144 TimingMode DINT IN Selects timing execution mode.
145 TimingModeInv BOOL OUT Invalid TimingMode value.
Allow ratio control permissive. Set to enable ratio
146 UseRatio BOOL IN
control when in Cascade/Ratio mode.
Windup high request. When set, the CV cannot
integrate in a positive direction. The signal is typically
147 WindupHIn BOOL IN
obtained from the WindupHOut output from a
secondary loop.
Windup high indicator. Set when either a SP high, CV
high, or CV low limit (depending on the control action)
148 WindupHOut BOOL OUT has been reached. This signal is typically used by the
WindupHIn input to prevent the windup of the CV
output on a primary loop.
Windup low request. When set, the cannot integrate in
149 WindupLIn BOOL IN a negative direction. This signal is typically obtained
from the WindupLOut output from a secondary loop.
Windup low indicator. Set when either a SP, CV high,
or CV low limit (depending on the control action) has
150 WindupLOut BOOL OUT been reached. This signal is typically used by the
WindupLIn input to prevent the windup of the CV
output on a primary loop.
Zero crossing deadband range, scaled in PV units.
Defines the zero crossing deadband range. Enter 0 to
disable the zero crossing deadband checking. If
151 ZCDeadband REAL IN
ZCDeadband < 0, the instruction sets the appropriate
bit in Status and disables zero crossing deadband
checking.
ZCDeadband < 0. The instruction disables zero
152 ZCDeadbandInv BOOL OUT
crossing deadband.
Zero crossing deadband indicator. When set the value
of CV does not change. If ZCOff is set, then
ZCDeadbandOn is set when | E | is within the
ZCDeadband range. If ZCOff is cleared, then
153 ZCDeadbandOn BOOL OUT
ZCDeadbandOn is set when | E | crosses zero and
remains within the ZCDeadband range.
ZCDeadbandOn is cleared when | E | exceeds the
deadband range or when ZCDeadband = 0.
Zero crossing disable request. Set to disable zero
154 ZCOff BOOL IN
crossing for the deadband calculation.

NEORSD_OL_PIDE.doc Page 13 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $PIDE

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
PV.EngUnitsMax Me.PVEUMax X
PV.EngUnitsMin Me.PVEUMin X
PV.EngUnitsRangeMax Me.PVEUMax X
PV.EngUnitsRangeMin Me.PVEUMin X
PV.RawMax Me.PVEUMax X
PV.RawMin Me.PVEUMin X
PV.TrendHi Me.PVEUMax X
PV.TrendLo Me.PVEUMin X
SP.EngUnitsMax Me.PVEUMax X
SP.EngUnitsMin Me.PVEUMin X
SP.EngUnitsRangeMax Me.PVEUMax X
SP.EngUnitsRangeMin Me.PVEUMin X
SP.RawMax Me.PVEUMax X
SP.RawMin Me.PVEUMin X
SPHLimit.EngUnitsMax Me.PVEUMax X
SPHLimit.EngUnitsMin Me.PVEUMin X
SPHLimit.EngUnitsRangeMax Me.PVEUMax X
SPHLimit.EngUnitsRangeMin Me.PVEUMin X
SPHLimit.RawMax Me.PVEUMax X
SPHLimit.RawMin Me.PVEUMin X
SPLLimit.EngUnitsMax Me.PVEUMax X
SPLLimit.EngUnitsMin Me.PVEUMin X
SPLLimit.EngUnitsRangeMax Me.PVEUMax X
SPLLimit.EngUnitsRangeMin Me.PVEUMin X
SPLLimit.RawMax Me.PVEUMax X
SPLLimit.RawMin Me.PVEUMin X
SPOper.EngUnitsMax Me.SPHLimit X
SPOper.EngUnitsMin Me.SPLLImit X
SPOper.EngUnitsRangeMax Me.SPHLimit X
SPOper.EngUnitsRangeMin Me.SPLLImit X
SPOper.RawMax Me.SPHLimit X
SPOper.RawMin Me.SPLLImit X

NEORSD_OL_PIDE.doc Page 14 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.3.5 Instance Configuration


All of the necessary configuration for the PIDE must also be done on any instance
derived from this template.
1) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. This template does not have any attributes available for
Me.Placeholder functionality.

NEORSD_OL_PIDE.doc Page 15 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.3.6 Faceplates
PIDE_Faceplate

1 7
2

4
3 8
5
6
9

10

Graphic Design Element


Number
Function Description
1 Tag Name Displays the object name.
2 Tabs Provides navigation to the other sections of the faceplate.
A bar-graph that provides a graphical representation of the set point and process
3 SP/PV Bar Graph
variable.
4 Set Point Displays the current value of the set point.
5 Process Variable Displays the current value of the process variable.
Displays the mode of the loop. Options include Auto, Manual, CASRAT, CVInitializing,
6 Mode
and Override
7 Close Button Pressing this button closes the faceplate display.
8 Engineering Units Displays the EUMax and EUMin entered in the PLC.
Limits the value that can be entered by the operator. The entry box is only selectable
when the logged in user has the proper control level access. If not logged in with the
9 Set Point High Limit proper control level the entry box will be grey; instead of white. The value is displayed to
the right of the text regardless of control level access. Pressing the SPH entry box will
allow the user to set the set point low high value.

NEORSD_OL_PIDE.doc Page 16 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

Graphic Design Element


Number
Function Description
Limits the value that can be entered by the operator. The entry box is only selectable
when the logged in user has the proper control level access. If not logged in with the
10 Set Point Low Limit proper control level the entry box will be grey; instead of white. The value is displayed to
the right of the text regardless of control level access. Pressing the SPL entry box will
allow the user to set the set point low high value.

1.3.7 Graphic Symbols

PIDE_Display

NEORSD_OL_PIDE.doc Page 17 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.4 ControlLogix PLC


Refer to Rockwell documentation for additional details on PIDE usage

1.4.1 Available Languages

1. Relay Ladder – This instruction is not available in ladder diagram logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_PIDE.doc Page 18 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
4 Engineering Units
5 Key Assignment (For Display Only)

1.5.2 Faceplates
No faceplates are currently configured for the PIDE OIT object.

NEORSD_OL_PIDE.doc Page 19 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.5.3 Graphic Symbols

OIT Object Animations:


Set point entry (white on black background) is enabled when the PIDE
instruction is in auto and CVInitializing is not set (not in hand, manual, or
override modes)
Set point indication (black on gray background) is displayed when the
PIDE instruction is either in not in auto mode or CVInitializing is set.
NOTE: Only set point display and entry is provided on the OIT. Other OIT
standard library objects must be used to display other PIDE elements, such as:
PV: Use ANALOG standard object to provide PV value and associated
alarms (PV hihi, hi, lo, and lolo).
CV: Displayed within VALVE_ANALOG, MOTOR_VFD, or similar, as
the auto command.
Mode: PIDE mode should be programmed within logic to correspond with
the mode of VALVE_ANALOG, MOTOR_VFD, or similar.

NEORSD_OL_PIDE.doc Page 20 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

1.6 PID Controlled Valve Example


Typical PID valve control utilizes 3 standard objects:
ANALOG (or ANALOG_BASIC)
VALVE_ANALOG
PIDE (or PID)

Tank Level Control


Example

PID
E

VALVE_ANAL
OG ANALOG

NEORSD_OL_PIDE.doc Page 21 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

Key Operational Concepts


PID mode based on VALVE_ANALOG mode; no independent PIDE/PID Auto/Manual
mode
Separate ANALOG block required to display PV and associated alarms (HiHi, Hi, etc.)

Mode control only on


VALVE_ANALOG

PID/PIDE only displays


SP information

ANALOG (or
ANALOG_BASIC) to display
PV

OIT: Numeric entry of SP HMI: Opens faceplate; SP


only; No PID/PIDE FP. available in Auto mode.

NEORSD_OL_PIDE.doc Page 22 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

Key Programming Concepts


Requires the 3 objects (ANALOG, VALVE_ANALOG, and PIDE/PID) described above:

ANALOG
Task: IO_Mapping (Typical)
Maps PV value from analog input card or
calculation with logic
.Ind parameter referenced by PIDE/PID
Typically no additional AOI configuration
required for PID loop programming

VALVE_ANALOG
Task: Process_Control
VALVE_ANALOG.Out mapped to analog
output card in associated mapping routine for
valve control
.Inp_AutoPositionCMD, .Auto, and .Position
typically referenced by PIDE/PID
Typically no additional AOI configuration
required for PID loop programming

PIDE/PID
Task: PID_Control
References ANALOG and
VALVE_ANALOG attributes typically
within the routine
Not directly linked to any hardwire IO
See below for standard configuration

NEORSD_OL_PIDE.doc Page 23 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PIDE

PIDE Configuration
There are many available methods to configure the PIDE instruction. The suggested
configuration is shown below. Note: All suggeseted configurations are provided to ease the
implementation of the library objects. It is still the responsibliity of the integrator to test and
verify the functionality of every control loop.

Links to ANALOG AOI No connection to SP within program. SP


(ANALOG).Ind -> (PIDE).PV mapped directly from graphics.

Links to VALVE_ANALOG AOI


(VALVE_ANALOG).Auto -> BNOT -
>(PIDE).CVInitReq
(VALVE_ANALOG).Position ->
PIDE Key Settings:
(PIDE).CVInitValue
(PIDE).OperOperReq = 1
(PIDE).CVEU ->
(PIDE).OperAutoReq = 1
(VALVE_ANALOG).Inp_AutoPositionCMD
(PIDE).CVEUMax = 100
(PIDE).CVEUMin = 0
(PIDE).PVEUMAX and (PIDE).PVEUMIN should match (ANALOG_AOI).EUMax and
(ANALOG_AOI).EUMin
(PIDE).CVHLimit and (PIDE).CVLLimit should match
(ANALOG_AOI).Cfg_MinPositionCommand
and (ANALOG_AOI).Cfg_CfgMaxPositionCommand

NEORSD_OL_PIDE.doc Page 24 of 24 Revision: 1.1.0


Title: NEORSD Standard Object Library - PLC Status

NEORSD Standard Object Library

PLC Status

NEORSD_OL_PLC_Status.doc Page 1 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Feb-2011 PSIM All Issue for Use.
1.1.0 03-Mar-2011 PSIM 1.2.1 Updated attribute Seconds in the Object Attribute list.
Added new attributes Sts_Red_KeyswitchAlarm,
1.2.0 06-Apr-2011 PSIM 1.2.1 Sts_Red_PartnerKeyswitch, Sts_Red_PartnerMinorFaults,
and Sts_Red_PartnerMode to the Object Attribute list.

1.2.0 06-Apr-2011 PSIM 1.5.2 Updated OIT faceplate objects

NEORSD_OL_PLC_Status.doc Page 2 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

Table of Contents:
1.0  PLC STATUS .................................................................................................................... 4 
1.1  OBJECT FEATURES ........................................................................................................... 4 
1.1.1  Indications................................................................................................................... 4 
1.1.2  Simulation ................................................................................................................... 4 
1.2  OBJECT ATTRIBUTES........................................................................................................ 5 
1.2.1  Table of Attributes & WW UDAs ................................................................................ 5 
1.3  WONDERWARE HMI ........................................................................................................ 7 
1.3.1  Hierarchical Name - $PLC_Status ............................................................................. 7 
1.3.2  Derived from - $NEORSDUserDefined ...................................................................... 7 
1.3.3  Container - None......................................................................................................... 7 
1.3.4  Extensions ................................................................................................................... 7 
1.3.5  Instance Configuration - None.................................................................................... 7 
1.3.6  Faceplates ................................................................................................................... 8 
1.3.7  Graphic Symbols ......................................................................................................... 9 
1.4  CONTROLLOGIX PLC..................................................................................................... 10 
1.4.1  Available Languages................................................................................................. 10 
1.5  PANELVIEW OIT............................................................................................................ 11 
1.5.1  Object Instance ......................................................................................................... 11 
1.5.2  Faceplates ................................................................................................................. 12 
1.5.3  Graphic Symbols ....................................................................................................... 16 

NEORSD_OL_PLC_Status.doc Page 3 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.0 PLC Status


The PLC_Status object template monitors the health of the PLC and provides status information
to the HMI/OIT for diagnostics and troubleshooting purposes. The status information includes
Major and Minor Fault indications, Connection Fault status, Force status, etc.

1.1 Object Features

1.1.1 Indications
This object indicates trouble within the PLC, as well as trouble associated with an
object programmed in logic of the PLC. The PLC status is updated once every 60
seconds.
The integrator must map all trouble alarm status to this block. The trouble
descriptions are passed to the HMI as a single DINT.
The breakout of this word is given below:
Bit 0= PLC Major Fault
Bit 1= PLC Minor Fault
Bit 2= Connection Fault
Bit 3= Low Battery
Bit 4 = Forces Enabled
Bit 5 = an Object in Simulate
Bit 6 = an Object in Trouble

1.1.2 Simulation
This object indicates if simulation is active for an object programmed in logic of
the PLC. The integrator must map all simulation status to this block.
The PLC object itself does not have a simulate mode.

NEORSD_OL_PLC_Status.doc Page 4 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1=ControlLogix Redundancy is configured for
1 Cfg_Redundancy BOOL IN
this module
Clear Minor Fault from Controller and Last
2 ClearFaultRecord_CMD BOOL IN
Stored Major Fault
Indicates an IO Connection Fault in the PLC.
3 Connection_Fault BOOL NA UDA
Passed into WW UDA via packed integer.
4 EnableIn BOOL IN Enable Input - System Defined Parameter
5 EnableOut BOOL OUT Enable Output - System Defined Parameter
Indicates Forces Enabled in the PLC.
6 Forces_Enabled BOOL NA UDA
Passed into WW UDA via packed integer.
Instructs the AOI to capture Major Fault
7 Inp_MajorFault BOOL IN
information for display on HMI
1 = One or more PLC AOI device objects
8 Inp_SimActive BOOL IN
have been placed in simulation
1 = One or more PLC AOI objects have
9 Inp_TroubleActive BOOL IN
trouble active
Indicates Low Battery in the PLC. Passed
10 Low_Battery BOOL NA UDA
into WW UDA via packed integer.
Indicates an object in the PLC logic is in
11 Object_In_Simulate BOOL NA UDA Simulate mode. Passed into WW UDA via
packed integer.
Indicates an object in the PLC logic has
12 Object_In_Trouble BOOL NA UDA Trouble active. Passed into WW UDA via
packed integer.
Indicates PLC_Major_Fault is active in the
13 PLC_Major_Fault BOOL NA UDA PLC. Passed into WW UDA via packed
integer.
Indicates PLC_Minor_Fault in the PLC.
14 PLC_Minor_Fault BOOL NA UDA
Passed into WW UDA via packed integer.
Set when the seconds counter has not
15 PLC_Seconds_Fault BOOL NA UDA
updated for 10-seconds.
STRIN Test for PLC_Seconds_Fault; required in
16 PLC_Seconds_Fault_Desc NA UDA
G WW for alarm description.
Bit array of PLC alarm or fault conditions for
17 PLC_Trouble_Desc DINT OUT AI Int X
HMI display. See section 1.1 for details.
Incrementing Seconds Count to Monitor PLC
18 Seconds DINT OUT AI Int
Health
19 Seconds_1 INT NA UDA Internal UDA for scripting.
A device object in this PLC is currently
20 Simulate_Active BOOL OUT
running in simulation mode
PLC has one or more connections not
21 Sts_ConnectFault BOOL OUT
working
22 Sts_Force_Enabled BOOL OUT Controller Forces Enabled
23 Sts_Force_Installed BOOL OUT Controller Forces Installed
PLC Low Battery/Energy Storage Fault
24 Sts_LowBatt BOOL OUT
Active
25 Sts_Major_fault BOOL OUT Controller Major Fault

NEORSD_OL_PLC_Status.doc Page 5 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
26 Sts_MinorFault BOOL OUT Controller Minor Fault
27 Sts_MinorFaultBits DINT OUT Controller Minor Fault Bits
28 Sts_MinorFaultEvents DINT OUT Controller Minor Fault Events
Controller Product Code (Determines Type of
29 Sts_ProductCode DINT OUT
Logix Controller)
Redundancy of entire Chassis for Redundant
30 Sts_Red_ChassisStatus DINT OUT
Configurations
Keyswitch Alarm (Primary and Partner
31 Sts_Red_KeyswitchAlarm DINT OUT keyswitch doesn't match) for Redundant
Configurations
Position of Keyswitch of Partner for
32 Sts_Red_PartnerKeyswitch DINT OUT
Redundant Configurations
Status of Partner Minor Faults for Redundant
33 Sts_Red_PartnerMinorFaults DINT OUT
Configurations
Mode of Partner for Redundant
34 Sts_Red_PartnerMode DINT OUT
Configurations
Chassis Of Currently Active Primary PLC in
35 Sts_Red_PhysicalChassisID DINT OUT
Redundant Configurations
An object in this PLC currently has trouble
36 Trouble_Active BOOL OUT
indication active

NEORSD_OL_PLC_Status.doc Page 6 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $PLC_Status

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Active
Extended
Category Priority Alarm Message Alarm Locked
Attribute
State
PLC_Seconds_Fault Discrete 250 Me.PLC_Seconds_Fault_Desc True x

1.3.5 Instance Configuration - None

NEORSD_OL_PLC_Status.doc Page 7 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.3.6 Faceplates
PLC_Faceplate

1
2
3
4

7
8

10

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.
3 Seconds Display Displays the PLC seconds, indicating the PLC is connected.

4 PLC_Seconds_Fault Light Indicates if the seconds of the PLC is not updating regularly.
5 PLC Fault Lights Indicates if the PLC has a Major or Minor Fault alarm.
6 Connection Fault Light Indicates if the PLC has a Connection Fault alarm.

7 Forces Enabled Light Indicates if the PLC has Forces enabled.

8 Obj In Simulate Light Indicates if an object in the PLC is in Simulate mode.


9 Obj in Trouble Light Indicates if an object in the PLC object has Trouble active.

10 Low Battery Indicates if an object in the PLC object has a Low Battery alarm.

NEORSD_OL_PLC_Status.doc Page 8 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.3.7 Graphic Symbols

PLC_ControlLogix PLC5

Display Animations:

• The graphic objects will have a red background if there are no PLC
alarms, and a green background if any PLC alarms are active.
• PLC_Seconds_Fault alarm:
o Yellow “C” will appear in the middle of the graphic symbols
o The “C” will blink if the alarm is not acknowledged.

NEORSD_OL_PLC_Status.doc Page 9 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_PLC_Status.doc Page 10 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 PLC Name
3 PLC Description
4 RSLinx Enterprise PLC Shortcut
5 Abbrev Controller Type (i.e. L62)

NEORSD_OL_PLC_Status.doc Page 11 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.5.2 Faceplates

FP_PLC_STATUS

1
2

4
5
6

7 10
8
11

Graphic Design Element


Number Function Description
1 PLC Name PLC name defined by user during instance creation.

2 Description User defined description text for display only.


3 Navigation Buttons Opens status and detail faceplates with additional information.

4 PLC Run Status Displays PLC mode status (Run/Remote Run/Remote Program/Program/Test/Fault)
5 Detailed PLC Status Displays various details regarding PLC and I/O health

6 Force Status Displays PLC Forces Installed and Forces Enabled Status
7 Keyswitch Status Displays PLC keyswitch position (Run/Rem/Program)
8 Trouble/Sim Status Indicates whether any object in the observed PLC has simulation or trouble active

Displays system redundancy status, including chassis location (Chassis A or B) of active


9 Redundancy Status
primary, for redundant configurations

Indicates whether a PLC minor fault is active on the primary controller (and on partner
10 Minor Fault
controller for redundant configurations)

11 Exit Button to close the faceplate.

NEORSD_OL_PLC_Status.doc Page 12 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

FP_PLC_STATUS_STATUS

2
1

Graphic Design Element


Number Function Description
1 Major Fault Displays PLC fault indication and codes. Fault codes buffered in PLC until reset.
2 Seconds Value of continuous 60 second PLC health and communications status timer.

3 Minor Fault Displays common minor fault status bits currently active in the PLC.
4 Clear Fault Clears buffered copy of major fault code and the PLC minor fault record

NEORSD_OL_PLC_Status.doc Page 13 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

FP_PLC_STATUS_DETAIL

1
2

Graphic Design Element


Number Function Description
1 Processor Name Displays the name assigned to controller.
2 PLC Type/Revision Displays the controller type and firmware revision.
Displays the most recent Date/Time the PanelView Plus lost communications with the
3 Connection Drop
controller (due to network or other errors).
Displays the total, used, and free IO and Data/Logic memory associated with the
4 Usage Memory
controller.

NEORSD_OL_PLC_Status.doc Page 14 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

FP_PLC_STATUS_REDUNDANCY

3
4

5 6

Graphic Design Element


Number Function Description
1 Primary Chassis Displays chassis location (Chassis A or B) of the active primary controller
2 Primary Mode/Keyswitch Displays the primary controller mode and keyswitch position.
3 Primary Minor Faults Displays common minor fault status bits currently active on the primary controller.

4 Secondary Chassis Displays chassis location (Chassis A or B) of the partner controller.


Displays the chassis redundancy state of the partner controller. Possible states
5 Partner Status
include synchronized (SYNC), disqualified (DISQ), or unknown (????).

6 Partner Mode/Keyswitch Displays the partner controller mode and keyswitch position.
7 Partner Minor Faults Displays common minor fault status bits currently active on the partner controller.

NEORSD_OL_PLC_Status.doc Page 15 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - PLC Status

1.5.3 Graphic Symbols

NEORSD_OL_PLC_Status.doc Page 16 of 16 Revision: 1.2.0


Title: NEORSD Standard Object Library - Restart Inhibit

NEORSD Standard Object Library

Restart Inhibit

NEORSD_OL_Restart_Inhibit.doc Page 1 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Restart Inhibit

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Feb-2011 PSIM All Issue for Use

NEORSD_OL_Restart_Inhibit.doc Page 2 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Restart Inhibit

Table of Contents:
1.0 RESTART INHIBIT......................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Indications................................................................................................................... 4
1.1.2 Simulation - None ....................................................................................................... 4
1.1.3 Trouble – None ........................................................................................................... 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 4
1.2.1 Table of Attributes & WW UDAs ................................................................................ 4
1.3 WONDERWARE HMI ........................................................................................................ 5
1.3.1 Hierarchical Name - $Restart_Inhibit ........................................................................ 5
1.3.2 Derived from - $NEORSDUserDefined ...................................................................... 5
1.3.3 Container - None......................................................................................................... 5
1.3.4 Extensions - None ....................................................................................................... 5
1.3.5 Instance Configuration - None.................................................................................... 5
1.3.6 Faceplates - None ....................................................................................................... 5
1.3.7 Graphic Symbols ......................................................................................................... 5
1.4 CONTROLLOGIX PLC....................................................................................................... 6
1.4.1 Available Languages ................................................................................................... 6
1.5 PANELVIEW OIT.............................................................................................................. 7
1.5.1 Object Instance ........................................................................................................... 7
1.5.2 Faceplates ................................................................................................................... 7
1.5.3 Graphic Symbols ......................................................................................................... 7

NEORSD_OL_Restart_Inhibit.doc Page 3 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Restart Inhibit

1.0 Restart Inhibit


The Restart Inhibit object template provides an interlock to prevent large motors or other objects
requiring protection from repeated starts. The template object monitors start attempts over time
and determines the required wait period before the next start attempt may be made.

1.1 Object Features

1.1.1 Indications
This object provides indication whether the motor is ready to start or inhibited. If
inhibited, the object displays the required wait time (in minutes and seconds) before
motor ready.

1.1.2 Simulation - None

1.1.3 Trouble – None

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware
Direction

Direction

Alarm

Event

Data
Item

Hist

Attributes Type Notes


Sec for motor to wait after 1st start failure
1 Cfg_FirstFailSec DINT IN
before ready to start
Sec for motor to wait after 2nd and
2 Cfg_SubseqFailSec DINT IN
subsequent start failure before ready
3 Cfg_ThreeStartsSec DINT IN Sec within which three starts are allowed
4 EnableIn BOOL IN Enable Input - System Defined Parameter
5 EnableOut BOOL OUT Enable Output - System Defined Parameter
6 Inp_Running BOOL IN DI Equipment is confirmed Running
Equipment is Starting, indicating a start
7 Inp_Starting BOOL IN
attempt
8 Inp_Stopped BOOL IN Equipment is confirmed Stopped
9 InstructFault BOOL OUT 1=Config Has Generated An Error
AI Minutes yet inhibited before ready to start
10 MinToReady DINT OUT
Int (mmm:ss)
Permissive for unit to start 1=ready, 0=not
11 Ready BOOL OUT DI
ready
AI Seconds yet inhibited before ready to start
12 SecToReady DINT OUT
Int (mmm:ss)
13 State DINT OUT State Number of AOI State Machine Logic

NEORSD_OL_Restart_Inhibit.doc Page 4 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Restart Inhibit

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Restart_Inhibit

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration - None

1.3.6 Faceplates - None

1.3.7 Graphic Symbols

Ready_Display

Display Animations:
• When the motor is not running, the display is visible.
• When the motor is running, the display becomes invisible.
• The Minutes and Seconds box are only visible when the motor is not
ready.

NEORSD_OL_Restart_Inhibit.doc Page 5 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Restart Inhibit

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Restart_Inhibit.doc Page 6 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Restart Inhibit

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description

1.5.2 Faceplates
No faceplates are currently configured for the Restart Inhibit display.

1.5.3 Graphic Symbols

OIT Object Animations:


• When the motor is not running, the display is visible.
• When the motor is running, the display becomes invisible.
• The Minutes and Seconds box are only visible when the motor is not
ready.

NEORSD_OL_Restart_Inhibit.doc Page 7 of 7 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

NEORSD Standard Object Library

Runtime

NEORSD_OL_Runtime.doc Page 1 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 21-Feb-2011 PSIM All Issue for Use

NEORSD_OL_Runtime.doc Page 2 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

Table of Contents:
1.0 RUNTIME ......................................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Controls ....................................................................................................... 4
1.1.2 Indications................................................................................................................... 4
1.1.3 Simulation – None ....................................................................................................... 4
1.1.4 Trouble - None ............................................................................................................ 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 6
1.3.1 Hierarchical Name - $Runtime ................................................................................... 6
1.3.2 Derived from - $NEORSDUserDefined ...................................................................... 6
1.3.3 Container - None......................................................................................................... 6
1.3.4 Extensions - None ....................................................................................................... 6
1.3.5 Instance Configuration - None.................................................................................... 6
1.3.6 Faceplates - None ....................................................................................................... 6
1.3.7 Graphic Symbols ......................................................................................................... 6
1.4 CONTROLLOGIX PLC....................................................................................................... 7
1.4.1 Available Languages ................................................................................................... 7
1.5 PANELVIEW OIT.............................................................................................................. 8
1.5.1 Object Instance ........................................................................................................... 8
1.5.2 Faceplates ................................................................................................................... 8
1.5.3 Graphic Symbols ......................................................................................................... 9

NEORSD_OL_Runtime.doc Page 3 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

1.0 Runtime
The Runtime template uses the Motor Output Signal (Starting) and Running Feedback
(Running) if available to totalize the amount of time running and start attempts made over
various time periods. The template stores a totalized value of each, as well as values for the
current and previous days.

1.1 Object Features

1.1.1 Standard Controls


This object calculates the following values:
Total RunTime – Accumulated runtime, in tenths of an hour
Previous Day RunTime – Previous day runtime value, in tenths of an hour
Current RunTime – Accumulated runtime since last start
Total Starts – Accumulated start counter
Current Day Starts – Current day starts, reset daily
Previous Day Starts – Previous day starts
Current Day RunTime – Current day runtime value, reset daily, in tenths of an
hour

The PLC Clock Hour must be linked to a tag, and configured in the AOI.

1.1.2 Indications
The HMI only displays the current Runtime hours. The OIT provides display of
all object attributes.

1.1.3 Simulation – None

1.1.4 Trouble - None

NEORSD_OL_Runtime.doc Page 4 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Hour of the Day at Which Daily Run Time is
1 Cfg_ResetHourofDay DINT IN
Reset (Typically Midnight, = 0)
2 Cur_Hours REAL OUT Current running time this start (hours)
AI Current day accumulated running time
3 CurDay_Hours REAL OUT X
Int (hours)
Total number of motor starts or attempts for
4 CurDay_Starts DINT OUT
the current day
Number of decimal places configured for
5 Decimal INT NA UDA
display on output
6 EnableIn BOOL IN Enable Input - System Defined Parameter
7 EnableOut BOOL OUT Enable Output - System Defined Parameter
References PLC Clock Hour Attribute (Used
8 Inp_PLCClockHours DINT InOut
to Reset Daily Hours)
9 Inp_Running BOOL IN 1=Motor is Running (from motor instruction)
10 Inp_Starting BOOL IN 1=Motor is Starting (from motor instruction)
11 InstructFault BOOL OUT 1=Config Has Generated an Error
Previous day accumulated running time
12 PrevDay_Hours REAL OUT
(hours)
Total number of motor starts or attempts for
13 PrevDay_Starts DINT OUT
the previous day
Command to Clear Total Running Time and
14 Reset_CMD BOOL IN
Starts/Start Attempts
15 Total_Hours REAL OUT Total accumulated running time (hours)
16 Total_Starts DINT OUT Total number of motor starts or attempts

NEORSD_OL_Runtime.doc Page 5 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Runtime

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration - None

1.3.6 Faceplates - None

1.3.7 Graphic Symbols

RunTime_Hrs

NEORSD_OL_Runtime.doc Page 6 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary. Inp_PLCClockHours must be configured
with a tag linked to the PLC Clock Hour.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Runtime.doc Page 7 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
4 Key Assignment (For Display Only)

1.5.2 Faceplates
FP_RUNTIME

1
2

4
5

Graphic Design Element


Number Function Description
1 Device Tag Device tag associated with the runtime object (motor device tag)
2 Description User defined description text for display only.
3 Navigation Buttons Opens status faceplate with additional information.
4 Current Day Values Total accumulated runtime hours and starts for current day. Resets once daily.
5 Current Runtime Total accumulated hours since last motor start. Resets every motor start.
6 Previous Day Values Total accumulated runtime hours and starts for previous day.
7 Exit Button to close the faceplate.

NEORSD_OL_Runtime.doc Page 8 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Runtime

FP_RUNTIME_STATUS

Graphic Design Element


Number Function Description
1 Motor Status Indicates status of motor output (start) and motor feedback (running) signals.
2 Daily Reset Hour Displays hour of the day that daily runtime values are reset. Default is midnight.
3 Totalized Values Total accumulated runtime hours and starts. Reset only through PLC object access.

1.5.3 Graphic Symbols

NEORSD_OL_Runtime.doc Page 9 of 9 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

NEORSD Standard Object Library

Valve Actuator

NEORSD_OL_Valve_Actuator.doc Page 1 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 16-Dec-2011 PSIM All Issue for Use

NEORSD_OL_Valve_Actuator.doc Page 2 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

Table of Contents:
1.0 VALVE ACTUATOR....................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Controls ....................................................................................................... 4
1.1.2 Indications................................................................................................................... 4
1.1.3 Alarming ..................................................................................................................... 4
1.1.4 Simulation ................................................................................................................... 4
1.1.5 Trouble ........................................................................................................................ 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 8
1.3.1 Hierarchical Name - $Valve_Actuator ....................................................................... 8
1.3.2 Derived from - $NEORSDUserDefined/$Valve_Discrete_Indicator/$Valve_Discrete
8
1.3.3 Container - None......................................................................................................... 8
1.3.4 Extensions - None ....................................................................................................... 8
1.3.5 Faceplates ................................................................................................................... 8
1.3.6 Graphic Symbols ....................................................................................................... 10
1.3.7 Instance Configuration ............................................................................................. 11
1.4 CONTROLLOGIX PLC..................................................................................................... 12
1.4.1 Available Languages ................................................................................................. 12
1.5 PANELVIEW OIT............................................................................................................ 13
1.5.1 Object Instance ......................................................................................................... 13
1.5.2 Faceplates ................................................................................................................. 14
1.5.3 Graphic Symbols ....................................................................................................... 17

NEORSD_OL_Valve_Actuator.doc Page 3 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.0 Valve Actuator


The valve actuator template provides a standard method for controlling the operation,
indication, and alarming of actuator valves throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Standard Controls


This object supports the following standard device control elements and
indications:
Local – Device controlled at local control station, outside of PLC logic.
Remote Manual – Device controlled by operator via faceplates and PLC.
Remote Auto – Device controlled by PLC logic.
OOS – Device is out of service and alarms are disabled.

When configured to use limit switch feedback, a fault causes the object to fail to
manual mode.
The object allows for as many as five custom interlocks to be connected through
external logic. Interlocks will disable the ability to activate the device.

1.1.2 Indications
Opened and Closed feedback indicators.

This object also features a Wired_Failsafe UDA. This setting should match the
field wiring. A valve wired failsafe will indicate a “0” at its limit, and a “1 when
not at it limit. If both Opened and Closed inputs are off, and Wired_Failsafe is
true, then the valve has failed and the Fault indicator is activated.

This object contains command-direction indication attributes Closing and


Opening for display purposes.

1.1.3 Alarming
This object supports a common alarm indicator (Fault).

1.1.4 Simulation
This object support simulation of actuator valve operation.

1.1.5 Trouble
This object supports hardware trouble indication. The text string for the trouble
description must be mapped to a user defined tag and configured in the object.

NEORSD_OL_Valve_Actuator.doc Page 4 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Auto BOOL OUT DI X 1=Auto Mode Active
2 Auto_CMD BOOL IN DO X HMI command to place valve in Auto
Delay before fault after commanded
3 Cfg_CloseTime DINT IN
close and feedback not received
4 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
Delay before device fault is reset if not
5 Cfg_FaultActiveTime DINT IN
configured to latch
Delay before fault if both failsafe
6 Cfg_FBFailTime DINT IN
feedbacks lose input
1=Closed/Open limit switches are
7 Cfg_FBWiredFailsafe BOOL IN
wired failsafe
Valve Position At Which Valve is
8 Cfg_FullClosedPosition REAL IN
Considered Fully Closed
Valve Position At Which Valve is
9 Cfg_FullOpenPosition REAL IN
Considered Fully Open
Valve interlock operation: 0 = Stop In-
10 Cfg_InterlockState DINT IN
Place 1 = Force Close 2 = Force Open
1=Require HMI Reset_CMD toggle to
11 Cfg_LatchFault BOOL IN reset fault, 0 =Automatically clear fault
after configurable delay
1=Manual only device, device cannot
12 Cfg_ManOnlyDevice BOOL IN
be placed in auto
Delay before fault after commanded
13 Cfg_OpenTime DINT IN
open and feedback not received
Time in seconds in which outputs are
14 Cfg_OutputPulseTime DINT IN held active (unless limit switch is met).
Enter 0 to maintain outputs.
1=Simulate working valve;
15 Cfg_Sim BOOL IN
0=Open/Close/ Monitor actual valve
1=Valve Closed LS should be used for
16 Cfg_UseClosedLS BOOL IN
failure checking
1=Valve Open LS should be used for
17 Cfg_UseOpenLS BOOL IN
failure checking
1=Valve Position FB available for
18 Cfg_UsePositionFB BOOL IN
monitoring
1=Valve has LOCAL/OFF/REMOTE
19 Cfg_UseRemote BOOL IN
control
HMI command to close valve while in
20 Close_CMD BOOL IN DO X
Manual
21 Closed BOOL OUT DI X 1=Valve is confirmed Closed
1=Valve has been commanded close
22 Closing BOOL OUT DI
and has not reached the closed limit
Number of configured decimal places
23 Decimal DINT IN UDA
configured on output value (Position)
Enable Input - System Defined
24 EnableIn BOOL IN
Parameter
Enable Output - System Defined
25 EnableOut BOOL OUT
Parameter
26 Fault BOOL OUT DI X 1=Fault open or close alarm active
27 Inp_AutoCloseCMD BOOL In Program Command to Close Valve

NEORSD_OL_Valve_Actuator.doc Page 5 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
28 Inp_AutoOpenCMD BOOL In Program Command to Open Valve
Valve Closed Limit Switch 1=confirmed
29 Inp_ClosedLS BOOL In
CLOSED
1=Interlock 1 condition active, do not
30 Inp_Interlock1 BOOL In
permit operation
1=Interlock 2 condition active, do not
31 Inp_Interlock2 BOOL In
permit operation
1=Interlock 3 condition active, do not
32 Inp_Interlock3 BOOL In
permit operation
1=Interlock 4 condition active, do not
33 Inp_Interlock4 BOOL In
permit operation
1=Interlock 5 condition active, do not
34 Inp_Interlock5 BOOL In
permit operation
Communication Status 0=OK, 1=Fail.
35 Inp_IOFault BOOL In
Faults Valve Object
Valve Open Limit Switch 1=confirmed
36 Inp_OpenLS BOOL In
OPEN
CLX InOut Paramter. PLC_STATUS
PLC_ST
37 Inp_PLC_STATUS InOut reference for setting Inp_TroubleActive
ATUS
and Inp_SimActive
Actual valve position from field
38 Inp_PositionFB REAL In
measurement
LOCAL/OFF/REMOTE position
39 Inp_Remote BOOL In
feedback (1=Valve in Remote)
40 Inp_Trouble BOOL In Trouble indication
CLX InOut Parameter: Use a Unique
41 Inp_Trouble_Desc STRING InOut Tag to Hold the Trouble Description
String
42 InstructFault BOOL Out 1=Config Has Generated an Error
1=Interlock 1 active, operation not
43 Interlock1 BOOL OUT DI X
permitted
1=Interlock 2 active, operation not
44 Interlock2 BOOL OUT DI X
permitted
1=Interlock 3 active, operation not
45 Interlock3 BOOL OUT DI X
permitted
1=Interlock 4 active, operation not
46 Interlock4 BOOL OUT DI X
permitted
1=Interlock 5 active, operation not
47 Interlock5 BOOL OUT DI X
permitted
48 OOS BOOL OUT DI X 1=OOS (Out of Service) Mode Active
49 OOS_CMD BOOL IN DO X HMI command to place valve in OOS
50 Open_CMD BOOL IN DO X HMI command to open valve in Manual
51 Opened BOOL OUT DI X 1=Valve is confirmed Opened
1=Valve has been commanded open
52 Opening BOOL OUT DI
and has not reached the open limit
53 Out_Close BOOL OUT 1=Run actuator/motor to CLOSE Valve
54 Out_Open BOOL OUT 1=Run actuator/motor to OPEN Valve
1=Break seal-in circuit in actuator to
55 Out_Stop BOOL OUT
STOP Valve motion
AI Valve Position for display on the
56 Position REAL OUT X
Float OIT/HMI
57 Rem BOOL OUT DI X 1=Valve is in Remote

NEORSD_OL_Valve_Actuator.doc Page 6 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
58 ResetAlarm_CMD BOOL IN 1=Reset alarm command from HMI

59 Sim BOOL OUT 1=Simulation Active

60 Stop_CMD BOOL IN DO X HMI command to stop valve in Manual


61 Stopped BOOL OUT 1=Valve is Stopped
62 Sts_Interlocked BOOL OUT 1 or more device interlocks are active
63 Trouble BOOL OUT DI X 1=Specified trouble condition active
64 Trouble_Desc STRING Local UDA Active trouble description
1=Block has produced new fault that
65 UnackedAlarm BOOL OUT
has not been ackowledged/reset
1=Closed/Open limit switches are
66 Wired_Failsafe BOOL OUT UDA
wired failsafe

NEORSD_OL_Valve_Actuator.doc Page 7 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Valve_Actuator

1.3.2 Derived from -


$NEORSDUserDefined/$Valve_Discrete_Indicator/$Valve_Discrete

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Faceplates

Actuator_Faceplate
10
1
11
2 12

4
13
5
6
7
14
8
15
9

NEORSD_OL_Valve_Actuator.doc Page 8 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

16

17

Graphic Design Element


Number
Function Description
1 Tagname Displays the object name
Indicates the current mode. Allows for the toggling between automatic and manual
states. This button is only selectable when the logged in user has proper control level
Automatic and access. If the user is not logged in with the proper control level access the switch is not
2
Manual Switch selectable and becomes grey indicating it is not selectable. Regardless if the user is
logged in with the proper control level the switch will indicate the current state of the
mode.
3 Remote Indicates the valve is in remote mode.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
any of those conditions are not met the button will be disabled and the text will appear
4 Open
grey indicating it is not selectable. If the conditions are met, pressing the Open button
will open the valve. The light is visible regardless if the conditions are met and is bright
red when opened and dark when not opened.
5 Transition Arrows Arrows indicate the direction of the valve movement. Only visible while in transition.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
any of those conditions are not met the button will be disabled and the text will appear
6 Close
grey indicating it is not selectable. If the conditions are met, pressing the Close button
will close the valve. The light is visible regardless if the conditions are met and is bright
green when closed and dark when not closed.
This button is only selectable when the logged in user has proper control level access.
If the user is not logged in with the proper control level access the switch is not
7 Out of Service selectable and becomes grey indicating it is not selectable. Pressing the OOS button
will put the motor in out of service mode. The light is visible regardless if the conditions
are met and is bright red when out of service and dark when not out of service.

NEORSD_OL_Valve_Actuator.doc Page 9 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

Graphic Design Element


Number
Function Description
Indicates the valve is in interlock mode. Interlock mode prevents the opening or closing
8 Interlock
of the valve.
This button is only selectable when the logged in user has proper control level access,
the mode is manual, REM is remote, Interlock is not active, and OOS is not active. If
9 Stop Button any of those conditions are not met the button will be disabled and the text will appear
grey indicating it is not selectable. If the conditions are met, pressing the Stop button
will stop the valve.
10 Close Button Pressing this button closes the faceplate display.
Provides navigation to the other pages of the faceplate. Status will animate when Fault
11 Tabs
or Interlocks or Trouble is active.
12 Fault Indicates the valve has faulted (failopen, failclose).
13 Interlock Indicates the status of the configured interlocks
14 Failsafe Indicates the valve is wired for failsafe indication (no feedback = fault)
15 Trouble Indicates if the valve is in trouble and shows the trouble description message below
16 Position Indicates the analog position of the valve
The display (to the right of the button) indicates the current target setpoint. This button is
only selectable when the logged in user has proper control level access, the mode is
manual, the valve is in remote, Interlock is not active, and OOS is not active. If any of
17 Setpoint
those conditions are not met the button will be disabled and the text will appear grey
indicating it is not selectable. If those conditions are met, pressing the Setpoint button
will display an entry box that can be used to set the value.

1.3.6 Graphic Symbols

Actuator_Valve Actuator_PEPS_Butterfly_Horz Actuator_PEPS_Butterfly


Actuator_Gate

Actuator_TextStatusPT_OPND
Actuator_Position_Ind_Display

Actuator_ISA_Gate Actuator_Horz_Meter

NEORSD_OL_Valve_Actuator.doc Page 10 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.3.7 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) Wired_Failsafe – Specify if this is a Wired_Failsafe valve. If it is, check the


True/False box on the Wired_Failsafe UDA on the UDA tab. If it is not then
no configuration is required.

3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Auto
b. Close_CMD
c. Fault
d. Interlock1 to Interlock5
e. OOS
f. OOS_CMD
g. Open_CMD
h. Position
i. REM
j. Stop_CMD

NEORSD_OL_Valve_Actuator.doc Page 11 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Valve_Actuator.doc Page 12 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
4 Keypad Assignment (For Display Only)
5 Interlock 1 Description
6 Interlock 2 Description
7 Interlock 3 Description
8 Interlock 4 Description
9 Interlock 5 Description

NEORSD_OL_Valve_Actuator.doc Page 13 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.5.2 Faceplates
FP_VALVE_ACTUATOR

1
2

5
6

8
9

10

Graphic Design Element


Number Function Description
1 Display Name Displays the object name.

2 Device Description User defined description text for display only.


Provides navigation to the other sections of the faceplate; restricted to higher level
3 Tabs
access.

4 Device Status Displays mode (Auto/Manual) and Out of Service (OOS).


Buttons to open, stop, or close the valve. Command state is indicated by the black
5 Open/Stop/Close
triangle.

6 Limit Switch Displays the state of the limit switches.

7 Opening/Closing Status Indicates if the valve is traveling in the open or closed direction

8 Alarm Indicators Lights indicate if a Fault, or Trouble or Interlock is active.

9 Mode Control Toggle the valve between Manual and Auto mode.

10 Exit Button Pressing this button closes the faceplate display.

NEORSD_OL_Valve_Actuator.doc Page 14 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

FP_VALVE_ACTUATOR_DETAIL

1 2
3

Graphic Design Element


Number Function Description
1 Object Configurations Displays various object configuration settings within the PLC.

2 Instruction Fault Indicates a configuration error in the PLC.

3 Out of Service Status Indicates the device has been placed out of service (OOS).

NEORSD_OL_Valve_Actuator.doc Page 15 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

FP_VALVE_ACTUATOR_STATUS

2 3

Graphic Design Element


Number Function Description
1 Interlock Status Displays the status for the configured Interlocks.
2 Trouble Displays the Trouble indication and Trouble message.
3 Fault Status Displays the active faults.

NEORSD_OL_Valve_Actuator.doc Page 16 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Actuator

1.5.3 Graphic Symbols

NEORSD_OL_Valve_Actuator.doc Page 17 of 17 Revision: 1.0.0


Title: NEORSD Standard Object Library - Valve Analog

NEORSD Standard Object Library

Valve Analog

NEORSD_OL_Valve_Analog.doc Page 1 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 02-Feb-2011 PSIM All Issue for use.
1.1.0 04-Apr-2011 PSIM 1.3.7 Added Analog_TxtStatus graphic symbol
Updated OIT faceplates to include longer interlock
1.2.0 20-Apr-2011 PSIM 1.5.2
description field length.
Inserted OIT graphical symbols for damper and
1.2.0 20-Apr-2011 PSIM 1.5.3
generic open/close status.
Added new attribute Inp_PLC_STATUS to Object
1.3.0 04-May-2011 PSIM 1.2.1
Attribute List.
1.4.0 13-May-2011 PSIM 1.3.5 Updated instance visibility configuration.
Inserted Wonderware graphics
1.4.0 13-May-2011 PSIM 1.3.7 Analog_Damper_Basic and
Analog_Flow_Control_Valve.
1.5.0 03-June-2011 PSIM 1.3.7 Inserted Wonderware graphic Analog_Vert_Meter.
Added PulseTime and TriggerTime UDAs to Object
1.6.0 29-June-2011 PSIM 1.2.1
Attributes List.
Inserted Wonderware graphics Analog_ISA_Gate and
1.6.0 29-June-2011 PSIM 1.3.7 Analog_Horz_Meter, and updated
Analog_Position_Display.
1.7.0 14-Dec-2011 PSIM 1.1 Revised object feature descriptions
Added new attribute ExternalFault and
1.7.0 14-Dec-2011 PSIM 1.2.1
Inp_ExternalFault to Object Attribute List.
1.7.0 14-Dec-2011 PSIM 1.3.7 Inserted Wonderware graphics w/o Faceplates (_RO).
Updated OIT faceplates to include an external fault
1.7.0 14-Dec-2011 PSIM 1.5.2
status.
1.7.0 14-Dec-2011 PSIM 1.5.3 Updated standard Valve Analog symbols

NEORSD_OL_Valve_Analog.doc Page 2 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

Table of Contents:
1.0 VALVE ANALOG ............................................................................................................ 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Controls & Features.................................................................................... 4
1.1.2 Indications................................................................................................................... 4
1.1.3 Alarming ..................................................................................................................... 4
1.1.4 Simulation ................................................................................................................... 5
1.1.5 Trouble ........................................................................................................................ 5
1.2 OBJECT ATTRIBUTES........................................................................................................ 6
1.2.1 Table of Attributes & WW UDAs ................................................................................ 6
1.3 WONDERWARE HMI ........................................................................................................ 9
1.3.1 Hierarchical Name - $Valve_Analog.......................................................................... 9
1.3.2 Derived from - $NEORSDUserDefined/$Valve_Analog_Indicator ........................... 9
1.3.3 Container - None......................................................................................................... 9
1.3.4 Extensions - None ....................................................................................................... 9
1.3.5 Instance Configuration ............................................................................................... 9
1.3.6 Faceplates ................................................................................................................. 10
1.3.7 Graphic Symbols ....................................................................................................... 11
** BLUE BACKGROUND ON POSITION DISPLAY INDICATES OPERATOR ACTION POSSIBLE. ........... 11
1.4 CONTROLLOGIX PLC..................................................................................................... 13
1.4.1 Available Languages ................................................................................................. 13
1.5 PANELVIEW OIT............................................................................................................ 14
1.5.1 Object Instance ......................................................................................................... 14
1.5.2 Faceplates ................................................................................................................. 15
1.5.3 Graphic Symbols ....................................................................................................... 18

NEORSD_OL_Valve_Analog.doc Page 3 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.0 Valve Analog


The valve analog template provides a standard method for controlling the operation,
indication, and alarming of analog valves throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Standard Controls & Features


This object supports the following standard device control elements and
indications:
Local – Device controlled at local control station, outside of PLC logic.
Remote Manual – Device controlled by operator via faceplates and PLC.
Remote Auto – Device controlled by PLC logic.
OOS – Device is out of service and alarms are disabled.

The object allows for as many as five custom interlocks to be connected through
external logic. Interlocks prevent device operation.

Parameters allow configuration of the full open/closed position limits, as well as


the minimum and maximum output command limits.

1.1.2 Indications
Analog position feedback may be linked to the object, as well as limit switch
inputs (full open, full closed) if available.

The Wired-Failsafe parameter that should be configured when using limit


switches. This setting should match the field wiring. A valve wired failsafe will
indicate a “0” at its limit, and a “1 when not at it limit.

1.1.3 Alarming
This object supports a common alarm indicator (Fault). Configuration parameters
allow for customizing the fail open/close times, the deadband used in command to
feedback comparison, partial open times, and the timeout for loss of limit switch
feedback. Fault is disabled in local mode.

When a fault occurs, the device will go to the configured fail safe position and
manual mode. A parameter exists to enable manual reset of the alarm, or auto
acknowledging when the fault condition clears.

NEORSD_OL_Valve_Analog.doc Page 4 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.1.4 Simulation
This object can provided simulated feedback of a working valve while disabling
outputs.

1.1.5 Trouble
This object supports hardware trouble indication. The text string for the trouble
description must be mapped to a user defined tag and configured in the object.

NEORSD_OL_Valve_Analog.doc Page 5 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Auto BOOL OUT DI X 1=Auto Mode Active
2 Auto_CMD BOOL IN DO X HMI command to place valve in Auto
Delay before fault after commanded fully
3 Cfg_CloseTime DINT IN close and limit switch feedback not
received
4 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
Delay before device fault is reset if not
5 Cfg_FaultActiveTime DINT IN
configured to latch
Delay before fault if both failsafe
6 Cfg_FBFailTime DINT IN
feedbacks lose input
1=Closed/Open limit switches are wired
7 Cfg_FBWiredFailsafe BOOL IN
failsafe
Valve Position At Which Valve is
8 Cfg_FullClosedPosition REAl IN
Considered Fully Closed
Valve Position At Which Valve is
9 Cfg_FullOpenPosition REAL IN
Considered Fully Open
1=Require HMI Reset_CMD toggle to
10 Cfg_LatchFault BOOL IN reset fault, 0 =Automatically clear fault
after configurable delay
1=Manual only device, device cannot be
11 Cfg_ManOnlyDevice BOOL IN
placed in auto
Cfg_MaxPositionComman
12 REAL IN High limit of commanded output
d
13 Cfg_MinPositionCommand REAL IN Low limit of commanded output
Delay before fault after commanded fully
14 Cfg_OpenTime DINT IN
open and feedback not received
Deadband around Fully Closed/Open
Cfg_PartialOpenDeadban
15 REAL IN Position Settings to prevent false Partial
d Open Faults
Delay before fault after commanded
16 Cfg_PartialOpenTime DINT IN
partial open and feedback not received
Deadband in evaluating whether
17 Cfg_PosFBDeadband REAL IN position feedback matches the valve
command
Delay before fault after commanded
18 Cfg_PositionCheckTime DINT IN position feedback is not reached within
deadband
1=Reverse acting (fail open), 0=Normal
19 Cfg_ReverseActing BOOL IN
(fail close)
1=Simulate working valve;
20 Cfg_Sim BOOL IN
0=Open/Close/ Monitor actual valve
1=Valve Closed LS should be used for
21 Cfg_UseClosedLS BOOL IN
failure checking. Default = 0
1=Valve Open LS should be used for
22 Cfg_UseOpenLS BOOL IN
failure checking. Default = 0
1=Valve Position FB should be used for
23 Cfg_UsePositionFB BOOL IN
failure checking. Default = 0
1=Valve has LOCAL/OFF/REMOTE
24 Cfg_UseRemote BOOL IN
control
25 Closed BOOL OUT DI 1=Valve is confirmed fully Closed

NEORSD_OL_Valve_Analog.doc Page 6 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
Number of configured decimal places
26 Decimal DINT IN UDA
configured on output value (Position)
Enable Input - System Defined
27 EnableIn BOOL IN
Parameter
Enable Output - System Defined
28 EnableOut BOOL OUT
Parameter
29 ExternalFault BOOL OUT Valve External Fault Indicator
30 Fault BOOL OUT DI X 1 = Alarm Active
Program Commanded State when in
31 Inp_AutoPositionCMD REAL IN
Auto
Valve Closed Limit Switch 1=confirmed
32 Inp_ClosedLS BOOL IN
CLOSED
1=External Fault Condition Active.
33 Inp_ExternalFault BOOL IN
Faults Valve Object
1=Interlock 1 condition active, do not
34 Inp_Interlock1 BOOL IN
permit operation
1=Interlock 2 condition active, do not
35 Inp_Interlock2 BOOL IN
permit operation
1=Interlock 3 condition active, do not
36 Inp_Interlock3 BOOL IN
permit operation
1=Interlock 4 condition active, do not
37 Inp_Interlock4 BOOL IN
permit operation
1=Interlock 5 condition active, do not
38 Inp_Interlock5 BOOL IN
permit operation
Valve Open Limit Switch 1=confirmed
39 Inp_OpenLS BOOL IN
OPEN
CLX InOut Paramter – PLC_STATUS
PLC_ IO
40 Inp_PLC_STATUS STATUS Param
reference for setting Inp_TroubleActive
and Inp_SimActive
Actual valve position from field
41 Inp_PositionFB REAL IN
measurement
LOCAL/OFF/REMOTE position
42 Inp_Remote BOOL IN feedback (1=Valve in Remote). Faults
are disabled in local mode.
43 Inp_Trouble BOOL IN Trouble indication
CLX InOut Parameter: Use a Unique
IO
44 Inp_Trouble_Desc STRING
Param
Tag to Hold the Trouble Description
String
45 InstructFault BOOL OUT 1=Config Has Generated an Error
1=Interlock 1 active, operation not
46 Interlock1 BOOL OUT DI X
permitted
1=Interlock 2 active, operation not
47 Interlock2 BOOL OUT DI X
permitted
1=Interlock 3 active, operation not
48 Interlock3 BOOL OUT DI X
permitted
1=Interlock 4 active, operation not
49 Interlock4 BOOL OUT DI X
permitted
1=Interlock 5 active, operation not
50 Interlock5 BOOL OUT DI X
permitted
51 OOS BOOL OUT DI X 1=OOS (Out of Service) Mode Active
52 OOS_CMD BOOL IN DO X HMI command to place valve in OOS
53 Opened BOOL OUT DI 1=Valve is confirmed fully Opened
54 Out REAL OUT Valve Output Command (0 - 100%)

NEORSD_OL_Valve_Analog.doc Page 7 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
AI Valve position feedback for display on
55 Position REAL OUT
Float
x
the HMI
AI/O Valve commanded position from HMI
56 Position_CMD REAL IN
Float
X
when in manual
Amount of time (sec) the setpoint will be
57 PulseTime FLOAT IN UDA
written to the PLC before unlatch.
58 Rem BOOL OUT DI X 1=Valve is in Remote
59 ResetAlarm_CMD BOOL IN 1=Reset alarm command from HMI
60 Sim BOOL OUT 1=Simulation Active
61 Sts_Interlocked BOOL OUT 1 or more device interlocks are active
62 Sts_MaxCommandOutput BOOL OUT 1=Valve is at high command limit
63 Sts_MinCommandOutput BOOL OUT 1=Valve is at low command limit
Position feedback does not match valve
64 Sts_PositionFBMismatch BOOL OUT
commanded state
The current time, used in script with
65 TriggerTime TIME IN UDA
PulseTime for setpoint unlatch.
66 Trouble BOOL OUT DI X 1=Specified trouble condition active
67 Trouble_Desc STRING Local UDA Active trouble description
1=Block has produced new fault that has
68 UnackedAlarm BOOL OUT
not been ackowledged/reset

NEORSD_OL_Valve_Analog.doc Page 8 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Valve_Analog

1.3.2 Derived from - $NEORSDUserDefined/$Valve_Analog_Indicator

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) Decimal – Defined as how many decimal points are shown. The default value
is 0 and need to be specified on the instance.

3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Interlock1 to Interlock5
b. OOS
c. OOS_CMD
d. Fault
e. Auto
f. REM
g. Position_CMD

Note: The default Engineering Units for Position is %. This can be changed but
is not required.

NEORSD_OL_Valve_Analog.doc Page 9 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.3.6 Faceplates
Valve_Analog_Faceplate
11
1
2
3 12
4 13

8 14

10

Graphic Design Element


Number
Function Description
1 Tag Name Displays the object name
Provides navigation to the other sections of the faceplate. The Status tab will animate if
2 Tabs
there is a fault, trouble or an interlock active.
Indicates the current mode. Allows for the toggling between automatic and manual
states. This button is only selectable when the logged in user has proper control level
Automatic and access. If the user is not logged in with the proper control level access the switch is not
3
Manual Switch selectable and becomes grey indicating it is not selectable. Regardless if the user is
logged in with the proper control level the switch will indicate the current state of the
mode.
4 Remote Indicates the valve is in remote mode.
5 Position Indicates the analog position of the valve
The display (to the right of the button) indicates the current target setpoint. This button is
only selectable when the logged in user has proper control level access, the mode is
manual, the valve is in remote, Interlock is not active, and OOS is not active. If any of
6 Setpoint
those conditions are not met the button will be disabled and the text will appear grey
indicating it is not selectable. If those conditions are met, pressing the Setpoint button
will display an entry box that can be used to set the value.

NEORSD_OL_Valve_Analog.doc Page 10 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

Graphic Design Element


Number
Function Description
7 Opened Indicates if the valve is considered open
8 Closed Indicates if the valve is considered closed
This button is only selectable when the logged in user has proper control level access.
If the user is not logged in with the proper control level access the switch is not
9 Out of Service selectable and becomes grey indicating it is not selectable. Pressing the OOS button
will put the motor in out of service mode. The light is visible regardless if the conditions
are met and is bright red when out of service and dark when not out of service.
Indicates the valve is in interlock mode. Interlock mode prevents the opening or closing
10 Interlock
of the valve.
11 Close Button Pressing this button closes the faceplate display.
12 Fault Indicates if the valve is in fault.
13 Interlocks Indicates which of the configured interlock is active.
14 Trouble Indicates if the object is in trouble and shows the trouble description message below

1.3.7 Graphic Symbols

Analog_Valve Analog_Gate

Auto_Rem

Analog_Position_Display Indicator_TxtStatus
**

Analog_Damper_Basic Analog_Flow_Control_Valve

Analog_Vert_Meter
Analog_ISA_Gate Analog_Horz_Meter

** Blue background on position display indicates operator action possible.

NEORSD_OL_Valve_Analog.doc Page 11 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

Analog_Vert_Meter_RO Analog_Horz_Meter_RO Analog_Gate_RO

Analog_ISA_Gate_RO

Analog_Flow_Control_Valve_RO Analog_Valve_RO Analog_Position_Display_RO

Analog_Damper_Basic_RO Indicator_TxtStatus_RO

NEORSD_OL_Valve_Analog.doc Page 12 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary. To aid in configuration, the following
fault notes explain what settings trigger the internal alarms that set the Fault bit.
Failure to Open/Close Fault – Commanded to full open/close value (configured) AND no
open/close feedback (limit switch only) within the delay time (configured).
Partial Open Fault – Commanded away from full open or close position (with deadband)
AND open or closed feedback (Limit switch) is still true after the delay time (configured).
Loss of Feedback Fault – No open or closed feedback AND configured for wired-failsafe,
after the delay time (configured).
Command/Feedback Mismatch Fault – Commanded position does not match the analog
feedback (plus deadband) after the delay time (configured).
When Fault is triggered, the output remains unchanged.
Interlock alarms force the output to the fail-safe mode.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Valve_Analog.doc Page 13 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
Keypad Assignment (For Display
4
Only)
5 Interlock 1 Description
6 Interlock 2 Description
7 Interlock 3 Description
8 Interlock 4 Description
9 Interlock 5 Description

NEORSD_OL_Valve_Analog.doc Page 14 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.5.2 Faceplates

FP_VALVE_ANALOG

1
2
3

5 4

9
8

10

Graphic Design Element


Number Function Description
1 Display Name Displays the object name
2 Device Description Displays the configured device description
Provides navigation to the other sections of the faceplate; restricted to higher
3 Tabs
level access.
4 Mode Display Indicates the current mode (Auto/Manual, Remote/Local, OOS).
5 Limit Switches Displays the state of the limit switch if configured.
Analog position is indicated by the colored portion of the graph. Command
6 Bar Graph
setpoints indicated by the pointer.
7 Setpoint Entry Allows editing the command setpoint. Analog feedback is displayed below.
8 Mode Selection Allows toggling the mode between Auto and Manual.
Indicates when an Interlock or Trouble or Fault is active. If the object is
9 Status configured to latch the alarm, the Reset button is visible. The alarms latch
must be cleared before the device can restart.
10 Exit Button Used to close the faceplate display.

NEORSD_OL_Valve_Analog.doc Page 15 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

FP_VALVE_ANALOG_DETAIL

1 2
3

Graphic Design Element


Number Function Description
1 Object Configurations Displays various object PLC configuration settings.
2 Instruction Fault Indicates a PLC configuration error.
Allows the user, with appropriate clearance, to place the device out of
3 Out of Service
service. The status is displayed as Active or Not Active.

NEORSD_OL_Valve_Analog.doc Page 16 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

FP_VALVE_ANALOG_STATUS

2
3

Graphic Design Element


Number Function Description
1 Interlock Status Displays the status for the configured Interlocks.
2 Trouble Displays the Trouble indication and Trouble message.
3 Fault Status Displays the active faults.

NEORSD_OL_Valve_Analog.doc Page 17 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog

1.5.3 Graphic Symbols


Note: Two sizes are offered to fit most applications.

NEORSD_OL_Valve_Analog.doc Page 18 of 18 Revision: 1.7.0


Title: NEORSD Standard Object Library - Valve Analog Indicator

NEORSD Standard Object Library

Valve Analog Indicator

NEORSD_OL_Valve_Analog_Indicator.
Page 1 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 02-Feb-2011 PSIM All Issue for Use
1.1.0 04-Apr-2011 PSIM 1.3.7 Added Indicator_TxtStatus graphic symbol
Inserted OIT graphical symbols for damper and
1.2.0 04-May-2011 PSIM 1.5.3
generic open/close status.
Added new attribute Inp_PLC_STATUS to Object
1.2.0 04-May-2011 PSIM 1.2.1
Attribute List.
Inserted Wonderware graphics
1.3.0 13-May-2011 PSIM 1.3.7 Indicator_Damper_Basic and
Indicator_Flow_Control_Valve.
1.4.0 03-June-2011 PSIM 1.3.7 Inserted Wonderware graphic Indicator_Vert_Meter.
Inserted Wonderware graphics Indicator_ISA_Gate
1.5.0 29-June-2011 PSIM 1.3.7
and Indicator_Horz_Meter.
Added new attribute Inp_ExternalFault to Object
1.6.0 14_Dec_2011 PSIM 1.2.1
Attribute List.
Extended attribute Trouble_Desc default destination
1.6.0 14-Dec-2011 PSIM 1.3.4
is now Me.Placeholder
1.6.0 14-Dec-2011 PSIM 1.4.1 Updated Ladder and Function Block

NEORSD_OL_Valve_Analog_Indicator.
Page 2 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

Table of Contents:
1.0 VALVE ANALOG INDICATOR.................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Indications................................................................................................................... 4
1.1.2 Alarming ..................................................................................................................... 4
1.1.3 Simulation ................................................................................................................... 4
1.1.4 Trouble ........................................................................................................................ 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 6
1.3.1 Hierarchical Name - $Valve_Analog_Indicator ......................................................... 6
1.3.2 Derived from - $NEORSDUserDefined ...................................................................... 6
1.3.3 Container - None......................................................................................................... 6
1.3.4 Extensions ................................................................................................................... 6
1.3.5 Instance Configuration ............................................................................................... 6
1.3.6 Faceplates ................................................................................................................... 7
1.3.7 Graphic Symbols ......................................................................................................... 8
1.4 CONTROLLOGIX PLC....................................................................................................... 9
1.4.1 Available Languages ................................................................................................... 9
1.5 PANELVIEW OIT............................................................................................................ 10
1.5.1 Object Instance ......................................................................................................... 10
1.5.2 Faceplates ................................................................................................................. 10
1.5.3 Graphic Symbols ....................................................................................................... 10

NEORSD_OL_Valve_Analog_Indicator.
Page 3 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

1.0 Valve Analog Indicator


The valve analog indicator template provides a standard method for indicating the status and
alarming for monitored-only analog valves throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Indications
Analog position feedback may be linked to the object, as well as limit switch
inputs (full open, full closed) if available.

The Wired-Failsafe parameter that should be configured when using limit


switches. This setting should match the field wiring. A valve wired failsafe will
indicate a “0” at its limit, and a “1 when not at it limit.

1.1.2 Alarming
This object supports a common alarm indicator (Fault). Configuration parameters
allow for customizing the fail open/close times, the deadband used in command to
feedback comparison, the partial open times, and the timeout for loss of limit
switch feedback.

1.1.3 Simulation
This object can provided simulated feedback of a working valve while disabling
outputs.

1.1.4 Trouble
This object supports hardware trouble indication. The text string for the trouble
description must be mapped to a user defined tag and configured in the object.

NEORSD_OL_Valve_Analog_Indicator.
Page 4 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
Delay before fault if both failsafe
2 Cfg_FBFailTime DINT IN feedbacks lose input (only checked
when FBWiredFailsafe is active)
1=Closed/Open limit switches are wired
3 Cfg_FBWiredFailsafe BOOL IN
failsafe
Valve Position at which valve is
4 Cfg_FullClosedPosition REAL IN considered Fully Closed (no deadband)
when not using limit switches.
Valve Position at which valve is
5 Cfg_FullOpenPosition REAL IN considered Fully Open (no deadband)
when not using limit switches.
Deadband around Fully Closed/Open
6 Cfg_PartialOpenDeadband REAL IN Position Settings to prevent false Partial
Open Faults
7 Cfg_Sim BOOL IN 1=Simulate position feedback
1=Valve Closed LS should be used for
8 Cfg_UseClosedLS BOOL IN
failure checking
1=Valve Open LS should be used for
9 Cfg_UseOpenLS BOOL IN
failure checking
10 Closed BOOL OUT DI X 1=Valve is confirmed fully Closed
Number of configured decimal places
11 Decimal DINT IN UDA
configured on output value (Position)
Enable Input - System Defined
12 EnableIn BOOL IN
Parameter
Enable Output - System Defined
13 EnableOut BOOL OUT
Parameter
14 Fault BOOL OUT DI X 1 = Alarm Active; clears automatically
Valve Closed Limit Switch 1=confirmed
15 Inp_ClosedLS BOOL IN
CLOSED
1=External Fault Condition Active. Faults
16 Inp_ExternalFault BOOL IN
Valve Object
Valve Open Limit Switch 1=confirmed
17 Inp_OpenLS BOOL IN
OPEN
CLX InOut Paramter – PLC_STATUS
PLC_ IO
18 Inp_PLC_STATUS STATUS Param
reference for setting Inp_TroubleActive
and Inp_SimActive
Actual valve position from field
19 Inp_PositionFB REAL IN
measurement
Device position to display while in
20 Inp_SimValue DINT IN
simulate mode
21 Inp_Trouble BOOL IN Trouble indication
CLX InOut Parameter: Use a Unique
IO
22 Inp_Trouble_Desc STRING
Param
Tag to Hold the Trouble Description
String
23 InstructFault BOOL OUT 1=Config Has Generated an Error

NEORSD_OL_Valve_Analog_Indicator.
Page 5 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
24 Opened BOOL OUT DI X 1=Valve is confirmed fully Opened
AI Valve position feedback for display on
25 Position REAL OUT
Float
X
the HMI
26 Sim BOOL OUT 1=Simulation Active
27 Trouble BOOL OUT DI X 1=Specified trouble condition active
28 Trouble_Desc STRING Local UDA Active trouble description

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Valve_Analog_Indicator

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
Trouble_Desc Me.Placeholder

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) Decimal – Defined as how many decimal points are shown. The default value
is 0 and need to be specified on the instance.

3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Fault

Note: The default Engineering Units for Position is %. This can be changed per
instance if required.

NEORSD_OL_Valve_Analog_Indicator.
Page 6 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

1.3.6 Faceplates
Valve_Analog_Indicator_Faceplate

1
2

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tagname Displays the object name
3 Position Indicates the current position of the valve
4 Fault Indicates if the valve is in fault
5 Opened Indicates if the valve is considered open
6 Closed Indicates if the valve is considered closed
7 Trouble Indicates if the object is in trouble and shows the trouble description message below

NEORSD_OL_Valve_Analog_Indicator.
Page 7 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

1.3.7 Graphic Symbols

Indicator_Position_Display Indicator_Valve Indicator_Gate

Indicator_TxtStatus

Indicator_Damper_Basic Indicator_Flow_Control_Valve

Indicator_ISA_Gate Indicator_Horz_Meter

Indicator_Vert_Meter

NEORSD_OL_Valve_Analog_Indicator.
Page 8 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary. To aid in configuration, the following
fault notes explain what settings trigger the internal alarms that set the Fault bit.
Failure to Open/Close Fault – Commanded to full open/close value (configured) AND no
open/close feedback (limit switch only) within the delay time (configured).
Partial Open Fault – Commanded away from full open or close position (with deadband)
AND open or closed feedback (Limit switch) is still true after the delay time (configured).
Loss of Feedback Fault – No open or closed feedback AND configured for wired-failsafe,
after the delay time (configured).
Command/Feedback Mismatch Fault – Commanded position does not match the analog
feedback (plus deadband) after the delay time (configured).

1.4.1 Available Languages


1. Relay Ladder– Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Valve_Analog_Indicator.
Page 9 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Analog Indicator

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description

1.5.2 Faceplates
No faceplates are currently configured for the Valve Analog Indicator display.

1.5.3 Graphic Symbols


Note: Two sizes are offered to fit most applications.

NEORSD_OL_Valve_Analog_Indicator.
Page 10 of 10 Revision: 1.6.0
doc
Title: NEORSD Standard Object Library - Valve Discrete

NEORSD Standard Object Library

Valve Discrete

NEORSD_OL_Valve_Discrete.doc Page 1 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 31-Jan-2011 PSIM All Issue for Use
Updated OIT faceplates to include longer interlock
1.1.0 20-Apr-2011 PSIM 1.5.2
description field length.
Inserted OIT graphical symbols for damper and
1.1.0 20-Apr-2011 PSIM 1.5.3
generic open/close status.
Added new attribute Inp_PLC_STATUS to Object
1.2.0 04-May-2011 PSIM 1.2.1
Attribute List.
1.3.0 13-May-2011 PSIM 1.3.5 Updated instance visibility configuration.
Inserted Wonderware graphic
1.3.0 13-May-2011 PSIM 1.3.7
Discrete_Damper_Basic.
1.4.0 03-June-2011 PSIM 1.3.7 Inserted Wonderware graphic Discrete_ISA_Gate.
Removed Direction attribute, added Opening and
1.5.0 14-June-2011 PSIM 1.2.1
Closing attributes
Added PulseTime and TriggerTime UDAs to Object
1.6.0 29-June-2011 PSIM 1.2.1
Attributes List.
Inserted Wonderware graphic
1.7.0 19-Aug-2011 PSIM 1.3.7
Discrete_BladderValve.
Added new attribute ExternalFault,
1.8.0 14-Dec-2011 PSIM 1.2.1 Cfg_OutputPulseTime, Inp_ExternalFault,
Out_Close, and Out_Open to Object Attribute List.
1.8.0 14-Dec-2011 PSIM 1.3.7 Inserted Wonderware graphics w/o Faceplates (_RO).
1.8.0 14-Dec-2011 PSIM 1.4.1 Updated Ladder and Function Block
1.8.0 14-Dec-2011 PSIM 1.5.2 Updated OIT faceplates
1.8.0 14-Dec-2011 PSIM 1.5.3 Updated standard Valve Discrete symbols

NEORSD_OL_Valve_Discrete.doc Page 2 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

Table of Contents:
1.0 VALVE DISCRETE ......................................................................................................... 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Standard Controls ....................................................................................................... 4
1.1.2 Indications................................................................................................................... 4
1.1.3 Alarming ..................................................................................................................... 4
1.1.4 Simulation ................................................................................................................... 4
1.1.5 Trouble ........................................................................................................................ 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ................................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 8
1.3.1 Hierarchical Name - $Valve_Discrete........................................................................ 8
1.3.2 Derived from - $NEORSDUserDefined/$Valve_Discrete_Indicator ......................... 8
1.3.3 Container - None......................................................................................................... 8
1.3.4 Extensions - None ....................................................................................................... 8
1.3.5 Instance Configuration ............................................................................................... 8
1.3.6 Faceplates ................................................................................................................... 9
1.3.7 Graphic Symbols ....................................................................................................... 11
1.4 CONTROLLOGIX PLC..................................................................................................... 13
1.4.1 Available Languages ................................................................................................. 13
1.5 PANELVIEW OIT............................................................................................................ 14
1.5.1 Object Instance ......................................................................................................... 14
1.5.2 Faceplates ................................................................................................................. 15
1.5.3 Graphic Symbols ....................................................................................................... 18

NEORSD_OL_Valve_Discrete.doc Page 3 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.0 Valve Discrete


The valve discrete template provides a standard method for controlling the operation,
indication, and alarming of discrete valves throughout the NEORSD MCS systems.

1.1 Object Features

1.1.1 Standard Controls


This object supports the following standard device control elements and
indications:
Local – Device controlled at local control station, outside of PLC logic.
Remote Manual – Device controlled by operator via faceplates and PLC.
Remote Auto – Device controlled by PLC logic.
OOS – Device is out of service and alarms are disabled.

When configured to use limit switch feedback, a fault causes the object to fail to
manual mode. Device can be configured to fail open (energize to close) or fail
closed (energize to open, default).
The object allows for as many as five custom interlocks to be connected through
external logic. Interlocks prevent device operation.

1.1.2 Indications
Opened and Closed feedback indicators.

This object also features a Wired_Failsafe UDA. This setting should match the
field wiring. A valve wired failsafe will indicate a “0” at its limit, and a “1 when
not at it limit. If both Opened and Closed inputs are off, and Wired_Failsafe is
true, then the valve has failed and the Fault indicator is activated.

This object contains command-direction indication for display purposes


(0=stopped, 1=opening, 2=closing).

1.1.3 Alarming
This object supports a common alarm indicator (Fault). Fault is disabled in local
mode.

1.1.4 Simulation
This object support simulation of discrete valve operation.

1.1.5 Trouble
This object supports hardware trouble indication. The text string for the trouble
description must be mapped to a user defined tag and configured in the object.

NEORSD_OL_Valve_Discrete.doc Page 4 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Auto BOOL OUT DI X 1=Auto Mode Active
2 Auto_CMD BOOL IN DO X HMI command to place valve in Auto
Delay before fault after commanded
3 Cfg_CloseTime DINT IN
close and feedback not received
4 Cfg_DisableAlarming BOOL IN 1=Disables open and close fault alarms
1=Fail Open (energize to close), 0=Fail
5 Cfg_FailOpen BOOL IN
Closed (energize to open)
Delay before device fault is reset if not
6 Cfg_FaultActiveTime DINT IN configured to latch
Delay before fault if failsafe feedbacks
7 Cfg_FBFailTime DINT IN
fault
1=Closed/Open limit switches are
8 Cfg_FBWiredFailsafe BOOL IN
wired failsafe
1=Require HMI Reset_CMD toggle to
9 Cfg_LatchFault BOOL IN reset fault, 0 =Automatically clear fault
after configurable delay
1=Manual only device, device cannot
10 Cfg_ManOnlyDevice BOOL IN
be placed in auto
Delay before fault after commanded
11 Cfg_OpenTime DINT IN
open and feedback not received
Time in seconds pulsed outputs are
12 Cfg_OutputPulseTime DINT IN held active (unless limit switch is met).
Enter 0 to maintain outputs.
1=Simulate working valve;
13 Cfg_Sim BOOL IN
0=Open/Close/ Monitor actual valve
1=Valve Closed LS should be used for
14 Cfg_UseClosedLS BOOL IN
failure checking
1=Valve Open LS should be used for
15 Cfg_UseOpenLS BOOL IN
failure checking
1=Valve has LOCAL/OFF/REMOTE
16 Cfg_UseRemote BOOL IN
control
HMI command to close valve while in
17 Close_CMD BOOL IN DO X
Manual
18 Closed BOOL OUT DI X 1=Valve is confirmed Closed
1=Valve has been commanded close
19 Closing BOOL OUT DI
and has not reached the closed limit
Enable Input - System Defined
20 EnableIn BOOL IN
Parameter
Enable Output - System Defined
21 EnableOut BOOL OUT
Parameter
22 ExternalFault BOOL OUT Updated standard Analog symbols
23 Fault BOOL OUT DI X 1=Fault open or close alarm active
24 Inp_AutoCMD BOOL IN Program Command to Open Valve
Valve Closed Limit Switch 1=confirmed
25 Inp_ClosedLS BOOL IN
CLOSED
26 Inp_ExternalFault BOOL IN Updated standard Analog symbols
1=Interlock condition 1 active, do not
27 Inp_Interlock1 BOOL IN
permit operation

NEORSD_OL_Valve_Discrete.doc Page 5 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1=Interlock 2 condition active, do not
28 Inp_Interlock2 BOOL IN
permit operation
1=Interlock 3 condition active, do not
29 Inp_Interlock3 BOOL IN
permit operation
1=Interlock 4 condition active, do not
30 Inp_Interlock4 BOOL IN
permit operation
1=Interlock 5 condition active, do not
31 Inp_Interlock5 BOOL IN
permit operation
Valve Open Limit Switch 1=confirmed
32 Inp_OpenLS BOOL IN
OPEN
CLX InOut Paramter – PLC_STATUS
PLC_ IO
33 Inp_PLC_STATUS reference for setting Inp_TroubleActive
STATUS Param
and Inp_SimActive
LOCAL/OFF/REMOTE position
34 Inp_Remote BOOL IN
feedback (1=Valve in Remote)
35 Inp_Trouble BOOL IN Trouble indication
CLX InOut parameter – use a unique
IO
36 Inp_Trouble_Desc STRING tag to hold the trouble description
Param
string, that appears on the faceplate
37 InstructFault BOOL OUT 1=Config has generated an error
1=Interlock 1 active, operation not
38 Interlock1 BOOL OUT DI X
permitted
1=Interlock 2 active, operation not
39 Interlock2 BOOL OUT DI X
permitted
1=Interlock 3 active, operation not
40 Interlock3 BOOL OUT DI X
permitted
1=Interlock 4 active, operation not
41 Interlock4 BOOL OUT DI X
permitted
1=Interlock 5 active, operation not
42 Interlock5 BOOL OUT DI X
permitted
43 OOS BOOL OUT DI X 1=OOS (Out of Service) Mode Active
44 OOS_CMD BOOL IN DO X HMI command to place valve in OOS
45 Open_CMD BOOL IN DO X HMI command to open valve in Manual
46 Opened BOOL OUT DI X 1=Valve is confirmed Opened
1=Valve has been commanded open
47 Opening BOOL OUT DI
and has not reached the open limit
48 Out BOOL OUT 1=Energize Valve Solenoid
1=Open Valve (pulse), 0=Leave Valve
49 Out_Close BOOL OUT
in current state
1=Close Valve (pulse), 0=Leave Valve
50 Out_Open BOOL OUT
in current state
Amount of time (sec) the setpoint will
51 PulseTime FLOAT IN UDA
be written to the PLC before unlatch.
52 Rem BOOL OUT DI X 1=Valve is in Remote
53 ResetAlarm_CMD BOOL IN 1=Reset alarm command from HMI
54 Sim BOOL OUT 1=Simulation Active
55 Sts_Interlocked BOOL OUT 1 or more device interlocks are active
The current time, used in script with
56 TriggerTime TIME IN UDA
PulseTime for setpoint unlatch.
57 Trouble BOOL OUT DI X 1=Specified trouble condition active
58 Trouble_Desc STRING Local UDA Active trouble description by the HMI

NEORSD_OL_Valve_Discrete.doc Page 6 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1=New active alarm that has not been
59 UnackedAlarm BOOL OUT
acknowledged
1=Closed/Open limit switches are
60 Wired_Failsafe BOOL OUT UDA
wired failsafe

NEORSD_OL_Valve_Discrete.doc Page 7 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Valve_Discrete

1.3.2 Derived from - $NEORSDUserDefined/$Valve_Discrete_Indicator

1.3.3 Container - None

1.3.4 Extensions - None

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) Wired_Failsafe – Specify if this is a Wired_Failsafe valve. If it is, check the


True/False box on the Wired_Failsafe UDA on the UDA tab. If it is not then
no configuration is required.

3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Interlock1 to Interlock5
b. OOS
c. OOS_CMD
d. Fault
e. Auto
f. REM
g. Open_CMD
h. Close_CMD

NEORSD_OL_Valve_Discrete.doc Page 8 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.3.6 Faceplates
Valve_Discrete_Faceplate
9
1
10
2 11

4
12
5
6

7
13
8 14

Graphic Design Element


Number
Function Description
1 Tagname Displays the object name
Indicates the current mode. Allows for the toggling between automatic and
manual states. This button is only selectable when the logged in user has
Automatic and proper control level access. If the user is not logged in with the proper control
2
Manual Switch level access the switch is not selectable and becomes grey indicating it is not
selectable. Regardless if the user is logged in with the proper control level the
switch will indicate the current state of the mode.
3 Remote Indicates the valve is in remote mode.
This button is only selectable when the logged in user has proper control level
access, the mode is manual, REM is remote, Interlock is not active, and OOS
is not active. If any of those conditions are not met the button will be disabled
4 Open and the text will appear grey indicating it is not selectable. If the conditions are
met, pressing the Open button will open the valve. The light is visible
regardless if the conditions are met and is bright red when opened and dark
when not opened.
Arrows indicate the direction of the valve movement. Only visible while in
5 Transition Arrows
transition.

NEORSD_OL_Valve_Discrete.doc Page 9 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

Graphic Design Element


Number
Function Description
This button is only selectable when the logged in user has proper control level
access, the mode is manual, REM is remote, Interlock is not active, and OOS
is not active. If any of those conditions are not met the button will be disabled
6 Close and the text will appear grey indicating it is not selectable. If the conditions are
met, pressing the Close button will close the valve. The light is visible
regardless if the conditions are met and is bright green when closed and dark
when not closed.
This button is only selectable when the logged in user has proper control level
access. If the user is not logged in with the proper control level access the
switch is not selectable and becomes grey indicating it is not selectable.
7 Out of Service
Pressing the OOS button will put the motor in out of service mode. The light is
visible regardless if the conditions are met and is bright red when out of
service and dark when not out of service.
Indicates the valve is in interlock mode. Interlock mode prevents the opening
8 Interlock
or closing of the valve.
9 Close Button Pressing this button closes the faceplate display.
Provides navigation to the other pages of the faceplate. Status will animate
10 Tabs
when Fault or Interlocks or Trouble is active.
11 Fault Indicates the valve has faulted (failopen, failclose).
12 Interlock Indicates the status of the configured interlocks
13 Failsafe Indicates the valve is wired for failsafe indication (no feedback = fault)
Indicates if the valve is in trouble and shows the trouble description message
14 Trouble
below

NEORSD_OL_Valve_Discrete.doc Page 10 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.3.7 Graphic Symbols

Discrete_Valve Discrete_Valve_RO

Discrete_BladderValve Discrete_BladderValve_RO

Discrete_Damper Discrete_Damper_RO

Discrete_PEPS_Butterfly Discrete_PEPS_Butterfly_RO

Discrete_TextStatusPT_OPND Discrete_TextStatusPT_OPND_RO

NEORSD_OL_Valve_Discrete.doc Page 11 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

Discrete_ISA_Gate Discrete_ISA_Gate_RO

Discrete_PEPS_Butterfly_Horz Discrete_PEPS_Butterfly_Horz_RO

Discrete_Gate Discrete_Gate_RO

Auto_Rem

Discrete_Damper_Basic Discrete_Damper_Basic_RO

NEORSD_OL_Valve_Discrete.doc Page 12 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Valve_Discrete.doc Page 13 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description
4 Keypad Assignment (For Display Only)
5 Interlock 1 Description
6 Interlock 2 Description
7 Interlock 3 Description
8 Interlock 4 Description
9 Interlock 5 Description

NEORSD_OL_Valve_Discrete.doc Page 14 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.5.2 Faceplates
FP_VALVE_DISCRETE

1
2

6
5

8
7

Graphic Design Element


Number Function Description
1 Display Name Displays the object name.

2 Device Description User defined description text for display only.


Provides navigation to the other sections of the faceplate; restricted to higher level
3 Tabs
access.

4 Device Status Displays mode (Auto/Manual) and Out of Service (OOS).

5 Limit Switch Displays the state of the limit switches.

6 Open/Close Buttons to open or close the valve. Command state is indicated by the black triangle.

7 Mode Control Toggle the valve between Manual and Auto mode.

8 Alarm Indicators Lights indicate if a Fault, or Trouble or Interlock is active.

9 Exit Button Pressing this button closes the faceplate display.

NEORSD_OL_Valve_Discrete.doc Page 15 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

FP_VALVE_DISCRETE_DETAIL

1 2
3

Graphic Design Element


Number Function Description
1 Object Configurations Displays various object configuration settings within the PLC.

2 Instruction Fault Indicates a configuration error in the PLC.

3 Out of Service Status Indicates the device has been placed out of service (OOS).

NEORSD_OL_Valve_Discrete.doc Page 16 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

FP_VALVE_DISCRETE_STATUS

2
3

Graphic Design Element


Number Function Description
1 Interlock Status Displays the status for the configured Interlocks.
2 Trouble Displays the Trouble indication and Trouble message.
3 Fault Status Displays the active faults.

NEORSD_OL_Valve_Discrete.doc Page 17 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete

1.5.3 Graphic Symbols

NEORSD_OL_Valve_Discrete.doc Page 18 of 18 Revision: 1.8.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

NEORSD Standard Object Library

Valve Discrete Indicator

NEORSD_OL_Valve_Discrete_Indicator.doc Page 1 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

Revision History:
Revision Revision Date Author Updated Description
dd-Mmm-yyyy Section
1.0.0 01-Feb-2011 PSIM All Issue for Use
Inserted OIT graphical symbols for damper and
1.1.0 04-May-2011 PSIM 1.5.3
generic open/close status.
Added new attribute Inp_PLC_STATUS to Object
1.1.0 04-May-2011 PSIM 1.2.1
Attribute List.
Inserted Wonderware graphic
1.2.0 13-May-2011 PSIM 1.3.7
Indicator_Damper_Basic.
1.3.0 03-June-2011 PSIM 1.3.7 Inserted Wonderware graphic Indicator_ISA_Gate.
Added new attribute Inp_ExternalFault to Object
1.4.0 14-Dec-2012 PSIM 1.2.1
Attribute List.
Extended attribute Trouble_Desc default destination
1.4.0 14-Dec-2012 PSIM 1.3.4
is now Me.Placeholder
1.4.0 14-Dec-2012 PSIM 1.4.1 Updated Ladder and Function Block

NEORSD_OL_Valve_Discrete_Indicator.doc Page 2 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

Table of Contents:
1.0 VALVE DISCRETE INDICATOR ................................................................................. 4
1.1 OBJECT FEATURES ........................................................................................................... 4
1.1.1 Indications............................................................................................................... 4
1.1.2 Alarming ................................................................................................................. 4
1.1.3 Simulation ............................................................................................................... 4
1.1.4 Trouble .................................................................................................................... 4
1.2 OBJECT ATTRIBUTES........................................................................................................ 5
1.2.1 Table of Attributes & WW UDAs ............................................................................ 5
1.3 WONDERWARE HMI ........................................................................................................ 6
1.3.1 Hierarchical Name - $Valve_Discrete_Indicator ................................................... 6
1.3.2 Derived from - $NEORSDUserDefined .................................................................. 6
1.3.3 Container - None..................................................................................................... 6
1.3.4 Extensions ............................................................................................................... 6
1.3.5 Instance Configuration ........................................................................................... 6
1.3.6 Faceplates ............................................................................................................... 7
1.3.7 Graphic Symbols ..................................................................................................... 8
1.4 CONTROLLOGIX PLC....................................................................................................... 9
1.4.1 Available Languages ............................................................................................... 9
1.5 PANELVIEW OIT............................................................................................................ 10
1.5.1 Object Instance ..................................................................................................... 10
1.5.2 Faceplates ............................................................................................................. 10
1.5.3 Graphic Symbols ................................................................................................... 10

NEORSD_OL_Valve_Discrete_Indicator.doc Page 3 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.0 Valve Discrete Indicator


The valve discrete indicator template provides a standard method for handling the indication
and alarming of a field operated discrete valve, throughout the NEORSD MCS systems.
The object is not used to control the output of a valve.

1.1 Object Features

1.1.1 Indications
This object supports Opened and Closed feedback indicators.

This object also features a Wired_Failsafe UDA. This setting should match the
field wiring. A valve wired failsafe will indicate a “0” at its limit, and a “1 when
not at it limit. If both Opened and Closed inputs are off, and Wired_Failsafe is
true, then the valve has failed and the Fault indicator is activated.

1.1.2 Alarming
This object supports a common alarm indicator (Fault) based on detection of an
external valve command and feedback failures (limit switches). Fault time is
configurable. If the command state is unknown, alarming should be disabled.

1.1.3 Simulation
This object support simulation of discrete valve feedback.

1.1.4 Trouble
This object supports hardware trouble indication. The Trouble_Desc tag must be
configured.

NEORSD_OL_Valve_Discrete_Indicator.doc Page 4 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.2 Object Attributes

1.2.1 Table of Attributes & WW UDAs


AOI Wonderware

Direction

Direction

Alarm

Event
Data
Item

Hist
Attributes Type Notes
1 Cfg_DisableAlarming BOOL IN 1=Disables all fault alarms
Delay before fault if both failsafe feedbacks
2 Cfg_FBFailTime DINT IN
lose input
Delay before fault if both failsafe feedbacks
3 Cfg_FBWiredFailsafe BOOL IN
lose input
1=Simulate valve state based on
4 Cfg_Sim BOOL IN Inp_SimValue; 0=Monitor Open/Close Limit
Switches
1=Valve Closed LS should be used for
5 Cfg_UseClosedLS BOOL IN
failure checking
1=Valve Open LS should be used for failure
6 Cfg_UseOpenLS BOOL IN
checking
7 Closed BOOL OUT DI X 1=Valve is confirmed Closed
8 EnableIn BOOL IN Enable Input - System Defined Parameter
9 EnableOut BOOL OUT Enable Output - System Defined Parameter
10 Fault BOOL OUT DI X 1 = Alarm Active
Valve Closed Limit Switch 1=confirmed
11 Inp_ClosedLS BOOL IN
CLOSED
1=External Fault Condition Active. Faults
12 Inp_ExternalFault BOOL IN
Valve Object
Valve Open Limit Switch 1=confirmed
13 Inp_OpenLS BOOL IN
OPEN
CLX InOut Paramter – PLC_STATUS
PLC_ IO
14 Inp_PLC_STATUS STATUS Param
reference for setting Inp_TroubleActive and
Inp_SimActive
Device state (1=open) to display while in
15 Inp_SimValue BOOL IN
simulate mode
16 Inp_Trouble BOOL IN Trouble indication
IO CLX InOut Parameter: Use a Unique Tag
17 Inp_Trouble_Desc STRING
Param to Hold the Trouble Description String
18 InstructFault BOOL OUT 1=Config Has Generated an Error
1=Valve requested to open and is
19 Opened BOOL OUT DI X
confirmed Opened
20 Sim BOOL OUT 1=Simulation Active
21 Trouble BOOL OUT DI X 1=Specified trouble condition active
22 Trouble_Desc STRING Local UDA Active trouble description by the HMI
1=Closed/Open limit switches are wired
23 Wired_Failsafe BOOL OUT UDA
failsafe

NEORSD_OL_Valve_Discrete_Indicator.doc Page 5 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.3 Wonderware HMI

1.3.1 Hierarchical Name - $Valve_Discrete_Indicator

1.3.2 Derived from - $NEORSDUserDefined

1.3.3 Container - None

1.3.4 Extensions
Extended Attribute Destination Locked
Trouble_Desc Me.Placeholder

1.3.5 Instance Configuration


1) Alarm Priority – The attribute Fault needs to have a priority defined.

2) Wired_Failsafe – Specify if this is a Wired_Failsafe valve. If it is, check the


True/False box on the Wired_Failsafe UDA on the UDA tab. If it is not then
no configuration is required.

3) Attributes that are not used in the configured instance shall use
Me.Placeholder to eliminate the point from counting against the systems total
I/O scan counts. The allowed attributes for this template include the
following:
a. Fault

NEORSD_OL_Valve_Discrete_Indicator.doc Page 6 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.3.6 Faceplates
Valve_Discrete_Indicator_Faceplate

1
2

Graphic Design Element


Number
Function Description
1 Close Button Pressing this button closes the faceplate display.
2 Tag Name Displays the object name.
3 Opened Indicates if the valve is open.
4 Closed Indicates if the valve is closed.
5 Fault Indicates if the valve is in fault (commanded state does not match feedback).
6 Failsafe Indicates the status of the failsafe configuration parameter.
7 Trouble Indicates if the valve is in trouble and shows the trouble description message below.

NEORSD_OL_Valve_Discrete_Indicator.doc Page 7 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.3.7 Graphic Symbols

Indiactor_Valve Indicator_PEPS_Butterfly_Horz Indicator_PEPS_Butterfly

Indicator_TextStatusPT_OPND Indicator_Damper

Indicator_Damper_Basic

Indicator_ISA_Gate

Indicator_Gate

NEORSD_OL_Valve_Discrete_Indicator.doc Page 8 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.4 ControlLogix PLC


Set configuration parameters (cfg_) as necessary.

1.4.1 Available Languages

1. Relay Ladder – Manipulate object parameters with external logic.

2. Function Block – Enable/Disable additional parameters for access within


function block editor as required.

NEORSD_OL_Valve_Discrete_Indicator.doc Page 9 of 10 Revision: 1.4.0


Title: NEORSD Standard Object Library - Valve Discrete Indicator

1.5 PanelView OIT

1.5.1 Object Instance


Configure the global object properties as shown in the table below.
Name Description
1 PLC Tag
2 Display Name (Device Tag)
3 Device Description

1.5.2 Faceplates
No faceplates are currently configured for the Valve Discrete Indicator display.

1.5.3 Graphic Symbols

NEORSD_OL_Valve_Discrete_Indicator.doc Page 10 of 10 Revision: 1.4.0

Vous aimerez peut-être aussi