miio.airqualitymonitor_miot module

exception miio.airqualitymonitor_miot.AirQualityMonitorMiotException[source]

Bases: DeviceException

with_traceback()

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

args
class miio.airqualitymonitor_miot.AirQualityMonitorCGDN1(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, mapping: Optional[Dict[str, Dict[str, Any]]] = None)[source]

Bases: MiotDevice

Qingping Air Monitor Lite.

buttons() List[ButtonDescriptor]

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

call_action(name: str, params=None)

Call an action by a name in the mapping.

call_action_by(siid, aiid, params=None)

Call an action.

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.

get_properties_for_mapping(*, max_properties=15) list

Retrieve raw properties based on mapping.

get_property_by(siid: int, piid: int)

Get a single property (siid/piid).

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

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

Set device off duration.

set_display_temperature_unit(unit: DisplayTemperatureUnitCGDN1)[source]

Set display temperature unit.

set_monitoring_frequency_duration(duration)[source]

Set monitoring frequency.

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(siid: int, piid: int, value: Union[int, float, str, bool], value_type: Any = None)

Set a single property (siid/piid) to given value.

value_type can be given to convert the value to wanted type, allowed types are: int, float, bool, str

set_screen_off_duration(duration)[source]

Set screen off duration.

settings() Dict[str, SettingDescriptor]

Return list of settings.

status() AirQualityMonitorCGDN1Status[source]

Retrieve properties.

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.

mapping: Dict[str, Dict[str, Any]]
property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = dict_keys(['cgllc.airm.cgdn1'])
timeout = 5
class miio.airqualitymonitor_miot.AirQualityMonitorCGDN1Status(data)[source]

Bases: DeviceStatus

Container of air quality monitor CGDN1 status.

Example::

{ ‘humidity’: 34, ‘pm25’: 18, ‘pm10’: 21, ‘temperature’: 22.8, ‘co2’: 468, ‘battery’: 37, ‘charging_state’: 0, ‘voltage’: 3564, ‘start_time’: 0, ‘end_time’: 0, ‘monitoring_frequency’: 1, ‘screen_off’: 300, ‘device_off’: 60, ‘temperature_unit’: ‘c’ }

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

Return battery level (0…100%).

property charging_state: ChargingState

Return charging state.

property co2: int

Return co2 value (0…9999ppm).

property device_off: int

Return device off time (0..60 min).

property display_temperature_unit

Return display temperature unit.

property humidity: int

Return humidity value (0…100%).

property monitoring_frequency: int

Return monitoring frequency time (0..600 s).

property pm10: int

Return PM 10 value (0…1000ppm).

property pm25: int

Return PM 2.5 value (0…1000ppm).

property screen_off: int

Return screen off time (0..300 s).

property temperature: float

Return temperature value (-30…100°C).

class miio.airqualitymonitor_miot.ChargingState(value)[source]

Bases: Enum

An enumeration.

Charging = 1
NotChargable = 3
NotCharging = 2
Unplugged = 0
class miio.airqualitymonitor_miot.DeviceOffCGDN1(value)[source]

Bases: Enum

An enumeration.

After15Minutes = 15
After1Hour = 60
After30Minutes = 30
Never = 0
class miio.airqualitymonitor_miot.DisplayTemperatureUnitCGDN1(value)[source]

Bases: Enum

An enumeration.

Celcius = 'c'
Fahrenheit = 'f'
class miio.airqualitymonitor_miot.MonitoringFrequencyCGDN1(value)[source]

Bases: Enum

An enumeration.

Every10Minutes = 600
Every1Minute = 60
Every1Second = 1
Every5Minutes = 300
NotSet = 0
class miio.airqualitymonitor_miot.ScreenOffCGDN1(value)[source]

Bases: Enum

An enumeration.

After15Seconds = 15
After1Minute = 60
After30Seconds = 30
After5Minutes = 300
Never = 0