alarmValue

Check whether an alarm is currently active from a virtual tag script.

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

Returns whether an alarm is currently active.

alarmValue(alarmPath: string): boolean;

Parameters

• alarmPath — the path to the alarm. Use Shift + Alt + A in the editor to insert it.

Return value

true if the alarm is active, otherwise false.

Example

// 1 when the high-temperature alarm is active, else 0
alarmValue("Boiler/High temperature") ? 1 : 0;