DoAlarm
Trigger activation of an alarm.
Description
DoAlarm( alarmno, force, dparam, iparam1, iparam2, text, ... )
This command will change the state of an alarm into active and trigger any alarm actions accordingly. If the force parameter is 0/false and the alarm is already in active state, the actions are not re-triggered.
If the alarm is not active, the restore logic and holdoff will determine if/when the restore actions will execute.
Parameters
alarmno | The alarm number |
force | If set to TRUE/1, the actions will be run even if the alarm was already in alarm state |
dparam | A user-defined float value (accessed by [P2] in templates |
iparam1 | A user-defined integer value [P3] |
iparam2 | A user-defined integer value [P4] |
text | User defined formatted text to include in the alarm message [TEXT] |
Return value
Returns the previous state of the alarm. 1=alarm was already active. 0=alarm was not active.
Example usage
new t = 99; DoAlarm(4, 0, 1.1, 200, 333, "Too hot! Temp=%d degrees!", t);
NOTE: First appeared in firmware 24060601