miio.integrations.zimi.powerstrip package

Submodules

• miio.integrations.zimi.powerstrip.powerstrip module
  • PowerMode
    • PowerMode.Eco
    • PowerMode.Normal
  • PowerStrip
    • PowerStrip.actions()
    • PowerStrip.call_action()
    • PowerStrip.change_setting()
    • PowerStrip.configure_wifi()
    • PowerStrip.descriptors()
    • PowerStrip.get_device_group()
    • PowerStrip.get_properties()
    • PowerStrip.info()
    • PowerStrip.off()
    • PowerStrip.on()
    • PowerStrip.raw_command()
    • PowerStrip.send()
    • PowerStrip.send_handshake()
    • PowerStrip.sensors()
    • PowerStrip.set_led()
    • PowerStrip.set_power()
    • PowerStrip.set_power_mode()
    • PowerStrip.set_power_price()
    • PowerStrip.set_realtime_power()
    • PowerStrip.set_wifi_led()
    • PowerStrip.settings()
    • PowerStrip.status()
    • PowerStrip.supports_miot()
    • PowerStrip.update()
    • PowerStrip.update_progress()
    • PowerStrip.update_state()
    • PowerStrip.device_id
    • PowerStrip.model
    • PowerStrip.raw_id
    • PowerStrip.retry_count
    • PowerStrip.supported_models
    • PowerStrip.timeout
    • PowerStrip.token
  • PowerStripStatus
    • PowerStripStatus.descriptors()
    • PowerStripStatus.embed()
    • PowerStripStatus.current
    • PowerStripStatus.is_on
    • PowerStripStatus.leakage_current
    • PowerStripStatus.led
    • PowerStripStatus.load_power
    • PowerStripStatus.mode
    • PowerStripStatus.power
    • PowerStripStatus.power_factor
    • PowerStripStatus.power_price
    • PowerStripStatus.temperature
    • PowerStripStatus.voltage
    • PowerStripStatus.wifi_led

Module contents

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

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

off()

Power off.

on()

Power on.

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_led(led: bool)

Set the wifi led on/off.

set_power(power: bool)

Set the power on or off.

set_power_mode(mode: PowerMode)

Set the power mode.

set_power_price(price: int)

Set the power price.

set_realtime_power(power: bool)

Set the realtime power on/off.

set_wifi_led(led: bool)

Set the wifi led on/off.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → PowerStripStatus

Retrieve properties.

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.

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

timeout = 5

token: str | None