You are on page 1of 64

Process Add-On Instructions and Graphics:

Basic Analog Input (P_AIn)

Compatible with the Plant-wide Integrated Architecture


Reference Manual

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 office
or 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 application
of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in
this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING

IMPORTANT
ATTENTION

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


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

Identifies information that is critical for successful application and understanding of the product.
Identifies information about practices or circumstances that can lead to personal injury or death,
property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and
recognize the consequence.

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.

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.

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 the
Release 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

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

iii

Summary of Changes

Notes:

iv

Publication SYSLIB-RM001C-EN-E - October 2011

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Pre-Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Function Block States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Entering Text in FactoryTalk View SE. . . . . . . . . . . . . . . . . . . . . . xii

Chapter 1
Overview

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

Chapter 2
Configuration Options

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

Chapter 3
Instruction Data Reference

vPublication SYSLIB-RM001C-EN-E - October 2011

Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Inputs (Inp_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Configurations (Cfg_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Program Settings (PSet_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Program Commands (PCmd_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Device Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Operator Settings, Maintenance Settings, Other Settings
(OSet_, MSet_, Set_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Operator / Maintenance Setting Readies . . . . . . . . . . . . . . . . . . . . 21
Operator Commands, Maintenance Commands, Command Readies
(OCmd_, MCmd_, Rdy_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Device Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Mode Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Alarm Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Values (Val_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Status (Sts_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Mode Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Alarm Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Table of Contents

Chapter 4
HMI Reference

vi

Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Using Graphics Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Alarm Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Analog Input Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Publication SYSLIB-RM001C-EN-E - October 2011

Preface

Use of this Document

This document provides a programmer with details on the P_AIn instruction


for a Logix-based controller. You should already be familiar with how the
Logix-based controller stores and processes data.
Novice programmers should read all the details about an instruction before
using the instruction. Experienced programmers can refer to the instruction
information to verify details.

Conventions and Related


Terms

Set and Clear


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

viiPublication SYSLIB-RM001C-EN-E - October 2011

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

vii

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 the
action; 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 a


state, usually 1)
Opposite action (disable) is triggered by input being in
opposite 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 Level
input on the instruction (one-to-one relationship restriction).

IMPORTANT

viii

All Operator Commands (OCmd_) and Maintenance Commands


(MCmd_) are Edge triggered. The HMI Graphic Symbol or
Faceplate SETS (writes a 1 to) each Command bit and the
Instruction CLEARS (writes a 0 to) the Command bit, then
performs the function, if possible.

Publication SYSLIB-RM001C-EN-E - October 2011

Preface

IMPORTANT

This instruction has Program Commands (PCmd_) which are


selectable as Edge or Level, depending on the Configuration
Parameter 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 the
Instruction Data Reference become Level triggered, and
opposite functions are triggered by the primary Program
Command being CLEARED to 0.

Relay Ladder Rung Condition


The controller evaluates ladder instructions based on the rung condition
preceding the instruction (rung-in condition). Based on the rung-in condition
and the instruction, the controller sets the rung condition following the
instruction (rung-out condition), which in turn, affects any subsequent
instruction.

If the rung-in condition to an input instruction is true, the controller evaluates


the instruction and sets the rung-out condition based on the results of the
instruction. 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

The rung-in condition is reflected in the EnableIn parameter and


determines how the system performs each Process Add-On
Instruction. If the EnableIn signal is TRUE, the system performs
the instructions main logic routine. Conversely, if the EnableIn
signal is FALSE, the system performs the instructions
EnableInFalse routine.
The instructions main logic routine sets/clears the EnableOut
parameter, which then determines the rung-out condition. The
EnableInFalse routine cannot set the EnableOut parameter. If
the rung-in condition is FALSE, then the EnableOut parameter
and the rung-out condition will also be FALSE.

Publication SYSLIB-RM001C-EN-E - October 2011

ix

Preface

Pre-Scan
During the transition into RUN, the controller performs a Pre-scan before the
first 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 ignores
jumps that could skip the execution of instructions. The controller executes all
FOR loops and subroutine calls. If a subroutine is called more than once, it is
executed each time it is called. The controller uses Pre-scan instructions to
reset non-retentive data values.
During Pre-scan, input values are not current and outputs are not written. The
following 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 Instructions


logic routine as all FALSE and then performs its Pre-scan
routine as TRUE.

Publication SYSLIB-RM001C-EN-E - October 2011

Preface

Function Block States


The controller evaluates function block instructions based on the state of
different conditions.
Possible Condition:

Description:

Pre-scan

Pre-scan for function block routines is the same as for relay


ladder routines. The only difference is that the Enableln
parameter for each function block instruction is cleared during
Pre-scan.

Instruction first scan

Instruction first scan refers to the first time an instruction is


executed after Pre-scan. The controller uses instruction first
scan to read current inputs and determine the appropriate
state to be in.

Instruction first run

Instruction first run refers to the first time the instruction


executes with a new instance of a data structure. The
controller uses instruction first run to generate coefficients
and other data stores that do not change for a function block
after initial download.

Every function block instruction also includes EnableIn and EnableOut


parameters.
If the EnableIn parameter is not wired, the instruction always executes as
normal and EnableIn remains set. If you clear EnableIn, it changes to set the
next time the instruction executes.
IMPORTANT

Publication SYSLIB-RM001C-EN-E - October 2011

When programming in function block, restrict the range


of engineering units to 1015 because internal floating
point calculations are done using single precision floating
point. Engineering units outside of this range may result in
a loss of accuracy if results approach the limitations of
single precision floating point (1038).

xi

Preface

Entering Text in FactoryTalk View SE


When entering data into String Input fields in FactoryTalk View SE, the data is
not 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.

EXAMPLE

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.

EXAMPLE

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

xii

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter

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 when
the analog value exceeds user-specified thresholds (high and low). The Analog
Input Instruction also provides capabilities for linear scaling of an analog input
value from raw (input) units to engineering (output) units, and entry of a
Substitute Process Variable, providing handling of an out-of-range or faulted
input.
In order to keep the Instruction memory and execution footprint small,
certain capabilities, used less frequently, are reserved for the Advanced Analog
Input 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 signal
from 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, and
Maintenance 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 by
the P_VSD Instruction. It is not necessary to use the P_AIn instruction
first. Wire or map the input directly to P_VSD.
You only need to display a number on a screen and do not need any of
the scaling or alarming features. (Just use a numeric display field.)
You need advanced capabilities such as square root extraction (for
example, orifice flow meters), rate-of-change alarming or limiting, or
alarming 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 the
P_AInDual (Dual Analog Input) Instruction instead.
1Publication SYSLIB-RM001C-EN-E - October 2011

Chapter 1

Overview

You have more than two sensors for one process variable and need to
use 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 input


alarms 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 optionally
filters the signal.
Provides High-High, High, Low and Low-Low status and alarms with
configurable Delay Times and Deadbands
Provides Program and Operator Settings for Status Thresholds
Provides Input failure checking for Out of Range High and Out of
Range Low, plus PV quality and alarm on failure.
Provides Maintenance selection of the Substitute PV function to allow
manual override of the Input signal (PV)
Monitors Input communication status and provides indication of stale
PV (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 more
information.

Publication SYSLIB-RM001C-EN-E - October 2011

Overview

Operating Modes

Chapter 1

The following standard Modes, implemented using the P_Mode Add-On


Instruction, are used by the Analog Input Add-On Instruction.
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; normal


Operator Commands and Settings are accepted from the
Operator via the HMI.

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.
Alarm

Description

High-High PV

PV above High-High threshold. Threshold is set by Operator or


Program. 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 or


Program. Deadband and Severity are set in Configuration.

Fail

PV quality is Bad (Inp_PVBad is TRUE) or PV is beyond configured


Fail High and Fail Low thresholds.

Each alarm has a configurable deadband for return to normal, and each
threshold alarm has configurable on-delay and off-delay times. (The PV quality
alarms are immediate.)
Refer to the Process Add-On Instructions and Graphics: Alarm (P_Alarm)
Reference Manual, publication SYSLIB-RM002, for more information.

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter 1

Overview

Execution

The following table explains the handling of instruction execution conditions.


Condition

Description

EnableIn False (False Rung)

The P_AIn Instruction shows a status of Bad


Quality (Sts_PVBad) and an indication on
the HMI. All alarms are cleared. The Mode
is reported as NO MODE. However,
calculation of the scaled Val_InpPV is
executed in order to indicate to the operator
the actual input value, even though the
primary PV (Val) is not updated (holds last
value).

Powerup (Pre-Scan, First Scan)

Any Commands received before First Scan


are discarded.
Embedded P_Alarm instructions are
handled in accordance with their standard
powerup procedures. Refer to the
Reference Manual for the P_Alarm
Instruction for more information.

Postscan (SFC Transition)

No SFC Postscan logic is provided.

Refer to the Logix5000 Controllers Add-On Instructions Programming


Manual, publication 1756-PM010, for more information on Add-On
Instruction 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 shown
in the following table:.
Component

Example

The Add-On Instruction in RSLogix 5000 has


revision information visible when the
instruction is selected in the Controller
Organizer.

The Faceplate in FactoryTalk View has


revision information visible when the
pointer is paused just inside the lower
left-hand corner of the Faceplate when
called up on a running HMI Client.

Publication SYSLIB-RM001C-EN-E - October 2011

Overview

Chapter 1

The Instruction and Faceplate are compatible if they have the same Major and
Minor Revision numbers.
The Major Revision is the first number, before the period.
The Minor Revision is the second number, after the period and before the
hyphen or space.
Information after the hyphen or space indicates the Tweak Revision. The
Instruction and Faceplate do not have to have the same Tweak Revision to be
compatible.
In the table above, the Add-On Instruction and Faceplate shown are
compatible because they have the same Major.Minor (1.1).

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter 1

Overview

Notes:

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter

Configuration Options

Configuration Parameters

Enter the appropriate values from the following table into the P_AIn
Instructions configuration parameters to configure it for your application.
Use the HMI Faceplate or RSLogix 5000 Tag Monitor function the to set the
applicable configuration parameter(s).

Parameter:

Default:

Faceplate Tab
Location:
Usage:

Cfg_Desc

Analog Input

Engineering

Cfg_EU

Cfg_Label

Analog Input

Description

Cfg_Tag

P_AIn

Engineering Units (units of


measure)

Associated Parameters:

These Local Tags determine the text


displayed on the various graphic
objects and Faceplates for:

Label (if used)


Tagname
Cfg_FailAckReqd

ON

Cfg_HiAckReqd

Cfg_HiAckReqd

Cfg_HiHiAckReqd

Alarm
Configuration

When this parameter is:


ON, the Acknowledge (Ack) bit is
cleared when an alarm occurs,
indicating an unacknowledged
alarm. An Acknowledge
Command is required to
acknowledge the alarm (set the
Ack bit).
OFF, the Acknowledge (Ack) bit is
set when an alarm occurs,
indicating an acknowledged
alarm. No Acknowledge
Command is required.

This configuration does not


impact clearing of the Alarm
(Alm) bit. It only determines
whether a new alarm becomes
unacknowledged or is
automatically acknowledged.
Ack_Fail
PCmd_FailAck
Fail.OCmd_Ack
Ack_Hi
PCmd_HiAck
Hi.OCmd_Ack
Ack_HiHi
PCmd_HiHiAck
HiHi.OCmd_Ack

Cfg_LoAckReqd

Ack_Lo
PCmd_LoAck
Lo.OCmd_Ack

Cfg_LoLoAckReqd

Ack_LoLo
PCmd_LoLoAck
LoLo.OCmd_Ack

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

Chapter 2

Configuration Options

Parameter:

Default:

Faceplate Tab
Location:
Usage:

Cfg_FailDB

0.0

Maintenance

Cfg_HiDB

Cfg_HiHiDB

Cfg_LoDB

1.0

Associated Parameters:

Enter the Deadband (hysteresis) that


should be applied to each threshold.
This is used to prevent a noisy signal
from generating spurious trips or
alarms.

Cfg_FailLoLim
Sts_Fail
Alm_Fail
Val_HiLim

Example:

Sts_Hi

Suppose the High Threshold is 90.0


and High Deadband (Cfg_HiDB) is 5.0.
Once the PV rises above 90.0 and
asserts a High Status, the PV must
fall below 85.0 (90.0 - 5.0) for the
High Status to clear.

1.0

Cfg_FailHiLim

Alm_Hi
Val_HiHiLim
Sts_HiHi
Alm_HiHi
Val_LoLim

1.0

Sts_Lo
Alm_Lo
Cfg_LoLoDB

Val_LoLoLim

1.0

Sts_LoLo
Alm_LoLo
Cfg_FailOnDly
Cfg_HiOnDly

Maintenance

1.0

Enter the amount of time (in seconds)


the PV must exceed the threshold
before the corresponding status is
asserted.

Sts_Fail
Alm_Fail
Sts_Hi
Alm_Hi

Cfg_HiHiOnDly

Sts_HiHi

1.0

Alm_HiHi
Cfg_LoOnDly

Sts_Lo

1.0

Alm_Lo
Cfg_LoLoOnDly

Sts_LoLo

1.0

Alm_LoLo
Cfg_FailOffDly
Cfg_HiOffDly

0
1.0

Maintenance

Enter the amount of time (in seconds)


the PV must stay within the threshold
(and deadband) before the
corresponding status is cleared.

Sts_Fail
Alm_Fail
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

Publication SYSLIB-RM001C-EN-E - October 2011

Configuration Options

Parameter:

Default:

Faceplate Tab
Location:
Usage:

Cfg_FailHiLim

1.5E+38

Maintenance

Cfg_FailLoLim

-1.5E+38

These thresholds determine what


Inp_PV values (in scaled engineering
units) are considered as a signal
failure.
The failure thresholds are typically
set just outside the Cfg_PVEUMax
and Cfg_PVEUMin scaling range.

Chapter 2

Associated Parameters:
The High, High-High, Low and
Low-Low thresholds use
Settings (PSet_, OSet_) and
Values (Val_), not Configuration
Parameters (Cfg_).
Alm_Fail

When the PV is above the Fail Hi


threshold or below the Fail Lo
threshold, a Fail Status is generated.
Cfg_FailResetReqd

OFF

Alarm
Configuration

The alarm may be cleared by an


Operator or Program Reset
ON, the alarm is latched ON when command or by asserting the
an alarm occurs. After the alarm Inp_Reset Input.
condition returns to normal, a
PCmd_Reset
Reset is required to clear the
alarm.
Inp_Reset

When this parameter is:

IMPORTANT

Alm_Fail
Fail.OCmd_Reset

If the Reset clears the alarm, it


also acknowledges the alarm.

Cfg_HiResetReqd

OFF, the alarm is set when an


alarm occurs and cleared when
the alarm condition returns to
normal. No Reset is required.

Cfg_HiHiResetReqd
Cfg_LoResetReqd

Alm_Hi
Hi.OCmd_Reset
Alm_HiHi
HiHi.OCmd_Reset
Alm_Lo
Lo.OCmd_Reset
Alm_LoLo

Cfg_LoLoResetReqd

LoLo.OCmd_Reset
Cfg_InpRawMin

0.0

Cfg_InpRawMax

100.0

Engineering

These parameters must be set to the


range of the signal connected to the
Inp_PV Input.

Inp_PV
Cfg_PVEUMin
Cfg_PVEUMax

Example:
If your Input card scales the input and
provides 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/Max
values are used for scaling to
engineering units.

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter 2

Configuration Options

Parameter:

Default:

Faceplate Tab
Location:
Usage:

Cfg_NoSubstPV

OFF

Engineering

Associated Parameters:

Set this parameter to:


OFF to allow the Substitute PV
Maintenance function.
ON to disallow the Substitute PV
Maintenance function.

When Cfg_NoSubstPV is in the


OFF state, the instruction
accepts either of the following
commands:
MCmd_SubstPV - Select the
Substitute PV
MCmd_InpPV - Return to the
Live (Input) PV
Sts_SubstPV is ON when the
Substitute PV is selected and
OFF when the Input PV is
selected.

Cfg_PCmdClear

ON

Engineering

Set this parameter:


On to use Edge-triggered Program
Commands.

The Cfg_PCmdClear parameter


configures all Program
Commands (PCmd_) for either
Level or Edge triggering.

Off to use Level-triggered


Program Commands.
See the Edge and Level section in the
Preface for more information.
Cfg_ProgDefault

ON

Engineering

Val_Mode

When this parameter is:


ON, the Mode defaults to Program
if no Mode is being requested.

Sts_Prog
Sts_Oper

OFF, the Mode defaults to


Operator if no Mode is being
requested.
IMPORTANT
Changing this parameter online may
cause unintended mode changes.
Cfg_PVEUMin
Cfg_PVEUMax

0.0
100.0

Engineering

These parameters must be set to


match the Process Variable (PV) range
represented by the input signal
connected to the Inp_PV.

Inp_PV
Cfg_InpRawMin
Cfg_InpRawMax

For example, if your Input card


provides a signal from 4.0 to 20.0
(mA) that represents -50 to 250
degrees Celsius, set Cfg_PVEUMin to
-50 and Cfg_PVEUMax to 250.
The Raw Min/Max and EU Min/Max
values are used for scaling to
engineering units.

10

Publication SYSLIB-RM001C-EN-E - October 2011

Configuration Options

Parameter:

Default:

Faceplate Tab
Location:
Usage:

Cfg_SetTrack

ON

Maintenance

When this parameter is:


ON, the Operator Settings track
the Program Settings in Program
Mode; the Program Settings track
the Operator Settings in Operator
Mode; the transition between
Modes is bumpless.
OFF, the Operator Settings and
Program Settings are not modified
by this instruction and retain their
values regardless of the mode.
When the mode is changed, the
value of a Setting may bump, from
the Program-set value to the
Operator-set value (or vice-versa).

Cfg_FailSeverity

Cfg_HiHiSeverity

Cfg_HiSeverity

Cfg_LoSeverity

Cfg_LoLoSeverity

Alarm
Configuration

These parameters determine the


Severity of each alarm, and thus the
color of alarm animations for each
alarm.

Chapter 2

Associated Parameters:
PSet_HiHiLim
PSet_LoLoLim
PSet_LoLim
PSet_LoLoLim
OSet_HiHiLim
OSet_HiLim
OSet_LoLim
OSet_LoLoLim
Val_HiHiLim
Val_HiLim
Val_LoLim
Val_LoLoLim
Val_Notify

Valid values are:


1 = Information (blue)
2 = Warning (yellow)
3 = Exception (red)
4 = Fault (magenta)

Cfg_FiltTC

0.0 sec

Engineering

This parameter sets the filter time


constant for the first-order (lag) filter
applied to the PV.

Val_InpPV
Val

The filter is applied after scaling (to


Val_InpPV) and before alarm checking
and PV display as Val. See the
Primary Operations in Chapter 1 for
details.
Cfg_HasFailAlm

Off

Cfg_HasHiHiAlm

Alarm
Configuration

These parameters determine whether


the corresponding alarm exists and
will be checked, or doesnt exist and
will not be used.

Alm_Fail

When this parameter is:

Alm_LoLo

Cfg_HasHiAlm
Cfg_HasLoAlm
Cfg_HasLoLoAlm

Alm_HiHi
Alm_Hi
Alm_Lo

On, the Alarm exists and will be


checked
Off, the Alarm does not exist and
will not be used

Publication SYSLIB-RM001C-EN-E - October 2011

11

Chapter 2

Configuration Options

Notes:

12

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter

Instruction Data Reference

This chapter describes the P_AIn Instructions 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 the
Logix5000 Controllers Add-On Instructions Programming Manual,
publication 1756-PM010, for more information on these data elements.

Name:

Data Type:

Usage:

Default:

EnableIn

BOOL

Input

Enable Input:
1 = Normal scan. The instruction scales
the Input PVs and generates alarms.
0 = OFF-Scan; No Value updates or alarm
checking. Bad PV (stale) is asserted.

EnableOut

BOOL

Output

Enable Output: The EnableOut signal is


not manipulated by this instruction. Its
output state always reflects the EnableIn
input state.

Inf_Tab

SINT

Tab to display (FTView ME)

Inf_Type

STRING_16

P_AIn

Must contain AOI name, used for HMI and


Information S/W

P_AIn

BOOL

Unique Parameter Name for


auto - discovery

Output

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

Style: Description:

Associated
Configuration
Parameter

13

Chapter 3

Instruction Data Reference

Inputs
(Inp_)

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

Name:

Data Type:

Usage:

Default:

Style: Description:

Inp_PV

REAL

Input

0.0

Float

Associated
Configuration
Parameter

Input Signal (Process Variable) from


Sensor

Cfg_InpRawMin
Cfg_InpRawMax
Cfg_PVEUMin
Cfg_PVEUMax

Inp_PVBad

BOOL

Input

Level

1 = PV or I/O Comms Status Bad


0 = OK

Inp_PVUncertain

BOOL

Input

Level

1 = PV Value Not Reliable


0 =OK

Inp_Sim

BOOL

Input

Level

1 = Use simulated PV (Set_SimPV)


0 = Use Input (Inp_PV)

Inp_Reset

BOOL

Input

Level

1 = Reset all Alarms requiring reset

Cfg_FailResetReqd
Cfg_HiHiResetReqd
Cfg_HiResetReqd
Cfg_LoResetReqd
Cfg_LoLoResetReqd

Configurations
(Cfg_)

Configuration data elements are used to set configurable capabilities, features


and functions of the P_AIn Instruction.
The following Configuration data may be modified by controller application
logic, using the HMI Faceplate, or using the Tag Monitor in RSLogix 5000
software.
Associated
Configuration
Parameter

Name:

Data Type:

Usage:

Default:

Style:

Description:

Cfg_NoSubstPV

BOOL

Input

Level

1 = Disallow selection of
Substitute PV

Cfg_SetTrack

BOOL

Input

Level

1 = PSets track OSets in Oper,


OSets track, PSets in Prog
0 = No tracking

Cfg_PCmdClear

BOOL

Input

Level

1 = Clear Program Commands on


receipt
0 = Leave Set

Cfg_ProgDefault

BOOL

Input

Level

Default Mode:
1 = Program Mode if no requests
0 = Operator Mode if no requests

14

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Name:

Data Type:

Usage:

Default:

Style:

Description:

Cfg_HasHiHiAlm

BOOL

Input

Level

1 = High-High Alarm exists and


will be checked

Cfg_HasHiAlm

BOOL

Input

Level

1 = High Alarm exists and will be


checked

Cfg_HasLoAlm

BOOL

Input

Level

1 = Low Alarm exists and will be


checked

Cfg_HasLoLoAlm

BOOL

Input

Level

1 = Low-Low Alarm exists and


will be checked

Cfg_HasFailAlm

BOOL

Input

Level

1 = Analog Input Failure Alarm


exists and will be checked

Cfg_HiHiResetReqd

BOOL

Input

Level

1 = Reset required to clear


High-High Alarm

Cfg_HiResetReqd

BOOL

Input

Level

1 = Reset required to clear High


Alarm

Cfg_LoResetReqd

BOOL

Input

Level

1 = Reset required to clear Low


Alarm

Cfg_LoLoResetReqd

BOOL

Input

Level

1 = Reset required to clear


Low-Low Alarm

Cfg_FailResetReqd

BOOL

Input

Level

1 = Reset required to clear Input


Failure Alarm

Cfg_HiHiAckReqd

BOOL

Input

Level

1 = Acknowledge required for


High-High Alarm

Cfg_HiAckReqd

BOOL

Input

Level

1 = Acknowledge required for


High Alarm

Cfg_LoAckReqd

BOOL

Input

Level

1 = Acknowledge required for


Low Alarm

Cfg_LoLoAckReqd

BOOL

Input

Level

1 = Acknowledge required for


Low-Low Alarm

Cfg_FailAckReqd

BOOL

Input

Level

1 = Acknowledge required for


Input Failure Alarm

Cfg_HiHiSeverity

SINT

Input

Decimal High-High Alarm Severity


1 = Information
2 = Warning
3 = Exception
4 = Fault

Cfg_HiSeverity

SINT

Input

Decimal High Alarm Severity


1 = Information
2 = Warning
3 = Exception
4 = Fault

Cfg_LoSeverity

SINT

Input

Decimal Low Alarm Severity


1 = Information
2 = Warning
3 = Exception
4 = Fault

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter 3

Associated
Configuration
Parameter

15

Chapter 3

Instruction Data Reference

Associated
Configuration
Parameter

Name:

Data Type:

Usage:

Default:

Style:

Description:

Cfg_LoLoSeverity

SINT

Input

Decimal Low-Low Alarm Severity


1 = Information
2 = Warning
3 = Exception
4 = Fault

Cfg_FailSeverity

SINT

Input

Decimal Failure Alarm Severity


1 = Information
2 = Warning
3 = Exception
4 = Fault

Cfg_InpRawMin

REAL

Input

0.0

Float

Input (unscaled) Minimum for


Scaling

Cfg_InpRawMax

REAL

Input

100.0

Float

Input (unscaled) Maximum for


Scaling

Cfg_PVEUMin

REAL

Input

0.0

Float

PV (Output) Minimum for Scaling


to EU

Cfg_PVEUMax

REAL

Input

100.0

Float

PV (Output) Maximum for Scaling


to EU

TIP
The P_AIn Instruction supports
reverse scaling. Either the raw
(Input) or engineering (Scaled)
range may be reversed (maximum
less 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

Decimal Minimum time above High-High


Limit to raise Status (sec)

Cfg_HiHiOffDly

DINT

Input

Decimal Minimum time below High-High


Limit (minus deadband) to clear
Status (sec)

Cfg_HiDB

REAL

Input

1.0

Float

Cfg_HiOnDly

DINT

Input

Decimal Minimum time above High Limit


to raise Status (sec)

Cfg_HiOffDly

DINT

Input

Decimal Minimum time below High Limit


(minus deadband) to clear Status
(sec)

Cfg_LoDB

REAL

Input

1.0

Float

Cfg_LoOnDly

DINT

Input

Decimal Minimum time below Low Limit to


raise Status (sec)

16

High Deadband (EU)

Low Deadband (EU)

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Name:

Data Type:

Usage:

Default:

Style:

Description:

Cfg_LoOffDly

DINT

Input

Decimal Minimum time above Low Limit


(plus deadband) to clear Status
(sec)

Cfg_LoLoDB

REAL

Input

1.0

Float

Cfg_LoLoOnDly

DINT

Input

Decimal Minimum time below Low-Low


Limit to raise Status (sec)

Cfg_LoLoOffDly

DINT

Input

Decimal Minimum time above Low-Low


Limit (plus deadband) to clear
Status (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

Decimal Minimum time Bad or Out of


Range to raise Fail Status (sec)

Cfg_FailOffDly

DINT

Input

Decimal Minimum time OK or In Range to


clear Fail Status (sec)

Chapter 3

Associated
Configuration
Parameter

Low-Low Deadband (EU)

Because they contain arrayed or structured data types, the following


Configuration 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:

Name:

Data Type:

Cfg_Desc

Usage:

Default:

Style: Description:

STRING_40

Analog Input

String

Description for display on HMI

Cfg_EU

STRING_8

String

Engineering Units for display on


HMI

Cfg_Label

STRING_20

Analog Input

String

Label for graphic symbol displayed


on HMI

Cfg_Tag

STRING_20

P_AIn

String

Tagname for display on HMI

Publication SYSLIB-RM001C-EN-E - October 2011

Associated
Configuration
Parameter

17

Chapter 3

Instruction Data Reference

Program Settings
(PSet_)

Program Setting data elements are used by application logic to establish


setpoints, thresholds, and other settings of the P_AIn Instruction. Automation
logic may write to these settings any time; the P_AIn Instruction uses them in
its logic when it is in the Program Mode.
Associated
Configuration
Parameter

Name:

Data Type:

Usage:

Default:

Style:

PSet_Owner

DINT

Input

Decimal Program Owner request ID (non-zero) or


Release (0)

PSet_HiHiLim

REAL

Input

1.50E+38

Float

Program-Entered High-High Status


Threshold (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 Status


Threshold (EU)

Cfg_SetTrack

18

Description:

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Program Commands
(PCmd_)

Chapter 3

Program Command data elements are used by application logic to request


P_AIn Instruction actions, such as changing Modes, acknowledging alarms, or
specific P_AIn actions. Application logic sets the Program Command to 1 or 0
to request the action. (See the Edge and Level section in the Preface for more
information.) The P_AIn Instruction then performs the requested action if it
is in Program Mode and the action can be performed.

Device Commands

Name:

Data Type: Usage: Default:

Style:

Description:

PCmd_ClearCapt

BOOL

Program Command to Clear


the captured min / max PV
excursion values

Input

Associated
Configuration
Parameter
PCmd_ClearCapt

* 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 bit

Mode Commands

Name:

Data Type:

Usage:

Default:

Style: Description:

PCmd_Acq

BOOL

Input

Program Command to Acquire


Ownership (Oper to Prog)

PCmd_Rel

BOOL

Input

**

Program Command to Release


Ownership (Prog to Oper)

PCmd_Lock

BOOL

Input

Program Command to Lock Mode in


Prog

PCmd_Unlock

BOOL

Input

**

Program Command to Unlock Mode

Associated
Configuration
Parameter

* 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

Publication SYSLIB-RM001C-EN-E - October 2011

19

Chapter 3

Instruction Data Reference

Alarm Commands

Name:

Data
Type:

Usage:

Default:

Style: Description:

PCmd_Reset

BOOL

Input

Associated
Configuration
Parameter

Program Command to Reset all Alarms


requiring Reset

Cfg_FailResetReqd
Cfg_HiHiResetReqd
Cfg_HiResetReqd
Cfg_LoResetReqd
Cfg_LoLoResetReqd

PCmd_HiHiAck

BOOL

Input

Command to Acknowledge High-High


Alarm

PCmd_HiHiInhibit

BOOL

Input

Command to Inhibit High-High Alarm

PCmd_HiHiUninhibit

BOOL

Input

**

Command to Uninhibit High-High


Alarm

PCmd_HiAck

BOOL

Input

Command to Acknowledge High Alarm

PCmd_HiInhibit

BOOL

Input

Command to Inhibit High Alarm

PCmd_HiUninhibit

BOOL

Input

**

Command to Uninhibit High Alarm

PCmd_LoAck

BOOL

Input

Command to Acknowledge Low Alarm

PCmd_LoInhibit

BOOL

Input

Command to Inhibit Low Alarm

PCmd_LoUninhibit

BOOL

Input

**

Command to Uninhibit Low Alarm

PCmd_LoLoAck

BOOL

Input

Command to Acknowledge Low-Low


Alarm

PCmd_LoLoInhibit

BOOL

Input

Command to Inhibit Low-Low Alarm

PCmd_LoLoUninhibit

BOOL

Input

**

Command to Uninhibit Low-Low Alarm

PCmd_FailAck

BOOL

Input

Command to Acknowledge Input


Failure Alarm

PCmd_FailInhibit

BOOL

Input

Command to Inhibit Input Failure


Alarm

PCmd_FailUninhibit

BOOL

Input

**

Command to Uninhibit Input Failure


Alarm

Cfg_HiHiAckReqd

Cfg_HiAckReqd

Cfg_LoAckReqd

Cfg_LoLoAckReqd

Cfg_FailAckReqd

* 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 = 0, triggered by rising Edge of this bitOperator Settings

20

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Operator Settings,
Maintenance Settings,
Other Settings
(OSet_, MSet_, Set_)

Chapter 3

Operator, Maintenance and Other Setting data elements are used by the HMI
Faceplate to let the operator establish setpoints, thresholds, and other settings
of the P_AIn Instruction. The P_AIn Instruction uses Other Settings in its
logic regardless of Mode. It uses Operator and Maintenance Settings when it is
in Operator or Maintenance Mode.
Associated
Configuration
Parameter

Name:

Data Type:

Usage:

Default:

Style:

Description:

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

PV used in Simulation (Inp_Sim=1) (EU)

Float

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 used
for certain Operator or Maintenance Settings. Rdy_OSet applies to all
Operator or Maintenance Settings for which there are no specific Ready bits.

Name:

Data Type:

Usage:

Default:

Rdy_OSet

BOOL

Output

Publication SYSLIB-RM001C-EN-E - October 2011

Style:

Description:

Associated
Configuration
Parameter

1 = Ready to receive OSets (enables


data entry fields)

21

Chapter 3

Instruction Data Reference

Operator Commands,
Maintenance Commands,
Command Readies
(OCmd_, MCmd_, Rdy_)

Operator Commands and Maintenance Commands are used by the operator at


the HMI to request instruction actions, such as changing modes;
acknowledging, enabling or disabling, suppressing or unsuppressing alarms; or
other instruction-specific actions. These Commands are set (latched) by the
HMI and are read and then cleared (unlatched) and acted upon by the P_AIn
instruction, allowing a many-to-one relationship between HMI requestors and
each Command. Commands are implemented as public Input Parameters of
the instruction or as Input Parameters of instructions internal to the P_AIn
instruction (embedded Commands).

Device Commands
Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Style: Description:

MCmd_SubstPV

BOOL

Input

Edge

Maintenance Command to use


Substitute PV (override input)

Cfg_NoSubstPV

MCmd_InpPV

BOOL

Input

Edge

Maintenance Command to use Input


PV (normal)

Cfg_NoSubstPV

OCmd_ClearCapt

BOOL

Input

Edge

Operator Command to Clear the


captured min / max PV excursion
values

Mode Commands
IMPORTANT

Mode Commands are sent to a P_Mode Instruction embedded


within the P_AIn Instruction. The P_Mode Instruction instance
is named Mode.
Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Style: Description:

Mode.MCmd_Acq

BOOL

Input

Edge

Maintenance Command to Acquire


Ownership (Oper/Prog/Ovrd to Maint)

Mode.MCmd_Rel

BOOL

Input

Edge

Maintenance Command to Release


ownership (Maint to Oper/Prog/Ovrd)

Mode.OCmd_AcqLock BOOL

Input

Edge

Operator Command to Acquire and Lock


Mode in Oper

Mode.OCmd_Unlock

Input

Edge

Operator Command to Unlock Operator


Mode

22

BOOL

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Chapter 3

Alarm Commands
Alarm Commands are sent to P_Alarm Instructions embedded
within the P_AIn Instruction. Each P_Alarm Instruction instance
is named for the alarm condition.

IMPORTANT

Name:

Data
Type:

Usage:

Default:

Style: Description:

OCmd_Reset

BOOL

Input

Edge

Operator Command to Reset all


Alarms requiring Reset

Associated
Configuration
Parameter
Cfg_FailResetReqd
Cfg_HiHiResetReqd
Cfg_HiResetReqd
Cfg_LoLoResetReqd
Cfg_LoResetReqd

OCmd_ResetAckAll

BOOL

Input

Edge

Operator Command to Reset and


Acknowledge all Alarms

HiHi.OCmd_Reset

BOOL

Input

Edge

Command to Reset latched High-High


Alarm

Cfg_HiHiResetReqd

HiHi.OCmd_Ack

BOOL

Input

Edge

Command to Acknowledge High-High


Alarm

Cfg_HiHiAckReqd

HiHi.OCmd_Disable

BOOL

Input

Edge

Command to Disable High-High Alarm

HiHi.OCmd_Enable

BOOL

Input

Edge

Command to Enable High-High Alarm

Hi.OCmd_Reset

BOOL

Input

Edge

Command to Reset latched High


Alarm

Cfg_HiResetReqd

Hi.OCmd_Ack

BOOL

Input

Edge

Command to Acknowledge High


Alarm

Cfg_HiAckReqd

Hi.OCmd_Disable

BOOL

Input

Edge

Command to Disable High Alarm

Hi.OCmd_Enable

BOOL

Input

Edge

Command to Enable High Alarm

Lo.OCmd_Reset

BOOL

Input

Edge

Command to Reset Low Alarm

Cfg_LoResetReqd

Lo.OCmd_Ack

BOOL

Input

Edge

Command to Acknowledge Low Alarm

Cfg_LoAckReqd

Lo.OCmd_Disable

BOOL

Input

Edge

Command to Disable Low Alarm

Lo.OCmd_Enable

BOOL

Input

Edge

Command to Enable Low Alarm

LoLo.OCmd_Reset

BOOL

Input

Edge

Command to Reset Low-Low Alarm

Cfg_LoLoResetReqd

LoLo.OCmd_Ack

BOOL

Input

Edge

Command to Acknowledge Low-Low


Alarm

Cfg_LoLoAckReqd

LoLo.OCmd_Disable

BOOL

Input

Edge

Command to Disable Low-Low Alarm

LoLo.OCmd_Enable

BOOL

Input

Edge

Command to Enable Low-Low Alarm

Fail.OCmd_Reset

BOOL

Input

Edge

Command to Reset Input Failure Alarm

Publication SYSLIB-RM001C-EN-E - October 2011

Cfg_FailResetReqd

23

Chapter 3

Instruction Data Reference

Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Style: Description:

Fail.OCmd_Ack

BOOL

Input

Edge

Command to Acknowledge Input


Failure Alarm

Fail.OCmd_Disable

BOOL

Input

Edge

Command to Disable Input Failure


Alarm

Fail.OCmd_Enable

BOOL

Input

Edge

Command to Enable Input Failure


Alarm

Cfg_FailAckReqd

Device Command Readies


Each Operator or Maintenance Command has a corresponding Ready bit
which indicates whether the Command will be accepted and acted upon when
received. The Ready bit is used to enable (1) or gray-out (0) the Operator
Command button on the Faceplate.
Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Rdy_SubstPV

BOOL

Output

1 = Ready for MCmd_SubstPV (enables


HMI button)

Rdy_InpPV

BOOL

Output

1 = Ready for MCmd_InpPV (enables HMI


button)

Style: Description:

Mode Command Readies


IMPORTANT

Mode Command Readies are provided by a P_Mode Instruction


embedded within the P_AIn Instruction. The P_Mode
Instruction instance is named Mode.
Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Mode.Rdy_Acq

BOOL

Output

1 = Ready for OCmd_Reset (enables HMI


button)

Mode.Rdy_Rel

BOOL

Output

1 = Ready for OCmd_ResetAckAll (enables


HMI button)

Mode.Rdy_AcqLock

BOOL

Output

1 = Ready for OCmd_AcqLock (enables


HMI button)

Mode.Rdy_Unlock

BOOL

Output

1 = Ready for OCmd_Unlock (enables HMI


button)

24

Style: Description:

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Chapter 3

Alarm Command Readies


IMPORTANT

Alarm Command Readies are provided by P_Alarm Instructions


embedded within the P_AIn Instruction. Each P_Alarm
Instruction instance is named for the alarm condition.

Name:

Data
Type:

Usage:

Default:

Rdy_Reset

BOOL

Output

1 = Ready for OCmd_Reset (enables HMI


button)

Rdy_ResetAckAll

BOOL

Output

1 = Ready for OCmd_ResetAckAll (enables


HMI button)

HiHi.Rdy_Reset

BOOL

Output

1 = Ready for HiHi.OCmd_Reset (enables


HMI button)

HiHi.Rdy_Ack

BOOL

Output

1 = Ready for HiHi.OCmd_Ack (enables


HMI button)

HiHi.Rdy_Disable

BOOL

Output

1 = Ready for HiHi.OCmd_Disable


(enables HMI button)

HiHi.Rdy_Enable

BOOL

Output

1 = Ready for HiHi.OCmd_Enable (enables


HMI button)

Hi.Rdy_Reset

BOOL

Output

1 = Ready for Hi.OCmd_Reset (enables


HMI button)

Hi.Rdy_Ack

BOOL

Output

1 = Ready for Hi.OCmd_Ack (enables HMI


button)

Hi.Rdy_Disable

BOOL

Output

1 = Ready for Hi.OCmd_Disable (enables


HMI button)

Hi.Rdy_Enable

BOOL

Output

1 = Ready for Hi.OCmd_Enable (enables


HMI button)

Lo.Rdy_Reset

BOOL

Output

1 = Ready for Lo.OCmd_Reset (enables


HMI button)

Lo.Rdy_Ack

BOOL

Output

1 = Ready for Lo.OCmd_Ack (enables HMI


button)

Lo.Rdy_Disable

BOOL

Output

1 = Ready for Lo.OCmd_Disable (enables


HMI button)

Lo.Rdy_Enable

BOOL

Output

1 = Ready for Lo.OCmd_Enable (enables


HMI button)

LoLo.Rdy_Reset

BOOL

Output

1 = Ready for LoLo.OCmd_Reset (enables


HMI button)

LoLo.Rdy_Ack

BOOL

Output

1 = Ready for LoLo.OCmd_Ack (enables


HMI button)

LoLo.Rdy_Disable

BOOL

Output

1 = Ready for LoLo.OCmd_Disable


(enables HMI button)

LoLo.Rdy_Enable

BOOL

Output

1 = Ready for LoLo.OCmd_Enable (enables


HMI button)

Publication SYSLIB-RM001C-EN-E - October 2011

Style: Description:

Associated
Configuration
Parameter

25

Chapter 3

Instruction Data Reference

Name:

Data
Type:

Usage:

Default:

Fail.Rdy_Reset

BOOL

Output

1 = Ready for Fail.OCmd_Reset (enables


HMI button)

Fail.Rdy_Ack

BOOL

Output

1 = Ready for Fail.OCmd_Ack (enables


HMI button)

Fail.Rdy_Disable

BOOL

Output

1 = Ready for Fail.OCmd_Disable (enables


HMI button)

Fail.Rdy_Enable

BOOL

Output

1 = Ready for Fail.OCmd_Enable (enables


HMI button)

26

Associated
Configuration
Parameter

Style: Description:

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Values
(Val_)

Chapter 3

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

Name:

Data
Type:

Usage:

Default:

Style:

Description:

Val

REAL

Output

0.0

Float

Analog Input Value (incl.Manual


Override, if used)

Cfg_FiltTC

Val_InpPV

REAL

Output

0.0

Float

Analog Input Value (actual, not


subject 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

Decimal Device confirmed status


enumeration:
0 = PV Good
5 = PV Uncertain
6 = PV Bad
7 = Substitute PV
33 = Disabled (EnableIn False)

Val_Fault

SINT

Output

Decimal Device confirmed status


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

Val_Mode

DINT

Output

Decimal Device confirmed status


enumeration:
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

Decimal Current Object Owner ID (0 = not


owned)

Publication SYSLIB-RM001C-EN-E - October 2011

27

Chapter 3

Instruction Data Reference

Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Style:

Val_Notify

SINT

Output

Decimal Current Alarm Level and


Acknowledgement (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

Float

Cfg_SetTrack

Val_HiHiLim

REAL

Output

1.50E+38

Description:

Current High-High Threshold

Cfg_HiHiSeverity
Cfg_HiSeverity
Cfg_LoSeverity
Cfg_LoLoSeverity

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

28

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Status
(Sts_)

Chapter 3

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

Device Status

Name:

Data Type:

Usage:

Default:

Style: Description:

Sts_SubstPV

BOOL

Output

1 = Using Substitute PV (Input being


overridden)

Sts_InpPV

BOOL

Output

1 = Using Input PV (normal)

Sts_PVBad

BOOL

Output

1 = PV Bad Quality or Out of Range

Sts_PVUncertain

BOOL

Output

1 = PV Value is uncertain (Quality)

Sts_MaintByp

BOOL

Output

1 = Maintenance Bypass is Active, display


icon

Sts_AlmInh

BOOL

Output

1 = An Alarm is Inhibited, Disabled, or


Suppressed, display icon

Sts_Err

BOOL

Output

1 = Error in Config. See Detail Err_Bits for


reason

Err_Raw

BOOL

Output

1 = Error in Config: Raw Input Scaling Min


= Max

Err_EU

BOOL

Output

1 = Error in Config: Scaled EU Min = Max

Err_Timer

BOOL

Output

1 = Error in Config: On-Delay or Off-Delay


Time Invalid (use 0 to 2147483 sec)

Err_Filt

BOOL

Output

1 = Error in Config: PV filter parameters


(Rate Time, TC)

Err_DB

BOOL

Output

1 = Error in Config: an Alarm Deadband is


< 0.0

Err_Alarm

BOOL

Output

1 = Error in Config: Invalid Alarm Minimum


On Time or Severity

Associated
Configuration
Parameter
Cfg_NoSubstPV

Mode Status

Name:

Data
Type:

Usage:

Default:

Sts_Maint

BOOL

Output

1 = Mode is Maintenance (supersedes


Prog, Oper)

Sts_Prog

BOOL

Output

1 = Mode is Program

Publication SYSLIB-RM001C-EN-E - October 2011

Style: Description:

Associated
Configuration
Parameter

29

Chapter 3

Instruction Data Reference

Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Sts_Oper

BOOL

Output

1 = Mode is Operator

Sts_ProgOperLock BOOL

Output

1 = Program or Operator Mode Lock

Sts_NoMode

Output

1 = NoMode (Disabled because EnableIn


is False)

BOOL

Style: Description:

Alarm Status
Associated
Configuration
Parameter

Name:

Data
Type:

Usage:

Default:

Sts_HiHi

BOOL

Output

1 = Analog Input is above High-High


threshold

Alm_HiHi

BOOL

Output

1 = Analog Input is in High-High


Alarm

Style: Description:

Cfg_HiHiAckReqd
Cfg_FailDB
Cfg_HiHiOnDly
Cfg_HiHiOffDly
Cfg_HiHiResetReqd

Ack_HiHi

BOOL

Output

1 = High-High Alarm Acknowledged

Sts_HiHiDisabled

BOOL

Output

1 = High-High Alarm Disabled (not


saved or sent)

Sts_HiHiInhibited

BOOL

Output

1 = High-High Alarm Inhibited by


logic

Sts_HiHiSuppressed

BOOL

Output

1 = High-High Alarm Suppressed


(logged only)

Sts_Hi

BOOL

Output

1 = Analog Input is above High


threshold

Alm_Hi

BOOL

Output

1 = Analog Input is in High Alarm

Cfg_HiHiAckReqd

Cfg_HiAckReqd
Cfg_FailDB
Cfg_HiOnDly
Cfg_HiOffDly
Cfg_HiResetReqd

Ack_Hi

BOOL

Output

1 = High Alarm Acknowledged

Sts_HiDisabled

BOOL

Output

1 = High Alarm Disabled (not saved


or sent)

Sts_HiInhibited

BOOL

Output

1 = High Alarm Inhibited by logic

Sts_HiSuppressed

BOOL

Output

1 = High Alarm Suppressed (logged


only)

Sts_Lo

BOOL

Output

1 = Analog Input is below Low


threshold

30

Cfg_HiAckReqd

Publication SYSLIB-RM001C-EN-E - October 2011

Instruction Data Reference

Name:

Data
Type:

Usage:

Default:

Alm_Lo

BOOL

Output

Style: Description:
1 = Analog Input is in Low Alarm

Chapter 3

Associated
Configuration
Parameter
Cfg_LoAckReqd
Cfg_FailDB
Cfg_LoOnDly
Cfg_LoOffDly
Cfg_LoResetReqd

Ack_Lo

BOOL

Output

1 = Low Alarm Acknowledged

Sts_LoDisabled

BOOL

Output

1 = Low Alarm Disabled (not saved or


sent)

Sts_LoInhibited

BOOL

Output

1 = Low Alarm Inhibited by logic

Sts_LoSuppressed

BOOL

Output

1 = Low Alarm Suppressed (logged


only)

Sts_LoLo

BOOL

Output

1 = Analog Input is below Low-Low


threshold

Alm_LoLo

BOOL

Output

1 = Analog Input is in Low-Low


Alarm

Cfg_LoAckReqd

Cfg_LoLoAckReqd
Cfg_FailDB
Cfg_LoLoOnDly
Cfg_LoLoOffDly
Cfg_LoLoResetReqd

Ack_LoLo

BOOL

Output

1 = Low-Low Alarm Acknowledged

Sts_LoLoDisabled

BOOL

Output

1 = Low-Low Alarm Disabled (not


saved or sent)

Sts_LoLoInhibited

BOOL

Output

1 = Low-Low Alarm Inhibited by logic

Sts_LoLoSuppressed

BOOL

Output

1 = Low-Low Alarm Suppressed


(logged only)

Sts_Fail

BOOL

Output

1 = Analog Input is Out of Range or


PV Bad

Alm_Fail

BOOL

Output

1 = Analog Input is in Failure Alarm


(Bad or Out of Range)

Cfg_LoLoAckReqd

Cfg_FailAckReqd
Cfg_FailDB
Cfg_FailOnDly
Cfg_FailOffDly
Cfg_FailResetReqd

Ack_Fail

BOOL

Output

1 = Analog Input Failure Alarm has


been acknowledged

Sts_FailDisabled

BOOL

Output

1 = Input Failure Alarm Disabled (not


saved or sent)

Sts_FailInhibited

BOOL

Output

1 = Input Failure Alarm Inhibited by


logic

Sts_FailSuppressed

BOOL

Output

1 = Input Failure Alarm Suppressed


(logged only)

Publication SYSLIB-RM001C-EN-E - October 2011

Cfg_FailAckReqd

31

Chapter 3

Instruction Data Reference

Notes:

32

Publication SYSLIB-RM001C-EN-E - October 2011

Chapter

HMI Reference

This chapter describes the Graphic Symbols and Faceplates provided for
human-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:
Label
Alarm Border
Maintenance
Bypass Indicator

Alarm Indicator
Threshold / Quality
Indicator

Mode Indicator

Process Variable

Engineering Units

Each Analog Input Graphic Symbol displays the objects label and engineering
units text, the current value of the process variable (PV), and various status
indicators. The current value of the PV changes color depending on the PV
value and its signal quality. The graphic symbol has a color changing alarm
border that blinks on unacknowledged alarm.
The overall Graphic Symbol includes a touch field over it which calls up the
objects Faceplate. In addition, pausing the pointing device over the Graphic
Symbol displays a tooltip showing the objects configured Tag and
Description.

Threshold / Quality Indicators


One of these symbols appears to the left of the Process Variable when the
described condition is true:
Graphic Symbol

Description
Invalid Configuration
PV Quality Bad:
Not a number, Out of Range, or
Communication Failure
PV Quality Uncertain

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

33

Chapter 4

HMI Reference

Graphic Symbol

Description
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

TIP
When the Invalid Configuration Indicator appears, you can find what
configuration setting is invalid by following the indicators like a trail of
breadcrumbs. Click the Graphic Symbol to call up the Faceplate. The Invalid
Configuration indicator will appear next to the appropriate tab at the top of the
Faceplate to guide you in finding the configuration error. Once you navigate to the
tab, the misconfigured item will be flagged with this indicator or appear in a
magenta box.
For the Analog Input Instruction, the Invalid Configuration Indicator appears
under the following conditions:
The Input Raw Minimum and Raw Maximum scaling parameters are set
to the same value.
The Scaled EU Minimum and EU Maximum scaling parameters are set
to 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 value
less 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).

34

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

Maintenance Bypass Indicator


This symbol appears to the right of the Label to indicate that a Maintenance
Bypass has been activated:
Graphic Symbol

Description
A Maintenance Bypass is active

No symbol displayed

No Maintenance Bypass active

TIP
When the Maintenance Bypass Indicator appears, you can find what condition
was bypassed by following the indicators like a trail of breadcrumbs. Click the
Graphic Symbol to call up the Faceplate. The Maintenance Bypass Indicator will
appear next to the appropriate tab at the top of the Faceplate to guide you in
finding the bypass. Once you navigate to the tab, the bypassed item will be
flagged with this indicator.
For the Analog Input Instruction, the Maintenance Bypass Indicator appears
under 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 indicate
the Mode of the Analog Input instruction:
TIP
The Mode Indicator may not appear if the instruction is in its default mode.
Graphic Symbol

Description
No Mode: the instruction is scanned false
and is out of service The Process Variable
and Alarms are not updated
The instruction is in Maintenance Mode
The instruction is in Program Mode
The instruction is in Operator Mode

Publication SYSLIB-RM001C-EN-E - October 2011

35

Chapter 4

HMI Reference

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 described
alarm condition. The alarm border and label background blink if
Acknowledgement of an alarm condition is required.
Symbol
Black I in white box with black
border

Description
Alarm Inhibit: an alarm is Inhibited by the
Program, Disabled by Maintenance or
Suppressed by the Operator.

White bell, border, and text


background

Return to Normal (no Alarm condition, but a


previous Alarm has not been
acknowledged)

Blue border and text background


Yellow rectangle with exclamation
point (!)

Information Severity Alarm

Yellow border and text background


Orange triangle with exclamation
point (!)

Warning Severity Alarm

Red border and text background


Orange diamond with exclamation
point (!)

Exception Severity Alarm

Magenta border and text background Fault Severity Alarm


Red circle with two exclamation
points (!!)

No symbol or border displayed, text is on


normal (light gray) background, not blinking

36

No Alarm or Alarm Inhibit condition, and all


Alarms are Acknowledged

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

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 the
graphic 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 is
displayed when the Faceplate is initially called up. Click the appropriate icon at
the top of the Faceplate to access a specific tab.
Maintenance

Operator

Engineering

Alarm Configuration

Trends

Alarms

Help

Exit

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

Publication SYSLIB-RM001C-EN-E - October 2011

37

Chapter 4

HMI Reference

Operator Tab

Reset Acknowledge All


Alarms Command Buttons

Mode Indicator

Operator Mode Unlock and


Lock Command Buttons
High and High-High
Thresholds
Current Process Variable

Current Process Variable


Graph

Low and Low-Low


Thresholds

Input Status Indicator

The Operator tab shows the following information:


The current Mode (Program, Operator, or Maintenance).
Requested Modes Indicator (This only appears if the Operator or
Program Mode has been superseded by another mode.)
The current Process Variable.
A bar graph for the current Process Variable. High-High and Low-Low
ranges are show in dark gray and these ranges turn red if the threshold is
exceeded. High and Low ranges are shown in medium gray and these
ranges turn yellow if the threshold is exceeded.
Scaled High and Low Range Values (Top and Bottom labels on the bar
graph). If high range or low range values are exceeded, then the
appropriate icon appears next to the values to the left of the bar graph.

38

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

High-High (HH) and Low-Low (LL) thresholds are displayed with a


label background that turns red when exceeded.
High (H) and Low (L) thresholds are displayed with a label background
that turns yellow when exceeded
Input Status (Communication OK, Communication Fail or Bad PV
Quality, or Uncertain PV Quality)
The following table shows the alarm status indicators 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 is
logged but not displayed)
Alarm Disabled (by Maintenance)

Alarm Inhibited (by Program Logic)

The following table shows the functions on the Operator tab:


Button/Field

Action

Security
Required

Click to release Operator Mode


Lock.

Code B

Click to lock in Operator Mode.

Code B

Click to reset and acknowledge all


alarms.

Code F

Code C
Click to select normal input for
Process Variable. This button is
only visible in Maintenance Mode,
and only if Engineering has
enabled the Substitute PV
function.

Publication SYSLIB-RM001C-EN-E - October 2011

39

Chapter 4

HMI Reference

Button/Field

Substitute Process Variable data


entry

Action

Security
Required

Click to select substitute Process


Variable instead of normal input.
This button us only visible in
Maintenance Mode, and only if
Engineering has enabled the
Substitute PV function.

Code C

Enter the Substitute PV value. This Code C


entry is available only when the
Substitute PV function is enabled.)

PV Used in Simulation data entry Enter the Simulation PV value. This Code A
entry is available when Input
Simulation is enabled.

40

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

Alarms Tab

Alarm Acknowledge
Command Button

Reset and
Acknowledge All
Alarms Command
Button

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

Publication SYSLIB-RM001C-EN-E - October 2011

Color

Definition

Magenta

Fault

Red

Exception

Yellow

Warning

Blue

Information

Background (Light Gray)

No alarm

41

Chapter 4

HMI Reference

The following table lists the functions on the Alarms tab.


Button

Action

Security Required

Alarm Acknowledge

Code F

Reset and Acknowledge All


Alarms

Code F

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 requires
acknowledgement.
The Reset and Acknowledge All Alarms button is enabled if any alarm
requires reset or acknowledgement.

42

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

Maintenance Tab

Maintenance Mode
Acquire and Release
Command Buttons

Mode Indicator
Requested Modes Indicator

Status Thresholds
and Deadbands

The Maintenance tab shows the following information:


The current Mode (Program, Operator, or Maintenance).
Requested Modes Indicator - This display highlights all of the Modes
that have been requested. The left-most highlighted Mode is the active
Mode.

Publication SYSLIB-RM001C-EN-E - October 2011

43

Chapter 4

HMI Reference

The following table shows the functions on the Maintenance tab.


Button/Field

Action

Security
Required

Click for Maintenance Mode.

Code C

Click to release Maintenance


Mode.

Code C

Threshold

Enter the threshold (trip point) for


analog input alarms.

Code H

Deadband

Type the deadband (hysteresis) for


analog input alarms.

Code H

On-Delay

Enter the amount of time (in


seconds) the PV must exceed the
threshold before the
corresponding status is asserted.

Code D

Off-Delay

Enter the amount of time (in


seconds) the PV must stay within
the threshold (and deadband)
before the corresponding status is
cleared.

Code D

Bumpless Program/Operator
Transition

Select to enable or disable the


bumpless program/operator
transition of Status Threshold
settings (tracking).

Code C

Refer to Primary Operations on page 2 or the Process Add-On Instructions


and Graphics: Mode (P_Mode) Reference Manual, publication
SYSLIB-RM005, for more information on Modes.

44

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

Engineering Tab

Mode Configuration
Button
Configure Device
Description, Label,
and Tag Text

Configure Input and


Scaled Ranges

On the Engineering tab, users can configure the description, label, tag, and
Process Variable units for the device.
The following table lists the functions on the Engineering tab.
Button/Field

Action

Security
Required

Click to navigate to the Mode


Configuration popup.

Publication SYSLIB-RM001C-EN-E - October 2011

Description

Type the description.

Code E

Label

Type the label.

Code E

Tag

Type the tag.

Code E

Maximum Value for the Input


Variable

Type the maximum value for the


Input Process Variable (unscaled).

Code E

Minimum Value for the Input


Variable

Type the minimum value for the


Input Process Variable (unscaled).

Code E

45

Chapter 4

HMI Reference

Button/Field

Action

Security
Required

Maximum for the Scaled Value

Type the maximum for the Scaled


Process Variable (displayed).

Code E

Minimum for the Scaled Value

Type the minimum for the Scaled


Process Variable (displayed).

Code E

Disallow selection of Substitute


PV

Select to disallow selection of


substitute PV.

Code E

Clear Program Commands on


Receipt

Select (default) this checkbox to


use Edge-triggered Program
Commands. Deselect this
checkbox to use Level-triggered
Program Commands.

Code E

PV Filter Time Constant

Enter the time constant (in


seconds) for the first-order filter
applied to the analog input. If you
enter zero, filtering is not applied
to the input.

Code E

TIP
The P_AIn Instruction supports reverse scaling. Either the Raw (Input) or
Engineering (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 by
selecting a radio button. The radio buttons require security code E.

46

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

Trends Tab

Reset capture
min/max value

On the Trend tab, users can view the Process Variable and reset the capture
ranges 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.
Button

Publication SYSLIB-RM001C-EN-E - October 2011

Action

Security Required

Reset capture min/max values

Code A

47

Chapter 4

HMI Reference

Alarm Configuration Tab

The Alarm Configuration tab contains configuration related to the alarms


for the device.

48

Publication SYSLIB-RM001C-EN-E - October 2011

HMI Reference

Chapter 4

The following table shows the functions on the Alarm Configuration tab.
Check Box/Field

Action

Security
Required

Alarm

The alarm exists for the device.

Code E

Acknowledge Required

Require acknowledgement of the alarm.

Code E

IMPORTANT
If using FTView Alarm and Events,
configure its Alarm Tag for Acknowledge
Required. The controller handles
acknowledgement within this instruction.
Reset Required

Require a reset to clear the alarm status.


There is a single alarm reset that resets
all of the alarms for the device.

Code E

IMPORTANT
If using FTView Alarms and Events, DO
NOT check the Latched checkbox as the
controller handles the alarm reset within
this instruction.
Code E

Severity

Configure the severity level of the alarm:


1 = Information
2 = Warning
3 = Exception
4 = Fault

Minimum On Time

When an Alarm occurs, the Alarm output Code D


will be held on for at least this amount of
time (sec). If set to 5 seconds or less, the
Alarm output will be held on for at least 5
seconds to ensure it is seen by polling.
Set this time higher if you want an Alarm
to be held in the Alarm state (and on the
Alarm summary) longer. This will keep it
visible to the Operator, or keep the Alarm
from clearing and being set again for an
intermittent condition) until the Operator
has had time to perform any
Alarm-related actions.
Note: If the alarm is configured with
Reset Required (Cfg_ResetReqd = 1), the
operator can reset the alarm before this
time expires if the input condition has
returned to normal.

Publication SYSLIB-RM001C-EN-E - October 2011

49

Chapter 4

HMI Reference

Analog Input Faceplate Help

50

Publication SYSLIB-RM001C-EN-E - October 2011

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 and
application 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 TechConnect
support 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.
United States or Canada

1.440.646.3434

Outside United States or


Canada

Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html, or contact


your local Rockwell Automation representative.

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.
United States

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

Outside United States

Please contact your local Rockwell Automation representative for the return procedure.

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/.

Rockwell Otomasyon Ticaret A.., Kar Plaza Merkezi E Blok Kat:6 34752 erenky, stanbul, Tel: +90 (216) 5698400

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


Copyright 2011 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.

You might also like