miio.integrations.zhimi.airpurifier.airpurifier_miot module

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

Bases: MiotDevice

Main class representing the air purifier which uses MIoT protocol.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

call_action_by(siid, aiid, params=None)

Call an action.

call_action_from_mapping(name: str, params=None)

Call an action by a name in the mapping.

change_setting(name: str, params=None)

Change setting value.

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

Configure the wifi settings.

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.

get_properties_for_mapping(*, max_properties=15) → list

Retrieve raw properties based on mapping.

get_property_by(siid: int, piid: int)

Get a single property (siid/piid).

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.

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

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.

set_anion(anion: bool)

Set anion on/off.

set_buzzer(buzzer: bool)

Set buzzer on/off.

set_child_lock(lock: bool)

Set child lock on/off.

set_fan_level(level: int)

Set fan level.

set_favorite_level(level: int)

Set the favorite level used when the mode is favorite.

Needs to be between 0 and 14.

set_favorite_rpm(rpm: int)

Set favorite motor speed.

set_gestures(gestures: bool)

Set gestures on/off.

set_led(led: bool)

Turn led on/off.

set_led_brightness(brightness: LedBrightness)

Set led brightness.

set_led_brightness_level(level: int)

Set led brightness level (0..8).

set_mode(mode: OperationMode)

Set mode.

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(siid: int, piid: int, value: int | float | str | bool, *, value_type: Any | None = None, name: str | None = None)

Set a single property (siid/piid) to given value.

value_type can be given to convert the value to wanted type, allowed types are: int, float, bool, str

set_volume(volume: int)

Set buzzer volume.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → AirPurifierMiotStatus

Retrieve properties.

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

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 = ['zhimi.airpurifier.ma4', 'zhimi.airpurifier.mb3', 'zhimi.airpurifier.mb3a', 'zhimi.airp.mb3a', 'zhimi.airpurifier.va1', 'zhimi.airpurifier.vb2', 'zhimi.airpurifier.mb4', 'zhimi.airp.mb4a', 'zhimi.airp.mb5', 'zhimi.airp.mb5a', 'zhimi.airp.va2', 'zhimi.airp.vb4', 'zhimi.airpurifier.rma1', 'zhimi.airp.rmb1', 'zhimi.airpurifier.za1']

timeout = 5

token: str | None

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

Bases: 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}
]

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 anion: bool | None

Return whether anion is on.

property aqi: int | None

Air quality index.

property average_aqi: int | None

Average of the air quality index.

property buzzer: bool | None

Return True if buzzer is on.

property buzzer_volume: int | None

Return buzzer volume.

property child_lock: bool | None

Return True if child lock is on.

property fan_level: int | None

Current fan level.

property favorite_level: int | None

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

property favorite_rpm: int | None

Return favorite rpm level.

property filter_hours_used: int | None

How long the filter has been in use.

property filter_left_time: int | None

How many days can the filter still be used.

property filter_life_remaining: int | None

Time until the filter should be changed.

property filter_rfid_product_id: str | None

RFID product ID of installed filter.

property filter_rfid_tag: str | None

RFID tag ID of installed filter.

property filter_type: FilterType | None

Type of installed filter.

property gestures: bool | None

Return True if gesture control is on.

property humidity: int | None

Current humidity.

property is_on: bool

Return True if device is on.

property led: bool | None

Return True if LED is on.

property led_brightness: LedBrightness | None

Brightness of the LED.

property led_brightness_level: int | None

Return brightness level.

property mode: OperationMode

Current operation mode.

property motor_speed: int | None

Speed of the motor.

property pm10_density: float | None

Current temperature, if available.

property power: str

Power state.

property purify_volume: int | None

The volume of purified air in cubic meter.

property temperature: float | None

Current temperature, if available.

property tvoc: int | None

Current TVOC.

property use_time: int | None

How long the device has been active in seconds.

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

Bases: Enum

An enumeration.

Bright = 0

Dim = 1

Off = 2

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

Bases: Enum

An enumeration.

Auto = 0

Fan = 3

Favorite = 2

Silent = 1

Unknown = -1