miio.walkingpad module

exception miio.walkingpad.WalkingpadException

Bases: miio.exceptions.DeviceException

with_traceback()

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

args

class miio.walkingpad.OperationMode(value)

Bases: enum.Enum

An enumeration.

Auto = 0

Manual = 1

Off = 2

class miio.walkingpad.OperationSensitivity(value)

Bases: enum.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)

Bases: miio.device.Device

Main class representing Xiaomi Walkingpad.

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)

lock(*args, **kwargs)

off(*args, **kwargs)

on(*args, **kwargs)

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

set_mode(*args, **kwargs)

set_sensitivity(*args, **kwargs)

set_speed(*args, **kwargs)

set_start_speed(*args, **kwargs)

start(*args, **kwargs)

status(*args, **kwargs)

stop(*args, **kwargs)

test_properties(*args, **kwargs)

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

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

Bases: miio.device.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}

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: miio.walkingpad.OperationMode

Current mode.

property power: str

Power state.

property sensitivity: miio.walkingpad.OperationSensitivity

Current sensitivity.

property speed: float

Current speed.

property start_speed: float

Current start speed.

property step_count: int

Current steps.

property walking_time: datetime.timedelta

Current walking duration in seconds.