jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 11:47:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update ZigBee docs

Browse Source
This commit is contained in:
Fabian Affolter 2016-09-06 16:31:35 +02:00
parent d2e7e65e90
commit 738dc54259
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
5 changed files with 31 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/_components/binary_sensor.zigbee.markdown
View File

@ -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`.

21
source/_components/light.zigbee.markdown
View File

@ -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.

2
source/_components/sensor.zigbee.markdown
View File

@ -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:

21
source/_components/switch.zigbee.markdown
View File

@ -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.

1
source/_components/zigbee.markdown
View File

@ -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.