miio.device module

class miio.device.Device(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)[source]

Bases: object

Base class for all device implementations.

This is the main class providing the basic protocol handling for devices using the miIO protocol. This class should not be initialized directly but a device- specific class inheriting it should be used instead of it.

actions() DescriptorCollection[ActionDescriptor][source]

Return device actions.

call_action(name: str, params=None)[source]

Call action by name.

change_setting(name: str, params=None)[source]

Change setting value.

configure_wifi(ssid, password, uid=0, extra_params=None)[source]

Configure the wifi settings.

descriptors() DescriptorCollection[Descriptor][source]

Return a collection containing all descriptors for the device.

classmethod get_device_group()
get_properties(properties, *, property_getter='get_prop', max_properties=None)[source]

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.

  • properties (list) – List of properties to query from the device.

  • max_properties (int) – Number of properties that can be requested at once.


List of property values.

info(*, skip_cache=False) DeviceInfo[source]

Get (and cache) miIO protocol information from the device.

This includes information about connected wlan network, and hardware and software versions.


bool (skip_cache) – Skip the cache

raw_command(command, parameters)[source]

Send a raw command to the device. This is mostly useful when trying out commands which are not implemented by a given device instance.

  • 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[source]

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.

  • 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 initial handshake to the device.

final sensors() DescriptorCollection[PropertyDescriptor][source]

Return read-only properties.

final settings() DescriptorCollection[PropertyDescriptor][source]

Return settable properties.

status() DeviceStatus[source]

Return device status.

supports_miot() bool[source]

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)[source]

Start an OTA update.

update_progress() int[source]

Return current update progress [0-100].


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 = []
timeout = 5
class miio.device.UpdateState(value)[source]

Bases: Enum

An enumeration.

Downloading = 'downloading'
Failed = 'failed'
Idle = 'idle'
Installing = 'installing'