jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document Avion's ability to obtain configuration automatically (#2766)

Browse Source 
The Avion upstream code now has support for pulling switch information from
the central server directly. Document that.
This commit is contained in:
Matthew Garrett 2017-07-17 10:08:10 -07:00 committed by Fredrik Lindqvist
parent 1a18543c35
commit 7abc205582
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
source/_components/light.avion.markdown
View File

@ -21,21 +21,32 @@ To enable these lights, add the following lines to your `configuration.yaml` fil
# Example configuration.yaml entry # Example configuration.yaml entry
light: light:
- platform: avion - platform: avion
devices: username: testuser@fakedomain.com
00:21:4D:00:00:01: password: foobar
name: Light 1
api_key: Gr35a/rt3RgaRenl9ag8Ba==
00:21:3D:20:00:a1:
name: Bulb 2
api_key: Gr35a/rt3RgaRenl9ag8Ba==
``` ```
Configuration variables: Configuration variables:
- **devices**: A 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: - **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 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 passphrase field of the output should be used as the API key in the configuration. with the email and password fields replaced with those used when registering the device via the mobile app. The passphrase field of the output should be used as the API key in the configuration.
If username and password are not supplied, devices must be configured manually like so:
```yaml
# Manual device configuration.yaml entry
light:
- platform: avion
devices:
00:21:4D:00:00:01:
name: Light 1
api_key: Gr35a/rt3RgaRenl9ag8Ba==
00:21:3D:20:00:a1:
name: Light 2
api_key: Gr35a/rt3RgaRenl9ag8Ba==
```