Elk-M1 Control


The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation.

The Elk-M1 controller is manufactured by Elk Products.

There is currently support for the following device types within Home Assistant:

  • Alarm - An Elk-M1 area (also known as partition) is represented as an alarm_control_panel.
  • Climate - An Elk-M1 thermostat is represented as a climate entity.
  • Light - An Elk-M1 light (which can be X10, Insteon, UPB) is represented as a light.
  • Scene - Elk-M1 tasks are represented as scene entities.
  • Sensor - Elk-M1 counters, keypads, panel, settings, and zones are represented as sensor entities.
  • Switch - Elk-M1 outputs are represented as switch entities.

The implementation follows the Elk Products ElkM1 “ASCII Protocol & Interface Specification, Revision 1.84” document. This document can be found on the Internet.

ElkM1 Configuration and Version

In order for the ElkM1 integration to work to its fullest with Home Assistant the ElkM1 panel must be configured correctly. This section describes the configuration required on the ElkM1 panel.

ElkM1 Version

ElkM1 should be running:

  • Version 4.6.8, or
  • Version 5.2.0 or higher.

Force arm away and stay are available in 5.3.0 or higher.

Many features will work with lower versions of the ElkM1. Check the “ElkM1 RS232 Protocol” manual for details.

Global Setting 35

The ElkM1 integration tracks the user number and name of the last user name to arm or disarm the panel. The changed_by and changed_by_id attributes of the alarm_control_panel hold those two attributes.

On the ElkM1 panel Global Setting 35, “Transmit Event Log” must be enabled for this to fully work.

Note that without Global Setting 35 set and in a single area system, changed_by and changed_by_id are updated when a user enters a valid code on a physical keypad.

Global Setting 36 — 40

If you are using the features below then these respective global options should be enabled:

Option # Option Name Description
36 Transmit Zone Changes If you are using Zones this allows Home Assistant to track the status of the Zones.
37 Transmit Output Changes If you are using Outputs this allows Home Assistant to track the status of the Outputs.
38 Transmit Automation Task Changes If you are using ElkM1 Tasks this allows Home Assistant to track the status of the Tasks.
39 Transmit Light Changes If you are using ElkM1 Lights this allows Home Assistant to track the status of the lights.
40 Transmit Keypad Changes Oddly, this option tracks keypad changes and alarm status. If you are wishing to track keypresses on ElkM1 keypad or if you are wishing to track the armed, disarmed, and alarm state of the ElkM1 then this option should be set.

System Trouble Status

The ElkM1 is able to report general system trouble statuses. This is reported using the system_trouble_status attribute of the panel sensor (often named sensor.elkm1) in Home Assistant.

The format of the system_trouble_status attribute is a comma separated list of the active troubles. Only active trouble statuses are in the list. If the trouble is for a zone then zone <number> is appended to the trouble name.

For example, if zone 42 wireless sensor lost communication with the panel then system_trouble_status would be “Lost Transmitter zone 42”. If in addition there was an AC failure then system_trouble_status would be the string “AC Fail, Lost Transmitter zone 42”.

The complete list of trouble statuses are:

  • AC Fail
  • Box Tamper (zone is part of status)
  • Fail To Communicate
  • EEProm Memory Error
  • Low Battery Control
  • Transmitter Low Battery (zone is part of status)
  • Over Current
  • Telephone Fault
  • Output 2
  • Missing Keypad
  • Zone Expander
  • Output Expander
  • ELKRP Remote Access
  • Common Area Not Armed
  • Flash Memory Error
  • Security Alert (zone is part of status)
  • Serial Port Expander
  • Lost Transmitter (zone is part of status)
  • GE Smoke CleanMe
  • Ethernet
  • Display Message In Keypad Line 1
  • Display Message In Keypad Line 2
  • Fire (zone is part of status)

Configuration

To add ElkM1 to your installation, go to Configuration >> Integrations in the UI, click the button with + sign and from the list of integrations select Elk-M1 Control.

Alternatively, configuration through the configuration.yaml file is supported (example below).

Both methods of configuration support “auto configuration”. This works by reporting only elements on the ElkM1 that have a “Name” configured. So, for example, if counter #11 on the panel was configured with the name “Test counter” then this element would show up in Home Assistant. If an element is being used but does not have a name configured then it will not appear in Home Assistant through the auto-configuration feature.

# Example configuration.yaml entry
elkm1:
  - host: elk://IP_ADDRESS_1
  ...
  - host: elk://IP_ADDRESS_2
    prefix: gh  # for guest house controller

Configuration Variables

host string Required

Connection string to Elk of the form <method>://<address>[:port]. <method> is elk for non-secure connection, elks for secure connection, and serial for serial port connection. <address> is IP address or domain or for serial the serial port that the Elk is connected to. Optional <port> is the port to connect to on the Elk, defaulting to 2101 for elk and 2601 for elks. For serial method, address is the path to the tty /dev/ttyS1 for example and [:baud] is the baud rate to connect with (Elk systems default to 115200 baud, but this can be changed during Elk system configuration). You may have multiple host sections for connecting multiple controllers.

username string (Optional)

Username to login to Elk. Only required if using elks connection method.

password string (Optional)

Password to login to Elk. Only required if using elks connection method.

prefix string

The prefix to use, if any, for all the devices created for this controller. At most one host can omit the prefix, all others must have a unique prefix within the Home Assistant instance.

temperature_unit string (Optional, default: F)

The temperature unit that the Elk panel uses. Valid values are C and F.

auto_configure boolean (Optional, default: false)

Auto configure area, counter, keypad, output, setting, task, thermostat, plc, and zone by only adding elements that ElkM1 reports on the initial sync.

area map (Optional, default: All included.)

Elk areas to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

counter map (Optional, default: All included.)

Elk counters to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

keypad map (Optional, default: All included.)

Elk keypads to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

output map (Optional, default: All included.)

Elk outputs to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

setting map (Optional, default: All included.)

Elk settings to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

task map (Optional, default: All included.)

Elk tasks to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

thermostat map (Optional, default: All included.)

Elk thermostats to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

plc map (Optional, default: All included.)

Elk PLC lights to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

zone map (Optional, default: All included.)

Elk zones to include in Home Assistant.

enabled boolean (Optional, default: true)

Enable this configuration section.

include list (Optional, default: All included.)

List to include in the form of either <value> or <value>-<value> where <value> is a positive integer or an X10 housecode. See configuration below for examples of ranges.

exclude list (Optional, default: None excluded.)

List to exclude in the form of either <value> or <value>-<value> where <value> is a number or an X10 housecode. See configuration below for examples of ranges.

Example configuration of the above:

elkm1:
  host: elks://IP_ADDRESS
  username: USERNAME
  password: PASSWORD
  area:
    exclude: [5-8]
  zone:
    exclude: [11-16, 19-192, 199-208]
  plc:
    include: [a1-d16, 192]
    exclude: [b12-d5]

Example configuration using auto_configure:

elkm1:
  host: elks://IP_ADDRESS
  username: USERNAME
  password: PASSWORD
  auto_configure: true

Example for a serial port instance on /dev/ttyUSB0 at 115200 baud:

elkm1:
  - host: serial:///dev/ttyUSB0:115200
    # Elk doesn't know which areas/zones/etc are unused, so it can generate
    # many unwanted Home Assistant Entities.  Be liberal in excluding them:
    area:
      exclude: [2-8]
    zone:
      exclude: [17-192, 195-208]
    plc:
      enabled: false
    task:
      enabled: false
    counter:
      exclude: [1-64]
    keypad:
      exclude: [3-16]
    setting:
      exclude: [1-20]
    output:
      enabled: false
    thermostat:
      enabled: false

Events

The ElkM1 integration supports the following event: elkm1.keypad_key_pressed. The event is generated whenever a key is pressed on an ElkM1 keypad. The event_data contains the following:

  • keypad_id: The number of the keypad that reported the keypress.
  • key_name: The name of the key that was pressed.
  • key: The number of the key that was pressed.

Services

Besides the standard Home Assistant services for Alarm Control Panel, Climate, Light, Scene, Sensor, and Switch the ElkM1 integration offers these additional services:

  • elkm1.alarm_arm_home_instant
  • elkm1.alarm_arm_night_instant
  • elkm1.alarm_arm_vacation
  • elkm1.alarm_bypass
  • elkm1.alarm_clear_bypass
  • elkm1.alarm_display_message
  • elkm1.sensor_counter_refresh
  • elkm1.sensor_counter_set
  • elkm1.sensor_zone_bypass
  • elkm1.sensor_zone_trigger
  • elkm1.set_time
  • elkm1.speak_phrase
  • elkm1.speak_word

Services elkm1.alarm_arm_home_instant, elkm1.alarm_arm_night_instant, and elkm1.alarm_arm_vacation

Arms the ElkM1 area in “home instant”, “night instant”, or “vacation” modes respectively.

Service data attribute Optional Description
entity_id yes ElkM1 area which to arm.
code no Alarm code to arm the system (4 or 6 digits).

Services elkm1.alarm_bypass and elkm1.alarm_clear_bypass

For all zones associated with the specified alarm panel these services respectively bypass or clear the bypass the zones.

Service data attribute Optional Description
entity_id yes ElkM1 area which to bypass or clear bypass.
code no Alarm code to bypass the alarm panel (4 or 6 digits).

Service elkm1.alarm_display_message

Display text on an area’s keypads.

Service data attribute Optional Description
entity_id yes ElkM1 area which to display the message.
clear yes 0=clear message, 1=clear message with * key, 2=Display until timeout; default 2
beep yes 0=no beep, 1=beep; default 0
timeout yes Time to display message, 0=forever, max 65535, default 0
line1 yes Up to 16 characters of text (truncated if too long). Default blank.
line2 yes Up to 16 characters of text (truncated if too long). Default blank.

Service elkm1.sensor_counter_refresh

Refresh the value of a counter. Note that under certain conditions the panel does not automatically send a new value under certain conditions. This service retrieves the current counter value.

Service data attribute Optional Description
entity_id yes ElkM1 counter to refresh.

Service elkm1.sensor_counter_set

Set counter to value.

Service data attribute Optional Description
entity_id yes ElkM1 counter to refresh.
value no Value to set the counter to Can be 0-65536.

Service elkm1.sensor_zone_bypass

Bypass a zone. Note that the only mechanism ElkM1 offers to clear the bypass is to clear all the bypassed zones in a given alarm panel (area).

Service data attribute Optional Description
entity_id yes ElkM1 zone which to bypass.
code no Alarm code to bypass the zone (4 or 6 digits).

Service elkm1.sensor_zone_trigger

Cause a zone on the panel to trigger. This command creates a virtual momentary open condition on the zone as if the EOL hardwired loop had been physically opened.

Service data attribute Optional Description
entity_id yes ElkM1 zone which to trigger.

Service elkm1.set_time

Set the time on the panel. Uses the current time on the instance of Home Assistant.

Service data attribute Optional Description
prefix yes Prefix to identify panel when multiple panels configured.

Service elkm1.speak_phrase

Speak a phrase. The list of phrases is defined in the ElkM1 ASCII Protocol documentation.

Service data attribute Optional Description
phrase no Phrase to speak.
prefix yes Prefix to identify panel when multiple panels configured.

Service elkm1.speak_word

Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documentation.

Service data attribute Optional Description
word no Word to speak.
prefix yes Prefix to identify panel when multiple panels configured.