M1 Rules

From CT.wiki

The automation functions of the ELK M1 family of controls can be managed and controlled through "rules." M1 rules define a specialized programming language for controlling the M1 that is simple to understand and use. Rules are created and managed using the ElkRP configuration software tool for the M1.

The ELK M1 installation manual describes the M1 automation functions but omits details of the automation rules. This page lists the rules that are implemented in version 5.1.8 of the M1G firmware.

M1 rules have the following structure:

WHENEVER <event>
 Defines an event which triggers the rule, such as a time of day, a change in a
 zone state, or other condition.  Each WHENEVER defines one rule.

AND <condition>
 An optional qualifier that will suppress execution of the rule if the condition
 is not met.  A single rule can have one, none or several AND conditions specified.
 If more than one AND is specified, then all AND conditions must be met or the rule
 will not be executed.

THEN <action>
 Specifies the actions that the M1 carries out when the rule is triggered and all AND
 conditions are satisfied.  A single rule can have one or more THEN actions specified.

M1 rule example:

 WHENEVER Garage Door (Zn18) BECOMES NOT SECURE
   AND IT IS DARK OUTSIDE
   AND Driveway Lights [194 (M2)] IS OFF
     THEN TURN Driveway Lights [194 (M2)] ON FOR 2 MINS, 30 SECS

M1 WHENEVER Options

WHENEVER:

Time Occurrence
   Time of Day Equals (hrs:mins)
   At Sunrise (+/-)
   At Sunset (+/-)
   Hour Equals X
   Minute Equals X
   Every X Hours and/or Minutes
   Every X Seconds
Input (Zone) Change
Output Change
Keypad F Key Press
Keyfob Button Press
Lighting Change
   Individual
   All
Automation Tasks
Security/Alarms
   Is Disarmed
   Is Armed
       Armed to any mode
       Armed Away
       Armed Stay
       Armed Stay Instant
       Armed Night
       Armed Night Instant
       Armed Vacation
       Force Armed
   Burglar Status
       Becomes Ready to Arm
       Becomes Not Ready To Arm
   Day Alert
       Activates
       Cuts Off
   Entry Delay
       Starts
       Ends
   Exit Delay
       Starts
       Expires
   Exit Error Occurs
   Closing Report Ring Back
   Key Switch Tamper Alert
       Turns On
       Cuts Off
   Alarm Turns On or Cuts Off
       Fire
       Fire Supervisory
       Burglar
       Medical
       Police
       Aux1 24 hr.
       Aux2 24 hr.
       CO Carbon Monoxide
       Emergency
       Freeze
       Gas
       Heat
       Water
       Any Alarm
   Access
   Chime
       Mode is Enabled
       Alert Sounds
       Mode is Disabled
   Zone Bypass Status
       At Least One Zone Becomes Bypassed
       All Zones Become Un-bypassed
Miscellaneous System
   Troubles
       Power Supv Zn - AC Trouble
       Power Supv Zn - Low Batt Trouble
       Any Fire Zone Trouble
       2-Wire Smoke Det. Clean Trouble
       Any Burglar Zone Trouble
       Failed to Communicate
       Any RF Sensor Low Battery
       Any RF Sensor Supervision Loss
       ANC Module Trouble
       Keypad Trouble
       Input Expander Trouble
       Output Expander Trouble
       EEProm Memory Error
       Flash Memory Error
       AC Power Failure
       Low Backup Battery
       Control Over Current
       Any Expansion Module Trouble
       Output 2 Supervisory Trouble
       Telephone Line Trouble
       Ethernet Expander Trouble
   Restorals
       Power Supv Zn - AC Trouble Restore
       Power Supv Zn = Low Batt Restore
       Communication Fail Restore
       AC Power Failure Restore
       Low Battery Restore
       Control Over Current Restore
       Expansion Module Restore
       Output 2 Restore
       Telephone Line Restore
       Ethernet Expander Restore
   Other
       Audio Amplifier
           Turns On
           Turns Off
       Dialer Abort
       Dialer Cancel
       Dialer AutoTest
       Dialer C.S. Kissoff
       Keypad Beep
       Keypad Locked Out
       Event Log Reaches 80% Full
       Local Programming
           Begins
           Ends
       Telephone Line is Ringing
       Telephone Line Seize
           Occurs
           Clears
       Telephone Line On/Off Hook
           Goes Off-hook
           Goes On-hook
       Telephone Local Access
           Begins
           Ends
       Telephone Remote Access
           Begins
           Ends
       Remote Programming
           Begins
           Ends
       System Start-up Occurs
Text (ASCII) String is Received
Counter Changes/Expires
Thermostat Setting Changes

M1 AND Options

AND WHEN:

Time is
   Relative to a Specific Time of Day
   Relative to Sunrise
   Relative to Sunset
   Every (n) Days
   Every (n) Months
Date is
   Specific Days of the Week
   A Specific Day of the Month
   A Specific Month of the Year
   A Specific Year
Light/Dark
   It is Light Outside
   It is Dark Outside
Input (zone) is
Output is
Last User Was
Lighting is
Security/Alarms
   Is Disarmed
   Is Armed
       Armed to any mode
       Armed Away
       Armed Stay
       Armed Stay Instant
       Armed Night
       Armed Night Instant
       Armed Vacation
       Force Armed
   Burglar Status
       Is Ready to Arm
       Is Not Ready To Arm
   Day Alert
       Is Active
       Is Not Active
   Entry Delay
       Is Active
       Is Not Active
   Exit Delay
       Is Active
       Is Not Active
   Exit Error
       Is Active
       Is Not Active
   Key Switch Tamper Alert
       Is Active
       Is Not Active
   Alarm On or Off
       Fire
       Fire Supervisory
       Burglar
       Medical
       Police
       Aux1 24 hr.
       Aux2 24 hr.
       CO Carbon Monoxide
       Emergency
       Freeze
       Gas
       Heat
       Water
       Any Alarm
   Alarm Memory
   Chime
       Mode is Enabled
       Mode is Disabled
   Zone Bypass Status
       At Least One Zone Is Bypassed
       No Zones Are Bypassed
Miscellaneous System
   Troubles
       Power Supv Zn - AC Trouble
       Power Supv Zn - Low Batt Trouble
       Any Fire Zone Trouble
       2-Wire Smoke Det. Clean Trouble
       Any Burglar Zone Trouble
       Failed to Communicate
       Any RF Sensor Low Battery
       Any RF Sensor Supervision Loss
       ANC Module Trouble
       Keypad Trouble
       Input Expander Trouble
       Output Expander Trouble
       EEProm Memory Error
       Flash Memory Error
       AC Power Failure
       Low Backup Battery
       Control Over Current
       Any Expansion Module Trouble
       Output 2 Supervisory Trouble
       Telephone Line Trouble
       Ethernet Expander Trouble
   Other
       Audio Amplifier
           Is On
           Is Off
       Event Log, 80% Full
       Local Programming
           Is Active
           Is Not Active
       Telephone Line Seized/Not Seized
           Is Seized
           Is Not Seized
       Telephone Line On/Off Hook
           Is Off-hook
           Is On-hook
       Telephone Local Access
           Is Active
           Is Not Active
       Telephone Remote Access
           Is Active
           Is Not Active
       Remote Programming
           Is Active
           Is Not Active
Counter is
Temperature
Thermostat

M1 THEN Options

THEN:

Automation Tasks
   Activate Task (t)
Security
   Automatically Arm
       Away
       Stay
       Stay Instant
       Night
       Night Instant
       Vacation
   Automatically Disarm
   Set Expected Arm/Disarm Times
       hh:mm
Turn Output On/Off
   Turn On/Turn Off/Toggle
   [for duration dd:hh:mm:ss]
   [for Custom Setting time]
   [Restart if running]
Control Lighting
   Individual
       Turn On/Turn Off/Toggle
       [for duration dd:hh:mm:ss]
       [for Custom Setting time]
   All
       All Lights On/All Units Off/All Lights Off
Speak
Send Text Out Port
   Text String Through Serial Port (n)
Send Text To Keypad
   Select Message (m) Select Area (a)
   [Clear any previous message]
   [Beep keypad(s)]
   [Allow user to clear with *]
   [Display message for (n) seconds]
Enable/Disable Chime
Beep Keypad(s)
   Select Area (a) Start Beeps/Stop Beeps
Chirp Outside Siren
   (n) times
Set/Change Counter
   [Toggle between 0 and 1]
   [Set counter to value (n)]
   [Add value (n) to counter]
   [Subtract value (n) from counter]
   [Set counter to temperature of (temp sensor)]
Dial Telephone Number
Set Email Message
Thermostat
   [multiple thermostat settings]
Enable/Disable User
Enable/Disable Voice
Bypass/Unbypass a Zone
   Bypass/Unbypass a specific zone
   Bypass/Unbypass all non-secure burglar zones in area
Reset Smoke Power