Alarm attributes
- Last UpdatedJul 20, 2024
- 2 minute read
If an alarm attribute is enabled, then the following additional alarm attributes become available. None of these attributes can be alarmed.
|
Attribute |
Description |
|---|---|
|
<Attribute>.Acked |
Used to specify whether an alarm has been acknowledged. This attribute is updated when the AckMsg attribute is set. This attribute is always set to FALSE when a new alarm condition is detected (when the InAlarm attribute changes from FALSE to TRUE). |
|
<Attribute>.AckMsg |
The operator comment at the time the alarm is acknowledged. Any received text is stored, and the Acked attribute is set to TRUE. Also, the TimeAlarmAcked attribute is set to the current time. The maximum length is 256 characters. |
|
<Attribute>.Category |
The category of the alarm. The label of each alarm category is fixed. |
|
<Attribute>.DescAttrName |
The name of the attribute (within the same object) to be used as the alarm message. The attribute you specify must be of type String or InternationalizedString, with a maximum string length of 329 characters. If no attribute is specified, the short description of the object is used as the alarm message. |
|
<Attribute>.InAlarm |
The alarm state. This is exactly the same as the attribute in the host primitive that
represents the alarm condition, except when the alarm state is disabled, in which
case, InAlarm is set to Off, regardless of the actual condition state. |
|
<Attribute>.Priority |
The value for the urgency of the alarm. Valid values are 1 through 999, with 1 being the most urgent. |
|
<Attribute>.TimeAlarmAcked |
The timestamp indicating the last time this alarm was acknowledged. The date format reflects the current locale setting for the operating system. |
|
<Attribute>.TimeAlarmOff |
The timestamp indicating the last time this alarm (as represented by the InAlarm attribute) went off. The date format reflects the current locale setting for the operating system. |
|
<Attribute>.TimeAlarmOn |
The timestamp indicating the last time this alarm (as represented by the InAlarm attribute) went on. The date format reflects the current locale setting for the operating system. |