-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add deCONZ component documentation #3967
Changes from 31 commits
7761260
703489d
462828b
624b4fc
9af6a73
654e79d
bd016cf
530358f
aa8f4f4
849d5e5
6765855
4e65edc
9fd66c2
65674ec
396e0b1
4628e4a
6cd572a
1f207ec
0b01111
6cabc52
0c09774
e77e0ec
2ea698b
d884646
b20fe26
a41cace
a115dbe
3f8c758
857a7b8
c66583e
a49c08a
27bcb20
af6549e
0728fdc
649db42
3e36599
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ Binary Sensor" | ||
description: "Instructions how to integrate Zigbee binary sensors from deCONZ into Home Assistant." | ||
date: 2017-11-12 16:30 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: deconz.jpeg | ||
ha_category: Binary Sensor | ||
ha_release: "0.60" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. bump to |
||
ha_iot_class: "Local Push" | ||
--- | ||
|
||
See the [deCONZ main component](/components/deconz/) for configuration instructions. | ||
|
||
The following sensor types are supported: | ||
|
||
* Open/Close detection | ||
* Presence detection | ||
|
||
Entity ids will be binary_sensor.device_name, where device_name is defined in deCONZ. | ||
|
||
#### {% linkable_title Verified to be supported binary sensors %} | ||
|
||
- Open/Close Detection | ||
- Xiaomi Smart Home Security Door & Window Contact Sensor | ||
- Presence Detection | ||
- IKEA Trådfri Motion Sensor | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add HUE Motion sensor |
||
- Philips Hue Motion Sensor | ||
- Xiaomi Motion Sensor | ||
- Xiaomi Smart Home Aqara Human Body Sensor |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ" | ||
description: "Instructions on how to setup Conbee/Raspbee devices with deCONZ from Dresden Elektronik within Home Assistant." | ||
date: 2017-11-12 16:30 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: deconz.jpeg | ||
ha_category: Hub | ||
ha_release: "0.60" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. bump to |
||
ha_iot_class: "Local Push" | ||
--- | ||
|
||
[deCONZ](https://www.dresden-elektronik.de/funktechnik/products/software/pc/deconz/) by [Dresden Elektronik](https://www.dresden-elektronik.de) is a software that communicates with Conbee/Raspbee Zigbee gateways and exposes Zigbee devices that are connected to the gateway. | ||
|
||
[deCONZ REST API](http://dresden-elektronik.github.io/deconz-rest-doc/). | ||
|
||
Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file. | ||
|
||
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to Menu->Settings->Unlock Gateway in deCONZ and then use the deCONZ configurator in HASS GUI to create an API key. When you've generated the API key from HASS the API key will be stored in deconz.conf inside the home-assistant folder. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
You can add the following to your configuration.yaml file if you are not using the `discovery:` component: | ||
|
||
```yaml | ||
# Example configuration.yaml entry | ||
deconz: | ||
host: IP ADDRESS | ||
``` | ||
|
||
#### {% linkable_title Supported Device types %} | ||
|
||
- [Zigbee Lights](/components/light/deconz/) | ||
- [Humidity Sensors](/components/sensor/deconz/) | ||
- [Light Level Sensors](/components/sensor/deconz/) | ||
- [OpenClose Detectors](/components/binary_sensor/deconz/) | ||
- [Presence Detectors](/components/binary_sensor/deconz/) | ||
- [Pressure Sensors](/components/sensor/deconz/) | ||
- [Switches (Remote Controls)](/components/sensor/deconz/) | ||
- [Temperature Sensors](/components/sensor/deconz/) | ||
|
||
## {% linkable_title Configuration variables %} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please use the configuration tags to display configuration variables. For more information see: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This header is not needed. It will be defined automatically when using the |
||
|
||
- **host** (*Optional*): The IP address to your deCONZ server. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- **api_key** (*Optional*): The API key to your deCONZ server. | ||
- **port** (*Optional*): Configure port deCONZ web server is accessible from. Default is 80. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure if it's used here but in the more recent versions of deconz you can change the websocket port. Does this need to be taken into consideration here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Websocket port is taken directly from Deconz, no need to configure. |
||
|
||
A full configuration could look like this: | ||
|
||
```yaml | ||
# Example configuration.yaml entry | ||
deconz: | ||
host: 127.0.0.1 | ||
api_key: 0123456789 | ||
port: 80 | ||
``` | ||
|
||
## {% linkable_title Device services %} | ||
Available services: `configure`. | ||
|
||
#### {% linkable_title Service `deconz/configure` %} | ||
Set attribute of device in Deconz using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/). | ||
|
||
| Parameter | Description | | ||
|-----------|---------------------------------------------------------| | ||
| `field` | String representing a specific device in deCONZ. | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please format as our standard service table. Also extend this table with info on if parameter is optional. See eg: |
||
| `data` | Data is a json object with what data you want to alter. | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
{ "field": "/lights/1", "data": {"name": "light2"} } | ||
|
||
{ "field": "/config", "data": {"permitjoin": 60} } | ||
|
||
## {% linkable_title Remote control devices%} | ||
|
||
Remote controls (ZHASwitch category) will be not be exposed as a regular entity, but as events named 'deconz_event' with a payload of 'id' and 'event'. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level. | ||
|
||
Typical values for switches, the event codes are 4 numbers where the first and last number are of interest here. | ||
|
||
| Switch code | Description | | ||
|-------------|-------------------------| | ||
| 1XXX | Button #1 up to #8 | | ||
| XXX1 | Button hold | | ||
| XXX2 | Button short release | | ||
| XXX3 | Button long release | | ||
|
||
Where for example on a Philips Hue Dimmer, 2001 would be holding the dim up button. | ||
|
||
## {% linkable_title Examples %} | ||
|
||
### {% linkable_title Step up and step down input number with wireless dimmer %} | ||
|
||
```yaml | ||
automation: | ||
- alias: 'Toggle lamp from dimmer' | ||
initial_state: 'on' | ||
trigger: | ||
platform: event | ||
event_type: deconz_event | ||
event_data: | ||
id: remote_control_1 | ||
event: 1002 | ||
action: | ||
service: light.toggle | ||
entity_id: light.lamp | ||
|
||
- alias: 'Increase brightness of lamp from dimmer' | ||
initial_state: 'on' | ||
trigger: | ||
platform: event | ||
event_type: deconz_event | ||
event_data: | ||
id: remote_control_1 | ||
event: 2002 | ||
action: | ||
- service: light.turn_on | ||
data_template: | ||
entity_id: light.lamp | ||
brightness: {% raw %}> | ||
{% set bri = states.light.lamp.attributes.brightness | int %} | ||
{{ [bri+30, 249] | min }}{% endraw %} | ||
|
||
- alias: 'Decrease brightness of lamp from dimmer' | ||
initial_state: 'on' | ||
trigger: | ||
platform: event | ||
event_type: deconz_event | ||
event_data: | ||
id: remote_control_1 | ||
event: 3002 | ||
action: | ||
- service: light.turn_on | ||
data_template: | ||
entity_id: light.lamp | ||
brightness: {% raw %}> | ||
{% set bri = states.light.lamp.attributes.brightness | int %} | ||
{{ [bri-30, 0] | max }}{% endraw %} | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ lights" | ||
description: "Instructions how to integrate Zigbee lights from deCONZ into Home Assistant." | ||
date: 2017-11-12 16:30 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: deconz.jpeg | ||
ha_category: Light | ||
ha_release: "0.60" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. bump to |
||
ha_iot_class: "Local Push" | ||
--- | ||
|
||
See the [deCONZ main component](/components/deconz/) for configuration instructions. | ||
|
||
Entity Ids names will be light.device_name, where device_name is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named light.group_name_in_deconz, allowing the user to control groups of lights with only a single API call to deCONZ. | ||
|
||
#### {% linkable_title Verified to be supported sensors %} | ||
|
||
- IKEA Trådfri bulb E14 WS opal 400lm | ||
- IKEA Trådfri Bulb E27 WS Opal 980lm | ||
- IKEA Trådfri Bulb E27 WS Opal 1000lm | ||
- IKEA Trådfri Bulb GU10 W 400lm | ||
- OSRAM Flex RGBW | ||
- OSRAM Gardenpole RGBW | ||
- Philips Hue White A19 | ||
- Philips Hue White Ambiance A19 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ" | ||
description: "Instructions how to integrate deCONZ scenes into Home Assistant." | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
date: 2017-11-19 20:00 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: deconz.jpeg | ||
ha_category: Scene | ||
ha_release: "0.60" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. bump to |
||
ha_iot_class: "Local Push" | ||
--- | ||
|
||
See the [deCONZ main component](/components/deconz/) for configuration instructions. | ||
|
||
Entity Ids will be scene.group_scene_name, where group is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
layout: page | ||
title: deCONZ Sensor | ||
description: "Instructions how to integrate Zigbee sensors from deCONZ into Home Assistant." | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
date: 2017-11-12 16:30 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: deconz.jpeg | ||
ha_category: Sensor | ||
ha_release: "0.60" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. bump to |
||
ha_iot_class: "Local Push" | ||
--- | ||
|
||
See the [deCONZ main component](/components/deconz/) for configuration instructions. | ||
|
||
The following sensor types are supported: | ||
|
||
* Humidity sensor | ||
* Light level sensor | ||
* Pressure sensor | ||
* Switches | ||
* Temperature sensor | ||
|
||
Entity ids will be sensor.device_name, where device_name is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details. | ||
|
||
#### {% linkable_title Verified to be supported sensors %} | ||
|
||
- Humidity Sensor | ||
- Xiaomi Aqara Humidity/Temperature Sensor | ||
- Xiaomi MiJia Smart Temperature & Humidity Sensor | ||
- Light Level Sensor | ||
- Pressure Sensor | ||
- Switches | ||
- IKEA Trådfri Wireless Dimmer | ||
- Philips Hue Motion Sensor | ||
- IKEA Trådfri Remote | ||
- Philips Hue Dimmer Switch | ||
- Xiaomi Cube | ||
- Xiaomi Aqara Smart Light Switch | ||
- Xiaomi Aqara Smart Wireless Switch | ||
- Xiaomi Smart Home Wireless Switch | ||
- Temperature Sensor | ||
- Xiaomi Temperature/Humidity Sensor |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instructions how to
->Instructions on how to