jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Xiaomi vacuum documentation (#3076)

Browse source 
* move previous work for switch to xiaomi vacuum platform

* add doc for vacuum component and extra services of the xiaomi platform
This commit is contained in:
Eugenio Panadero 2017-08-06 18:05:27 +02:00 • committed by Martin Hjelmare
parent e58b8e7037
commit b8a6688787
3 changed files with 222 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

96
source/_components/vacuum.markdown Normal file
View file

@ -0,0 +1,96 @@
---
layout: page
title: "Vacuum cleaner robots"
description: "Instructions how to setup a botvac in Home Assistant."
date: 2017-07-28 15:00
sidebar: true
comments: false
sharing: true
footer: true
---
The `vacuum` component enables the ability to control home cleaning robots within Home Assistant.
To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi/).
```yaml
# Example configuration.yaml entry
vacuum:
- platform: xiaomi
name: 'name of the robot'
host: 192.168.1.2
token: your-token-here
```
### {% linkable_title Component services %}
Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `set_fanspeed` and `send_command`.
Before calling one of these services, make sure your botvac platform supports it.
#### {% linkable_title Service `vacuum/turn_on` %}
Start a new cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/turn_off` %}
Stop the current cleaning task and return to the dock.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/start_pause` %}
Start, pause or resume a cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/stop` %}
Stop the current activity of the botvac.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/return_to_home` %}
Tell the botvac to return home.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/locate` %}
Start a new cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/set_fanspeed` %}
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number, it depends of the `vacuum` platform.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
| `fanspeed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
#### {% linkable_title Service `vacuum/send_command` %}
Send a platform-specific command to the vacuum cleaner.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
| `command` | no | Command to execute. |
| `params` | yes | Parameters for the command. |