Process Add-On Instructions and Graphics:

Standard Alarm Sub-Block (P_Alarm)

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 Appli-
cation, 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 re-
sponsible 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 as-
sociated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the ex-
amples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described 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.

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

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

IMPORTANT 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,
ATTENTION
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
Standard Alarm Sub-Block (P_Alarm) 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-RM002C-EN-E - October 2011 iii

Summary of Changes

Notes:

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

 Table of Contents

Preface Use of this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Conventions and Related Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Set and Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Edge and Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Relay Ladder Rung Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Pre-Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Function Block States. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Entering Text in FactoryTalk View SE . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Chapter 1
Overview Primary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Standalone vs. Embedded in Other AOIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Implementation Using the EnableIn FALSE Feature . . . . . . . . . . . . . . . . . . 7
Revision Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2
Configuration Options Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Instruction Data Reference
Chapter 3
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Inputs (Inp_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Configurations (Cfg_). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Program Commands (PCmd_). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Operator Commands, Maintenance Commands, Command Readies
(OCmd_, MCmd_, Rdy_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Alarm Readies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Values (Val_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Status (Sts_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Alarm Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 4
HMI Reference Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Alarm Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Alarm Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Alarm Indicators on Other Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Rockwell Automation Publication SYSLIB-RM002C - October 2011 v

Table of Contents

Notes:

vi Rockwell Automation Publication SYSLIB-RM002C - October 2011

 Preface

Use of this Document This document provides a programmer with details on the P_Alarm
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 Set and Clear

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

This term: Means:

Set The bit is set to 1 (ON)
A value is set to any non-zero number
Clear The bit is cleared to 0 (OFF)
All the bits in a value are cleared to 0

viiPublication SYSLIB-RM002C-EN-E - October 2011 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 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 to a 0), and then performs the
function if possible.

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

 Preface

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-RM002C-EN-E - October 2011 ix

Preface

Pre-Scan

On 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 performs
all FOR loops and subroutine calls. If a subroutine is called more than once, it
is performed 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 FALSE and then performs its Pre-scan routine
as TRUE.

x Publication SYSLIB-RM002C-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 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).

Publication SYSLIB-RM002C-EN-E - October 2011 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-RM002C-EN-E - October 2011

 Chapter 1

Overview

The Alarm Add-On Instruction is used to monitor an input condition, and,

when it is true, raise an Alarm. This instruction handles Alarm
Acknowledgement, Alarm Reset, Alarm Inhibiting /Disabling, and Alarm
Suppression (for FactoryTalk Alarm and Events)

Use when:

You are developing your own Add-On Instruction (AOI) and you want
it to generate one or more Alarms that are compatible with the alarm
strategy for the Process Add-On Instructions. Use an instance of the
P_Alarm Instruction embedded within your AOI for each alarm
condition.
You have a condition in your logic (outside of any Add-On Instruction)
that you want to generate an Alarm. Use the P_Alarm Instruction
stand-alone within your program logic.

Do NOT use when:

You have a discrete input signal from a flow switch, pressure switch,
level switch or other device and want to display the device state,
generate alarms, or condition the alarm based on time or gating signals.
Use the P_DIn (Discrete Input) Add-On Instruction instead.
You need synchronized timestamping features or other features of
FactoryTalk Alarms and Events not supported by P_Alarm. Use the
ALMD built-in instruction instead.

IMPORTANT P_Alarm supports:

Alarm
Configurable minimum in-alarm time
Operator Acknowledge
Operator Suppress
Maintenance Disable
Program Inhibit
Engineer Exist

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

Chapter 1 Overview

The State Diagram below shows how a P_Alarm Instruction instance behaves
as an alarm occurs, is acknowledged, clears and is reset, depending upon the
instructions configuration.

A Inp = 1 B
Normal (Process Alarm/Unacked
Inp = 0 (Normal) Abnormal) Inp = 1 (Abnormal)
Alm = 0 (No Alarm) and Ack Alm = 1 (Alarm)
Ack = 1 (Acked) Required Ack = 0 (Unacked)

Inp = 1
(Process Operator Ack
Abnormal) or Ack
and Ack Not Required
Not Required

Inp = 0 C Inp = 0 Inp = 0

(Process Alarm/Acked (Process (Process
Normal) Inp = 1 (Abnormal) Normal) Normal)
and Reset Alm = 1 (Alarm) and Reset and Reset
Not Required Ack = 1 (Acked) Required Not Required

Inp = 0 (Process
Normal) and
Reset Required

F E
Inp = 1
Operator Reset RTN/Acked/Latched Operator Ack RTN/Unacked/Latched
(Process
or Reset Inp = 0 (Normal) or Ack Inp = 0 (Normal)
Abnormal)
Not Required Alm = 1 (Alarm) Not Required Alm = 1 (Alarm)
Ack = 1 (Acked) Ack = 0 (Unacked)

Operator Reset Reset

(also acknowledges) Not Required

D
Operator Ack RTN/Unacked/Not Latched
or Ack Inp = 0 (Normal)
Not Required Alm = 0 (No Alarm)
Ack = 0 (Unacked)

Initial Operator Operator Program Program Maintenance Maintenance

State Unsuppress Suppress Uninhibit Inhibit Enable Disable

G H I
Suppressed (Oper) Inhibited (Prog) Disabled (Maint)
Alarm is Logged as Alarm is not Reported Alarm is not Reported
an Event, but is not or Logged or Logged
displayed to operator
(Ack Not Required,
Reset Not Required)

NOTE: Bold lines denote default configuration. RTN means Returned To Normal

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

 Overview Chapter 1

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

Raise an Alarm when the Input is true.

IMPORTANT Alarm On-Delay and Off-Delay timing is handled by the logic

that triggers the P_Alarm instruction, not by the instruction
itself.

Ensure the alarm stays on for a configurable minimum time or until

reset, even if the input condition clears.
Handle Alarm Acknowledge Commands from the HMI or from other
logic. The requirement for acknowledgement is configurable. If
acknowledge is required, a new alarm clears the acknowledged status
and an Acknowledge Command is required to set the status. If
acknowledge is not required, the alarm is automatically acknowledged.
Handle Alarm Reset Commands from the HMI or from other logic. The
requirement for reset is configurable. If reset is required, the alarm
Input sets the Alarm condition, and it is latched in until the alarm Input
is clear and a Reset Command is received. If reset is not required, the
Alarm condition clears when the Input clears, and the minimum alarm
on time expires.

TIP An Add-On Instruction which contains one or more embedded

P_Alarm instances should provide a single Reset Command,
which is forwarded to the contained P_Alarm instances. This
same Reset Command may also be used to clear latched fault
conditions or otherwise reset the containing instruction.

Handle Maintenance Disable and Enable Commands, Program Inhibit

and Uninhibit Commands, and Operator Suppress and Unsuppress
Commands. Providing separate Commands and Status for these
functions allows automatic logic to inhibit an alarm at certain operating
sequence points, while Maintenance can independently disable the alarm
or the Operator can temporarily Suppress the alarm. When the
operating sequence uninhibits the alarm at the appropriate step, the
Maintenance Disable or Operator Suppress will still be in effect.

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

Chapter 1 Overview

IMPORTANT This object has Output Parameters that are directly written by
the HMI or Alarm Server to be compatible with FactoryTalk
Alarms and Events (tag-based) as well as Legacy Alarms
(RSView SE/ME/32). Output Parameters directly written by the
HMI are:
Ack (Acknowledgment, set by the HMI when the Alarm is
Acknowledged)
Disabled (set by the HMI to disable the Alarm, cleared to
enable the Alarm
Suppressed (set by the HMI when it is not displaying the
Alarm, cleared when unsuppressed
For Factory Talk Alarm and Events Tag Alarms, the alarm must
be configured with:
Acknowledge Required
Not Latched
(Legacy alarms are not configurable with those options.)
The P_Alarm instruction handles automatic acknowledgement
(Cfg_AckReqd = 0) and latching (Cfg_ResetReqd = 1).
The alarm must be configured with acknowledge required.
Legacy alarms are not configurable for Ack Not Required. The
P_Alarm instruction handles automatic acknowledge when
configured with Cfg-AckReqd = 0.

When an alarm is Suppressed (by the Operator):

The alarm is still sent to the Factory Talk Alarm and Event Server,
where it is logged.
The alarm is not displayed in the Alarm Banner or Alarm Summary.
Since it is not displayed, the operator does not need to acknowledge or
reset it.

When an alarm is Disabled (by Maintenance):

An existing alarm is cleared (reset) and acknowledged.

New alarm conditions are ignored.

4 Publication SYSLIB-RM002C-EN-E - October 2011

 Overview Chapter 1

When an alarm is Inhibited (by Program logic):

An existing alarm must be reset by the operator if Reset is Required.

An existing alarm must be acknowledged by the operator if
Acknowledge is Required.
New alarm conditions are ignored.

Operating Modes The Alarm Add-On Instruction has no Modes. It has Program, Operator, and
Maintenance Commands, but since this object controls no equipment, these
are accepted from each source at any time.

Standalone vs. Embedded This instruction may be used standalone, with the abnormal condition simply
written or wired to the Input (Inp) pin, or it may be embedded within another
in Other AOIs Add-On Instruction to provide Alarming for some condition. For example, a
Motor instruction may have P_Alarm AOIs for Failure to Start, Failure to Stop
and other conditions.

When embedded within another AOI, the following Commands and

Configuration parameters should be wired in or aliased from the containing
object:

Inp: Alarm Condition Input

Inp_Reset: Alarm Reset
PCmd_Reset: Program Command to Reset the Alarm
PCmd_Ack: Program Command to Acknowledge the Alarm
PCmd_Inhibit: Program Command to Inhibit the Alarm
PCmd_Uninhibit: Program Command to Uninhibit the Alarm
Cfg_AckReqd: Acknowledge Required Configuration
Cfg_ResetReqd: Reset Required Configuration
Cfg_MinOnT: The minimum amount of time (in seconds) the alarm
must be help in the alarm state (kept in the operators view) when it
occurs
Cfg_Severity: Alarm Severity 1 = Information, 2 = Warning,
3 = Exception, 4 = Fault
Cfg_Exists: 1 if Alarm should be processed, 0 if Alarm is not used and
Alarm logic should be skipped

The following output parameters should be wired out or aliased to Status bits
of the containing object to make the signals available for other logic:

Alm: Alarm Status

Ack: Acknowledgement Status
Disabled: Alarm Disabled Status

Publication SYSLIB-RM002C-EN-E - October 2011 5

Chapter 1 Overview

Inhibited: Alarm Inhibited Status

Suppressed: Alarm Suppressed Status

IMPORTANT All the above Parameters should be the targets of Alias

Parameters in the containing AOI. Ack, Disabled, and Inhibited
must be configured as Read/Write in RSLogix 5000 Version 18
or later for proper operation of Alarms with the FactoryTalk
Alarms and Events server tag-based Alarms.

The Alarm Input (Inp) can also be wired or aliased to a Status bit of the
containing instruction to provide status of the initiating condition of the
Alarm (in addition to the Alarm itself) outside the containing instruction.

Refer to HMI Reference on page 17 for Faceplate pieces that can be used
within other instructions' Faceplates for their Alarms.

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

Condition
EnableIn False (False Rung)
Powerup (Pre-scan, First Scan)
Postscan (SFC Transition)
Description
Processing for EnableIn False (False Rung) is
handled the same as the main Logic Routine except
that the state of Inp (the Input) is inverted. This
allows the P_Alarm Add-On Instruction in a Ladder
Diagram instance to have its input mapped by using
the rung condition instead of using a separate
branch or rung. Inp should be set to 1 when using
the on-rung mapping. The illustrations in
Implementation Using the EnableIn FALSE Feature
show both mapping methods.
No Powerup, Pre-scan or First Scan handling is
required or provided. The internal timers reset on
powerup, but the outputs are retained through a
power cycle or Run - Program - Run cycle.
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.

6 Publication SYSLIB-RM002C-EN-E - October 2011

 Overview Chapter 1

Implementation Using the For the convenience of Ladder Diagram programmers, the P_Alarm
instruction can be used in a Ladder Diagram Routine with the input condition
EnableIn FALSE Feature carried by the Rung-In condition instead of being mapped on a separate
branch.

The following illustration shows normal implementation with the input

condition mapped to Inp on a separate branch.

The following illustration shows EnableIn FALSE implementation with the

input condition mapped to the P_Alarm instruction using the Rung-In state.

The Rung-In condition determines whether the Add-On Instruction's normal

code (Logic Routine) is executed or its EnableIn False code (EnableInFalse
Routine) is executed. In the P_Alarm instruction, the EnableIn False code is
identical to the Logic code, except it uses the inverse of the Inp signal for
processing. To use the Rung-In mapping, method, set Inp to 1 (its default
value). When the rung is TRUE, Inp (=1) is treated as TRUE (not inverted, in
alarm), and when the rung is FALSE, Inp (=1) is treated as FALSE (inverted,
not in alarm).

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

Chapter 1 Overview

Revision Compatibility The P_Alarm Add-On Instruction is marked with revision information in
RSLogix 5000 software, as are any instructions which contain it. When you
import an instruction containing the P_Alarm instruction, the compatible
P_Alarm instruction is also imported.

The containing instructions Faceplate in FactoryTalk View software is also

marked with revision information. The following table shows revision
information for the P_AIn (Analog Input) instruction, which contains
P_Alarm instances, and its Faceplate:

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.

An instruction containing the P_Alarm Instruction and the containing

instructions 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 P_AIn Add-On Instruction (which uses P_Alarm)
and its Faceplate as shown are compatible because they have the same
Major.Minor (1.1).

8 Publication SYSLIB-RM002C-EN-E - October 2011

 Chapter 2

Configuration Options

Configuration Parameters Enter the appropriate values from the following table into the P_Alarm
Instructions configuration parameters to configure it for your application.

Use the containing instructions HMI Faceplate or the RSLogix 5000 Tag
Monitor function to set the applicable Configuration Parameter(s).

Parameter: Default: Faceplate Tab Usage: Associated Parameters:

Location:
Cfg_AckReqd ON Alarm When this parameter is:
Configuration
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
PCmd_Ack
OCmd_Ack

IMPORTANT

For FactoryTalk View Alarms and

Events Tag Alarms, the P_Alarm
instruction handles automatic
acknowledgement. Alaways check
the FTA&E Acknowledge Required
checkbox.
Cfg_Exists ON Alarm Set this parameter to: Alm
Configuration Ack
ON if this alarm instance is used.
The alarm logic is scanned, alarm Disabled
input transitions are monitored, Suppressed
and commands to Acknowledge,
Inhibited
Reset, Inhibit, Suppress, and
Disable are processed. Rdy_Ack
OFF if this alarm instance is not Rdy_Reset
used. Most alarm logic is skipped Rdy_Disable
(to improve scan time) and the
Rdy_Enable
alarm is set to a default (no alarm)
condition Rdy_Suppress
Rdy_Unsuppress

9Publication SYSLIB-RM002C-EN-E - October 2011 9

Chapter 2 Configuration Options

Parameter: Default: Faceplate Tab Usage: Associated Parameters:

Location:
Cfg_AlmMinOnT 0 sec Alarm Enter the amount of time the alarm Alm
Configuration must be kept visible to the operator.
This capability can be used to hold an
alarm in the Alarm Summary long
enough for the operator to address
the problem, even if the inout returns
to normal quickly.
Cfg_ResetReqd OFF Alarm When this parameter is: If this bit is set, when an alarm
Configuration occurs, the alarm status is
ON, the instruction latches the latched ON until one of the
alarms status. The instruction following occurs:
requires a Reset after the Input
signal returns to normal before The instruction receives a
clear the alarm. Reset command.
OFF, the instruction clears the Inp_Reset is asserted.
alarm after the Input signal
returns to normal. No Reset is Associated Parameters
required.
Alm
IMPORTANT
OCmd_Reset
If a reset is received when the alarm PCmd_Reset
condition is still active, no change Inp_Reset
occurs.
Rdy_Reset
For an unacknowledged alarm, if the
reset clears the alarm, it also
acknowledges it.
Cfg_Severity 3 Alarm This parameter determines the Val_Notify
Configuration Severity of the alarm, and thus the
color of alarm animations for the
alarm.

Valid values are:

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

10 Publication SYSLIB-RM002C-EN-E - October 2011

 Chapter 3

Instruction Data Reference

This chapter describes the P_Alarm 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.

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
EnableIn BOOL Input 1 Enable Input:
1 = Perform alarm processing, such as
delay, latch/reset, acknowledge,
enable/disable, inhibit/uninhibit,
and suppress/unsuppress.
0 = Perform Alarm processing, but
invert Alarm Input signal (Inp) for
use with the rung-in condition in
Ladder Diagram routines.
EnableOut BOOL Output 0 Enable Output:
The EnableOut signal is not
manipulated by this instruction. Its
output state always reflects the
EnableIn input state.

11Publication SYSLIB-RM002C-EN-E - October 2011 11

Chapter 3 Instruction Data Reference

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

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
Inp BOOL Input 1 Level Alarm Condition Input 1 = Alarm Cfg_AlmMinOnT

Inp_Reset BOOL Input 0 Level 1 = Reset Alarm requiring reset Cfg_ResetReqd

Configurations Configuration data elements are used to set configurable capabilities, features
and functions of the P_Alarm Instruction.
(Cfg_)
The following Configuration data may be modified by controller application
logic, using HMI Faceplate, or using the Tag Monitor in RSLogix 5000
software.

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
Cfg_Exists BOOL Input 1 Level 1 = Alarm configured to exist
0 = Does not exist; do not scan
Cfg_ResetReqd BOOL Input 0 Level 1 = Reset required to clear Alarm

Cfg_AckReqd BOOL Input 1 Level 1 = Acknowledge required for Alarm

Cfg_Severity SINT Input 3 Decimal Alarm Severity

1 = Information
2 = Warning
3 = Exception
4 = Fault
Cfg_AlmMinOnT DINT Input 0 Decimal Minimum time (sec) alarm output stays
on

12 Publication SYSLIB-RM002C-EN-E - October 2011

 Instruction Data Reference Chapter 3

Program Commands Program Command data elements are used by application logic to request
P_Alarm Instruction actions, such as acknowledging, inhibiting or resetting
(PCmd_) alarms. Application logic sets the Program Command to 1 to request the
action; the P_Alarm Instruction reads the 1, clears it to 0, then performs the
requested action if the action can be performed.

Alarm Commands

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
PCmd_Reset BOOL Input 0 Edge Program Command to Reset latched Cfg_ResetReqd
Alarm
PCmd_Ack BOOL Input 0 Edge Program Command to Acknowledge Cfg_AckReqd
Alarm
PCmd_Inhibit BOOL Input 0 Edge Program Command to Inhibit Alarm
(force Alm to 0)
PCmd_Uninhibit BOOL Input 0 Edge Program Command to Uninhibit Alarm

Operator Commands, Operator Commands and Maintenance Commands are used by the operator at
the HMI to request instruction actions, such as acknowledging, disabling,
Maintenance Commands, suppressing or resetting alarms. These Commands are set (latched) by the
Command Readies HMI and are read and then cleared (unlatched) and acted upon by the
(OCmd_, MCmd_, Rdy_) instruction, allowing a many-to-one relationship between HMI requestors and
each Command. Commands are implemented as public Input Parameters of
the instruction.

Alarm Commands

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
OCmd_Reset BOOL Input 0 Edge Operator Command to Reset latched Cfg_ResetReqd
Alarm
OCmd_Ack BOOL Input 0 Edge Operator Command to Acknowledge Cfg_AckReqd
Alarm
OCmd_Suppress BOOL Input 0 Edge Operator Command to Suppress Alarm

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

Chapter 3 Instruction Data Reference

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
OCmd_Unsuppress BOOL Input 0 Edge Operator Command to Unsuppress
Alarm
MCmd_Disable BOOL Input 0 Edge Maintenance Command to Disable
Alarm (force Alm to 0)
MCmd_Enable BOOL Input 0 Edge Maintenance Command to Enable
Alarm

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.

Alarm Readies

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
Rdy_Reset BOOL Output 0 1=Ready to receive OCmd_Reset
(enables HMI button)
Rdy_Ack BOOL Output 0 1=Ready to receive OCmd_Ack
(enables HMI button)
Rdy_Suppress BOOL Output 0 1=Ready to receive OCmd_Suppress
(enables HMI button)
Rdy_Unsuppress BOOL Output 0 1=Ready to receive OCmd_Unsuppress
(enables HMI button)
Rdy_Disable BOOL Output 0 1=Ready to receive MCmd_Disable
(enables HMI button)
Rdy_Enable BOOL Output 0 1=Ready to receive MCmd_Enable
(enables HMI button)

14 Publication SYSLIB-RM002C-EN-E - October 2011

 Instruction Data Reference Chapter 3

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

Associated
Data Configuration
Name: Type: Usage: Default: Style: Description: Parameter
Val_Notify SINT Output 0 Decimal Current Alarm Level and Cfg_Severity
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

Status 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
(Sts_) other application logic.

Alarm Status

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
Alm BOOL Output 0 Alarm Output: Cfg_ResetReqd
1 = In Alarm Cfg_AlmMinOnT
Ack BOOL Output 1 Alarm acknowledged status: Cfg_AckReqd
1 = Acknowledged
Inhibited BOOL Output 0 1 = Alarm Inhibited by logic (will not be
sent)
Suppressed BOOL Output 0 1 = Alarm Suppressed (not visible on
HMI)
Disabled BOOL Output 0 1 = Alarm Disabled by Operator (will
not be sent)

Publication SYSLIB-RM002C-EN-E - October 2011 15

Chapter 3 Instruction Data Reference

Associated
Configuration
Name: Data Type: Usage: Default: Style: Description: Parameter
Sts_Err BOOL Output 0 1 = Error in Config: see Err_bits for
reason
Err_MinDuration BOOL Output 0 1 = Error in Config: Invalid Min Duration
(use 0 to 2147483)
Err_Severity BOOL Output 0 1 = Error in Config: Invalid Severity (use
1 to 4)

16 Publication SYSLIB-RM002C-EN-E - October 2011

 Chapter 4

HMI Reference

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

Graphic Symbols The P_Alarm instruction is usually used within other device instructions to
provide alarm functions. This section describes the alarm indicators that
typically appear on the containing instructions Graphic Symbols.

Alarm Indicator

A single Alarm Indicator will appear on a devices graphic symbol when any of
its alarms are active, or when any alarms are inhibited, disabled or suppressed.
The graphic symbol has a color changing alarm border that blinks on
unacknowledged alarm.

Alarm Indicator

Alarm Border

17Publication SYSLIB-RM002C-EN-E - October 2011 17

Chapter 4 HMI Reference

In an active alarm condition, the color of the alarm bell symbol indicates the
highest active alarm severity, and the alarm border and label background blink
if acknowledgement of any alarm condition is required.

Symbol Description
Black I in white box with black Alarm Inhibit: an alarm is Inhibited by the
border Program, Disabled by Maintenance or
Suppressed by the Operator.
White bell, border, and text Return to Normal (no Alarm condition), but a
background previous Alarm has not been acknowledged

Blue border and text background Information Severity Alarm

Yellow rectangle with exclamation
point (!)
Yellow border and text background Warning Severity Alarm
Orange triangle with exclamation
point (!)
Red border and text background Exception Severity Alarm
Orange diamond with exclamation
point (!)
Magenta border and text background Fault Severity Alarm
Red circle with exclamation point (!)

No symbol or border displayed, text is on No Alarm or Alarm Inhibit condition, and all
normal (light gray) background, not blinking Alarms are Acknowledged

Invalid Configuration Indicator

The Invalid Configuration Indicator appears on a devices graphic symbol

when inappropriate configuration selections or entries are made.

Graphic Symbol Description

Invalid Configuration

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.

18 Publication SYSLIB-RM002C-EN-E - October 2011

 HMI Reference Chapter 4

For instructions which use the P_Alarm Instruction, the Invalid Configuration
Indicator appears when these alarm configuration errors are made:

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

Faceplate The P_Alarm instruction does not have its own Faceplate; instead, device
Faceplates include an Alarms tab and an Alarm Configuration tab. The tab
icons at the top of the Faceplate are used to navigate to the Alarms tab and
Alarm Configuration tab. The Alarms tab icon is animated, using the same
colors as the Alarm Indicator on the devices Graphic Symbol.
Maintenance Alarm Configuration Help

Operator Engineering Alarms Exit

There is also an Alarm Help display, which can be called up from the help
screens of objects that use the P_Alarm instruction.

Publication SYSLIB-RM002C-EN-E - October 2011 19

Chapter 4 HMI Reference

Alarms Tab

On the Alarms tab of a device or other Add-On Instruction Faceplate, there is

an Alarm Display Bar with an Acknowledge Command button for each Alarm.
Each Alarm Display Bar changes color according to the alarms severity and
the appropriate severity icon appears when the alarm is active. If the alarm
must be acknowledged, the bar and background blinks and the Acknowledge
Command button becomes active.

Color Indicates Severity Blinks When

Acknowledge Required

Acknowledge Button

The Alarm Display Bar also has indicators to show when the alarm is disabled,
inhibited, or suppressed.
Alarm Suppressed
(by Operator)
Alarm Inhibited
(by Logic)
Alarm Disabled
(by Maintenance)

The alarm severity associated with each bar color is shown in the following
table.

Color Severity
Magenta Fault
Red Exception
Yellow Warning
Blue Information
Background (Light Gray) No alarm

20 Publication SYSLIB-RM002C-EN-E - October 2011

 HMI Reference Chapter 4

The Alarms tab of a device or instruction with alarms includes an Alarm

Acknowledge Command button for each alarm and one Alarm Reset
Command button which resets all the alarms.

Button Action Security Required

Click to acknowledge the alarm Code F

Click to reset and acknowledge all Code F

alarm

Each Alarm Acknowledge button is enabled if the corresponding Alarm

requires acknowledgement.

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

Publication SYSLIB-RM002C-EN-E - October 2011 21

Chapter 4 HMI Reference

Alarm Configuration Tab

The Alarm Configuration tab of an instruction which uses P_Alarm

Instruction instances contains configuration selections and entries related to
the alarms.

The following table shows the functions typically available on the Alarm
Configuration tab for an instruction which uses P_Alarm instances for its
alarms.

Check Box/Field Action Security

Required
Alarm The alarm exists for the device. Code E

22 Publication SYSLIB-RM002C-EN-E - October 2011

 HMI Reference Chapter 4

Check Box/Field Action Security

Required
Acknowledge Required Requires acknowledgement of the alarm. Code E

IMPORTANT

If using FTView Alarm and Events, the

corresponding FTView Alarm
Acknowledge Required must be
configured the same as this
Acknowledge Required.
Reset Required Require a reset to clear the alarm status. Code E
There is a single alarm reset that resets
all of the alarms for the device.

IMPORTANT

If using FTView Alarms and Events, DO

NOT check the Latched checkbox as the
controller handles the alarm reset within
this instruction.
Severity Configure the severity level of the alarm: Code E
1 = Information
2 = Warning
3 = Exception
4 = Fault
Minimum On Time When an Alarm occurs, the Alarm output Code G
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-RM002C-EN-E - October 2011 23

Chapter 4 HMI Reference

Alarm Indicators on Other Tabs

Alarm Indicators are used on other tabs of an instruction Faceplate to show

alarm states. These indicators are detailed in the table below.

Icon Meaning
In 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 (disabled by Program Logic)

24 Publication SYSLIB-RM002C-EN-E - October 2011

 HMI Reference Chapter 4

Alarm Faceplate Help

An Instruction which has a Help Faceplate and which uses the P_Alarm
instruction will have a button on its Help Faceplate to call up the Alarm
Faceplate Help display.

Publication SYSLIB-RM002C-EN-E - October 2011 25

Chapter 4 HMI Reference

Notes:

26 Publication SYSLIB-RM002C-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
TechConnectSM 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

www.rockwel lautomation.com

Power, Control and Information Solutions Headquarters

Americas: Rockwell Automation, 1201 South Second Street, Milwaukee, WI 53204-2496 USA, Tel: (1) 414.382.2000, Fax: (1) 414.382.4444
Europe/Middle East/Africa: Rockwell Automation NV, Pegasus Park, De Kleetlaan 12a, 1831 Diegem, Belgium, Tel: (32) 2 663 0600, Fax: (32) 2 663 0640
Asia Pacific: Rockwell Automation, Level 14, Core F, Cyberport 3, 100 Cyberport Road, Hong Kong, Tel: (852) 2887 4788, Fax: (852) 2508 1846

Publication SYSLIB-RM002C - October 2011

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