diff --git a/source/_components/binary_sensor.konnected.markdown b/source/_components/binary_sensor.konnected.markdown new file mode 100644 index 00000000000..727cc4e9440 --- /dev/null +++ b/source/_components/binary_sensor.konnected.markdown @@ -0,0 +1,45 @@ +--- +layout: page +title: "Konnected Binary Sensor" +description: "Connect wired open/close sensors to Home Assistant with Konnected and a NodeMCU ESP8266" +date: 2018-04-03 12:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: konnected.png +ha_category: Binary Sensor +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). + +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. + +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. \ No newline at end of file diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown new file mode 100644 index 00000000000..f9e9a5e9a07 --- /dev/null +++ b/source/_components/konnected.markdown @@ -0,0 +1,102 @@ +--- +layout: page +title: "Konnected" +description: "Connect wired alarm sensors and siren using the NodeMCU based Konnected Alarm Panel" +date: 2018-04-03 12:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: konnected.png +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. + +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. + +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: + +```yaml +# 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 +``` + +{% 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 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 | diff --git a/source/_components/switch.konnected.markdown b/source/_components/switch.konnected.markdown new file mode 100644 index 00000000000..224ce8af5f3 --- /dev/null +++ b/source/_components/switch.konnected.markdown @@ -0,0 +1,46 @@ +--- +layout: page +title: "Konnected Switch" +description: "Connect wired actuators to Home Assistant with Konnected and a NodeMCU ESP8266" +date: 2018-04-03 12:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: konnected.png +ha_category: Switch +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. + +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). diff --git a/source/images/supported_brands/konnected.png b/source/images/supported_brands/konnected.png new file mode 100644 index 00000000000..cd6ebbf7970 Binary files /dev/null and b/source/images/supported_brands/konnected.png differ