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

Update Wink component configuration variable (#6723)

Browse Source 
* Update Wink component configuration variable

* Minor changes
This commit is contained in:
Klaas Schoute 2018-10-13 13:23:14 +02:00 committed by Fabian Affolter
parent 11808dee04
commit aa8b39736e
1 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_components/wink.markdown
View File

@ -44,11 +44,10 @@ When using the configurator make sure the initial setup is performed on the same
wink: wink:
``` ```
### {% linkable_title Full oauth authentication (legacy). %} ### {% linkable_title Full oauth authentication (legacy) %}
This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existence. This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existence.
```yaml ```yaml
wink: wink:
email: YOUR_WINK_EMAIL_ADDRESS email: YOUR_WINK_EMAIL_ADDRESS
@ -57,23 +56,38 @@ wink:
client_secret: YOUR_WINK_CLIENT_SECRET client_secret: YOUR_WINK_CLIENT_SECRET
``` ```
Configuration variables: Please pay attention that the required entries are only needed for legacy OAuth access.
- **email** (*Required for legacy OAuth*): Your Wink login email. {% configuration %}
- **password** (*Required for legacy OAuth*): Your Wink login password. email:
- **client_id** (*Required for legacy OAuth*): Your provided Wink client_id. description: Your Wink login email address.
- **client_secret** (*Required for legacy OAuth*): Your provided Wink client_secret. required: true
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issued to the local hub. type: string
password:
description: Your Wink login password.
required: true
type: string
client_id:
description: Your provided Wink `client_id`.
required: true
type: string
client_secret:
description: Your provided Wink `client_secret`.
required: true
type: string
local_control:
description: If set to `true` state changes for lights, locks and switches will be issued to the local hub.
required: false
default: false
type: boolean
{% endconfiguration %}
Local control: Local control:
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `False`.
- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `false`.
- Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage. - Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage.
- Local control is also only available for the Wink hub v1 and v2, not the Wink relay. - Local control is also only available for the Wink hub v1 and v2, not the Wink relay.
- Local control isn't used during start-up of Home Assistant; this means initial setup requires an active internet connection. - Local control isn't used during start-up of Home Assistant; this means initial setup requires an active internet connection.
- Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online. - Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.
<p class='note'> <p class='note'>