Alarm Information [ezeio documentation]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

===== Alarm Information ======

==== ai(alarmno, mode) ====

Returns information of a given alarm.

=== Description ===

<code>ai(3, AL_HOLDOFF)</code>

Returns the remaining holdoff time for alarm #3.

=== Parameters ===

| ''alarmno'' | Alarm number |
| ''mode'' | What information is requested |

=== mode ===

| ''AL_STATE'' | The alarm state (1=in alarm, 0=not in alarm) |
| ''AL_HOLDOFF'' | The remaining time on the holdoff timer (in seconds) |
| ''AL_ALARMHOLDOFF'' | The alarm holdoff setting (in seconds) |
| ''AL_RESTOREHOLDOFF'' | The restore holdoff setting (in seconds) |
| ''AL_ISALARM'' | Returns 1 if the alarm condition is true. Otherwise 0 |
| ''AL_ISRESTORE'' | Return 1 if the restore condition is true. Otherwise 0 |
| ''AL_RETRIGCOUNT'' | Number of times the alarm has be re-triggered |
| ''AL_RETRIGDELAY'' | Time remaining on the alarm retrigger delay (in seconds) |
| ''AL_RETRIGCOUNTSET'' | Retrigger count configured |
| ''AL_RETRIGDELAYSET'' | Retrigger delay configured (in seconds) |

=== Return value ===

This function returns information about the alarm based on the mode parameter

=== Example usage ===

<code>ai(3, AL_RETRIGCOUNT)</code>

[command available in firmware 201008 and later]