Event Helpers

Naming

When you installed ideAlarm you already downloaded an Event Helpers file with predefined but quite empty functions. The Event Helpers file is named $OPENHAB_CONF/automation/lib/python/idealarm/custom.py

Custom helper functions for various alarm events

Every installation is unique and has it's own needs. Therefore ideAlarm has a number of alarm events that will trigger your custom script functions (if you choose to define them). That way you can choose whatever shall happen on those events. You define those functions in the event helpers file. The helper functions provides useful ideAlarm objects that makes your custom scripting easy.

There is an example event helpers script available if you'd like to get inspired.

onArmingModeChange(zone, newArmingMode, oldArmingMode)

This function will be called when there is a change of arming mode for a zone.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onZoneStatusChange(zone, newZoneStatus, oldZoneStatus, errorMessage=None)

This function will be called when there is a change of zone status. oldZoneStatus is None when initializing.

Function arguments:

• zone: The zone object.
• newZoneStatus: The current zone status.
• oldZoneStatus: The previous zone status.
• errorMessage: Holds an error message (string) when an error has occurred, typically when trying to arm a zone with tripped sensors.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.

onXXX(zone, newArmingMode, oldArmingMode)

This function XXXXXXXX.

Function arguments:

• zone: The zone object.
• newArmingMode: The current arming mode.
• oldArmingMode: The previous arming mode.