miio.integrations.airpurifier.airdog.airpurifier_airdog module

exception miio.integrations.airpurifier.airdog.airpurifier_airdog.AirDogException[source]

Bases: miio.exceptions.DeviceException

with_traceback()

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

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

Bases: miio.device.DeviceStatus

Container for status reports from the air dog x3.

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

Return formaldehyde value.

property is_on: bool

True if device is turned on.

property mode: miio.integrations.airpurifier.airdog.airpurifier_airdog.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.airpurifier.airdog.airpurifier_airdog.AirDogX3(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)[source]

Bases: miio.device.Device

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

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)
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_child_lock(*args, **kwargs)
set_filters_cleaned(*args, **kwargs)
set_mode_and_speed(*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 = ['airdog.airpurifier.x3', 'airdog.airpurifier.x5', 'airdog.airpurifier.x7sm']
timeout = 5
token: Optional[str]
class miio.integrations.airpurifier.airdog.airpurifier_airdog.OperationMode(value)[source]

Bases: enum.Enum

An enumeration.

Auto = 'auto'
Idle = 'sleep'
Manual = 'manual'
class miio.integrations.airpurifier.airdog.airpurifier_airdog.OperationModeMapping(value)[source]

Bases: enum.Enum

An enumeration.

Auto = 0
Idle = 2
Manual = 1