miio.integrations.ksmb.walkingpad package

Submodules

• miio.integrations.ksmb.walkingpad.walkingpad module
  • OperationMode
    • OperationMode.Auto
    • OperationMode.Manual
    • OperationMode.Off
  • OperationSensitivity
    • OperationSensitivity.High
    • OperationSensitivity.Low
    • OperationSensitivity.Medium
  • Walkingpad
    • Walkingpad.actions()
    • Walkingpad.call_action()
    • Walkingpad.change_setting()
    • Walkingpad.configure_wifi()
    • Walkingpad.descriptors()
    • Walkingpad.get_device_group()
    • Walkingpad.get_properties()
    • Walkingpad.info()
    • Walkingpad.lock()
    • Walkingpad.off()
    • Walkingpad.on()
    • Walkingpad.quick_status()
    • Walkingpad.raw_command()
    • Walkingpad.send()
    • Walkingpad.send_handshake()
    • Walkingpad.sensors()
    • Walkingpad.set_mode()
    • Walkingpad.set_sensitivity()
    • Walkingpad.set_speed()
    • Walkingpad.set_start_speed()
    • Walkingpad.settings()
    • Walkingpad.start()
    • Walkingpad.status()
    • Walkingpad.stop()
    • Walkingpad.supports_miot()
    • Walkingpad.unlock()
    • Walkingpad.update()
    • Walkingpad.update_progress()
    • Walkingpad.update_state()
    • Walkingpad.device_id
    • Walkingpad.model
    • Walkingpad.raw_id
    • Walkingpad.retry_count
    • Walkingpad.supported_models
    • Walkingpad.timeout
    • Walkingpad.token
  • WalkingpadStatus
    • WalkingpadStatus.descriptors()
    • WalkingpadStatus.embed()
    • WalkingpadStatus.calories
    • WalkingpadStatus.distance
    • WalkingpadStatus.is_on
    • WalkingpadStatus.mode
    • WalkingpadStatus.power
    • WalkingpadStatus.sensitivity
    • WalkingpadStatus.speed
    • WalkingpadStatus.start_speed
    • WalkingpadStatus.step_count
    • WalkingpadStatus.walking_time

Module contents

class miio.integrations.ksmb.walkingpad.Walkingpad(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)

Bases: Device

Main class representing Xiaomi Walkingpad.

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.

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.

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()

Lock device.

off()

Power off.

on()

Power on.

quick_status() → WalkingpadStatus

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

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() → DescriptorCollection[PropertyDescriptor]

Return read-only properties.

set_mode(mode: OperationMode)

Set mode (auto/manual).

set_sensitivity(sensitivity: OperationSensitivity)

Set sensitivity.

set_speed(speed: float)

Set speed.

set_start_speed(speed: float)

Set start speed.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

start()

Start the treadmill.

status() → WalkingpadStatus

Retrieve properties.

stop()

Stop the treadmill.

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.

unlock()

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 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 = ['ksmb.walkingpad.v3']

timeout = 5

token: str | None