Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.xiaomi_miio.vacuum Namespace Reference

Classes

class  MiroboVacuum
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_ERROR = "error"
 
string ATTR_RC_DURATION = "duration"
 
string ATTR_RC_ROTATION = "rotation"
 
string ATTR_RC_VELOCITY = "velocity"
 
string ATTR_STATUS = "status"
 
string ATTR_TIMERS = "timers"
 
string ATTR_ZONE_ARRAY = "zone"
 
string ATTR_ZONE_REPEATER = "repeats"
 
dictionary STATE_CODE_TO_STATE
 

Detailed Description

Support for the Xiaomi vacuum cleaner robot.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.xiaomi_miio.vacuum.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the Xiaomi vacuum cleaner robot from a config entry.

Definition at line 84 of file vacuum.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.xiaomi_miio.vacuum._LOGGER = logging.getLogger(__name__)
private

Definition at line 46 of file vacuum.py.

◆ ATTR_ERROR

string homeassistant.components.xiaomi_miio.vacuum.ATTR_ERROR = "error"

Definition at line 48 of file vacuum.py.

◆ ATTR_RC_DURATION

string homeassistant.components.xiaomi_miio.vacuum.ATTR_RC_DURATION = "duration"

Definition at line 49 of file vacuum.py.

◆ ATTR_RC_ROTATION

string homeassistant.components.xiaomi_miio.vacuum.ATTR_RC_ROTATION = "rotation"

Definition at line 50 of file vacuum.py.

◆ ATTR_RC_VELOCITY

string homeassistant.components.xiaomi_miio.vacuum.ATTR_RC_VELOCITY = "velocity"

Definition at line 51 of file vacuum.py.

◆ ATTR_STATUS

string homeassistant.components.xiaomi_miio.vacuum.ATTR_STATUS = "status"

Definition at line 52 of file vacuum.py.

◆ ATTR_TIMERS

string homeassistant.components.xiaomi_miio.vacuum.ATTR_TIMERS = "timers"

Definition at line 55 of file vacuum.py.

◆ ATTR_ZONE_ARRAY

string homeassistant.components.xiaomi_miio.vacuum.ATTR_ZONE_ARRAY = "zone"

Definition at line 53 of file vacuum.py.

◆ ATTR_ZONE_REPEATER

string homeassistant.components.xiaomi_miio.vacuum.ATTR_ZONE_REPEATER = "repeats"

Definition at line 54 of file vacuum.py.

◆ STATE_CODE_TO_STATE

dictionary homeassistant.components.xiaomi_miio.vacuum.STATE_CODE_TO_STATE
Initial value:
1 = {
2  1: STATE_IDLE, # "Starting"
3  2: STATE_IDLE, # "Charger disconnected"
4  3: STATE_IDLE, # "Idle"
5  4: STATE_CLEANING, # "Remote control active"
6  5: STATE_CLEANING, # "Cleaning"
7  6: STATE_RETURNING, # "Returning home"
8  7: STATE_CLEANING, # "Manual mode"
9  8: STATE_DOCKED, # "Charging"
10  9: STATE_ERROR, # "Charging problem"
11  10: STATE_PAUSED, # "Paused"
12  11: STATE_CLEANING, # "Spot cleaning"
13  12: STATE_ERROR, # "Error"
14  13: STATE_IDLE, # "Shutting down"
15  14: STATE_DOCKED, # "Updating"
16  15: STATE_RETURNING, # "Docking"
17  16: STATE_CLEANING, # "Going to target"
18  17: STATE_CLEANING, # "Zoned cleaning"
19  18: STATE_CLEANING, # "Segment cleaning"
20  22: STATE_DOCKED, # "Emptying the bin" on s7+
21  23: STATE_DOCKED, # "Washing the mop" on s7maxV
22  26: STATE_RETURNING, # "Going to wash the mop" on s7maxV
23  100: STATE_DOCKED, # "Charging complete"
24  101: STATE_ERROR, # "Device offline"
25 }

Definition at line 57 of file vacuum.py.