light.py

Go to the documentation of this file.

"""Support for RFXtrx lights."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import RFXtrx as rfxtrxmod
 
from homeassistant.components.light import ATTR_BRIGHTNESS, ColorMode, LightEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import STATE_ON
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity import Entity
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import DeviceTuple, async_setup_platform_entry
from .const import COMMAND_OFF_LIST, COMMAND_ON_LIST
from .entity import RfxtrxCommandEntity
 
_LOGGER = logging.getLogger(__name__)
 
 
def supported(event: rfxtrxmod.RFXtrxEvent) -> bool:
    """Return whether an event supports light."""
    return (
        isinstance(event.device, rfxtrxmod.LightingDevice)
        and event.device.known_to_be_dimmable
    )
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up config entry."""
 
    def _constructor(
        event: rfxtrxmod.RFXtrxEvent,
        auto: rfxtrxmod.RFXtrxEvent | None,
        device_id: DeviceTuple,
        entity_info: dict[str, Any],
    ) -> list[Entity]:
        return [
            RfxtrxLight(
                event.device,
                device_id,
                event=event if auto else None,
            )
        ]
 
    await async_setup_platform_entry(
        hass, config_entry, async_add_entities, supported, _constructor
    )
 
 
class RfxtrxLight(RfxtrxCommandEntity, LightEntity):
    """Representation of a RFXtrx light."""
 
    _attr_color_mode = ColorMode.BRIGHTNESS
    _attr_supported_color_modes = {ColorMode.BRIGHTNESS}
    _attr_brightness: int = 0
    _device: rfxtrxmod.LightingDevice
 
    async def async_added_to_hass(self) -> None:
        """Restore RFXtrx device state (ON/OFF)."""
        await super().async_added_to_hass()
 
        if self._event_event is None:
            old_state = await self.async_get_last_stateasync_get_last_state()
            if old_state is not None:
                self._attr_is_on_attr_is_on = old_state.state == STATE_ON
                if brightness := old_state.attributes.get(ATTR_BRIGHTNESS):
                    self._attr_brightness_attr_brightness = int(brightness)
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        brightness = kwargs.get(ATTR_BRIGHTNESS)
        self._attr_is_on_attr_is_on = True
        if brightness is None:
            await self._async_send(self._device_device.send_on)
            self._attr_brightness_attr_brightness = 255
        else:
            await self._async_send(self._device_device.send_dim, brightness * 100 // 255)
            self._attr_brightness_attr_brightness = brightness
 
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        await self._async_send(self._device_device.send_off)
        self._attr_is_on_attr_is_on = False
        self._attr_brightness_attr_brightness = 0
        self.async_write_ha_stateasync_write_ha_state()
 
    def _apply_event(self, event: rfxtrxmod.RFXtrxEvent) -> None:
        """Apply command from rfxtrx."""
        assert isinstance(event, rfxtrxmod.ControlEvent)
        super()._apply_event(event)
        if event.values["Command"] in COMMAND_ON_LIST:
            self._attr_is_on_attr_is_on = True
        elif event.values["Command"] in COMMAND_OFF_LIST:
            self._attr_is_on_attr_is_on = False
        elif event.values["Command"] == "Set level":
            brightness = event.values["Dim level"] * 255 // 100
            self._attr_brightness_attr_brightness = brightness
            self._attr_is_on_attr_is_on = brightness > 0
 
    @callback
    def _handle_event(
        self, event: rfxtrxmod.RFXtrxEvent, device_id: DeviceTuple
    ) -> None:
        """Check if event applies to me and update."""
        if device_id != self._device_id_device_id:
            return
 
        self._apply_event_apply_event(event)
 
        self.async_write_ha_stateasync_write_ha_state()