Ранее рассказывал об опыте покупки и использования этого пылесоса. Я, естественно, не удовлетворился функционалом родного приложения mihome и захотел интегрировать этот пылесос в Home assistant.
К сожалению, на момент написания статьи штатная интеграция в Home Assistant не поддерживает данную модель пылесоса, поэтому пришлось искать альтернативы. Одно время в качестве альтернативы я рассматривал перепрошивку пылесоса на альтернативную прошивка Valetudo, но на данный момент нашел и использую другую интеграцию, без необходимости перепрошивки пылесоса.
Итак, в HACS была найдена интеграция
На данный момент автор ушел больше в поддержки европейской версии пылесоса, где были убраны “лишние” атрибуты, например, статистика расходных материалов.
После того, как это обновление произошло, я просто откатился назад и больше не обновляю эту интеграцию, сейчас все работает шикарно. В качестве альтернативы есть другая ветка развития данного репозитория
Итак, приступим. Установив данную интеграцию, в Файл configuration.yaml добавляем следующее содержание
Токен устройства можно взять из приложения mihome от kapiba.ru. Заходим в настройки пылесоса – Общие настройки – Дополнительные настройки – Информация о сети. В самом низу будет токен. Далее перезагружаем сервер, теперь нам доступен пылесос.
Карточка самого пылесоса содержит просто кучу атрибутов, что может быть удобно для использования в уведомлениях и автоматизациях.
Теперь необходимо научиться отправлять пылесос убирать отдельные комнаты. Я долго искал способ для этого пылесоса, но все же нашел его. Мне очень помогло это видео для понимания новой системы координатов в данном пылесосе. Если кратко – за точку отсчета берется док-станция пылесоса, она имеет координаты 0.0.0.0. Далее необходимо определить расстояние от док станции до границ уборки. Расстояние в данном случае в метрах.
Подобрать идеальные координаты с первого раза может не получится, но попыток у вас неограниченное число.
При вызове сервиса с координатами в приложении можно будет увидеть очерченный прямоугольник зоны для уборки, на него можно ориентироваться при дальнейшем подборе координат.
Я вынес скрипты и автоматизации пылесоса в отдельный package, вот таким образом выглядят скрипты.
Для отображения я воспользовался картой
После настройки она выглядит следующим образом:
Подписывайтесь на мой канал и страницу в инстаграм @smart.home53, чтобы не пропустить новые статьи.
#умный дом #smart home #home assistant #xiaomi #робот пылесос #интернет вещей #iot #технологии
После приобретения пылесоса Xiaomi Robot Vacuum MOP C2 Robot Cleaner оказалось, что он произведен для региона Сингапур. Отказался регистрироваться в приложении Mi Home в регионах Китай и Россия. Что, собственно, меня не очень устроило. Пользоваться кнопками на корпусе пылесоса тоже не очень интересно, тем более, что поселили мы его под шкафом. Сами понимаете, что залазить под шкаф для активации уборки не очень удобно. В итоге решил поискать возможности интеграции данного пылесоса в систему, уже имеющегося у меня “умного дома” на базе Home Assistant (НА). НА у меня уже около года, начал использовать его после того, как перестали приходить уведомления от датчиков протечки Aqara в Mi Home. Вернее приходить как им вздумается. Поиски решения этой проблемы привели меня к локальной системе управления умного дома. Выбор пал на НА, потому что прочитал, что есть кастомная интеграция Xiaomi Gateway 3 for Home Assistant для которой не нужно перепрошивать хаб Xiaomi Gateway (EU). Но и управлять пылесосом только из интерфейса НА мне тоже не очень хотелось, поэтому решил для управления использовать telegram_bot Home Assistant.
Задача поставлена – организовать основные кнопки управления в telegram (старт, стоп, пауза) и, раз уж пылесос может строить карты, сделать выбор помещений для уборки. Для подключения пылесоса к НА использовал интеграцию Xiaomi Miot For HomeAssistant. Подключить его не составило труда, в итоге стало доступно 1 устройство (собственно сам пылесос) и 10 объектов (сенсоров). По поиску в гугле пришел на статью Аз Алексея (AlexAz),где как раз было написано как подключить пылесос и, главное, как сделать автоматизацию зональной уборки с выбором помещений. Опыт написания конфигов в yaml у меня не большой, поэтому изначально взяв примеры из статьи, я их адаптировал к моей задаче, управлению уборкой через telegram.Примечание: для понимания структуры папок и файлов в НА привожу пример конфигурации как сделано у меня.
scene: !include scenes.yaml
telegram_bot: !include includes/telegram.yaml
notify: !include includes/notify.yaml
input_number: !include includes/input_number.yaml
input_text: !include includes/input_text.yaml
input_datetime: !include includes/input_datetime.yaml
input_boolean: !include includes/input_boolean.yaml
group: !include includes/groups.yaml
script: !include_dir_merge_named includes/script
sensor: !include_dir_merge_list includes/sensor
automation: !include_dir_merge_list includes/automationtemplate: !include_dir_merge_list includes/templates
Сначала я так же, как в упомянутой статье, создал для каждой комнаты input boolean, и объединил их в группу:
initial: false
is_hallway_vacuum_manual:
name: manual cleaning the hallway with a vacuum cleaner
initial: false
is_childrensroom_vacuum_manual:
name: manual cleaning the childrensroom with a vacuum cleaner
initial: false
is_kitchen_vacuum_manual:
name: manual cleaning the kitchen with a vacuum cleaner
initial: false
initial: false
entities:
- input_boolean.is_kitchen_vacuum_manual
- input_boolean.is_hallway_vacuum_manual
- input_boolean.is_bedroom_vacuum_manual
- input_boolean.is_childrensroom_vacuum_manual
Затем создал два сенсора
unique_id: "Выбранные комнаты для ручной уборки пылесосом, скрипт"
state: >
{%-
set dfg = expand('group.all_rooms_for_manual_vacuum_clean') | selectattr('state', 'eq', 'on')
| map(attribute='entity_id') | list | join(',')
| replace('input_boolean.is_hallway_vacuum_manual','[1,1,1,0,1]')
| replace('input_boolean.is_childrensroom_vacuum_manual','[2,1,1,0,1]')
| replace('input_boolean.is_kitchen_vacuum_manual','[3,1,1,0,1]')
| replace('input_boolean.is_bedroom_vacuum_manual','[4,1,1,0,1]')
%}
{{dfg}}
- name: "select_friendly_name_rooms_for_manual_clean"
unique_id: "Выбранные комнаты для ручной уборки пылесосом, дисплей"
state: >
{%-
set dfg = expand('group.all_rooms_for_manual_vacuum_clean') | selectattr('state', 'eq', 'on')
| map(attribute='entity_id') | list | join(', ')
| replace('input_boolean.is_hallway_vacuum_manual','Прихожая')
| replace('input_boolean.is_childrensroom_vacuum_manual','Детская')
| replace('input_boolean.is_kitchen_vacuum_manual','Кухня')
| replace('input_boolean.is_bedroom_vacuum_manual','Спальня')
%}
[ {{ dfg }} ]
Написал автоматизацию выбора помещений для уборки в telegram:
alias: ctrl_panels_rooms_4_manual_zone_cleaning_vacuum
initial_state: true
trigger:
- platform: event
event_type: telegram_callback
event_data:
data: '/roomCleaning'
action:
- service: telegram_bot.send_message
data_template:
message_id: 'last'
chat_id: '{{ trigger.event.data.chat_id }}'
title: '{{ "U0001F916" }} Робот пылесос сообщает:'
data:
message: |
- Выберите помещения для зональной уборки:
inline_keyboard: &ctrlBtnRooms
[
[
["{{
'☑️' if bool(states('input_boolean.is_kitchen_vacuum_manual'), false) else '⬜️'
}} Кухня", "/rooms is_kitchen_vacuum_manual"],
["{{
'☑️' if bool(states('input_boolean.is_hallway_vacuum_manual'), false) else '⬜️'
}} Прихожая", "/rooms is_hallway_vacuum_manual"]
],
[
["{{
'☑️' if bool(states('input_boolean.is_bedroom_vacuum_manual'), false) else '⬜️'
}} Спальня", "/rooms is_bedroom_vacuum_manual"],
["{{
'☑️' if bool(states('input_boolean.is_childrensroom_vacuum_manual'), false) else '⬜️'
}} Детская", "/rooms is_childrensroom_vacuum_manual"]
],
[
["️ Начать уборку", "/startManualClean"]
],
[
["{{ 'U0001F916' }} Управ. пылесосом", "/controlPanelVacuum"],
["{{ 'u21a9ufe0f' }} Глав. панель управ.", "/start"]
]
]
- id: Клавиатура отметки выбора помещений для ручной зональной уборки
alias: ctrl_panels_ONOFF_rooms_4_manual_zone_cleaning_vacuum
initial_state: true
trigger:
- platform: event
event_type: telegram_callback
event_data:
command: '/rooms'
action:
- service: script.mark_unmark_selected_rooms_in_the_list
data:
bool_name: "{{ trigger.event.data['args'][0] }}"
- service: telegram_bot.edit_replymarkup
data:
message_id: 'last'
chat_id: '{{ trigger.event.data.chat_id }}'
inline_keyboard: *ctrlBtnRooms
sequence:
- service: input_boolean.toggle
target:
entity_id: input_boolean.{{ bool_name }}
Вот так это выглядит в telegram
А дальше, собственно, сама автоматизация включения пылесоса по кнопке Начать уборку
alias: manual_zone_cleaning_start_vacuum_cleaner
initial_state: true
trigger:
- platform: event
event_type: telegram_callback
event_data:
data: '/startManualClean'
condition:
- condition: state
entity_id: input_boolean.is_started_manual_zone_cleaning_vacuum
state: "off"
action:
- service: script.turn_on
target:
entity_id: >
{%- if not bool(states('group.all_rooms_for_manual_vacuum_clean'), false) %}
script.message_about_uncomplete_task
{%- else %}
script.zone_autostart_and_message_complete_task
{%- endif %}
data:
variables: >
{%- if not bool(states('group.all_rooms_for_manual_vacuum_clean'), false) %}
{
"command": "Начать уборку помещений немедленно",
"valid_state": "Выбрано одно или несколько помещений для уборки",
"current_state": "Нет выбранных помещений",
"joke": "А счастье было так близко... :=)"
}
{%- else %}
{
"type_clean": "ручная",
"friendly_name_rooms": "{{states('sensor.select_friendly_name_rooms_for_manual_clean')}}",
"bool_name": "is_started_manual_zone_cleaning_vacuum",
"select_rooms": "{{ states('sensor.select_rooms_for_manual_clean') }}"
}
{%- endif %}# Скрипты
# script_alert_fail_task.yaml
message_about_uncomplete_task:
alias: Сообщение о невозможности выполнить задание
sequence:
- service: telegram_bot.send_message
data:
message: |
{{"U0001F916"}} Робот пылесос сообщает:
- Я не могу выполнить команду!
- Для команды [ {{ command }} ] я должен быть в состоянии:
[ {{ valid_state }} ]
- А я сейчас в состоянии:
[ {{ current_state }} ]
=================
- {{ joke }}
[ {{ states('sensor.time_date') }} ]
inline_keyboard:
- '{{ "U0001F52E" }} Узнать как дела у пылесоса:/reportStateVacuum'
- '{{ "U0001F916" }} Панель управления пылесосом:/controlPanelVacuum'
Пример вывода сообщения в telegram о начале уборки
Пример вывода сообщения о невозможности начать уборку
Собственно, этого кода достаточно для выполнения поставленной задачи. Вынесение некоторых операций в отдельные скрипты оправдано тем, что я их переиспользую в других задачах (уборка по расписанию, уборка по кнопке из браузера и тп.), ничего не мешает их встроить в автоматизации. Листинг некоторых скриптов я не показал, так как они решают задачи выходящие за рамки данной статьи. Если интересно, расскажу о них в следующих статьях.
В данном уроке рассмотрим процесс добавления робота-пылесоса Xiaomi Vacuum Cleaner 1C в Home Assistant. И первое, что для этого потребуется – получить токен устройства. Проще всего это сделать установив модифицированный Mi Home от Vevs (подходит только для Android смартфонов). В данном способе найти токен в Mi Home можно зайдя в плагин устройства и перейдя по пути ‘’дополнительные настройки” – “информация о сети”.
Для добавления пылесоса в Home Assistant требуется установить стороннюю интеграцию. Для этого лучше всего использовать компонент HACS, про установку которого я рассказывал ранее.
Добавление нужной интеграции с помощью HACS выглядит следующим образом:
Если же Вы по какой-то причине не используете HACS, то интеграцию можно установить вручную, скопировав папку (ссылка на нее в пункте 3) xiaomi_vacuum и все находящиеся в ней файлы в папку /config/custom_components (необходимо создать).
Теперь можно добавить Xiaomi 1C в Home Assistant. Для этого достаточно в configuration.yaml прописать:
vacuum: - platform: xiaomi_vacuum host: IP адрес, не забудьте сделать его статическим в роутере token: токен name: VacuumMop
И желательно добавить friendly name в customize.yaml (поменяйте только имя сущности на свое):
#Пылесос vacuum.vacuummop: friendly_name: Пылесос
Далее сохраняем конфигурацию, проверяем ее “настройки –> сервер –> начать проверку” и перезапускаем Home Assistant. После перезагрузки пылесос появится в общем списке объектов.
Добавление карточки робота-пылесоса в Lovelace
Для того, чтобы добавить карточку, переходим в HACS –> Пользовательский интерфейс и нажимаем “Explore & add repositories”.
Находим там Vacuum Card, щелкаем на нее и нажимаем “Установить этот репозиторий в HACS”.
Далее, чтобы не получить ошибку “Custom element doesn’t exist: vacuum-card”, прописываем в configuration.yaml после mode: yaml указал путь до карточки и перезагружаем Home Assistant:
lovelace: mode: yaml resources: - url: /local/community/vacuum-card/vacuum-card.js type: module
Осталось только добавить карточку в Lovelace. Для этого переходим в ui-lovelace.yaml и прописываем туда (entity: меняем на свое):
- title: Уборка icon: mdi:robot-vacuum cards: - type: "custom:vacuum-card" entity: vacuum.vacuummop stats: default: - attribute: filter_life_level unit: '%' subtitle: Фильтр - attribute: side_brush_life_level unit: '%' subtitle: Боковая щетка - attribute: main_brush_life_level unit: '%' subtitle: Основная щетка cleaning: - attribute: cleaned_area unit: м2 subtitle: Убрано - attribute: cleaning_time unit: минут subtitle: Времени прошло
Особо описывать по коду тут нечего, все должно быть понятно. Есть default и cleaning. Первое – что отображается в режиме ожидания, второе – в режиме уборки.
Получилось так:
В карточке есть кнопки запуска уборки, поиска пылесоса и отправки на базу. И вся необходимая информация.
Ссылки на другие уроки по настройке Home Assistant.
Hello, this will be a Home Assistant Xiaomi Vacuum Cleaner integration tutorial. The same method can be applied for several other Xiaomi products like:
- Xiaomi Gateways,
- Xiaomi Air Purifiers,
- Xiaomi IR Remotes,
- Xiaomi WiFi repeaters,
- Xiaomi Smart plugs and more.
For dessert we will create some Home Assistant automations and scripts to control our Xiaomi Robot Vacuum Cleaner locally.
Let’s start…
What this article is about?
This article will not be a Xiaomi Robot Vacuum cleaner review. Instead we will focus on Home Assistant Xiaomi integration by extracting the Xiaomi Access Token that is is needed by Home Assistant to control the Xiaomi Robot Vacuum Cleaner and other devices stated above.
We will also make some Home Assistant automations just as a hint of what is possible when we finish that integration.
What I’m going to use?
As example I’m going to use Xiaomi Mi Robot Vacuum-Mop Pro, which looks like this.
I’m kidding it is this one.
Here are few affiliate links where you can check the best price and shipping for your region if you want to buy the same:
- Xiaomi Robot Vacuum Mop Pro (AliExpress Affiliate 1) 👉 LINK
- Xiaomi Robot Vacuum Mop Pro (AliExpress Affiliate 2) 👉 LINK
- Xiaomi Robot Vacuum Mop Pro (AliExpress Affiliate 3) 👉 LINK
- Xiaomi Robot Vacuum Mop Pro (AliExpress Affiliate 4) 👉 LINK
- Xiaomi Robot Vacuum Mop Pro (Amazon UK Affiliate) 👉 LINK
As I said in the beginning of the article there are a lot of Xiaomi Products that can be integrated almost the same way. Here is the full list:
- Supported Xiaomi Gateway Models – LINK
- Supported Xiaomi Air Purifiers and Humidifiers – LINK
- Supported Xiaomi Philips Light – LINK
- Supported Xiaomi Smart WiFi Socket and Smart Power Strip – LINK
Mi Home mobile App
To complete this tutorial you will need an Access Token and Mi Home mobile app. Now is the best time to add your Xiaomi device to the Mi Home mobile app.
This is easy and straightforward task:
- Download the Mi Home app on your mobile device:
- Mi Home App for iOS 👉 LINK
- Mi Home App for Android 👉 LINK
- Start it!
- Follow the instructions there for the initial device setup.
Xiaomi Access Token
There are several ways to get your Xiaomi Access Token. I will show you some of these methods and the whole idea here is to choose a method that suits you best.
When you get your token by either of the ways you can go directly to the Home Assistant Integration part 👉 LINK
Quick Hint
Some people are saying that if you smash my Newsletter Subscribe button so hard that you receive a confirmation mail, and you actually click on the confirmation link after that – you will get your Xiaomi access token in no time.
Just kidding here, but please consider seriously about subscribing for my newsletter – I won’t spam.
Let’s see the first method of Xiaomi access token extraction.
Extract Xiaomi Access Token – 1st method
You will need pip3 (python package manager) for this method. To check if you already have pip3 – open a Terminal if you are running Linux/macOS or command prompt in Windows and type:
pip3
- If you see an error – Google how to install pip3 on your Operating System.
- If you see the pip3 help screen you can continue forward.
Next step is to get all dependencies by executing:
pip3 install pycryptodome pybase64 requests
You will also need a git client or you can download the Project as ZIP from the GitHub repo and extract the archive on your computer. The result is the same.
This is how you can get the needed files using git client and git clone command:
git clone https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor.git
Enter inside the downloaded/cloned folder:
cd Xiaomi-cloud-tokens-extractor
Start the tool with python:
python3 token_extractor.py
Alternatively you can start the tool using Docker, but you have to have up & running Docker client for that:
docker run --rm -it $(docker build -q .)
After you start the tool either by using Python or Docker you have to enter your Mi Home App credentials.
When the script ask you to choose a server – just Hit Enter and the tool will auto check all Xiaomi servers. At the end you should see all of your Xiaomi devices, their IP’s, models, and most importantly their Tokens. Which is exactly what we need.
Extract Xiaomi Access Token – 2nd method
The second method for Xiaomi Access Token extraction is even easier than the first one, but it’s only working on Windows and macOS.
- Go to https://github.com/Maxmudjon/Get_MiHome_devices_token/releases
- Download and start the Get Mi Home Devices Token App (it is the zip archive)
- Start the App
- Log in with your Mi Home e-mail and password and click Sign in button
You will see a compete list of your Xiaomi Devices and their tokens 🤩
We have the Xiaomi Access Token! Now let’s finish this Home Assistant Xiaomi Vacuum Mop Pro integration.
Again we have two methods for the Home Assistant Xiaomi Vacuum integration:
- Using the xiaomi_miio platform which is embedded in Home Assistant – LINK
- Using a custom component 👉 LINK
The first method is preferred, as there is better chance if it worked once to work for a long time without issues. It all depends of your Xiaomi Device and model here.
Unfortunately, the first method didn’t worked for me (Xiaomi Robot Vacuum Mop P/Pro) and I have to use the second method, which turns out to work flawlessly at least for now.
MY RECOMMENDATION: Start with the first method and only if it is not working for you – go for the second method.
After we finish (regardless of the method) we will be able to give commands to our device like: start, stop, pause, return to base, locate, clean spot, set fan speed and more.
Home Assistant Xiaomi Vacuum integration – 1st method
Open your configuration.yaml file in your Home Assistant config folder and paste the following YAML code inside:
# configuration.yaml entry
vacuum:
- platform: xiaomi_miio
host: 192.168.1.2
token: YOUR_TOKEN
Replace the 192.168.1.2 with your Xiaomi device IP, and YOUR_TOKEN with your real token that you get from the above steps. Save the file and restart the Home Assistant.
After Home Assistant Starts, go to Developer Tools > Services and try to invoke vacuum.start service with your new Xiaomi Entity as shown in the picture below:
If your Xiaomi Robot Vacuum start cleaning, then everything is fine and you can skip method 2 and you can go directly to the Home Assistant Xiaomi vacuum automation part.
Home Assistant Xiaomi Vacuum integration – 2nd method
Do this part only if the Home Assistant Xiaomi Vacuum integration – 1st method didn’t worked for you.
Go to https://github.com/nqkdev/home-assistant-vacuum-styj02ym and download the project as ZIP
Extract the files and copy them under /custom_components/miio2 folder inside your Home Assistant configuration folder. If you don’t have such folders – create them
Then open your configuration.yaml file, remove the vacuum section from the first method if it is still there and and paste the following:
# configuration.yaml entry
vacuum:
- platform: miio2
host: 192.168.1.2
token: YOUR_TOKEN
name: Mi hihi
Replace the 192.168.1.2 with your Xiaomi device IP, and YOUR_TOKEN with your real token that you have from the above steps. Save the file and restart the Home Assistant.
Go to Developer Tools > Services and try to invoke vacuum.start service with your new Xiaomi Entity. If everything is fine, then Xiaomi Robot Vacuum will start cleaning.
Good job 👍
Create a Home Assistant Xiaomi Automation
Let’s create a Home Assistant automation that will start the Xiaomi Robot Vacuum Cleaner when Elvis has left the building.
I’m kidding when a person leave the house.
And as always you can use the Home Assistant Graphical Automations Editor as I’m showing in my video or you can edit the automations.yaml file as I will show here.
Open the automations.yaml file and paste the following YAML lines:
- id: '1613942351983'
alias: Start vacuum when I leave home
description: ''
trigger:
- platform: state
entity_id: person.kiril
from: home
to: not_home
condition: []
action:
- service: vacuum.start
data: {}
entity_id: vacuum.mi_hihi
mode: single
Replace person.kiril with your entity_id that you want to track and vacuum.mi_hihi with your vacuum cleaner entity.
Save the file and reload the automations. Now when person.kiril goes from home to not_home the Xiaomi Robot Vacuum Cleaner will start cleaning automatically.
You can of course add conditions and complications to this automation to make it really useful for your needs.
Reset Xiaomi maintenance hours with Home Assistant
You can reset maintenance hours of the Xiaomi Robot Vacuum Mop Pro using Home Assistant scripts.
This is the link to Home Assistant documentation about how you can do that 👉 LINK
Home Assistant Xiaomi vacuum card
You also can create a card to your Home Assistant Lovelace for your robot vacuum. The author of the card claims that it supports the following brands/models: Xiaomi, Roomba, Neato, Robovac, Valetudo, Ecovacs, Deebot.
And here is the GitHub page and instructions about how you can do that 👉 LINK
Question for You!
My question for you is very simple. Do you have any Xiaomi devices at your home and if yes what exactly?
Let me know in the comments below.
Except the Xiaomi Robot Vacuum Mop Pro I also have 3 Xiaomi Xiaofanng cameras which I mounted at my parents work place and they work just fine.
Support My Work!
If you want to secure this blog existence you can become one of my supporters. You can see exactly how in this section of my site.
I can’t thank enough to all wonderful guys that are supporting my work already – you are amazing!
Any other sort of engagement on this site and my YouTube channel does really help out a lot with the Google & YouTube algorithms, so make sure you:
- Hit the subscribe for my weekly newsletter 🗞
- As well as the Like and Bell buttons 👍🔔
If you are just entering the Smart Home world you could also buy my digital product called: Smart Home – Getting Started Actionable Guide 👉 LINK
Also feel free to add me on Twitter by searching for @KPeyanski. You can find me on my Discord server as well.
Stay safe and don’t forget – Home Smart, But Not Hard!
The vacuum
integration enables the ability to control home cleaning robots within Home Assistant.
Configuration
To use this integration in your installation, add a vacuum
platform to your configuration.yaml
file, like the Xiaomi.
# Example configuration.yaml entry
vacuum:
- platform: xiaomi_miio
name: Living room
host: 192.168.1.2
Component services
Available services: turn_on
, turn_off
, start_pause
, 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.turn_on
Start a new cleaning task. For the Xiaomi Vacuum, Roomba, and Neato use vacuum.start
instead.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.turn_off
Stop the current cleaning task and return to the dock. For the Xiaomi Vacuum, Roomba, and Neato use vacuum.stop
instead.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.start_pause
Start, pause or resume a cleaning task. For the Xiaomi Vacuum, Roomba, and Neato use vacuum.start
and vacuum.pause
instead.
Service data attribute | Optional | Description |
---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
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. |
Help us to improve our documentation
Suggest an edit to this page, or provide/view feedback for this page.