miio.integrations.vacuum.roborock.vacuum module

exception miio.integrations.vacuum.roborock.vacuum.VacuumException

Bases: miio.exceptions.DeviceException

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

class miio.integrations.vacuum.roborock.vacuum.CarpetCleaningMode(value)

Bases: enum.Enum

Type of carpet cleaning/avoidance.

Avoid = 0

Ignore = 2

Rise = 1

class miio.integrations.vacuum.roborock.vacuum.Consumable(value)

Bases: enum.Enum

An enumeration.

Filter = 'filter_work_time'

MainBrush = 'main_brush_work_time'

SensorDirty = 'sensor_dirty_time'

SideBrush = 'side_brush_work_time'

class miio.integrations.vacuum.roborock.vacuum.DustCollectionMode(value)

Bases: enum.Enum

Auto emptying mode (S7 + S7MAXV only)

Daily = 2

Max = 4

Quick = 1

Smart = 0

Strong = 3

class miio.integrations.vacuum.roborock.vacuum.FanspeedE2(value)

Bases: miio.integrations.vacuum.roborock.vacuum.FanspeedEnum

An enumeration.

Gentle = 41

Medium = 79

Silent = 50

Standard = 68

Turbo = 100

class miio.integrations.vacuum.roborock.vacuum.FanspeedEnum(value)

Bases: enum.Enum

An enumeration.

class miio.integrations.vacuum.roborock.vacuum.FanspeedS7(value)

Bases: miio.integrations.vacuum.roborock.vacuum.FanspeedEnum

An enumeration.

Medium = 103

Silent = 101

Standard = 102

Turbo = 104

class miio.integrations.vacuum.roborock.vacuum.FanspeedS7_Maxv(value)

Bases: miio.integrations.vacuum.roborock.vacuum.FanspeedEnum

An enumeration.

Max = 108

Medium = 103

Silent = 101

Standard = 102

Turbo = 104

class miio.integrations.vacuum.roborock.vacuum.FanspeedV1(value)

Bases: miio.integrations.vacuum.roborock.vacuum.FanspeedEnum

An enumeration.

Medium = 77

Silent = 38

Standard = 60

Turbo = 90

class miio.integrations.vacuum.roborock.vacuum.FanspeedV2(value)

Bases: miio.integrations.vacuum.roborock.vacuum.FanspeedEnum

An enumeration.

Auto = 106

Gentle = 105

Medium = 103

Silent = 101

Standard = 102

Turbo = 104

class miio.integrations.vacuum.roborock.vacuum.FanspeedV3(value)

Bases: miio.integrations.vacuum.roborock.vacuum.FanspeedEnum

An enumeration.

Medium = 75

Silent = 38

Standard = 60

Turbo = 100

class miio.integrations.vacuum.roborock.vacuum.MopIntensity(value)

Bases: enum.Enum

Mop scrub intensity on S7 + S7MAXV.

Close = 200

Intense = 203

Mild = 201

Moderate = 202

class miio.integrations.vacuum.roborock.vacuum.MopMode(value)

Bases: enum.Enum

Mop routing on S7.

Deep = 301

Standard = 300

class miio.integrations.vacuum.roborock.vacuum.RoborockVacuum(ip: str, token: Optional[str] = None, start_id: int = 0, debug: int = 0, *, model=None)

Bases: miio.device.Device, miio.interfaces.vacuuminterface.VacuumInterface

Main class for roborock vacuums (roborock.vacuum.*).

add_timer(*args, **kwargs)

carpet_cleaning_mode(*args, **kwargs)

carpet_mode(*args, **kwargs)

child_lock(*args, **kwargs)

clean_details(*args, **kwargs)

clean_history(*args, **kwargs)

configure_wifi(ssid, password, uid=0, timezone=None)

Configure the wifi settings.

consumable_reset(*args, **kwargs)

consumable_status(*args, **kwargs)

create_nogo_zone(*args, **kwargs)

create_software_barrier(*args, **kwargs)

delete_timer(*args, **kwargs)

disable_dnd(*args, **kwargs)

dnd_status(*args, **kwargs)

dust_collection_mode(*args, **kwargs)

edit_map(*args, **kwargs)

enable_lab_mode(*args, **kwargs)

enable_log_upload()

fan_speed(*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)

fresh_map(*args, **kwargs)

get_backup_maps(*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_room_mapping(*args, **kwargs)

get_segment_status(*args, **kwargs)

goto(*args, **kwargs)

home(*args, **kwargs)

Return vacuum robot to home station/dock.

info(*args, **kwargs)

install_sound(*args, **kwargs)

last_clean_details(*args, **kwargs)

locale(*args, **kwargs)

log_upload_status(*args, **kwargs)

manual_control(*args, **kwargs)

manual_control_once(*args, **kwargs)

manual_start(*args, **kwargs)

manual_stop(*args, **kwargs)

map(*args, **kwargs)

merge_segment()

mop_intensity(*args, **kwargs)

mop_mode(*args, **kwargs)

name_segment()

pause(*args, **kwargs)

Pause cleaning.

Raises

RuntimeError – if the method is not supported by the device

persist_map(*args, **kwargs)

raw_command(*args, **kwargs)

resume_or_start(*args, **kwargs)

resume_segment_clean(*args, **kwargs)

resume_zoned_clean(*args, **kwargs)

segment_clean(*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.

serial_number(*args, **kwargs)

set_carpet_cleaning_mode(*args, **kwargs)

set_carpet_mode(*args, **kwargs)

set_child_lock(*args, **kwargs)

set_dnd(*args, **kwargs)

set_dust_collection(*args, **kwargs)

set_dust_collection_mode(*args, **kwargs)

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_mop_intensity(*args, **kwargs)

set_mop_mode(*args, **kwargs)

set_sound_volume(*args, **kwargs)

set_timezone(new_zone)

Set the timezone.

set_waterflow(*args, **kwargs)

sound_info(*args, **kwargs)

sound_install_progress(*args, **kwargs)

sound_volume(*args, **kwargs)

split_segment()

spot(*args, **kwargs)

start(*args, **kwargs)

Start cleaning.

start_dust_collection(*args, **kwargs)

status(*args, **kwargs)

stop(*args, **kwargs)

Stop cleaning.

stop_dust_collection(*args, **kwargs)

stop_segment_clean(*args, **kwargs)

stop_zoned_clean(*args, **kwargs)

test_properties(*args, **kwargs)

test_sound_volume(*args, **kwargs)

timer(*args, **kwargs)

timezone(*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.

update_timer(*args, **kwargs)

use_backup_map(*args, **kwargs)

waterflow(*args, **kwargs)

zoned_clean(*args, **kwargs)

MANUAL_DURATION_DEFAULT = 1500

MANUAL_ROTATION_MAX = 180

MANUAL_ROTATION_MIN = -180

MANUAL_VELOCITY_MAX = 0.3

MANUAL_VELOCITY_MIN = -0.3

property device_id: int

Return device id (did), if available.

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3

supported_models = ['rockrobo.vacuum.v1', 'roborock.vacuum.s4', 'roborock.vacuum.a19', 'roborock.vacuum.s5', 'roborock.vacuum.s5e', 'roborock.vacuum.s6', 'roborock.vacuum.t6', 'roborock.vacuum.a08', 'roborock.vacuum.a11', 'roborock.vacuum.a14', 'roborock.vacuum.a23', 'roborock.vacuum.a15', 'roborock.vacuum.a27', 'roborock.vacuum.a34', 'roborock.vacuum.a46', 'roborock.vacuum.a10', 'roborock.vacuum.e2', 'roborock.vacuum.m1s', 'roborock.vacuum.c1']

timeout = 5

token: Optional[str]

class miio.integrations.vacuum.roborock.vacuum.TimerState(value)

Bases: enum.Enum

An enumeration.

Off = 'off'

On = 'on'

class miio.integrations.vacuum.roborock.vacuum.WaterFlow(value)

Bases: enum.Enum

Water flow strength on s5 max.

High = 202

Low = 201

Maximum = 203

Minimum = 200