SpokeXAlarmBorder Wizard option
- Last UpdatedAug 05, 2024
- 2 minute read
The Boolean value of SpokexAlarmBorder enables Alarm Border animation at the end point of Spokex during an alarm state. The default is False to not show Alarm Border animation.
Alarm Border animation appears as a colored circle at the end point of a Polar Star spoke whose measured value is in an alarm state. An Alarm Indicator shows the severity level of the alarm. The appearance of an alarm border indicates the alarm state, mode, severity, and shelved status of the most urgent alarm associated with the spoke.
Related Wizard options and custom properties
When set to True, additional custom properties appear and must be configured to enable Alarm Border animation.
|
Wizard options |
Custom properties |
|---|---|
|
SpokexAlarmBorder: True |
SpokeXAlarmIndicatorVisible custom property: Set to True to show an Alarm Indicator with Alarm Border animation. |
|
SpokeXAlarmMostUrgentAcked custom property: Set a Boolean value that indicates if the most urgent alarm is acknowledged or not. |
|
|
SpokeXAlarmMostUrgentInAlarm custom property: Set a Boolean value that indicates if the most urgent alarm is currently active or not. |
|
|
SpokeXAlarmMostUrgentMode custom property: Set an integer value that indicates the current mode of the most urgent alarm. |
|
|
SpokeXAlarmMostUrgentSeverity custom property: Set an integer value (1-4) that indicates the severity of the most urgent alarm. |
|
|
SpokeXAlarmMostUrgentShelved custom property: Set a Boolean value that indicates if the most urgent alarm is shleved or not. |