Skip to content

AlarmBanner

List of active alarms with time, source, priority and message (SCADA-006, SCADA-007).

Not a safety-related system

The alarms 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.

AlarmBanner, light theme AlarmBanner, dark theme

Alarms and events · Widget catalog · API reference · schema alarmbanner.schema.json

Example

The traits of the picture above:

ai.AlarmBanner(label="AlarmBanner", size=(520, 140))

Traits

Trait Type Default Set by Description
size array [520,180] host [width, height] in CSS pixels.
value array of object [] derived Alarms that are not back to normal, {id, timestamp, source, priority, message, state}; the view sorts them (unacknowledged first, then priority and time). Written by the host (Python: raise_alarm(), clear_alarm()); without a host owning the state, the front end applies the acknowledgements (an alarm back to normal leaves the list) and writes the list back (HOST-004, 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.