AlarmIndicator¶
Single alarm annunciator with the ISA-18.2 alarm states (SCADA-005, SCADA-007).
Not a safety-related system
The alarm shown here may be delayed, lost or stale. It is for visualization, teaching, simulation and supervision; it is not a safety-related system and must not perform a safety function. See the safety notice.

Alarms and events · Widget catalog · API reference ·
schema alarmindicator.schema.json
Example¶
The traits of the picture above:
ai.AlarmIndicator(
value="active_unacknowledged",
label="Alarm",
alarm_id="TK-101.HI",
message="Tank level high",
size=(280, 64),
)
Traits¶
| Trait | Type | Default | Set by | Description |
|---|---|---|---|---|
alarm_id |
string | "" |
host | Identifier passed to the acknowledgement callbacks. |
message |
string | "" |
host | Alarm message (plain text, SEC-002). |
priority |
"low", "medium", "high", "critical" |
"high" |
host | Priority, shown by a shape and a P1 .. P4 text as well as a color (A11Y-003). |
size |
array | [260,64] |
host | [width, height] in CSS pixels. |
value |
"normal", "active_unacknowledged", "active_acknowledged", "cleared_unacknowledged" |
"normal" |
host, widget | ISA-18.2 alarm state. Transitions (x-awi-transitions, [state, event, next]): activate and clear come from the host; acknowledge from the operator (ACK), applied by the host when it owns the state, otherwise by the front end, which always sends the ack message (HOST-012). |
Common traits (8), shared with other widgets
| Trait | Type | Default | Set by | Description |
|---|---|---|---|---|
mode |
"control", "indicator" |
"control" |
host | "control": the user sets the value; "indicator": display only. |
label |
string | "" |
host | Plain text, never interpreted as HTML (SEC-002). |
disabled |
boolean | false |
host | Greyed out, input rejected. |
visible |
boolean | true |
host | |
tooltip |
string | "" |
host | Plain text shown on hover. |
style |
"modern", "classic", "system" |
"modern" |
host | |
theme |
"auto", "light", "dark", "system" |
"auto" |
host | "auto": the style decides; "system": the host page or the operating system (STYLE-007). |
skin |
object | {} |
host | Replaceable drawing parts: part name -> SVG source, sanitized (STYLE-005, STYLE-006). |
Set by: host, the program (Python, Julia, ...); widget, the user through the widget;
derived, computed from other traits by the host that owns the state, or by the widget.
See the trait contract.