Skip to content

Commit 10248cd

Browse files
William Scanlonfabaff
William Scanlon
authored andcommitted
Update wink doc (home-assistant#1881)
* Update wink doc * Fixed yaml
1 parent 834fdca commit 10248cd

10 files changed

+162
-19
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: page
3+
title: "Wink Alarm"
4+
description: "Instructions how to setup the Wink alarms within Home Assistant."
5+
date: 2017-01-14 12:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: wink.png
11+
ha_category: Alarm
12+
ha_release: 0.37
13+
---
14+
15+
No Wink hub is required to support these devices.
16+
17+
18+
The Wink alarm platform allows you to control your [Wink](http://www.wink.com/) Canary all-in-one security camera.
19+
20+
The requirement is that you have setup [Wink](/components/wink/).
21+
22+
23+
### Supported devices
24+
25+
- Canary all-in-one security camera
26+
27+
28+
<p class='note'>
29+
The above devices are confimed to work, but others may work as well.
30+
</p>
31+

source/_components/binary_sensor.wink.markdown

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,23 @@ ha_iot_class: "Cloud Polling"
1616

1717
The Wink binary sensor platform allows you to get data from your [Wink](http://www.wink.com/) binary sensors.
1818

19-
The requirement is that you have setup your [Wink hub](/components/wink/).
19+
The requirement is that you have setup [Wink](/components/wink/).
20+
21+
22+
### Supported Binary sensor devices
23+
24+
- Smoke and CO detectors (No Wink hub required for Nest)
25+
- Window/Door sensors
26+
- Motion sensors
27+
- Ring Door bells (No hub required)
28+
- Liquid presense sensors
29+
- Z-wave lock key codes
30+
- Lutron connected bulb remote buttons
31+
- Wink Relay buttons and presense detection
32+
- Wink spotter loudness and vibration (No Wink hub required)
33+
- Wink hub devices connection status. This includes any paired hubs like Hue, Wink v1, Wink v2, Wink Relay...
34+
35+
<p class='note'>
36+
The above devices are confimed to work, but others may work as well.
37+
</p>
2038

source/_components/climate.wink.markdown

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,19 @@ ha_iot_class: "Cloud Polling"
1616

1717
The Wink climate platform allows you to get data from your [Wink](http://www.wink.com/) thermostats.
1818

19-
The requirement is that you have setup your [Wink hub](/components/wink/).
19+
The requirement is that you have setup [Wink](/components/wink/).
20+
21+
22+
### Supported climate devices:
23+
24+
- Nest (No wink hub required)
25+
- Ecobee (No wink hub required)
26+
- Sensi (No wink hub required)
27+
- Carrier (Unconfirmed)
28+
- Honeywell (No wink hub required)
29+
- Generic Z-Wave
30+
31+
<p class='note'>
32+
The above devices are confimed to work, but others may work as well.
33+
</p>
2034

source/_components/cover.wink.markdown

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,18 @@ The following quote is from Wink.
1818

1919
> As part of our agreement with Chamberlain, third-party access to control Chamberlain garage doors has been restricted. Please contact Chamberlain directly to inquire about permissions.
2020
21-
The requirement is that you have setup your [Wink hub](/components/wink/).
21+
The requirement is that you have setup [Wink](/components/wink/).
22+
23+
24+
### Supported cover devices
25+
26+
- Bali window treatments
27+
- Lutron shades
28+
- Pella motorized blinds and shades
29+
- GoControl garage door opener
30+
- Chamberlain (Limited functionality) (No Wink hub required)
31+
32+
<p class='note'>
33+
The above devices are confimed to work, but others may work as well.
34+
</p>
35+

source/_components/fan.wink.markdown

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,15 @@ ha_release: 0.36
1515

1616
The Wink fan platform allows you to control your [Wink](http://www.wink.com/) fans.
1717

18-
The requirement is that you have setup your [Wink hub](/components/wink/).
18+
The requirement is that you have setup [Wink](/components/wink/).
19+
20+
21+
### Supported fan devices
22+
23+
- Gardinier
24+
25+
26+
<p class='note'>
27+
The above devices are confimed to work, but others may work as well.
28+
</p>
1929

source/_components/light.wink.markdown

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,17 @@ ha_category: Light
1414

1515
The wink light platform allows you to use your [Wink](http://www.wink.com/) lights.
1616

17-
The requirement is that you have setup your [Wink hub](/components/wink/).
17+
The requirement is that you have setup [Wink](/components/wink/).
18+
19+
20+
### Supported light devices
21+
22+
- Z-wave switches with dimming
23+
- Hue
24+
- Lightify
25+
- GE link
26+
27+
<p class='note'>
28+
The above devices are confimed to work, but others may work as well.
29+
</p>
30+

source/_components/lock.wink.markdown

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,12 @@ ha_release: 0.9
1515

1616
The Wink lock platform allows you to control your [Wink](http://www.wink.com/) locks.
1717

18-
The requirement is that you have setup your [Wink hub](/components/wink/).
18+
The requirement is that you have setup [Wink](/components/wink/).
19+
20+
21+
### Supported lock devices
22+
23+
- Kwikset
24+
- Schlage
25+
- Generic Z-wave
1926

source/_components/sensor.wink.markdown

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,19 @@ ha_category: Sensor
1414

1515
The Wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors.
1616

17-
The requirement is that you have setup your [Wink hub](/components/wink/).
17+
The requirement is that you have setup [Wink](/components/wink/).
18+
19+
20+
### Supported sensor devices
21+
22+
- Wink Relay temperature, proximity, and humidity
23+
- Wink Spotter temperature, humidity, and brightness (No Wink hub required)
24+
- Wink Porkfolio balance (No Wink hub required)
25+
- Wink eggminder (No Wink hub required)
26+
- Nest protect Smoke and CO severity (No confirmation that this is actually reported) (No Wink hub required)
27+
- Motion sensor temperature
28+
29+
<p class='note'>
30+
The above devices are confimed to work, but others may work as well.
31+
</p>
1832

source/_components/switch.wink.markdown

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,14 @@ ha_category: Switch
1414

1515
The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.
1616

17-
The requirement is that you have setup your [Wink hub](/components/wink/).
17+
The requirement is that you have setup [Wink](/components/wink/).
18+
19+
20+
### Supported switch devices
21+
22+
- Wink Pivot power genius (No Wink hub required)
23+
- non-dimming Z-wave in wall switches (dimming switches show up as lights)
24+
- Wink Relay load controlling switches
25+
- Rachio sprinkler controller (No Wink hub required)
26+
- iHome smart plug (No Wink hub required)
1827

source/_components/wink.markdown

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,37 +18,50 @@ featured: true
1818
Wink offers one, quick and simple way to connect people with the products they rely on every day in their home.
1919
</blockquote>
2020

21-
Home Assistant integrates the Wink hub and allows you to get the status and control connected switches, lights, locks, and sensors.
21+
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.
2222

23-
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.
23+
Check the related componets pages for actual devices that are support.
24+
25+
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
26+
27+
### Authentication with an access token.
28+
29+
30+
To use this form of authentication obtain a token from the form below and insert it into your `configuration.yaml`
2431

2532
<iframe src="https://winkbearertoken.appspot.com"
2633
style='width: 100%; height: 200px; border: 0; margin: 0 auto 15px; border-left: 2px solid #049cdb; padding-left: 15px;'></iframe>
2734

28-
After you have gotten your access token, add the following to your `configuration.yaml`:
29-
3035
```yaml
3136
wink:
3237
access_token: YOUR_ACCESS_TOKEN
3338
```
3439
35-
You can also request API access via Wink's [contact us](http://www.wink.com/help/contact/) page.
40+
### Authentication with your Wink email and password.
3641
37-
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.
42+
43+
This method uses the same form from above to obtain an access token, but does so without the user needing to manually do so.
44+
This method pulls a new token on every startup of Home Assistant.
3845
3946
```yaml
4047
wink:
4148
email: YOUR_WINK_EMAIL_ADDRESS
4249
password: YOUR_WINK_PASSWORD
43-
client_id: YOUR_WINK_CLIENT_ID
44-
client_secret: YOUR_WINK_CLIENT_SECRET
4550
```
4651
47-
The following can also be provided to allow access to the Wink Relay sensors. This value could change at any time.
52+
### Full oath authentication. (This is the best option!)
53+
54+
55+
You can also request API access via Wink's [contact us](http://www.wink.com/help/contact/) page.
56+
57+
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.
4858
4959
```yaml
5060
wink:
51-
user_agent: Manufacturer/Home-Assistant WinkAndroid/4
61+
email: YOUR_WINK_EMAIL_ADDRESS
62+
password: YOUR_WINK_PASSWORD
63+
client_id: YOUR_WINK_CLIENT_ID
64+
client_secret: YOUR_WINK_CLIENT_SECRET
5265
```
5366
5467
Configuration variables:
@@ -60,7 +73,7 @@ Configuration variables:
6073
- **client_secret** (*Required if access token isn't provided*): Your provided Wink client_secret.
6174
- **user_agent** (*Optional*): The user-agent passed in the API calls to Wink.
6275
63-
This will connect to the Wink hub and automatically set up any lights, switches and sensors that it finds.
76+
This will connect to the Wink API and automatically set up any switches, lights, locks, fans, climate devices, covers, and sensors.
6477
6578
<p class='note'>
6679
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).

0 commit comments

Comments
 (0)