From 55aa1c3c20ff4e466e19f177d5e5d38d0e6612b9 Mon Sep 17 00:00:00 2001 From: Kit Klein <33464407+kit-klein@users.noreply.github.com> Date: Tue, 18 Feb 2020 17:30:03 -0500 Subject: [PATCH] Konnected Pro Board support and config flow (#11785) * Konnected Pro Board support and config flow Updated docs to reflect pro board support and config flow support * Updated to reflect options flow * Note on imports Note that the config/option flow must be used to finalize an imported configuration.yaml. * fix textlint * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof * Update source/_integrations/konnected.markdown Co-Authored-By: Franck Nijhof Co-authored-by: Franck Nijhof --- source/_integrations/konnected.markdown | 31 ++++++++++++++++--------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown index e6529b4bf478..65084bad9fbd 100644 --- a/source/_integrations/konnected.markdown +++ b/source/_integrations/konnected.markdown @@ -12,7 +12,7 @@ ha_codeowners: - '@heythisisnate' --- -The `konnected` integration lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. +The `konnected` integration lets you connect wired sensors and switches to a Konnected Alarm Panel, or NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware. @@ -22,7 +22,7 @@ The integration currently supports the following device types in Home Assistant: - Switch: Actuate a siren, strobe, buzzer or relay module. - Sensor: Periodic measurements from DHT temperature/humidity sensors and DS18B20 temperature sensors. -This integration uses the [`discovery`](/integrations/discovery) component, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description. +This integration uses the [SSDP](/integrations/ssdp) integration, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description.
@@ -32,7 +32,13 @@ Konnected devices communicate with Home Assistant over your local LAN -- there i ## Configuration -A `konnected` section must be present in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them: +Home Assistant offers Konnected integration through **Configuration** -> **Integrations** -> **Konnected.io**. + +The configuration flow will guide you through a setup process that lets you connect to the panel and generate a configuration entry. You can then utilize the options flow to configure or modify the behavior of each zone. + +If you prefer you can also utilize a `konnected` section in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them. If using `configuration.yaml` the configuration will automatically be imported and used to start a configuration flow. **Note that you must still complete the configuration/options flow before the configuration entry will be finalized.** + +Details of the configuration fields and values can be found below - these apply to both the configuration flow and the YAML. ```yaml # Example configuration.yaml entry @@ -69,7 +75,7 @@ devices: type: list keys: id: - description: The MAC address of the NodeMCU Wi-Fi module with colons/punctuation removed, for example `68c63a8bcd53`. You can usually find the mac address in your router's client list. Or, check the home-assistant.log for log messages from automatically discovered devices. + description: The MAC address of the Konnected device with colons/punctuation removed, for example, `68c63a8bcd53`. You can usually find the mac address in your router's client list. Or, check the `home-assistant.log` for log messages from automatically discovered devices. required: true type: string binary_sensors: @@ -78,10 +84,10 @@ devices: type: list keys: pin: - description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are `1`, `2`, `5`, `6`, `7` and `9`. + description: See [Configuration Notes](#configuration-notes). required: exclusive zone: - description: The number corresponding to the labeled zone on the [Konnected Alarm Panel](https://konnected.io) board. Valid values are `1`, `2`, `3`, `4`, `5` and `6`. + description: See [Configuration Notes](#configuration-notes). required: exclusive type: description: Any [binary sensor](/integrations/binary_sensor/) class, typically `door`, `window`, `motion` or `smoke`. @@ -101,10 +107,10 @@ devices: type: list keys: pin: - description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values for sensors are `1`, `2`, `5`, `6`, `7` and `9`. + description: See [Configuration Notes](#configuration-notes). required: exclusive zone: - description: The number corresponding to the labeled zone on the [Konnected Alarm Panel](https://konnected.io) board. Valid values for sensors are `1`, `2`, `3`, `4`, `5` and `6`. + description: See [Configuration Notes](#configuration-notes). required: exclusive name: description: The name of the device used in the front end. @@ -124,10 +130,10 @@ devices: type: list keys: pin: - description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are 1, 2, 5, 6, 7 and 8. + description: See [Configuration Notes](#configuration-notes). required: exclusive zone: - description: The number corresponding to the labeled zone on the [Konnected Alarm Panel](https://konnected.io) board or the word `out` to specify the dedicated ALARM/OUT terminal on the Konnected board. Valid values are `1`, `2`, `3`, `4`, `5` and `out`. + description: See [Configuration Notes](#configuration-notes). required: exclusive name: description: The name of the device used in the front end. @@ -169,8 +175,11 @@ devices: ### Configuration Notes -- Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition. +- Either `pin` or `zone` is required for each actuator or sensor. Do not use both in the same definition. +- `pin` represents the number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are `1`, `2`, `5`, `6`, `7`, `8`, and `9`. Pin based configuration is only allowed with ESP8266 based devices. - Pin `D8` or the `out` zone will only work when activation is set to high (the default). +- `zone` represents the value corresponding to the labeled zone on the [Konnected Alarm Panel](https://konnected.io) boards. Valid zone values are `1`, `2`, `3`, `4`, `5`, `6`, and `out` for the Konnected Alarm Panel (`out` represents the dedicated ALARM/OUT terminal) and `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `out1`, `alarm1`, and `alarm2_out2` for the Konnected Alarm Panel Pro. +- **The Konnected Alarm Panel Pro does not support configuration via `pin`.** ## Extended Configuration