Update Avion light component configuration (#7094)

* Update Avion light component configuration

* Minor fixes

* Minor changes
This commit is contained in:
Klaas Schoute 2018-10-26 11:03:00 +02:00 committed by Fabian Affolter
parent 594798a2ed
commit aac5cce273

View File

@ -15,6 +15,20 @@ ha_release: 0.37
Support for the Avi-on Bluetooth dimmer switch [Avi-On](http://avi-on.com/).
## {% linkable_title Setup %}
If you want to add your devices manually (like in the example below) then you need to get the API key. The API key can be obtained by executing the following command:
```bash
$ curl -X POST -H "Content-Type: application/json" \
-d '{"email": "fakename@example.com", "password": "password"}' \
https://admin.avi-on.com/api/sessions | jq
```
with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration.
## {% linkable_title Configuration %}
To enable these lights, add the following lines to your `configuration.yaml` file:
```yaml
@ -23,16 +37,31 @@ light:
- platform: avion
```
Configuration variables:
{% configuration %}
username:
description: The username used in the Avion app. If username and password are both provided, all associated switches will automatically be added to your configuration.
required: false
type: string
password:
description: The password used in the Avion app.
required: false
type: string
devices:
description: An optional list of devices with their Bluetooth addresses.
required: false
type: list
keys:
name:
description: A custom name to use in the frontend.
required: false
type: string
api_key:
description: The API Key.
required: true
type: string
{% endconfiguration %}
- **username** (*Optional*): The username used in the Avion app. If username and password are both provided, any associated switches will automatically be added to your configuration.
- **password** (*Optional*): The password used in the Avion app.
- **devices** (*Optional*): An optional list of devices with their Bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command:
```
curl -X POST -H "Content-Type: application/json" -d '{"email": "fakename@example.com", "password": "password"}' https://admin.avi-on.com/api/sessions | jq
```
with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration.
## {% linkable_title Full example %}
If username and password are not supplied, devices must be configured manually like so: