miio.airqualitymonitor module¶

exception miio.airqualitymonitor.AirQualityMonitorException[source]¶

Bases: miio.exceptions.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: miio.device.Device

Xiaomi PM2.5 Air Quality Monitor.

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_auto_close(*args, **kwargs)¶

set_display_clock(*args, **kwargs)¶

set_night_mode(*args, **kwargs)¶

set_night_time(*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.airmonitor.v1', 'cgllc.airmonitor.b1', 'cgllc.airmonitor.s1']¶

timeout = 5¶

class miio.airqualitymonitor.AirQualityMonitorStatus(data)[source]¶

Bases: miio.device.DeviceStatus

Container of air quality monitor status.

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.