miio.integrations.zhimi.fan.zhimi_miot module

class miio.integrations.zhimi.fan.zhimi_miot.FanStatusZA5(data: Dict[str, Any])

Bases: DeviceStatus

Container for status reports for FanZA5.

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 angle: int

Oscillation angle.

property battery_supported: bool

True if battery is supported.

property buttons_pressed: str

What buttons on the fan are pressed now.

property buzzer: bool

True if buzzer is turned on.

property child_lock: bool

True if child lock if on.

property delay_off_countdown: int

Countdown until turning off in minutes.

property fan_level: int

Fan level (1-4).

property fan_speed: int

Fan speed (1-100).

property humidity: int

Air humidity in percent.

property ionizer: bool

True if negative ions generation is enabled.

property is_on: bool

True if device is currently on.

property led_brightness: int

LED brightness (1-100).

property mode: OperationMode

Operation mode (normal or nature).

property oscillate: bool

True if oscillation is enabled.

property power: str

Power state.

property powersupply_attached: bool

True is power supply is attached.

property speed: int

Fan speed (1-100).

property speed_rpm: int

Fan rotations per minute.

property temperature: Any

Air temperature (degree celsius).

class miio.integrations.zhimi.fan.zhimi_miot.FanZA5(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

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.

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.

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_angle(angle: int)

Set the oscillation angle.

set_buzzer(buzzer: bool)

Set buzzer on/off.

set_child_lock(lock: bool)

Set child lock on/off.

set_ionizer(on: bool)

Set ionizer on/off.

set_led_brightness(brightness: int)

Set LED brightness.

set_mode(mode: OperationMode)

Set mode.

set_oscillate(oscillate: bool)

Set oscillate 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_rotate(direction: MoveDirection)

Rotate fan 7.5 degrees horizontally to given direction.

set_speed(speed: int)

Set fan speed.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → FanStatusZA5

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.fan.za5']

timeout = 5

token: str | None

class miio.integrations.zhimi.fan.zhimi_miot.MoveDirection(value)

Bases: Enum

An enumeration.

Left = 'left'

Right = 'right'

class miio.integrations.zhimi.fan.zhimi_miot.OperationMode(value)

Bases: Enum

An enumeration.

Nature = 'nature'

Normal = 'normal'

class miio.integrations.zhimi.fan.zhimi_miot.OperationModeFanZA5(value)

Bases: Enum

An enumeration.

Nature = 0

Normal = 1