miio.integrations.viomi.viomidishwasher.viomidishwasher module

class miio.integrations.viomi.viomidishwasher.viomidishwasher.ChildLockStatus(value)

Bases: IntEnum

An enumeration.

Disabled = 0

Enabled = 1

class miio.integrations.viomi.viomidishwasher.viomidishwasher.DoorStatus(value)

Bases: IntEnum

An enumeration.

Closed = 0

Open = 128

class miio.integrations.viomi.viomidishwasher.viomidishwasher.MachineStatus(value)

Bases: IntEnum

An enumeration.

AutoDry = 6

Done = 4

Off = 0

On = 1

Paused = 3

Running = 2

Scheduled = 5

class miio.integrations.viomi.viomidishwasher.viomidishwasher.Program(value)

Bases: IntEnum

An enumeration.

Eco = 1

Glassware = 4

Intensive = 3

Quick = 2

Standard = 0

Sterilize = 7

Unknown = -1

property run_time

class miio.integrations.viomi.viomidishwasher.viomidishwasher.ProgramStatus(value)

Bases: IntEnum

An enumeration.

Drying = 4

Prewash = 1

Rinse = 3

Standby = 0

Unknown = -1

Wash = 2

class miio.integrations.viomi.viomidishwasher.viomidishwasher.SystemStatus(value)

Bases: IntEnum

An enumeration.

HeatingElementError = 2048

InsufficientWaterFlow = 4

InsufficientWaterSoftener = 512

InternalConnectionError = 9

ThermistorError = 32

WaterLeak = 1

class miio.integrations.viomi.viomidishwasher.viomidishwasher.ViomiDishwasher(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)

Bases: Device

Main class representing the dishwasher.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

airrefresh(time: int) → List[str]

Set air refresh interval.

call_action(name: str, params=None)

Call action by name.

cancel_schedule(check_if_on=True) → str

Cancel an existing schedule.

change_setting(name: str, params=None)

Change setting value.

child_lock(status: ChildLockStatus)

Set child lock.

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

Configure the wifi settings.

continue_program() → str

Continue a program.

descriptors() → DescriptorCollection[Descriptor]

Return a collection containing all descriptors for the device.

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.

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

off()

Power off.

on()

Power on.

pause() → str

Pause a program.

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

schedule(time: datetime, program: Program) → str

Schedule a program run.

time defines the time when the program should finish.

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.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

start(program: Program | None) → str

Start a program (with optional program or current).

status() → ViomiDishwasherStatus

Retrieve properties.

stop() → str

Stop a program.

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

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3

supported_models = ['viomi.dishwasher.m02']

timeout = 5

token: str | None

class miio.integrations.viomi.viomidishwasher.viomidishwasher.ViomiDishwasherStatus(data: Dict[str, Any])

Bases: DeviceStatus

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 air_refresh_interval: int

Returns an integer on how often the air in the device should be refreshed.

Todo:

• It’s unknown what the value means. It seems not to be minutes. The default set by the Xiaomi Home app is 8.

property child_lock: bool

Returns the child lock status of the device.

property door_open: bool

Returns True if the door is open.

property errors: List[SystemStatus]

Returns list of errors if detected in the system.

property power: bool

Returns the power status of the device.

property program: Program

Returns the current selected program of the device.

property program_progress: ProgramStatus

Returns the program status of the running program.

property schedule: datetime | None

Returns a datetime when the scheduled program should be finished.

Will always be 0 if nothing is scheduled.

property status: MachineStatus

Returns the machine status of the device.

property system_status_raw: int

Returns the raw status number of the device.

This is in general used to detected:

• Errors in the system.

• If the door is open or not.

property temperature: int

Returns the temperature in degree Celsius as determined by the NTC thermistor.

property time_left: timedelta

Returns the timedelta in seconds of time left of the current program.

Will always be 0 if no program is running.