You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_integrations/konnected.markdown
+20-11Lines changed: 20 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ha_codeowners:
12
12
- '@heythisisnate'
13
13
---
14
14
15
-
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.
15
+
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.
16
16
17
17
Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware.
18
18
@@ -22,7 +22,7 @@ The integration currently supports the following device types in Home Assistant:
22
22
- Switch: Actuate a siren, strobe, buzzer or relay module.
23
23
- Sensor: Periodic measurements from DHT temperature/humidity sensors and DS18B20 temperature sensors.
24
24
25
-
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.
25
+
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.
26
26
27
27
<divclass='note info'>
28
28
@@ -32,7 +32,13 @@ Konnected devices communicate with Home Assistant over your local LAN -- there i
32
32
33
33
## Configuration
34
34
35
-
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:
35
+
Home Assistant offers Konnected integration through **Configuration** -> **Integrations** -> **Konnected.io**.
36
+
37
+
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.
38
+
39
+
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.**
40
+
41
+
Details of the configuration fields and values can be found below - these apply to both the configuration flow and the YAML.
36
42
37
43
```yaml
38
44
# Example configuration.yaml entry
@@ -69,7 +75,7 @@ devices:
69
75
type: list
70
76
keys:
71
77
id:
72
-
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.
78
+
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.
73
79
required: true
74
80
type: string
75
81
binary_sensors:
@@ -78,10 +84,10 @@ devices:
78
84
type: list
79
85
keys:
80
86
pin:
81
-
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`.
87
+
description: See [Configuration Notes](#configuration-notes).
82
88
required: exclusive
83
89
zone:
84
-
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`.
90
+
description: See [Configuration Notes](#configuration-notes).
85
91
required: exclusive
86
92
type:
87
93
description: Any [binary sensor](/integrations/binary_sensor/) class, typically `door`, `window`, `motion` or `smoke`.
@@ -101,10 +107,10 @@ devices:
101
107
type: list
102
108
keys:
103
109
pin:
104
-
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`.
110
+
description: See [Configuration Notes](#configuration-notes).
105
111
required: exclusive
106
112
zone:
107
-
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`.
113
+
description: See [Configuration Notes](#configuration-notes).
108
114
required: exclusive
109
115
name:
110
116
description: The name of the device used in the front end.
@@ -124,10 +130,10 @@ devices:
124
130
type: list
125
131
keys:
126
132
pin:
127
-
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.
133
+
description: See [Configuration Notes](#configuration-notes).
128
134
required: exclusive
129
135
zone:
130
-
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`.
136
+
description: See [Configuration Notes](#configuration-notes).
131
137
required: exclusive
132
138
name:
133
139
description: The name of the device used in the front end.
@@ -169,8 +175,11 @@ devices:
169
175
170
176
### Configuration Notes
171
177
172
-
- Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition.
178
+
- Either `pin` or `zone` is required for each actuator or sensor. Do not use both in the same definition.
179
+
- `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.
173
180
- Pin `D8` or the `out` zone will only work when activation is set to high (the default).
181
+
- `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.
182
+
- **The Konnected Alarm Panel Pro does not support configuration via `pin`.**
0 commit comments