miio.heater module

exception miio.heater.HeaterException[source]

Bases: DeviceException

with_traceback()

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

args
class miio.heater.Brightness(value)[source]

Bases: Enum

An enumeration.

Bright = 0
Dim = 1
Off = 2
class miio.heater.Heater(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)[source]

Bases: Device

Main class representing the Smartmi Zhimi Heater.

buttons() List[ButtonDescriptor]

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

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

Configure the wifi settings.

delay_off(seconds: int)[source]

Set delay off seconds.

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.

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: 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_brightness(brightness: Brightness)[source]

Set display brightness.

set_buzzer(buzzer: bool)[source]

Set buzzer on/off.

set_child_lock(lock: bool)[source]

Set child lock on/off.

set_target_temperature(temperature: int)[source]

Set target temperature.

settings() Dict[str, SettingDescriptor]

Return list of settings.

status() HeaterStatus[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.

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = ['zhimi.heater.za1', 'zhimi.elecheater.ma1']
timeout = 5
token: Optional[str]
class miio.heater.HeaterStatus(data: Dict[str, Any])[source]

Bases: DeviceStatus

Container for status reports from the Smartmi Zhimi Heater.

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 brightness: Brightness

Display brightness.

property buzzer: bool

True if buzzer is turned on.

property child_lock: bool

True if child lock is on.

property delay_off_countdown: Optional[int]

Countdown until turning off in seconds.

property humidity: Optional[int]

Current humidity.

property is_on: bool

True if device is currently on.

property power: str

Power state.

property target_temperature: int

Target temperature.

property temperature: float

Current temperature.

property use_time: int

How long the device has been active in seconds.