mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-24 02:56:49 +00:00
a4a68172c0
* u-z integrations: apply sentence-style caps to categories * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Add references to glossary terms * Update source/_integrations/universal.markdown Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Update source/_integrations/universal.markdown Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * linter: change vizio to VIZIO - as per product website https://www.vizio.com/en/smartcast * remove term refs from YAML * VIZIO: change spelling according to website - https://www.vizio.com/en/t * Update source/_integrations/vizio.markdown * Update source/_integrations/universal.markdown * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Apply suggestions from code review Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Apply suggestions from code review Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Fix some more to sentence-style caps * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Update source/_integrations/unifiprotect.markdown Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com> Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
4.3 KiB
4.3 KiB
title, description, ha_release, ha_domain, ha_quality_scale, ha_category, ha_codeowners, ha_integration_type
| title | description | ha_release | ha_domain | ha_quality_scale | ha_category | ha_codeowners | ha_integration_type | ||
|---|---|---|---|---|---|---|---|---|---|
| Vacuum | Instructions on how to setup and use vacuums in Home Assistant. | 0.51 | vacuum | internal |
|
|
entity |
The Vacuum {% term integration %} enables the ability to control home cleaning robots within Home Assistant.
{% include integrations/building_block_integration.md %}
Services
Available services: start, pause, stop, return_to_base, locate, clean_spot, set_fan_speed and send_command.
Before calling one of these services, make sure your vacuum platform supports it.
Service vacuum.start
Start or resume a cleaning task.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.pause
Pause a cleaning task.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.stop
Stop the current activity of the vacuum.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.return_to_base
Tell the vacuum to return home.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.locate
Locate the vacuum cleaner robot.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.clean_spot
Tell the vacuum cleaner to do a spot clean-up.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.set_fan_speed
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.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
fan_speed |
no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
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 vacuum. Use entity_id: all to target all. |
command |
no | Command to execute. |
params |
yes | Parameters for the command. |