-
-
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 10 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,29 @@ | ||
--- | ||
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: zigbee.png | ||
ha_category: Binary Sensor | ||
ha_release: "0.58" | ||
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 comes from deCONZ. | ||
|
||
#### {% linkable_title Verified to be supported binary sensors %} | ||
|
||
- Open/close detection | ||
- 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 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
--- | ||
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: zigbee.png | ||
ha_category: Hub | ||
ha_release: "0.58" | ||
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/) verified from v2.04.86. | ||
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. Change to 2.04.89 |
||
|
||
The minimum amount of configuration for deCONZ is the IP ADDRESS, if you don't have the API key. The component will automatically generate an API key for deCONZ. You can later find the API key in deconz.conf inside the home-assistant folder. If you've changed the username and password you can specify those when you configure deconz in configuration.yaml. | ||
|
||
You must configure deCONZ by adding the following lines to your `configuration.yaml` file: | ||
|
||
```yaml | ||
# Example configuration.yaml entry | ||
deconz: | ||
host: IP ADDRESS | ||
``` | ||
|
||
#### {% linkable_title Supported Device types %} | ||
|
||
- Zigbee lights | ||
- Humidity sensors | ||
- Light Level sensors | ||
- OpenClose detectors | ||
- Presence detectors | ||
- Pressure sensors | ||
- Switches (remote controls) | ||
- Temperature sensors | ||
|
||
## {% 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** (*Required*): The IP address to your deCONZ server. | ||
- **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. |
||
- **username** (*Optional*): If you need to generate an API key. Default is 'delight'. | ||
- **password** (*Optional*): If you need to generate an API key. Default is 'delight'. | ||
|
||
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 Remote control devices%} | ||
|
||
Remote controls (ZHASwitch category) will be exposed 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. An extra entity battery sensor will be created to show battery levels of switch. | ||
|
||
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 Device services %} | ||
Available services: `generate_api_key`. | ||
|
||
#### {% linkable_title Service `deconz/generate_api_key` %} | ||
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 add a link to deconz documentation for this http://dresden-elektronik.github.io/deconz-rest-doc/getting_started/ |
||
Generate API key needed by component to communicate with deCONZ. The Key will be stored in a config file named deconz.conf. | ||
|
||
| Service data attribute | Optional | Description | | ||
|---------------------------|----------|-------------------------------------------| | ||
| `username` | yes | Username to deCONZ. Default is `delight`. | | ||
| `password` | yes | Password to deCONZ. Default is `delight`. | | ||
|
||
## {% linkable_title Examples %} | ||
|
||
### {% linkable_title Step up and step down input number with wireless dimmer %} | ||
|
||
```yaml | ||
automation: | ||
- alias: step_up | ||
trigger: | ||
platform: event | ||
event_type: deconz_event | ||
event_data: | ||
id: tradfri_wireless_dimmer_ | ||
event: 2002 | ||
action: | ||
service: input_number.increment | ||
entity_id: input_number.slider1 | ||
|
||
- alias: step_down | ||
trigger: | ||
platform: event | ||
event_type: deconz_event | ||
event_data: | ||
id: tradfri_wireless_dimmer_ | ||
event: 3002 | ||
action: | ||
service: input_number.decrement | ||
entity_id: input_number.slider1 | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ lights" | ||
description: "Instructions how to integrate your Zigbee lights from deCONZ into Home Assistant." | ||
date: 2017-11-12 16:30 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: zigbee.png | ||
ha_category: Light | ||
ha_release: "0.58" | ||
ha_iot_class: "Local Push" | ||
--- | ||
|
||
See the [deCONZ main component](/components/deconz/) for configuration instructions. | ||
|
||
Lights entity names will be light.device_name, where device_name comes from deCONZ. | ||
|
||
#### {% linkable_title Verified to be supported sensors %} | ||
|
||
- IKEA Trådfri bulb GU10 W 400lm | ||
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. Tested "TRADFRI bulb E27 WS�opal 980lm" as working. Not sure about the weird character in there but thats how it displays in the front end (and probably deconz to be fair) 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. Hmm, maybe I need to decode it to a specific type like UTF-8? |
||
- OSRAM Flex RGBW |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
layout: page | ||
title: deCONZ 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: zigbee.png | ||
ha_category: Sensor | ||
ha_release: "0.58" | ||
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 comes from deCONZ. | ||
|
||
#### {% linkable_title Verified to be supported sensors %} | ||
|
||
- Humidity sensor | ||
- Light level sensor | ||
- Pressure sensor | ||
- Switches | ||
- IKEA Trådfri wireless dimmer | ||
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 IKEA Trådfri remote http://www.ikea.com/us/en/catalog/products/20303317/ |
||
- Temperature 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