ym88659208ym87991671
Устройство vacuum_cleaner | Документация для разработчиков

vacuum_cleaner

Обновлено 20 декабря 2023

Пылесос.

Доступные функции устройства

У устройства могут быть все нижеперечисленные функции или только часть из них. Например, если пылесос не поддерживает разные типы уборки, включать функцию vacuum_cleaner_cleaning_type в описание его модели не нужно.

Для пылесоса обязательно должна быть описана функция online.

ФункцияОбязательная?Описание
battery_percentageУровень заряда батареи
child_lockБлокировка от детей
vacuum_cleaner_cleaning_type

Тип уборки: сухая, влажная, сухая и влажная.

Если пользователь не может управлять типом уборки, например, если он выбирается автоматически, исходя из надетой на пылесос насадки, тип уборки добавлять в модель устройства не нужно

vacuum_cleaner_command

Команда управления: начать уборку, приостановить уборку, вернуться на базу, возобновить уборку.

Если отдана команда уборки vacuum_cleaner_command и при этом не передано, какие программу vacuum_cleaner_program и тип уборки vacuum_cleaner_cleaning_type использовать, умный дом использует программу и тип, которые пользователь выбрал в приложении Салют или на устройстве с ассистентом Салют. Если в приложении или на устройстве ничего не предустановлено, используется программа smart: уборка в автоматическом режиме по алгоритму устройства

vacuum_cleaner_programПрограмма уборки: уборка по периметру, уборка по спирали, уборка всей доступной площади, уборка по случайному маршруту
vacuum_cleaner_statusСтатус устройства: уборка, пауза, возвращение на базу, на базе
online✔︎Доступность устройства: офлайн или онлайн

Пример описания модели пылесоса

Модель описывается в соответствии со структурой model. В примере описан пылесос, который обладает всеми поддерживаемыми функциями.

Кроме того, у модели изменены доступные значения для функции vacuum_cleaner_program (программа уборки): эта модель умеет убирать только по трем программам, программа random_route (случайный маршрут) не поддерживается и исключена.

{
"id": "QWERTY124",
"manufacturer": "Xiaqara",
"model": "SM1123456789",
"hw_version": "3.1",
"sw_version": "5.6",
"description": "Умный пылесос Xiaqara",
"category": "vacuum_cleaner",
"features": [
"battery_percentage",
"child_lock",
"vacuum_cleaner_cleaning_type",
"vacuum_cleaner_command",
"vacuum_cleaner_program",
"vacuum_cleaner_status",
"online",
],
"allowed_values": {
"vacuum_cleaner_program": {
"type": "ENUM",
"enum_values": {
"values": [
"perimeter",
"spot",
"smart",
]
}
}
}
}

Пример описания пылесоса пользователя

Устройство описывается в соответствии со структурой device. В примере нет описания модели пылесоса — считаем, что модели описаны отдельно, поэтому достаточно указать только ID модели (здесь — QWERTY124).

{
"id": "ABCD_004",
"name": "Мой пылесос",
"default_name": "Умный пылесос",
"nicknames": ["Смарт-пылесос", "Управляемый пылесос"],
"home": "Мой дом",
"room": "Гостиная",
"groups": ["Уборка",],
"model_id": "QWERTY124",
"hw_version": "3.1",
"sw_version": "5.6",
"partner_meta": {
"internal-id": 1234,
"specificity": "microchip 2A"
},
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.