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

Site updated at 2017-08-24 06:43:59 UTC

Browse source
This commit is contained in:
Travis CI 2017-08-24 06:43:59 +00:00
parent 337e2f0247
commit 270647e144
43 changed files with 94 additions and 94 deletions
Download patch file Download diff file Expand all files Collapse all files

28
components/wink/index.html
View file

@ -79,10 +79,10 @@
<p>Wink offers one, quick and simple way to connect people with the products they rely on every day in their home.</p>
</blockquote>
<p>Home Assistant integrates with the Wink API and automatically sets up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.</p>
<p>Check the related components pages for actual devices that are support.</p>
<p>Check the related components pages for actual devices that are supported.</p>
<p>Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.</p>
<h3>Authenticate using <a href="https://developer.wink.com">developer.wink.com</a></h3>
<p>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.</p>
<p>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.</p>
<p>This form of authentication doesn’t require any settings in the configuration.yaml other than <code class="highlighter-rouge">wink:</code> this is because you will be guided through setup via the configurator on the frontend.</p>
<p class="note">
When using the configurator make sure the initial setup is performed on the same local network as the Home Assistant server, if not from the same box Home Assistant is running on. This will allow for authentication redirects to happen correctly.
@ -108,16 +108,16 @@ When using the configurator make sure the initial setup is performed on the same
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>email</strong> (<em>Required for email/password auth or legacy oauth</em>): Your Wink login email.</li>
<li><strong>password</strong> (<em>Required for email/password auth or legacy oauth</em>): Your Wink login password.</li>
<li><strong>client_id</strong> (<em>Required for legacy oauth</em>): Your provided Wink client_id.</li>
<li><strong>client_secret</strong> (<em>Required for legacy oauth</em>): Your provided Wink client_secret.</li>
<li><strong>local_control</strong> (<em>Optional</em>): If set to <code class="highlighter-rouge">True</code> state changes for lights, locks, and switches will be issue to the local hub.</li>
<li><strong>email</strong> (<em>Required for email/password auth or legacy OAuth</em>): Your Wink login email.</li>
<li><strong>password</strong> (<em>Required for email/password auth or legacy OAuth</em>): Your Wink login password.</li>
<li><strong>client_id</strong> (<em>Required for legacy OAuth</em>): Your provided Wink client_id.</li>
<li><strong>client_secret</strong> (<em>Required for legacy OAuth</em>): Your provided Wink client_secret.</li>
<li><strong>local_control</strong> (<em>Optional</em>): If set to <code class="highlighter-rouge">True</code> state changes for lights, locks, and switches will be an issue to the local hub.</li>
</ul>
<p>Local control:</p>
<ul>
<li>
<p>Wink’s local control API isn’t officially documented and therefore could be broken by a hub update. For these reasons <code class="highlighter-rouge">local_control</code> defaults to <code class="highlighter-rouge">False</code></p>
<p>Wink’s local control API isn’t officially documented and therefore could be broken by a hub update. For these reasons <code class="highlighter-rouge">local_control</code> defaults to <code class="highlighter-rouge">False</code>.</p>
</li>
<li>
<p>Using local control doesn’t appear to make commands any quicker, but does function in an internet/Wink outage.</p>
@ -126,26 +126,26 @@ When using the configurator make sure the initial setup is performed on the same
<p>Local control is also only available for the Wink hub v1 and v2, not the Wink relay.</p>
</li>
<li>
<p>Local control isn’t used during startup of Home Assistant, this means initial setup requires an active internet connection.</p>
<p>Local control isn’t used during start-up of Home Assistant; this means initial setup requires an active internet connection.</p>
</li>
<li>
<p>Local control requests are first sent to the controlling hub. In the event that a request fails, that request will attempt to go online.</p>
<p>Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.</p>
</li>
</ul>
<p class="note">
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.
The following error will be logged in the event that the hub is rejecting local requests.
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.
The following error will be logged if the hub is rejecting local requests.
<code class="highlighter-rouge">
Error sending local control request. Sending request online
</code>
</p>
<h3><a class="title-link" name="service-refresh_state_from_wink" href="#service-refresh_state_from_wink"></a> Service <code class="highlighter-rouge">refresh_state_from_wink</code></h3>
<p>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.</p>
<p>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 where an update isn’t pushed device states can be out of sync.</p>
<p>You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If <code class="highlighter-rouge">local_control</code> is set to <code class="highlighter-rouge">True</code> states will be pulled from the devices controlling hub, not the online API.</p>
<h3><a class="title-link" name="service-add_new_devices" href="#service-add_new_devices"></a> Service <code class="highlighter-rouge">add_new_devices</code></h3>
<p>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.</p>
<p class="note">
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).
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).
</p>
</article>
</div>