ReferenceControlArcReferenceStandard LibraryStatus

status

Arc standard library reference for the status module

The status module publishes status notifications (alarms, warnings, and operational states) to the Core.

set

Sets a status notification (an alarm, warning, or operational state) on the Core, addressing it by name or by key, and outputs the resolved status key.

Parameters

ParameterTypeRequiredDescription
key_or_namestrYesAn existing status key or name. A match is updated in place; if none matches, a new status is created with this name; if several statuses share the name, the first is updated and a warning is surfaced.
messagestrYesThe message body shown on the status.
variantstrYesOne of success, info, warning, error, loading, or disabled.

Output str: the resolved status key that was set.

If a status.set fails (for example, an empty key_or_name or a database error), it reports a warning and the automation keeps running.

trigger -> status.set{
    key_or_name = "ox_alarm",
    variant = "error",
    message = "Overpressure detected"
}

func raise_alarm() {
    alarm_key = status.set(
      "ox_alarm",
      "Overpressure detected",
      "error"
    )
}