miio.integrations.zhimi.heater package

Submodules

• miio.integrations.zhimi.heater.heater module
  • Brightness
    • Brightness.Bright
    • Brightness.Dim
    • Brightness.Off
  • Heater
    • Heater.actions()
    • Heater.call_action()
    • Heater.change_setting()
    • Heater.configure_wifi()
    • Heater.delay_off()
    • Heater.descriptors()
    • Heater.get_device_group()
    • Heater.get_properties()
    • Heater.info()
    • Heater.off()
    • Heater.on()
    • Heater.raw_command()
    • Heater.send()
    • Heater.send_handshake()
    • Heater.sensors()
    • Heater.set_brightness()
    • Heater.set_buzzer()
    • Heater.set_child_lock()
    • Heater.set_target_temperature()
    • Heater.settings()
    • Heater.status()
    • Heater.supports_miot()
    • Heater.update()
    • Heater.update_progress()
    • Heater.update_state()
    • Heater.device_id
    • Heater.model
    • Heater.raw_id
    • Heater.retry_count
    • Heater.supported_models
    • Heater.timeout
    • Heater.token
  • HeaterStatus
    • HeaterStatus.descriptors()
    • HeaterStatus.embed()
    • HeaterStatus.brightness
    • HeaterStatus.buzzer
    • HeaterStatus.child_lock
    • HeaterStatus.delay_off_countdown
    • HeaterStatus.humidity
    • HeaterStatus.is_on
    • HeaterStatus.power
    • HeaterStatus.target_temperature
    • HeaterStatus.temperature
    • HeaterStatus.use_time
• miio.integrations.zhimi.heater.heater_miot module
  • HeaterMiot
    • HeaterMiot.actions()
    • HeaterMiot.call_action()
    • HeaterMiot.call_action_by()
    • HeaterMiot.call_action_from_mapping()
    • HeaterMiot.change_setting()
    • HeaterMiot.configure_wifi()
    • HeaterMiot.descriptors()
    • HeaterMiot.get_device_group()
    • HeaterMiot.get_properties()
    • HeaterMiot.get_properties_for_mapping()
    • HeaterMiot.get_property_by()
    • HeaterMiot.info()
    • HeaterMiot.off()
    • HeaterMiot.on()
    • HeaterMiot.raw_command()
    • HeaterMiot.send()
    • HeaterMiot.send_handshake()
    • HeaterMiot.sensors()
    • HeaterMiot.set_buzzer()
    • HeaterMiot.set_child_lock()
    • HeaterMiot.set_delay_off()
    • HeaterMiot.set_led_brightness()
    • HeaterMiot.set_property()
    • HeaterMiot.set_property_by()
    • HeaterMiot.set_target_temperature()
    • HeaterMiot.settings()
    • HeaterMiot.status()
    • HeaterMiot.supports_miot()
    • HeaterMiot.update()
    • HeaterMiot.update_progress()
    • HeaterMiot.update_state()
    • HeaterMiot.device_id
    • HeaterMiot.mapping
    • HeaterMiot.model
    • HeaterMiot.raw_id
    • HeaterMiot.retry_count
    • HeaterMiot.supported_models
    • HeaterMiot.timeout
    • HeaterMiot.token
  • HeaterMiotStatus
    • HeaterMiotStatus.descriptors()
    • HeaterMiotStatus.embed()
    • HeaterMiotStatus.buzzer
    • HeaterMiotStatus.child_lock
    • HeaterMiotStatus.delay_off_countdown
    • HeaterMiotStatus.is_on
    • HeaterMiotStatus.led_brightness
    • HeaterMiotStatus.power
    • HeaterMiotStatus.relative_humidity
    • HeaterMiotStatus.target_temperature
    • HeaterMiotStatus.temperature
  • LedBrightness
    • LedBrightness.Dim
    • LedBrightness.Off
    • LedBrightness.On

Module contents

class miio.integrations.zhimi.heater.Heater(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)

Bases: Device

Main class representing the Smartmi Zhimi Heater.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

change_setting(name: str, params=None)

Change setting value.

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

Configure the wifi settings.

delay_off(seconds: int)

Set delay off seconds.

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.

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

Power off.

on()

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

Set display brightness.

set_buzzer(buzzer: bool)

Set buzzer on/off.

set_child_lock(lock: bool)

Set child lock on/off.

set_target_temperature(temperature: int)

Set target temperature.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → HeaterStatus

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

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: str | None

class miio.integrations.zhimi.heater.HeaterMiot(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)

Bases: MiotDevice

Main class representing the Xiaomi Smart Space Heater S (zhimi.heater.mc2) & 1S (zhimi.heater.za2).

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

Power off.

on()

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)

Set buzzer on/off.

set_child_lock(lock: bool)

Set child lock on/off.

set_delay_off(seconds: int)

Set delay off seconds.

set_led_brightness(brightness: LedBrightness)

Set led brightness.

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_temperature(target_temperature: int)

Set target_temperature .

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → HeaterMiotStatus

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 = ['zhimi.heater.mc2', 'zhimi.heater.mc2a', 'zhimi.heater.za2', 'leshow.heater.bs1s']

timeout = 5

token: str | None