miio.integrations.dreame.vacuum.dreamevacuum_miot module

Dreame Vacuum.

class miio.integrations.dreame.vacuum.dreamevacuum_miot.ChargingState(value)[source]

Bases: FormattableEnum

An enumeration.

Charging = 1

Charging2 = 4

Discharging = 2

GoCharging = 5

class miio.integrations.dreame.vacuum.dreamevacuum_miot.CleaningModeDreame1C(value)[source]

Bases: FormattableEnum

An enumeration.

Default = 1

Medium = 2

Quiet = 0

Strong = 3

class miio.integrations.dreame.vacuum.dreamevacuum_miot.CleaningModeDreameF9(value)[source]

Bases: FormattableEnum

An enumeration.

Quiet = 0

Standart = 1

Strong = 2

Turbo = 3

class miio.integrations.dreame.vacuum.dreamevacuum_miot.DeviceStatus(value)[source]

Bases: FormattableEnum

An enumeration.

Building = 11

Charging = 6

ChargingComplete = 13

Drying = 8

Error = 4

GoCharging = 5

Idle = 2

Mopping = 7

Paused = 3

ReturningWashing = 10

Sweeping = 1

SweepingAndMopping = 12

Upgrading = 14

Washing = 9

class miio.integrations.dreame.vacuum.dreamevacuum_miot.DreameVacuum(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

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()[source]: Return fan speed.

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

forward(distance: int) → None[source]: Move forward.

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() → None[source]: Return to home.

identify() → None[source]: Locate the device (i am here).

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

play_sound() → None[source]: Play sound.

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

reset_filter_life() → None[source]: Reset filter life.

reset_mainbrush_life() → None[source]: Reset main brush life.

reset_sidebrush_life() → None[source]: Reset side brush life.

rotate(rotatation: int) → None[source]: Rotate vacuum.

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(speed: int)[source]

Set fan speed.

Parameters:: speed (int) – Fan speed to set

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

set_voice(url: str, md5sum: str, size: int, voice_id: str)[source]

Upload voice package.

Parameters:

url (str) – URL or path to language pack
md5sum (str) – MD5 hash for file if URL used
size (int) – File size in bytes if URL used
voice_id (str) – Country code for the selected voice pack. CP=Custom Packet

set_waterflow(value: int)[source]

Set water flow.

Parameters:: value (int) – Water flow value to set

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

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

status() → DreameVacuumStatus[source]: State of the vacuum.

stop() → None[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.

waterflow()[source]: Get water flow setting.

waterflow_presets() → Dict[str, int][source]: Return dictionary containing supported water flow.

MANUAL_DISTANCE_MAX = 300

MANUAL_DISTANCE_MIN = -300

MANUAL_ROTATION_MAX = 120

MANUAL_ROTATION_MIN = -120

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 = ['dreame.vacuum.mc1808', 'dreame.vacuum.p2008', 'dreame.vacuum.p2009', 'dreame.vacuum.p2028', 'dreame.vacuum.p2029', 'dreame.vacuum.r2228o', 'dreame.vacuum.p2041o', 'dreame.vacuum.p2150a', 'dreame.vacuum.p2150o', 'dreame.vacuum.p2036', 'dreame.vacuum.r2205']

timeout = 5

token: str | None

class miio.integrations.dreame.vacuum.dreamevacuum_miot.DreameVacuumStatus(data, model)[source]

Bases: DeviceStatus

Container for status reports from the dreame vacuum.

Dreame vacuum example response:

{
    'battery_level': 100,
    'brush_left_time': 260,
    'brush_left_time2': 200,
    'brush_life_level': 90,
    'brush_life_level2': 90,
    'charging_state': 1,
    'cleaning_area': 22,
    'cleaning_mode': 2,
    'cleaning_time': 17,
    'device_fault': 0,
    'device_status': 6,
    'filter_left_time': 120,
    'filter_life_level': 40,
    'first_clean_time': 1620154830,
    'operating_mode': 6,
    'start_time': '22:00',
    'stop_time': '08:00',
    'timer_enable': True,
    'timezone': 'Europe/Berlin',
    'total_clean_area': 205,
    'total_clean_time': 186,
    'total_clean_times': 21,
    'voice_package': 'DR0',
    'volume': 65,
    'water_box_carriage_status': 0,
    'water_flow': 3
}

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_level: str

property brush_left_time: str

property brush_left_time2: str

property brush_life_level: str

property brush_life_level2: str

property charging_state: ChargingState | None

property cleaning_area: str

property cleaning_mode

property cleaning_time: str

property device_fault: FaultStatus | None

property device_status: DeviceStatus | None

property filter_left_time: str

property filter_life_level: str

property first_clean_time: str

property is_water_box_carriage_attached: bool | None: Return True if water box carriage (mop) is installed, None if sensor not present.

property life_brush_main: str | None

property life_brush_side: str | None

property life_sieve: str | None

property map_view: str

property operating_mode: OperatingMode | None

property start_time: str

property stop_time: str

property timer_enable: str

property timezone: str

property total_clean_area: str

property total_clean_time: str

property total_clean_times: str

property voice_package: str

property volume: str

property water_flow: WaterFlow | None

class miio.integrations.dreame.vacuum.dreamevacuum_miot.FaultStatus(value)[source]

Bases: FormattableEnum

An enumeration.

NoFaults = 0

class miio.integrations.dreame.vacuum.dreamevacuum_miot.FormattableEnum(value)[source]

Bases: Enum

An enumeration.

class miio.integrations.dreame.vacuum.dreamevacuum_miot.OperatingMode(value)[source]

Bases: FormattableEnum

An enumeration.

Charging = 6

Cleaning = 2

GoCharging = 3

ManualCleaning = 13

ManualPaused = 17

Paused = 1

Sleeping = 14

ZonedCleaning = 19

class miio.integrations.dreame.vacuum.dreamevacuum_miot.WaterFlow(value)[source]

Bases: FormattableEnum

An enumeration.

High = 3

Low = 1

Medium = 2