miio.integrations.airpurifier.zhimi.airpurifier module

exception miio.integrations.airpurifier.zhimi.airpurifier.AirPurifierException

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

Bases: miio.device.Device

Main class representing the air purifier.

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)

off(*args, **kwargs)

on(*args, **kwargs)

raw_command(*args, **kwargs)

reset_filter(*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_auto_detect(*args, **kwargs)

set_buzzer(*args, **kwargs)

set_child_lock(*args, **kwargs)

set_extra_features(*args, **kwargs)

set_favorite_level(*args, **kwargs)

set_learn_mode(*args, **kwargs)

set_led(*args, **kwargs)

set_led_brightness(*args, **kwargs)

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

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: Optional[str]

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

Bases: miio.device.DeviceStatus

Container for status reports from the air purifier.

property aqi: int

Air quality index.

property auto_detect: Optional[bool]

Return True if auto detect is enabled.

property average_aqi: int

Average of the air quality index.

property button_pressed: Optional[str]

Last pressed button.

property buzzer: Optional[bool]

Return True if buzzer is on.

property child_lock: bool

Return True if child lock is on.

property extra_features: Optional[int]

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

Current humidity.

property illuminance: Optional[int]

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: Optional[miio.integrations.airpurifier.zhimi.airpurifier.LedBrightness]

Brightness of the LED.

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

Current operation mode.

property motor2_speed: Optional[int]

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: Optional[miio.integrations.airpurifier.zhimi.airpurifier.SleepMode]

Operation mode of the sleep state.

(Idle vs. Silent)

property sleep_mode_learn_count: Optional[int]

property sleep_time: Optional[int]

property temperature: Optional[float]

Current temperature, if available.

property turbo_mode_supported: Optional[bool]

property use_time: int

How long the device has been active in seconds.

property volume: Optional[int]

Volume of sound notifications [0-100].

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

Bases: enum.Enum

An enumeration.

Bright = 0

Dim = 1

Off = 2

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

Bases: enum.Enum

An enumeration.

Auto = 'auto'

Favorite = 'favorite'

High = 'high'

Idle = 'idle'

Low = 'low'

Medium = 'medium'

Silent = 'silent'

Strong = 'strong'

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

Bases: enum.Enum

An enumeration.

Idle = 'idle'

Off = 'poweroff'

Silent = 'silent'