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-14 21:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify how to connect to Elk over serial port (#10604)

Browse Source 
* Update docs to use the default Elk Baud rate of 115200 for serial connections.
* Use /dev/ttyUSB0, which is the serial device used by USB-to-serial converters by default.
* Don't use a username and password over a serial connection, as Elk doesn't require them over a hardwired serial connection.
* Give example of liberal use of exclusions, showing users how to avoid Entity registry spam caused by Elk.
This commit is contained in:
Chris Colohan 2019-11-07 02:40:43 -08:00 committed by Franck Nijhof
parent 7c81578d98
commit 61baec6c8e
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
source/_integrations/elkm1.markdown
View File

@ -43,7 +43,7 @@ elkm1:
{% 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`. 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.
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 (Elk systems default to 115200 baud, but this can be changed during Elk system configuration). You may have multiple host sections for connecting multiple controllers.
required: true
type: string
username:
@ -270,18 +270,29 @@ elkm1:
exclude: [b12-d5]
```
Example for a serial port instance on /dev/ttyS1 at 9600 baud:
Example for a serial port instance on /dev/ttyUSB0 at 115200 baud:
```yaml
elkm1:
host: serial://dev/ttyS1:9600
username: USERNAME
password: PASSWORD
- host: serial:///dev/ttyUSB0:115200
# Elk doesn't know which areas/zones/etc are unused, so it can generate
# many unwanted Home Assistant Entities. Be liberal in excluding them:
area:
exclude: [5-8]
exclude: [2-8]
zone:
exclude: [11-16, 19-192, 199-208]
exclude: [17-192, 195-208]
plc:
include: [a1-d16, 192]
exclude: [b12-d5]
enabled: false
task:
enabled: false
counter:
exclude: [1-64]
keypad:
exclude: [3-16]
setting:
exclude: [1-20]
output:
enabled: false
thermostat:
enabled: false
```