miio.airqualitymonitor module

exception miio.airqualitymonitor.AirQualityMonitorException[source]

Bases: DeviceException

with_traceback()

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

args
class miio.airqualitymonitor.AirQualityMonitor(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: Device

Xiaomi PM2.5 Air Quality Monitor.

buttons() List[ButtonDescriptor]

Return a list of button-like, clickable actions of the device.

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.

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()[source]

Power off.

on()[source]

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

sensors() Dict[str, SensorDescriptor]

Return sensors.

set_auto_close(auto_close: bool)[source]

Purpose unknown.

set_display_clock(display_clock: bool)[source]

Enable/disable displaying a clock instead the AQI.

set_night_mode(night_mode: bool)[source]

Decrease the brightness of the display.

set_night_time(begin_hour: int, begin_minute: int, end_hour: int, end_minute: int)[source]

Enable night mode daily at bedtime.

settings() Dict[str, SettingDescriptor]

Return list of settings.

status() AirQualityMonitorStatus[source]

Return device status.

switches() Dict[str, SwitchDescriptor]

Return toggleable switches.

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.airmonitor.v1', 'cgllc.airmonitor.b1', 'cgllc.airmonitor.s1']
timeout = 5
class miio.airqualitymonitor.AirQualityMonitorStatus(data)[source]

Bases: DeviceStatus

Container of air quality monitor status.

embed(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 property names, and override the __getattribute__ to lookup attributes in the embedded containers.

sensors() Dict[str, SensorDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

settings() Dict[str, SettingDescriptor]

Return the dict of settings exposed by the status container.

You can use @setting decorator to define sensors inside your status class.

switches() Dict[str, SwitchDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

property aqi: Optional[int]

Air quality index value (0..600).

property battery: Optional[int]

Current battery level (0..100).

property co2: Optional[int]

Return co2 value (400…9999ppm).

property co2e: Optional[int]

Return co2e value (400…9999ppm).

property display_clock: Optional[bool]

Display a clock instead the AQI.

property humidity: Optional[float]

Return humidity value (0…100%).

property is_on: bool

Return True if the device is turned on.

property night_mode: Optional[bool]

Return True if the night mode is on.

property night_time_begin: Optional[str]

Return the begin of the night time.

property night_time_end: Optional[str]

Return the end of the night time.

property pm25: Optional[float]

Return pm2.5 value (0…999μg/m³).

property power: Optional[str]

Current power state.

property sensor_state: Optional[str]

Sensor state.

property temperature: Optional[float]

Return temperature value (-10…50°C).

property tvoc: Optional[int]

Return tvoc value.

property usb_power: Optional[bool]

Return True if the device’s usb is on.