jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update wink doc (#1881)

Browse source 
* Update wink doc

* Fixed yaml
This commit is contained in:
William Scanlon 2017-01-26 10:36:25 -05:00 • committed by Fabian Affolter
parent 834fdca7bc
commit 10248cd3de
10 changed files with 163 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

37
source/_components/wink.markdown
View file

@ -18,20 +18,40 @@ featured: true
Wink offers one, quick and simple way to connect people with the products they rely on every day in their home.
</blockquote>
Home Assistant integrates the Wink hub and allows you to get the status and control connected switches, lights, locks, and sensors.
Home Assistant integrates with the Wink API and allows you to get the status and control connected switches, lights, locks, fan, climate devices, covers, and sensors.
To get started with the Wink API, you will first need to get yourself an API access token. Because it is very difficult right now to get access to their API, John McLaughlin has created the form below to get you one.
Check the related componets pages for actual devices that are support.
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
### Authentication with an access token.
To use this form of authentication obtain a token from the form below and insert it into your `configuration.yaml`
<iframe src="https://winkbearertoken.appspot.com"
style='width: 100%; height: 200px; border: 0; margin: 0 auto 15px; border-left: 2px solid #049cdb; padding-left: 15px;'></iframe>
After you have gotten your access token, add the following to your `configuration.yaml`:
```yaml
wink:
access_token: YOUR_ACCESS_TOKEN
```
### Authentication with your Wink email and password.
This method uses the same form from above to obtain an access token, but does so without the user needing to manually do so.
This method pulls a new token on every startup of Home Assistant.
```yaml
wink:
email: YOUR_WINK_EMAIL_ADDRESS
password: YOUR_WINK_PASSWORD
```
### Full oath authentication. (This is the best option!)
You can also request API access via Wink's [contact us](http://www.wink.com/help/contact/) page.
You will be provided with a client ID and a client secret via email. These can then be used in your configuration in place of the access_token this will prevent you from having to manually refresh your access token.
@ -44,13 +64,6 @@ wink:
client_secret: YOUR_WINK_CLIENT_SECRET
```
The following can also be provided to allow access to the Wink Relay sensors. This value could change at any time.
```yaml
wink:
user_agent: Manufacturer/Home-Assistant WinkAndroid/4
```
Configuration variables:
- **access_token** (*Required if the below aren't present.*): The retrieved access token.
@ -60,7 +73,7 @@ Configuration variables:
- **client_secret** (*Required if access token isn't provided*): Your provided Wink client_secret.
- **user_agent** (*Optional*): The user-agent passed in the API calls to Wink.
This will connect to the Wink hub and automatically set up any lights, switches and sensors that it finds.
This will connect to the Wink API and automatically set up any switches, lights, locks, fans, climate devices, covers, and sensors.
<p class='note'>
The Wink hub can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling and updating devices (~3s).