mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-22 19:23:34 +00:00
db6e335346
PR contains a number of fixes from testing with HA devices: - Fixes a bug with turning the light on and off via `set_state` - Aligns `set_brightness` behaviour across `smart` and `iot` devices such that a value of 0 is off. - Aligns `set_brightness` behaviour for `IotDimmer` such that setting the brightness turns on the device with a transition of 1ms. ([HA comment](https://github.com/home-assistant/core/pull/117839#discussion_r1608720006)) - Fixes a typing issue in `LightState`. - Adds `ColorTempRange` and `HSV` to `__init__.py` - Adds a `state` property to the interface returning `LightState` for validating `set_state` changes. - Adds tests for `set_state`
139 lines
3.4 KiB
Python
139 lines
3.4 KiB
Python
"""Module for Device base class."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from abc import ABC, abstractmethod
|
|
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: int | None = None
|
|
|
|
|
|
class ColorTempRange(NamedTuple):
|
|
"""Color temperature range."""
|
|
|
|
min: int
|
|
max: int
|
|
|
|
|
|
class HSV(NamedTuple):
|
|
"""Hue-saturation-value."""
|
|
|
|
hue: int
|
|
saturation: int
|
|
value: int
|
|
|
|
|
|
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.
|
|
"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def state(self) -> LightState:
|
|
"""Return the current light state."""
|
|
|
|
@abstractmethod
|
|
async def set_state(self, state: LightState) -> dict:
|
|
"""Set the light state."""
|