miio.waterpurifier_yunmi module¶

class miio.waterpurifier_yunmi.OperationStatus(operation_status: int)[source]¶

Bases: miio.device.DeviceStatus

property errors: List¶

class miio.waterpurifier_yunmi.WaterPurifierYunmi(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: Optional[int] = None, *, model: Optional[str] = None)[source]¶

Bases: miio.device.Device

Main class representing the water purifier (Yunmi model).

configure_wifi(ssid, password, uid=0, extra_params=None)¶: Configure the wifi settings.

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.

info(*args, **kwargs)¶

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

status(*args, **kwargs)¶

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

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 = ['yunmi.waterpuri.lx9', 'yunmi.waterpuri.lx11']¶

timeout = 5¶

token: Optional[str]¶

class miio.waterpurifier_yunmi.WaterPurifierYunmiStatus(data: Dict[str, Any])[source]¶

Bases: miio.device.DeviceStatus

Container for status reports from the water purifier (Yunmi model).

property filter1_flow_remaining: int¶: Filter1 remaining flow in Metric Liter (L).

property filter1_flow_total: int¶: Filter1 total available flow in Metric Liter (L).

property filter1_flow_used: int¶: Filter1 used flow in Metric Liter (L).

property filter1_life_remaining: datetime.timedelta¶: Filter1 remaining time in hours.

property filter1_life_total: datetime.timedelta¶: Filter1 total available time in hours.

property filter1_life_used: datetime.timedelta¶: Filter1 used time in hours.

property filter2_flow_remaining: int¶: Filter2 remaining flow in Metric Liter (L).

property filter2_flow_total: int¶: Filter2 total available flow in Metric Liter (L).

property filter2_flow_used: int¶: Filter2 used flow in Metric Liter (L).

property filter2_life_remaining: datetime.timedelta¶: Filter2 remaining time in hours.

property filter2_life_total: datetime.timedelta¶: Filter2 total available time in hours.

property filter2_life_used: datetime.timedelta¶: Filter2 used time in hours.

property filter3_flow_remaining: int¶: Filter1 remaining flow in Metric Liter (L).

property filter3_flow_total: int¶: Filter3 total available flow in Metric Liter (L).

property filter3_flow_used: int¶: Filter3 used flow in Metric Liter (L).

property filter3_life_remaining: datetime.timedelta¶: Filter3 remaining time in hours.

property filter3_life_total: datetime.timedelta¶: Filter3 total available time in hours.

property filter3_life_used: datetime.timedelta¶: Filter3 used time in hours.

property operation_status: miio.waterpurifier_yunmi.OperationStatus¶: Current operation status.

property rinse: bool¶: True if the device is rinsing.

property tds_in: int¶: TDS value of input water.

property tds_out: int¶: TDS value of output water.

property tds_warn_thd: int¶: TDS warning threshold.

property temperature: int¶: Current water temperature in Celsius.