mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
136 lines
3.4 KiB
Python
136 lines
3.4 KiB
Python
"""Module for Device base class."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import NamedTuple, Optional
|
|
|
|
from pydantic.v1 import BaseModel
|
|
|
|
from ..module import Module
|
|
|
|
|
|
class ColorTempRange(NamedTuple):
|
|
"""Color temperature range."""
|
|
|
|
min: int
|
|
max: int
|
|
|
|
|
|
class HSV(NamedTuple):
|
|
"""Hue-saturation-value."""
|
|
|
|
hue: int
|
|
saturation: int
|
|
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."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def is_dimmable(self) -> bool:
|
|
"""Whether the light supports brightness changes."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def is_color(self) -> bool:
|
|
"""Whether the bulb supports color changes."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def is_variable_color_temp(self) -> bool:
|
|
"""Whether the bulb supports color temperature changes."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def valid_temperature_range(self) -> ColorTempRange:
|
|
"""Return the device-specific white temperature range (in Kelvin).
|
|
|
|
:return: White temperature range in Kelvin (minimum, maximum)
|
|
"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def has_effects(self) -> bool:
|
|
"""Return True if the device supports effects."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def hsv(self) -> HSV:
|
|
"""Return the current HSV state of the bulb.
|
|
|
|
:return: hue, saturation and value (degrees, %, %)
|
|
"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def color_temp(self) -> int:
|
|
"""Whether the bulb supports color temperature changes."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def brightness(self) -> int:
|
|
"""Return the current brightness in percentage."""
|
|
|
|
@abstractmethod
|
|
async def set_hsv(
|
|
self,
|
|
hue: int,
|
|
saturation: int,
|
|
value: int | None = None,
|
|
*,
|
|
transition: int | None = None,
|
|
) -> dict:
|
|
"""Set new HSV.
|
|
|
|
Note, transition is not supported and will be ignored.
|
|
|
|
:param int hue: hue in degrees
|
|
:param int saturation: saturation in percentage [0,100]
|
|
:param int value: value in percentage [0, 100]
|
|
:param int transition: transition in milliseconds.
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def set_color_temp(
|
|
self, temp: int, *, brightness=None, transition: int | None = None
|
|
) -> dict:
|
|
"""Set the color temperature of the device in kelvin.
|
|
|
|
Note, transition is not supported and will be ignored.
|
|
|
|
:param int temp: The new color temperature, in Kelvin
|
|
:param int transition: transition in milliseconds.
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def set_brightness(
|
|
self, brightness: int, *, transition: int | None = None
|
|
) -> dict:
|
|
"""Set the brightness in percentage.
|
|
|
|
Note, transition is not supported and will be ignored.
|
|
|
|
:param int brightness: brightness in percent
|
|
:param int transition: transition in milliseconds.
|
|
"""
|