miio.integrations.ijai.vacuum.pro2vacuum module

class miio.integrations.ijai.vacuum.pro2vacuum.DeviceState(value)[source]

Bases: Enum

An enumeration.

Charging = 4

GoCharging = 3

Idle = 1

Mopping = 7

Paused = 2

Sleep = 0

Sweeping = 5

SweepingAndMopping = 6

Upgrading = 8

class miio.integrations.ijai.vacuum.pro2vacuum.DoorState(value)[source]

Bases: Enum

An enumeration.

DustBox = 1

Off = 0

TwoInOneWaterVolume = 3

WaterVolume = 2

class miio.integrations.ijai.vacuum.pro2vacuum.FanSpeedMode(value)[source]

Bases: Enum

An enumeration.

EnergySaving = 1

Off = 0

Standard = 2

Turbo = 3

class miio.integrations.ijai.vacuum.pro2vacuum.MopRoute(value)[source]

Bases: Enum

An enumeration.

BowStyle = 0

YStyle = 1

class miio.integrations.ijai.vacuum.pro2vacuum.Pro2Status(data)[source]

Bases: DeviceStatus

Container for status reports from Mi Robot Vacuum-Mop 2 Pro.

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 clean_area: int: Last time clean area(m^2).

property clean_time: timedelta: Last time clean time(mins).

property current_language: str: Current Language.

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: FanSpeedMode: Fan Speed.

property filter_life_level: int: Filter Life Level(%).

property filter_time_left: timedelta: Filter Life Time Left(hours).

property main_brush_life_level: int: Main Brush Life Level(%).

property main_brush_time_left: timedelta: Main Brush Life Time Left(hours).

property mop_life_level: int: Mop Life Level(%).

property mop_state: bool: Mop State.

property mop_time_left: timedelta: Mop Life Time Left(hours).

property side_brush_life_level: int: Side Brush Life Level(%).

property side_brush_time_left: timedelta: Side Brush Life Time Left(hours).

property state: DeviceState: Vacuum Status.

property sweep_mode: SweepMode: Sweep Mode.

property sweep_type: SweepType: Operating Mode.

property water_level: WaterLevel: Water Level.

class miio.integrations.ijai.vacuum.pro2vacuum.Pro2Vacuum(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 Mi Robot Vacuum-Mop 2 Pro (ijai.vacuum.v3).

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.

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

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

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

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]: Go 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: FanSpeedMode)[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() → Pro2Status[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 = ['ijai.vacuum.v3']

timeout = 5

token: str | None

class miio.integrations.ijai.vacuum.pro2vacuum.SweepMode(value)[source]

Bases: Enum

An enumeration.

Mop = 2

Sweep = 0

SweepAndMop = 1

class miio.integrations.ijai.vacuum.pro2vacuum.SweepType(value)[source]

Bases: Enum

An enumeration.

Area = 3

Edge = 2

Explore = 6

Floor = 8

Global = 0

Mop = 1

Point = 4

Remote = 5

Room = 7

class miio.integrations.ijai.vacuum.pro2vacuum.WaterLevel(value)[source]

Bases: Enum

An enumeration.

High = 2

Low = 0

Medium = 1