jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-31 15:26:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

add doc for new service clean_spot for the vacuum component (#3146)

Browse Source 
Also, fix the `locate` service description and the `ha_release`.
This commit is contained in:
Eugenio Panadero 2017-08-06 23:44:55 +02:00 committed by Martin Hjelmare
parent b8a6688787
commit 3b49eb8cfe
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_components/vacuum.markdown
View File

@ -24,7 +24,7 @@ vacuum:
### {% linkable_title Component services %} ### {% linkable_title Component services %}
Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `set_fanspeed` and `send_command`. Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`.
Before calling one of these services, make sure your botvac platform supports it. Before calling one of these services, make sure your botvac platform supports it.
@ -70,7 +70,15 @@ Tell the botvac to return home.
#### {% linkable_title Service `vacuum/locate` %} #### {% linkable_title Service `vacuum/locate` %}
Start a new cleaning task. Locate the vacuum cleaner robot.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/clean_spot` %}
Tell the vacuum cleaner to do a spot clean-up.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------| |---------------------------|----------|-------------------------------------------------------|

8
source/_components/vacuum.xiaomi.markdown
View File

@ -9,12 +9,12 @@ sharing: true
footer: true footer: true
logo: xiaomi.png logo: xiaomi.png
ha_category: Hub ha_category: Hub
ha_release: 0.50 ha_release: 0.51
--- ---
The `xiaomi` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/). The `xiaomi` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/).
Current supported features are `turn_on`, `pause`, `stop`, `return_to_home`, `turn_off` (stops goes to dock), `locate`, `set_fanspeed` and even remote control your robot. Current supported features are `turn_on`, `pause`, `stop`, `return_to_home`, `turn_off` (stops goes to dock), `locate`, `clean_spot`, `set_fanspeed` and even remote control your robot.
## {% linkable_title Getting started %} ## {% linkable_title Getting started %}
@ -23,7 +23,7 @@ Follow the pairing process using your phone and Mi-Home app. From here you will
<p class='note warning'> <p class='note warning'>
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.</p> 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.</p>
```bash ```bash
$ sudo su -s /bin/bash homeassistant $ sudo su -s /bin/bash homeassistant
$ source /srv/homeassistant/bin/activate $ source /srv/homeassistant/bin/activate
``` ```
@ -41,7 +41,7 @@ In order to fetch the token follow these instructions depending on your mobile p
5. If you have this message : "More than one device or emulator", use this command to list all devices: 5. If you have this message : "More than one device or emulator", use this command to list all devices:
```bash ```bash
.\adb devices .\adb devices
``` ```
and execute this command: and execute this command:
```bash ```bash
.\adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command) .\adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command)