Add light presets common module to devices. (#907)

Adds light preset common module for switching to presets and saving presets.
Deprecates the `presets` attribute and `save_preset` method from the `bulb` 
interface in favour of the modular approach.  Allows setting preset for `iot` 
which was not previously supported.
This commit is contained in:
Steven B
2024-05-19 11:20:18 +01:00
committed by GitHub
parent 1ba5c73279
commit 273c541fcc
20 changed files with 612 additions and 73 deletions

View File

@@ -3,13 +3,24 @@
from __future__ import annotations
from abc import ABC, abstractmethod
from typing import NamedTuple, Optional
from pydantic.v1 import BaseModel
from dataclasses import dataclass
from typing import NamedTuple
from ..module import Module
@dataclass
class LightState:
"""Class for smart light preset info."""
light_on: bool | None = None
brightness: int | None = None
hue: int | None = None
saturation: int | None = None
color_temp: int | None = None
transition: bool | None = None
class ColorTempRange(NamedTuple):
"""Color temperature range."""
@@ -25,23 +36,6 @@ class HSV(NamedTuple):
value: int
class LightPreset(BaseModel):
"""Light configuration preset."""
index: int
brightness: int
# These are not available for effect mode presets on light strips
hue: Optional[int] # noqa: UP007
saturation: Optional[int] # noqa: UP007
color_temp: Optional[int] # noqa: UP007
# Variables for effect mode presets
custom: Optional[int] # noqa: UP007
id: Optional[str] # noqa: UP007
mode: Optional[int] # noqa: UP007
class Light(Module, ABC):
"""Base class for TP-Link Light."""
@@ -133,3 +127,7 @@ class Light(Module, ABC):
:param int brightness: brightness in percent
:param int transition: transition in milliseconds.
"""
@abstractmethod
async def set_state(self, state: LightState) -> dict:
"""Set the light state."""