From 10248cd3debc27c685cbc1675a1f65780ef422e5 Mon Sep 17 00:00:00 2001 From: William Scanlon Date: Thu, 26 Jan 2017 10:36:25 -0500 Subject: [PATCH] Update wink doc (#1881) * Update wink doc * Fixed yaml --- .../alarm_control_panel.wink.markdown | 31 ++++++++++++++++ .../_components/binary_sensor.wink.markdown | 20 +++++++++- source/_components/climate.wink.markdown | 16 +++++++- source/_components/cover.wink.markdown | 16 +++++++- source/_components/fan.wink.markdown | 12 +++++- source/_components/light.wink.markdown | 15 +++++++- source/_components/lock.wink.markdown | 9 ++++- source/_components/sensor.wink.markdown | 16 +++++++- source/_components/switch.wink.markdown | 11 +++++- source/_components/wink.markdown | 37 +++++++++++++------ 10 files changed, 163 insertions(+), 20 deletions(-) create mode 100644 source/_components/alarm_control_panel.wink.markdown diff --git a/source/_components/alarm_control_panel.wink.markdown b/source/_components/alarm_control_panel.wink.markdown new file mode 100644 index 00000000000..f2ea46016e4 --- /dev/null +++ b/source/_components/alarm_control_panel.wink.markdown @@ -0,0 +1,31 @@ +--- +layout: page +title: "Wink Alarm" +description: "Instructions how to setup the Wink alarms within Home Assistant." +date: 2017-01-14 12:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: wink.png +ha_category: Alarm +ha_release: 0.37 +--- + +No Wink hub is required to support these devices. + + +The Wink alarm platform allows you to control your [Wink](http://www.wink.com/) Canary all-in-one security camera. + +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported devices + +- Canary all-in-one security camera + + +

+The above devices are confimed to work, but others may work as well. +

+ diff --git a/source/_components/binary_sensor.wink.markdown b/source/_components/binary_sensor.wink.markdown index f50296e4d4e..10e5833a4b2 100644 --- a/source/_components/binary_sensor.wink.markdown +++ b/source/_components/binary_sensor.wink.markdown @@ -16,5 +16,23 @@ ha_iot_class: "Cloud Polling" The Wink binary sensor platform allows you to get data from your [Wink](http://www.wink.com/) binary sensors. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported Binary sensor devices + +- Smoke and CO detectors (No Wink hub required for Nest) +- Window/Door sensors +- Motion sensors +- Ring Door bells (No hub required) +- Liquid presense sensors +- Z-wave lock key codes +- Lutron connected bulb remote buttons +- Wink Relay buttons and presense detection +- Wink spotter loudness and vibration (No Wink hub required) +- Wink hub devices connection status. This includes any paired hubs like Hue, Wink v1, Wink v2, Wink Relay... + +

+The above devices are confimed to work, but others may work as well. +

diff --git a/source/_components/climate.wink.markdown b/source/_components/climate.wink.markdown index 6b6a22c3b90..ae5634031f7 100644 --- a/source/_components/climate.wink.markdown +++ b/source/_components/climate.wink.markdown @@ -16,5 +16,19 @@ ha_iot_class: "Cloud Polling" The Wink climate platform allows you to get data from your [Wink](http://www.wink.com/) thermostats. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported climate devices: + +- Nest (No wink hub required) +- Ecobee (No wink hub required) +- Sensi (No wink hub required) +- Carrier (Unconfirmed) +- Honeywell (No wink hub required) +- Generic Z-Wave + +

+The above devices are confimed to work, but others may work as well. +

diff --git a/source/_components/cover.wink.markdown b/source/_components/cover.wink.markdown index dc4d53b5805..6be519c7558 100644 --- a/source/_components/cover.wink.markdown +++ b/source/_components/cover.wink.markdown @@ -18,4 +18,18 @@ The following quote is from Wink. > 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. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported cover devices + +- Bali window treatments +- Lutron shades +- Pella motorized blinds and shades +- GoControl garage door opener +- Chamberlain (Limited functionality) (No Wink hub required) + +

+The above devices are confimed to work, but others may work as well. +

+ diff --git a/source/_components/fan.wink.markdown b/source/_components/fan.wink.markdown index 66183bbebb3..b0b8e197d94 100644 --- a/source/_components/fan.wink.markdown +++ b/source/_components/fan.wink.markdown @@ -15,5 +15,15 @@ ha_release: 0.36 The Wink fan platform allows you to control your [Wink](http://www.wink.com/) fans. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported fan devices + +- Gardinier + + +

+The above devices are confimed to work, but others may work as well. +

diff --git a/source/_components/light.wink.markdown b/source/_components/light.wink.markdown index 16cbc2346a9..37d90d9846e 100644 --- a/source/_components/light.wink.markdown +++ b/source/_components/light.wink.markdown @@ -14,4 +14,17 @@ ha_category: Light The wink light platform allows you to use your [Wink](http://www.wink.com/) lights. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported light devices + +- Z-wave switches with dimming +- Hue +- Lightify +- GE link + +

+The above devices are confimed to work, but others may work as well. +

+ diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown index b12225d5b13..24dce87b856 100644 --- a/source/_components/lock.wink.markdown +++ b/source/_components/lock.wink.markdown @@ -15,5 +15,12 @@ ha_release: 0.9 The Wink lock platform allows you to control your [Wink](http://www.wink.com/) locks. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported lock devices + +- Kwikset +- Schlage +- Generic Z-wave diff --git a/source/_components/sensor.wink.markdown b/source/_components/sensor.wink.markdown index 1ff2c385c5f..b162dc1d2e4 100644 --- a/source/_components/sensor.wink.markdown +++ b/source/_components/sensor.wink.markdown @@ -14,5 +14,19 @@ ha_category: Sensor The Wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported sensor devices + +- Wink Relay temperature, proximity, and humidity +- Wink Spotter temperature, humidity, and brightness (No Wink hub required) +- Wink Porkfolio balance (No Wink hub required) +- Wink eggminder (No Wink hub required) +- Nest protect Smoke and CO severity (No confirmation that this is actually reported) (No Wink hub required) +- Motion sensor temperature + +

+The above devices are confimed to work, but others may work as well. +

diff --git a/source/_components/switch.wink.markdown b/source/_components/switch.wink.markdown index 7dcb6c37990..56dadcf37ed 100644 --- a/source/_components/switch.wink.markdown +++ b/source/_components/switch.wink.markdown @@ -14,5 +14,14 @@ ha_category: Switch The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches. -The requirement is that you have setup your [Wink hub](/components/wink/). +The requirement is that you have setup [Wink](/components/wink/). + + +### Supported switch devices + +- Wink Pivot power genius (No Wink hub required) +- non-dimming Z-wave in wall switches (dimming switches show up as lights) +- Wink Relay load controlling switches +- Rachio sprinkler controller (No Wink hub required) +- iHome smart plug (No Wink hub required) diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index 71a6e0c3ab0..6a9b528a71b 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -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. -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` -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.

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).