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.

If you would like your alarm_control_panel devices to keep track of the user whose code was last used to change the status of that partition (via the attributes changed_by and changed_by_id) you must configure your Elk’s global setting location 35, “System Log Data Update” transmission, so that the M1 sends the updated partition status whenever it changes. (It may work anyway if you have exactly one area configured and do not have that setting enabled.)

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, add the following section to your configuration.yaml file:

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

Configuration Variables

hoststringRequired

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.

usernamestring(Optional)

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

passwordstring(Optional)

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

prefixstring

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_unitstring(Optional, default: F)

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

auto_configureboolean(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.

areamap(Optional, default: All included.)

Elk areas to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

countermap(Optional, default: All included.)

Elk counters to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

keypadmap(Optional, default: All included.)

Elk keypads to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

outputmap(Optional, default: All included.)

Elk outputs to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

settingmap(Optional, default: All included.)

Elk settings to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

taskmap(Optional, default: All included.)

Elk tasks to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

thermostatmap(Optional, default: All included.)

Elk thermostats to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

plcmap(Optional, default: All included.)

Elk PLC lights to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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.

zonemap(Optional, default: All included.)

Elk zones to include in Home Assistant.

enabledboolean(Optional, default: true)

Enable this configuration section.

includelist(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.

excludelist(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