8000 Add Elk-M1 by gwww · Pull Request #6587 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add Elk-M1 #6587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions source/_components/alarm_control_panel.elkm1.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: page
title: "Elk-M1 Alarm Control Panel"
description: "Instructions how to integrate Elk M1 alarm control panel."
date: 2018-10-07 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: elkproducts.png
ha_release: 0.81
ha_category: Alarm
ha_iot_class: "Local Push"
---

The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html).

An Elk-M1 area (also known as partition) is represented as an `alarm_control_panel`.

<p class='note'>
Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page.
</p>
253 changes: 253 additions & 0 deletions source/_components/elkm1.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
---
layout: page
title: "Elk-M1 Controller"
description: "Instructions to setup the Elk-M1 controller."
date: 2018-10-07 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: elkproducts.png
ha_release: 0.81
ha_category: Hub
ha_iot_class: "Local Push"
---

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](https://www.elkproducts.com).

## {% linkable_title Configuration %}

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

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

{% configuration %}
host:
description: 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`.
required: true
type: string
username:
description: Username to login to Elk. Only required if using `elks` connection method.
required: false
type: string
password:
description: Password to login to Elk. Only required if using `elks` connection method.
required: false
type: string
temperature_unit:
description: The temperature unit that the Elk panel uses. Valid values are `C` and `F`.
required: false
type: string
default: F
area:
description: Elk areas to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
counter:
description: Elk counters to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
keypad:
description: Elk keypads to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
output:
description: Elk outputs to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
setting:
description: Elk settings to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
task:
description: Elk tasks to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
thermostat:
description: Elk thermostats to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
plc:
description: Elk PLC lights to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
zone:
description: Elk zones to include in Home Assistant.
required: false
default: All included.
type: map
keys:
enabled:
description: Enable this configuration section.
type: boolean
required: false
default: true
include:
description: 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.
type: list
required: false
default: All included.
exclude:
description: 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.
type: list
required: false
default: None excluded.
{% endconfiguration %}

Example configuration of the above:
```yaml
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]
```
Binary file added source/images/supported_brands/elkproducts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0