vacuum_cleaner
Vacuum cleaner.
Available device functions
The device can have all the functions listed below or some of them. E.g. If the vacuum cleaner does not support different types of cleaning, it is not necessary to include the function vacuum_cleaner_cleaning_type in the description of its model.
The online function must be described.
| Function | Mandatory? | Description |
| battery_percentage | Batter charge level | |
| vacuum_cleaner_cleaning_type | Cleaning type: dry, wet, dry and wet. Do not add a cleaning type to a model unless the user can control the cleaning type. For example, if the cleaning type is selected automatically depending on the nozzle used. | |
| vacuum_cleaner_command | Command: start cleaning, pause cleaning, return to base, resume cleaning. If the cleaning command `vacuum_cleaner_command` is used, but the program ([vacuum_cleaner_program](/en/smarthome/c2c/vacuum_cleaner_program)) and cleaning type ([vacuum_cleaner_cleaning_type](/en/smarthome/c2c/vacuum_cleaner_cleaning_type)) are not selected, the Smart Home uses the program and type that the user selected in the Salyut application or on the device with the Salyut assistant. If nothing is preinstalled in the application or on the device, the `smart` program is used: cleaning in automatic mode according to the device’s algorithm. | |
| vacuum_cleaner_program | Cleaning program: perimeter cleaning, spiral cleaning, cleaning of the entire available area, cleaning along a random route | |
| vacuum_cleaner_status | Device status: cleaning, pause, return to dock, docked | |
| online | ✔︎ | Device availability: offline or online |
Vacuum cleaner model description example
The model shall be described in accordance with the model structure. The example describes a vacuum cleaner with all supported functions.
In addition, the model's allowed values for the vacuum_cleaner_program function have been changed: it supports only three cleaning programs. The random_route program is not supported and has been deleted.
{
"id": "QWERTY124",
"manufacturer": "Xiaqara",
"model": "SM1123456789",
"hw_version": "3.1",
"sw_version": "5.6",
"description": "Smart vacuum cleaner 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",
]
}
}
}
}
User's vacuum cleaner description example
The device shall be describe in accordance with the device structure. The example contains no vacuum cleaners model description as we believe that models are described independently and the model ID will be enough (in this case, QWERTY124).
{
"id": "ABCD_004",
"name": "My vacuum cleaner",
"default_name": "Smart vacuum cleaner",
"nicknames": ["Hoover", "Controlled cleaner"],
"home": "My home",
"room": "Living room",
"groups": ["Sweeping",],
"model_id": "QWERTY124",
"hw_version": "3.1",
"sw_version": "5.6",
"partner_meta": {
"internal-id": 1234,
"specificity": "microchip 2A"
},
}