UltraM1G3 HSPI User’s Guide
A HomeSeer HS3 plug-in for the Elk M1 Security and Automation Controller
Copyright © 2015
Revised 03/13/2015
This document contains proprietary and copyrighted information and may not be copied, reproduced, translated, or reduced to any electronic medium without prior consent, in writing, from [email protected].
2
Table of Contents Introduction .................................................................................................................................................. 4
Intended Audience .................................................................................................................................... 4
UltraM1G3 HSPI Overview ............................................................................................................................ 4
How It Works ............................................................................................................................................ 4
Features .................................................................................................................................................... 5
Requirements ............................................................................................................................................ 6
UltraM1G3 HSPI Installation ......................................................................................................................... 6
Downloading the HomeSeer Plug-in ......................................................................................................... 6
Initial Setup Using the ElkRP Software .......................................................................................................... 6
Verify Elk M1 Global Programming Options ............................................................................................. 7
Verify Elk M1XEP Non-Secure Port ........................................................................................................... 7
Verify Elk M1 Naming................................................................................................................................ 7
UltraM1G3 HSPI Setup .................................................................................................................................. 7
Set Initial UltraM1G3 Options ................................................................................................................... 7
UltraM1G3 HSPI Configuration ..................................................................................................................... 8
Web Page Layout ...................................................................................................................................... 8
UltraM1G3 HSPI Options .......................................................................................................................... 9
Elk M1G Connectivity ............................................................................................................................ 9
Defined Elk M1G Configuration ............................................................................................................ 9
Elk M1 Event Logs ................................................................................................................................. 9
Web Page Access ................................................................................................................................ 10
Elk M1 Polling Options ........................................................................................................................ 10
Application Options ............................................................................................................................ 10
Adding an ElK M1 HomeSeer Device ...................................................................................................... 10
Elk M1 Area Devices ............................................................................................................................ 10
Elk M1 Keypad Devices ....................................................................................................................... 10
Elk M1 Users........................................................................................................................................ 10
Elk M1 Zones ....................................................................................................................................... 11
Elk M1 Outputs ................................................................................................................................... 11
3
Elk M1 Thermostats ............................................................................................................................ 11
Elk M1 Custom Settings ...................................................................................................................... 11
Elk M1 Counters .................................................................................................................................. 11
Elk M1 Tasks ........................................................................................................................................ 11
Elk M1 Lighting .................................................................................................................................... 11
Elk M1 System Status .......................................................................................................................... 11
Elk M1 Area Status .............................................................................................................................. 11
Elk M1 Audio Zones ............................................................................................................................. 11
Modifying an Existing UltraM1G3 Device ............................................................................................... 12
Deleting an Existing UltraM1G3 Device .................................................................................................. 12
UltraM1G3 HSPI Triggers ............................................................................................................................ 12
UltraM1G3 HSPI Triggers Supported ...................................................................................................... 12
Elk M1 Alarm Trigger ........................................................................................................................... 12
Elk M1 Pre-Arming Trigger .................................................................................................................. 13
Elk M1 Arm Status ............................................................................................................................... 13
Elk M1 Arm Up State ........................................................................................................................... 13
Elk M1 Zone Status .............................................................................................................................. 14
Elk M1 Output Status .......................................................................................................................... 14
Elk M1 Task Trigger ............................................................................................................................. 14
Elk M1 User Trigger ............................................................................................................................. 14
Elk M1 Keypad KeyChange .................................................................................................................. 15
Elk M1 Event Trigger ........................................................................................................................... 15
Elk M1 System Trouble Trigger ........................................................................................................... 15
Elk M1 Watchdog Trigger .................................................................................................................... 15
Elk M1 Custom Codes ......................................................................................................................... 16
Elk M1 ELKRP Trigger .......................................................................................................................... 16
Elk M1 Thermostat Setpoint Trigger ................................................................................................... 16
Elk M1 Counter Value ......................................................................................................................... 16
HomeSeer Device Value Trigger ............................................................................................................. 16
UltraM1G3 HSPI Event Actions ................................................................................................................... 17
UltraM1G3 Actions Supported ................................................................................................................ 17
Elk M1 Arming Action ......................................................................................................................... 17
4
Elk M1 Output Action .......................................................................................................................... 17
Elk M1 Speak Words ........................................................................................................................... 17
Elk M1 Speak Phrase ........................................................................................................................... 17
Elk M1 Function Key Press .................................................................................................................. 17
Elk M1 Keypad Display ........................................................................................................................ 17
Elk M1 Task Activation ........................................................................................................................ 18
Elk M1 Counter Value ......................................................................................................................... 18
Elk M1 Email Trigger ........................................................................................................................... 18
Elk M1 Timesync (Real Time Clock Update) ........................................................................................ 18
UltraM1G3 HSPI Trigger Conditions ............................................................................................................ 18
UltraM1G3 Conditions Supported .......................................................................................................... 18
Elk M1 Arming Status .......................................................................................................................... 18
Elk M1 Arm Up State ........................................................................................................................... 18
Elk M1 Current Alarm State ................................................................................................................ 19
Elk M1 Zone Status .............................................................................................................................. 19
Elk M1 Output Status .......................................................................................................................... 19
UltraM1G3 HSPI API Reference .................................................................................................................. 19
Introduction UltraM1G3 HSPI is a cool new HomeSeer HS3 plug-in for the Elk M1 Alarm Panel. The UltraM1G3 plug-in
connects to the Elk M1 Alarm Panel using either a serial or Ethernet connection allowing control of the
panel using HomeSeer. An extensive list of HomeSeer Triggers and Actions are available to customize
your home automation setup.
Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the
UltraM1G3 HomeSeer Plug-in.
UltraM1G3 HSPI Overview
How It Works
The plug-in connects to the Elk M1 Panel via serial port or Elk-M1XEP Ethernet interface.
5
Defined areas, keypads, users, zones, outputs, thermostats, custom settings, counters, tasks, lighting, system status, audio zones and logs are obtained from the Elk M1 panel on startup and kept updated as the plug-in runs.
Once the Elk M1 initialization is complete, updates are sent from the Elk M1 panel in real-time eliminating the need to query the Elk M1 panel for status.
Features
Multiple threading allows actions to take place without disrupting the performance of HomeSeer.
Elk M1 command queue executed in its own thread.
Verification and retry logic to verify critical commands sent to the Elk M1 are processed.
Elk M1 real-time clock updated on startup.
Elk M1 Panel configuration is saved between sessions and loaded on startup.
Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception.
Flexibility to allow the creation of only the HomeSeer devices desired (Area, Keypad, Users, Zones, Outputs, Thermostats, Custom Settings, Counters, Tasks, Lighting, System Status, Areas Status and Audio Zones).
UltraM1G3 Triggers Supported o Elk M1 Alarm Trigger o Elk M1 Pre-Arming Trigger o Elk M1 Arm Status o Elk M1 Arm Up State o Elk M1 Zone Status o Elk M1 Output Status o Elk M1 Thermostat set point trigger o Elk M1 Task Trigger o Elk M1 Keypad Access o Elk M1 Keypad Key Change o Elk M1 Event Log Trigger (supports events 1000-1386) o Elk M1 Custom Codes (trigger on non-defined user codes or Weigand data codes). o Elk M1 User Trigger o Elk M1 ELKRP Trigger (trigger when ElkRP software connects/disconnects) o Elk M1 Counters (requires firmware > 5.1.6) o Elk M1 System Trouble trigger (requires firmware > 4.5.2, 5.1.2) o Elk M1 Watchdog Trigger
UltraM1G3 Conditions Supported o Elk M1 Arming Status o Elk M1 ArmUp State
6
o Elk M1 Current Alarm State o Elk M1 Zone Status o Elk M1 Output Status
UltraM1G3 Actions Supported o Elk M1 Arming Action o Elk M1 Output Action o Elk M1 Speak Words (supports up to 5 words) o Elk M1 Speak Phrase o Elk M1 Function Key Press o Elk M1 Keypad Display (Send Text to LCD Keypad) o Elk M1 Task Activation o Elk M1 Counter Value o Elk M1 Email Trigger o Elk M1 Real Time Clock (Real Time Clock Update)
UltraM1G3 Interfaces Supported o Serial Port via Port 0 o Ethernet via Elk-M1XSP
Requirements Homeseer3
Elk M1 Gold or Elk M1 EZ Security and Automation Controller
Serial or Ethernet connection to your Elk M1 Security and Automation Controller
UltraM1G3 HSPI Installation
Downloading the HomeSeer Plug-in 1. From your HomeSeer web page, select PLUG-INS > Manage.
2. Click the + icon next to Additional Interfaces to expand the list of available HomSeer3 plug-ins.
3. Click the + icon next to the “Security Plug-Ins” category, then click the checkbox next to the
UltraM1G3 (Elk M1 Plug-in) package to mark the plug-in for installation.
4. Under “Pending Updates/Installs”, click the Download and Install button.
5. Once the installer finishes, find the UltraM1G3 plug-in under Installed Plug-Ins, then enable it.
Initial Setup Using the ElkRP Software Before you can use the plug-in for the first time, you must set options that allows the UltraM1G3 plug-in
to communicate properly to your Elk M1 Security and Automation Controller. If you do not have the
ElkRP software installed, then you’ll need to obtain it from ELK Products, Inc.
7
Verify Elk M1 Global Programming Options The Elk M1 Security and Automation Controller should be programmed to send changes whenever a
status change is detected. Using the ElkRP software or your Keypad, verify the following global
programming options are set to 'Yes':
1. G35:=Yes (Xmit Event Log-ASCII) 2. G36:=Yes (Xmit Zone Chgs-ASCII) 3. G37:=Yes (Xmit Output Chgs-ASCII) 4. G38:=Yes (Xmit Task Chgs-ASCII) 5. G39:=Yes (Xmit Light Chgs-ASCII) 6. G40:=Yes (Xmit Keypad Key Chgs)
Verify Elk M1XEP Non-Secure Port If you are using an Ethernet connection, then you’ll need to verify you have the non-secure port enabled. Using the ElkRP software, connect to your M1XEP and confirm the Non-Secure port is enabled under the TCP/IP configuration tab as shown below.
Verify Elk M1 Naming The UltraM1G3 plug-in allows you to create HomeSeer devices for Areas, Keypads, Users, Zones,
Outputs, Thermostats, Custom Settings, Counters, Tasks, Lighting and Audio Zones. Before you begin
creating HomeSeer devices, you’ll need to connect to the Elk M1 using the ELKRP software and verify all
of your devices have been properly named.
UltraM1G3 HSPI Setup
Set Initial UltraM1G3 Options 1. From your HomeSeer web page, select PLUG-INS > UltraM1G3 > UltraM1G3.
2. Click on the Options Tab to display the available options.
3. Under the Elk M1G Connectivity section, set the Elk M1 connectivity type:
a. Serial Port – You must select the Serial Com Port
b. Ethernet – You must define the IP address and IP port of your Elk M1XEP.
If you are using an Ethernet connection, then verify you have the non-secure port
8
enabled from M1XEP TCP/IP configuration tab as shown.
2. Under the Defined Elk M1G Configuration section, review and select the supported Elk M1
configuration. (e.g. If the maximum zone number defined in your Elk M1 is 48, then select 48
for the zones.)
3. Click the Save button.
4. Restart HomeSeer.
UltraM1G3 HSPI Configuration
Web Page Layout The UltraM1G3 plug-in has 15 web pages that provide access the available features of the plug-in.
The available web pages are as follows:
1. Status – Displays the plug-in status including M1 panel status, M1 log count and supported Elk
M1 configurations.
2. Options – Displays and allows you to change the options associated with the plug-in.
3. Areas – Displays an at-a-glance status of all Elk M1 areas.
4. Keypads – Displays an at-a-glance status of the Elk M1 keypads.
5. Users – Displays an at-a-glance status of the Elk M1 users.
6. Zones – Displays an at-a-glance status of the Elk M1 zones.
7. Outputs – Displays an at-a-glance status of the Elk M1 outputs.
8. Thermostats – Displays an at-a-glance status of the Elk M1 thermostats.
9. Custom – Displays the custom settings you have pre-configured in your Elk M1.
10. Counters – Displays the counters you have pre-configured in your Elk M1.
11. Tasks – Displays the tasks you have pre-configured in your Elk M1.
12. Lighting – Displays an at-a-glance status of the Elk M1 lighting devices.
13. System Status – Displays an at-a-glance status of the Elk M1 system.
14. Area Status – Displays an at-a-glance status of the Elk M1 areas.
15. Audio Zones – Displays an at-a-glance status of the Elk M1XEP audio zones.
16. Logs – Displays the log events written to your Elk M1 panel.
9
UltraM1G3 HSPI Options All options are set from the Options web page. The following options are supported:
Elk M1G Connectivity
Connection Type – Specifies the interface you are using to connect your computer to the Elk M1
panel. The current choices are Serial Port or Ethernet. The default is Serial Port.
Serial Com Port – The communication port you use to connect your computer to the Elk M1
panel. The default is disabled.
IP Address – The IP address of your Elk M1XEP. This option is only valid if you choose Ethernet
for the Connection Type. The default is an empty string.
IP Port – The TCP port of your Elk M1XEP. This option is only valid if you choose Ethernet for the
Connection Type. The default is 2101.
Attempts Per Command – Specifies the number of times you want to try sending the Elk M1 a
command before giving up. This option only applies to Elk M1 commands that return a result.
The default is 2 times.
Wait Time per Command – Specifies the number of seconds to wait for the Elk M1 to respond
to a command before giving up.
Defined Elk M1G Configuration
Areas – Set this value to the number of areas configured in your Elk M1. The default is 1.
Keypads – Set this value to the number of keypads configured in your Elk M1. The default is 1.
Users – Set this value to the number of users you have defined in your Elk M1. The default is 1.
Zones – Set this value to the maximum zone number you have configured in your Elk M1. The
default is 16.
Outputs – Set this value to the maximum output number you have configured in your Elk M1.
The default is 16.
Thermostats – Set this value to the maximum thermostat number you have connected to your
Elk M1. The default is 0.
Custom Values – Set this to the maximum custom settings number you have defined in your Elk
M1. The default is 0.
Counters – Set this to the maximum counter number you have defined in your Elk M1. The
default is 0.
Tasks – Set this value to the maximum task number you have defined in your Elk M1. The
default is 0.
Lighting – Set this value to the maximum lighting device number defined in your Elk M1. The
default is 0.
Audio Zones – Set this value to the maximum audio zone defined in your Elk M1XEP. The
default is 0.
Elk M1 Event Logs
Write to HomeSeer Log – This option allows the Elk M1 log events to be written to the
HomeSeer event log.
10
Web Page Access
Authorized User Roles – The HomeSeer users authorized to access the web page. This option
does not override the default HomeSeer web server settings.
Elk M1 Polling Options
Temperature Polling - Specifies how the plug-in will poll the Elk M1 Zone status. Set this option
to Yes only if the Elk M1 is not properly reporting Temperature changes.
Analog Zone Polling - Specifies how the plug-in will poll the Elk M1 Analog Zone values. Set this
option to Yes only if the Elk M1 is not properly reporting changes.
Counter Polling - Specifies how the plug-in will poll the Elk M1 Counter values.
Application Options
Temperature Format – Set this value to the temperature scale defined in your Elk M1. The
default is F.
Note: You must restart HomeSeer if you change this value.
Logging Level – Select the level of application logging.
Note: This option may produce a lot of output and should only be used when debugging.
Adding an ElK M1 HomeSeer Device The UltraM1G3 plug-in allows you to create HomeSeer devices for Areas, Keypads, Users, Zones,
Outputs, Thermostats, Custom Settings, Counters, Tasks, Lighting, System Status, Areas Status and Audio
Zones. Before you begin creating HomeSeer devices, you’ll need to connect to the Elk M1 using the
ELKRP software and verify all of your devices have been properly named. If you made changes using the
ELKRP software, you’ll need to reload the data from the UltraM1G3 HSPI Status web page.
Note: The plug-in will enable the HomeSeer checkbox for each Elk M1 object that has been named. If
the checkbox is not enabled, then you’ll need to name the Elk M1 object using the ELKRP software, and
then forcing a manual data reload by clicking the “Reload Data” button on the UltraM1G3 HSPI Status
web page.
Elk M1 Area Devices
To create an area device, simply connect to the UltraM1G3 HSPI Area web page, then select the
checkbox next to the area number, then click the Submit button.
Note: Once the area device is created, you can enter the user code to allow you to arm and disarm the
system from the web page or using the API. This code is stored encrypted in the plug-in settings file.
Elk M1 Keypad Devices
To create a keypad device, simply connect to the UltraM1G3 HSPI Keypad web page, then select the
checkbox next to the keypad number, then click the Submit button.
Elk M1 Users
To create a user device, simply connect to the UltraM1G3 HSPI Users web page, then select the
checkbox next to the user number, then click the Submit button.
11
Note: The plug-in will automatically add 3 users that are valid, but not visible using the ELKRP software.
Elk M1 Zones
To create a zone device, simply connect to the UltraM1G3 HSPI Zones web page, then select the
checkbox next to the zone number, then click the Submit button.
Elk M1 Outputs
To create an output device, simply connect to the UltraM1G3 HSPI Outputs web page, then select the
checkbox next to the zone number, then click the Submit button.
Elk M1 Thermostats
To create a thermostat device, simply connect to the UltraM1G3 HSPI Thermostats web page, then
select the checkbox next to the thermostat number, then click the Submit button.
Elk M1 Custom Settings
To create a custom setting device, simply connect to the UltraM1G3 HSPI Custom web page, then select
the checkbox next to the custom setting number, then click the Submit button.
Elk M1 Counters
To create a counter device, simply connect to the UltraM1G3 HSPI Counters web page, then select the
checkbox next to the counter number, then click the Submit button.
Elk M1 Tasks
To create a task device, simply connect to the UltraM1G3 HSPI Tasks web page, then select the checkbox
next to the task number, then click the Submit button.
Elk M1 Lighting
To create a lighting device, simply connect to the UltraM1G3 HSPI Lighting web page, then select the
checkbox next to the lighting number, then click the Submit button.
Note: You can change the lighting device from on/off to direct dimming from the HomeSeer device
properties web page.
Elk M1 System Status
To create a system status device, simply connect to the UltraM1G3 HSPI System Status web page, then
select the checkbox next to the system status, then click the Submit button.
Elk M1 Area Status
To create an area status device, simply connect to the UltraM1G3 HSPI Area Status web page, then
select the checkbox next to the area status, then click the Submit button.
Elk M1 Audio Zones
To create an audio zone device, simply connect to the UltraM1G3 HSPI Audio Zone web page, then
select the checkbox next to the audio zone, then click the Submit button.
12
Modifying an Existing UltraM1G3 Device You can modify an UltraM1G3 device the same way you modify any other HomeSeer device. Simply
click on the device name from the HomeSeer device page, and then change the device properties as
needed.
Note: Once a HomeSeer device is created, the plug-in will not overwrite any of the device properties, so
feel free to modify the name, location and location2 properties as you see fit.
Deleting an Existing UltraM1G3 Device You can delete an UltraM1G3 device the same way you delete any other HomeSeer device. From the
HomeSeer device web page, click the device name, then from the HomeSeer modify device web page,
click the Delete button.
UltraM1G3 HSPI Triggers You can create HomeSeer events using any of the supported Elk M1 triggers listed below.
UltraM1G3 HSPI Triggers Supported
Elk M1 Alarm Trigger
The Elk M1 will notify the plug-in whenever the alarm state changes.
Example Usage
Turn on lights when the entrance delay is active.
Receive a notification when a burglar alarm is triggered within your home.
Supported Alarm States
No Alarm Active
Entrance Delay is Active
Alarm Abort Delay Active
Fire Alarm
Medical Alarm
Police Alarm
Burglar Alarm
Aux1 Alarm
Aux2 Alarm
Aux3 Alarm
Aux4 Alarm
Carbon Monoxide Alarm
Emergency Alarm
Freeze Alarm
Gas Alarm
Heat Alarm
Water Alarm
Fire Supervisory
Verify Fire
13
Elk M1 Pre-Arming Trigger
The Elk M1 will allow you to automatically arm your system when zones are violated. This trigger can
be used to check whenever the Elk M1 changes to an Arm state with one or more zones violated.
Example Usage
Receive a notification when your system is automatically armed, but one or more zones were
violated.
Supported Arm Up States
Not Ready To Arm
Ready To Arm
Ready to Arm, but a zone is violated and can be Forced Armed
Armed with Exit Timer working
Armed Fully
Force Armed with a force arm zone violated
Armed with a bypass
Elk M1 Arm Status
The Elk M1 will notify the plug-in whenever the M1 arm status changes.
Example Usage
Receive a notification when your system is armed or disarmed.
Turn on lights when your system is disarmed.
Supported Alarm Statuses
Disarmed
Armed Away
Armed Stay
Armed Stay Instant
Armed to Night
Armed to Night Instant
Armed to Vacation
Any Arm Status Change
Elk M1 Arm Up State
The Elk M1 will notify the plug-in whenever the arm up status changes.
Example Usage
Receive a notification when your system is armed fully.
Supported Arm Up States
Not Ready To Arm
Ready To Arm
Ready to Arm, but a zone is violated and can be Forced Armed
Armed with Exit Timer working
14
Armed Fully
Force Armed with a force arm zone violated
Armed with a bypass
Elk M1 Zone Status
The Elk M1 will notify the plug-in whenever an input (zone) changes status.
Example Usage
Turn on lights when you walk into a room or open a door.
Receive a notification when a zone becomes violated or reports a trouble.
Supported Zone Statues
Normal
Trouble
Violated
Bypassed
Elk M1 Output Status
The Elk M1 will notify the plug-in whenever an output changes status.
Example Usage
Take additional action when an Elk M1 output changes state.
Supported Output States
On
Off
Elk M1 Task Trigger
The Elk M1 will notify the plug-in whenever a task is activated.
Example Usage
Have HomeSeer complete other tasks once an Elk M1 task triggers.
Elk M1 User Trigger
This trigger can be used to run a HomeSeer event based on which Elk M1 user arms or disarms the
system.
Example Usage
Receive a notification when family member arrives home (disarmed the system).
Run additional HomeSeer actions when the specified user arms or disarms the system.
Supported User Actions
Disarmed
Armed Away
15
Armed Stay
Armed Stay Instant
Armed to Night
Armed to Night Instant
Armed to Vacation Any Arm Status Change
Elk M1 Keypad Access
This trigger can be used to trigger a HomeSeer event when a user accesses a keypad by entering their
code or by swiping their Proximity Fob.
Example Usage
Trigger a HomeSeer event based on the keypad that was accessed by a valid user.
Elk M1 Keypad KeyChange
This trigger can be used to trigger a HomeSeer event based on a single key press on the Elk M1 keypad.
Example Usage
Speak the time when someone presses the F5 key.
Turn off all lights when someone presses the F6 key.
Announce the weather forecast when someone presses the F3 key (a HomeSeer weather plug-in
is required).
Elk M1 Event Trigger
You can use this trigger to run a HomeSeer event based on an event written to the Elk M1. This trigger
supports Elk M1 events 1000-1386.
Example Usage
Receive a notification if an Ethernet trouble is reported.
Receive a notification is the Elk M1 event log exceeds 80% full.
Elk M1 System Trouble Trigger
The Elk M1 will notify the plug-in (using firmware >= 4.5.2, 5.1.2) when a system trouble is detected.
Example Usage
Receive a notification when a low battery trouble is reported.
Receive a notification when a GE Smoke reports a CleanMe trouble.
Receive a notification when any trouble is reported.
Elk M1 Watchdog Trigger
The UltraM1G3 plug-in has a built in watchdog timer to ensure the plug-in is always connected to the Elk
M1. The trigger can be used to trigger a HomeSeer event when connectivity has been lost or restored.
Example Usage
Receive a notification if the plug-in loses communication with the Elk M1 panel.
16
Supported Events
Panel connection failure
Panel connection restore
Elk M1 Custom Codes
This trigger can be used to run a HomeSeer event based on a non-defined user code or a Weigand data
code. Once defined, you simply enter the 4 or 6 digit code into a keypad to run a HomeSeer event.
Note: You must press the * key between user codes if you want to trigger it multiple times or enter
another code.
Example Usage
Turn on all lights when someone enters 123456 on the keypad.
Turn the sprinklers on when someone enters 654321on the keypad.
Elk M1 ELKRP Trigger
This event is trigger whenever the ElkRP software connects to or disconnects from the Elk M1 panel.
Example Usage
Trigger an action to automatically perform a complete reload of the Elk M1 data when the ElkRP
software disconnects from the panel.
Send an e-mail notification whenever the ElkRP software connects to your Elk M1 system.
Elk M1 Thermostat Setpoint Trigger
The UltraM1G3 plug-in can be used to ensure your thermostat heat or cool setpoint can be manually
adjusted outside a desired range.
Example Usage
If someone sets the cool setpoint below 70, you can reset it to 70 using an Ek M1 Thermostat
setpoint action.
Elk M1 Counter Value
The plug-in will poll the Elk M1 counter values and can trigger an event whenever a counter changes
value.
Example Usage
Can be used in conjunction with Elk1 rules to trigger a HomeSeer event when the counter values are less than, greater than or equal to a value between 1 and 65535.
HomeSeer Device Value Trigger The UltraM1G3 plug-in uses the HomeSeer device value to keep track of the state of the monitored
device. The device status displayed depends on the current value of the Device Value.
17
UltraM1G3 HSPI Event Actions
UltraM1G3 Actions Supported
Elk M1 Arming Action
This action can be used to arm or disarm your system.
Note: You must verify you have entered a valid user code on the UltraM1G3 HSPI Keypad web page.
Supported Arm Actions
Disarmed
Armed Away
Armed Stay
Armed Stay Instant
Armed to Night
Armed to Night Instant
Armed to Vacation
Elk M1 Output Action
This action can be used to turn on or off an Elk M1 output.
Supported Output Actions:
On (with number of seconds output will be active)
Off
Toggle
Elk M1 Speak Words
This action allows HomeSeer to cause the Elk M1 Gold to speak up to 5 words. If you need to speak
more than 5 words, just add an additional action.
Elk M1 Speak Phrase
This action allows HomeSeer to cause the Elk M1 Gold to speak a pre-defined phrase.
Elk M1 Function Key Press
This action is used to simulate a key press on a keypad. This will only be a single key press even if the Elk
M1 Control is programmed for a double key press.
Example Usage
Can be used to silence a trouble beep on a keypad.
Can be used to enable or disable chime mode.
Elk M1 Keypad Display
This action is used to send text to the Elk M1 keypad. You can use any of the HomeSeer3 replacement
variables to customize the text strings you send to your keypads.
18
Elk M1 Task Activation
This action allows HomeSeer to run a pre-configured Elk M1 task.
Elk M1 Counter Value
This action allows HomeSeer to change the value of any of the Elk M1 counters.
Elk M1 Email Trigger
This action allows HomeSeer to run a pre-configured Elk M1 email trigger.
Elk M1 Timesync (Real Time Clock Update)
This action allows HomeSeer to set the Elk M1 real-time clock.
UltraM1G3 HSPI Trigger Conditions UltraM1G3 HSPI conditions allow you to specify that certain conditions must exist before a HomeSeer
event will run.
UltraM1G3 Conditions Supported
Elk M1 Arming Status
No Alarm Active
Entrance Delay is Active
Alarm Abort Delay Active
Fire Alarm
Medical Alarm
Police Alarm
Burglar Alarm
Aux1 Alarm
Aux2 Alarm
Aux3 Alarm
Aux4 Alarm
Carbon Monoxide Alarm
Emergency Alarm
Freeze Alarm
Gas Alarm
Heat Alarm
Water Alarm
Fire Supervisory
Verify Fire
Elk M1 Arm Up State
Not Ready To Arm
Ready To Arm
Ready to Arm, but a zone is violated and can be Forced Armed
Armed with Exit Timer working
Armed Fully
Force Armed with a force arm zone violated
19
Armed with a bypass
Elk M1 Current Alarm State
Disarmed
Armed Away
Armed Stay
Armed Stay Instant
Armed to Night
Armed to Night Instant
Armed to Vacation
Elk M1 Zone Status
Normal
Trouble
Violated
Bypassed
Elk M1 Output Status
On
Off
UltraM1G3 HSPI API Reference To be determined.
