ForceAlarm

Force activation of an alarm.

Description

ForceAlarm( alarmno )

This command will force the state of an alarm into active and trigger any alarm actions accordingly.

The alarm will be triggered even if the alarm is already active. 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

Return value

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

Example usage

   ForceAlarm(10);   // trigger alarm number 10