miio.integrations.zhimi.fan.fan module

class miio.integrations.zhimi.fan.fan.Fan(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 Xiaomi Mi Smart Pedestal Fan.

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_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_direct_speed(speed: int)

Set speed of the direct mode.

set_led(led: bool)

Turn led on/off.

Not supported by model SA1.

set_led_brightness(brightness: LedBrightness)

Set led brightness.

set_natural_speed(speed: int)

Set natural level.

set_oscillate(oscillate: bool)

Set oscillate on/off.

set_power(power: bool)

Turn device on or off.

set_rotate(direction: MoveDirection)

Rotate the fan by -5/+5 degrees left/right.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → FanStatus

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.fan.v3', 'zhimi.fan.v2', 'zhimi.fan.sa1', 'zhimi.fan.za1', 'zhimi.fan.za3', 'zhimi.fan.za4']

timeout = 5

token: str | None

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

Bases: DeviceStatus

Container for status reports from the Xiaomi Mi Smart Pedestal Fan.

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 ac_power: bool

True if powered by AC.

property angle: int

Current angle.

property battery: int | None

Current battery level.

property battery_charge: str | None

State of the battery charger, if available.

property battery_state: str | None

State of the battery, if available.

property button_pressed: str | None

Last pressed button.

property buzzer: bool

True if buzzer is turned on.

property child_lock: bool

True if child lock is on.

property delay_off_countdown: int

Countdown until turning off in seconds.

property direct_speed: int | None

Speed level in direct mode.

property humidity: int | None

Current humidity.

property is_on: bool

True if device is currently on.

property led: bool | None

True if LED is turned on, if available.

property led_brightness: LedBrightness | None

LED brightness, if available.

property natural_speed: int | None

Speed level in natural mode.

property oscillate: bool

True if oscillation is enabled.

property power: str

Power state.

property speed: int

Speed of the motor.

property temperature: float | None

Current temperature, if available.

property use_time: int

How long the device has been active in seconds.

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

Bases: FanStatus

Container for status reports from the Xiaomi Mi Smart Pedestal Fan Zhimi ZA4.

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 ac_power: bool

True if powered by AC.

property angle: int

Current angle.

property battery: int | None

Current battery level.

property battery_charge: str | None

State of the battery charger, if available.

property battery_state: str | None

State of the battery, if available.

property button_pressed: str | None

Last pressed button.

property buzzer: bool

True if buzzer is turned on.

property child_lock: bool

True if child lock is on.

property delay_off_countdown: int

Countdown until turning off in minutes.

property direct_speed: int | None

Speed level in direct mode.

property humidity: int | None

Current humidity.

property is_on: bool

True if device is currently on.

property led: bool | None

True if LED is turned on, if available.

property led_brightness: LedBrightness | None

LED brightness, if available.

property natural_speed: int | None

Speed level in natural mode.

property oscillate: bool

True if oscillation is enabled.

property power: str

Power state.

property speed: int

Speed of the motor.

property temperature: float | None

Current temperature, if available.

property use_time: int

How long the device has been active in seconds.

class miio.integrations.zhimi.fan.fan.LedBrightness(value)

Bases: Enum

An enumeration.

Bright = 0

Dim = 1

Off = 2

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

Bases: Enum

An enumeration.

Left = 'left'

Right = 'right'