-
-
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 1 commit
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,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 %} | ||
|
||
- **host** (*Required*): The IP address to your deCONZ server. | ||
- **api-key** (*Optional*): The username to your Axis device. Default is 'root'. | ||
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. Left overs from the Axis component ;) |
||
- **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: `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. 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`. | |
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.
Please use the configuration tags to display configuration variables. For more information see:
https://home-assistant.io/developers/documentation/create_page/#configuration
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.
This header is not needed. It will be defined automatically when using the
configuration
tags.