Skip to content

Commit 3b49eb8

Browse files
azogueMartinHjelmare
authored andcommitted
add doc for new service clean_spot for the vacuum component (home-assistant#3146)
Also, fix the `locate` service description and the `ha_release`.
1 parent b8a6688 commit 3b49eb8

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

source/_components/vacuum.markdown

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ vacuum:
2424
2525
### {% linkable_title Component services %}
2626
27-
Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `set_fanspeed` and `send_command`.
27+
Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`.
2828

2929
Before calling one of these services, make sure your botvac platform supports it.
3030

@@ -70,7 +70,15 @@ Tell the botvac to return home.
7070

7171
#### {% linkable_title Service `vacuum/locate` %}
7272

73-
Start a new cleaning task.
73+
Locate the vacuum cleaner robot.
74+
75+
| Service data attribute | Optional | Description |
76+
|---------------------------|----------|-------------------------------------------------------|
77+
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
78+
79+
#### {% linkable_title Service `vacuum/clean_spot` %}
80+
81+
Tell the vacuum cleaner to do a spot clean-up.
7482

7583
| Service data attribute | Optional | Description |
7684
|---------------------------|----------|-------------------------------------------------------|

source/_components/vacuum.xiaomi.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ sharing: true
99
footer: true
1010
logo: xiaomi.png
1111
ha_category: Hub
12-
ha_release: 0.50
12+
ha_release: 0.51
1313
---
1414

1515
The `xiaomi` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/).
1616

17-
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.
17+
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.
1818

1919
## {% linkable_title Getting started %}
2020

@@ -23,7 +23,7 @@ Follow the pairing process using your phone and Mi-Home app. From here you will
2323
<p class='note warning'>
2424
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>
2525

26-
```bash
26+
```bash
2727
$ sudo su -s /bin/bash homeassistant
2828
$ source /srv/homeassistant/bin/activate
2929
```
@@ -41,7 +41,7 @@ In order to fetch the token follow these instructions depending on your mobile p
4141
5. If you have this message : "More than one device or emulator", use this command to list all devices:
4242
```bash
4343
.\adb devices
44-
```
44+
```
4545
and execute this command:
4646
```bash
4747
.\adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command)

0 commit comments

Comments
 (0)