Skip to end of metadata
Go to start of metadata

 

Alarming is a core feature of the Ignition platform. Alarms are conditions that are evaluated with respect to a specific numeric data point. Most commonly, alarms are configured on a Tag.

To configure an alarm on a tag

  1. Double-click on the tag to edit it.
    The Tag Editor window is displayed. 
     
  2. Click on Alarming, click the green plus sign + to add a New Alarm to the tag.
     
  3. Enter a Name for the Alarm and set any other settings you wish.
     
  4. In the Alarm Mode Settings choose the appropriate logic that determines if the alarm is active or not.
     
  5. Click Apply or OK to commit the new alarm.
    Ignition will start monitoring the alarm immediately. 

IULocgo


Configure Alarm on a Tag

 

 

 

Alarm Attributes

All alarm states have a list of properties that you can edit or bind when creating or editing a tag. Here is the list of attributes paired with their scripting names. This is useful when using the system.tag.add() and system.tag.edit() functions.

If the attribute you want to reference is not listed, you can simply change the attribute on your tag, export it to XML, and view the reference to the alarm attribute. 

GroupProperty NameScripting NameDescription
Main
 

Priority

priorityThe priority (or "severity") of this alarm. Diagnostic (0), Low (1), Medium (2), High (3), Critical (4)
 Timestamp SourcetimestampSourceDictates whether the timestamp used on the alarm comes from the system or the value. System (0), Value (1)
 Display PathdisplayPathAn optional path (separated by "/") that will be used for display and browsing purposes.
 Ack ModeackModeHow acknowledgement works for the alarm: Auto (1) - Alarm is acknowledged when cleared. Manual (2) - Alarm acknowledged by user. Unused (0) - Alarm is always marked as 'acknowledged'.
 NotesnotesDocumentation about the alarm.
 Ack Notes RequiredackNotesReqdSelect this option to require operators to provide some explanation when the alarm is acknowledged. true or false
 Shelving AllowedshelvingAllowedtrue or false
Alarm Mode Settings
 Modemode

The alarm mode. Equal (0), Not Equal (1), Above Setpoint (2), Below Setpoint (3), Between Setpoints (4), Outside Setpoints (5), Out of Range (6),

Bad Quality (7), Any Change (8), Bit State (9), On Condition (10)

 Setpoint / Low SetpointsetpointAThe value used to initiate an alarm. If the alarm mode calls for two setpoints, this is the low value.
 Inclusive / Low InclusiveinclusiveAIf true, the Setpoint or Low Setpoint value is used inclusively for the condition to alarm.
 High SetpointsetpointBThe high value used to initiate an alarm when the alarm mode calls for two setpoints.
 High InclusiveinclusiveBIf true, the High Setpoint value is used inclusively for the condition to alarm.
 Any ChangeanyChangeIf true, will alarm on each value change given the alarm mode conditions are met.
 Bit PositionbitPositionThe position of the bit, starting at 0, that will be watched.
 On ZerobitOnZeroIf true, will alarm when the specified bit is not high, or "0".
Deadbands and Time Delays
 DeadbanddeadbandA numeric deadband of the alarm condition. The interpretation of this value depends on the deadband mode. Note that his deadband is separate from, and evaluated after, the tag's deadband.
 Deadband ModedeadbandModeDefines how the deadband value is used. If percent, the value (0-100) will be compared against the Eng. limits defined for the value. Absolute (0), Percent (1)
 Active DelaytimeOnDelaySecondsThe time, in seconds, before the alarm will be considered truly active after the active condition becomes true. Also known as a "rising edge time deadband".
 Clear DelaytimeOffDelaySecondsThe time, in seconds, before the alarm will be considered truly clear after the clear condition becomes true. Also know as a "falling edge time deadband".
    
Notifications

 

Active PipelineactivePipelineThe pipeline that will be used to process active events generated by this alarm.
 Clear PipelineclearPipelineThe pipeline that will be used to process clear events generated by this alarm.
 Ack PipelineackPipelineThe pipeline that will be notified when the alarm has been acknowledged.
Email Notification Settings
 Custom SubjectCustomEmailSubjectIf specified, will be used for the email subject. If blank, the subject defined in the notification block to be used.
 Custom EmailCustomEmailMessageIf specified, will be used for email message. If blank,. the message defined in the notification block will be used.
SMS Notification Settings
 Custom MessageCustomSmsMessageIf specified, will be used for the SMS message. If blank, the message defined in the notification block will be used.
Associated Data
 yourAssociatedDatayourAssociatedData 

 

 

 

  • No labels