Add ZigBee component documentation.

This commit is contained in:
Flyte 2016-01-28 17:07:22 +00:00
parent bc4688e065
commit 583e4f93d7
6 changed files with 213 additions and 0 deletions

View File

@ -0,0 +1,33 @@
---
layout: component
title: ZigBee Binary Sensor
description: "Instructions on how to set up ZigBee binary sensors within Home Assistant."
date: 2016-01-28 12:38
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Binary Sensor
---
A ZigBee binary sensor in this context is a device connected to one of the digital input pins on a ZigBee 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 configure a digital input as a binary sensor, use the following variables:
- **name** (*Required*): The name you'd like to give the binary sensor 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 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'.
#### Example
```yaml
binary_sensor:
- name: Hallway PIR Sensor
platform: zigbee
pin: 0
address: 0013A20040892FA2
on_state: low
```

View File

@ -0,0 +1,33 @@
---
layout: component
title: ZigBee Light
description: "Instructions on how to set up ZigBee lights within Home Assistant."
date: 2016-01-28 12:38
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Light
---
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
```yaml
light:
- name: Desk Lamp
platform: zigbee
pin: 0
address: 0013A20040791FA2
on_state: low
```

View File

@ -0,0 +1,59 @@
---
layout: component
title: ZigBee Sensor
description: "Instructions on how to set up ZigBee sensors within Home Assistant."
date: 2016-01-28 10:08
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Sensor
---
There are two types of ZigBee sensor available to Home Assistant:
- Analog input pin
- Temperature sensor (XBee Pro)
## Analog Input Pin
The analog input pins on an XBee (non-pro) will read 0-1.2 Volts. This is translated by the [xbee-helper](https://github.com/flyte/xbee-helper) library into a percentage. The maximum voltage your ZigBee device will read is configurable using the `max_volts` configuration variable.
To configure an analog input pin sensor, use the following variables:
- **name** (*Required*): The name you'd like to give the sensor in Home Assistant.
- **platform** (*Required*): Set to `zigbee`.
- **type** (*Required*): Set to `analog`.
- **pin** (*Required*): The number identifying which pin to sample.
- **address**: The long 64bit address of the remote ZigBee device whose analog input pin you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's pins.
#### Example
sensor:
- name: My Analog Input
platform: zigbee
type: analog
pin: 0
address: 0013A2004233D138
See the [Digi knowledge base](http://knowledge.digi.com/articles/Knowledge_Base_Article/Digital-and-analog-sampling-using-XBee-radios) for more XBee sampling details.
## Temperature Sensor
The XBee Pro (and perhaps other third party modules) contains a thermometer device which can be read by using the `TP` AT command. To set this up as a temperature sensor device in Home Assistant use the following config variables:
- **name** (*Required*): The name you'd like to give the temperature sensor in Home Assistant
- **platform** (*Required*): Set to `zigbee`
- **type** (*Required*): Set to `temperature`
- **address**: The long 64bit address of the remote ZigBee device whose temperature sensor you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's temperature.
#### Example
```yaml
sensor:
- name: Living Room Temperature
platform: zigbee
type: temperature
address: 0013A20050E752C5
```

View File

@ -0,0 +1,33 @@
---
layout: component
title: ZigBee Switch
description: "Instructions on how to set up ZigBee switches within Home Assistant."
date: 2016-01-28 11:52
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Switch
---
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
```yaml
switch:
- name: Pond Fountain
platform: zigbee
pin: 0
address: 0013A20040791FA2
on_state: low
```

View File

@ -0,0 +1,55 @@
---
layout: component
title: "ZigBee"
description: "Instructions on how to integrate a ZigBee network with Home Assistant."
date: 2016-01-27 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: DIY
---
[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.
There is currently support for the following device types within Home Assistant:
- Binary Sensor (digital input pins)
- Sensor (analog input pins and temperature sensor)
- Light (digital output pins)
- Switch (digital output pins)
The local ZigBee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed.
## Configuration
A `zigbee` section must be present in the `configuration.yaml` file and contain the following options as required:
- **device**: The serial port to which the local ZigBee device is connected. Default: `/dev/ttyUSB0`
- **baud**: The baud rate at which to communicate with the local ZigBee device. Default: `9600`
#### Example
```yaml
zigbee:
device: /dev/ttyUSB0
baud: 115200
```
Or to simply use the defaults:
```yaml
zigbee:
```
To find the possible serial port names of your device, run:
```bash
$ ls /dev/ttyUSB*
```
<p class='note'>
The port may also appear as /dev/ttyACM* if you're communicating with the ZigBee device through an Arduino.
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB