Skip to content
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 36 commits into from
Jan 1, 2018
Merged
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
7761260
Deconz hub documentation
Kane610 Nov 12, 2017
703489d
Add binary sensor documentation
Kane610 Nov 12, 2017
462828b
Add sensor documentation
Kane610 Nov 12, 2017
624b4fc
Add light documentation
Kane610 Nov 12, 2017
9af6a73
Improve description
Kane610 Nov 12, 2017
654e79d
Add information about HASS events from ZHASwitch buttonpresses
Kane610 Nov 12, 2017
bd016cf
Added description about how entity id naming works
Kane610 Nov 12, 2017
530358f
Added links to dresden elektronik, deconz and deconz rest api
Kane610 Nov 14, 2017
aa8f4f4
Changed description of how to generate API key
Kane610 Nov 17, 2017
849d5e5
Added information about configuration variables username and password
Kane610 Nov 17, 2017
6765855
Updated lists of verified devices
Kane610 Nov 17, 2017
4e65edc
Links from list of supported device to sub modules
Kane610 Nov 17, 2017
9fd66c2
Remove documentation for api_key_generation since functionality has b…
Kane610 Nov 17, 2017
65674ec
Add documentation for configure service
Kane610 Nov 19, 2017
396e0b1
Documentation for scenes
Kane610 Nov 19, 2017
4628e4a
Bumped HASS release version to 0.59
Kane610 Nov 19, 2017
6cd572a
Added Xiaomi Aqara Smart Wireless Switch to list of verified to work …
Kane610 Nov 19, 2017
1f207ec
Added improved automation example by simonporter007
Kane610 Nov 21, 2017
0b01111
Added information about deCONZ configurator
Kane610 Nov 21, 2017
6cabc52
Fix raw code
Kane610 Nov 21, 2017
0c09774
Added more lights to supported list
Kane610 Nov 22, 2017
e77e0ec
Make description about entity id same in all types
Kane610 Nov 25, 2017
2ea698b
Updated installation instructions
Kane610 Nov 25, 2017
d884646
Added Dresden Elektroniks logo
Kane610 Nov 25, 2017
b20fe26
Added Tseels verified to work devices
Kane610 Dec 15, 2017
a41cace
Bump ha_release string
Kane610 Dec 15, 2017
a115dbe
Added information about groups
Kane610 Dec 19, 2017
3f8c758
Link to information about switch not being an entity on main hub page
Kane610 Dec 19, 2017
857a7b8
Improved information about switches not being normal entities
Kane610 Dec 19, 2017
c66583e
It should be api_key not api-key
Kane610 Dec 19, 2017
a49c08a
Removed specifying deconz version
Kane610 Dec 19, 2017
27bcb20
Bump version to 0.61
Kane610 Dec 20, 2017
af6549e
Fix typos
Kane610 Dec 20, 2017
0728fdc
Use configuration tags to describe configuration parameters
Kane610 Dec 20, 2017
649db42
Fix martinhjelamares comments
Kane610 Jan 1, 2018
3e36599
Rename parameter service data attribute
Kane610 Jan 1, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions source/_components/deconz.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
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 Polling"
---

deCONZ by Dresden Elektronik is a software that communicates with Conbee/Raspbee Zigbee gateways and exposes Zigbee devices that are connected to the gateway.

deCONZ REST API verified from v2.04.86.

The minimum amount of configuration for deCONZ is the IP ADDRESS, if you don't have the API key. You can then generate an API key through the deCONZ service generate_api_key.

You must configure deCONZ by adding the following lines to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
deconz:
host: IP ADDRESS
```

Configuration variables:

## {% linkable_title Configuration variables %}
Copy link
Member

Choose a reason for hiding this comment

The 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:
https://home-assistant.io/developers/documentation/create_page/#configuration

Copy link
Member

Choose a reason for hiding this comment

The 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 configuration tags.


- **host** (*Required*): The IP address to your deCONZ server.
- **api-key** (*Optional*): The username to your Axis device. Default is 'root'.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left overs from the Axis component ;)

- **port** (*Optional*): Configure port deCONZ web server is accessible from. Default is 80.

Choose a reason for hiding this comment

The 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?

Copy link
Member Author

Choose a reason for hiding this comment

The 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: `generate_api_key`.

#### {% linkable_title Service `deconz/generate_api_key` %}
Copy link

Choose a reason for hiding this comment

The 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. Key will be stored in config file deconz.conf.

| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------|
| `username` | yes | Username to deCONZ. Default is `delight`. |
| `password` | yes | Password to deCONZ. Default is `delight`. |