jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Describe support of multiple elk devices (#9441)

Browse Source 
* Describe support of multiple elk devices

For an upcoming PR that supports multiple elk devices.  This is a doc update for the version of that PR that uses multiple host sections instead of a list of host sections under a devices tag (since that extra "devices" section would result in a breaking change).

* ✏️ Tweak

* Added a prefix field to one of the config entries

The example config needed a prefix for the second entry.
This commit is contained in:
gjbadros 2019-07-29 11:05:32 -07:00 committed by Franck Nijhof
parent 3baa5df87b
commit 470fa2665f
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
source/_components/elkm1.markdown
View File

@ -36,18 +36,21 @@ There is currently support for the following device types within Home Assistant:
## Configuration ## Configuration
To integrate Elk-M1 controller with Home Assistant, add the following To integrate one or more Elk-M1 controllers with Home Assistant, add the following
section to your `configuration.yaml` file: section to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
elkm1: elkm1:
host: elk://IP_ADDRESS - host: elk://IP_ADDRESS_1
...
- host: elk://IP_ADDRESS_2
prefix: gh # for guest house controller
``` ```
{% configuration %} {% configuration %}
host: 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`. For `serial` method, _address_ is the path to the tty _/dev/ttyS1_ for example and `[:baud]` is the baud rate to connect with. 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`. For `serial` method, _address_ is the path to the tty _/dev/ttyS1_ for example and `[:baud]` is the baud rate to connect with. You may have multiple host sections for connecting multiple controllers.
required: true required: true
type: string type: string
username: username:
@ -58,6 +61,10 @@ password:
description: Password to login to Elk. Only required if using `elks` connection method. description: Password to login to Elk. Only required if using `elks` connection method.
required: false required: false
type: string type: string
prefix:
description: 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.
require: false
type: string
temperature_unit: temperature_unit:
description: The temperature unit that the Elk panel uses. Valid values are `C` and `F`. description: The temperature unit that the Elk panel uses. Valid values are `C` and `F`.
required: false required: false