miio.integrations.yeelight.dual_switch package

Submodules

Module contents

class miio.integrations.yeelight.dual_switch.YeelightDualControlModule(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, mapping: Dict[str, Dict[str, Any]] | None = None)[source]

Bases: MiotDevice

Main class representing the Yeelight Dual Control Module (yeelink.switch.sw1) which uses MIoT protocol.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

call_action_by(siid, aiid, params=None)

Call an action.

call_action_from_mapping(name: str, params=None)

Call an action by a name in the mapping.

change_setting(name: str, params=None)

Change setting value.

configure_wifi(ssid, password, uid=0, extra_params=None)

Configure the wifi settings.

delete_rc(rc_mac: str)[source]

Delete remote control by MAC.

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.

get_properties_for_mapping(*, max_properties=15) → list

Retrieve raw properties based on mapping.

get_property_by(siid: int, piid: int)

Get a single property (siid/piid).

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(switch: Switch)[source]

Turn switch off.

on(switch: Switch)[source]

Turn switch 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_default_state(state: bool, switch: Switch)[source]

Set switch default state.

set_flex_mode(flex_mode: bool)[source]

Set flex mode.

set_interlock(interlock: bool)[source]

Set interlock.

set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(siid: int, piid: int, value: int | float | str | bool, *, value_type: Any | None = None, name: str | None = None)

Set a single property (siid/piid) to given value.

value_type can be given to convert the value to wanted type, allowed types are: int, float, bool, str

set_switch_off_delay(delay: int, switch: Switch)[source]

Set switch off delay, should be between -1 to 43200 (in seconds)

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → DualControlModuleStatus[source]

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.

toggle(switch: Switch)[source]

Toggle switch.

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

mapping: Dict[str, Dict[str, Any]]
property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = ['yeelink.switch.sw1']
timeout = 5
token: str | None