mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
81 lines
3.0 KiB
Markdown
81 lines
3.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Wink"
|
|
description: "Instructions how to setup the Wink hub within Home Assistant."
|
|
date: 2015-01-20 22:36
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: wink.png
|
|
ha_category: Hub
|
|
featured: true
|
|
---
|
|
|
|
[Wink](http://www.wink.com/) is a home automation hub that can control a whole wide range of devices on the market. Or, as they say in their own words:
|
|
|
|
<blockquote>
|
|
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 with the Wink API and allows you to get the status and control connected switches, lights, locks, fan, climate devices, covers, and sensors.
|
|
|
|
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>
|
|
|
|
```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.
|
|
|
|
```yaml
|
|
wink:
|
|
email: YOUR_WINK_EMAIL_ADDRESS
|
|
password: YOUR_WINK_PASSWORD
|
|
client_id: YOUR_WINK_CLIENT_ID
|
|
client_secret: YOUR_WINK_CLIENT_SECRET
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **access_token** (*Required if the below aren't present.*): The retrieved access token.
|
|
- **email** (*Required if access token isn't provided*): Your Wink login email.
|
|
- **password** (*Required if access token isn't provided*): Your Wink login password.
|
|
- **client_id** (*Required if access token isn't provided*): Your provided Wink client_id.
|
|
- **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 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).
|
|
</p>
|