6.1 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release |
---|---|---|---|---|---|---|---|---|---|---|
page | Konnected | Connect wired alarm sensors and siren using the NodeMCU based Konnected Alarm Panel | 2018-04-03 12:30 | true | false | true | true | konnected.png | Alarm | 0.70 |
The konnected
component lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the open source Konnected software. 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 for more information about the Konnected Alarm Panel board and compatible hardware.
The component currently supports the following device types in Home Assistant:
- Binary Sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
- Switch: Actuate a siren, strobe, buzzer or relay module.
This component requires the discovery
component to be enabled.
{% linkable_title Configuration %}
A konnected
section must be present in the configuration.yml
file that specifies the Konnected devices on the network and the sensors or actuators attached to them:
# Example configuration.yaml entry
konnected:
access_token: REPLACE_ME_WITH_A_RANDOM_STRING
devices:
- id: 8bcd53
binary_sensors:
- zone: 1
type: door
switches:
- zone: out
- id: 438a38
binary_sensors:
- pin: 2
type: door
switches:
- pin: 5
{% configuration %}
access_token:
description: Any random string. This is used to ensure that only those devices which you have configured can authenticate to Home Assistant to change a device state.
required: true
type: string
devices:
description: A list of Konnected devices that you have on your network.
required: true
type: list
keys:
id:
description: The MAC address of the WiFi module with colons/punctuation removed. You can either use the full 12-character MAC address or only the last 6 characters. This is visible in the device's WiFi SSID and hostname.
required: true
type: string
binary_sensors:
description: A list of binary sensors connected to the device. See Konnected Binary Sensor for configuration variables.
required: false
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 for more details. Valid values are 1, 2, 5, 6, 7 and 9.
required: exclusive
zone:
description: The number corresponding to the labeled zone on the Konnected Alarm Panel board. Valid values are 1, 2, 3, 4, 5 and 6.
required: exclusive
type:
description: Any binary sensor class, typically door
, window
, motion
or smoke
.
required: true
name:
description: The name of the device used in the front end.
required: false
default: automatically generated
switches:
description: A list of actuators (on/off switches) connected to the device. See Konnected Switch for configuration variables.
required: false
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 for more details. Valid values are 1, 2, 5, 6, 7 and 8.
required: exclusive
zone:
description: The number corresponding to the labeled zone on the Konnected Alarm Panel 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.
required: exclusive
name:
description: The name of the device used in the front end.
required: false
default: automatically generated
activation:
description: Either "low" or "high" to specify the state when the switch is turned on.
default: high
required: false
{% endconfiguration%}
Configuration Notes
- Either pin or zone is required for each actuator or sensor. Do not use both in the same definition.
- Pin
D8
or theout
zone will only work when activation is set to high (the default).
{% linkable_title Full configuration %}
# Example configuration.yaml entry
konnected:
access_token: REPLACE_ME_WITH_A_RANDOM_STRING
devices:
- id: 8bcd53
binary_sensors:
- zone: 1
type: door
name: 'Front Door'
- zone: 3
type: motion
name: 'Test Motion'
switches:
- zone: out
name: siren
- id: 438a38
binary_sensors:
- pin: 1
type: motion
name: 'Office Motion'
- pin: 2
type: door
name: 'Office Door'
switches:
- pin: 5
name: 'Garage Door'
activation: low
{% linkable_title Pin Mapping %}
Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly used with the NodeMCU dev kit WiFi module and optionally Konnected's Alarm Panel hardware. The following table shows the pin mapping between the Konnected hardware labeled zones, the NodeMCU labeled pins and the ESP8266 GPIO pins.
Konnected Alarm Panel Zone | NodeMCU pin | IO Index | ESP8266 GPIO |
---|---|---|---|
1 | D1 | 1 | GPIO5 |
2 | D2 | 2 | GPIO4 |
3 | D5 | 5 | GPIO14 |
4 | D6 | 6 | GPIO12 |
5 | D7 | 7 | GPIO13 |
6 | RX | 9 | GPIO3 |
ALARM or OUT | D8 | 8 | GPIO15 |