jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

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
Download patch file Download diff file Expand all files Collapse all files

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.