From 470fa2665f142ca523bd92588eda764af4e4de70 Mon Sep 17 00:00:00 2001 From: gjbadros Date: Mon, 29 Jul 2019 11:05:32 -0700 Subject: [PATCH] Describe support of multiple elk devices (#9441) * 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). * :pencil2: Tweak * Added a prefix field to one of the config entries The example config needed a prefix for the second entry. --- source/_components/elkm1.markdown | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown index 063db11650f..86baa1093c2 100644 --- a/source/_components/elkm1.markdown +++ b/source/_components/elkm1.markdown @@ -36,18 +36,21 @@ There is currently support for the following device types within Home Assistant: ## 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: ```yaml # Example configuration.yaml entry elkm1: - host: elk://IP_ADDRESS + - host: elk://IP_ADDRESS_1 + ... + - host: elk://IP_ADDRESS_2 + prefix: gh # for guest house controller ``` {% configuration %} host: - description: Connection string to Elk of the form `://
[:port]`. `` is `elk` for non-secure connection, `elks` for secure connection, and `serial` for serial port connection. `
` is IP address or domain or for `serial` the serial port that the Elk is connected to. Optional `` 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 `://
[:port]`. `` is `elk` for non-secure connection, `elks` for secure connection, and `serial` for serial port connection. `
` is IP address or domain or for `serial` the serial port that the Elk is connected to. Optional `` 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 type: string username: @@ -58,6 +61,10 @@ password: description: Password to login to Elk. Only required if using `elks` connection method. required: false 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: description: The temperature unit that the Elk panel uses. Valid values are `C` and `F`. required: false