Skip to content

Commit 1a28a24

Browse files
dshokouhidshokouhi
authored
Update vacuum docs to be more generic
Docs kept mentioned `botvac` instead of `vacuum` so they are updated to be more generic. They still tell the user that the services depend on their platform.
1 parent 087dc71 commit 1a28a24

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

‎source/_components/vacuum.markdown

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: "Vacuum cleaner robots"
4-
description: "Instructions on how to setup a botvac in Home Assistant."
4+
description: "Instructions on how to setup and use vacuum's in Home Assistant."
55
date: 2017-07-28 15:00
66
sidebar: true
77
comments: false
@@ -25,71 +25,71 @@ vacuum:
2525
2626
Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`.
2727

28-
Before calling one of these services, make sure your botvac platform supports it.
28+
Before calling one of these services, make sure your vacuum platform supports it.
2929

3030
#### {% linkable_title Service `vacuum.turn_on` %}
3131

3232
Start a new cleaning task.
3333

3434
| Service data attribute | Optional | Description |
3535
|---------------------------|----------|-------------------------------------------------------|
36-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
36+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
3737

3838
#### {% linkable_title Service `vacuum.turn_off` %}
3939

4040
Stop the current cleaning task and return to the dock.
4141

4242
| Service data attribute | Optional | Description |
4343
|---------------------------|----------|-------------------------------------------------------|
44-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
44+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
4545

4646
#### {% linkable_title Service `vacuum.start_pause` %}
4747

4848
Start, pause or resume a cleaning task.
4949

5050
| Service data attribute | Optional | Description |
5151
|---------------------------|----------|-------------------------------------------------------|
52-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
52+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
5353

5454
#### {% linkable_title Service `vacuum.stop` %}
5555

56-
Stop the current activity of the botvac.
56+
Stop the current activity of the vacuum.
5757

5858
| Service data attribute | Optional | Description |
5959
|---------------------------|----------|-------------------------------------------------------|
60-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
60+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
6161

6262
#### {% linkable_title Service `vacuum.return_to_home` %}
6363

64-
Tell the botvac to return home.
64+
Tell the vacuum to return home.
6565

6666
| Service data attribute | Optional | Description |
6767
|---------------------------|----------|-------------------------------------------------------|
68-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
68+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
6969

7070
#### {% linkable_title Service `vacuum.locate` %}
7171

7272
Locate the vacuum cleaner robot.
7373

7474
| Service data attribute | Optional | Description |
7575
|---------------------------|----------|-------------------------------------------------------|
76-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
76+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
7777

7878
#### {% linkable_title Service `vacuum.clean_spot` %}
7979

8080
Tell the vacuum cleaner to do a spot clean-up.
8181

8282
| Service data attribute | Optional | Description |
8383
|---------------------------|----------|-------------------------------------------------------|
84-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
84+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
8585

8686
#### {% linkable_title Service `vacuum.set_fanspeed` %}
8787

88-
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
88+
Set the fan speed of the vacuum. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
8989

9090
| Service data attribute | Optional | Description |
9191
|---------------------------|----------|-------------------------------------------------------|
92-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
92+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
9393
| `fanspeed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
9494

9595
#### {% linkable_title Service `vacuum.send_command` %}
@@ -98,6 +98,6 @@ Send a platform-specific command to the vacuum cleaner.
9898

9999
| Service data attribute | Optional | Description |
100100
|---------------------------|----------|-------------------------------------------------------|
101-
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
101+
| `entity_id` | yes | Only act on specific vacuum. Else targets all. |
102102
| `command` | no | Command to execute. |
103103
| `params` | yes | Parameters for the command. |

0 commit comments

Comments
 (0)