mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-25 02:07:15 +00:00
Update docs (#5373)
This commit is contained in:
Fabian Affolter
GitHub
parent
407d7f6cb6
commit
0cf73827b7
@ -13,33 +13,9 @@ ha_release: "0.70"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors,
|
||||
CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a
|
||||
NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).
|
||||
The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).
|
||||
|
||||
See the [`konnected`](/components/konnected/) component for configuration and setup instructions. Please visit the
|
||||
[Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible
|
||||
hardware.
|
||||
See the [`konnected`](/components/konnected/) component for configuration and setup instructions.
|
||||
|
||||
This component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/)
|
||||
component.
|
||||
This component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component.
|
||||
|
||||
{% configuration %}
|
||||
|
||||
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.
|
||||
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.
|
||||
required: exclusive
|
||||
type:
|
||||
description: Any [binary sensor](/components/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
|
||||
|
||||
{% endconfiguration%}
|
||||
|
||||
**Note:** Either **pin** or **zone** is required for each sensor. Do not use both in the same sensor definition.
|
||||
@ -12,22 +12,99 @@ ha_category: Alarm
|
||||
ha_release: "0.70"
|
||||
---
|
||||
|
||||
The `konnected` component 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` component 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.
|
||||
|
||||
Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and
|
||||
compatible hardware.
|
||||
Visit the [Konnected.io website](https://konnected.io) 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](/components/binary_sensor.konnected/): Wired door and window sensors, motion detectors, glass-break
|
||||
detectors, leak sensors, smoke & CO detectors or any open/close switch.
|
||||
- [Switch](/components/switch.konnected/): Actuate a siren, strobe, buzzer, or relay module.
|
||||
|
||||
- [Binary Sensor](/components/binary_sensor.konnected/): Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
|
||||
- [Switch](/components/switch.konnected/): Actuate a siren, strobe, buzzer or relay module.
|
||||
|
||||
This component requires the [`discovery`](https://www.home-assistant.io/components/discovery) component to be enabled.
|
||||
|
||||
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:
|
||||
## {% 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:
|
||||
|
||||
```yaml
|
||||
# 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](/components/binary_sensor.konnected/) 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](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) 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](https://konnected.io) board. Valid values are 1, 2, 3, 4, 5 and 6.
|
||||
required: exclusive
|
||||
type:
|
||||
description: Any [binary sensor](/components/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](/components/switch.konnected/) 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](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) 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](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.
|
||||
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 the `out` zone will only work when activation is set to high (the default).
|
||||
|
||||
## {% linkable_title Full configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -58,38 +135,10 @@ konnected:
|
||||
name: 'Garage Door'
|
||||
activation: low
|
||||
```
|
||||
|
||||
{% 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. For security, we recommend using `secrets.yml` to specify this.
|
||||
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](/components/binary_sensor.konnected/) for configuration variables.
|
||||
required: false
|
||||
type: list
|
||||
switches:
|
||||
description: A list of actuators (on/off switches) connected to the device. See [Konnected Switch](/components/switch.konnected/) for configuration variables.
|
||||
required: false
|
||||
type: list
|
||||
|
||||
{% endconfiguration%}
|
||||
|
||||
### {% 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 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 |
|
||||
|---|---|---|---|
|
||||
|
||||
@ -13,34 +13,7 @@ ha_release: "0.70"
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `konnected` switch allows you to actuate an alarm system siren, strobe light, buzzer, or any other wired device using
|
||||
a [Konnected Alarm Panel board](https://konnected.io) or relay module and a NodeMCU ESP8266 WiFi module running the
|
||||
[open source Konnected software](https://github.com/konnected-io/konnected-security).
|
||||
|
||||
Please visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible
|
||||
hardware.
|
||||
The `konnected` switch platform allows you to actuate an alarm system siren, strobe light, buzzer or any other wired device using a [Konnected Alarm Panel board](https://konnected.io) or relay module and a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).
|
||||
|
||||
See the [`konnected`](/components/konnected/) component for configuration and setup instructions.
|
||||
|
||||
{% configuration %}
|
||||
|
||||
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.
|
||||
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.
|
||||
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. Do not use both in the same definition.
|
||||
- Pin `D8` or the `out` zone will only work when activation is set to high (the default).
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user