miio.integrations.humidifier.zhimi.airhumidifier_miot module

exception miio.integrations.humidifier.zhimi.airhumidifier_miot.AirHumidifierMiotException

Bases: miio.exceptions.DeviceException

with_traceback()

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

args

class miio.integrations.humidifier.zhimi.airhumidifier_miot.AirHumidifierMiot(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)

Bases: miio.miot_device.MiotDevice

Main class representing the air humidifier which uses MIoT protocol.

call_action(*args, **kwargs)

call_action_by(*args, **kwargs)

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.

get_properties_for_mapping(*, max_properties=15) → list

Retrieve raw properties based on mapping.

get_property_by(*args, **kwargs)

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

set_child_lock(*args, **kwargs)

set_clean_mode(*args, **kwargs)

set_dry(*args, **kwargs)

set_led_brightness(*args, **kwargs)

set_mode(*args, **kwargs)

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(*args, **kwargs)

set_speed(*args, **kwargs)

set_target_humidity(*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.

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(['zhimi.humidifier.ca4'])

timeout = 5

token: Optional[str]

class miio.integrations.humidifier.zhimi.airhumidifier_miot.AirHumidifierMiotStatus(data: Dict[str, Any])

Bases: miio.device.DeviceStatus

Container for status reports from the air humidifier.

Xiaomi Smartmi Evaporation Air Humidifier 2 (zhimi.humidifier.ca4) respone (MIoT format)

[

{‘did’: ‘power’, ‘siid’: 2, ‘piid’: 1, ‘code’: 0, ‘value’: True}, {‘did’: ‘fault’, ‘siid’: 2, ‘piid’: 2, ‘code’: 0, ‘value’: 0}, {‘did’: ‘mode’, ‘siid’: 2, ‘piid’: 5, ‘code’: 0, ‘value’: 0}, {‘did’: ‘target_humidity’, ‘siid’: 2, ‘piid’: 6, ‘code’: 0, ‘value’: 50}, {‘did’: ‘water_level’, ‘siid’: 2, ‘piid’: 7, ‘code’: 0, ‘value’: 127}, {‘did’: ‘dry’, ‘siid’: 2, ‘piid’: 8, ‘code’: 0, ‘value’: False}, {‘did’: ‘use_time’, ‘siid’: 2, ‘piid’: 9, ‘code’: 0, ‘value’: 5140816}, {‘did’: ‘button_pressed’, ‘siid’: 2, ‘piid’: 10, ‘code’: 0, ‘value’: 2}, {‘did’: ‘speed_level’, ‘siid’: 2, ‘piid’: 11, ‘code’: 0, ‘value’: 790}, {‘did’: ‘temperature’, ‘siid’: 3, ‘piid’: 7, ‘code’: 0, ‘value’: 22.7}, {‘did’: ‘fahrenheit’, ‘siid’: 3, ‘piid’: 8, ‘code’: 0, ‘value’: 72.8}, {‘did’: ‘humidity’, ‘siid’: 3, ‘piid’: 9, ‘code’: 0, ‘value’: 39}, {‘did’: ‘buzzer’, ‘siid’: 4, ‘piid’: 1, ‘code’: 0, ‘value’: False}, {‘did’: ‘led_brightness’, ‘siid’: 5, ‘piid’: 2, ‘code’: 0, ‘value’: 2}, {‘did’: ‘child_lock’, ‘siid’: 6, ‘piid’: 1, ‘code’: 0, ‘value’: False}, {‘did’: ‘actual_speed’, ‘siid’: 7, ‘piid’: 1, ‘code’: 0, ‘value’: 0}, {‘did’: ‘power_time’, ‘siid’: 7, ‘piid’: 3, ‘code’: 0, ‘value’: 18520}, {‘did’: ‘clean_mode’, ‘siid’: 7, ‘piid’: 5, ‘code’: 0, ‘value’: True}

]

property actual_speed: int

Return real speed of the motor.

property button_pressed: miio.integrations.humidifier.zhimi.airhumidifier_miot.PressedButton

Return last pressed button.

property buzzer: Optional[bool]

Return True if buzzer is on.

property child_lock: bool

Return True if child lock is on.

property clean_mode: bool

Return True if clean mode is active.

property dry: Optional[bool]

Return True if dry mode is on.

property error: int

Return error state.

property fahrenheit: Optional[float]

Return current temperature in fahrenheit, if available.

property humidity: int

Return current humidity.

property is_on: bool

Return True if device is on.

property led_brightness: Optional[miio.integrations.humidifier.zhimi.airhumidifier_miot.LedBrightness]

Return brightness of the LED.

property mode: miio.integrations.humidifier.zhimi.airhumidifier_miot.OperationMode

Return current operation mode.

property motor_speed: int

Return target speed of the motor.

property power: str

Return power state.

property power_time: int

Return how long the device has been powered in seconds.

property target_humidity: int

Return target humidity.

property temperature: Optional[float]

Return current temperature, if available.

property use_time: int

Return how long the device has been active in seconds.

property water_level: Optional[int]

Return current water level in percent.

If water tank is full, raw water_level value is 120. If water tank is overfilled, raw water_level value is 125.

property water_tank_detached: bool

True if the water tank is detached.

If water tank is detached, water_level is 127.

class miio.integrations.humidifier.zhimi.airhumidifier_miot.LedBrightness(value)

Bases: enum.Enum

An enumeration.

Bright = 2

Dim = 1

Off = 0

class miio.integrations.humidifier.zhimi.airhumidifier_miot.OperationMode(value)

Bases: enum.Enum

An enumeration.

Auto = 0

High = 3

Low = 1

Mid = 2

class miio.integrations.humidifier.zhimi.airhumidifier_miot.PressedButton(value)

Bases: enum.Enum

An enumeration.

Led = 1

No = 0

Power = 2