miio.interfaces.vacuuminterface module

VacuumInterface is an interface (abstract class) with shared API for all vacuum devices.

class miio.interfaces.vacuuminterface.VacuumInterface

Bases: object

Vacuum API interface.

abstract fan_speed_presets() → Dict[str, int]

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

Return vacuum robot to home station/dock.

pause()

Pause cleaning.

Raises

RuntimeError – if the method is not supported by the device

abstract set_fan_speed_preset(speed_preset: int) → None

Set fan speed preset speed.

Parameters

speed_preset – a value from fan_speed_presets()

Raises

ValueError – for invalid preset value

abstract start()

Start cleaning.

abstract stop()

Stop cleaning.