From 738dc5425900705a9a2a8d38012c860d37280029 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 6 Sep 2016 16:31:35 +0200 Subject: [PATCH] Update ZigBee docs --- .../_components/binary_sensor.zigbee.markdown | 11 +++++----- source/_components/light.zigbee.markdown | 21 ++++++++++--------- source/_components/sensor.zigbee.markdown | 2 ++ source/_components/switch.zigbee.markdown | 21 ++++++++++--------- source/_components/zigbee.markdown | 1 + 5 files changed, 31 insertions(+), 25 deletions(-) diff --git a/source/_components/binary_sensor.zigbee.markdown b/source/_components/binary_sensor.zigbee.markdown index e6fb6a1ddb2..48302659e51 100644 --- a/source/_components/binary_sensor.zigbee.markdown +++ b/source/_components/binary_sensor.zigbee.markdown @@ -9,11 +9,13 @@ sharing: true footer: true logo: zigbee.png ha_category: Binary Sensor +ha_release: 0.12 +ha_iot_class: "Local Polling" --- -A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to 'on' or 'off'. By default, a binary sensor is considered 'on' when the ZigBee device's digital input pin is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`. +A `zigbee` binary sha_release: 0.13ensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the ZigBee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`. -To enable the ZigBee binary sensors in your installation, add the following lines to your `configuration.yaml`: +To enable a digital input pin as binary sensor in your installation, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry @@ -27,9 +29,8 @@ binary_sensor: Configuration variables: -- **name** (*Required*): The name you'd like to give the binary sensor in Home Assistant. -- **platform** (*Required*): Set to `zigbee`. +- **name** (*Required*): The name you wouldd like to give the binary sensor in Home Assistant. - **pin** (*Required*): The number identifying which pin to use. - **address**: The long 64bit address of the remote ZigBee device whose digital input pin you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's pins. -- **on_state**: Either `high` (default) or `low`, depicting whether the binary sensor is considered 'on' when the pin is 'high' or 'low'. +- **on_state**: Either `high` (default) or `low`, depicting whether the binary sensor is considered `on` when the pin is `high` or `low`. diff --git a/source/_components/light.zigbee.markdown b/source/_components/light.zigbee.markdown index 25832fedbd1..a50568b0dd2 100644 --- a/source/_components/light.zigbee.markdown +++ b/source/_components/light.zigbee.markdown @@ -9,19 +9,13 @@ sharing: true footer: true logo: zigbee.png ha_category: Light +ha_release: 0.12 +ha_iot_class: "Local Polling" --- -A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered 'on' when the ZigBee device's digital output is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`. +A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`. -To configure a digital output pin as a light, use the following variables: - -- **name** (*Required*): The name you'd like to give the light in Home Assistant. -- **platform** (*Required*): Set to `zigbee`. -- **pin** (*Required*): The number identifying which pin to use. -- **address**: The long 64bit address of the remote ZigBee device whose digital output pin you'd like to switch. Do not include this variable if you want to switch the local ZigBee device's pins. -- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled high or low when the light is turned on. - -#### Example +To configure a digital output pin as light, add the following to your `configuration.yaml` file: ```yaml light: @@ -31,3 +25,10 @@ light: address: 0013A20040791FA2 on_state: low ``` + +Configuration variables: + +- **name** (*Required*): The name you' would like to give the light in Home Assistant. +- **pin** (*Required*): The number identifying which pin to use. +- **address**: The long 64 bit address of the remote ZigBee device whose digital output pin you wouldd like to switch. Do not include this variable if you want to switch the local ZigBee device's pins. +- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled `high` or `low` when the light is turned on. diff --git a/source/_components/sensor.zigbee.markdown b/source/_components/sensor.zigbee.markdown index 58d436ccd27..96f66fc0d45 100644 --- a/source/_components/sensor.zigbee.markdown +++ b/source/_components/sensor.zigbee.markdown @@ -9,6 +9,8 @@ sharing: true footer: true logo: zigbee.png ha_category: Sensor +ha_release: 0.12 +ha_iot_class: "Local Polling" --- There are two types of [ZigBee](http://www.zigbee.org/) sensor available to Home Assistant: diff --git a/source/_components/switch.zigbee.markdown b/source/_components/switch.zigbee.markdown index 41097f32e68..58bb428b79e 100644 --- a/source/_components/switch.zigbee.markdown +++ b/source/_components/switch.zigbee.markdown @@ -9,19 +9,13 @@ sharing: true footer: true logo: zigbee.png ha_category: Switch +ha_release: 0.12 +ha_iot_class: "Local Polling" --- -A ZigBee switch in this context is a device connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a switch is considered 'on' when the ZigBee device's digital output is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`. +A ZigBee switch in this context is a device connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a switch is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`. -To configure a digital output pin as a switch, use the following variables: - -- **name** (*Required*): The name you'd like to give the switch in Home Assistant. -- **platform** (*Required*): Set to `zigbee`. -- **pin** (*Required*): The number identifying which pin to use. -- **address**: The long 64bit address of the remote ZigBee device whose digital output pin you'd like to switch. Do not include this variable if you want to switch the local ZigBee device's pins. -- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled high or low when the switch is turned on. - -#### Example +To configure a digital output pin as switch, add the following to your `configuration.yaml` file: ```yaml switch: @@ -31,3 +25,10 @@ switch: address: 0013A20040791FA2 on_state: low ``` + +Configuration variables: + +- **name** (*Required*): The name you would like to give the switch in Home Assistant. +- **pin** (*Required*): The number identifying which pin to use. +- **address**: The long 6 4bit address of the remote ZigBee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local ZigBee device's pins. +- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled `high` or `low` when the switch is turned on. diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index 0d973649f90..8b29e11237a 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -10,6 +10,7 @@ footer: true logo: zigbee.png ha_category: DIY ha_release: 0.12 +ha_iot_class: "Local Polling" --- [ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilise modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected over a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network.