miio.integrations.fan.zhimi.fan module¶

class miio.integrations.fan.zhimi.fan.Fan(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: miio.device.Device

Main class representing the Xiaomi Mi Smart Pedestal Fan.

configure_wifi(ssid, password, uid=0, extra_params=None)¶: Configure the wifi settings.

delay_off(*args, **kwargs)¶

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.

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

set_buzzer(*args, **kwargs)¶

set_child_lock(*args, **kwargs)¶

set_direct_speed(*args, **kwargs)¶

set_led(*args, **kwargs)¶

set_led_brightness(*args, **kwargs)¶

set_natural_speed(*args, **kwargs)¶

set_oscillate(*args, **kwargs)¶

set_rotate(*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.

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: Optional[str]¶

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

Bases: miio.device.DeviceStatus

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

property ac_power: bool¶: True if powered by AC.

property angle: int¶: Current angle.

property battery: Optional[int]¶: Current battery level.

property battery_charge: Optional[str]¶: State of the battery charger, if available.

property battery_state: Optional[str]¶: State of the battery, if available.

property button_pressed: Optional[str]¶: 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: Optional[int]¶: Speed level in direct mode.

property humidity: Optional[int]¶: Current humidity.

property is_on: bool¶: True if device is currently on.

property led: Optional[bool]¶: True if LED is turned on, if available.

property led_brightness: Optional[miio.fan_common.LedBrightness]¶: LED brightness, if available.

property natural_speed: Optional[int]¶: 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: Optional[float]¶: Current temperature, if available.

property use_time: int¶: How long the device has been active in seconds.