getActiveAlarmsStateByPriority

Check whether any active alarm has a given priority.

Available in read and write scripts. Part of the virtual tag expression reference.

Returns whether any currently active alarm has a given priority.

getActiveAlarmsStateByPriority(priority: number): boolean;

Parameters

  • priority — the alarm priority to check for.

Return value

true if at least one active alarm has that priority, otherwise false.

Example

// 1 while any priority-1 alarm is active
getActiveAlarmsStateByPriority(1) ? 1 : 0;