mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 13:26:54 +00:00
✏️ Spelling, grammar, styling and fixes (#8178)
This commit is contained in:
parent
9dd559a246
commit
b5cb35646b
@ -13,7 +13,7 @@ ha_release: 0.51
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `xiaomi miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/).
|
||||
The `xiaomi_miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/).
|
||||
|
||||
Currently supported services are:
|
||||
|
||||
@ -69,39 +69,39 @@ In addition to all of the services provided by the `vacuum` component (`start`,
|
||||
|
||||
Start the remote control mode of the robot. You can then move it with `remote_control_move`; when done, call `remote_control_stop`.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific robot; default targets all |
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|---------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on a specific robot; default targets all |
|
||||
|
||||
### {% linkable_title Service `vacuum.xiaomi_remote_control_stop` %}
|
||||
|
||||
Exit the remote control mode of the robot.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific robot; default targets all |
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|---------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on a specific robot; default targets all |
|
||||
|
||||
### {% linkable_title Service `vacuum.xiaomi_remote_control_move` %}
|
||||
|
||||
Remote control the robot. Please ensure you first set it in remote control mode with `remote_control_start`.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific robot; default targets all |
|
||||
| `velocity` | no | Speed: between -0.29 and 0.29 |
|
||||
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
|
||||
| `duration` | no | The number of milliseconds that the robot should move for |
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-----------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on a specific robot; default targets all |
|
||||
| `velocity` | no | Speed: between -0.29 and 0.29 |
|
||||
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
|
||||
| `duration` | no | The number of milliseconds that the robot should move for |
|
||||
|
||||
### {% linkable_title Service `vacuum.xiaomi_remote_control_move_step` %}
|
||||
|
||||
Enter remote control mode, make one move, stop, and exit remote control mode.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on specific robot; default targets all |
|
||||
| `velocity` | no | Speed: between -0.29 and 0.29. |
|
||||
| `rotation` | no | Rotation: between -179 degrees and 179 degrees. |
|
||||
| `duration` | no | The number of milliseconds that the robot should move for |
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-----------------------------------------------------------|
|
||||
| `entity_id` | yes | Only act on a specific robot; default targets all |
|
||||
| `velocity` | no | Speed: between -0.29 and 0.29 |
|
||||
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
|
||||
| `duration` | no | The number of milliseconds that the robot should move for |
|
||||
|
||||
## {% linkable_title Attributes %}
|
||||
|
||||
@ -134,23 +134,23 @@ The following table shows the units of measurement for each attribute:
|
||||
## {% linkable_title Retrieving the Access Token %}
|
||||
|
||||
<p class='note'>
|
||||
As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
|
||||
As per [`python-miio` issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently, the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using an older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
|
||||
<br/> <br/>
|
||||
The iPhone app still stores the token in the sqlite db as of v4.10.2 (Dec 22, 2018).
|
||||
The iPhone app still stores the token in the SQLite db as of v4.10.2 (Dec 22, 2018).
|
||||
<br/> <br/>
|
||||
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained
|
||||
easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.
|
||||
</p>
|
||||
|
||||
#### {% linkable_title Miio command line tool %}
|
||||
### {% linkable_title Miio command line tool %}
|
||||
|
||||
You can install the command line tool with:
|
||||
You can install the command line tool using the following command:
|
||||
|
||||
```bash
|
||||
npm install -g miio
|
||||
```
|
||||
|
||||
Discovering devices on current network
|
||||
Discovering devices on the current network:
|
||||
|
||||
```bash
|
||||
miio discover
|
||||
@ -170,12 +170,12 @@ Support: At least basic
|
||||
|
||||
The information output is:
|
||||
|
||||
- __Device ID__ - the unique identifier of the device, does not change if the device is reset.
|
||||
- __Model ID__ - the model id if it could be determined, this indicates what type of device it is
|
||||
- __Address__ - the IP that the device has on the network
|
||||
- __Token__ - the token of the device or ??? if it could not be automatically determined
|
||||
- `Device ID` - The unique identifier of the device, does not change if the device is reset.
|
||||
- `Model ID`- The model id if it could be determined, this indicates what type of device it is.
|
||||
- `Address` - The IP that the device has on the network.
|
||||
- `Token` - The token of the device or `???` if it could not be automatically determined.
|
||||
|
||||
#### {% linkable_title Windows and Android %}
|
||||
### {% linkable_title Windows and Android %}
|
||||
|
||||
To fetch the token follow these instructions depending on your mobile phone platform.
|
||||
|
||||
@ -183,14 +183,14 @@ To fetch the token follow these instructions depending on your mobile phone plat
|
||||
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"
|
||||
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.
|
||||
7. Once you have confirmed the backup the token extraction will begin, it should appear in the MiToolKit shortly.
|
||||
8. If you don't get a token, close MiToolKit completely, delete the folder MiToolkit\apps\com.xiaomi.smarthome and relaunch MiToolKit to force recreate a new backup (sometimes the files would not be overwritten before deleting the old ones)
|
||||
8. If you don't get a token, close MiToolKit completely, delete the folder MiToolkit\apps\com.xiaomi.smarthome and relaunch MiToolKit to force recreate a new backup (sometimes the files would not be overwritten before deleting the old ones).
|
||||
|
||||
#### {% linkable_title Linux and Android (not rooted) %}
|
||||
### {% linkable_title Linux and Android (not rooted) %}
|
||||
|
||||
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone.
|
||||
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from an SQLite file inside your phone.
|
||||
|
||||
Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly.
|
||||
|
||||
@ -198,7 +198,7 @@ Before you begin you need to install `libffi-dev` and `libssl-dev` by running th
|
||||
sudo apt-get install libffi-dev libssl-dev
|
||||
```
|
||||
|
||||
If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
|
||||
If your Home Assistant installation is running in a [virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
@ -209,17 +209,23 @@ To fetch the token follow these instructions depending on your mobile phone plat
|
||||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Enable developer mode, USB debugging and plug the Android phone into the computer.
|
||||
3. Get ADB e.g., `apt-get install android-tools-adb` or `apt-get install adb`
|
||||
4. `adb devices` should list your device. Consult ADB manual if necessary.
|
||||
5. Issue a backup command via adb: `adb backup -noapk com.xiaomi.smarthome -f backup.ab` (set a password if prompted on your phone). Some devices may required single quotes in the command `adb backup '-noapk com.xiaomi.smarthome -f backup.ab'`
|
||||
6. Download the 'ADB Backup Extractor' from [here](https://sourceforge.net/projects/adbextractor/files/latest/download)
|
||||
7. Extract the data from the backup: `java -jar Android\ Backup\ Utilities/Android\ Backup\ Extractor/android-backup-extractor-20171005-bin/abe.jar unpack backup.ab unpacked.tar` (enter the password, if prompted)
|
||||
8. Untar the unpacked data: `tar -xvf unpacked.tar`
|
||||
9. `sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name like "%Vacuum%";'` returns the token for your Xiaomi vacuum bot.
|
||||
3. Get ADB by running `apt-get install android-tools-adb` or `apt-get install adb`.
|
||||
4. `adb devices` should list your device. Consult the ADB manual if necessary.
|
||||
5. Issue a backup command via adb: `adb backup -noapk com.xiaomi.smarthome -f backup.ab` (set a password if prompted on your phone). Some devices may require single quotes in the command `adb backup '-noapk com.xiaomi.smarthome -f backup.ab'`.
|
||||
6. Download the ['ADB Backup Extractor'](https://sourceforge.net/projects/adbextractor/files/latest/download).
|
||||
7. Extract the data from the backup: (enter the password, if prompted)
|
||||
```bash
|
||||
java -jar Android\ Backup\ Utilities/Android\ Backup\ Extractor/android-backup-extractor-20171005-bin/abe.jar unpack backup.ab unpacked.tar
|
||||
```
|
||||
8. Untar the unpacked data: `tar -xvf unpacked.tar`.
|
||||
9. The following command returns the token for your Xiaomi vacuum bot:
|
||||
```bash
|
||||
sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name like "%Vacuum%";'
|
||||
```
|
||||
|
||||
#### {% linkable_title Linux and Android (rooted!) %}
|
||||
### {% linkable_title Linux and Android (rooted!) %}
|
||||
|
||||
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone.
|
||||
Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from an SQLite file inside your phone.
|
||||
|
||||
Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly.
|
||||
|
||||
@ -227,7 +233,7 @@ Before you begin you need to install `libffi-dev` and `libssl-dev` by running th
|
||||
sudo apt-get install libffi-dev libssl-dev
|
||||
```
|
||||
|
||||
If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
|
||||
If your Home Assistant installation is running in a [virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
@ -238,57 +244,71 @@ To fetch the token follow these instructions depending on your mobile phone plat
|
||||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Enable developer mode, USB debugging and root permission only for ADB on the Android phone and plug it into the computer.
|
||||
3. Get ADB f.e. `apt-get install android-tools-adb`
|
||||
4. `adb devices` should list your device
|
||||
5. `adb root` (does work for development builds only: ones with `ro.debuggable=1`)
|
||||
6. `adb shell` (for those using Magisk based root the previous command won't work. After entering a shell, type `su` to enter the root shell)
|
||||
7. `echo "select name,localIP,token from devicerecord;" | sqlite3 /data/data/com.xiaomi.smarthome/databases/miio2.db` returns a list of all registered devices including IP address and token.
|
||||
3. Get ADB (e.g, using `apt-get install android-tools-adb`).
|
||||
4. The command `adb devices` should list your device.
|
||||
5. The command `adb root` (does work for development builds only: ones with `ro.debuggable=1`).
|
||||
6. The command `adb shell` (for those using Magisk based root the this command won't work. After entering a shell, type `su` to enter the root shell and try again).
|
||||
7. The following command returns a list of all registered devices including IP address and token:
|
||||
```bash
|
||||
echo "select name,localIP,token from devicerecord;" | sqlite3 /data/data/com.xiaomi.smarthome/databases/miio2.db
|
||||
```
|
||||
|
||||
#### {% linkable_title iOS %}
|
||||
### {% linkable_title iOS %}
|
||||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Using iTunes, create an unencrypted backup of your iPhone.
|
||||
3. Install [iBackup Viewer](https://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.
|
||||
6. Search for a file that looks like this: `123456789_mihome.sqlite` (Note: `_mihome.sqlite` is *not* the correct file).
|
||||
7. Save this file to your filesystem.
|
||||
8. Install [DB Browser for SQLite](https://sqlitebrowser.org/).
|
||||
9. Open DB Browser and load the `.sqlite` file you saved from your backup.
|
||||
10. Click on the `Execute SQL` tab.
|
||||
11. Input and run this query: `SELECT ZTOKEN FROM ZDEVICE WHERE ZMODEL LIKE "%vacuum%"`
|
||||
11. Input and run this query:
|
||||
```sql
|
||||
SELECT ZTOKEN FROM ZDEVICE WHERE ZMODEL LIKE "%vacuum%"
|
||||
```
|
||||
12. Copy the returned 32-digit hexadecimal string to your clipboard.
|
||||
13. Open `Terminal` and execute this command: `echo '0: <YOUR HEXADECIMAL STRING>' | xxd -r -p | openssl enc -d -aes-128-ecb -nopad -nosalt -K 00000000000000000000000000000000`
|
||||
13. Open `Terminal` and execute this command:
|
||||
```bash
|
||||
echo '0: <YOUR HEXADECIMAL STRING>' | xxd -r -p | openssl enc -d -aes-128-ecb -nopad -nosalt -K 00000000000000000000000000000000
|
||||
```
|
||||
14. Use the resulting string as your token.
|
||||
|
||||
#### {% linkable_title Bluestacks %}
|
||||
### {% linkable_title Bluestacks %}
|
||||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
2. Install [BlueStacks](https://www.bluestacks.com).
|
||||
3. Set up the Mi-Home app in BlueStacks and login to synchronize devices.
|
||||
4. Use [BlueStacks Tweaker](https://forum.xda-developers.com/general/general/bluestacks-tweaker-2-tool-modifing-t3622681) to access the filesystem and retrieve the token.
|
||||
|
||||
#### {% linkable_title Selecting token manually (Windows and Android)%}
|
||||
### {% linkable_title Selecting token manually (Windows and Android) %}
|
||||
|
||||
The following instruction explained an alternative method, in case the MiToolKit didn't work.
|
||||
|
||||
Software Required:
|
||||
|
||||
The following instruction explained an alternativ way, if MiToolKit didn't work.
|
||||
Software Required:
|
||||
- Android ADB is contained in [Android SDK](https://developer.android.com/studio/releases/platform-tools)
|
||||
- [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/)
|
||||
- [Android Backup Extractor](https://sourceforge.net/projects/adbextractor/)
|
||||
- [SQLite Browser](https://sqlitebrowser.org/)
|
||||
1. Install an old Version of MiHome (e.g. Mi-Home version 5.0.30) on your Android-Device
|
||||
2. Open MiHome, log-in and add your devices
|
||||
3. Enable USB-Debugging on your Android
|
||||
4. Create a backup from your MiHome App, by using adb
|
||||
```bash
|
||||
adb backup com.xiaomi.smarthome
|
||||
```
|
||||
Now the backup App opens on you Android-Device. You don't need to set a password, just click save.
|
||||
5. Extract the backup-file with android-backup-extractor
|
||||
```bash
|
||||
java -jar abe.jar unpack backup.ab backup.tar
|
||||
```
|
||||
After that, you kann open the file with WinRaR or what ever you like.
|
||||
6. Go to \apps\com.xiaomi.smarthome\db
|
||||
7. Open miio2.db with SQLite Browser
|
||||
8. You can find your device tokens in "devicerecord" table
|
||||
|
||||
Steps to take:
|
||||
|
||||
1. Install an old Version of MiHome (e.g. Mi-Home version 5.0.30) on your Android-Device.
|
||||
2. Open MiHome, log-in and add your devices.
|
||||
3. Enable USB-Debugging on your Android.
|
||||
4. Create a backup from your MiHome App, by using adb:
|
||||
```bash
|
||||
adb backup com.xiaomi.smarthome
|
||||
```
|
||||
Now the backup App opens on you Android-Device. You don't need to set a password, just click save.
|
||||
5. Extract the backup-file with android-backup-extractor:
|
||||
```bash
|
||||
java -jar abe.jar unpack backup.ab backup.tar
|
||||
```
|
||||
After that, extract the file with WinRAR, 7-Zip (or similar).
|
||||
6. Go to `\apps\com.xiaomi.smarthome\db`.
|
||||
7. Open `miio2.db` with the SQLite Browser.
|
||||
8. You can find your device tokens in `devicerecord` table.
|
||||
|
@ -17,12 +17,12 @@ Home Assistant has support to integrate your [Verisure](https://www.verisure.com
|
||||
|
||||
We support:
|
||||
|
||||
* [Alarm](/components/alarm_control_panel.verisure/)
|
||||
* [Smartplugs](/components/switch.verisure/)
|
||||
* Reading from thermometers and hygrometers integrated in various [devices](/components/sensor.verisure/)
|
||||
* Mouse Detector
|
||||
* [Locks](/components/lock.verisure/)
|
||||
* [Door & Window](/components/binary_sensor.verisure/)
|
||||
- [Alarm](/components/alarm_control_panel.verisure/)
|
||||
- [Smartplugs](/components/switch.verisure/)
|
||||
- Reading from thermometers and hygrometers integrated in various [devices](/components/sensor.verisure/)
|
||||
- Mouse Detector
|
||||
- [Locks](/components/lock.verisure/)
|
||||
- [Door & Window](/components/binary_sensor.verisure/)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
|
@ -52,22 +52,47 @@ volvooncall:
|
||||
region: cn
|
||||
```
|
||||
|
||||
A more advanced example for setting the vehicle name and selecting what resources to display:
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username associated with your Volvo On Call account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your given Volvo On Call account.
|
||||
required: true
|
||||
type: string
|
||||
region:
|
||||
description: The region where the Volvo is registered. Needs to be set for users in North America or China.
|
||||
required: false
|
||||
type: string
|
||||
service_url:
|
||||
description: The service URL to use for Volvo On Call. Normally not necessary to specify.
|
||||
required: false
|
||||
type: string
|
||||
mutable:
|
||||
description: If set to true, include components that can make changes to the vehicle (unlock, start engine, start heater etc).
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
name:
|
||||
description: Make it possible to provide a name for the vehicles.
|
||||
required: false
|
||||
type: string
|
||||
resources:
|
||||
description: A list of resources to display (defaults to all available).
|
||||
required: false
|
||||
type: list
|
||||
scandinavian_miles:
|
||||
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
volvooncall:
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
name:
|
||||
abc123: 'Batmobile'
|
||||
resources:
|
||||
- odometer
|
||||
- lock
|
||||
- heater
|
||||
```
|
||||
### {% linkable_title Available Resources %}
|
||||
|
||||
The list of currently available resources:
|
||||
|
||||
Currently available resources:
|
||||
- `position`
|
||||
- `lock`
|
||||
- `heater`
|
||||
@ -105,39 +130,19 @@ Currently available resources:
|
||||
- `any_door_open`
|
||||
- `any_window_open`
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username associated with your Volvo On Call account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your given Volvo On Call account.
|
||||
required: true
|
||||
type: string
|
||||
region:
|
||||
description: The region where the Volvo is registered. Needs to be set for users in North America or China.
|
||||
required: false
|
||||
type: string
|
||||
service_url:
|
||||
description: The service URL to use for Volvo On Call. Normally not necessary to specify.
|
||||
required: false
|
||||
type: string
|
||||
mutable:
|
||||
description: If set to true, include components that can make changes to the vehicle (unlock, start engine, start heater etc).
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
name:
|
||||
description: Make it possible to provide a name for the vehicles.
|
||||
required: false
|
||||
type: string
|
||||
resources:
|
||||
description: A list of resources to display (defaults to all available).
|
||||
required: false
|
||||
type: list
|
||||
scandinavian_miles:
|
||||
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
## {% linkable_title Advanced Examples %}
|
||||
|
||||
A more advanced example for setting the vehicle name and selecting what resources to display:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
volvooncall:
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
name:
|
||||
abc123: 'Batmobile'
|
||||
resources:
|
||||
- odometer
|
||||
- lock
|
||||
- heater
|
||||
```
|
||||
|
@ -13,10 +13,10 @@ ha_release: 0.83
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which
|
||||
The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which
|
||||
communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz.
|
||||
|
||||
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad
|
||||
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad
|
||||
remotes, key chain remotes, Hawkeye motion detectors, and many, many other X10 RF devices.
|
||||
|
||||
To enable W800rf32 in your installation, add the following to your `configuration.yaml` file:
|
||||
@ -33,6 +33,3 @@ device:
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
|
||||
|
@ -14,8 +14,7 @@ ha_iot_class: "Cloud Polling"
|
||||
redirect_from: /components/climate.econet/
|
||||
---
|
||||
|
||||
|
||||
The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vaction mode.
|
||||
The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vacation mode.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -46,9 +45,9 @@ You can use the service `econet.add_vacation` to create a new vacation for your
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | The entity id of the water heater to add the vaction to.
|
||||
| `start_date` | yes | This is a Unix timestamp for when the vaction should start.
|
||||
| `end_date` | yes | this is a Unix timestamp for when the vaction should end.
|
||||
| `entity_id` | yes | The entity id of the water heater to add the vacation to.
|
||||
| `start_date` | yes | This is a Unix timestamp for when the vacation should start.
|
||||
| `end_date` | yes | this is a Unix timestamp for when the vacation should end.
|
||||
|
||||
<p class='note'>
|
||||
The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.
|
||||
@ -56,11 +55,11 @@ The Unix timestamps can be obtained from the `input_datetime` component. This wi
|
||||
|
||||
### {% linkable_title Service `econet.delete_vacation` %}
|
||||
|
||||
You can use the service `econet.delete_vacation` to remove all vactions from an EcoNet water heater.
|
||||
You can use the service `econet.delete_vacation` to remove all vacations from an EcoNet water heater.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | The entity id of the water heater to remove the vaction from.
|
||||
| `entity_id` | yes | The entity id of the water heater to remove the vacation from.
|
||||
|
||||
<p class='note'>
|
||||
Econet water heaters use to live under the `climate` platform prior to release 0.81.
|
||||
|
@ -9,9 +9,8 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
|
||||
The `water_heater` component is built for the controlling and monitoring of hot water heaters.
|
||||
|
||||
|
||||
To enable this component, pick one of the platforms, and add it to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
@ -23,6 +22,7 @@ water_heater:
|
||||
## {% linkable_title Services %}
|
||||
|
||||
### {% linkable_title Water heater control services %}
|
||||
|
||||
Available services: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode`
|
||||
|
||||
<p class='note'>
|
||||
@ -31,13 +31,13 @@ Not all water heater services may be available for your platform. Be sure to che
|
||||
|
||||
### {% linkable_title Service `water_heater.set_temperature` %}
|
||||
|
||||
Set target temperature of water heater device
|
||||
Sets target temperature of water heater device.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all.
|
||||
| `temperature` | no | New target temperature for water heater
|
||||
| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
|
||||
| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly.
|
||||
|
||||
#### {% linkable_title Automation example %}
|
||||
|
||||
@ -63,7 +63,7 @@ Set operation mode for water heater device
|
||||
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all.
|
||||
| `operation_mode` | no | New value of operation mode
|
||||
|
||||
#### {% linkable_title Automation example %}
|
||||
#### {% linkable_title Automation example %}
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
@ -86,7 +86,7 @@ Turn away mode on or off for water heater device
|
||||
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all.
|
||||
| `away_mode` | no | New value of away mode. 'on'/'off' or True/False
|
||||
|
||||
#### {% linkable_title Automation example %}
|
||||
#### {% linkable_title Automation example %}
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Wink Water Heater"
|
||||
description: "Instructions on how to setup the Wink water heaters within Home Assistant."
|
||||
description: "Instructions on how to set up the Wink water heaters within Home Assistant."
|
||||
date: 2016-11-01 22:36
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -15,14 +15,12 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The Wink water heater platform allows you to get data from your [Wink](http://www.wink.com/) Water Heaters.
|
||||
|
||||
The requirement is that you have setup [Wink](/components/wink/).
|
||||
The requirement is that you have set up [Wink](/components/wink/).
|
||||
|
||||
|
||||
### {% linkable_title Supported water heaters %}
|
||||
## {% linkable_title Supported water heaters %}
|
||||
|
||||
- Rheem Econet water heaters (No Wink hub required)
|
||||
|
||||
|
||||
<p class='note'>
|
||||
Wink water heaters use to live under the `climate` platform prior to release 0.81.
|
||||
</p>
|
||||
|
@ -17,21 +17,20 @@ The `waterfurnace` component communicates with the WaterFurnace Symphony website
|
||||
|
||||
The sensors provided include:
|
||||
|
||||
- Thermostat Setpoint
|
||||
- Thermostat Current Temp
|
||||
- Leaving Air Temp
|
||||
- Entering Water Loop Temp
|
||||
- Current Humidity
|
||||
- Current Humidity Setpoint
|
||||
- Total system power (in Watts)
|
||||
- Furnace Mode
|
||||
- Compressor Power
|
||||
- Fan Power
|
||||
- Aux Power
|
||||
- Loop Pump Power
|
||||
- Compressor Speed
|
||||
- Fan Speed
|
||||
|
||||
- Thermostat Setpoint
|
||||
- Thermostat Current Temp
|
||||
- Leaving Air Temp
|
||||
- Entering Water Loop Temp
|
||||
- Current Humidity
|
||||
- Current Humidity Setpoint
|
||||
- Total system power (in Watts)
|
||||
- Furnace Mode
|
||||
- Compressor Power
|
||||
- Fan Power
|
||||
- Aux Power
|
||||
- Loop Pump Power
|
||||
- Compressor Speed
|
||||
- Fan Speed
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -55,8 +54,8 @@ password:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### {% linkable_title Limitations %}
|
||||
## {% linkable_title Limitations %}
|
||||
|
||||
The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle.
|
||||
The WebSocket interface used by this module requires active polling to prevent the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle.
|
||||
|
||||
While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented.
|
||||
|
@ -22,10 +22,11 @@ a gateway device in your IoT platform instance. For instructions on how to do
|
||||
this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway)
|
||||
which provides the details on doing this. After you register the gateway device
|
||||
for your home-assistant you'll need 4 pieces of information:
|
||||
- Organization ID
|
||||
- Gateway device Type
|
||||
- Gateway device ID
|
||||
- Authentication Token
|
||||
|
||||
- Organization ID
|
||||
- Gateway device Type
|
||||
- Gateway device ID
|
||||
- Authentication Token
|
||||
|
||||
With this basic information you can configure the component:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user