Add deCONZ component documentation #3967

Kane610 · 2017-11-12T16:42:59Z

Description:
Component supporting deCONZ REST API exposing Zigbee devices such as Lights and Sensors.

Pull request in home-assistant: home-assistant/core#10321

Checklist:

New documentation for platforms/components and features should go to next.
The documentation follow the standards.

donnib · 2017-11-13T08:33:16Z

source/_components/deconz.markdown

+## {% linkable_title Configuration variables %}
+
+- **host** (*Required*): The IP address to your deCONZ server.
+- **api-key** (*Optional*): The username to your Axis device. Default is 'root'.


Left overs from the Axis component ;)

donnib · 2017-11-13T08:34:06Z

source/_components/deconz.markdown

+## {% linkable_title Device services %}
+Available services: `generate_api_key`.
+
+#### {% linkable_title Service `deconz/generate_api_key` %}


Please add a link to deconz documentation for this http://dresden-elektronik.github.io/deconz-rest-doc/getting_started/

donnib · 2017-11-13T08:41:58Z

So here is some general feedback :

I think it would be VERY beneficial to make a list of the real devices supported since users will ask questions like does THIS specific device work ? so make a list similar to the one i started :
https://bitbucket.org/mihaicph/deconz-custom-module/overview
Add examples of an event automation like i did in above link
Explain to users how they find the ID's in deconz by pointing to Postman for example (you can get some inspiration what i wrote)
Make a list of things that you know doesn't work at the moment or won't work when released such as renames in deconz only after reboot or what id deconz is rebooted, does it then still work, such things.
Also i think a best practice should be there such as explaining to users that they should try to make groups in deConz then control the groups when there is more than one light you wish to control at the same time, failing to do so can cause some weird Zigbee problems.

Added automation examples for a IKEA Trådfri dimmer and input number Added list of supported device types Added lists of verified to work devices Removed references to Axis component

simonporter007 · 2017-11-17T18:36:04Z

source/_components/light.deconz.markdown

+
+#### {% linkable_title Verified to be supported sensors %}
+
+- IKEA Trådfri bulb GU10 W 400lm


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)

Hmm, maybe I need to decode it to a specific type like UTF-8?

simonporter007 · 2017-11-17T18:39:53Z

source/_components/deconz.markdown

+
+- **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.


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?

Websocket port is taken directly from Deconz, no need to configure.

donnib · 2017-11-17T19:05:39Z

source/_components/binary_sensor.deconz.markdown

+
+- Open/close detection
+- Presence detection
+  - IKEA Trådfri Motion Sensor


Add HUE Motion sensor

donnib · 2017-11-17T19:06:08Z

source/_components/deconz.markdown

+
+[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.


Change to 2.04.89

donnib · 2017-11-17T19:11:52Z

source/_components/sensor.deconz.markdown

+- Light level sensor
+- Pressure sensor
+- Switches
+  - IKEA Trådfri wireless dimmer


Add IKEA Trådfri remote http://www.ikea.com/us/en/catalog/products/20303317/
Add Xiaomi Humidity/Temperature sensor https://www.gearbest.com/access-control/pp_626702.html
Add Philips HUE Dim Switch http://www2.meethue.com/en-us/p/hue-dimmer-switch/046677458140
Add Xiaomi Cube https://www.gearbest.com/living-appliances/pp_364494.html?vip=3160986&gclid=CjwKCAiArrrQBRBbEiwAH_6sNOFBNv-r-QMC2huQ9ODXWxARRAJtGRdwWZO_1GEt9MAJg1IXLS1hlhoCDT4QAvD_BwE
Add Philips Motion Sensor http://www2.meethue.com/en-hk/p/hue-motion-sensor/8718696769881

…een removed

…devices

thoscut · 2017-12-13T12:27:24Z

Can confirm following devices to be working fine:

Xiaomi WXKG01LM Smart Home Wireless Switch
Xiaomi WXKG11LM Aqara Smart Wireless Switch
Xiaomi WXKG02LM Aqara Smart Light Switch
Xiaomi RTCGQ01LM Motion Sensor
Xiaomi RTCGQ01LM Smart Home Aqara Human Body Sensor
Xiaomi MCCGQ01LM Smart Home Security Door & Window Contact Sensor
Xiaomi WSDCGQ01LM MiJia Smart Temperature & Humidity Sensor
Xiaomi WSDCGQ11LM Aqara Temperature Humidity Sensor

Due to lack of support in deconz, battery values are still not reported.

Kane610 · 2017-12-15T21:30:03Z

@tseel no battery support on any of those devices?

thoscut · 2017-12-16T00:05:48Z

@Kane610 It's a known issue in the rest api of deconz and announced for the future, see dresden-elektronik/deconz-rest-plugin#13

Added additional verified lights

frenck

@Kane610 Requested some small change via review. Could you take a look?

frenck · 2017-12-19T22:39:17Z

source/_components/binary_sensor.deconz.markdown

+---
+layout: page
+title: "deCONZ Binary Sensor"
+description: "Instructions how to integrate Zigbee binary sensors from deCONZ into Home Assistant."


Instructions how to -> Instructions on how to

frenck · 2017-12-19T22:40:37Z

source/_components/deconz.markdown

+
+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.


Missing comma after HASS -> from HASS, the API

Replace HASS -> Home Assistant

frenck · 2017-12-19T22:41:50Z

source/_components/deconz.markdown

+| Parameter | Description                                             |
+|-----------|---------------------------------------------------------|
+| `field`   | String representing a specific device in deCONZ.        |
+| `data`    | Data is a json object with what data you want to alter. |


json -> JSON

frenck · 2017-12-19T22:42:15Z

source/_components/deconz.markdown

+
+## {% linkable_title Configuration variables %}
+
+- **host** (*Optional*): The IP address to your deCONZ server.


address to your -> address of your

frenck · 2017-12-19T22:43:25Z

source/_components/deconz.markdown

+- [Switches (Remote Controls)](/components/sensor/deconz/)
+- [Temperature Sensors](/components/sensor/deconz/)
+
+## {% linkable_title Configuration variables %}


Please use the configuration tags to display configuration variables. For more information see:
https://home-assistant.io/developers/documentation/create_page/#configuration

This header is not needed. It will be defined automatically when using the configuration tags.

frenck · 2017-12-19T22:44:31Z

source/_components/light.deconz.markdown

+footer: true
+logo: deconz.jpeg
+ha_category: Light
+ha_release: "0.60"


bump to 0.61

frenck · 2017-12-19T22:44:40Z

source/_components/sensor.deconz.markdown

+footer: true
+logo: deconz.jpeg
+ha_category: Sensor
+ha_release: "0.60"


bump to 0.61

frenck · 2017-12-20T11:33:28Z

source/_components/sensor.deconz.markdown

+---
+layout: page
+title: deCONZ Sensor
+description: "Instructions how to integrate Zigbee sensors from deCONZ into Home Assistant."


Instructions how to -> Instructions on how to

frenck · 2017-12-20T11:33:33Z

source/_components/scene.deconz.markdown

+---
+layout: page
+title: "deCONZ"
+description: "Instructions how to integrate deCONZ scenes into Home Assistant."


Instructions how to -> Instructions on how to

frenck · 2017-12-20T11:33:46Z

source/_components/scene.deconz.markdown

+footer: true
+logo: deconz.jpeg
+ha_category: Scene
+ha_release: "0.60"


bump to 0.61

frenck

Click approve instead of request changes (correcting)

Kane610 · 2017-12-20T17:03:48Z

@frenck thanks for feedback! I followed your suggested improvements.

frenck

Thanks @Kane610 🏅

Kane610 · 2017-12-20T22:06:23Z

Much appreciated @frenck !

MartinHjelmare · 2018-01-01T16:11:34Z

source/_components/deconz.markdown

+- [Switches (Remote Controls)](/components/sensor/deconz/)
+- [Temperature Sensors](/components/sensor/deconz/)
+
+## {% linkable_title Configuration variables %}


This header is not needed. It will be defined automatically when using the configuration tags.

MartinHjelmare · 2018-01-01T16:13:32Z

source/_components/deconz.markdown

+
+| Parameter | Description                                             |
+|-----------|---------------------------------------------------------|
+| `field`   | String representing a specific device in deCONZ.        |


Please format as our standard service table. Also extend this table with info on if parameter is optional. See eg:
https://home-assistant.io/components/media_player.sonos/#service-sonos_snapshot

MartinHjelmare · 2018-01-01T16:54:30Z

source/_components/deconz.markdown

+#### {% 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 |


Please rename Parameter to Service data attribute.

MartinHjelmare

Thanks!

Kane610 · 2018-01-01T17:35:58Z

Thanks a lot @MartinHjelmare !

Kane610 added 5 commits November 12, 2017 16:47

Deconz hub documentation

7761260

Add binary sensor documentation

703489d

Add sensor documentation

462828b

Add light documentation

624b4fc

Improve description

9af6a73

Kane610 mentioned this pull request Nov 12, 2017

Add deCONZ component home-assistant/core#10321

Merged

6 tasks

Kane610 added 2 commits November 12, 2017 18:39

Add information about HASS events from ZHASwitch buttonpresses

654e79d

Added description about how entity id naming works

bd016cf

Kane610 changed the title ~~WIP: Deconz component~~ WIP: Deconz component documentation Nov 12, 2017

donnib reviewed Nov 13, 2017

View reviewed changes

Kane610 added 3 commits November 14, 2017 23:19

Added links to dresden elektronik, deconz and deconz rest api

530358f

Added automation examples for a IKEA Trådfri dimmer and input number Added list of supported device types Added lists of verified to work devices Removed references to Axis component

Changed description of how to generate API key

aa8f4f4

Added information about configuration variables username and password

849d5e5

simonporter007 reviewed Nov 17, 2017

View reviewed changes

donnib reviewed Nov 17, 2017

View reviewed changes

Kane610 added 9 commits November 17, 2017 22:41

Updated lists of verified devices

6765855

Links from list of supported device to sub modules

4e65edc

Remove documentation for api_key_generation since functionality has b…

9fd66c2

…een removed

Add documentation for configure service

65674ec

Documentation for scenes

396e0b1

Bumped HASS release version to 0.59

4628e4a

Added Xiaomi Aqara Smart Wireless Switch to list of verified to work …

6cd572a

…devices

Added improved automation example by simonporter007

1f207ec

Added information about deCONZ configurator

0b01111

Kane610 changed the title ~~WIP: Deconz component documentation~~ deCONZ component documentation Nov 21, 2017

Added Tseels verified to work devices

b20fe26

Bump ha_release string

a41cace

frenck added the new-integration This PR adds documentation for a new Home Assistant integration label Dec 18, 2017

Kane610 added 5 commits December 19, 2017 22:09

Added information about groups

a115dbe

Added additional verified lights

Link to information about switch not being an entity on main hub page

3f8c758

Improved information about switches not being normal entities

857a7b8

It should be api_key not api-key

c66583e

Removed specifying deconz version

a49c08a

frenck self-requested a review December 19, 2017 22:44

frenck approved these changes Dec 20, 2017

View reviewed changes

frenck requested changes Dec 20, 2017

View reviewed changes

Kane610 added 3 commits December 20, 2017 17:42

Bump version to 0.61

27bcb20

Fix typos

af6549e

Use configuration tags to describe configuration parameters

0728fdc

frenck previously approved these changes Dec 20, 2017

View reviewed changes

MartinHjelmare requested changes Jan 1, 2018

View reviewed changes

Fix martinhjelamares comments

649db42

Kane610 dismissed frenck’s stale review via 649db42 January 1, 2018 16:27

MartinHjelmare reviewed Jan 1, 2018

View reviewed changes

Rename parameter service data attribute

3e36599

MartinHjelmare approved these changes Jan 1, 2018

View reviewed changes

MartinHjelmare changed the title ~~deCONZ component documentation~~ Add deCONZ component documentation Jan 1, 2018

MartinHjelmare merged commit 943b2e3 into home-assistant:next Jan 1, 2018

Kane610 deleted the deconz-component branch February 6, 2019 21:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deCONZ component documentation #3967

Add deCONZ component documentation #3967

Kane610 commented Nov 12, 2017 •

edited

Loading

donnib Nov 13, 2017

donnib Nov 13, 2017

donnib commented Nov 13, 2017

simonporter007 Nov 17, 2017

Kane610 Nov 17, 2017

simonporter007 Nov 17, 2017

Kane610 Nov 17, 2017

donnib Nov 17, 2017

donnib Nov 17, 2017

donnib Nov 17, 2017

thoscut commented Dec 13, 2017

Kane610 commented Dec 15, 2017 •

edited

Loading

thoscut commented Dec 16, 2017

frenck left a comment

frenck Dec 19, 2017

frenck Dec 19, 2017

frenck Dec 19, 2017

frenck Dec 19, 2017

frenck Dec 19, 2017

MartinHjelmare Jan 1, 2018

frenck Dec 19, 2017

frenck Dec 19, 2017

frenck Dec 20, 2017

frenck Dec 20, 2017

frenck Dec 20, 2017

frenck left a comment

Kane610 commented Dec 20, 2017

frenck left a comment

Kane610 commented Dec 20, 2017

MartinHjelmare Jan 1, 2018

MartinHjelmare Jan 1, 2018

MartinHjelmare Jan 1, 2018

MartinHjelmare left a comment

Kane610 commented Jan 1, 2018


		#### {% linkable_title Verified to be supported sensors %}

		- IKEA Trådfri bulb GU10 W 400lm


		[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.


		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.


		## {% linkable_title Configuration variables %}

		- host (Optional): The IP address to your deCONZ server.

Add deCONZ component documentation #3967

Add deCONZ component documentation #3967

Conversation

Kane610 commented Nov 12, 2017 • edited Loading

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

donnib commented Nov 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thoscut commented Dec 13, 2017

Kane610 commented Dec 15, 2017 • edited Loading

thoscut commented Dec 16, 2017

frenck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frenck left a comment

Choose a reason for hiding this comment

Kane610 commented Dec 20, 2017

frenck left a comment

Choose a reason for hiding this comment

Kane610 commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

Kane610 commented Jan 1, 2018

Kane610 commented Nov 12, 2017 •

edited

Loading

Kane610 commented Dec 15, 2017 •

edited

Loading