Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2017
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions source/_components/vacuum.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ vacuum:

### {% 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.

Expand Down Expand Up @@ -70,7 +70,15 @@ Tell the botvac to return home.

#### {% 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 |
|---------------------------|----------|-------------------------------------------------------|
Expand Down
8 changes: 4 additions & 4 deletions source/_components/vacuum.xiaomi.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ sharing: true
footer: true
logo: xiaomi.png
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/).

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 %}

Expand All @@ -23,7 +23,7 @@ Follow the pairing process using your phone and Mi-Home app. From here you will
<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>

```bash
```bash
$ sudo su -s /bin/bash homeassistant
$ source /srv/homeassistant/bin/activate
```
Expand All @@ -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:
```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)
Expand Down