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

Merge remote-tracking branch 'origin/current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2017-07-31 18:31:30 -07:00
commit 720ea957af
15 changed files with 189 additions and 260 deletions
Download patch file Download diff file Expand all files Collapse all files

11
source/_components/cover.markdown
View file

@ -11,11 +11,12 @@ footer: true
Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors.
The display style of each entity can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for covers:
- **None**: Generic cover device
- **window**: Window controller
- **garage**: Garage door controller
The display style of each entity can be modified in the [customize section](/getting-started/customizing-devices/). Besides the basic ones like `friendly_name` or `hidden`, the following attributes are supported for covers:
| Attribute | Default | Description |
| --------- | ------- | ----------- |
| `device_class` | | `none` Generic cover device<br>`window` Window controller<br>`garage` Garage door controller
| `assumed_state` | `false` | If set to `true`, cover buttons will always be enabled
## {% linkable_title Services %}

4
source/_components/fan.wink.markdown
View file

@ -21,10 +21,12 @@ The requirement is that you have setup [Wink](/components/wink/).
### {% linkable_title Supported fan devices %}
- Gardinier
- Home Decorator Wink-enabled Gardinier ceiling fan
- Hampton Bay ceiling fan module
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

2
source/_components/light.wink.markdown
View file

@ -25,8 +25,10 @@ The requirement is that you have setup [Wink](/components/wink/).
- Hue
- Lightify
- GE link
- Wink light groups (User created groups of lights)
<p class='note'>
The above devices are confimed to work, but others may work as well.
</p>

6
source/_components/sensor.google_wifi.markdown
View file

@ -30,11 +30,11 @@ Configuration variables:
- **host** (*Optional*): The address to retreive status from the router. Defaults to `testwifi.here` (other options include `onhub.here` and your router's IP such as `192.168.86.1`).
- **name** (*Optional*): Name to give the Google Wifi sensor. Defaults to `google_wifi`.
- **monitored_conditions** (*Optional*): Defines the data to monitor as sensors. Defaults to all of the listed options below.
- **monitored_conditions** array (*Optional*): Defines the data to monitor as sensors. Defaults to all of the listed options below.
- **current_version**: Current firmware version of the router.
- **new_version**: Latest availiable firmware version. If router is up-to-date, this value defaults to `Latest`.
- **new_version**: Latest availiable firmware version. If router is up-to-date, this value defaults to `Latest`.
- **uptime**: Days since router has been turned on.
- **last_restart**: Date of last restart. Format is `YYYY-MM-DD HH:mm:SS`.
- **last_restart**: Date of last restart. Format is `YYYY-MM-DD HH:mm:SS`.
- **local_ip**: Local public IP address.
- **status**: Reports whether the router is or is not connected to the internet.

2
source/_components/switch.wink.markdown
View file

@ -26,4 +26,6 @@ The requirement is that you have setup [Wink](/components/wink/).
- Wink Relay load controlling switches
- Rachio sprinkler controller (No Wink hub required)
- iHome smart plug (No Wink hub required)
- Wink switch groups (User created groups of switches)

4
source/_components/telegram_bot.webhooks.markdown
View file

@ -36,7 +36,7 @@ telegram_bot:
Configuration variables:
- **allowed_chat_ids** (*Required*): A list of user in the `user_id` Telegram format enabled to interact to webhook
- **allowed_chat_ids** (*Required*): A list of ids representing the users and group chats that are authorised to interact with the webhook.
- **api_key** (*Required*): The API token of your bot.
- **trusted_networks** (*Optional*): Telegram server access ACL as list. Defaults to `149.154.167.197-233`.
- **parse_mode** (*Optional*): Default parser for messages if not explicit in message data: 'html' or 'markdown'. Default is 'markdown'.
@ -44,7 +44,7 @@ Configuration variables:
- **proxy_params** (*Optional*): Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
- **url** (*Optional*): Allow to overwrite the `base_url` from http component for diferent configs.
To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram) .
To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorising the chat, if you have added your bot to a group you will also need to authorise any user that will be interacting with the webhook. When an unauthorised user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the the users id by looking in the "from" section of this error message.
Full configuration sample:

42
source/_components/wink.markdown
View file

@ -20,16 +20,16 @@ ha_release: pre 0.7
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.
Home Assistant integrates with the Wink API and automatically sets up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
Check the related componets pages for actual devices that are support.
Check the related components pages for actual devices that are support.
Home Assistant offers multiple ways to authenticate to the Wink API. Each authentication method is described below.
### Authenticate using [developer.wink.com](https://developer.wink.com)
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.
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.
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.
@ -68,23 +68,45 @@ wink:
Configuration variables:
- **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.
- **email** (*Required for email/password auth or legacy oauth*): Your Wink login email.
- **password** (*Required for email/password auth or legacy oauth*): Your Wink login password.
- **client_id** (*Required for legacy oauth*): Your provided Wink client_id.
- **client_secret** (*Required for legacy oauth*): Your provided Wink client_secret.
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issue to the local hub.
This will connect to the Wink API and automatically set up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
Local control:
- 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`
- Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage.
- Local control is also only available for the Wink hub v1 and v2, not the Wink relay.
- Local control isn't used during startup of Home Assistant, this means initial setup requires an active internet connection.
- 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 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.
```
Error sending local control request. Sending request online
```
</p>
### {% linkable_title Service `refresh_state_from_wink` %}
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.
You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices.
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.
### {% linkable_title Service `add_new_devices` %}
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 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).
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>