miio.powerstrip module

exception miio.powerstrip.PowerStripException

Bases: miio.exceptions.DeviceException

with_traceback()

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

args

class miio.powerstrip.PowerMode(value)

Bases: enum.Enum

An enumeration.

Eco = 'green'

Normal = 'normal'

class miio.powerstrip.PowerStrip(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 the smart power strip.

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)

off(*args, **kwargs)

on(*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_led(*args, **kwargs)

set_power_mode(*args, **kwargs)

set_power_price(*args, **kwargs)

set_realtime_power(*args, **kwargs)

set_wifi_led(*args, **kwargs)

status(*args, **kwargs)

test_properties(*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 = ['qmi.powerstrip.v1', 'zimi.powerstrip.v2']

timeout = 5

token: Optional[str]

class miio.powerstrip.PowerStripStatus(data: Dict[str, Any])

Bases: miio.device.DeviceStatus

Container for status reports from the power strip.

property current: Optional[float]

Current, if available.

Meaning and voltage reference unknown.

property is_on: bool

True if the device is turned on.

property leakage_current: Optional[int]

The leakage current, if available.

property led: Optional[bool]

True if the wifi led is turned on.

property load_power: Optional[float]

Current power load, if available.

property mode: Optional[miio.powerstrip.PowerMode]

Current operation mode, can be either green or normal.

property power: str

Current power state.

property power_factor: Optional[float]

The power factor, if available.

property power_price: Optional[int]

The stored power price, if available.

property temperature: float

Current temperature.

property voltage: Optional[float]

The voltage, if available.

property wifi_led: Optional[bool]

True if the wifi led is turned on.