Reference Manual

Rockwell Automation Library of Process Objects:

Analog Input Channel (P_AIChan)
Version 3.5

IMPORTANT This manual applies to the Rockwell Automation Library of Process Objects version 3.5 or earlier.
For Rockwell Automation Library of Process Objects version 5.0, see
• PROCES-RM200
For Rockwell Automation Library of Process Objects version 4.0 or later, use the following manuals:
• PROCES-RM013 contains logic instructions
• PROCES-RM014 contains display elements
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to
familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws,
and standards.

Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required
to be carried out by suitably trained personnel in accordance with applicable code of practice.

If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.

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

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

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

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

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

WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.

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

Labels may also be on or inside the equipment to provide specific precautions.

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

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.

ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to
potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL
Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).

Allen-Bradley, Rockwell Software, Rockwell Automation, RSLogix, Logix5000, FactoryTalk, PlantPAx, and ControlLogix are trademarks of Rockwell Automation, Inc.

Trademarks not belonging to Rockwell Automation are property of their respective companies.
 Table of Contents

Preface Software Compatibility and Content Revision. . . . . . . . . . . . . . . . . . . . . . . 5

Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Analog Input Channel (P_AIChan) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Analog Input Channel Input Structure . . . . . . . . . . . . . . . . . . . . . . . . . 11
Analog Input Channel Output Structure . . . . . . . . . . . . . . . . . . . . . . . 13
Analog Input Channel Local Configuration Tags . . . . . . . . . . . . . . . 16
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Threshold Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Analog Input Channel Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . 34

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 3

Table of Contents

Notes:

4 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Preface

This manual contains new and updated information. Changes throughout this
revision are marked by change bars, as shown to the right of this paragraph.

Software Compatibility and Table 1 - Summary of Changes

Content Revision Topic Page
Changed version from 3_1 to 3_5 9
Visualization Files - Split visualization files table by type and reordered to align with installation 9
requirements
Updated Alarm descriptions 17
Updated Status/Quality Indicator descriptions 19

For the latest compatible software information and to download the Rockwell
Automation® Library of Process Objects, see the Product Compatibility and
Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.

For general library considerations, see Rockwell Automation Library of Process

Objects, publication PROCES-RM002.

Additional Resources These documents contain additional information concerning related products
from Rockwell Automation.
Resource Description
PlantPAx® Distribution Control System Selection Guide, Provides information to assist with equipment
publication PROCES-SG001 procurement for your PlantPAx system.
PlantPAx Distribution Control System Reference Manual, Provides characterized recommendations for
publication PROCES-RM001 implementing your PlantPAx system.
Rockwell Automation Library of Process Objects, Provides general considerations for the Rockwell
publication PROCES-RM002 Automation system library of process objects.
FactoryTalk® View Machine Edition User Manual, Provides details on how to use this software package for
publication VIEWME-UM004 creating an automation application.
FactoryTalk View Site Edition User Manual, Provides details on how to use this software package for
publication VIEWSE-UM006 developing and running human-machine interface
(HMI) applications that can involve multiple users and
servers, distributed over a network.
Logix5000™ Controllers Add-On Instructions Programming Provides information for designing, configuring, and
Manual, publication 1756-PM010 programming Add-On Instructions.
Rockwell Automation Library of Process Objects: Common Details how to monitor an input condition to raise an
Alarm Block (P_Alarm) Reference Manual, publication alarm. Information includes acknowledging, resetting,
SYSLIB-RM002 inhibiting, and disabling an alarm. Generally the
P_Alarm faceplate is accessible from the Alarms tab.

You can view or download publications at

http:/www.rockwellautomation.com/literature/. To order paper copies of
technical documentation, contact your local Allen-Bradley® distributor or
Rockwell Automation sales representative.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 5

Preface

Notes:

6 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

The P_AIChan (Analog Input Channel) Add-On Instruction monitors one

analog input channel and provides one configurable alarm. There are no
dedicated display elements for this instruction. The faceplate is called from the
associated analog input instruction faceplate.

Add-On Instruction Faceplate

This instruction is usually associated with other instructions, with one instance
being used for each analog input of the associated instruction.

This instruction can be integrated with the following instructions in the

Rockwell Automation Library of Process Objects:
• Basic Analog Input (P_AIn)
• Advanced Analog Input (P_AInAdv)
• Dual Sensor Analog Input (P_AInDual)
• Multiple Analog Input (P_AInMulti)
• Flowmeter Dosing (P_DoseFM)
• Weigh Scale Dosing (P_DoseWS)

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 7

Analog Input Channel (P_AIChan)

Functional Description The P_AIChan Add-On Instruction monitors one analog input channel for the
following conditions:
• Invalid configuration
• I/O module fault
• Input out of range
• Instrument reports the following conditions:
– Out of specification (uncertain)
– Function check (substitute PV entered manually)
– Maintenance required
• Channel fault
• Input not-a-number (floating-point exception)
• Input stuck (unchanging)

For each condition, the Process Variable (PV) quality to report can be configured
as follows:
• Good
• Uncertain
• Bad (raises Fail alarm)

For each condition, the following actions can be taken:

• Pass the PV through unchanged
• Apply a configured replacement PV value
• Use the last good PV value

8 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times in
your application code as needed.

Controller File

The P_AIChan_3_5-00_AOI.L5X Add-On Instruction must be imported into

the controller project to be used in the controller configuration. The service
release number (boldfaced) can change as service revisions are created.

Visualization Files

http://www.rockwellautomation.com/global/support/pcdc.pageThis Add-On
Instruction has associated visualization files that provide a common user
interface. These files can be downloaded from the Product Compatibility and
Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.

IMPORTANT The visualization file dependencies require Process Library content imports to
occur in a specific order as reflected in the following tables:
• Images
• Global Objects
• Standard Displays
• HMI Tags
• Macros

Images are external graphic files that can be used in displays. They must be
imported for FactoryTalk View to make use of them.

When PNG files are imported, they are renamed by FactoryTalk View with
a .bmp file extension, but retain a .png format.
Table 2 - Visualization Files: Images (.png)
FactoryTalk View SE Software FactoryTalk View ME Software Description
All .png files in the images folder All .png files in the images folder These are the common icons used in the global objects and
standard displays for all Process Objects.

The Global Object files (.ggfx file type) in the following table are Process Library
display elements that are created once and referenced multiple times on multiple
displays in an application. When changes are made to a Global Object, all
instances in the application are automatically updated.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 9

Analog Input Channel (P_AIChan)

Table 3 - Visualization Files: Global Objects (.ggfx)

FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) Common Faceplate Objects (RA-BAS-ME) Common Faceplate Objects Global objects used on process object faceplates.
(RA-BAS) Process Alarm Objects (RA-BAS-ME) Process Alarm Objects Global objects used for managing alarms on process
object faceplates.
(RA-BAS) Process Faceplate Analog Objects (RA-BAS-ME) Process Faceplate Analog Objects Analog global objects used on process object faceplates.
(RA-BAS) Process Help Objects (RA-BAS-ME) Process Help Objects Global objects used for all process objects help displays.

The Standard Display files (.gfx file type) in the following table are the Process
Library displays that you see at runtime.
Table 4 - Visualization Files: Standard Displays (.gfx)
FactoryTalk View SE Software FactoryTalk View ME Software Description
(RA-BAS) Common-AnalogEdit N/A Faceplate used for analog input data entry. The FactoryTalk
View ME faceplates use the native analog input data entry
so no file is required.
(RA-BAS) P_AIChan-Faceplate (RA-BAS-ME) P_AIChan-Faceplate The faceplate that is used for the object.
(RA-BAS) P_AIChan-Help (RA-BAS-ME) P_AIChan-Help The Help display that is used for the object.
(RA-BAS) P_Alarm-Faceplate (RA-BAS-ME) P_Alarm-Faceplate The faceplate that is used for the object
(RA-BAS) P_Alarm-Help (RA-BAS-ME) P_Alarm-Help Alarm Help information that is accessed from the
P_AIarm faceplate.

HMI Tags are created in a FactoryTalk View ME application to support tab

switching on Process Library faceplates. The HMI tags may be imported via the
comma-separated values file (.csv file type) in the following table.
Table 5 - Visualization Files: HMI Tags (.csv)
FactoryTalk View SE Software FactoryTalk View ME Software Description
N/A FTVME_PlantPAxLib_Tags_3_5_xx.csv These tags must be imported into the
where xx = the service release number. FactoryTalk View ME project to support switching tabs on
any Process Object faceplate.

10 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Controller Code This section describes the parameter references for this Add-On Instruction.

Analog Input Channel Input Structure

Input parameters include the following:
• Input data elements (Inp_) are typically used to connect field inputs from
I/O modules or signals from other objects.
• Configuration data elements (Cfg_) are used to set configurable
capabilities and features of the instruction.
• Commands (PCmd_, OCmd_, MCmd_) are used by program logic,
operators, and maintenance personnel to request instruction actions.
Table 7 - P_AIChan Input Parameters
Input Parameter Data Alias For Default Description
Type
EnableIn BOOL 1 Ladder Diagram:
If the rung-in condition is true, the instruction’s Logic routine executes. If the rung-
in condition is false, the instruction’s EnableInFalse routine executes.
Function Block Diagram:
If true, or not connected, the instruction’s Logic routine executes. If the parameter
is exposed as a pin and wired, and the pin is false, the instruction’s EnableInFalse
routine executes.
Structured Text:
No effect. The instruction’s Logic routine executes.
Inp_Raw REAL 4.0 Input signal from transmitter or sensor (raw units).
Inp_ModFault BOOL 0 1 = I/O module failure or module communication status bad
0 = OK
Inp_ChanFault BOOL 0 1 = I/O channel fault or failure
0 = OK
Inp_OutOfSpec BOOL 0 1 = Out of specification (PV uncertain, from instrument)
0 = OK
Inp_FuncCheck BOOL 0 1 = Function check (PV substituted, from instrument)
0 = OK
Inp_MaintReqd BOOL 0 1 = Maintenance required (from instrument).
Inp_Reset BOOL 0 Input parameter used to programatically reset alarms. When set to 1, all alarms
requiring reset are reset.
Cfg_FailOnUncertain BOOL 0 1 = Raise Sts_Fail (and alarm) if Bad or Uncertain quality
0 = Only if Bad quality
Cfg_PCmdClear BOOL Mode.Cfg_PCmdClear 1 When this parameter is 1, program commands are cleared once they are acted
upon. When set to 0, program commands remain set until cleared by the
application program logic.
IMPORTANT: Clearing this parameter online can cause unintended program
command execution.
Cfg_HasFailAlm BOOL Fail.Cfg_Exists 0 This parameter determines whether the corresponding alarm exists and is checked
or if the alarm does not exist and is not used. When this parameter is 1, the
corresponding alarm exists.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 11

Analog Input Channel (P_AIChan)

Table 7 - P_AIChan Input Parameters

Input Parameter Data Alias For Default Description
Type
Cfg_FailResetReqd BOOL Fail.Cfg_ResetReqd 0 This parameters determines whether a reset is required to clear the alarm status.
When this parameter is 1, the alarm is latched ON when the alarm occurs. After the
alarm condition returns to normal, a reset is required to clear the alarm status (for
example, OCmd_Reset, Inp_Reset, or Fail.OCmd_Reset are required to clear
Alm_Fail alarm after the alarm is set and the value returns to normal). When this
parameter is 0, no reset is required and the alarm status is cleared when the alarm
condition returns to normal.
IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.
Cfg_FailAckReqd BOOL Fail.Cfg_AckReqd 1 This parameter determines whether an acknowledgement is required for an alarm.
When this parameter is 1, the acknowledge (ack) bit is cleared when the alarm
occurs. An acknowledge command (for example, PCmd_FailAck or Fail.OCmd_Ack)
is required to acknowledge the alarm. When set to 0, the Acknowledge bit is set
when an alarm occurs indicating an acknowledged alarm and no acknowledge
command is required.
Cfg_FailSeverity INT Fail.Cfg_Severity 1000 This parameter determines the severity of each alarm. This drives the color and
symbol that is used to indicate alarm status on the faceplate and global object.
The following are valid values:
1…250 = Low
251…500 = Medium
501…750 = High
751…1000 = Urgent
IMPORTANT: For FactoryTalk View software version 7.0, this severity parameter
drives only the indication on the global object and faceplate. The Alarms and
Events definition of severity drives the color and symbol that is used on the alarm
banner and alarm summary as well as the value returned by FactoryTalk Alarms
and Events display commands.
Cfg_InpRawMin REAL 4.0 Input (unscaled) minimum for scaling (raw units).
Cfg_InpRawMax REAL 20.0 Input (unscaled) maximum for scaling (raw units).
Cfg_PVEUMin REAL 0.0 Process Variable (PV) (output) minimum for scaling (engineering units).
Cfg_PVEUMax REAL 100.0 PV (output) maximum for scaling to engineering units.
TIP The P_AIChan instruction supports reverse scaling; either the raw (input) or
engineering (scaled) range can be reversed (maximum less than minimum).
Cfg_PVHiLim REAL 1.50E+38 PV high clamping threshold (engineering units).
Cfg_PVLoLim REAL -1.50E+38 PV low clamping threshold (engineering units).
Cfg_InpOORHiLim REAL 20.733334 Out-of-Range (fail) high limit (raw units).
Cfg_InpOORLoLim REAL 3.6666667 Out-of-Range (fail) low limit (raw units).
Cfg_InpOORDB REAL 0.06666667 Out-of-Range (fail) high/low deadband (raw units).
Cfg_InpOOROnDly DINT 0 Minimum time out-of-range to raise status (seconds).
Cfg_InpOOROffDly 0 Minimum time in-range to clear out-of-range status (seconds).
Cfg_InpOORAction SINT 1 PV action on: Out-of-range, stuck (unchanging), PV not a number, I/O module
fault, I/O channel fault, Inp_PVUncertain, function check, maintenance required,
Cfg_InpStuckAction or AOI configuration error:
Cfg_InpNaNAction 2 1 = Pass input PV through unchanged
2 = Hold last good PV value
Cfg_ModFaultAction 3 = Replace PV value with Cfg_PVReplaceVal
Cfg_ChanFaultAction
Cfg_OutOfSpecAction 1
Cfg_FuncCheckAction 3
Cfg_MaintReqdAction
Cfg_CfgErrAction

12 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Table 7 - P_AIChan Input Parameters

Input Parameter Data Alias For Default Description
Type
Cfg_InpOORQual SINT 3 PV quality to report for: Out-of-range, stuck (unchanging), PV not a number, I/O
module fault, I/O channel fault, Inp_PVUncertain, function check, maintenance
Cfg_InpStuckQual 1 required, or AOI configuration error:
Cfg_InpNaNQual 3 1 = Good
2 = Uncertain
Cfg_ModFaultQual 3 = Bad
Cfg_ChanFaultQual
Cfg_OutOfSpecQual 2
Cfg_FuncCheckQual 3
Cfg_MaintReqdQual
Cfg_CfgErrQual
Cfg_StuckT DINT 60 Time with no change in input to raise stuck status (s).
Cfg_PVReplaceVal REAL 0.0 Value (engineering units) to use to replace PV when action = replace.
PCmd_FailAck BOOL Fail.PCmd_Ack 0 • Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm
• The parameter is reset automatically
PCmd_FailSuppress Fail.PCmd_Suppress When Cfg_PCmdClear is 1:
PCmd_FailUnsuppress Fail.PCmd_Unsuppress • Set PCmd_<Alarm>Suppress to 1 to suppress alarm
• Set PCmd_<Alarm>Unsuppress to 1 to unsuppress alarm
• These parameters reset automatically
When Cfg_PCmdClear is 0:
• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
• Set PCmd_<Alarm>Suppress to 0 to unsuppress alarm
• PCmd_<Alarm>Unsuppress is not used
• These Parameters do not reset automatically
PCmd_FailUnshelve Fail.PCmd_Unshelve • Set PCmd_<Alarm>Unshelve to 1 to Unshelve alarm
• The parameter is reset automatically
PCmd_Reset BOOL 0 • Set PCmd_Reset to 1 to reset all alarms requiring reset
• This parameter is always reset automatically
OCmd_Reset BOOL 0 Operator command to reset all alarms requiring reset.
OCmd_ResetAckAll Operator command to acknowledge and reset all alarms.

Analog Input Channel Output Structure

Output parameters include the following:

• Value data elements (Val_) are numeric outputs of the instruction for use
by the HMI. Values also can be used by other application logic or software
packages.
• Source and Quality data elements (SrcQ_) are outputs of the instruction
used by the HMI to indicate PV source and quality.
• Status data elements (Sts_) are bit outputs of the instruction for use by the
HMI. Status bits also can be used by other application logic.
• Error data elements (Err_) are outputs of the instruction that indicate a
particular configuration error. If any Err_ bit is set, then the Sts_Err
configuration error summary status is set and the Invalid Configuration
indicator is displayed on the HMI.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 13

Analog Input Channel (P_AIChan)

• Alarm data elements (Alm_) are outputs of the instruction that indicate a
particular alarm has occurred.
• Acknowledge data elements (Ack_) are outputs of the instruction that
indicate the corresponding alarm has been acknowledged.
• Ready data elements (Rdy_) are bit outputs of the instruction
used by the HMI to enable or disable Command buttons and Setting entry
fields.
Table 8 - P_AIChan Output Parameters
Output Parameter Data Type Alias For Description
EnableOut BOOL Enable Output: The EnableOut signal is not manipulated by this instruction. Its output state
always reflects EnableIn Input state.
Val_InpRaw REAL Analog input value (raw units) (before scaling or checking).
Val PV value (engineering units).
Val_PVEUMin Minimum of scaled range = minimum (Cfg_PVEUMin, Cfg_PVEUMax).
Val_PVEUMax Maximum of scaled range = maximum (Cfg_PVEUMin, Cfg_PVEUMax).
SrcQ_IO SINT I/O signal source and quality.
SrcQ Final channel status source and quality.
GOOD 0 = I/O live and confirmed good quality
1 = I/O live and assumed good quality
2 = No feedback configured, assumed good quality
TEST 8 = Device simulated
9 = Device loopback simulation
10 = Manually entered value
UNCERTAIN 16 = Live input, off-specification
17 = Value substituted at device/bus
18 = Value substituted by maintenance (Has and not Use)
19 = Shed, using last good value
20 = Shed, using replacement value
BAD 32 = Signal failure (out-of-range, NaN, invalid combination)
33 = I/O channel fault
34 = I/O module fault
35 = Bad I/O configuration (for example, scaling parameters)
Val_Sts SINT Device confirmed status:
0 = PV Good
5 = PV Uncertain
6 = PV Bad
7 = Substitute PV
33 = Disabled
Val_Fault SINT Device fault status:
0 = none
32 = Fail
34 = Configuration error
Val_Notify SINT Current alarm level and acknowledgement (enumeration):
0 = No alarm
1 = Alarm cleared: a reset or acknowledge is required
2 = Low (acknowledged)
3 = Low (unacknowledged)
4 = Medium (acknowledged)
5 = Medium (unacknowledged)
6 = High (acknowledged)
7 = High (unacknowledged)
8 = Urgent (acknowledged)
9 = Urgent (unacknowledged)

14 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Table 8 - P_AIChan Output Parameters

Output Parameter Data Type Alias For Description
Sts_PVGood BOOL 1 = PV quality is Good (not flagged as Bad or Uncertain).
Sts_PVUncertain BOOL 1 = PV quality is flagged as Uncertain.
Sts_PVBad BOOL 1 = PV quality is flagged as Bad.
Sts_UseInp BOOL 1 = Using input to calculate PV (not replaced or held).
Sts_HoldLast BOOL 1 = Analog PV being held at last good value.
Sts_Clamped BOOL 1 = Analog PV being clamped at Low or High Limit.
Sts_Replaced BOOL 1 = Analog PV being replaced with configured value.
Sts_InpOORHiCmp BOOL 1 = Input PV exceeds out-of-range High limit.
Sts_InpOORLoCmp BOOL 1 = Input PV exceeds out-of-range Low limit.
Sts_InpOutOfRange BOOL 1 = Input is out-of-range (includes On-delay, deadband, Off-delay).
Sts_InpStuck BOOL 1 = Input is ‘stuck’ (unchanging).
Sts_InpNaN BOOL 1 = Input is not a number (floating point exception).
Sts_ModFault BOOL 1 = I/O module fault condition.
Sts_ChanFault BOOL 1 = I/O channel fault condition.
Sts_OutOfSpec BOOL 1 = Working outside specifications (from instrument).
Sts_FuncCheck BOOL 1 = Function check (PV simulated/replaced at instrument).
Sts_MaintReqd BOOL 1 = Maintenance is required (from instrument).
Sts_AlmInh BOOL 1 = An alarm is inhibited, disabled, or shelved, display icon.
Sts_Err BOOL 1 = Error in configuration (see detail Err_ bits for reason), display icon.
Err_Raw BOOL 1 = Error in configuration: raw input scaling minimum = maximum.
Err_EU BOOL 1 = Error in configuration: scaled engineering units minimum = maximum.
Err_Timer BOOL 1 = Error in timer preset (must be 0…2,147,483).
Err_DB BOOL 1 = Error in configuration: a status deadband is < 0.0.
Err_Alarm BOOL 1 = Error in configuration: alarm minimum on time, shelf time, or severity.
Sts_Fail BOOL Fail.Inp 1 = Analog input failure (Bad, Uncertain).
Alm_Fail BOOL Fail.Alm 1 = Analog input failure alarm (Bad, Uncertain).
Ack_Fail BOOL Fail.Ack 1 = Analog input failure alarm has been acknowledged.
Sts_FailDisabled BOOL Fail.Disabled 1 = Analog input failure alarm is disabled (by Maintenance).
Sts_FailSuppressed BOOL Fail.Suppressed 1 = Analog input failure alarm is suppressed (by Program).
Sts_FailShelved BOOL Fail.Shelved 1 = Analog input failure alarm is shelved (by Operator).
Rdy_Reset BOOL 1 = At least one alarm requires reset.
Rdy_ResetAckAll BOOL 1 = At least one alarm requires reset or acknowledgement.
P_AIChan BOOL Unique parameter name for auto-discovery.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 15

Analog Input Channel (P_AIChan)

Analog Input Channel Local Configuration Tags

Configuration parameters that are arrayed, string, or structure data types cannot
be configured as parameters for Add-On Instructions. Configuration parameters
of these types appear as local tags to the Add-On Instruction. Local tags can be
configured through the HMI faceplates or in Studio 5000 Logix Designer®
application by opening the instruction logic of the Add-On Instruction instance
and then opening the Data Monitor on a local tag. These parameters cannot be
modified by using controller logic or Logix Designer application export/import
functionality.
Table 9 - Local Configuration Tags
Tag Name Data Type Default Description
Cfg_Desc STRING_40 'Analog Channel Description for display on HMI. This string is shown in the title bar of the faceplate.
Quality'
Cfg_EU STRING_8 '%' Engineering units for display on HMI.
Cfg_Label STRING_20 'Analog In Channel' Label for graphic symbol displayed on HMI. This string appears on the graphic symbol.
Cfg_RU STRING_8 'mA DC' Raw Units for display on HMI.
Cfg_Tag STRING_20 'P_AIChan' Tag name for display on HMI. This string is shown in the title bar of the faceplate.

Operations This section describes the primary operations for Add-On Instructions.

Modes

The P_AIChan instruction does not have modes and does not use an embedded
P_Mode Add-On Instruction. The P_AIChan instruction is used to monitor an
analog input.

16 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Alarms

This instruction uses the following alarms, which are implemented by using
embedded P_Alarm and P_Gate Add-On Instructions.

Alarm Name P_Alarm Name P_Gate Name Description

Fail Fail None Raised when the PV is flagged as Bad, or when the PV
is flagged as Uncertain and Cfg_FailOnUncertain is 1.
The PV can be configured to be flagged as Bad or
Uncertain for the following reasons:
• Its value has not changed for more than the
configured Stuck PV time
• It is outside the configured failure range
thresholds for more than the Out of Range on-
delay time
• It is infinite or not a number (floating point
exception)
• Module Fault input is true
• Channel Fault input is true
• Out of Specification (measurement uncertain)
input is true
• Function Check (PV substituted at device) input is
true
• Maintenance Required input is true
• There is a Configuration Error (see Sts_Err and the
Err_ bits)

Parameters of the P_Alarm object can be accessed by using the following

convention: [P_Alarm Name].[P_Alarm Parameter].

See Rockwell Automation Library of Process Objects: Common Alarm Block

(P_Alarm) Reference Manual, publication SYSLIB-RM002, for more
information.

TIP The P_AIChan object's ‘Fail’ alarm is set to not exist by default. If you set this
alarm to exist, be aware that the P_AIChan object does not have its own
display elements. Thus, you do not have a graphic symbol with flashing border
to show and click to call up the P_AIChan faceplate. However, you can still get
to the P_AIChan instance's faceplate easily when it raises a failure alarm in
two different ways:
• Tie the Sts_PVBad output parameter of the P_AIChan instance to the
Inp_PVBad input parameter of the downstream object and enable that
object's I/O failure alarm. Enable the downstream object's navigation to its
upstream Channel object. When the P_AIChan raises its Fail alarm, the
symbol for the downstream object flashes. Call up the downstream
object's faceplate, then navigate from there to the P_AIChan faceplate.
• In the FactoryTalk Alarm and Events alarm setup, create a command string
for the P_AIChan ‘Fail’ alarm that opens the P_AIChan faceplate with that
instance's tag. Instructions for how to do this are included in the alarm
set-up PDF document that is included in the Rockwell Automation Library
download. When the alarm occurs, open the Alarm Summary screen.
Double-click the alarm in the summary list and the P_AIChan faceplate is
displayed.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 17

Analog Input Channel (P_AIChan)

Simulation

The Analog Input Channel Add-On Instruction does not have a Simulation
capability.

Execution

The following table explains the handling of instruction execution conditions.

Table 10 - P_AIChan Execution

Condition Description
EnableIn False (false rung) Clear any received commands. Reset internal timers. Clear the Fail alarm.
Flag input quality as ‘bad’. Show alarm inhibited status as disabled. Other
parameters are left in their last state.
Powerup (prescan, first scan) Reset internal timers. Clear any received commands.
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.

Programming Example The following example provides shows the connection from raw analog input
through process value by using the P_AIChan block.

The raw input value (Local:1:I.Ch0Data) from the analog input card is used as
the raw input value (Inp_Raw) for the P_AIChan block. The output value (Val)
and quality (SrcQ) from the P_AIChan block are used as inputs for the P_AIn
block. In this configuration, the P_AIn block uses the Cfg_HasChanObj
configuration parameter. The final output process value (Feedwater_Flow) is the
fully converted, scaled, and filtered analog value that is propagated through the
system.

The P_AIChan block also uses the Channel Fault and Module Fault parameters
taken from the same analog input module as the process value. Inp_ChanFault is
simply the tag value for the channel (Local:1:I.Ch0Fault). The Inp_ModFault
parameter (Rack1Slot4ModFault) is generated by using a GSV to the module
object (with the instance for the appropriate card and then the EntryStatus
parameter). The top four bits of the EntryStatus parameter are checked to make
sure they do not equal 2#0100_xxxx_xxxx_xxxx. The 0100 pattern indicates the
connection is “Running”. All other values are considered faulted.

18 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Display Elements The P_AIChan instruction is used in association with other device instructions
to provide input monitoring functions. There are no dedicated display elements
for this instruction. The faceplate is called from the associated instruction’s
faceplate.

Status/Quality Indicators

One of these symbols appears on the graphic symbol when the described
condition is true.
Graphic Symbol Description
Invalid configuration.

Data quality bad/failure.

Data Quality degraded: uncertain, test, simulation, substitution, or out of specification.

The input or device has been disabled.

Input Value clamped to minimum/maximum.

Value infinite or not a number.

Value has not changed (stuck).

Value is being replaced.

Value is being held at last good value.

No symbol displayed I/O communication and quality good, configuration valid.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 19

Analog Input Channel (P_AIChan)

TIP When the Invalid Configuration indicator appears, you can find what
configuration setting is invalid by following the indicators. The Invalid
Configuration indicator appears 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 is flagged with this indicator or appears in a
magenta box.

For the P_AIChan instruction, the Invalid Configuration indicator appears

under any of the following conditions:
• Input raw minimum and maximum scaling parameters are set to the same
value.
• Scaled EU minimum and EU maximum scaling parameters are set to the
same value.
• The Out-of-range On-delay timer or the Out-of-range Off-delay timer is
set to a value less than or greater than 2,147,483 seconds.
• The Stuck value timer is set to a value less than zero or greater than
2,147,483 seconds.
• Alarm Minimum On Time or Shelf Time is set to a value less than zero or
greater than 2,147,483 seconds.
• Alarm Severity is set to a value less than 1 or greater than 1000.
• A deadband is set to a value less than zero.

Threshold Indicators

These indicators show that the PV has exceeded a threshold.

Graphic Symbol Description

High threshold exceeded

Low threshold exceeded

20 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Alarm Indicators
One of these symbols appears on 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. Once the alarm is
acknowledged, the alarm border and label background remain the color that
corresponds to the severity of the alarm.
Symbol Border and Label Background Description
No change in color Alarm Inhibit: an alarm is suppressed by the Program,
disabled by Maintenance, or shelved by the Operator.

White Return to normal (no alarm condition), but a previous

alarm has not been acknowledged.

Blue Low severity alarm.

Yellow Medium severity alarm.

Red High severity alarm.

Magenta Urgent severity alarm.

No symbol No change in color No alarm or alarm inhibit condition, and all alarms
are acknowledged.

See Rockwell Automation Library of Process Objects: Common Alarm Block

(P_Alarm) Reference Manual, publication SYSLIB-RM002, for more
information.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 21

Analog Input Channel (P_AIChan)

Faceplate The P_AIChan faceplate consists of four tabs and each tab consists of one or
more pages.

The title bar of each faceplate contains the value of local configuration tags
Cfg_Tag and Cfg_Desc.

The Operator tab is displayed when the faceplate is initially opened.

Maintenance Alarms Exit

Operator Engineering Help

The faceplate provides the means for operators, maintenance personnel,

engineers, and others to interact with the P_AIChan instruction instance. When
a given input is restricted via Factory Talk View security, the required user
security code letter is shown in the tables.

22 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Operator Tab

The faceplate initially opens to the Operator (‘Home’) tab. From here, an
operator can monitor the device status.

The Operator tab shows the following information:

• Current PV value in raw and engineering units
• PV status
• Input Source and Quality indicator (see 'SrcQ' in the Output parameters
table on page 14 for details)

Reset and Acknowledge

All Alarms Command
Button
Input Bar Graph

Status Indicator

Raw Input Out-of-Range

High and Low Values Current PV

Input Source and

Quality Indicator

The following table lists the functions on the Operator tab.

Table 11 - Operator Tab Descriptions

Function Action Security Required
Click to reset and acknowledge all alarms. Acknowledge Alarms
(Code F)

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 23

Analog Input Channel (P_AIChan)

An Alarm indicator appears on the Operator tab when the corresponding

alarm occurs.

Fail Alarm

The following table shows the alarm status symbols used on the Operator tab.
Table 12 - Operator Tab Alarm Status
Graphic Symbol Alarm Status
In Alarm (Active Alarm)

In Alarm and Acknowledged

Out of Alarm but not Acknowledged

Alarm Suppressed (by Program)

Alarm Disabled (by Maintenance)

Alarm Shelved (by Operator)

24 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Maintenance Tab

Maintenance personnel use the information and controls on the Maintenance tab
to make adjustments to device parameters.

The following table shows the functions on the Maintenance tab.

Table 13 - Maintenance Tab Descriptions
Function Action Security Configuration Parameters
Value (EU) to use to Type the value to output as the PV Configuration Cfg_PVReplaceVal
replace PV when when a condition occurs that has its & Tuning
Action = Replace action set to ‘Replace’. Maintenance
(Code D)
Minimum time In Type the amount of time the input Cfg_InpOOROffDly
Range to clear Out must stay within the range thresholds
of Range Status (with deadband) to clear the Out of
(seconds) Range (fail) condition. The off-delay
time is used to prevent a chattering fail
detection on a noisy signal near a
range threshold.
Minimum time Out Type the amount of time the input Cfg_InpOOROnDly
of Range to raise must stay beyond a range threshold to
Status (seconds) cause an Out of Range (fail) condition.
The on-delay time is used to avoid an
unnecessary fail detection when the
input only momentarily exceeds the
threshold.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 25

Analog Input Channel (P_AIChan)

Table 13 - Maintenance Tab Descriptions

Function Action Security Configuration Parameters
Time with no Type the amount of time the input Configuration Cfg_StuckT
change in Input to must remain unchanged to trigger a & Tuning
raise Stuck Status stuck input condition. A value of zero Maintenance
means the input must change every (Code D)
instruction scan to avoid a stuck input
condition. Type a large value to disable
stuck input detection.
Input Out of Range Type the thresholds that are considered Disable • Cfg_InpOORHiLim
(Fail): Threshold out of range (failed). If the PV is greater Alarms • Cfg_InpOORLoLim
Maximum and than or equal to the high threshold, or Bypass
Minimum less than or equal to the low threshold Permissives
for the on-delay time, it is considered and Interlocks
out of range. (Code H)
Input Out of Range Type the deadband to use with the out- Cfg_InpOORDB
(Fail): Deadband of-range thresholds. If the PV is less
than the high threshold minus the
deadband and the PV is greater than
the low threshold plus the deadband
for the off-delay time, it is considered
in range (not failed). The deadband
must be greater than or equal to zero.
PV Clamping Limits Type the low clamping limit for the PV. Configuration Cfg_PVLoLim
(EU): Low This clamps (limits) the PV so it does & Tuning
not go below this value. Maintenance
IMPORTANT: Out-of-Range detection (Code D)
uses the PV value before clamping. This
entry does not affect Out-of-Range
detection.
PV Clamping Limits Type the high clamping limit for the PV. Cfg_PVHiLim
(EU): High This clamps (limits) the PV so it does
not exceed this value.
IMPORTANT: Out-of-Range detection
uses the PV value before clamping. This
entry does not affect Out-of-Range
detection.

26 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Engineering Tab

The Engineering tab provides access to device configuration parameters and

ranges, options for device and I/O setup, displayed text, and
faceplate-to-faceplate navigation settings, for initial system commissioning or
later system changes.

The Engineering tab is divided into two pages.

Engineering Tab Page 1

On Page 1 of the Engineering tab, you can configure the description, label, tag,
and PV units for the device.

Configure Device Description,

Label, and Tag

Configure Raw Input Configure Scaled Input

Maximum/Minimum Maximum/Minimum

Raw and Scaled Units

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 27

Analog Input Channel (P_AIChan)

The following table lists the functions on page 1 of the Engineering tab.
Table 14 - Engineering Tab Page 1 Description
Function Action Security Configuration Parameters
Description Type the device description to show Engineering Cfg_Desc
on the Faceplate title bar. Configuration
(Code E)
Label Type the label to show on the graphic Cfg_Label
symbol.
Tag Type the tag name to show on the Cfg_Tag
faceplate title bar and in the Tooltip.
IMPORTANT: Pausing the mouse
over this field displays a tool tip with
the configured Logix tag/path.
Raw Input Scaling: Type the range of the signal • Cfg_InpRawMax
Input - Maximum connected to the Inp_PV Input. The • Cfg_InpRawMin
Raw Min default is 4.0 and the Raw
Raw Input Scaling: Max default is 20.0.
Input - Minimum EXAMPLE: If your input card provides
a signal from 4.0…20.0 mA, set
Cfg_InpRawMin to 4.0 and
Cfg_InpRawMax to 20.0. The Raw
minimum/maximum and
engineering units minimum/
maximum are used for scaling to
engineering units.
Raw Input Scaling: Type the PV range represented by the • Cfg_PVEUMax
Scaled - Maximum input signal connected to Inp_PV. • Cfg_PVEUMin
The PV engineering units minimum
Raw Input Scaling: default is 0.0 and the PV engineering
Scaled - Maximum units maximum is 100.0.
EXAMPLE: If your input card provides
a signal from 4…20 mA that
represents -50…250 °C, set
Cfg_PVEUMin to -50.0 and
Cfg_PVEUMax to 250.0.
The Raw Min/Max and PV
engineering units Min/Max are used
for scaling to Engineering Units.
Input Units Type the units of measure for the Cfg_RU
input signal. “mA DC” is the default.
Scaled Units Type the engineering units for display Cfg_EU
on the HMI. Percent (%) is the
default.
Fail if Bad or Check to trigger a failure condition Cfg_FailOnUncertain
Uncertain quality and alarm when the PV status is
(unchecked will fail either Bad or Uncertain.
on Bad quality) Clear this checkbox to trigger the
failure condition when only the PV
status is Bad.
Clear Program Check to clear program commands on Cfg_PCmdClear
Commands upon receipt.
receipt

28 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Engineering Tab Page 2

The following table shows the functions on page 2 of the Engineering tab.
Table 15 - Engineering Tab Page 2 Description
Function Action Security Configuration Parameters
Invalid When the P_AInChan configuration Engineering Cfg_CfgErrAction
Configuration - is not valid: Configuration
Action = Use Input, • Use the input to determine value (Code E)
Hold Input, or • Hold value at its last good value
Replace PV • Set value by using
Cfg_PVReplaceVal
Invalid When the P_AIChan configuration is Cfg_CfgErrQual
Configuration - not valid:
Quality = Good • Set Sts_PVGood
Quality, Uncertain, • Set Sts_PVUncertain
or Bad Quality • Set Sts_PVBad
Channel Fault- When there is a channel fault: Cfg_ChanFaultAction
Action = Use Input, • Use the input to determine value
Hold Input, or • Hold value at its last good value
Replace PV • Set value by using
Cfg_PVReplaceVal

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 29

Analog Input Channel (P_AIChan)

Table 15 - Engineering Tab Page 2 Description

Function Action Security Configuration Parameters
Channel Fault - When there is a channel fault: Engineering Cfg_ChanFaultQual
Quality = Good • Set Sts_PVGood Configuration
Quality, Uncertain, • Set Sts_PVUncertain (Code E)
or Bad Quality • Set Sts_PVBad
Module Fault- When there is a module fault: Cfg_ModFaultAction
Action = Use Input, • Use the input to determine value
Hold Input, or • Hold value at its last good value
Replace PV • Set value by using
Cfg_PVReplaceVal
Module Fault - When there is a module fault: Cfg_ModFaultQual
Quality = Good • Set Sts_PVGood
Quality, Uncertain, • Set Sts_PVUncertain
or Bad Quality • Set Sts_PVBad
Input not a Number When the input is not a number: Cfg_InpNaNAction
- Action = Use • Use the input to determine value
Input, Hold Input, • Hold value at its last good value
or Replace PV • Set value by using
Cfg_PVReplaceVal
Input not a Number When the input is not a number: Cfg_InpNaNQual
- Quality = Good • Set Sts_PVGood
Quality, Uncertain, • Set Sts_PVUncertain
or Bad Quality • Set Sts_PVBad
Input out of Range- When the input is out of range: Cfg_InpOORAction
Action = Use Input, • Use the input to determine value
Hold Input, or • Hold value at its last good value
Replace PV • Set value by using
Cfg_PVReplaceVal
Input out of Range- When the input is out of range: Cfg_InpOORQual
Quality = Good • Set Sts_PVGood
Quality, Uncertain, • Set Sts_PVUncertain
or Bad Quality • Set Sts_PVBad
Function Check - When Inp_FuncCheck is set: Cfg_FuncCheckAction
Action = Use Input, • Use the input to determine value
Hold Input, or • Hold value at its last good value
Replace PV • Set value by using
Cfg_PVReplaceVal
Function Check - When Inp_FuncCheck is set: Cfg_FuncCheckQual
Quality = Good • Set Sts_PVGood
Quality, Uncertain, • Set Sts_PVUncertain
or Bad Quality • Set Sts_PVBad
Input Stuck - Action When the input is stuck Cfg_InpStuckAction
= Use Input, Hold (not changing):
Input, or Replace PV • Use the input to determine value
• Hold value at its last good value
• Set value by using
Cfg_PVReplaceVal

30 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Table 15 - Engineering Tab Page 2 Description

Function Action Security Configuration Parameters
Input Stuck - When the input is stuck Engineering Cfg_InpStuckQual
Quality = Good (not changing): Configuration
Quality, Uncertain, • Set Sts_PVGood (Code E)
or Bad Quality • Set Sts_PVUncertain
• Set Sts_PVBad
Maintenance When Inp_MaintReqd is set: Cfg_MaintReqdAction
Required - Action = • Use the input to determine value
Use Input, Hold • Hold value at its last good value
Input, or Replace PV • Set value by using
Cfg_PVReplaceVal
Maintenance When Inp_MaintReqd is set: Cfg_MaintReqdQual
Required - Quality • Set Sts_PVGood
= Good Quality, • Set Sts_PVUncertain
Uncertain, or Bad • Set Sts_PVBad
Quality

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 31

Analog Input Channel (P_AIChan)

Alarms Tab

The Alarms tab displays each configured alarm for the P_AIChan instruction.
The icon on the tab for the alarms page changes color based on the current active
alarms. A blinking alarm icon indicates that one or more alarms must be
acknowledged or the device must be reset.

Alarm Acknowledge
Alarm Severity Indicators
Command Button

Reset and Acknowledge All

Alarm Name
Alarms Command Button

Click an alarm name to open the P_Alarm faceplate for that alarm. From the
P_Alarm faceplate, you can configure and perform additional operations on
the alarm.

If an alarm is active, the panel behind the alarm changes color to match the
severity of the alarm. The color of the bell icon at the top of the faceplate shows
the severity of the highest active alarm, and the icon blinks if any alarm is
unacknowledged or requires reset.

32 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

 Analog Input Channel (P_AIChan)

Table 16 - Alarm Severity Colors

Color Definition
Magenta Urgent
Red High
Yellow Medium
Blue Low
White (bell icon) Alarm has cleared but is unacknowledged
Background (Light Gray) No alarm

The following table shows the functions on the Alarms tab.

Table 17 - Alarms Tab Description
Function Action Security
Alarm Name Click an alarm name to open the associated None
P_Alarm faceplate.
Click to acknowledge the alarm. Acknowledge Alarms
(Code F)

Click to reset and acknowledge all alarms.

When the Reset and Acknowledge All Alarms button is enabled, the panel
behind the alarm blinks, indicating the alarm requires acknowledgement or reset.
The Alarm Acknowledge button is enabled if the alarm requires
acknowledgment. Click the button with the check mark to acknowledge the
alarm.

See Rockwell Automation Library of Process Objects: Common Alarm Block

(P_Alarm) Reference Manual, publication SYSLIB-RM002, for
more information.

Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016 33

Analog Input Channel (P_AIChan)

Analog Input Channel Faceplate Help

Faceplate Help

34 Rockwell Automation Publication SYSLIB-RM042C-EN-P - January 2016

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 and application notes, sample code, and links to
software service packs. You can also visit our Support Center at https://rockwellautomation.custhelp.com/ for software
updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.

In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more
information, contact your local distributor or Rockwell Automation representative, or visit
http://www.rockwellautomation.com/services/online-phone.

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/rockwellautomation/support/overview.page, or contact your local
Rockwell Automation representative.

New Product Satisfaction Return

Rockwell Automation tests all of its products to help 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 Automation maintains current product environmental information on its website at

http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page.

Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400

Publication SYSLIB-RM042C-EN-P - January 2016

Supersedes Publication SYSLIB-RM042B-EN-P - August 2014 Copyright © 2016 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.