miio.heater_miot module

exception miio.heater_miot.HeaterMiotException

Bases: miio.exceptions.DeviceException

with_traceback()

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

args

class miio.heater_miot.HeaterMiot(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 Xiaomi Smart Space Heater S (zhimi.heater.mc2) & 1S (zhimi.heater.za2).

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

set_led_brightness(*args, **kwargs)

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(*args, **kwargs)

set_target_temperature(*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.heater.mc2', 'zhimi.heater.za2'])

timeout = 5

token: Optional[str]

class miio.heater_miot.HeaterMiotStatus(data: Dict[str, Any], model: str)

Bases: miio.device.DeviceStatus

Container for status reports from the Xiaomi Smart Space Heater S and 1S.

property buzzer: bool

True if buzzer is turned on, False otherwise.

property child_lock: bool

True if child lock is on, False otherwise.

property delay_off_countdown: int

Countdown until turning off in seconds.

property is_on: bool

True if device is currently on.

property led_brightness: miio.heater_miot.LedBrightness

LED indicator brightness.

property power: str

Power state.

property relative_humidity: Optional[int]

Current relative humidity.

property target_temperature: int

Target temperature.

property temperature: float

Current temperature.

class miio.heater_miot.LedBrightness(value)

Bases: enum.Enum

Note that only Xiaomi Smart Space Heater 1S (zhimi.heater.za2) supports Dim.

Dim = 2

Off = 1

On = 0