miio.integrations.zhimi.airpurifier.airpurifier module

class miio.integrations.zhimi.airpurifier.airpurifier.AirPurifier(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 air purifier.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

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.

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

reset_filter()

Resets filter hours used and remaining life.

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_auto_detect(auto_detect: bool)

Set auto detect on/off.

It’s a feature of the AirPurifier V1 & V3

set_buzzer(buzzer: bool)

Set buzzer on/off.

set_child_lock(lock: bool)

Set child lock on/off.

set_extra_features(value: int)

Storage register to enable extra features at the app.

app_extra=1 unlocks a turbo mode supported feature

set_favorite_level(level: int)

Set favorite level.

set_learn_mode(learn_mode: bool)

Set the Learn Mode on/off.

set_led(led: bool)

Turn led on/off.

set_led_brightness(brightness: LedBrightness)

Set led brightness.

set_mode(mode: OperationMode)

Set mode.

set_volume(volume: int)

Set volume of sound notifications [0-100].

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → AirPurifierStatus

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

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3

supported_models = ['zhimi.airpurifier.v1', 'zhimi.airpurifier.v2', 'zhimi.airpurifier.v3', 'zhimi.airpurifier.v5', 'zhimi.airpurifier.v6', 'zhimi.airpurifier.v7', 'zhimi.airpurifier.m1', 'zhimi.airpurifier.m2', 'zhimi.airpurifier.ma1', 'zhimi.airpurifier.ma2', 'zhimi.airpurifier.sa1', 'zhimi.airpurifier.sa2', 'zhimi.airpurifier.mc1', 'zhimi.airpurifier.mc2']

timeout = 5

token: str | None

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

Bases: DeviceStatus

Container for status reports from the air purifier.

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

Air quality index.

property auto_detect: bool | None

Return True if auto detect is enabled.

property average_aqi: int

Average of the air quality index.

property button_pressed: str | None

Last pressed button.

property buzzer: bool | None

Return True if buzzer is on.

property child_lock: bool

Return True if child lock is on.

property extra_features: int | None

property favorite_level: int

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

property filter_hours_used: int

How long the filter has been in use.

property filter_life_remaining: int

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

Current humidity.

property illuminance: int | None

Environment illuminance level in lux [0-200].

Sensor value is updated only when device is turned on.

property is_on: bool

Return True if device is on.

property learn_mode: bool

Return True if Learn Mode is enabled.

property led: bool

Return True if LED is on.

property led_brightness: LedBrightness | None

Brightness of the LED.

property mode: OperationMode

Current operation mode.

property motor2_speed: int | None

Speed of the 2nd motor.

property motor_speed: int

Speed of the motor.

property power: str

Power state.

property purify_volume: int

The volume of purified air in cubic meter.

property sleep_mode: SleepMode | None

Operation mode of the sleep state.

(Idle vs. Silent)

property sleep_mode_learn_count: int | None

property sleep_time: int | None

property temperature: float | None

Current temperature, if available.

property turbo_mode_supported: bool | None

property use_time: int

How long the device has been active in seconds.

property volume: int | None

Volume of sound notifications [0-100].

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

Bases: Enum

An enumeration.

Bright = 0

Dim = 1

Off = 2

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

Bases: Enum

An enumeration.

Auto = 'auto'

Favorite = 'favorite'

High = 'high'

Idle = 'idle'

Low = 'low'

Medium = 'medium'

Silent = 'silent'

Strong = 'strong'

class miio.integrations.zhimi.airpurifier.airpurifier.SleepMode(value)

Bases: Enum

An enumeration.

Idle = 'idle'

Off = 'poweroff'

Silent = 'silent'