miio.walkingpad module

exception miio.walkingpad.WalkingpadException[source]

Bases: DeviceException

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args
class miio.walkingpad.OperationMode(value)[source]

Bases: Enum

An enumeration.

Auto = 0
Manual = 1
Off = 2
class miio.walkingpad.OperationSensitivity(value)[source]

Bases: Enum

An enumeration.

High = 1
Low = 3
Medium = 2
class miio.walkingpad.Walkingpad(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: Device

Main class representing Xiaomi Walkingpad.

buttons() List[ButtonDescriptor]

Return a list of button-like, clickable actions of the device.

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.

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

lock()[source]

Lock device.

off()[source]

Power off.

on()[source]

Power on.

quick_status() WalkingpadStatus[source]

Retrieve quick status.

The walkingpad provides the option to retrieve a subset of properties in one call: steps, mode, speed, distance, calories and time.

status() will do four more separate I/O requests for power, mode, start_speed, and sensitivity. If you don’t need any of that, prefer this method for status updates.

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

sensors() Dict[str, SensorDescriptor]

Return sensors.

set_mode(mode: OperationMode)[source]

Set mode (auto/manual).

set_sensitivity(sensitivity: OperationSensitivity)[source]

Set sensitivity.

set_speed(speed: float)[source]

Set speed.

set_start_speed(speed: float)[source]

Set start speed.

settings() Dict[str, SettingDescriptor]

Return list of settings.

start()[source]

Start the treadmill.

status() WalkingpadStatus[source]

Retrieve properties.

stop()[source]

Stop the treadmill.

switches() Dict[str, SwitchDescriptor]

Return toggleable switches.

unlock()[source]

Unlock device.

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 = ['ksmb.walkingpad.v3']
timeout = 5
token: Optional[str]
class miio.walkingpad.WalkingpadStatus(data: Dict[str, Any])[source]

Bases: DeviceStatus

Container for status reports from Xiaomi Walkingpad A1 (ksmb.walkingpad.v3).

Input data dictionary to initialise this class:

{‘cal’: 6130,

‘dist’: 90, ‘mode’: 1, ‘power’: ‘on’, ‘sensitivity’: 1, ‘sp’: 3.0, ‘start_speed’: 3.0, ‘step’: 180, ‘time’: 121}

embed(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 property names, and override the __getattribute__ to lookup attributes in the embedded containers.

sensors() Dict[str, SensorDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

settings() Dict[str, SettingDescriptor]

Return the dict of settings exposed by the status container.

You can use @setting decorator to define sensors inside your status class.

switches() Dict[str, SwitchDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

property calories: int

Current calories burnt.

property distance: int

Current distance in meters.

property is_on: bool

True if the device is turned on.

property mode: OperationMode

Current mode.

property power: str

Power state.

property sensitivity: OperationSensitivity

Current sensitivity.

property speed: float

Current speed.

property start_speed: float

Current start speed.

property step_count: int

Current steps.

property walking_time: timedelta

Current walking duration in seconds.