-
-
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
Merged
Merged
Changes from 35 commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
7761260
Deconz hub documentation
Kane610 703489d
Add binary sensor documentation
Kane610 462828b
Add sensor documentation
Kane610 624b4fc
Add light documentation
Kane610 9af6a73
Improve description
Kane610 654e79d
Add information about HASS events from ZHASwitch buttonpresses
Kane610 bd016cf
Added description about how entity id naming works
Kane610 530358f
Added links to dresden elektronik, deconz and deconz rest api
Kane610 aa8f4f4
Changed description of how to generate API key
Kane610 849d5e5
Added information about configuration variables username and password
Kane610 6765855
Updated lists of verified devices
Kane610 4e65edc
Links from list of supported device to sub modules
Kane610 9fd66c2
Remove documentation for api_key_generation since functionality has b…
Kane610 65674ec
Add documentation for configure service
Kane610 396e0b1
Documentation for scenes
Kane610 4628e4a
Bumped HASS release version to 0.59
Kane610 6cd572a
Added Xiaomi Aqara Smart Wireless Switch to list of verified to work …
Kane610 1f207ec
Added improved automation example by simonporter007
Kane610 0b01111
Added information about deCONZ configurator
Kane610 6cabc52
Fix raw code
Kane610 0c09774
Added more lights to supported list
Kane610 e77e0ec
Make description about entity id same in all types
Kane610 2ea698b
Updated installation instructions
Kane610 d884646
Added Dresden Elektroniks logo
Kane610 b20fe26
Added Tseels verified to work devices
Kane610 a41cace
Bump ha_release string
Kane610 a115dbe
Added information about groups
Kane610 3f8c758
Link to information about switch not being an entity on main hub page
Kane610 857a7b8
Improved information about switches not being normal entities
Kane610 c66583e
It should be api_key not api-key
Kane610 a49c08a
Removed specifying deconz version
Kane610 27bcb20
Bump version to 0.61
Kane610 af6549e
Fix typos
Kane610 0728fdc
Use configuration tags to describe configuration parameters
Kane610 649db42
Fix martinhjelamares comments
Kane610 3e36599
Rename parameter service data attribute
Kane610 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ Binary Sensor" | ||
description: "Instructions on 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.61" | ||
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 | ||
- Philips Hue Motion Sensor | ||
- Xiaomi Motion Sensor | ||
- Xiaomi Smart Home Aqara Human Body Sensor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
--- | ||
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.61" | ||
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 Home Assistant GUI to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in deconz.conf inside the home-assistant folder. | ||
|
||
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/) | ||
|
||
{% configuration %} | ||
host: | ||
description: The IP address of your deCONZ web server. | ||
required: false | ||
type: string | ||
api_key: | ||
description: The API key to access your deCONZ web server. | ||
required: false | ||
type: string | ||
port: | ||
description: Configure port deCONZ web server is accessible from. | ||
required: false | ||
default: 80 | ||
type: int | ||
{% endconfiguration %} | ||
|
||
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 | Optional | Description | | ||
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 rename |
||
|-----------|----------|-------------| | ||
| `field` | No | String representing a specific device in deCONZ. | | ||
| `data` | No | Data is a JSON object with what data you want to alter. | | ||
|
||
{ "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 %} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ lights" | ||
description: "Instructions on 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.61" | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
layout: page | ||
title: "deCONZ scenes" | ||
description: "Instructions on how to integrate deCONZ scenes into Home Assistant." | ||
date: 2017-11-19 20:00 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
logo: deconz.jpeg | ||
ha_category: Scene | ||
ha_release: "0.61" | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
layout: page | ||
title: deCONZ Sensor | ||
description: "Instructions on how to integrate Zigbee 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: Sensor | ||
ha_release: "0.61" | ||
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 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Add HUE Motion sensor