mirror of
https://github.com/python-kasa/python-kasa.git
synced 2025-01-10 23:07:08 +00:00
9473d97ad2
Introduce common module interfaces across smart and iot devices and provide better typing implementation for getting modules to support this.
98 lines
2.8 KiB
Python
98 lines
2.8 KiB
Python
"""Module for light effects."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from ...interfaces.lighteffect import LightEffect
|
|
from ..effects import EFFECT_MAPPING_V1, EFFECT_NAMES_V1
|
|
from ..iotmodule import IotModule
|
|
|
|
|
|
class LightEffectModule(IotModule, LightEffect):
|
|
"""Implementation of dynamic light effects."""
|
|
|
|
@property
|
|
def effect(self) -> str:
|
|
"""Return effect state.
|
|
|
|
Example:
|
|
{'brightness': 50,
|
|
'custom': 0,
|
|
'enable': 0,
|
|
'id': '',
|
|
'name': ''}
|
|
"""
|
|
if (
|
|
(state := self.data.get("lighting_effect_state"))
|
|
and state.get("enable")
|
|
and (name := state.get("name"))
|
|
and name in EFFECT_NAMES_V1
|
|
):
|
|
return name
|
|
return self.LIGHT_EFFECTS_OFF
|
|
|
|
@property
|
|
def effect_list(self) -> list[str]:
|
|
"""Return built-in effects list.
|
|
|
|
Example:
|
|
['Aurora', 'Bubbling Cauldron', ...]
|
|
"""
|
|
effect_list = [self.LIGHT_EFFECTS_OFF]
|
|
effect_list.extend(EFFECT_NAMES_V1)
|
|
return effect_list
|
|
|
|
async def set_effect(
|
|
self,
|
|
effect: str,
|
|
*,
|
|
brightness: int | None = None,
|
|
transition: int | None = None,
|
|
) -> None:
|
|
"""Set an effect on the device.
|
|
|
|
If brightness or transition is defined,
|
|
its value will be used instead of the effect-specific default.
|
|
|
|
See :meth:`effect_list` for available effects,
|
|
or use :meth:`set_custom_effect` for custom effects.
|
|
|
|
:param str effect: The effect to set
|
|
:param int brightness: The wanted brightness
|
|
:param int transition: The wanted transition time
|
|
"""
|
|
if effect == self.LIGHT_EFFECTS_OFF:
|
|
effect_dict = dict(self.data["lighting_effect_state"])
|
|
effect_dict["enable"] = 0
|
|
elif effect not in EFFECT_MAPPING_V1:
|
|
raise ValueError(f"The effect {effect} is not a built in effect.")
|
|
else:
|
|
effect_dict = EFFECT_MAPPING_V1[effect]
|
|
if brightness is not None:
|
|
effect_dict["brightness"] = brightness
|
|
if transition is not None:
|
|
effect_dict["transition"] = transition
|
|
|
|
await self.set_custom_effect(effect_dict)
|
|
|
|
async def set_custom_effect(
|
|
self,
|
|
effect_dict: dict,
|
|
) -> None:
|
|
"""Set a custom effect on the device.
|
|
|
|
:param str effect_dict: The custom effect dict to set
|
|
"""
|
|
return await self.call(
|
|
"set_lighting_effect",
|
|
effect_dict,
|
|
)
|
|
|
|
@property
|
|
def has_custom_effects(self) -> bool:
|
|
"""Return True if the device supports setting custom effects."""
|
|
return True
|
|
|
|
def query(self):
|
|
"""Return the base query."""
|
|
return {}
|