miio.integrations.airpurifier.zhimi.airpurifier_miot module

exception miio.integrations.airpurifier.zhimi.airpurifier_miot.AirPurifierMiotException

Bases: miio.exceptions.DeviceException

with_traceback()

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

args

class miio.integrations.airpurifier.zhimi.airpurifier_miot.AirPurifierMiot(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, mapping: Optional[Dict[str, Dict[str, Any]]] = None)

Bases: miio.miot_device.MiotDevice

Main class representing the air purifier which uses MIoT protocol.

call_action(*args, **kwargs)

call_action_by(*args, **kwargs)

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.

get_properties_for_mapping(*, max_properties=15) → list

Retrieve raw properties based on mapping.

get_property_by(*args, **kwargs)

info(*args, **kwargs)

off(*args, **kwargs)

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

set_anion(*args, **kwargs)

set_buzzer(*args, **kwargs)

set_child_lock(*args, **kwargs)

set_fan_level(*args, **kwargs)

set_favorite_level(*args, **kwargs)

set_favorite_rpm(*args, **kwargs)

set_gestures(*args, **kwargs)

set_led(*args, **kwargs)

set_led_brightness(*args, **kwargs)

set_led_brightness_level(*args, **kwargs)

set_mode(*args, **kwargs)

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(*args, **kwargs)

set_volume(*args, **kwargs)

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.

mapping: Dict[str, Dict[str, Any]]

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3

supported_models = dict_keys(['zhimi.airpurifier.ma4', 'zhimi.airpurifier.mb3', 'zhimi.airpurifier.mb3a', 'zhimi.airpurifier.va1', 'zhimi.airpurifier.vb2', 'zhimi.airpurifier.mb4', 'zhimi.airp.mb4a', 'zhimi.airp.mb5', 'zhimi.airp.va2', 'zhimi.airp.vb4', 'zhimi.airpurifier.rma1', 'zhimi.airp.rmb1', 'zhimi.airpurifier.za1'])

timeout = 5

token: Optional[str]

class miio.integrations.airpurifier.zhimi.airpurifier_miot.AirPurifierMiotStatus(data: Dict[str, Any], model: str)

Bases: miio.device.DeviceStatus

Container for status reports from the air purifier.

Mi Air Purifier 3/3H (zhimi.airpurifier.mb3) response (MIoT format)

[

{‘did’: ‘power’, ‘siid’: 2, ‘piid’: 2, ‘code’: 0, ‘value’: True}, {‘did’: ‘fan_level’, ‘siid’: 2, ‘piid’: 4, ‘code’: 0, ‘value’: 1}, {‘did’: ‘mode’, ‘siid’: 2, ‘piid’: 5, ‘code’: 0, ‘value’: 2}, {‘did’: ‘humidity’, ‘siid’: 3, ‘piid’: 7, ‘code’: 0, ‘value’: 38}, {‘did’: ‘temperature’, ‘siid’: 3, ‘piid’: 8, ‘code’: 0, ‘value’: 22.299999}, {‘did’: ‘aqi’, ‘siid’: 3, ‘piid’: 6, ‘code’: 0, ‘value’: 2}, {‘did’: ‘filter_life_remaining’, ‘siid’: 4, ‘piid’: 3, ‘code’: 0, ‘value’: 45}, {‘did’: ‘filter_hours_used’, ‘siid’: 4, ‘piid’: 5, ‘code’: 0, ‘value’: 1915}, {‘did’: ‘buzzer’, ‘siid’: 5, ‘piid’: 1, ‘code’: 0, ‘value’: False}, {‘did’: ‘buzzer_volume’, ‘siid’: 5, ‘piid’: 2, ‘code’: -4001}, {‘did’: ‘led_brightness’, ‘siid’: 6, ‘piid’: 1, ‘code’: 0, ‘value’: 1}, {‘did’: ‘led’, ‘siid’: 6, ‘piid’: 6, ‘code’: 0, ‘value’: True}, {‘did’: ‘child_lock’, ‘siid’: 7, ‘piid’: 1, ‘code’: 0, ‘value’: False}, {‘did’: ‘favorite_level’, ‘siid’: 10, ‘piid’: 10, ‘code’: 0, ‘value’: 2}, {‘did’: ‘favorite_rpm’, ‘siid’: 10, ‘piid’: 7, ‘code’: 0, ‘value’: 770}, {‘did’: ‘motor_speed’, ‘siid’: 10, ‘piid’: 8, ‘code’: 0, ‘value’: 769}, {‘did’: ‘use_time’, ‘siid’: 12, ‘piid’: 1, ‘code’: 0, ‘value’: 6895800}, {‘did’: ‘purify_volume’, ‘siid’: 13, ‘piid’: 1, ‘code’: 0, ‘value’: 222564}, {‘did’: ‘average_aqi’, ‘siid’: 13, ‘piid’: 2, ‘code’: 0, ‘value’: 2}, {‘did’: ‘filter_rfid_tag’, ‘siid’: 14, ‘piid’: 1, ‘code’: 0, ‘value’: ‘81:6b:3f:32:84:4b:4’}, {‘did’: ‘filter_rfid_product_id’, ‘siid’: 14, ‘piid’: 3, ‘code’: 0, ‘value’: ‘0:0:31:31’}, {‘did’: ‘app_extra’, ‘siid’: 15, ‘piid’: 1, ‘code’: 0, ‘value’: 0}

]

property anion: Optional[bool]

Return whether anion is on.

property aqi: Optional[int]

Air quality index.

property average_aqi: Optional[int]

Average of the air quality index.

property buzzer: Optional[bool]

Return True if buzzer is on.

property buzzer_volume: Optional[int]

Return buzzer volume.

property child_lock: Optional[bool]

Return True if child lock is on.

property fan_level: Optional[int]

Current fan level.

property favorite_level: Optional[int]

Return favorite level, which is used if the mode is favorite.

property favorite_rpm: Optional[int]

Return favorite rpm level.

property filter_hours_used: Optional[int]

How long the filter has been in use.

property filter_left_time: Optional[int]

How many days can the filter still be used.

property filter_life_remaining: Optional[int]

Time until the filter should be changed.

property filter_rfid_product_id: Optional[str]

RFID product ID of installed filter.

property filter_rfid_tag: Optional[str]

RFID tag ID of installed filter.

property filter_type: Optional[miio.integrations.airpurifier.zhimi.airfilter_util.FilterType]

Type of installed filter.

property gestures: Optional[bool]

Return True if gesture control is on.

property humidity: Optional[int]

Current humidity.

property is_on: bool

Return True if device is on.

property led: Optional[bool]

Return True if LED is on.

property led_brightness: Optional[miio.integrations.airpurifier.zhimi.airpurifier_miot.LedBrightness]

Brightness of the LED.

property led_brightness_level: Optional[int]

Return brightness level.

property mode: miio.integrations.airpurifier.zhimi.airpurifier_miot.OperationMode

Current operation mode.

property motor_speed: Optional[int]

Speed of the motor.

property pm10_density: Optional[float]

Current temperature, if available.

property power: str

Power state.

property purify_volume: Optional[int]

The volume of purified air in cubic meter.

property temperature: Optional[float]

Current temperature, if available.

property tvoc: Optional[int]

Current TVOC.

property use_time: Optional[int]

How long the device has been active in seconds.

class miio.integrations.airpurifier.zhimi.airpurifier_miot.LedBrightness(value)

Bases: enum.Enum

An enumeration.

Bright = 0

Dim = 1

Off = 2

class miio.integrations.airpurifier.zhimi.airpurifier_miot.OperationMode(value)

Bases: enum.Enum

An enumeration.

Auto = 0

Fan = 3

Favorite = 2

Silent = 1

Unknown = -1