DoRestore

Trigger restore of an alarm.

Description

DoRestore( alarmno, force, dparam, iparam1, iparam2, text, ... )

This command will change the state of an alarm into restored and trigger any alarm actions accordingly. If the force parameter is 0/false and the alarm is not in active state, the actions are not re-triggered.

If the alarm is in alarm state, 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 restored 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 message [TEXT]

Return value

Returns the previous state of the alarm. 1=alarm was active. 0=alarm was not active.

Example usage

   new m = 14;
   DoRestore(4, 0, 1.1, 200, 333, "Door closed. Was open %d minutes.", m);

NOTE: First appeared in firmware 24060601