miio.interfaces package

Module contents

Interfaces API.

class miio.interfaces.VacuumInterface[source]

Bases: object

Vacuum API interface.

abstract fan_speed_presets() → Dict[str, int][source]

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().

abstract home()[source]

Return vacuum robot to home station/dock.

pause()[source]

Pause cleaning.

Raises

RuntimeError – if the method is not supported by the device

abstract set_fan_speed_preset(speed_preset: int) → None[source]

Set fan speed preset speed.

Parameters

speed_preset – a value from fan_speed_presets()

Raises

ValueError – for invalid preset value

abstract start()[source]

Start cleaning.

abstract stop()[source]

Stop cleaning.