Skip to content

Entities ​

The integration exposes almost all available settings and states reverse-engineered from the official application. Entities are dynamically generated for each specific device; if a device lacks a particular hardware feature or property, the corresponding entity is not added to Home Assistant.

EntitiesEntities

Most entities, including the main vacuum entity, are provided with dynamic icons that reflect their current state. These icons can be overridden in the entity settings if desired. Additionally, most sensor entities and all select entities return their raw integer value under the raw_value, map_id, or segment_id attributes, which simplifies their use in automations and services.

A dynamic refresh rate is applied to all entities, determined by their expected change frequency and the current device state. Home Assistant is only informed of changes when a property update is detected via listeners, functioning similarly to a local push approach.

State Synchronization Delay

It may take some time for an entity to reflect changes made directly in the official application. This delay is expected when using the Local or Xiaomi Home connection methods, as they rely on periodic data polling rather than the instant cloud push notifications utilized by other connection methods.

Certain entities have custom availability rules tied to the state of other entities, mirroring the logic extracted from the official application. For example, the tight_mopping switch becomes unavailable when a water tank or mop pad is not attached. Cloud-connected entities are also exposed for settings stored within specific map data rather than on the device itself, such as map_rotation.

Entity Availability & Firmware Limitations

Some entities may not be available on devices with older firmware versions, such as customized_cleaning and cleaning_mode. Furthermore, some entities are disabled by default, and others can be accessed directly via the vacuum entity's attributes.

All generated entities follow a standard naming schema:

[domain].[vacuum name]_[entity name] (e.g., switch.l10s_gen2_resume_cleaning)

Switch ​

NameDescriptionNotes
resume_cleaningEnable/Disable resume cleaning featureVacuum entity returns its state as paused before cleaning continues while charging
carpet_boostEnable/Disable carpet boost feature
carpet_recognitionEnable/Disable recognition featureAvailable on vacuums with ultrasonic sensor
obstacle_avoidanceEnable/Disable 3D obstacle avoidanceAvailable on vacuums with line laser
customized_cleaningEnable/Disable customized room cleaningAvailable on devices with firmware above 1056
child_lockEnable/Disable child lock
tight_moppingEnable/Disable tight mopping patternAvailable on devices with firmware above 1056 and unavailable when water tank or mop pad is not installed
dndEnable/Disable do not disturb
multi_floor_mapEnable/Disable multi-floor mapAvailable on vacuums that can store more than one map
auto_dust_collectingEnable/Disable automatic dust collecting when cleaning completedAvailable on vacuums with auto-empty station
self_cleanEnable/Disable automatic self cleaning featureAvailable on vacuums with self-wash base
self_clean_by_zoneAutomatically clean the mop pads after cleaning a specific zoneAvailable on devices with self clean by zone feature
auto_dryingEnable/Disable automatic drying of the mop after the cleaning is completedAvailable on vacuums with self-wash base
water_electrolysisEnable/Disable water electrolysis featureAvailable on vacuums with water electrolysis feature
auto_water_refillingEnable/Disable external water input for self-wash baseAvailable on vacuums with self-wash base and external water input
auto_mount_mopEnable/Disable automatic assembly and disassembly of mop pads according selected cleaning modeAvailable on vacuums with automatic mop assembly feature
carpet_avoidanceAvoid carpets if mop pads are attachedAvailable on vacuums with mop pad lifting feature
auto_add_detergentUse detergent cartridge for cleaning the mop padsAvailable on vacuums with self-wash base and detergent cartridge
auto_chargingAutomatically return to the base station for chargingAvailable on devices with auto charging feature
map_savingMap saving mode setting for VSLAM devicesAvailable on vacuums without lidar navigation
ai_obstacle_detectionEnable/Disable AI obstacle detectionAvailable on S10 and L10s models
ai_obstacle_image_uploadEnable/Disable uploading obstacle picture to cloudAvailable on devices with front camera
ai_obstacle_pictureEnable/Disable obstacle picture displayingAvailable on devices with front camera
ai_pet_detectionEnable/Disable AI pet detectionAvailable on devices with front camera
ai_human_detectionEnable/Disable AI human detectionAvailable on S10 and S10 Pro
ai_furniture_detectionEnable/Disable AI furniture detectionAvailable on devices with front camera
ai_fluid_detectionEnable/Disable AI fluid detectionAvailable on devices with front camera
fill_lightAfter turned on, it will automatically fill light in a poorly lit environment to improve the obstacle avoidance ability and the screen clarity in the videoAvailable on devices with front camera and front light
collision_avoidanceAfter it is turned on, collisions with walls, furniture and obstacles are reduced, and the cleaning efficiency and coverage are slightly reducedAvailable on devices with this feature
stain_avoidanceAfter it is turned on and when a stain is identified, the area is avoided and not cleanedAvailable on devices with AI fluid detection feature
intelligent_recognitionEnable/Disable automatic map switching when multi-floor map is enabledAvailable on devices with WiFi map feature
cleaning_sequenceEnable/Disable custom room cleaning sequenceAvailable with map feature (This is a dynamically created entity and not actually tied to any setting directly. When turned off, the current cleaning order is deleted and regenerated with the default order, or the previous order is restored from memory when turned on again)
voice_assistantEnable/Disable the built-in voice assistant on the vacuumAvailable on devices with voice assistant feature
fuzzy_obstacle_detectionAllow the vacuum to detect and avoid fuzzy or less distinct obstaclesAvailable on devices with AI fuzzy obstacle detection
ai_pet_avoidanceUse AI camera to identify and actively avoid pets while cleaningAvailable on devices with pet detective feature
pet_pictureAutomatically capture pictures of pets encountered during cleaningAvailable on devices with pet detective feature
pet_focused_detectionPrioritize detection of pets and pet-related objectsAvailable on devices with pet furniture feature
floor_direction_cleaningClean along the direction of the floorboards to prevent scratchingAvailable on devices with floor direction cleaning feature
pet_focused_cleaningAdapt cleaning strategy when pets are detectedAvailable on devices with pet detective feature
smart_chargingCalculate the exact amount of battery needed to finish the cleaning job and resumeAvailable on devices with auto charging feature
human_followAllow the vacuum to follow a person using its cameraAvailable on devices with mop pad swing and camera streaming features
max_suction_powerEnable the absolute maximum suction power mode for intensive cleaningAvailable on devices with max suction power feature
smart_dryingAutomatically adjust drying time based on environmental humidityAvailable on devices with smart drying feature
hot_washingUse hot water to wash the mop pads at the base stationAvailable on devices with hot washing but without smart mop washing feature
uv_sterilizationEnable UV light sterilization for the mop or water tankAvailable on devices with UV sterilization feature
camera_light_brightness_autoAutomatically adjust the brightness of the built-in camera fill lightAvailable on devices with camera streaming and fill light features
off_peak_chargingSchedule the vacuum to charge only during off-peak electricity hoursAvailable on devices with off-peak charging feature
mopping_under_furnituresExtend the mop pad to clean thoroughly underneath low furnitureAvailable on devices with mop pad swing plus feature
gap_cleaning_extensionExtend the mop pad into tight gaps and edgesAvailable on devices with mop pad swing plus feature
intensive_carpet_cleaningIncrease suction and adjust cleaning pattern specifically for carpetsAvailable on devices with intensive carpet cleaning feature
large_particles_boostTemporarily boost suction power when large debris is detectedAvailable on devices with large particles boost feature
ultra_clean_modePerform a highly intensive cleaning pass over the entire areaAvailable on devices with ultra clean mode but without smart mop washing feature
streaming_voice_promptEnable voice prompts while the camera stream is activeAvailable on devices with camera streaming feature
clean_carpets_firstPrioritize cleaning carpeted areas before moving to hard floorsAvailable on devices with clean carpets first feature
silent_dryingReduce noise during the mop pad drying processAvailable on devices with silent drying feature
hair_compressionAutomatically compress collected hair in the dustbin to save spaceAvailable on devices with hair compression feature
side_brush_carpet_rotateAdjust side brush rotation behavior when transitioning onto carpetsAvailable on devices with side brush carpet rotate feature
side_reachExtend the side brush for better edge sweepingAvailable on devices with side reach feature
smart_mop_washingDynamically adjust mop washing duration based on how dirty the mop isAvailable on devices with smart mop washing feature
dnd_disable_resume_cleaningPrevent the vacuum from resuming a paused cleaning task during Do Not Disturb hoursAvailable on devices with DND functions
dnd_disable_auto_emptyPrevent the base station from auto-emptying the dustbin during Do Not Disturb hoursAvailable on devices with DND functions
dnd_reduce_volumeLower the vacuum's voice prompt volume during Do Not Disturb hoursAvailable on devices with DND functions
auto_change_mopAutomatically eject and attach different mop pads based on cleaning requirementsAvailable on devices with automatic mop changing feature
lift_chassis_on_carpetLift the vacuum's main chassis to better navigate high-pile carpetsAvailable on devices with chassis lifting on carpet feature
close_roller_cover_on_carpetClose the main roller brush cover to prevent it from getting stuck on carpetsAvailable on devices with roller cover feature
dust_bag_dryingUse hot air to dry the dust bag inside the base stationAvailable on devices with manual dust bag drying feature
ring_light_always_onKeep the vacuum's indicator ring light turned on constantlyAvailable on devices with ring light always on feature
active_suspension_crossingUse active suspension to lift the vacuum over tall thresholds or obstaclesAvailable on devices with active suspension feature
dynamic_obstacle_cleaningDynamically adjust the cleaning path around newly detected obstaclesAvailable on devices with dynamic obstacle cleaning feature
pressurized_cleaningApply downward pressure on the mop pads for better stain removalAvailable on devices with pressurized cleaning feature
lds_stateToggle the lifting state of the LDS (Laser Distance Sensor) moduleAvailable on devices with auto LDS lifting feature
mop_washing_with_detergentAutomatically mix detergent into the water when washing the mop padsAvailable on devices with auto add detergent and mopping with detergent features
mop_extendExtend the mop pads for better edge coverageAvailable on devices with mop extend feature
mopping_with_detergentAutomatically add detergent to the water tank for moppingAvailable on devices with mopping with detergent feature
obstacle_crossingCoordinate wheels and suspension for climbing difficult obstaclesAvailable on devices with obstacle crossing feature

Sensor ​

NameDescriptionNotes
cleaning_timeCleaning duration of last/current cleaning jobUnavailable during fast mapping
mapping_timeMapping duration of current fast mapping jobOnly available when robot is fast mapping
cleaned_areaCleaned area of last/current cleaning jobUnavailable during fast mapping
stateState of the robotThis entity exposes robot states that are not present in Home Assistant natively, such as charging_completed
statusStatus of the robot
relocation_statusRelocation status of the robot
task_statusTask status of the robot
water_tankWater tank status of the robotAvailable on vacuums with water tank
mop_padWater mop pad status of the robotAvailable on vacuums with self-wash base
dust_collectionDust collection availability statusAvailable on vacuums with auto-empty station
auto_empty_statusStatus of auto empty dockAvailable on vacuums with auto-empty station
self_wash_base_statusStatus of self-wash baseAvailable on vacuums with self-wash base
errorFault code description of robotError reporting
charging_statusCharging status of the robot
battery_levelBattery level of the robot
first_cleaning_dateFirst cleaning date
total_cleaning_timeTotal cleaning duration
cleaning_countTotal cleaning times
total_cleaned_areaTotal cleaned area
stream_statusCurrent status of the live camera video stream (e.g., Idle, Streaming)Available on devices with camera streaming feature
drainage_statusCurrent status of the base station's water drainage systemAvailable on devices with water check feature
low_water_warningIndicates if the clean water tank in the base station is running lowAvailable on devices with self-wash base
task_typeThe type of task currently being executed (e.g., Cleaning, Returning, Washing)Available on devices with task type feature
firmware_versionThe current firmware version installed on the vacuum
cleaning_progressThe completion percentage of the current cleaning jobAvailable on devices with cleaning progress feature
drying_progressThe completion percentage of the current mop drying cycleAvailable on devices with self-wash base
dust_bag_drying_statusCurrent state of the dust bag drying process (e.g., Drying, Idle)Available on devices with manual or auto dust bag drying feature
clean_water_tank_statusCurrent status and level of the clean water tank in the base stationAvailable on devices with self-wash base
dirty_water_tank_statusCurrent status and level of the dirty water tank in the base stationAvailable on devices with self-wash base
dust_bag_statusCurrent status of the dust collection bag (e.g., Present, Full, Missing)Available on devices with auto-empty station
detergent_statusCurrent status of the detergent cartridge in the base stationAvailable on devices with self-wash base
hot_water_statusCurrent temperature or status of the hot water heater for mop washingAvailable on devices with hot washing feature
station_drainage_statusCurrent status of the automatic water hookup drainage systemAvailable on devices with drainage feature

Sensor Entities for Consumables ​

Consumable sensor entities are dynamically generated to report the remaining life or time left for various device parts and accessories.

For more info about consumable entities ​

Sensor Entities for Map Map Support ​

Map sensor entities are dynamically generated from saved maps to report map-related states.

For more info about map entities ​

Binary Sensor ​

NameDescriptionNotes
charging_stateIndicates whether the vacuum is currently charging on the base station
roller_cover_statusIndicates if the main roller brush cover is properly installed or closedAvailable on devices with roller cover feature
lds_statusIndicates if the LDS (Laser Distance Sensor) module is in its lifted positionAvailable on devices with auto LDS lifting feature

Number ​

NameDescriptionNotes
volumeVolume level
mop_cleaning_remainderMop cleaning remainder
camera_light_brightnessTarget brightness level of the camera's fill lightAvailable on devices with camera streaming and fill light features
self_clean_areaThe designated area size (in square meters) to clean before returning to wash the mopAvailable on devices with self wash base but without mop clean frequency feature
self_clean_timeThe designated time (in minutes) to clean before returning to wash the mopAvailable on devices with self clean frequency but without mop clean frequency feature
wetness_levelThe target moisture level for the mop pads during moppingAvailable on devices with wetness level feature
drying_timeThe designated duration (in hours) for drying the mop padsAvailable on devices with self wash base and mop clean frequency or long drying time feature
auto_empty_areaThe designated area size to clean before returning to empty the dustbinAvailable on devices with auto empty area and mode features

Time ​

NameDescriptionNotes
dnd_startDo not disturb startUnavailable when do not disturb is disabled
dnd_endDo not disturb endUnavailable when do not disturb is disabled
off_peak_charging_startThe starting time for off-peak electricity chargingAvailable on devices with off-peak charging feature
off_peak_charging_endThe ending time for off-peak electricity chargingAvailable on devices with off-peak charging feature

Button ​

NameDescriptionNotes
start_auto_emptyStart auto-emptyingAvailable on vacuums with auto-empty station
clear_warningClear warningUnavailable when there is no warning to clear
self_cleanManually start/pause mop washingAvailable on vacuums with self-wash base, unavailable when washing is not possible
manual_dryingManually start/stop mop dryingAvailable on vacuums with self-wash base, unavailable when drying is not possible
manual_dust_bag_dryingTrigger or stop the dust bag drying process manuallyAvailable on devices with manual or auto dust bag drying feature
water_tank_drainingTrigger the base station to drain its internal water linesAvailable on devices with drainage feature
base_station_self_repairTrigger the base station's self-diagnosis and repair routineAvailable on devices with self-wash base
start_recleaningCommand the vacuum to restart the previous cleaning job from the beginningAvailable on devices with auto re-cleaning and map features
empty_water_tankCommand the vacuum to completely empty its onboard water tankAvailable on devices with water tank draining feature
base_station_cleaningTrigger the base station's self-cleaning routine for its washboardAvailable on devices with station cleaning feature
reload_shortcutsReload the saved cleaning shortcuts from the vacuumAvailable on devices with shortcuts feature
shortcut_{1-33}Execute a specific saved cleaning shortcutAvailable on devices with shortcuts feature

Button Entities for Consumables ​

Consumable button entities are used to reset the remaining life of device parts and accessories after replacement or cleaning.

For more info about consumable entities ​

Button Entities for Map Map Support ​

Map button entities are used to trigger mapping functions or interact with saved maps.

For more info about map entities ​

Select ​

NameDescriptionNotes
suction_levelSuction level of the vacuumUnavailable if customized cleaning is enabled and the current job is not zone cleaning or spot cleaning
water_volumeWater volume of the vacuumAvailable on vacuums with water tank. Unavailable if customized cleaning is enabled and the current job is not zone cleaning or spot cleaning
mop_pad_humidityHumidity level of the mop padAvailable on vacuums with self-wash base. Unavailable if customized cleaning is enabled and the current job is not zone cleaning or spot cleaning
cleaning_modeCleaning mode of the vacuum (Sweeping, Mopping, Sweeping and mopping)Unavailable during cleaning.
(Options are dynamically generated for vacuums without a liftable mop pad)
carpet_sensitivityCarpet sensitivity of carpet boost featureUnavailable when carpet boost is disabled
auto_empty_frequencyAuto empty frequencyUnavailable when automatic dust collection is disabled or not available
self_clean_areaSelect cleaning area before return to clean the mop padAvailable on vacuums with self-wash base
mop_wash_levelMop cleaning water usage levelAvailable on vacuums with self-wash base and external water input
drying_timeMop drying time in minutesAvailable on vacuums with self-wash base
mopping_typeMopping type for deep or daily cleaningAvailable on vacuums with AI fluid and stain detection feature
wider_corner_coverageFrequency of reversing into corners to clean them with the mop padAvailable on devices without mop pad swing and mop clean frequency features
mop_pad_swingFrequency of swinging the rear of the vacuum to clean edges with the mop padAvailable on devices with mop pad swing but without mop extend feature
voice_assistant_languageThe language spoken by the vacuum's built-in voice assistantAvailable on devices with voice assistant feature
auto_empty_modeThe logic used to determine when the vacuum should auto-empty its dustbinAvailable on devices with auto empty mode feature
cleangeniusEnable automatic intelligence for room cleaning and mopping settingsAvailable on devices with CleanGenius feature
auto_rewashingLogic for deciding if the mop pad needs a second wash based on dirtinessAvailable on devices with auto rewashing feature
auto_recleaningLogic for deciding if heavily soiled areas need a second cleaning passAvailable on devices with auto recleaning feature
cleaning_routeThe navigation pattern used during cleaning (e.g., Standard, Deep, Fast)Available on devices with cleaning route feature
custom_mopping_routeThe navigation pattern specifically used when mopping is enabledAvailable on devices with custom mopping route feature
self_clean_frequencyThe condition (Area, Time, or Room) that triggers a return for mop washingAvailable on devices with self clean frequency feature
mop_clean_frequencyThe specific frequency value based on the chosen self-clean frequency modeAvailable on devices with self-wash base and mop clean frequency features
mop_extend_frequencyThe specific frequency value based on the chosen mop extend modeAvailable on devices with mop extend feature
cleangenius_modeThe intensity level of the CleanGenius automated cleaning modeAvailable on devices with CleanGenius mode feature
washing_modeThe intensity of the mop washing cycle at the base stationAvailable on devices with smart mop washing feature
water_temperatureThe target temperature of the water used for washing mop padsAvailable on devices with water temperature feature
mop_pressureThe amount of downward pressure applied to the mop padsAvailable on devices with mop pressure feature
mop_temperatureThe target temperature of the mop pads during cleaningAvailable on devices with mop temperature feature
low_lying_area_frequencyThe frequency of cleaning specifically under low-lying furnitureAvailable on devices with low lying area frequency feature
scraper_frequencyThe frequency of using the scraper tool (if applicable)Available on devices with scraper frequency feature
battery_charge_levelThe target battery percentage to charge to before resuming a cleaning job
auto_lds_coverageThe coverage setting for lifting the LDS sensor in tight spacesAvailable on devices with auto LDS lifting feature

Select Entities for Rooms Map Support ​

Room select entities are dynamically generated from saved maps and are used to edit customized cleaning settings per room.

For more info about customized cleaning feature ​

Select Entities for Map Map Support ​

Map select entities are used to interact with saved maps.

For more info about map entities ​

Camera Map Support ​

Camera entities are only available when using a cloud connection and are used to render live maps and saved maps.

For more info about camera entities ​