miio.integrations.xiaomi.wifispeaker.wifispeaker module

class miio.integrations.xiaomi.wifispeaker.wifispeaker.PlayState(value)[source]

Bases: Enum

An enumeration.

Playing = 'PLAYING'
Stopped = 'STOPPED'
Transitioning = 'TRANSITIONING'
class miio.integrations.xiaomi.wifispeaker.wifispeaker.TransportChannel(value)[source]

Bases: Enum

An enumeration.

Air = 'AIR'
Auxiliary = 'AUX'
Bluetooth = 'BT'
OneTime = 'ONETIME'
Playlist = 'PLAYLIST'
Qplay = 'QPLAY'
Radio = 'RADIO'
class miio.integrations.xiaomi.wifispeaker.wifispeaker.WifiSpeaker(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: Device

Device class for Xiaomi Smart Wifi Speaker.

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.


Change transport channel.

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.

  • 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

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


Toggle power on and off.

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.

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

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

sensors() DescriptorCollection[PropertyDescriptor]

Return read-only properties.

settings() DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() WifiSpeakerStatus[source]

Return device status.

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.


Toggle play.


Move to next track.


Return current track position.


Move to previous track.

update(url: str, md5: str)

Start an OTA update.

update_progress() int

Return current update progress [0-100].


Return current update state.


Speaker volume.

volume_down(amount: int = 5)[source]

Set volume down.

volume_up(amount: int = 5)[source]

Set volume up.

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 = ['xiaomi.wifispeaker.v2']
timeout = 5
token: str | None
class miio.integrations.xiaomi.wifispeaker.wifispeaker.WifiSpeakerStatus(data)[source]

Bases: DeviceStatus

Container of a speaker state.

This contains information such as the name of the device, and what is currently being played by it.

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

Name of the channel.

property device_name: str

Name of the device.

property hardware_version: str
property play_mode

Play mode such as REPEAT_ALL.

property state: PlayState

State of the device, e.g. PLAYING.

property track_artist: str

Artist of the current track.

property track_duration: str

Total duration of the current track.

property track_title: str

Title of the current track.

property transport_channel: TransportChannel

Transport channel, e.g. PLAYLIST.