P AIn Analog Input

8/20/2019 P AIn Analog Input

1/64

Process Add-On Instructions and Graphics:

Basic Analog Input (P_AIn)

Reference Manual

Compatible with the Plant-wide Integrated Architecture™


2/64

Important User Information

Solid state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales officeor online at http://rockwellautomation.com.literature ) describes some important differences between solid state equipment and hard-wired

electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid state equipment, all persons responsible for applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or applicationof this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements as-sociated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the ex-

amples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described inthis manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

Allen-Bradley, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.

Trademarks not belonging to Rockwell Automation, Plant PAx Process Automation System, and TechConnect are property of their respective companies.

WARNING

Identifies information about practices or circumstances that can cause an explosion in a

hazardous environment, which may lead to personal injury or death, property damage, oreconomic loss.

IMPORTANT Identifies information that is critical for successful application and understanding of the product.

ATTENTIONIdentifies information about practices or circumstances that can lead to personal injury or death,

property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and

recognize the consequence.

SHOCK HAZARD Labels may be on or inside the equipment, for example, a drive or motor, to alert people that

dangerous voltage may be present.

BURN HAZARD Labels may be on or inside the equipment, for example, a drive or motor, to alert people that

surfaces may reach dangerous temperatures.


3/64

iiiPublication SYSLIB-RM001C-EN-E - Month Year - October 2011 iii

Summary of Changes

Introduction This release of this document is updated throughout for version 2.0 of the Analog Input (P_AIn) Add-On Instruction and Graphics. Please refer to theRelease Notes that are distributed with version 2.0 of the Library.

Updated Information This document contains the following changes:

Change: See:

Version 2.0 of instruction All


4/64

iv Publication SYSLIB-RM001C-EN-E - October 2011

Summary of Changes

Notes:


5/64

vPublication SYSLIB-RM001C-EN-E - October 2011 v

Table of Contents

Preface Use of this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Conventions and Related Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Set and Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Edge and Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Relay Ladder Rung Condition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixPre-Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xFunction Block States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Entering Text in FactoryTalk View SE. . . . . . . . . . . . . . . . . . . . . . xii

Chapter 1

Overview Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Primary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Revision Compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Chapter 2

Configuration Options Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 3

Instruction Data Reference Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Inputs (Inp_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configurations (Cfg_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Program Settings (PSet_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Program Commands (PCmd_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Device Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Operator Settings, Maintenance Settings, Other Settings (OSet_, MSet_, Set_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Operator / Maintenance Setting Readies . . . . . . . . . . . . . . . . . . . . 21Operator Commands, Maintenance Commands, Command Readies (OCmd_, MCmd_, Rdy_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Device Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Mode Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Alarm Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Values (Val_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Status (Sts_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Mode Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Alarm Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30


6/64

vi Publication SYSLIB-RM001C-EN-E - October 2011

Table of Contents

Chapter 4

HMI Reference Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Using Graphics Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Alarm Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Analog Input Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50


7/64

viiPublication SYSLIB-RM001C-EN-E - October 2011 vii

Preface

Use of this Document This document provides a programmer with details on the P_AIn instructionfor a Logix-based controller. You should already be familiar with how theLogix-based controller stores and processes data.

Novice programmers should read all the details about an instruction beforeusing the instruction. Experienced programmers can refer to the instructioninformation to verify details.

Conventions and RelatedTerms

Set and Clear

This manual uses set and clear to define the status of bits (booleans) and values(non-booleans):

This term: Means:

Set The bit is set to 1 (ON) A value is set to any non-zero number

Clear The bit is cleared to 0 (OFF) All the bits in a value are cleared to 0


8/64

viii Publication SYSLIB-RM001C-EN-E - October 2011

Preface

Edge and Level

This manual uses Edge and Level to describe how bit (BOOL) Commands,Settings, Configurations, and Inputs to this instruction are sent by other logic

and processed by this instruction.

Send/Receive Method: Description:

Edge • Action is triggered by ‘rising edge’ transition of input (0-1)

• Separate inputs are provided for complementary functions(such as ‘enable’ and ‘disable’)

• Sending logic SETS the bit (writes a 1) to initiate theaction; this instruction CLEARS the bit (to 0) immediately,then acts on the request, if possible

• Ladder Diagram (LD): use conditioned OTL (Latch) to send

• Structured Text (ST): use conditional assignment [if

(condition) then bit:=1;] to send• Function Block Diagram (FBD): OREF writes a 1 or 0 every

scan, should use Level, not Edge

Edge-triggering allows multiple senders per Command,Setting, Configuration, or Input (many-to-one relationship).

Level • Action (‘enable’) is triggered by input being at a level ( in astate, usually 1)

• Opposite action (‘disable’) is triggered by input being inopposite state (0)

• Sending logic SETS the bit (writes a 1) or CLEARS the bit(writes a 0); this instruction does not change the bit

• LD: use OTE (Energize) to send

• ST: use unconditional assignment[bit:= expression_resulting_in_1_or_0;] or‘if-then-else’ logic [if (condition) then bit:= 1; else bit:= 0;]

• FBD: use OREF to the input bit

Level triggering allows only one sender to drive each Levelinput on the instruction (one-to-one relationship restriction).

IMPORTANT All Operator Commands (OCmd_) and Maintenance Commands(MCmd_) are Edge triggered. The HMI Graphic Symbol orFaceplate SETS (writes a 1 to) each Command bit and theInstruction CLEARS (writes a 0 to) the Command bit, then

performs the function, if possible.


9/64

Publication SYSLIB-RM001C-EN-E - October 2011 ix

Preface

Relay Ladder Rung Condition

The controller evaluates ladder instructions based on the rung conditionpreceding the instruction (rung-in condition). Based on the rung-in condition

and the instruction, the controller sets the rung condition following theinstruction (rung-out condition), which in turn, affects any subsequentinstruction.

If the rung-in condition to an input instruction is true, the controller evaluatesthe instruction and sets the rung-out condition based on the results of theinstruction. If the instruction evaluates to true, the rung-out condition is true;if the instruction evaluates to false, the rung-out condition is false.

IMPORTANT This instruction has Program Commands (PCmd_) which areselectable as Edge or Level, depending on the ConfigurationParameter Cfg_PCmdClear. If Cfg_PCmdClear is 1 (the default),all Program Commands are CLEARED when received (edge). If

Cfg_PCmdClear is 0, Program Commands as noted in theInstruction Data Reference become Level triggered, andopposite functions are triggered by the primary ProgramCommand being CLEARED to 0.

IMPORTANT The rung-in condition is reflected in the EnableIn parameter anddetermines how the system performs each Process Add-OnInstruction. If the EnableIn signal is TRUE, the system performsthe instruction’s main logic routine. Conversely, if the EnableInsignal is FALSE, the system performs the instruction’sEnableInFalse routine.

The instruction’s main logic routine sets/clears the EnableOutparameter, which then determines the rung-out condition. TheEnableInFalse routine cannot set the EnableOut parameter. Ifthe rung-in condition is FALSE, then the EnableOut parameterand the rung-out condition will also be FALSE.


10/64

x Publication SYSLIB-RM001C-EN-E - October 2011

Preface

Pre-Scan

During the transition into RUN, the controller performs a Pre-scan before thefirst logic scan. Pre-scan is a special scan of all routines in the controller. The

controller scans all main routines and subroutines during Pre-scan, but ignoresjumps that could skip the execution of instructions. The controller executes allFOR loops and subroutine calls. If a subroutine is called more than once, it isexecuted each time it is called. The controller uses Pre-scan instructions toreset non-retentive data values.

During Pre-scan, input values are not current and outputs are not written. Thefollowing conditions generate Pre-scan:

• toggle from Program to Run mode.

• automatically enter Run mode from a power-up condition.

Pre-scan does not occur for a program when:

• the program becomes scheduled while the controller is running.

• the program is unscheduled when the controller enters Run mode.

IMPORTANT The Pre-scan process performs the Process Add-On Instruction’slogic routine as all FALSE and then performs its Pre-scanroutine as TRUE.


11/64

Publication SYSLIB-RM001C-EN-E - October 2011 xi

Preface

Function Block States

The controller evaluates function block instructions based on the state ofdifferent conditions.

Every function block instruction also includes EnableIn and EnableOutparameters.

If the EnableIn parameter is not wired, the instruction always executes asnormal and EnableIn remains set. If you clear EnableIn, it changes to set thenext time the instruction executes.

Possible Condition: Description:

Pre-scan Pre-scan for function block routines is the same as for relayladder routines. The only difference is that the Enablelnparameter for each function block instruction is cleared duringPre-scan.

Instruction first scan Instruction first scan refers to the first time an instruction isexecuted after Pre-scan. The controller uses instruction firstscan to read current inputs and determine the appropriatestate to be in.

Instruction first run Instruction first run refers to the first time the instructionexecutes with a new instance of a data structure. The

controller uses instruction first run to generate coefficientsand other data stores that do not change for a function blockafter initial download.

IMPORTANT When programming in function block, restrict the rangeof engineering units to ±10±15 because internal floatingpoint calculations are done using single precision floatingpoint. Engineering units outside of this range may result ina loss of accuracy if results approach the limitations of

single precision floating point (±10±38 ).


12/64

xii Publication SYSLIB-RM001C-EN-E - October 2011

Preface

Entering Text in FactoryTalk View SE

When entering data into String Input fields in FactoryTalk View SE, the data isnot saved to the tag until the user presses the Enter key. When the Input Field

is enabled, its border changes based on the state of the input:

• When the Input Field is Active (the cursor is in the field), the Input Field border is a

solid line.

• If the user modifies the data in the input field and moves to a different field without

pressing the Enter key, the border remains a solid line indicating that the data has not

been saved to the tag.

• If the data in the Input Field has not changed or has been written to the controller

tag, the border is a dashed line.

EXAMPLE

EXAMPLE

EXAMPLE


13/64

1Publication SYSLIB-RM001C-EN-E - October 2011 1

Chapter 1

Overview

The Analog Input Add-On Instruction is used to monitor one analog value,typically from a channel of an analog input module, and provide alarms whenthe analog value exceeds user-specified thresholds (high and low). The AnalogInput Instruction also provides capabilities for linear scaling of an analog input value from ‘raw’ (input) units to ‘engineering’ (output) units, and entry of aSubstitute Process Variable, providing handling of an out-of-range or faultedinput.

In order to keep the Instruction memory and execution footprint small,certain capabilities, used less frequently, are reserved for the Advanced AnalogInput Add-On Instruction. Refer to the Advanced Analog Input (P_AInAdv)Reference Manual, publication SYSLIB-RM018, for more information.

Use when:

• You want to display a temperature, flow, pressure, level, or other signalfrom a single field instrument on your HMI.

• You need any of the Scaling, Alarming, or HMI features for a single Analog Input, or any Analog (quantity) value.

•Linear scaling from raw to engineering units.

•High, Low, High-High, Low-Low, and Out of Range Alarms (with

deadband, On-Delay and Off-Delay per alarm).

•Indicator graphic object with label and engineering units.

•Faceplate with mode selection, status threshold entry, andMaintenance capability for substitute PV.

Do NOT use when:

• The analog input signal works with another instruction. For example,the Speed Feedback for a variable speed drive is completely handled bythe P_VSD Instruction. It is not necessary to use the P_AIn instructionfirst. Wire or map the input directly to P_VSD.

• You only need to display a number on a screen and do not need any ofthe scaling or alarming features. (Just use a numeric display field.)

• You need advanced capabilities such as square root extraction (forexample, orifice flow meters), rate-of-change alarming or limiting, oralarming for deviation from a reference value. Use the P_AInAdv(Advanced Analog Input) Instruction instead.

• You have dual sensors for one process variable (such as dual pH meters)and need to select one or the other sensor (or their average). Use theP_AInDual (Dual Analog Input) Instruction instead.


14/64

2 Publication SYSLIB-RM001C-EN-E - October 2011

Chapter 1 Overview

• You have more than two sensors for one process variable and need touse the average or median sensor value. Use the P_AInMulti (Multiple Analog Input) Instruction instead.

Functional Description The primary functions of scaling to engineering units and providing inputalarms are depicted in the following figure:

Primary Operations The primary operations of the Analog Input Add-On Instruction are:

• Scales an analog input from raw to engineering units and optionallyfilters the signal.

• Provides High-High, High, Low and Low-Low status and alarms withconfigurable Delay Times and Deadbands

• Provides Program and Operator Settings for Status Thresholds

• Provides Input failure checking for Out of Range High and Out ofRange Low, plus PV quality and alarm on failure.

• Provides Maintenance selection of the Substitute PV function to allowmanual override of the Input signal (PV)

• Monitors Input communication status and provides indication of stalePV (Sts_PVBad) or uncertain PV (Sts_PVUncertain).

• Uses a standard Mode model (P_Mode instruction) to provide Mode(ownership) selection. See the ‘Operating Modes’ section for moreinformation.


15/64

Publication SYSLIB-RM001C-EN-E - October 2011 3

Overview Chapter 1

Operating Modes The following standard Modes, implemented using the P_Mode Add-OnInstruction, are used by the Analog Input Add-On Instruction.

The following standard Modes are not used:

• Hand Mode

• Override (Ovrd) Mode

Refer to the Process Add-On Instructions and Graphics: Mode (P_Mode)Reference Manual, publication SYSLIB-RM005, for more information.

Alarms The following Alarms, implemented using the P_Alarm Add-On Instruction,are used by the Analog Input Add-On Instruction.

Each alarm has a configurable deadband for return to normal, and eachthreshold alarm has configurable on-delay and off-delay times. (The PV qualityalarms are immediate.)

Refer to the Process Add-On Instructions and Graphics: Alarm (P_Alarm)Reference Manual, publication SYSLIB-RM002, for more information.

Mode Description

Operator Commands and Settings accepted from the Operator via the HMI.Program Commands and Settings accepted from other logic.

Maintenance The Substitute PV function may be Enabled or Disabled; normalOperator Commands and Settings are accepted from theOperator via the HMI.

Alarm Description

High-High PV PV above High-High threshold. Threshold is set by Operator orProgram. Deadband and Severity are set in Configuration.

High PV PV above High threshold. Threshold is set by Operator or Program.Deadband and Severity are set in Configuration.

Low PV PV below Low threshold. Threshold is set by Operator or Program.Deadband and Severity are set in Configuration.

Low-Low PV PV below Low-Low threshold. Threshold is set by Operator orProgram. Deadband and Severity are set in Configuration.

Fail PV quality is Bad (Inp_PVBad is TRUE) or PV is beyond configuredFail High and Fail Low thresholds.


16/64


Chapter 1 Overview

Execution The following table explains the handling of instruction execution conditions.

Refer to the Logix5000 Controllers Add-On Instructions ProgrammingManual, publication 1756-PM010, for more information on Add-OnInstruction execution condition handling.

Revision Compatibility The P_AIn Add-On Instruction in RSLogix 5000 software and the Faceplate

in FactoryTalk View software are marked with revision information as shownin the following table:.

Condition Description

EnableIn False (False Rung) The P_AIn Instruction shows a status of Bad

Quality (Sts_PVBad) and an indication onthe HMI. All alarms are cleared. The Modeis reported as ‘NO MODE’. However,calculation of the scaled ‘Val_InpPV’ isexecuted in order to indicate to the operatorthe actual input value, even though theprimary PV (Val) is not updated (holds lastvalue).

Powerup (Pre-Scan, First Scan) Any Commands received before First Scanare discarded.

Embedded P_Alarm instructions arehandled in accordance with their standardpowerup procedures. Refer to the

Reference Manual for the P_AlarmInstruction for more information.

Postscan (SFC Transition) No SFC Postscan logic is provided.

Component Example

The Add-On Instruction in RSLogix 5000 hasrevision information visible when theinstruction is selected in the ControllerOrganizer.

The Faceplate in FactoryTalk View hasrevision information visible when thepointer is paused just inside the lowerleft-hand corner of the Faceplate whencalled up on a running HMI Client.

http://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdf


17/64


Overview Chapter 1

The Instruction and Faceplate are compatible if they have the same Major andMinor Revision numbers.

The Major Revision is the first number, before the period.

The Minor Revision is the second number, after the period and before thehyphen or space.

Information after the hyphen or space indicates the Tweak Revision. TheInstruction and Faceplate do not have to have the same Tweak Revision to becompatible.

In the table above, the Add-On Instruction and Faceplate shown arecompatible because they have the same Major.Minor (1.1).


18/64


Chapter 1 Overview

Notes:


19/64


20/64


Chapter 2 Configuration Options

Cfg_FailDB 0.0 Maintenance Enter the Deadband (hysteresis) thatshould be applied to each threshold.This is used to prevent a noisy signalfrom generating spurious trips oralarms.

Example:

Suppose the High Threshold is 90.0and High Deadband (Cfg_HiDB) is 5.0.Once the PV rises above 90.0 andasserts a High Status, the PV mustfall below 85.0 (90.0 - 5.0) for theHigh Status to clear.

• Cfg_FailHiLim

• Cfg_FailLoLim

• Sts_Fail

• Alm_Fail

Cfg_HiDB 1.0 • Val_HiLim

• Sts_Hi

• Alm_Hi

Cfg_HiHiDB 1.0 • Val_HiHiLim

• Sts_HiHi

• Alm_HiHi

Cfg_LoDB 1.0 • Val_LoLim

• Sts_Lo

• Alm_Lo

Cfg_LoLoDB 1.0 • Val_LoLoLim

• Sts_LoLo

• Alm_LoLo

Cfg_FailOnDly 0 Maintenance Enter the amount of time (in seconds)the PV must exceed the thresholdbefore the corresponding status isasserted.

• Sts_Fail

• Alm_Fail

Cfg_HiOnDly 1.0 • Sts_Hi

• Alm_Hi

Cfg_HiHiOnDly 1.0 • Sts_HiHi

•Alm_HiHi

Cfg_LoOnDly 1.0 • Sts_Lo

• Alm_Lo

Cfg_LoLoOnDly 1.0 • Sts_LoLo

• Alm_LoLo

Cfg_FailOffDly 0 Maintenance Enter the amount of time (in seconds)the PV must stay within the threshold(and deadband) before thecorresponding status is cleared.

• Sts_Fail

• Alm_Fail

Cfg_HiOffDly 1.0 • Sts_Hi

• Alm_Hi

Cfg_HiHiOffDly 1.0 • Sts_HiHi

• Alm_HiHi

Cfg_LoOffDly 1.0 • Sts_Lo

• Alm_Lo

Cfg_LoLoOffDly 1.0 • Sts_LoLo

• Alm_LoLo

Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:


21/64


Configuration Options Chapter 2

Cfg_FailHiLim

Cfg_FailLoLim

1.5E+38

-1.5E+38

Maintenance These thresholds determine whatInp_PV values (in scaled engineeringunits) are considered as a signal’failure’.

The failure thresholds are typicallyset just outside the Cfg_PVEUMax and Cfg_PVEUMin scaling range.

When the PV is above the Fail Hithreshold or below the Fail Lothreshold, a Fail Status is generated.

The High, High-High, Low andLow-Low thresholds useSettings (PSet_, OSet_) andValues (Val_), not ConfigurationParameters (Cfg_).

• Alm_Fail

Cfg_FailResetReqd OFF AlarmConfiguration

When this parameter is:

• ON, the alarm is latched ON whenan alarm occurs. After the alarm

condition returns to normal, aReset is required to clear thealarm.

IMPORTANT

If the Reset clears the alarm, italso acknowledges the alarm.

• OFF, the alarm is set when analarm occurs and cleared whenthe alarm condition returns tonormal. No Reset is required.

The alarm may be cleared by anOperator or Program Resetcommand or by asserting theInp_Reset Input.

• PCmd_Reset

• Inp_Reset

• Alm_Fail

• Fail.OCmd_Reset

Cfg_HiResetReqd • Alm_Hi

• Hi.OCmd_Reset

Cfg_HiHiResetReqd • Alm_HiHi

• HiHi.OCmd_Reset

Cfg_LoResetReqd • Alm_Lo

• Lo.OCmd_Reset

Cfg_LoLoResetReqd • Alm_LoLo

• LoLo.OCmd_Reset

Cfg_InpRawMin 0.0 Engineering These parameters must be set to therange of the signal connected to theInp_PV Input.

Example:

If your Input card scales the input andprovides a signal from 4.0 to 20.0(mA), set Cfg_InpRawMin to 4.0 and

Cfg_InpRawMax to 20.0.

The Raw Min/Max and EU Min/Maxvalues are used for scaling toengineering units.

• Inp_PV Cfg_PVEUMin

Cfg_InpRawMax 100.0 • Cfg_PVEUMax



22/64



Cfg_NoSubstPV OFF Engineering Set this parameter to:

• OFF to allow the Substitute PVMaintenance function.

• ON to disallow the Substitute PVMaintenance function.

When Cfg_NoSubstPV is in theOFF state, the instructionaccepts either of the followingcommands:

• MCmd_SubstPV - Select theSubstitute PV

• MCmd_InpPV - Return to the’Live’ (Input) PV

Sts_SubstPV is ON when theSubstitute PV is selected andOFF when the Input PV isselected.

Cfg_PCmdClear ON Engineering Set this parameter:

• On to use Edge-triggered ProgramCommands.

• Off to use Level-triggeredProgram Commands.

See the Edge and Level section in thePreface for more information.

The Cfg_PCmdClear parameterconfigures all Program

Commands (PCmd_) for eitherLevel or Edge triggering.

Cfg_ProgDefault ON Engineering When this parameter is:

• ON, the Mode defaults to Programif no Mode is being requested.

• OFF, the Mode defaults toOperator if no Mode is being

requested.IMPORTANT

Changing this parameter online maycause unintended mode changes.

• Val_Mode

• Sts_Prog

• Sts_Oper

Cfg_PVEUMin 0.0 Engineering These parameters must be set tomatch the Process Variable (PV) rangerepresented by the input signalconnected to the Inp_PV.

For example, if your Input cardprovides a signal from 4.0 to 20.0(mA) that represents -50 to 250degrees Celsius, set Cfg_PVEUMin to-50 and Cfg_PVEUMax to 250.

The Raw Min/Max and EU Min/Maxvalues are used for scaling toengineering units.

• Inp_PV

• Cfg_InpRawMin

Cfg_PVEUMax 100.0 • Cfg_InpRawMax



23/64


Configuration Options Chapter 2

Cfg_SetTrack ON Maintenance When this parameter is:

• ON, the Operator Settings trackthe Program Settings in ProgramMode; the Program Settings trackthe Operator Settings in OperatorMode; the transition betweenModes is bumpless.

• OFF, the Operator Settings andProgram Settings are not modifiedby this instruction and retain theirvalues regardless of the mode.When the mode is changed, thevalue of a Setting may bump, fromthe Program-set value to theOperator-set value (or vice-versa).

• PSet_HiHiLim

• PSet_LoLoLim

• PSet_LoLim

• PSet_LoLoLim

• OSet_HiHiLim

• OSet_HiLim

• OSet_LoLim

• OSet_LoLoLim

• Val_HiHiLim

• Val_HiLim

• Val_LoLim

• Val_LoLoLim

Cfg_FailSeverity

Cfg_HiHiSeverity

Cfg_HiSeverity

Cfg_LoSeverity

Cfg_LoLoSeverity

4

3

2

2

3

AlarmConfiguration

These parameters determine theSeverity of each alarm, and thus thecolor of alarm animations for eachalarm.

Valid values are:• 1 = Information (blue)

• 2 = Warning (yellow)

• 3 = Exception (red)

• 4 = Fault (magenta)

• Val_Notify

Cfg_FiltTC 0.0 sec Engineering This parameter sets the filter timeconstant for the first-order (lag) filter

applied to the PV.

The filter is applied after scaling (toVal_InpPV) and before alarm checkingand PV display as Val. See thePrimary Operations in Chapter 1 fordetails.

• Val_InpPV

•Val

Cfg_HasFailAlm

Cfg_HasHiHiAlm

Cfg_HasHiAlm

Cfg_HasLoAlm

Cfg_HasLoLoAlm

Off AlarmConfiguration

These parameters determine whetherthe corresponding alarm exists andwill be checked, or doesn’t exist andwill not be used.

When this parameter is:

• On, the Alarm exists and will bechecked

• Off, the Alarm does not exist andwill not be used

• Alm_Fail

• Alm_HiHi

• Alm_Hi

• Alm_Lo

• Alm_LoLo



24/64



Notes:


25/64


Chapter 3

Instruction Data Reference

This chapter describes the P_AIn Instruction’s public parameters.

The descriptions in the tables below show how these data elements are used with this instruction.

Execution Execution parameters are included with every Add-On Instruction. See theLogix5000 Controllers Add-On Instructions Programming Manual,publication 1756-PM010, for more information on these data elements.

Name: Data Type: Usage: Default: Style: Description:

AssociatedConfigurationParameter

EnableIn BOOL Input 1 Enable Input:

1 = Normal scan. The instruction scalesthe Input PVs and generates alarms.

0 = OFF-Scan; No Value updates or alarmchecking. Bad PV (stale) is asserted.

EnableOut BOOL Output 0 Enable Output: The EnableOut signal isnot manipulated by this instruction. Itsoutput state always reflects the EnableIn

input state.Inf_Tab SINT 0 Tab to display (FTView ME)

Inf_Type STRING_16 “P_AIn” Must contain AOI name, used for HMI andInformation S/W

P_AIn BOOL Output 0 Unique Parameter Name for auto - discovery

http://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdf


26/64


Chapter 3 Instruction Data Reference

Inputs (Inp_)

Input data elements are used to connect field inputs from I/O modules orsignals from other objects to the P_AIn instruction. Each Input used shouldhave mapping logic or a function block wire to get the input value from theinput card or other instruction every scan.

Configurations

(Cfg_)Configuration data elements are used to set configurable capabilities, featuresand functions of the P_AIn Instruction.

The following Configuration data may be modified by controller applicationlogic, using the HMI Faceplate, or using the Tag Monitor in RSLogix 5000software.



Inp_PV REAL Input 0.0 Float Input Signal (Process Variable) fromSensor

• Cfg_InpRawMin

• Cfg_InpRawMax

• Cfg_PVEUMin

• Cfg_PVEUMax

Inp_PVBad BOOL Input 0 Level 1 = PV or I/O Comms Status Bad 0 = OK

Inp_PVUncertain BOOL Input 0 Level 1 = PV Value Not Reliable

0 =OKInp_Sim BOOL Input 0 Level 1 = Use simulated PV (Set_SimPV)

0 = Use Input (Inp_PV)

Inp_Reset BOOL Input 0 Level 1 = Reset all Alarms requiring reset • Cfg_FailResetReqd

• Cfg_HiHiResetReqd

• Cfg_HiResetReqd

• Cfg_LoResetReqd

• Cfg_LoLoResetReqd



Cfg_NoSubstPV BOOL Input 0 Level 1 = Disallow selection ofSubstitute PV

Cfg_SetTrack BOOL Input 1 Level 1 = PSets track OSets in Oper,OSets track, PSets in Prog

0 = No tracking

Cfg_PCmdClear BOOL Input 1 Level 1 = Clear Program Commands onreceipt

0 = Leave Set

Cfg_ProgDefault BOOL Input 0 Level Default Mode:1 = Program Mode if no requests 0 = Operator Mode if no requests


27/64


Instruction Data Reference Chapter 3

Cfg_HasHiHiAlm BOOL Input 0 Level 1 = High-High Alarm exists andwill be checked

Cfg_HasHiAlm BOOL Input 0 Level 1 = High Alarm exists and will bechecked

Cfg_HasLoAlm BOOL Input 0 Level 1 = Low Alarm exists and will bechecked

Cfg_HasLoLoAlm BOOL Input 0 Level 1 = Low-Low Alarm exists andwill be checked

Cfg_HasFailAlm BOOL Input 0 Level 1 = Analog Input Failure Alarmexists and will be checked

Cfg_HiHiResetReqd BOOL Input 0 Level 1 = Reset required to clearHigh-High Alarm

Cfg_HiResetReqd BOOL Input 0 Level 1 = Reset required to clear HighAlarm

Cfg_LoResetReqd BOOL Input 0 Level 1 = Reset required to clear LowAlarm

Cfg_LoLoResetReqd BOOL Input 0 Level 1 = Reset required to clearLow-Low Alarm

Cfg_FailResetReqd BOOL Input 0 Level 1 = Reset required to clear InputFailure Alarm

Cfg_HiHiAckReqd BOOL Input 1 Level 1 = Acknowledge required forHigh-High Alarm

Cfg_HiAckReqd BOOL Input 1 Level 1 = Acknowledge required for

High AlarmCfg_LoAckReqd BOOL Input 1 Level 1 = Acknowledge required for

Low Alarm

Cfg_LoLoAckReqd BOOL Input 1 Level 1 = Acknowledge required forLow-Low Alarm

Cfg_FailAckReqd BOOL Input 1 Level 1 = Acknowledge required forInput Failure Alarm

Cfg_HiHiSeverity SINT Input 3 Decimal High-High Alarm Severity 1 = Information 2 = Warning 3 = Exception 4 = Fault

Cfg_HiSeverity SINT Input 2 Decimal High Alarm Severity 1 = Information 2 = Warning 3 = Exception 4 = Fault

Cfg_LoSeverity SINT Input 2 Decimal Low Alarm Severity 1 = Information 2 = Warning 3 = Exception 4 = Fault




28/64



Cfg_LoLoSeverity SINT Input 3 Decimal Low-Low Alarm Severity 1 = Information 2 = Warning 3 = Exception 4 = Fault

Cfg_FailSeverity SINT Input 4 Decimal Failure Alarm Severity 1 = Information 2 = Warning 3 = Exception 4 = Fault

Cfg_InpRawMin REAL Input 0.0 Float Input (unscaled) Minimum forScaling

Cfg_InpRawMax REAL Input 100.0 Float Input (unscaled) Maximum forScaling

Cfg_PVEUMin REAL Input 0.0 Float PV (Output) Minimum for Scalingto EU

Cfg_PVEUMax REAL Input 100.0 Float PV (Output) Maximum for Scalingto EU

TIP

The P_AIn Instruction supportsreverse scaling. Either the raw(Input) or engineering (Scaled)range may be reversed (maximumless than minimum).

Cfg_FiltTC REAL Input 0.0 Float PV Filter Time Constant (sec) 0.0 = Unfiltered

Cfg_HiHiDB REAL Input 1.0 Float High-High Deadband (EU)

Cfg_HiHiOnDly DINT Input 0 Decimal Minimum time above High-HighLimit to raise Status (sec)

Cfg_HiHiOffDly DINT Input 0 Decimal Minimum time below High-HighLimit (minus deadband) to clearStatus (sec)

Cfg_HiDB REAL Input 1.0 Float High Deadband (EU)

Cfg_HiOnDly DINT Input 0 Decimal Minimum time above High Limit

to raise Status (sec)Cfg_HiOffDly DINT Input 0 Decimal Minimum time below High Limit

(minus deadband) to clear Status(sec)

Cfg_LoDB REAL Input 1.0 Float Low Deadband (EU)

Cfg_LoOnDly DINT Input 0 Decimal Minimum time below Low Limit toraise Status (sec)




29/64



Because they contain arrayed or structured data types, the followingConfiguration data elements use P_AIn Add-On Instruction Local Tags.These may be modified using RSLogix 5000 software or using the HMI

Faceplate, but they cannot be modified using controller logic:

Cfg_LoOffDly DINT Input 0 Decimal Minimum time above Low Limit(plus deadband) to clear Status(sec)

Cfg_LoLoDB REAL Input 1.0 Float Low-Low Deadband (EU)

Cfg_LoLoOnDly DINT Input 0 Decimal Minimum time below Low-LowLimit to raise Status (sec)

Cfg_LoLoOffDly DINT Input 0 Decimal Minimum time above Low-LowLimit (plus deadband) to clearStatus (sec)

Cfg_FailHiLim REAL Input 1.50E+38 Float Out-of-Range (fail) High threshold(EU)

Cfg_FailLoLim REAL Input 1.50E+38 Float Out-of-Range (fail) Low threshold(EU)

Cfg_FailDB REAL Input 0.0 Float Out-of-Range (fail)Deadband (H/L) (EU)

Cfg_FailOnDly DINT Input 0 Decimal Minimum time Bad or Out ofRange to raise Fail Status (sec)

Cfg_FailOffDly DINT Input 0 Decimal Minimum time OK or In Range toclear Fail Status (sec)





Cfg_Desc STRING_40 ’Analog Input’ String Description for display on HMI

Cfg_EU STRING_8 ’%’ String Engineering Units for display onHMI

Cfg_Label STRING_20 ’Analog Input’ String Label for graphic symbol displayedon HMI

Cfg_Tag STRING_20 ’P_AIn’ String Tagname for display on HMI


30/64



Program Settings (PSet_)

Program Setting data elements are used by application logic to establishsetpoints, thresholds, and other settings of the P_AIn Instruction. Automationlogic may write to these settings any time; the P_AIn Instruction uses them inits logic when it is in the Program Mode.



PSet_Owner DINT Input 0 Decimal Program Owner request ID (non-zero) orRelease (0)

PSet_HiHiLim REAL Input 1.50E+38 Float Program-Entered High-High StatusThreshold (EU)

• Cfg_SetTrack

PSet_HiLim REAL Input 1.50E+38 Float Program-Entered High Status Threshold(EU)

• Cfg_SetTrack

PSet_LoLim REAL Input -1.50E+38 Float Program-Entered Low Status Threshold(EU)

• Cfg_SetTrack

PSet_LoLoLim REAL Input -1.50E+38 Float Program-Entered Low-Low StatusThreshold (EU)

• Cfg_SetTrack


31/64



Program Commands(PCmd_)

Program Command data elements are used by application logic to requestP_AIn Instruction actions, such as changing Modes, acknowledging alarms, orspecific P_AIn actions. Application logic sets the Program Command to 1 or 0to request the action. (See the Edge and Level section in the Preface for moreinformation.) The P_AIn Instruction then performs the requested action if itis in Program Mode and the action can be performed.

Device Commands

* Primary Function:If Cfg_PCmdClear = 0, triggered by Level = 1If Cfg_PCmdClear = 1, triggered by rising Edge

* * Opposite Function:If Cfg_PCmdClear = 0, triggered by primary function bit Level = 0 (this bit NOT USED)If Cfg_PCmdClear = 1, triggered by rising Edge of this bit

Mode Commands

* Primary Function:

If Cfg_PCmdClear = 0, triggered by Level = 1 If Cfg_PCmdClear = 1, triggered by rising Edge

* * Opposite Function: If Cfg_PCmdClear = 0, triggered by primary function bit Level = 0 (this bit NOT USED) If Cfg_PCmdClear = 1, triggered by rising Edge of this bits



PCmd_ClearCapt BOOL Input 0 * Program Command to Clearthe captured min / max PV

excursion values

PCmd_ClearCapt


Associated

ConfigurationParameter

PCmd_Acq BOOL Input 0 * Program Command to AcquireOwnership (Oper to Prog)

PCmd_Rel BOOL Input 0 ** Program Command to ReleaseOwnership (Prog to Oper)

PCmd_Lock BOOL Input 0 * Program Command to Lock Mode inProg

PCmd_Unlock BOOL Input 0 ** Program Command to Unlock Mode


32/64


33/64



Operator Settings, Maintenance Settings, Other Settings

(OSet_, MSet_, Set_)

Operator, Maintenance and Other Setting data elements are used by the HMIFaceplate to let the operator establish setpoints, thresholds, and other settingsof the P_AIn Instruction. The P_AIn Instruction uses Other Settings in itslogic regardless of Mode. It uses Operator and Maintenance Settings when it isin Operator or Maintenance Mode.

Operator / Maintenance Setting Readies

Operator / Maintenance Setting Readies are used to enable (1) or gray-out (0)the Setting data entry fields on the HMI faceplate. Specific Ready bits are usedfor certain Operator or Maintenance Settings. Rdy_OSet applies to all

Operator or Maintenance Settings for which there are no specific Ready bits.



MSet_SubstPV REAL Input 0.0 Float Maintenance-Entered Substitute PV(EU)

OSet_HiHiLim REAL Input 1.50E+38 Float Operator-Entered High-High Threshold(EU)

• Cfg_SetTrack

OSet_HiLim REAL Input 1.50E+38 Float Operator-Entered High Threshold (EU) • Cfg_SetTrack

OSet_LoLim REAL Input -1.50E+38 Float Operator-Entered Low Threshold (EU) • Cfg_SetTrack

OSet_LoLoLim REAL Input -1.50E+38 Float Operator-Entered Low-Low Threshold(EU)

• Cfg_SetTrack

Set_SimPV REAL Input 0.0 Float PV used in Simulation (Inp_Sim=1) (EU)



Rdy_OSet BOOL Output 0 1 = Ready to receive OSets (enablesdata entry fields)


34/64


35/64



Alarm Commands

IMPORTANT Alarm Commands are sent to P_Alarm Instructions embeddedwithin the P_AIn Instruction. Each P_Alarm Instruction instanceis named for the alarm condition.

Name:DataType: Usage: Default: Style: Description:


OCmd_Reset BOOL Input 0 Edge Operator Command to Reset allAlarms requiring Reset

• Cfg_FailResetReqd


• Cfg_HiResetReqd


• Cfg_LoResetReqd

OCmd_ResetAckAll BOOL Input 0 Edge Operator Command to Reset andAcknowledge all Alarms

HiHi.OCmd_Reset BOOL Input 0 Edge Command to Reset latched High-HighAlarm


HiHi.OCmd_Ack BOOL Input 0 Edge Command to Acknowledge High-HighAlarm

• Cfg_HiHiAckReqd

HiHi.OCmd_Disable BOOL Input 0 Edge Command to Disable High-High Alarm

HiHi.OCmd_Enable BOOL Input 0 Edge Command to Enable High-High Alarm

Hi.OCmd_Reset BOOL Input 0 Edge Command to Reset latched HighAlarm

• Cfg_HiResetReqd

Hi.OCmd_Ack BOOL Input 0 Edge Command to Acknowledge HighAlarm• Cfg_HiAckReqd

Hi.OCmd_Disable BOOL Input 0 Edge Command to Disable High Alarm

Hi.OCmd_Enable BOOL Input 0 Edge Command to Enable High Alarm

Lo.OCmd_Reset BOOL Input 0 Edge Command to Reset Low Alarm • Cfg_LoResetReqd

Lo.OCmd_Ack BOOL Input 0 Edge Command to Acknowledge Low Alarm • Cfg_LoAckReqd

Lo.OCmd_Disable BOOL Input 0 Edge Command to Disable Low Alarm

Lo.OCmd_Enable BOOL Input 0 Edge Command to Enable Low Alarm

LoLo.OCmd_Reset BOOL Input 0 Edge Command to Reset Low-Low Alarm • Cfg_LoLoResetReqd

LoLo.OCmd_Ack BOOL Input 0 Edge Command to Acknowledge Low-Low

Alarm

• Cfg_LoLoAckReqd

LoLo.OCmd_Disable BOOL Input 0 Edge Command to Disable Low-Low Alarm

LoLo.OCmd_Enable BOOL Input 0 Edge Command to Enable Low-Low Alarm

Fail.OCmd_Reset BOOL Input 0 Edge Command to Reset Input Failure Alarm • Cfg_FailResetReqd


36/64



Device Command Readies

Each Operator or Maintenance Command has a corresponding Ready bit

which indicates whether the Command will be accepted and acted upon whenreceived. The Ready bit is used to enable (1) or gray-out (0) the OperatorCommand button on the Faceplate.

Mode Command Readies

Fail.OCmd_Ack BOOL Input 0 Edge Command to Acknowledge InputFailure Alarm

• Cfg_FailAckReqd

Fail.OCmd_Disable BOOL Input 0 Edge Command to Disable Input FailureAlarm

Fail.OCmd_Enable BOOL Input 0 Edge Command to Enable Input FailureAlarm





Rdy_SubstPV BOOL Output 0 1 = Ready for MCmd_SubstPV (enablesHMI button)

Rdy_InpPV BOOL Output 0 1 = Ready for MCmd_InpPV (enables HMIbutton)

IMPORTANT Mode Command Readies are provided by a P_Mode Instructionembedded within the P_AIn Instruction. The P_ModeInstruction instance is named ‘Mode’.

Name:

Data

Type: Usage: Default: Style: Description:

AssociatedConfiguration

ParameterMode.Rdy_Acq BOOL Output 0 1 = Ready for OCmd_Reset (enables HMI

button)

Mode.Rdy_Rel BOOL Output 0 1 = Ready for OCmd_ResetAckAll (enablesHMI button)

Mode.Rdy_AcqLock BOOL Output 0 1 = Ready for OCmd_AcqLock (enablesHMI button)

Mode.Rdy_Unlock BOOL Output 0 1 = Ready for OCmd_Unlock (enables HMIbutton)


37/64



Alarm Command Readies

IMPORTANT Alarm Command Readies are provided by P_Alarm Instructionsembedded within the P_AIn Instruction. Each P_AlarmInstruction instance is named for the alarm condition.



Rdy_Reset BOOL Output 0 1 = Ready for OCmd_Reset (enables HMIbutton)

Rdy_ResetAckAll BOOL Output 0 1 = Ready for OCmd_ResetAckAll (enablesHMI button)

HiHi.Rdy_Reset BOOL Output 0 1 = Ready for HiHi.OCmd_Reset (enablesHMI button)

HiHi.Rdy_Ack BOOL Output 0 1 = Ready for HiHi.OCmd_Ack (enablesHMI button)

HiHi.Rdy_Disable BOOL Output 0 1 = Ready for HiHi.OCmd_Disable(enables HMI button)

HiHi.Rdy_Enable BOOL Output 0 1 = Ready for HiHi.OCmd_Enable (enablesHMI button)

Hi.Rdy_Reset BOOL Output 0 1 = Ready for Hi.OCmd_Reset (enablesHMI button)

Hi.Rdy_Ack BOOL Output 0 1 = Ready for Hi.OCmd_Ack (enables HMIbutton)

Hi.Rdy_Disable BOOL Output 0 1 = Ready for Hi.OCmd_Disable (enablesHMI button)

Hi.Rdy_Enable BOOL Output 0 1 = Ready for Hi.OCmd_Enable (enablesHMI button)

Lo.Rdy_Reset BOOL Output 0 1 = Ready for Lo.OCmd_Reset (enablesHMI button)

Lo.Rdy_Ack BOOL Output 0 1 = Ready for Lo.OCmd_Ack (enables HMIbutton)

Lo.Rdy_Disable BOOL Output 0 1 = Ready for Lo.OCmd_Disable (enablesHMI button)

Lo.Rdy_Enable BOOL Output 0 1 = Ready for Lo.OCmd_Enable (enables

HMI button)LoLo.Rdy_Reset BOOL Output 0 1 = Ready for LoLo.OCmd_Reset (enables

HMI button)

LoLo.Rdy_Ack BOOL Output 0 1 = Ready for LoLo.OCmd_Ack (enablesHMI button)

LoLo.Rdy_Disable BOOL Output 0 1 = Ready for LoLo.OCmd_Disable(enables HMI button)

LoLo.Rdy_Enable BOOL Output 0 1 = Ready for LoLo.OCmd_Enable (enablesHMI button)


38/64



Fail.Rdy_Reset BOOL Output 0 1 = Ready for Fail.OCmd_Reset (enablesHMI button)

Fail.Rdy_Ack BOOL Output 0 1 = Ready for Fail.OCmd_Ack (enablesHMI button)

Fail.Rdy_Disable BOOL Output 0 1 = Ready for Fail.OCmd_Disable (enablesHMI button)

Fail.Rdy_Enable BOOL Output 0 1 = Ready for Fail.OCmd_Enable (enablesHMI button)




39/64



Values (Val_)

Value data elements contain process or device variables, the notification levelfor alarm animation, and the current accepted values of any Program,Operator or Maintenance Settings for the P_AIn instruction. The HMIdisplays these Values, and they are available for use by other application logic.



Val REAL Output 0.0 Float Analog Input Value (incl.ManualOverride, if used)

• Cfg_FiltTC

Val_InpPV REAL Output 0.0 Float Analog Input Value (actual, notsubject to Override)

• Cfg_FiltTC

Val_PVMinCapt REAL Output 0.0 Float Captured PV Minimum (excursion)since last cleared

Val_PVMaxCapt REAL Output 0.0 Float Captured PV Maximum (excursion)since last cleared

Val_Sts SINT Output 0 Decimal Device confirmed statusenumeration:

0 = PV Good 5 = PV Uncertain 6 = PV Bad 7 = Substitute PV

33 = Disabled (EnableIn False)

Val_Fault SINT Output 0 Decimal Device confirmed statusenumeration:

0 = None 20 = Low 21 = High 24 = Low-Low 25 = High-High 32 = Failed (I/O Fault) 34 = Configuration Error

Val_Mode DINT Output 0 Decimal Device confirmed statusenumeration: 0 = No Mode 2 = Maintenance (M) 4 = Program (P) Locked 5 = Operator (O) Locked 6 = Program (P), Default is Operator 7 = Operator (O), Default is Program 8 = Program (P), Default is Program 9 = Operator (O), Default is Operator

Val_Owner DINT Output 0 Decimal Current Object Owner ID (0 = notowned)


40/64



Val_Notify SINT Output 0 Decimal Current Alarm Level andAcknowledgement (enumeration): 0 = No alarm 1 = Alarm cleared, not acknowledged 2 = Information alarm 3 = Unacknowledged Info. alarm 4 = Warning alarm 5 = Unacknowledged Warning alarm 6 = Exception alarm 7 = Unacknowledged Exception alarm 8 = Fault alarm 9 = Unacknowledged Fault alarm

• Cfg_FailSeverity

• Cfg_HiHiSeverity• Cfg_HiSeverity

• Cfg_LoSeverity

• Cfg_LoLoSeverity

Val_HiHiLim REAL Output 1.50E+38 Float Current High-High Threshold • Cfg_SetTrack

• Cfg_FailDB

• Cfg_HiHiOnDly• Cfg_HiHiOffDly

Val_HiLim REAL Output 1.50E+38 Float Current High Threshold • Cfg_SetTrack

• Cfg_FailDB

• Cfg_HiOnDly

• Cfg_HiOffDly

Val_LoLim REAL Output -1.50E+38 Float Current Low Threshold • Cfg_SetTrack

• Cfg_LoDB

• Cfg_LoOnDly

• Cfg_LoOffDly

Val_LoLoLim REAL Output -1.50E+38 Float Current Low-Low Threshold • Cfg_SetTrack

• Cfg_LoLoDB

• Cfg_LoLoOnDly

• Cfg_LoLoOffDly




41/64



Status (Sts_)

Status data elements contain process or device states, Mode status and Alarmstatus. The HMI displays these Status points, and they are available for use byother application logic.

Device Status

Mode Status



Sts_SubstPV BOOL Output 0 1 = Using Substitute PV (Input beingoverridden)

• Cfg_NoSubstPV

Sts_InpPV BOOL Output 0 1 = Using Input PV (normal)

Sts_PVBad BOOL Output 0 1 = PV Bad Quality or Out of Range

Sts_PVUncertain BOOL Output 0 1 = PV Value is uncertain (Quality)

Sts_MaintByp BOOL Output 0 1 = Maintenance Bypass is Active, displayicon

Sts_AlmInh BOOL Output 0 1 = An Alarm is Inhibited, Disabled, orSuppressed, display icon

Sts_Err BOOL Output 0 1 = Error in Config. See Detail Err_Bits forreason

Err_Raw BOOL Output 0 1 = Error in Config: Raw Input Scaling Min= Max

Err_EU BOOL Output 0 1 = Error in Config: Scaled EU Min = Max

Err_Timer BOOL Output 0 1 = Error in Config: On-Delay or Off-DelayTime Invalid (use 0 to 2147483 sec)

Err_Filt BOOL Output 0 1 = Error in Config: PV filter parameters(Rate Time, TC)

Err_DB BOOL Output 0 1 = Error in Config: an Alarm Deadband is< 0.0

Err_Alarm BOOL Output 0 1 = Error in Config: Invalid Alarm MinimumOn Time or Severity



Sts_Maint BOOL Output 0 1 = Mode is Maintenance (supersedesProg, Oper)

Sts_Prog BOOL Output 0 1 = Mode is Program


42/64


43/64



Alm_Lo BOOL Output 0 1 = Analog Input is in Low Alarm • Cfg_LoAckReqd

• Cfg_FailDB• Cfg_LoOnDly

• Cfg_LoOffDly

• Cfg_LoResetReqd

Ack_Lo BOOL Output 0 1 = Low Alarm Acknowledged • Cfg_LoAckReqd

Sts_LoDisabled BOOL Output 0 1 = Low Alarm Disabled (not saved orsent)

Sts_LoInhibited BOOL Output 0 1 = Low Alarm Inhibited by logic

Sts_LoSuppressed BOOL Output 0 1 = Low Alarm Suppressed (loggedonly)

Sts_LoLo BOOL Output 0 1 = Analog Input is below Low-Lowthreshold

Alm_LoLo BOOL Output 0 1 = Analog Input is in Low-LowAlarm

• Cfg_LoLoAckReqd

• Cfg_FailDB

• Cfg_LoLoOnDly

• Cfg_LoLoOffDly


Ack_LoLo BOOL Output 0 1 = Low-Low Alarm Acknowledged • Cfg_LoLoAckReqd

Sts_LoLoDisabled BOOL Output 0 1 = Low-Low Alarm Disabled (notsaved or sent)

Sts_LoLoInhibited BOOL Output 0 1 = Low-Low Alarm Inhibited by logic

Sts_LoLoSuppressed BOOL Output 0 1 = Low-Low Alarm Suppressed(logged only)

Sts_Fail BOOL Output 0 1 = Analog Input is Out of Range orPV Bad

Alm_Fail BOOL Output 0 1 = Analog Input is in Failure Alarm(Bad or Out of Range)

• Cfg_FailAckReqd

• Cfg_FailDB

• Cfg_FailOnDly

• Cfg_FailOffDly

• Cfg_FailResetReqd

Ack_Fail BOOL Output 0 1 = Analog Input Failure Alarm has

been acknowledged

• Cfg_FailAckReqd

Sts_FailDisabled BOOL Output 0 1 = Input Failure Alarm Disabled (notsaved or sent)

Sts_FailInhibited BOOL Output 0 1 = Input Failure Alarm Inhibited bylogic

Sts_FailSuppressed BOOL Output 0 1 = Input Failure Alarm Suppressed(logged only)




44/64



Notes:


45/64


Chapter 4

HMI Reference

This chapter describes the Graphic Symbols and Faceplates provided forhuman-machine interface (HMI) for the P_AIn Instruction.

Graphic Symbols Graphic Symbols are provided for use on end-user process graphic displays. Analog Input Graphic Symbols have the following common attributes:

Each Analog Input Graphic Symbol displays the object’s label and engineeringunits text, the current value of the process variable (PV), and various statusindicators. The current value of the PV changes color depending on the PV value and its signal quality. The graphic symbol has a color changing alarmborder that blinks on unacknowledged alarm.

The overall Graphic Symbol includes a touch field over it which calls up theobject’s Faceplate. In addition, pausing the pointing device over the GraphicSymbol displays a tooltip showing the object’s configured Tag andDescription.

Threshold / Quality Indicators

One of these symbols appears to the left of the Process Variable when thedescribed condition is true:

Graphic Symbol Description

Invalid Configuration

PV Quality Bad: Not a number, Out of Range, orCommunication Failure

PV Quality Uncertain

Alarm Indicator

Label

Threshold / Quality

Indicator

Process Variable

Maintenance

Bypass Indicator

Engineering Units

Mode Indicator

Alarm Border


46/64


Chapter 4 HMI Reference

TIP

When the Invalid Configuration Indicator appears, you can find whatconfiguration setting is invalid by following the indicators like a ‘trail ofbreadcrumbs’. Click the Graphic Symbol to call up the Faceplate. The InvalidConfiguration indicator will appear next to the appropriate tab at the top of theFaceplate to guide you in finding the configuration error. Once you navigate to thetab, the misconfigured item will be flagged with this indicator or appear in amagenta box.

For the Analog Input Instruction, the Invalid Configuration Indicator appearsunder the following conditions:

• The Input Raw Minimum and Raw Maximum scaling parameters are setto the same value.

• The Scaled EU Minimum and EU Maximum scaling parameters are setto the same value.

• The first-order filter time constant is set to a negative value.

• A Deadband is set to a negative value.

• An Alarm On-Delay, Off-Delay or Minimum On Time is set to a valueless than zero or greater than 2,147,483 seconds.

• An Alarm Severity is set to a value other than 1 (information), 2(warning), 3 (exception) or 4 (fault).

PV exceeds High-High threshold

PV exceeds High threshold

PV exceeds Low threshold

PV exceeds Low-Low threshold

The device is not ready to operate

No symbol displayed PV Quality Good and PV within thresholds



47/64


HMI Reference Chapter 4

Maintenance Bypass Indicator

This symbol appears to the right of the Label to indicate that a MaintenanceBypass has been activated:

TIP

When the Maintenance Bypass Indicator appears, you can find what conditionwas bypassed by following the indicators like a ‘trail of breadcrumbs’. Click theGraphic Symbol to call up the Faceplate. The Maintenance Bypass Indicator willappear next to the appropriate tab at the top of the Faceplate to guide you infinding the bypass. Once you navigate to the tab, the bypassed item will beflagged with this indicator.

For the Analog Input Instruction, the Maintenance Bypass Indicator appearsunder the following condition:

• The Substitute PV function has been enabled. The “live” Process Variable is being superseded by a Maintenance-entered value.

Mode Indicators

One of these symbols appears to the right of the Process Variable to indicatethe Mode of the Analog Input instruction:

TIP

The Mode Indicator may not appear if the instruction is in its default mode.


A Maintenance Bypass is active

No symbol displayed No Maintenance Bypass active

Graphic Symbol DescriptionNo Mode: the instruction is scanned falseand is out of service The Process Variableand Alarms are not updated

The instruction is in Maintenance Mode

The instruction is in Program Mode

The instruction is in Operator Mode


48/64



TIP

The Mode indicator may not appear if the instruction is in its default mode.

Alarm Indicators

One of these symbols appears to the left of the Label to indicate the describedalarm condition. The alarm border and label background blink if

Acknowledgement of an alarm condition is required.

Symbol Description

Black ‘I’ in white box with blackborder

Alarm Inhibit: an alarm is Inhibited by theProgram, Disabled by Maintenance orSuppressed by the Operator.

White bell, border, and textbackground

Return to Normal (no Alarm condition, but aprevious Alarm has not beenacknowledged)

Blue border and text backgroundYellow rectangle with exclamationpoint (!)

Information Severity Alarm

Yellow border and text backgroundOrange triangle with exclamationpoint (!)

Warning Severity Alarm

Red border and text backgroundOrange diamond with exclamationpoint (!)

Exception Severity Alarm

Magenta border and text backgroundRed circle with two exclamationpoints (!!)

Fault Severity Alarm

No symbol or border displayed, text is onnormal (light gray) background, not blinking

No Alarm or Alarm Inhibit condition, and allAlarms are Acknowledged


49/64



Using Graphics Symbols

The graphic symbol for P_AIn can be found in the global object file(RA-BAS) P_AIn Graphics Library. To use the graphic symbol, copy it from

the global object file and paste it in the display file. Next, right click on thegraphic symbol in the display file and select ‘Global Object Parameter Values’and the following window appears:

Enter the tag(s) in the ‘Value’ column as specified in the ‘Description’ column.

Note: Values for items marked ‘(Optional)’ may be left blank.

Faceplate The Analog Input Faceplate consists of six tabbed pages. The Operator tab isdisplayed when the Faceplate is initially called up. Click the appropriate icon atthe top of the Faceplate to access a specific tab.

The Faceplate provides the means for Operators, Maintenance, Engineers andothers to interact with the P_AIn Instruction instance, including viewing itsStatus and Values and manipulating it through its Commands and Settings. When a given input is restricted via FactoryTalk View security, the requireduser Security Code letter is shown in the tables that follow.

Operator Engineering

Maintenance

Alarms

Alarm Configuration Help

ExitTrends


50/64



Operator Tab

The Operator tab shows the following information:

• The current Mode (Program, Operator, or Maintenance).

• Requested Modes Indicator (This only appears if the Operator orProgram Mode has been superseded by another mode.)

• The current Process Variable.

• A bar graph for the current Process Variable. High-High and Low-Lowranges are show in dark gray and these ranges turn red if the threshold isexceeded. High and Low ranges are shown in medium gray and theseranges turn yellow if the threshold is exceeded.

• Scaled High and Low Range Values (Top and Bottom labels on the bargraph). If high range or low range values are exceeded, then theappropriate icon appears next to the values to the left of the bar graph.

Mode Indicator

Current Process VariableGraph

Operator Mode Unlock and

Lock Command Buttons

High and High-High

Thresholds

Current Process Variable

Low and Low-Low

Thresholds

Input Status Indicator

Reset Acknowledge All

Alarms Command Buttons


51/64



• High-High (HH) and Low-Low (LL) thresholds are displayed with alabel background that turns red when exceeded.

• High (H) and Low (L) thresholds are displayed with a label backgroundthat turns yellow when exceeded

• Input Status (Communication OK, Communication Fail or Bad PVQuality, or Uncertain PV Quality)

The following table shows the alarm status indicators on the Operator tab.

The following table shows the functions on the Operator tab:

Graphic Symbol Alarm Status

In Alarm (Active Alarm)

In Alarm and Acknowledged

Out of Alarm but Not Acknowledged

Alarm Suppressed (by Operator) (Alarm islogged but not displayed)

Alarm Disabled (by Maintenance)

Alarm Inhibited (by Program Logic)

Button/Field Action SecurityRequired

Click to release Operator ModeLock.

Code B

Click to lock in Operator Mode. Code B

Click to reset and acknowledge all

alarms.

Code F

Click to select normal input forProcess Variable. This button isonly visible in Maintenance Mode,and only if Engineering hasenabled the Substitute PVfunction.

Code C


52/64



Click to select substitute ProcessVariable instead of normal input.This button us only visible inMaintenance Mode, and only ifEngineering has enabled theSubstitute PV function.

Code C

Substitute Process Variable dataentry

Enter the Substitute PV value. Thisentry is available only when theSubstitute PV function is enabled.)

Code C

PV Used in Simulation data entry Enter the Simulation PV value. Thisentry is available when InputSimulation is enabled.

Code A



53/64



Alarms Tab

The Alarms tab displays each alarm for this device. If the alarm is active, thepanel behind the alarm will change color to match the severity of the alarm.

Alarm Acknowledge

Command Button

Reset and

Acknowledge All

Alarms Command

Button

Color Definition

Magenta Fault

Red Exception

Yellow Warning

Blue Information

Background (Light Gray) No alarm


54/64



The following table lists the functions on the Alarms tab.

The panel behind the alarm blinks if the alarm requires acknowledgement.Click the button with the check mark to acknowledge the alarm.

Alarm Acknowledge button is enabled if the corresponding Alarm requiresacknowledgement.

The Reset and Acknowledge All Alarms button is enabled if any alarmrequires reset or acknowledgement.

Button Action Security Required

Alarm Acknowledge Code F

Reset and Acknowledge AllAlarms

Code F


55/64



Maintenance Tab

The Maintenance tab shows the following information:

• The current Mode (Program, Operator, or Maintenance).

• Requested Modes Indicator - This display highlights all of the Modesthat have been requested. The left-most highlighted Mode is the activeMode.

Mode Indicator

Requested Modes Indicator

Maintenance Mode

Acquire and Release

Command Buttons

Status Thresholdsand Deadbands


56/64



The following table shows the functions on the Maintenance tab.

Refer to Primary Operations on page 2 or the Process Add-On Instructionsand Graphics: Mode (P_Mode) Reference Manual, publicationSYSLIB-RM005, for more information on Modes.


Click for Maintenance Mode. Code C

Click to release MaintenanceMode.

Code C

Threshold Enter the threshold (trip point) foranalog input alarms.

Code H

Deadband Type the deadband (hysteresis) foranalog input alarms.

Code H

On-Delay Enter the amount of time (in

seconds) the PV must exceed thethreshold before thecorresponding status is asserted.

Code D

Off-Delay Enter the amount of time (inseconds) the PV must stay withinthe threshold (and deadband)before the corresponding status iscleared.

Code D

Bumpless Program/OperatorTransition

Select to enable or disable thebumpless program/operatortransition of Status Thresholdsettings (tracking).

Code C


57/64



Engineering Tab

On the Engineering tab, users can configure the description, label, tag, andProcess Variable units for the device.

The following table lists the functions on the Engineering tab.

Configure Device

Description, Label,

and Tag Text

Configure Input and

Scaled Ranges

Mode Configuration

Button


Click to navigate to the ModeConfiguration popup.

Description Type the description. Code E

Label Type the label. Code E

Tag Type the tag. Code E

Maximum Value for the InputVariable

Type the maximum value for theInput Process Variable (unscaled).

Code E

Minimum Value for the InputVariable

Type the minimum value for theInput Process Variable (unscaled).

Code E


58/64



TIP

The P_AIn Instruction supports reverse scaling. Either the Raw (Input) orEngineering (Scaled) range may be reversed (maximum less than minimum).

Mode Configuration Popup

This popup allows the user to select the default mode for the object byselecting a radio button. The radio buttons require security code E.

Maximum for the Scaled Value Type the maximum for the ScaledProcess Variable (displayed).

Code E

Minimum for the Scaled Value Type the minimum for the ScaledProcess Variable (displayed).

Code E

Disallow selection of SubstitutePV

Select to disallow selection ofsubstitute PV.

Code E

Clear Program Commands onReceipt

Select (default) this checkbox touse Edge-triggered ProgramCommands. Deselect thischeckbox to use Level-triggeredProgram Commands.

Code E

PV Filter Time Constant Enter the time constant (inseconds) for the first-order filterapplied to the analog input. If you

enter zero, filtering is not appliedto the input.

Code E



59/64



Trends Tab

On the Trend tab, users can view the Process Variable and reset the capturerange’s min/max values. The green line represents the Process Variable (PV)and the light gray area shows the capture range.

The following table lists the functions on the Trends tab.

Reset capture

min/max value

Button Action Security Required

Reset capture min/max values Code A


60/64



Alarm Configuration Tab

The Alarm Configuration tab contains configuration related to the alarmsfor the device.


61/64



The following table shows the functions on the Alarm Configuration tab.

Check Box/Field Action SecurityRequired

Alarm The alarm exists for the device. Code EAcknowledge Required Require acknowledgement of the alarm.

IMPORTANT

If using FTView Alarm and Events,configure its Alarm Tag for AcknowledgeRequired. The controller handlesacknowledgement within this instruction.

Code E

Reset Required Require a reset to clear the alarm status.There is a single alarm reset that resetsall of the alarms for the device.

IMPORTANT

If using FTView Alarms and Events, DONOT check the ‘Latched’ checkbox as thecontroller handles the alarm reset withinthis instruction.

Code E

Severity Configure the severity level of the alarm: 1 = Information 2 = Warning 3 = Exception 4 = Fault

Code E

Minimum On Time When an Alarm occurs, the Alarm outputwill be held on for at least this amount oftime (sec). If set to 5 seconds or less, theAlarm output will be held on for at least 5seconds to ensure it is seen by polling.Set this time higher if you want an Alarmto be held in the Alarm state (and on theAlarm summary) longer. This will keep itvisible to the Operator, or keep the Alarmfrom clearing and being set again for anintermittent condition) until the Operatorhas had time to perform anyAlarm-related actions.

Note: If the alarm is configured withReset Required (Cfg_ResetReqd = 1), theoperator can reset the alarm before thistime expires if the input condition hasreturned to normal.

Code D


62/64



Analog Input Faceplate Help


63/64


64/64

Rockwell Automation Support

Rockwell Automation provides technical information on the Web to assist you in using its products.At http://www.rockwellautomation.com/support/, you can find technical manuals, a knowledge base of FAQs, technical andapplication notes, sample code and links to software service packs, and a MySupport feature that you can customize to make the

best use of these tools.

For an additional level of technical phone support for installation, configuration, and troubleshooting, we offer TechConnectsupport programs. For more information, contact your local distributor or Rockwell Automation representative,or visit http://www.rockwellautomation.com/support/.

Installation Assistance

If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact Customer Support for initial help in getting your product up and running.

New Product Satisfaction Return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility.However, if your product is not functioning and needs to be returned, follow these procedures.

Documentation Feedback

Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document,complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.

United States or Canada 1.440.646.3434

Outside United States orCanada

Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html , or contactyour local Rockwell Automation representative.

United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtainone) to your distributor to complete the return process.

Outside United States Please contact your local Rockwell Automation representative for the return procedure.
http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/http://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdfhttp://www.rockwellautomation.com/literature/http://www.rockwellautomation.com/locations/http://www.rockwellautomation.com/support/americas/phone_en.htmlhttp://www.rockwellautomation.com/locations/http://www.rockwellautomation.com/literature/http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/http://www.rockwellautomation.com/support/americas/phone_en.htmlhttp://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdf

Documents

P AIn Analog Input