mirror of
https://github.com/python-kasa/python-kasa.git
synced 2026-07-08 14:52:03 +00:00
bb27a43027
Comprehensive docstring cleanup across the repository — fix Sphinx cross-references, Python REPL continuation syntax, stale class names, and modernize the IotBulb docstring to use the `Module.Light`/`Module.LightPreset` interface.
57 lines
1.2 KiB
Python
57 lines
1.2 KiB
Python
"""Interact with child devices.
|
|
|
|
>>> from kasa import Discover
|
|
>>>
|
|
>>> dev = await Discover.discover_single(
|
|
... "127.0.0.1",
|
|
... username="user@example.com",
|
|
... password="great_password"
|
|
... )
|
|
>>> await dev.update()
|
|
>>> print(dev.alias)
|
|
Bedroom Power Strip
|
|
|
|
All methods act on the whole strip:
|
|
|
|
>>> for plug in dev.children:
|
|
... print(f"{plug.alias}: {plug.is_on}")
|
|
Plug 1: True
|
|
Plug 2: False
|
|
Plug 3: False
|
|
>>> dev.is_on
|
|
True
|
|
>>> await dev.turn_off()
|
|
>>> await dev.update()
|
|
|
|
Accessing individual plugs can be done using the `children` property:
|
|
|
|
>>> len(dev.children)
|
|
3
|
|
>>> for plug in dev.children:
|
|
... print(f"{plug.alias}: {plug.is_on}")
|
|
Plug 1: False
|
|
Plug 2: False
|
|
Plug 3: False
|
|
>>> await dev.children[1].turn_on()
|
|
>>> await dev.update()
|
|
>>> dev.is_on
|
|
True
|
|
"""
|
|
|
|
from ...device_type import DeviceType
|
|
from ..smartmodule import SmartModule
|
|
|
|
|
|
class ChildDevice(SmartModule):
|
|
"""Implementation for child devices."""
|
|
|
|
REQUIRED_COMPONENT = "child_device"
|
|
QUERY_GETTER_NAME = "get_child_device_list"
|
|
|
|
def query(self) -> dict:
|
|
"""Query to execute during the update cycle."""
|
|
q = super().query()
|
|
if self._device.device_type is DeviceType.Hub:
|
|
q["get_child_device_component_list"] = None
|
|
return q
|