Merge branch 'current' into next
This commit is contained in:
Paulus Schoutsen
commit
2581fb1bcd
71 changed files with 994 additions and 485 deletions
|
|
@ -11,7 +11,6 @@ logo: apple.png
|
|||
ha_category: Hub
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: 0.49
|
||||
featured: true
|
||||
---
|
||||
|
||||
The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g. arrow keys.
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ binary_sensor:
|
|||
prob_given_true: 0.5
|
||||
platform: 'state'
|
||||
to_state: 'on'
|
||||
- entity_id: 'sensor.sun'
|
||||
- entity_id: 'sun.sun'
|
||||
prob_given_true: 0.7
|
||||
platform: 'state'
|
||||
to_state: 'below_horizon'
|
||||
|
|
|
|||
|
|
@ -18,43 +18,49 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary
|
|||
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: knx
|
||||
name: "Entrance.Motion.Sensor"
|
||||
address: '6/0/2'
|
||||
device_class: 'motion'
|
||||
#significant_bit: 2
|
||||
- platform: knx
|
||||
name: "Entrance.Motion.Sensor"
|
||||
address: '6/0/2'
|
||||
device_class: 'motion'
|
||||
#significant_bit: 2
|
||||
```
|
||||
|
||||
* **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
* **address**: KNX group address of the binary sensor
|
||||
* **device_class**: (Optional) HASS device class e.g. "motion"
|
||||
* **significant_bit**: (Optional) Specify which significant bit of the KNX value should be used. Default is 1.
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **address**: KNX group address of the binary sensor.
|
||||
- **device_class** (Optional): HASS device class e.g. "motion".
|
||||
- **significant_bit** (Optional): Specify which significant bit of the KNX value should be used. Default is 1.
|
||||
|
||||
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: knx
|
||||
name: Livingroom.3Switch3
|
||||
address: '5/0/26'
|
||||
automation:
|
||||
- counter: 1
|
||||
hook: 'on'
|
||||
action:
|
||||
- entity_id: light.hue_color_lamp_1
|
||||
service: homeassistant.turn_on
|
||||
- counter: 2
|
||||
hook: 'on'
|
||||
action:
|
||||
- entity_id: light.hue_bloom_1
|
||||
service: homeassistant.turn_on
|
||||
- entity_id: light.hue_bloom_2
|
||||
service: homeassistant.turn_on
|
||||
- platform: knx
|
||||
name: Livingroom.3Switch3
|
||||
address: '5/0/26'
|
||||
automation:
|
||||
- counter: 1
|
||||
hook: 'on'
|
||||
action:
|
||||
- entity_id: light.hue_color_lamp_1
|
||||
service: homeassistant.turn_on
|
||||
- counter: 2
|
||||
hook: 'on'
|
||||
action:
|
||||
- entity_id: light.hue_bloom_1
|
||||
service: homeassistant.turn_on
|
||||
- entity_id: light.hue_bloom_2
|
||||
service: homeassistant.turn_on
|
||||
```
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **counter**: (*Optional*) Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
|
||||
- **hook**: (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: "on" or "off". Defaults to "on".
|
||||
- **action**: Specify a list of actions analog to the [HASS automation rules](https://home-assistant.io/docs/automation/action/).
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **counter** (*Optional*): Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
|
||||
- **hook** (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: "on" or "off". Defaults to "on".
|
||||
- **action**: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
|
||||
|
||||
|
|
|
|||
|
|
@ -9,9 +9,7 @@ sharing: true
|
|||
footer: true
|
||||
---
|
||||
|
||||
Binary sensors gather information about state of switches, contacts, pins, and alike. The return value of those sensors is usually digital (1/0). This means that those sensors knows only two states: **0/off/low/closed/false** and **1/on/high/open/true**.
|
||||
|
||||
Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.
|
||||
Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.
|
||||
|
||||
The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors:
|
||||
|
||||
|
|
|
|||
33
source/_components/climate.ephember.markdown
Normal file
33
source/_components/climate.ephember.markdown
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
layout: page
|
||||
title: "EPH Controls Ember Thermostat"
|
||||
description: "Instructions on how to integrate EPH Controls Ember thermostats within Home Assistant."
|
||||
date: 2017-10-07 12:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ephcontrolsember.png
|
||||
ha_category: Climate
|
||||
ha_release: "0.55"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `ephember` climate platform lets you control [EPH Controls](http://emberapp.ephcontrols.com/) thermostats. The module only works if you have a WiFi gateway to control your EPH system and an account on the ember app.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
climate:
|
||||
- platform: ephember
|
||||
username: YOUR_EMAIL
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
A single interface can handle up to 32 connected devices.
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The email address you used to sign up to the ember app
|
||||
- **password** (*Required*): The password you used to sign up to the ember app
|
||||
|
|
@ -21,6 +21,7 @@ The `knx` component must be configured correctly, see [KNX Component](/component
|
|||
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
climate:
|
||||
- platform: knx
|
||||
name: HASS-Kitchen.Temperature
|
||||
|
|
@ -33,31 +34,33 @@ climate:
|
|||
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
climate:
|
||||
- platform: knx
|
||||
name: HASS-Kitchen.Temperature
|
||||
temperature_address: '6/2/1'
|
||||
setpoint_address: '5/1/2'
|
||||
target_temperature_address: '5/1/1'
|
||||
operation_mode_frost_protection_address: '5/1/3'
|
||||
operation_mode_night_address: '5/1/4'
|
||||
operation_mode_comfort_address: '5/1/5'
|
||||
- platform: knx
|
||||
name: HASS-Kitchen.Temperature
|
||||
temperature_address: '6/2/1'
|
||||
setpoint_address: '5/1/2'
|
||||
target_temperature_address: '5/1/1'
|
||||
operation_mode_frost_protection_address: '5/1/3'
|
||||
operation_mode_night_address: '5/1/4'
|
||||
operation_mode_comfort_address: '5/1/5'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
* **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
* **temperature_address**: KNX group address for reading current room temperature from KNX bus.
|
||||
* **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
|
||||
* **setpoint_address**: KNX group address for basis setpoint
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **temperature_address**: KNX group address for reading current room temperature from KNX bus.
|
||||
- **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
|
||||
- **setpoint_address**: KNX group address for basis setpoint
|
||||
|
||||
* **operation_mode_address** (*Optional*) KNX address for operation mode (Frost protection/night/comfort).
|
||||
* **operation_mode_state_address** (*Optional*) Explicit KNX address for reading operation mode
|
||||
* **controller_status_address** (*Optional*) KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
|
||||
* **controller_status_state_address** (*Optional*) Explicit KNX address for reading HVAC controller status
|
||||
- **operation_mode_address** (*Optional*): KNX address for operation mode (Frost protection/night/comfort).
|
||||
- **operation_mode_state_address** (*Optional*): Explicit KNX address for reading operation mode
|
||||
- **controller_status_address** (*Optional*): KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
|
||||
- **controller_status_state_address** (*Optional*): Explicit KNX address for reading HVAC controller status
|
||||
|
||||
* **operation_mode_frost_protection_address** (*Optional*) KNX address for switching on/off frost/heat protection mode.
|
||||
* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night mode.
|
||||
* **operation_mode_comfort_address** (*Optional*) KNX address for switching on/off comfort mode.
|
||||
- **operation_mode_frost_protection_address** (*Optional*): KNX address for switching on/off frost/heat protection mode.
|
||||
- **operation_mode_night_address** (*Optional*): KNX address for switching on/off night mode.
|
||||
- **operation_mode_comfort_address** (*Optional*): KNX address for switching on/off comfort mode.
|
||||
|
||||
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified.
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,6 @@ A full configuration example looks like the one below.
|
|||
climate:
|
||||
- platform: mqtt
|
||||
name: Study
|
||||
target_sensor: sensor.study_temperature
|
||||
modes:
|
||||
- off
|
||||
- cool
|
||||
|
|
|
|||
|
|
@ -32,11 +32,10 @@ Configuration variables:
|
|||
- **step** (*Optional*): Incremental/step value for the counter. Defaults to 1 (increments by 1).
|
||||
- **icon** (*Optional*): Icon for entry.
|
||||
|
||||
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
|
||||
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance` or `mdi:motorbike`.
|
||||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
### {% linkable_title Media control services %}
|
||||
Available services: `increment`, `decrement`, and `reset`.
|
||||
|
||||
#### {% linkable_title Service `counter.increment` %}
|
||||
|
|
|
|||
|
|
@ -23,25 +23,27 @@ To use your KNX covers in your installation, add the following to your `configur
|
|||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
cover:
|
||||
- platform: knx
|
||||
name: "Kitchen.Shutter"
|
||||
move_long_address: '3/0/0'
|
||||
move_short_address: '3/0/1'
|
||||
position_address: '3/0/3'
|
||||
position_state_address: '3/0/2'
|
||||
travelling_time_down: 51
|
||||
travelling_time_up: 61
|
||||
- platform: knx
|
||||
name: "Kitchen.Shutter"
|
||||
move_long_address: '3/0/0'
|
||||
move_short_address: '3/0/1'
|
||||
position_address: '3/0/3'
|
||||
position_state_address: '3/0/2'
|
||||
travelling_time_down: 51
|
||||
travelling_time_up: 61
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **move_long_address**: KNX group address for moving the cover full up or down.
|
||||
- **move_short_address**: (*Optional*) KNX group address for moving the cover short time up or down.
|
||||
- **position_address**: (*Optional*) KNX group address for moving the cover to the dedicated position.
|
||||
- **position_state_address**: (*Optional*) Separate KNX group address for requesting the current position of the cover.
|
||||
- **angle_address**: (*Optional*) KNX group address for moving the cover to the dedicated angle.
|
||||
- **angle_state_address**: (*Optional*) Separate KNX group address for requesting the current angle of cover.
|
||||
- **travelling_time_down**: (*Optional*) Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
|
||||
- **travelling_time_up**: (*Optional*) Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
|
||||
- **invert_position**: (*Optional*) Set this to true if your actuator report fully closed as 100%
|
||||
- **invert_angle**: (*Optional*) Set this to true if your actuator reports tilt fully closed as 100%
|
||||
- **move_short_address** (*Optional*): KNX group address for moving the cover short time up or down.
|
||||
- **position_address** (*Optional*): KNX group address for moving the cover to the dedicated position.
|
||||
- **position_state_address** (*Optional*): Separate KNX group address for requesting the current position of the cover.
|
||||
- **angle_address** (*Optional*): KNX group address for moving the cover to the dedicated angle.
|
||||
- **angle_state_address** (*Optional*): Separate KNX group address for requesting the current angle of cover.
|
||||
- **travelling_time_down** (*Optional*): Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
|
||||
- **travelling_time_up** (*Optional*): Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
|
||||
- **invert_position** (*Optional*): Set this to true if your actuator report fully closed as 100%.
|
||||
- **invert_angle** (*Optional*): Set this to true if your actuator reports tilt fully closed as 100%.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,10 @@ logo: locative.png
|
|||
ha_category: Presence Detection
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
Locative is no longer under active development. See https://blog.locative.io/bye-everyone-df01871fe949
|
||||
</p>
|
||||
|
||||
This platform allows you to detect presence using [Locative](https://my.locative.io/). Locative is an open source app for [iOS](https://github.com/LocativeHQ/ios-app) and [Android](https://github.com/LocativeHQ/Locative-Android) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
|
||||
|
||||
To integrate Locative in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ Configuration variables:
|
|||
|
||||
- **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account.
|
||||
- **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`.
|
||||
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks.
|
||||
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. This would be the `username` portion of the Base Topic Name, (e.g. owntracks/**username**/iPhone). Defaults to all users who are connected to Home Assistant via Owntracks.
|
||||
- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present.
|
||||
|
||||
A full sample configuration for the `owntracks` platform is shown below:
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apiai.png
|
||||
logo: dialogflow.png
|
||||
ha_category: Voice
|
||||
featured: false
|
||||
ha_release: 0.56
|
||||
|
|
|
|||
|
|
@ -16,6 +16,10 @@ ha_release: 0.56
|
|||
# Google Assistant Docs
|
||||
The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.
|
||||
|
||||
<p class='note'>
|
||||
To use Google Assistant your Home Assistant configuration has to be externally accessible, with a hostname and SSL certificate. If you haven't already configured that you should do so before continuing.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -89,3 +89,38 @@ Notice in the example below that in order to refer to the group "Living Room", y
|
|||
- group.living_room
|
||||
- group.bedroom
|
||||
```
|
||||
|
||||
## {% linkable_title Default groups %}
|
||||
|
||||
Some components automatically create special groups containing component entities. These groups are named like `group.all_...`, for example:
|
||||
- `group.all_switches`
|
||||
- `group.all_lights`
|
||||
- `group.all_devices`
|
||||
- `group.all_scripts`
|
||||
- `group.all_automations`
|
||||
|
||||
You can see list of these groups in **State** <img src='/images/screenshots/developer-tool-states-icon.png' class='no-shadow' height='38' /> page of the **Developer Tools**.
|
||||
|
||||
Default groups appear in the HOME tab, if not overridden by user views and groups. Default groups are hidden by default, so you must [customize](/docs/configuration/customizing-devices/) them to be visible in your custom groups and views.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml to include default groups in custom view
|
||||
|
||||
customize:
|
||||
group.all_automations:
|
||||
hidden: false
|
||||
group.all_scripts:
|
||||
hidden: false
|
||||
|
||||
group:
|
||||
automation_view:
|
||||
name: Automation
|
||||
view: yes
|
||||
entities:
|
||||
- group.all_automations
|
||||
- group.all_scripts
|
||||
```
|
||||
|
||||
## {% linkable_title Group behaviour %}
|
||||
|
||||
When any member of a group is `on` then the group will also be `on`. Similarly with a device tracker, when any member of the group is `home` then the group is `home`.
|
||||
|
|
|
|||
|
|
@ -13,8 +13,6 @@ ha_release: 0.24
|
|||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
The [KNX](http://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
|
||||
|
||||
|
|
@ -30,8 +28,7 @@ There is currently support for the following device types within Home Assistant:
|
|||
- [Thermostat](/components/climate.knx)
|
||||
- [Notify](/components/notify.knx)
|
||||
|
||||
Configuration
|
||||
--------------
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To use your KNX in your installation, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -39,13 +36,14 @@ To use your KNX in your installation, add the following lines to your `configura
|
|||
knx:
|
||||
```
|
||||
|
||||
Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside HASS:
|
||||
Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside of Home Assistant:
|
||||
|
||||
```yaml
|
||||
knx:
|
||||
config_file: '/path/to/xknx.yaml'
|
||||
```
|
||||
* **config_file**: (*Optional*) path for xknx configuration file.
|
||||
|
||||
- **config_file** (*Optional*): The path for XKNX configuration file.
|
||||
|
||||
If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:
|
||||
|
||||
|
|
@ -56,9 +54,10 @@ knx:
|
|||
port: 3671
|
||||
local_ip: '192.168.2.109'
|
||||
```
|
||||
* **host**: Host of the KNX/IP tunneling device
|
||||
* **port**: Port of the KNX/IP tunneling device
|
||||
* **local_ip**: IP of the local interface
|
||||
|
||||
- **host**: Host of the KNX/IP tunneling device.
|
||||
- **port**: Port of the KNX/IP tunneling device.
|
||||
- **local_ip**: IP of the local interface.
|
||||
|
||||
Explicit connection to a KNX/IP routing device:
|
||||
|
||||
|
|
@ -68,7 +67,8 @@ knx:
|
|||
routing:
|
||||
local_ip: '192.168.2.109'
|
||||
```
|
||||
* **local_ip**: local ip of interface (which should be used for multicasting)
|
||||
|
||||
- **local_ip**: The local IP address of interface (which should be used for multicasting).
|
||||
|
||||
```yaml
|
||||
knx:
|
||||
|
|
@ -76,13 +76,11 @@ knx:
|
|||
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
|
||||
```
|
||||
|
||||
* **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
|
||||
* **fire_event_filter** (*Optional*): If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HASS event bus.
|
||||
- **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
|
||||
- **fire_event_filter** (*Optional*): If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
|
||||
- **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
|
||||
|
||||
* **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
|
||||
|
||||
Service
|
||||
-------
|
||||
### {% linkable_title Services %}
|
||||
|
||||
In order to directly interact with the KNX bus, you can now use the following service:
|
||||
|
||||
|
|
@ -96,12 +94,7 @@ Service Data: {"address": "1/0/15", "payload": 0}
|
|||
* **payload**: Payload, either an integer or an array of integers
|
||||
|
||||
|
||||
### {% linkable_title Known issues %}
|
||||
|
||||
Known issues:
|
||||
-------------
|
||||
|
||||
Due to lame multicast support the routing abstraction and the gateway scanner
|
||||
only work with python >=3.5.
|
||||
|
||||
|
||||
Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,23 +21,21 @@ The `knx` component must be configured correctly, see [KNX Component](/component
|
|||
To use your KNX light in your installation, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
- platform: knx
|
||||
name: Kitchen-Light-1
|
||||
address: '1/0/9'
|
||||
brightness_address: '1/0/11'
|
||||
|
||||
- platform: knx
|
||||
name: Kitchen-Light-2
|
||||
address: '1/0/12'
|
||||
brightness_address: '1/0/14'
|
||||
```
|
||||
|
||||
* **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
* **address**: KNX group address for switching the light on and off
|
||||
* **brightness_address**: (Optional) KNX group address for dimming light.
|
||||
* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state of the light.
|
||||
* **brightness_state_address**: (*Optional*) separate KNX group address for retrieving the dimmed state of the light.
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **address**: KNX group address for switching the light on and off.
|
||||
- **brightness_address** (Optional): KNX group address for dimming light.
|
||||
- **state_address** (*Optional*): separate KNX group address for retrieving the switch state of the light.
|
||||
- **brightness_state_address** (*Optional*): separate KNX group address for retrieving the dimmed state of the light.
|
||||
|
||||
Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
|
||||
For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address.
|
||||
|
|
|
|||
|
|
@ -16,4 +16,7 @@ This offers a map on the frontend to display the location of tracked devices. To
|
|||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
map:
|
||||
```
|
||||
```
|
||||
<p class='note'>
|
||||
Devices that are currently at home won't show on the map.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Apple TV"
|
||||
title: "Apple TV Media Player"
|
||||
description: "Instructions how to integrate Apple TV devices into Home Assistant."
|
||||
date: 2017-02-08 07:11
|
||||
sidebar: true
|
||||
|
|
@ -13,4 +13,4 @@ ha_iot_class: "Local Push"
|
|||
ha_release: 0.38
|
||||
---
|
||||
|
||||
To setup the `apple_tv` platform, please follow the instructions on the [Apple TV Component page](/components/apple_tv/).
|
||||
To setup the `apple_tv` media player platform, please follow the instructions on the [Apple TV Component page](/components/apple_tv/).
|
||||
|
|
|
|||
|
|
@ -57,7 +57,8 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`,
|
|||
| `source` | no | Name of the source to switch to. Platform dependent. |
|
||||
|
||||
#### {% linkable_title Service `media_player/shuffle_set` %}
|
||||
Currently only supports Spotify.
|
||||
|
||||
Currently only supported on [Spotify](/components/media_player.spotify/), [MPD](/components/media_player.mpd/), [Kodi](/components/media_player.kodi/), and [Universal](/components/media_player.universal/).
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------- |
|
||||
|
|
|
|||
|
|
@ -55,6 +55,7 @@ Currently known supported models:
|
|||
- U6300 (port must be set to 8001, and `pip3 install websocket-client` must be executed)
|
||||
- K6500AF (port must be set to 8001)
|
||||
- KS8005 (port must be set to 8001, and `pip3 install websocket-client` must be executed)
|
||||
- KS7502 (port must be set to 8001, and `pip3 install websocket-client` must be executed, turn on doesn't work, turn off works fine)
|
||||
- K5600AK (partially supported, turn on works but state is not updated)
|
||||
|
||||
Currently tested but not working models:
|
||||
|
|
|
|||
|
|
@ -15,7 +15,16 @@ ha_release: 0.18
|
|||
|
||||
The `webostv` platform allows you to control a [LG](http://www.lg.com/) webOS Smart TV.
|
||||
|
||||
When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.
|
||||
### {% linkable_title Setup %}
|
||||
|
||||
To begin with enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others).
|
||||
|
||||
Once basic configuration is added to your `configuration.yaml` *Configuration* card should prompt on your HA's States. Follow the instructions and accept pairing request on your TV.
|
||||
|
||||
Pairing information will be saved to the `filename:` provided in configuration; this process is IP sensitive, in case the IP address of your TV would change in future.
|
||||
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To add a TV to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -33,10 +42,9 @@ Configuration variables:
|
|||
- **timeout** (*Optional*): The timeout for connections to the TV in seconds.
|
||||
- **filename** (*Optional*): The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. It defaults to `webostv.conf`.
|
||||
- **customize** array (*Optional*): List of options to customize.
|
||||
- ***sources** array (*Optional*): List of hardware inputs.
|
||||
- ***sources** array (*Optional*): List of hardware and webOS App inputs.
|
||||
|
||||
If you do not specify `host:`, all LG webOS Smart TVs within your network will be auto-discovered if they use the default name setting of `[LG] webOS TV`.
|
||||
Home Assistant is able to turn on a LG webOS Smart TV if you specify an action, like HDMI-CEC or WakeOnLan.
|
||||
If you do not specify `host:`, all LG webOS Smart TVs within your network will be auto-discovered.
|
||||
|
||||
A full configuration example will look like the sample below:
|
||||
|
||||
|
|
@ -45,7 +53,7 @@ A full configuration example will look like the sample below:
|
|||
media_player:
|
||||
- platform: webostv
|
||||
host: 192.168.0.10
|
||||
name: Living Room TV
|
||||
name: Living Room TV
|
||||
timeout: 5
|
||||
filename: webostv.conf
|
||||
turn_on_action:
|
||||
|
|
@ -59,3 +67,32 @@ media_player:
|
|||
- makotv
|
||||
- netflix
|
||||
```
|
||||
** avoid using `[ ]` in the `name:` of your device.
|
||||
|
||||
|
||||
*Turn On Action*
|
||||
|
||||
Home Assistant is able to turn on a LG webOS Smart TV if you specify an action, like HDMI-CEC or WakeOnLan.
|
||||
|
||||
Common for webOS 3.0 and higher would be to use WakeOnLan feature.
|
||||
To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others) (or *Mobile App* in *General* settings for older models) (*may vary by version).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
wake_on_lan: # enables `wake_on_lan` domain
|
||||
|
||||
media_player:
|
||||
- platform: webostv
|
||||
host: 192.168.0.10
|
||||
#other settings
|
||||
turn_on_action:
|
||||
service: wake_on_lan.send_magic_packet
|
||||
data:
|
||||
mac: B4:E6:2A:1E:11:0F
|
||||
```
|
||||
Any other [actions](/docs/automation/action/) to power on the device can be configured.
|
||||
|
||||
|
||||
*Sources*
|
||||
|
||||
To obtain complete list of available sources currently configured on the TV, once the webOS TV is configured and linked, while its powered on head to the **Developer Tools** > **States**, find your `media_player.<name>` and use the sources listed in `source_list:` remembering to split them per line into your `sources:` configuration.
|
||||
|
|
|
|||
|
|
@ -27,9 +27,9 @@ mysensors:
|
|||
persistence_file: 'path/mysensors.json'
|
||||
baud_rate: 38400
|
||||
nodes:
|
||||
1:
|
||||
1:
|
||||
name: 'kitchen'
|
||||
3:
|
||||
3:
|
||||
name: 'living_room'
|
||||
- device: '/dev/ttyACM0'
|
||||
persistence_file: 'path/mysensors2.json'
|
||||
|
|
@ -47,21 +47,75 @@ mysensors:
|
|||
version: '2.0'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **device** (*Required*): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the TCP Ethernet gateway, or `mqtt` to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested.
|
||||
- **baud_rate** (*Optional*): Specifies the baud rate of the connected serial gateway. Default is 115200.
|
||||
- **tcp_port** (*Optional*): Specifies the port of the connected TCP Ethernet gateway. Default is 5003.
|
||||
- **topic_in_prefix** (*Optional*): Set the prefix of the MQTT topic for messages coming from the MySensors gateway in to Home Assistant. Default is an empty string.
|
||||
- **topic_out_prefix** (*Optional*): Set the prefix of the MQTT topic for messages going from Home Assistant out to the MySensors gateway. Default is an empty string.
|
||||
- **debug** (*DEPRECATED*): This option has been deprecated. Please remove this from your config is you have it included. Use the logger component to filter log messages on log level.
|
||||
- **persistence** (*Optional*): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.
|
||||
- **persistence_file** (*Optional*): The path to a file to save sensor information. The file extension determines the file type. Currently supported file types are 'pickle' and 'json'.
|
||||
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0. Default is 1.4.
|
||||
- **optimistic** (*Optional*): Enable or disable optimistic mode for actuators (switch/light). Default is false. Set this to true if no state feedback from actuators is possible. Home Assistant will assume that the command succeeded and change state.
|
||||
- **retain** (*Optional*): Enable or disable retain flag for published messages from Home Assistant when using the MQTT gateway. Default is true.
|
||||
- **nodes** (*Optional*): Nodes that need a custom name.
|
||||
- **name** (*Optional*): The name the node will be renamed to. This nodename becomes part of the entity_id. Default the entity_id is [sketch_name]\_[node_id]\_[child_id] and when this name is set, the entity_id becomes [name]\_[child_id].
|
||||
{% configuration %}
|
||||
gateways:
|
||||
description: A list of gateways to set up.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
device:
|
||||
description: The path to the serial gateway where it is connected to your Home Assistant host, or the address of the TCP Ethernet gateway, or `mqtt` to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested.
|
||||
required: true
|
||||
type: string
|
||||
baud_rate:
|
||||
description: Specifies the baud rate of the connected serial gateway.
|
||||
required: false
|
||||
type: int
|
||||
default: 115200
|
||||
tcp_port:
|
||||
description: Specifies the port of the connected TCP Ethernet gateway.
|
||||
required: false
|
||||
type: int
|
||||
default: 5003
|
||||
topic_in_prefix:
|
||||
description: Set the prefix of the MQTT topic for messages coming from the MySensors gateway in to Home Assistant.
|
||||
required: false
|
||||
type: string
|
||||
default: ''
|
||||
topic_out_prefix:
|
||||
description: Set the prefix of the MQTT topic for messages going from Home Assistant out to the MySensors gateway.
|
||||
required: false
|
||||
type: string
|
||||
default: ''
|
||||
nodes:
|
||||
description: A mapping of node ids to node settings, eg custom name.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: The name the node will be renamed to. This nodename becomes part of the entity_id. Default entity_id is [sketch_name]\_[node_id]\_[child_id] and when this name is set, the entity_id becomes [name]\_[child_id].
|
||||
required: true
|
||||
type: string
|
||||
debug:
|
||||
description: This option has been deprecated. Please remove this from your config if you have it included. Use the [logger component](/components/logger/) to filter log messages on log level.
|
||||
required: false
|
||||
type: int
|
||||
persistence:
|
||||
description: Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts.
|
||||
required: false
|
||||
type: int
|
||||
default: true
|
||||
persistence_file:
|
||||
description: The path to a file to save sensor information. The file extension determines the file type. Currently supported file types are 'pickle' and 'json'.
|
||||
required: false
|
||||
type: string
|
||||
default: path/to/config/directory/mysensors.pickle
|
||||
version:
|
||||
description: Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0.
|
||||
required: false
|
||||
type: string
|
||||
default: '1.4'
|
||||
optimistic:
|
||||
description: Enable or disable optimistic mode for actuators (switch/light). Set this to true if no state feedback from actuators is possible. Home Assistant will assume that the command succeeded and change state.
|
||||
required: false
|
||||
type: int
|
||||
default: false
|
||||
retain:
|
||||
description: Enable or disable retain flag for published messages from Home Assistant when using the MQTT gateway.
|
||||
required: false
|
||||
type: int
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
Not all features of MySensors 2.0 are yet supported by Home Assistant. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under "related components" to see what message types are currently supported.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Clikatell SMS"
|
||||
title: "Clickatell SMS"
|
||||
description: "Instructions on how to add Clickatell notifications to Home Assistant."
|
||||
date: 2017-10-09 00:00
|
||||
sidebar: true
|
||||
|
|
@ -18,17 +18,17 @@ The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver S
|
|||
### Get your Clickatell API Credentials
|
||||
Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to creater an integration. Please ensure the following:
|
||||
|
||||
1. Give the new Integration an identification name
|
||||
2. ensure it is set for 'production' use
|
||||
3. select 'HTTP' as your API type
|
||||
4. Ensure that the you select for the messaging type to be 'one way messaging'
|
||||
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide
|
||||
6. Once you have completed entering your details an API key is generated. Copy the API key
|
||||
1. Give the new Integration an identification name.
|
||||
2. Ensure it is set for 'production' use.
|
||||
3. Select 'HTTP' as your API type.
|
||||
4. Ensure that the you select for the messaging type to be 'one way messaging'.
|
||||
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide.
|
||||
6. Once you have completed entering your details an API key is generated. Copy the API key.
|
||||
|
||||
### Configuration
|
||||
To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- platform: clickatell
|
||||
name: USER_DEFINED_NAME
|
||||
|
|
@ -38,9 +38,9 @@ notify:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `Clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME.
|
||||
* **api_key** (Required): Your `API Key`.
|
||||
* **recipient** (Required): Your phone no. This is where you want to send your notification SMS messages. eg: `61444333444`
|
||||
* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME.
|
||||
* **api_key** (Required): Your API key.
|
||||
* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g. `61444333444`.
|
||||
|
||||
|
||||
To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/).
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ By default, every notification sent has a randomly generated UUID (v4) set as it
|
|||
}
|
||||
```
|
||||
|
||||
Example of adding a tag to your configuration. This won't create new notification if there already exists one with the same tag.
|
||||
Example of adding a tag to your notification. This won't create new notification if there already exists one with the same tag.
|
||||
|
||||
```yaml
|
||||
- alias: Push/update notification of sensor state with tag
|
||||
|
|
@ -233,7 +233,7 @@ or
|
|||
platform: event
|
||||
event_type: html5_notification.clicked
|
||||
event_data:
|
||||
action: open_door
|
||||
action: open_door
|
||||
```
|
||||
|
||||
#### {% linkable_title closed event %}
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@ To use your KNX switch in your installation, add the following lines to your `co
|
|||
|
||||
```yaml
|
||||
notify:
|
||||
- platform: knx
|
||||
name: Alarm
|
||||
address: '5/1/10'
|
||||
- platform: knx
|
||||
name: Alarm
|
||||
address: '5/1/10'
|
||||
```
|
||||
|
||||
* **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Apple TV"
|
||||
title: "Apple TV Remote"
|
||||
description: "Instructions how to integrate Apple TV remote into Home Assistant."
|
||||
date: 2017-06-26 20:50
|
||||
sidebar: true
|
||||
|
|
@ -38,7 +38,6 @@ data:
|
|||
- menu
|
||||
- select
|
||||
device: ''
|
||||
|
||||
```
|
||||
|
||||
Please note that `device` must be specified (because of validation) but is not used by this platform. So you may specify any value.
|
||||
|
|
|
|||
|
|
@ -26,26 +26,13 @@ sensor:
|
|||
name: Heating.Valve1
|
||||
address: '2/0/0'
|
||||
type: 'percent'
|
||||
|
||||
- platform: knx
|
||||
name: Kitchen.Temperature
|
||||
address: '6/2/1'
|
||||
type: 'temperature'
|
||||
|
||||
- platform: knx
|
||||
name: Wind speed
|
||||
type: speed_ms
|
||||
address: 1/0/0
|
||||
|
||||
- platform: knx
|
||||
name: Lux
|
||||
type: illuminance
|
||||
address: 1/0/1
|
||||
```
|
||||
|
||||
* **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
* **address**: KNX group address of the sensor
|
||||
* **type**: (Optional) "percent", "temperature", "illuminance", "speed_ms", "current"
|
||||
|
||||
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **address**: KNX group address of the sensor.
|
||||
- **type** (Optional): "percent", "temperature", "illuminance", "speed_ms", "current".
|
||||
|
||||
|
|
|
|||
|
|
@ -27,8 +27,15 @@ Configuration variables:
|
|||
|
||||
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
|
||||
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. Defaults to `traffic_jam`.
|
||||
<<<<<<< HEAD
|
||||
- **traffic_jam**: Amount of kilometers in traffic jam (km).
|
||||
- **mean_velocity**: Mean velocity (km/h).
|
||||
- **congestion**: Index of congestion (n/a).
|
||||
=======
|
||||
- **traffic_jam**: A human-readable text summary.
|
||||
- **mean_velocity**: The current temperature.
|
||||
- **congestion**: The wind speed.
|
||||
|
||||
>>>>>>> current
|
||||
|
||||
The data is coming from the [Direction des routes Île-de-France (DiRIF)](http://www.sytadin.fr).
|
||||
|
|
|
|||
|
|
@ -28,3 +28,11 @@ Configuration variables:
|
|||
|
||||
- **name** (*Optional*): Name of the sensor. Defaults to `Uptime`.
|
||||
- **unit_of_measurement** (*Optional*): Units for uptime measurement in either `days`, `hours`, or `minutes`. Defaults to `days`.
|
||||
|
||||
```yaml
|
||||
# Example with configuration variables
|
||||
sensor:
|
||||
- platform: uptime
|
||||
name: Time Online
|
||||
unit_of_measurement: hours
|
||||
````
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ logo: home-assistant.png
|
|||
---
|
||||
|
||||
This component can expose regular shell commands as services. Services can be called from a [script] or in [automation].
|
||||
Shell commands aren't allowed for a camel-case naming, please use lowercase naming only and separate the names with underscores.
|
||||
|
||||
[script]: /components/script/
|
||||
[automation]: /getting-started/automation/
|
||||
|
|
|
|||
|
|
@ -159,29 +159,12 @@ $ source /srv/homeassistant/bin/activate
|
|||
To fetch the token follow these instructions depending on your mobile phone platform.
|
||||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
|
||||
3. Get and install the [ADB tool for Windows](https://developer.android.com/studio/releases/platform-tools.html).
|
||||
4. Create a backup of the application `com.xiaomi.smarthome`:
|
||||
```bash
|
||||
$ adb backup -noapk com.xiaomi.smarthome -f backup.ab
|
||||
```
|
||||
5. If you have this message: "More than one device or emulator", use this command to list all devices:
|
||||
```bash
|
||||
$ adb devices
|
||||
```
|
||||
and execute this command:
|
||||
```bash
|
||||
$ adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command)
|
||||
```
|
||||
6. On the phone, you must confirm the backup. DO NOT enter any password and press button to make the backup.
|
||||
7. Get and install [ADB Backup Extractor](https://sourceforge.net/projects/adbextractor/).
|
||||
8. Extract All files from the backup:
|
||||
```bash
|
||||
$ java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar ""
|
||||
```
|
||||
9. Unzip the ".tar" file.
|
||||
10. Open the SQLite database `miio2.db` with a tool like SQLite Manager extension for FireFox.
|
||||
11. Get the token from "devicerecord" table.
|
||||
2. Download and extract the [MiToolKit.zip](https://github.com/ultrara1n/MiToolkit/releases).
|
||||
3. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
|
||||
4. Change the MiToolKit language to English if you need to.
|
||||
5. Click "Extract Token"
|
||||
6. On the phone, you must confirm the backup. DO NOT enter any password and press the button to make the backup.
|
||||
8. Once you have confirmed the backup the token extraction will begin, it should appear in the MiToolKit shortly.
|
||||
|
||||
#### {% linkable_title Linux and Android (rooted!) %}
|
||||
|
||||
|
|
@ -214,7 +197,7 @@ To fetch the token follow these instructions depending on your mobile phone plat
|
|||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Using iTunes, create an unencrypted backup of your iPhone.
|
||||
3. Install [iBackup Viewer](Get ADB f.e. `apt-get install android-tools-adb`), open it, and open your backup.
|
||||
3. Install [iBackup Viewer](http://www.imactools.com/iphonebackupviewer/), open it, and open your backup.
|
||||
4. Open the "Raw Data" module.
|
||||
5. Navigate to `com.xiaomi.mihome`.
|
||||
6. Search for a file that looks like this: `123456789_mihome.sqlite` – note that `_mihome.sqlite` is *not* the correct file.
|
||||
|
|
|
|||
|
|
@ -20,18 +20,21 @@ 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 automatically sets up any switches, lights, locks, fans, climate devices, covers, sensors, and alarms.
|
||||
Home Assistant integrates with the Wink API and automatically sets up any switches, lights, locks, fans, climate devices (thermostats, air conditioners, and water heaters), covers, sensors, alarms, and sirens.
|
||||
|
||||
Check the related components pages for actual devices that are supported.
|
||||
|
||||
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)
|
||||
|
||||
You need to setup a developer account with Wink. This process can take a few days to get approved.
|
||||
|
||||
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.
|
||||
Wink requests three pieces of information from the user when they sign up for a developer account.
|
||||
|
||||
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.
|
||||
1. `Name:` This can be anything, for example "Home Assistant"
|
||||
2. `Website:` The external address of your Home Assistant instance. If not externally accessible you can use your email address.
|
||||
3. `Redirect URI:` This should be "http://192.168.1.5:8123/auth/wink/callback" replacing the IP with the internal IP of your Home Assistant box.
|
||||
|
||||
No settings are required in the configuration.yaml other than `wink:` this is because you will be guided through setup via the configurator on the frontend.
|
||||
|
||||
<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.
|
||||
|
|
@ -41,11 +44,10 @@ When using the configurator make sure the initial setup is performed on the same
|
|||
wink:
|
||||
```
|
||||
|
||||
|
||||
### Authentication with your Wink email and password.
|
||||
~~### Authentication with your Wink email and password.~~
|
||||
|
||||
|
||||
This method pulls a new token on every startup of Home Assistant from this [URL](https://winkbearertoken.appspot.com)
|
||||
~~This method pulls a new token on every startup of Home Assistant from this [URL](https://winkbearertoken.appspot.com)~~
|
||||
|
||||
```yaml
|
||||
wink:
|
||||
|
|
@ -53,9 +55,11 @@ wink:
|
|||
password: YOUR_WINK_PASSWORD
|
||||
```
|
||||
|
||||
This is no longer working due to a recent change Wink made, and will be removed in the next release of Home Assistant. Please create a [developer.wink.com](https://developer.wink.com) account so you can keep using Wink!
|
||||
|
||||
### Full oauth authentication (legacy).
|
||||
|
||||
This should be used for users that obtained their client_id and client_secret via email from Wink support.
|
||||
This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existance.
|
||||
|
||||
|
||||
```yaml
|
||||
|
|
@ -68,11 +72,11 @@ wink:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **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.
|
||||
- **email** (*Required for legacy OAuth*): Your Wink login email.
|
||||
- **password** (*Required for 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 an issue to the local hub.
|
||||
- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issued to the local hub.
|
||||
|
||||
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`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue