miio.integrations.airdog.airpurifier.airpurifier_airdog module

class miio.integrations.airdog.airpurifier.airpurifier_airdog.AirDogStatus(data: Dict[str, Any])

Bases: DeviceStatus

Container for status reports from the air dog x3.

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 child_lock: bool

Return True if child lock is on.

property clean_filters: bool

True if the display shows “-C-” and the filter must be cleaned.

property hcho: int | None

Return formaldehyde value.

property is_on: bool

True if device is turned on.

property mode: OperationMode

Operation mode.

Can be either auto, manual, sleep.

property pm25: int

Return particulate matter value (0…300μg/m³).

property power: str

Power state.

property speed: int

Current speed level.

class miio.integrations.airdog.airpurifier.airpurifier_airdog.AirDogX3(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

Support for Airdog air purifiers (airdog.airpurifier.x*).

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

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_child_lock(lock: bool)

Set child lock on/off.

set_filters_cleaned()

Set filters cleaned.

set_mode_and_speed(mode: OperationMode, speed: int = 1)

Set mode and speed.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → AirDogStatus

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 = ['airdog.airpurifier.x3', 'airdog.airpurifier.x5', 'airdog.airpurifier.x7sm']

timeout = 5

token: str | None

class miio.integrations.airdog.airpurifier.airpurifier_airdog.OperationMode(value)

Bases: Enum

An enumeration.

Auto = 'auto'

Idle = 'sleep'

Manual = 'manual'

class miio.integrations.airdog.airpurifier.airpurifier_airdog.OperationModeMapping(value)

Bases: Enum

An enumeration.

Auto = 0

Idle = 2

Manual = 1