miio.integrations.vacuum.mijia.g1vacuum module¶

class miio.integrations.vacuum.mijia.g1vacuum.G1ChargeState(value)[source]¶

Bases: enum.Enum

Charging Status.

Charging = 1¶

Discharging = 0¶

FullyCharged = 2¶

class miio.integrations.vacuum.mijia.g1vacuum.G1CleaningSummary(data)[source]¶

Bases: miio.device.DeviceStatus

Container for cleaning summary from Mijia Vacuum G1.

Response (MIoT format) of a Mijia Vacuum G1 (mijia.vacuum.v2)

[: {‘did’: ‘total_clean_area’, ‘siid’: 9, ‘piid’: 3, ‘code’: 0, ‘value’: 0}, {‘did’: ‘total_clean_time’, ‘siid’: 9, ‘piid’: 4, ‘code’: 0, ‘value’: 0}, {‘did’: ‘total_clean_count’, ‘siid’: 9, ‘piid’: 5, ‘code’: 0, ‘value’: 0}

]

property total_clean_area: int¶: Total Area Cleaned in m2.

property total_clean_count: int¶: Total Number of Cleanings.

property total_clean_time: datetime.timedelta¶: Total Cleaning Time.

class miio.integrations.vacuum.mijia.g1vacuum.G1Consumable(value)[source]¶

Bases: enum.Enum

Consumables.

Filter = 'filter_life_level'¶

MainBrush = 'main_brush_life_level'¶

SideBrush = 'side_brush_life_level'¶

class miio.integrations.vacuum.mijia.g1vacuum.G1FanSpeed(value)[source]¶

Bases: enum.Enum

Fan speeds.

High = 3¶

Medium = 2¶

Mute = 0¶

Standard = 1¶

class miio.integrations.vacuum.mijia.g1vacuum.G1Languages(value)[source]¶

Bases: enum.Enum

Languages.

Chinese = 0¶

English = 1¶

class miio.integrations.vacuum.mijia.g1vacuum.G1MopState(value)[source]¶

Bases: enum.Enum

Mop Status.

Off = 0¶

On = 1¶

class miio.integrations.vacuum.mijia.g1vacuum.G1State(value)[source]¶

Bases: enum.Enum

Vacuum Status.

Charging = 5¶

Error = 4¶

GoCharging = 6¶

Idle = 1¶

Paused = 3¶

Sweeping = 2¶

class miio.integrations.vacuum.mijia.g1vacuum.G1Status(data)[source]¶

Bases: miio.device.DeviceStatus

Container for status reports from Mijia Vacuum G1.

property battery: int¶: Battery Level.

property charge_state: miio.integrations.vacuum.mijia.g1vacuum.G1ChargeState¶: Charging State.

property clean_area: int¶: Clean Area in cm2.

property clean_time: datetime.timedelta¶: Clean time.

property error: str¶: Human readable error description, see also error_code().

property error_code: int¶: Error code as returned by the device.

property fan_speed: miio.integrations.vacuum.mijia.g1vacuum.G1FanSpeed¶: Fan Speed.

property filter_life_level: int¶: Filter Life Level in %.

property filter_time_left: datetime.timedelta¶: Filter remaining time.

property main_brush_life_level: int¶: Main Brush Life Level in %.

property main_brush_time_left: datetime.timedelta¶: Main Brush Remaining Time in Minutes.

property mop_state: miio.integrations.vacuum.mijia.g1vacuum.G1MopState¶: Mop State.

property operating_mode: miio.integrations.vacuum.mijia.g1vacuum.G1VacuumMode¶: Operating Mode.

property side_brush_life_level: int¶: Side Brush Life Level in %.

property side_brush_time_left: datetime.timedelta¶: Side Brush Remaining Time in Minutes.

property state: miio.integrations.vacuum.mijia.g1vacuum.G1State¶: Vacuum Status.

property water_level: miio.integrations.vacuum.mijia.g1vacuum.G1WaterLevel¶: Water Level.

class miio.integrations.vacuum.mijia.g1vacuum.G1Vacuum(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: Optional[int] = None, *, model: Optional[str] = None, mapping: Optional[Dict[str, Dict[str, Any]]] = None)[source]¶

Bases: miio.miot_device.MiotDevice, miio.interfaces.vacuuminterface.VacuumInterface

Support for G1 vacuum (G1, mijia.vacuum.v2).

call_action(*args, **kwargs)¶

call_action_by(*args, **kwargs)¶

cleaning_summary(*args, **kwargs)¶

configure_wifi(ssid, password, uid=0, extra_params=None)¶: Configure the wifi settings.

consumable_reset(*args, **kwargs)¶

fan_speed_presets(*args, **kwargs)¶

Return available fan speed presets.

The returned object is a dictionary where the key is user-readable name and the value is input for set_fan_speed_preset().

find(*args, **kwargs)¶

classmethod get_device_group()¶

get_properties(properties, *, property_getter='get_prop', max_properties=None)¶

Request properties in slices based on given max_properties.

This is necessary as some devices have limitation on how many properties can be queried at once.

If max_properties is None, all properties are requested at once.

Parameters

properties (list) – List of properties to query from the device.
max_properties (int) – Number of properties that can be requested at once.

:return List of property values.

get_properties_for_mapping(*, max_properties=15) → list¶: Retrieve raw properties based on mapping.

get_property_by(*args, **kwargs)¶

home(*args, **kwargs)¶: Return vacuum robot to home station/dock.

info(*args, **kwargs)¶

pause()¶

Pause cleaning.

Raises: RuntimeError – if the method is not supported by the device

raw_command(*args, **kwargs)¶

send(command: str, parameters: Optional[Any] = None, retry_count: Optional[int] = None, *, extra_parameters=None) → Any¶

Send a command to the device.

Basic format of the request: {“id”: 1234, “method”: command, “parameters”: parameters}

extra_parameters allows passing elements to the top-level of the request. This is necessary for some devices, such as gateway devices, which expect the sub-device identifier to be on the top-level.

Parameters

command (str) – Command to send
parameters (dict) – Parameters to send
retry_count (int) – How many times to retry on error
extra_parameters (dict) – Extra top-level parameters
model (str) – Force model to avoid autodetection

send_handshake()¶: Send initial handshake to the device.

set_fan_speed(*args, **kwargs)¶

set_fan_speed_preset(*args, **kwargs)¶

Set fan speed preset speed.

Parameters: speed_preset – a value from fan_speed_presets()
Raises: ValueError – for invalid preset value

set_property(property_key: str, value)¶: Sets property value using the existing mapping.

set_property_by(*args, **kwargs)¶

start(*args, **kwargs)¶: Start cleaning.

status(*args, **kwargs)¶

stop(*args, **kwargs)¶: Stop cleaning.

test_properties(*args, **kwargs)¶

update(url: str, md5: str)¶: Start an OTA update.

update_progress() → int¶: Return current update progress [0-100].

update_state()¶: Return current update state.

property device_id: int¶: Return device id (did), if available.

mapping: Dict[str, Dict[str, Any]]¶

property model: str¶: Return device model.

property raw_id: int¶: Return the last used protocol sequence id.

retry_count = 3¶

supported_models = dict_keys(['mijia.vacuum.v1', 'mijia.vacuum.v2'])¶

timeout = 5¶

token: Optional[str]¶

class miio.integrations.vacuum.mijia.g1vacuum.G1VacuumMode(value)[source]¶

Bases: enum.Enum

Vacuum Mode.

GlobalClean = 1¶

SpotClean = 2¶

Wiping = 3¶

class miio.integrations.vacuum.mijia.g1vacuum.G1WaterLevel(value)[source]¶

Bases: enum.Enum

Water Flow Level.

Level1 = 1¶

Level2 = 2¶

Level3 = 3¶