isAlarmActive

This function is used by Ignition's Expression language.

Description

Returns whether there are active alarms that match the provided criteria. The alarm name is optional, and both the tag path and alarm name support wildcards ('*'). For example, if only the tag path was specified, this function would return whether any alarm on the tag was active. The pollRate parameter is only applicable in the client scope.

note

When calling this from the Gateway scope, the Tag Provider must be included in the path.

Syntax

isAlarmActive(tagPath[, alarmName][, pollRate])

• Parameters

  • string tagPath - The tagpath to search for active alarms. Supports the wildcard '*'.

  • string alarmName - Optional. The name of the alarm to search for. Supports the wildcard '*'.

  • int pollRate - Optional. The poll rate in milliseconds. Only applicable in the client scope.

• Returns

  • Boolean - True if an alarm is active, False if no active alarms were found.

Examples

Code Snippet

isAlarmActive("[default]Tanks/Temp", "[default]Tank_Temp_High")   //when the Tank_Temp_High alarm is active then this expression returns True.