light.py

Go to the documentation of this file.

"""Support for Decora dimmers."""
 
from __future__ import annotations
 
from collections.abc import Callable
import copy
from functools import wraps
import logging
import time
from typing import TYPE_CHECKING, Any, Concatenate
 
from bluepy.btle import BTLEException
import decora
import voluptuous as vol
 
from homeassistant import util
from homeassistant.components.light import (
    ATTR_BRIGHTNESS,
    PLATFORM_SCHEMA as LIGHT_PLATFORM_SCHEMA,
    ColorMode,
    LightEntity,
)
from homeassistant.const import CONF_API_KEY, CONF_DEVICES, CONF_NAME
import homeassistant.helpers.config_validation as cv
 
if TYPE_CHECKING:
    from homeassistant.core import HomeAssistant
    from homeassistant.helpers.entity_platform import AddEntitiesCallback
    from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
 
_LOGGER = logging.getLogger(__name__)
 
 
def _name_validator(config):
    """Validate the name."""
    config = copy.deepcopy(config)
    for address, device_config in config[CONF_DEVICES].items():
        if CONF_NAME not in device_config:
            device_config[CONF_NAME] = util.slugify(address)
 
    return config
 
 
DEVICE_SCHEMA = vol.Schema(
    {vol.Optional(CONF_NAME): cv.string, vol.Required(CONF_API_KEY): cv.string}
)
 
PLATFORM_SCHEMA = vol.Schema(
    vol.All(
        LIGHT_PLATFORM_SCHEMA.extend(
            {vol.Optional(CONF_DEVICES, default={}): {cv.string: DEVICE_SCHEMA}}
        ),
        _name_validator,
    )
)
 
 
def retry[_DecoraLightT: DecoraLight, **_P, _R](
    method: Callable[Concatenate[_DecoraLightT, _P], _R],
) -> Callable[Concatenate[_DecoraLightT, _P], _R | None]:
    """Retry bluetooth commands."""
 
    @wraps(method)
    def wrapper_retry(
        device: _DecoraLightT, *args: _P.args, **kwargs: _P.kwargs
    ) -> _R | None:
        """Try send command and retry on error."""
 
        initial = time.monotonic()
        while True:
            if time.monotonic() - initial >= 10:
                return None
            try:
                return method(device, *args, **kwargs)
            except (decora.decoraException, AttributeError, BTLEException):
                _LOGGER.warning(
                    "Decora connect error for device %s. Reconnecting",
                    device.name,
                )
                device._switch.connect()  # noqa: SLF001
 
    return wrapper_retry
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up an Decora switch."""
    lights = []
    for address, device_config in config[CONF_DEVICES].items():
        device = {}
        device["name"] = device_config[CONF_NAME]
        device["key"] = device_config[CONF_API_KEY]
        device["address"] = address
        light = DecoraLight(device)
        lights.append(light)
 
    add_entities(lights)
 
 
class DecoraLight(LightEntity):
    """Representation of an Decora light."""
 
    _attr_color_mode = ColorMode.BRIGHTNESS
    _attr_supported_color_modes = {ColorMode.BRIGHTNESS}
 
    def __init__(self, device: dict[str, Any]) -> None:
        """Initialize the light."""
 
        self._attr_name_attr_name = device["name"]
        self._attr_unique_id_attr_unique_id = device["address"]
        self._key_key = device["key"]
        self._switch_switch = decora.decora(device["address"], self._key_key)
        self._attr_brightness_attr_brightness = 0
        self._attr_is_on_attr_is_on = False
 
    @retry
    def set_state(self, brightness: int) -> None:
        """Set the state of this lamp to the provided brightness."""
        self._switch_switch.set_brightness(int(brightness / 2.55))
        self._attr_brightness_attr_brightness = brightness
 
    @retry
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the specified or all lights on."""
        brightness = kwargs.get(ATTR_BRIGHTNESS)
        self._switch_switch.on()
        self._attr_is_on_attr_is_on = True
 
        if brightness is not None:
            self.set_stateset_state(brightness)
 
    @retry
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the specified or all lights off."""
        self._switch_switch.off()
        self._attr_is_on_attr_is_on = False
 
    @retry
    def update(self) -> None:
        """Synchronise internal state with the actual light state."""
        self._attr_brightness_attr_brightness = self._switch_switch.get_brightness() * 2.55
        self._attr_is_on_attr_is_on = self._switch_switch.get_on()