miio.integrations.deerma.humidifier.airhumidifier_jsqs module

class miio.integrations.deerma.humidifier.airhumidifier_jsqs.AirHumidifierJsqs(ip: str | None = None, token: str | None = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: int | None = None, *, model: str | None = None, mapping: Dict[str, Dict[str, Any]] | None = None)[source]

Bases: MiotDevice

Main class representing the air humidifier which uses MIoT protocol.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

call_action_by(siid, aiid, params=None)

Call an action.

call_action_from_mapping(name: str, params=None)

Call an action by a name in the mapping.

change_setting(name: str, params=None)

Change setting value.

configure_wifi(ssid, password, uid=0, extra_params=None)

Configure the wifi settings.

descriptors() → DescriptorCollection[Descriptor]

Return a collection containing all descriptors for the device.

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

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: Any | None = None, retry_count: int | None = 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() → DescriptorCollection[PropertyDescriptor]

Return read-only properties.

set_buzzer(buzzer: bool)[source]

Set buzzer on/off.

set_light(light: bool)[source]

Set led light.

set_mode(mode: OperationMode)[source]

Set working mode.

set_overwet_protect(overwet: bool)[source]

Set overwet mode on/off.

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(siid: int, piid: int, value: int | float | str | bool, *, value_type: Any | None = None, name: str | None = 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_target_humidity(humidity: int)[source]

Set target humidity.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → AirHumidifierJsqsStatus[source]

Retrieve properties.

supports_miot() → bool

Return True if the device supports miot commands.

This requests a single property (siid=1, piid=1) and returns True on success.

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 the device id (did).

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 = ['deerma.humidifier.jsqs', 'deerma.humidifier.jsq5', 'deerma.humidifier.jsq2w']
timeout = 5
token: str | None
class miio.integrations.deerma.humidifier.airhumidifier_jsqs.AirHumidifierJsqsStatus(data: Dict[str, Any])[source]

Bases: DeviceStatus

Container for status reports from the air humidifier.

Xiaomi Mi Smart Humidifer S (deerma.humidifier.[jsqs, jsq5, jsq2w]) response (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': 1},
    {'did': 'target_humidity', 'siid': 2, 'piid': 6, 'code': 0, 'value': 50},
    {'did': 'relative_humidity', 'siid': 3, 'piid': 1, 'code': 0, 'value': 40},
    {'did': 'temperature', 'siid': 3, 'piid': 7, 'code': 0, 'value': 22.7},
    {'did': 'buzzer', 'siid': 5, 'piid': 1, 'code': 0, 'value': False},
    {'did': 'led_light', 'siid': 6, 'piid': 1, 'code': 0, 'value': True},
    {'did': 'water_shortage_fault', 'siid': 7, 'piid': 1, 'code': 0, 'value': False},
    {'did': 'tank_filed', 'siid': 7, 'piid': 2, 'code': 0, 'value': False},
    {'did': 'overwet_protect', 'siid': 7, 'piid': 3, 'code': 0, 'value': False}
]
descriptors() → DescriptorCollection[PropertyDescriptor]

Return the dict of sensors exposed by the status container.

Use @sensor and @setting decorators to define properties.

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

property buzzer: bool | None

Return True if buzzer is on.

property error: int

Return error state.

property is_on: bool

Return True if device is on.

property led_light: bool | None

Return status of the LED.

property mode: OperationMode

Return current operation mode.

property overwet_protect: bool | None

Return True if overwet mode is active.

property power: str

Return power state.

property relative_humidity: int | None

Return current humidity.

property tank_filed: bool | None

Return the tank filed.

property target_humidity: int | None

Return target humidity.

property temperature: float | None

Return current temperature, if available.

property water_shortage_fault: bool | None

Return water shortage fault.

class miio.integrations.deerma.humidifier.airhumidifier_jsqs.OperationMode(value)[source]

Bases: Enum

An enumeration.

Auto = 4
High = 3
Low = 1
Mid = 2