You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/wink.markdown
+32-10Lines changed: 32 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -20,16 +20,16 @@ ha_release: pre 0.7
20
20
Wink offers one, quick and simple way to connect people with the products they rely on every day in their home.
21
21
</blockquote>
22
22
23
-
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.
23
+
Home Assistant integrates with the Wink API and automatically sets up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
24
24
25
-
Check the related componets pages for actual devices that are support.
25
+
Check the related components pages for actual devices that are support.
26
26
27
27
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
28
28
29
29
### Authenticate using [developer.wink.com](https://developer.wink.com)
30
30
31
31
32
-
This method will require you to setup a developer account with Wink. This process can take a few days to get approved, but is the recommanded form of authentication. If you would like to use Wink in Home Assistant while you wait, you can use the email and password authentication below.
32
+
This method will require you to setup a developer account with Wink. This process can take a few days to get approved, but is the recommended form of authentication. If you would like to use Wink in Home Assistant while you wait, you can use the email and password authentication below.
33
33
34
34
This form of authentication doesn't require any settings in the configuration.yaml other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
35
35
@@ -68,23 +68,45 @@ wink:
68
68
69
69
Configuration variables:
70
70
71
-
- **email** (*Required if access token isn't provided*): Your Wink login email.
72
-
- **password** (*Required if access token isn't provided*): Your Wink login password.
73
-
- **client_id** (*Required if access token isn't provided*): Your provided Wink client_id.
74
-
- **client_secret** (*Required if access token isn't provided*): Your provided Wink client_secret.
71
+
- **email** (*Required for email/password auth or legacy oauth*): Your Wink login email.
72
+
- **password** (*Required for email/password auth or legacy oauth*): Your Wink login password.
73
+
- **client_id** (*Required for legacy oauth*): Your provided Wink client_id.
74
+
- **client_secret** (*Required for legacy oauth*): Your provided Wink client_secret.
75
+
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issue to the local hub.
75
76
76
-
This will connect to the Wink API and automatically set up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
77
+
Local control:
78
+
- 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`
79
+
80
+
- Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage.
81
+
82
+
- Local control is also only available for the Wink hub v1 and v2, not the Wink relay.
83
+
84
+
- Local control isn't used during startup of Home Assistant, this means initial setup requires an active internet connection.
85
+
86
+
- Local control requests are first sent to the controlling hub. In the event that a request fails, that request will attempt to go online.
87
+
88
+
<p class='note'>
89
+
It is possible for the hub to get into a bad state where it stops accepting local control request. If this happens you will notice requests taking significantly longer as they are redirected online. This doesn't happen often, but when it does, it appears to be resolved by rebooting the hub.
90
+
91
+
The following error will be logged in the event that the hub is rejecting local requests.
92
+
93
+
```
94
+
Error sending local control request. Sending request online
95
+
```
96
+
97
+
</p>
77
98
78
99
### {% linkable_title Service `refresh_state_from_wink` %}
79
100
80
101
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions were an update isn't pushed device states can be out of sync.
81
102
82
-
You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices.
103
+
You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `True` states will be pulled from the devices controlling hub, not the online API.
83
104
84
105
### {% linkable_title Service `add_new_devices` %}
85
106
86
107
You can use the service wink/add_new_devices to pull any newly paired Wink devices to an already running instance of Home-Assistant. Any new devices will also be added if Home-Assistant is restarted.
87
108
88
109
<p class='note'>
89
-
The Wink hubcan 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).
110
+
The Wink hub, by default 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