miio.integrations.humidifier.zhimi.airhumidifier module

exception miio.integrations.humidifier.zhimi.airhumidifier.AirHumidifierException

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.AirHumidifier(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)

Bases: miio.device.Device

Implementation of Xiaomi Mi Air Humidifier.

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

set_child_lock(*args, **kwargs)

set_dry(*args, **kwargs)

set_led(*args, **kwargs)

set_led_brightness(*args, **kwargs)

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

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3

supported_models = ['zhimi.humidifier.v1', 'zhimi.humidifier.ca1', 'zhimi.humidifier.cb1', 'zhimi.humidifier.cb2']

timeout = 5

token: Optional[str]

class miio.integrations.humidifier.zhimi.airhumidifier.AirHumidifierStatus(data: Dict[str, Any], device_info: miio.deviceinfo.DeviceInfo)

Bases: miio.device.DeviceStatus

Container for status reports from the air humidifier.

property button_pressed: Optional[str]

Last pressed button.

property buzzer: bool

True if buzzer is turned on.

property child_lock: bool

Return True if child lock is on.

property depth: Optional[int]

Return raw value of depth.

property dry: Optional[bool]

Dry mode: The amount of water is not enough to continue to work for about 8 hours.

Return True if dry mode is on if available.

property firmware_version: str

Returns the fw_ver of miIO.info.

For example 1.2.9_5033.

property firmware_version_major: str

property firmware_version_minor: int

property hardware_version: Optional[str]

The hardware version.

property humidity: int

Current humidity.

property is_on: bool

True if device is turned on.

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

LED brightness if available.

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

Operation mode.

Can be either silent, medium or high.

property motor_speed: Optional[int]

Current fan speed.

property power: str

Power state.

property strong_mode_enabled: bool

property target_humidity: int

Target humidity.

Can be either 30, 40, 50, 60, 70, 80 percent.

property temperature: Optional[float]

Current temperature, if available.

property trans_level: Optional[int]

The meaning of the property is unknown.

The property is used to determine the strong mode is enabled on old firmware.

property use_time: Optional[int]

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, depth is 120. If water tank is overfilled, depth is 125.

property water_tank_detached: Optional[bool]

True if the water tank is detached.

If water tank is detached, depth is 127.

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

Bases: enum.Enum

An enumeration.

Bright = 0

Dim = 1

Off = 2

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

Bases: enum.Enum

An enumeration.

Auto = 'auto'

High = 'high'

Medium = 'medium'

Silent = 'silent'

Strong = 'strong'