Skip to content

Elkm1 config flow #12521

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.

Sign up for GitHub

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
bdraco merged 3 commits into from
Mar 27, 2020
Merged

Elkm1 config flow #12521

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c183ad
Elkm1 config flow
bdraco Mar 27, 2020
6d6011b
Add auto_configure
bdraco Mar 27, 2020
a2d6a3a
Update elkm1.markdown
bdraco Mar 27, 2020
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
23 changes: 21 additions & 2 deletions source/_integrations/elkm1.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ ha_category:
- Switch
ha_iot_class: Local Push
ha_domain: elkm1
ha_config_flow: true
ha_codeowners:
- '@bdraco'
---

The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation.
Expand All @@ -30,8 +33,9 @@ There is currently support for the following device types within Home Assistant:

## Configuration

To integrate one or more Elk-M1 controllers with Home Assistant, add the following
section to your `configuration.yaml` file:
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:

```yaml
# Example configuration.yaml entry
Expand Down Expand Up @@ -64,6 +68,11 @@ temperature_unit:
required: false
type: string
default: F
auto_configure:
description: Auto configure `area`, `counter`, `keypad`, `output`, `setting`, `task`, `thermostat`, `plc`, and `zone` by only adding elements that ElkM1 reports on the initial sync.
required: false
type: boolean
default: False
area:
description: Elk areas to include in Home Assistant.
required: false
Expand Down Expand Up @@ -271,6 +280,16 @@ elkm1:
exclude: [b12-d5]
```

Example configuration using `auto_configure`:

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

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

```yaml
Expand Down