miio.wifispeaker module

class miio.wifispeaker.PlayState(value)

Bases: enum.Enum

An enumeration.

NoMedia = 'NO_MEDIA_PRESENT'

Paused = 'PAUSED_PLAYBACK'

Playing = 'PLAYING'

Stopped = 'STOPPED'

Transitioning = 'TRANSITIONING'

class miio.wifispeaker.TransportChannel(value)

Bases: enum.Enum

An enumeration.

Air = 'AIR'

Auxiliary = 'AUX'

Bluetooth = 'BT'

OneTime = 'ONETIME'

Playlist = 'PLAYLIST'

Qplay = 'QPLAY'

Radio = 'RADIO'

class miio.wifispeaker.WifiSpeaker(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)

Bases: miio.device.Device

Device class for Xiaomi Smart Wifi Speaker.

channel_next(*args, **kwargs)

configure_wifi(ssid, password, uid=0, extra_params=None)

Configure the wifi settings.

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)

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

status(*args, **kwargs)

test_properties(*args, **kwargs)

toggle(*args, **kwargs)

track_next(*args, **kwargs)

track_position(*args, **kwargs)

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

volume()

Speaker volume.

volume_down(*args, **kwargs)

volume_up(*args, **kwargs)

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 = ['xiaomi.wifispeaker.v2']

timeout = 5

token: Optional[str]

class miio.wifispeaker.WifiSpeakerStatus(data)

Bases: miio.device.DeviceStatus

Container of a speaker state.

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

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: miio.wifispeaker.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: miio.wifispeaker.TransportChannel

Transport channel, e.g. PLAYLIST.