Elk-M1 Controller


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.

Configuration

To integrate Elk-M1 controller with Home Assistant, add the following section to your configuration.yaml file:

# Example configuration.yaml entry
elkm1:
  host: elk://IP_ADDRESS

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.

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.

temperature_unit

(string)(Optional)The temperature unit that the Elk panel uses. Valid values are C and F.

Default value: F

area

(map)(Optional)Elk areas to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

counter

(map)(Optional)Elk counters to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

keypad

(map)(Optional)Elk keypads to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

output

(map)(Optional)Elk outputs to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

setting

(map)(Optional)Elk settings to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

task

(map)(Optional)Elk tasks to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

thermostat

(map)(Optional)Elk thermostats to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

plc

(map)(Optional)Elk PLC lights to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

zone

(map)(Optional)Elk zones to include in Home Assistant.

Default value: All included.

enabled

(boolean)(Optional)Enable this configuration section.

Default value: true

include

(list)(Optional)List to include in the form of either <value> or <value>-<value> where <value> is a postive integer or a X10 housecode. See configuration below for examples of ranges.

Default value: All included.

exclude

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

Default value: None excluded.

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]