miio.integrations.mijia.vacuum.g1vacuum module

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

Bases: Enum

Charging Status.

Charging = 1

Discharging = 0

FullyCharged = 2

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

Bases: 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}
]

descriptors() → DescriptorCollection[PropertyDescriptor]

Return the dict of sensors exposed by the status container.

Use @sensor and @setting decorators to define properties.

embed(name: str, other: DeviceStatus)

Embed another status container to current one.

This makes it easy to provide a single status response for cases where responses from multiple I/O calls is wanted to provide a simple interface for downstreams.

Internally, this will prepend the name of the other class to the attribute names, and override the __getattribute__ to lookup attributes in the embedded containers.

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

property total_clean_count: int: Total Number of Cleanings.

property total_clean_time: timedelta: Total Cleaning Time.

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

Bases: Enum

Consumables.

Filter = 'filter_life_level'

MainBrush = 'main_brush_life_level'

SideBrush = 'side_brush_life_level'

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

Bases: Enum

Fan speeds.

High = 3

Medium = 2

Mute = 0

Standard = 1

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

Bases: Enum

Languages.

Chinese = 0

English = 1

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

Bases: Enum

Mop Status.

Off = 0

On = 1

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

Bases: Enum

Vacuum Status.

Charging = 5

Error = 4

GoCharging = 6

Idle = 1

Paused = 3

Sweeping = 2

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

Bases: DeviceStatus

Container for status reports from Mijia Vacuum G1.

descriptors() → DescriptorCollection[PropertyDescriptor]

Return the dict of sensors exposed by the status container.

Use @sensor and @setting decorators to define properties.

embed(name: str, other: DeviceStatus)

Embed another status container to current one.

This makes it easy to provide a single status response for cases where responses from multiple I/O calls is wanted to provide a simple interface for downstreams.

Internally, this will prepend the name of the other class to the attribute names, and override the __getattribute__ to lookup attributes in the embedded containers.

property battery: int: Battery Level.

property charge_state: G1ChargeState: Charging State.

property clean_area: int: Clean Area in cm2.

property clean_time: 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: G1FanSpeed: Fan Speed.

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

property filter_time_left: timedelta: Filter remaining time.

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

property main_brush_time_left: timedelta: Main Brush Remaining Time in Minutes.

property mop_state: G1MopState: Mop State.

property operating_mode: G1VacuumMode: Operating Mode.

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

property side_brush_time_left: timedelta: Side Brush Remaining Time in Minutes.

property state: G1State: Vacuum Status.

property water_level: G1WaterLevel: Water Level.

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

Bases: MiotDevice

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

actions() → DescriptorCollection[ActionDescriptor]: Return device actions.

call_action(name: str, params=None): Call action by name.

call_action_by(siid, aiid, params=None): Call an action.

call_action_from_mapping(name: str, params=None): Call an action by a name in the mapping.

change_setting(name: str, params=None): Change setting value.

cleaning_summary() → G1CleaningSummary[source]: Retrieve properties.

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

consumable_reset(consumable: G1Consumable)[source]

Reset consumable information.

CONSUMABLE=main_brush_life_level|side_brush_life_level|filter_life_level

descriptors() → DescriptorCollection[Descriptor]: Return a collection containing all descriptors for the device.

fan_speed_presets() → Dict[str, int][source]: Return available fan speed presets.

find() → None[source]: Find the robot.

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.

Returns:

List of property values.

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

get_property_by(siid: int, piid: int): Get a single property (siid/piid).

home()[source]: Home.

info(*, skip_cache=False) → DeviceInfo

Get (and cache) miIO protocol information from the device.

This includes information about connected wlan network, and hardware and software versions.

Parameters:: bool (skip_cache) – Skip the cache

raw_command(command, parameters)

Send a raw command to the device. This is mostly useful when trying out commands which are not implemented by a given device instance.

Parameters:

command (str) – Command to send
parameters (dict) – Parameters to send

send(command: str, parameters: Any | None = None, retry_count: int | None = 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.

sensors() → DescriptorCollection[PropertyDescriptor]: Return read-only properties.

set_fan_speed(fan_speed: G1FanSpeed)[source]: Set fan speed.

set_fan_speed_preset(speed_preset: int) → None[source]: Set fan speed preset speed.

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

Set a single property (siid/piid) to given value.

value_type can be given to convert the value to wanted type, allowed types are: int, float, bool, str

settings() → DescriptorCollection[PropertyDescriptor]: Return settable properties.

start() → None[source]: Start Cleaning.

status() → G1Status[source]: Retrieve properties.

stop()[source]: Stop Cleaning.

supports_miot() → bool

Return True if the device supports miot commands.

This requests a single property (siid=1, piid=1) and returns True on success.

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 the device id (did).

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 = ['mijia.vacuum.v1', 'mijia.vacuum.v2']

timeout = 5

token: str | None

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

Bases: Enum

Vacuum Mode.

GlobalClean = 1

SpotClean = 2

Wiping = 3

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

Bases: Enum

Water Flow Level.

Level1 = 1

Level2 = 2

Level3 = 3