light.py

Go to the documentation of this file.

"""Demo light platform that implements lights."""
 
from __future__ import annotations
 
import random
from typing import Any
 
from homeassistant.components.light import (
    ATTR_BRIGHTNESS,
    ATTR_COLOR_TEMP,
    ATTR_EFFECT,
    ATTR_HS_COLOR,
    ATTR_RGBW_COLOR,
    ATTR_RGBWW_COLOR,
    ATTR_WHITE,
    ColorMode,
    LightEntity,
    LightEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import DOMAIN
 
LIGHT_COLORS = [(56, 86), (345, 75)]
 
LIGHT_EFFECT_LIST = ["rainbow", "none"]
 
LIGHT_TEMPS = [240, 380]
 
SUPPORT_DEMO = {ColorMode.HS, ColorMode.COLOR_TEMP}
SUPPORT_DEMO_HS_WHITE = {ColorMode.HS, ColorMode.WHITE}
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the demo light platform."""
    async_add_entities(
        [
            DemoLight(
                available=True,
                effect_list=LIGHT_EFFECT_LIST,
                effect=LIGHT_EFFECT_LIST[0],
                device_name="Bed Light",
                state=False,
                unique_id="light_1",
            ),
            DemoLight(
                available=True,
                ct=LIGHT_TEMPS[1],
                device_name="Ceiling Lights",
                state=True,
                unique_id="light_2",
            ),
            DemoLight(
                available=True,
                hs_color=LIGHT_COLORS[1],
                device_name="Kitchen Lights",
                state=True,
                unique_id="light_3",
            ),
            DemoLight(
                available=True,
                ct=LIGHT_TEMPS[1],
                device_name="Office RGBW Lights",
                rgbw_color=(255, 0, 0, 255),
                state=True,
                supported_color_modes={ColorMode.RGBW},
                unique_id="light_4",
            ),
            DemoLight(
                available=True,
                device_name="Living Room RGBWW Lights",
                rgbww_color=(255, 0, 0, 255, 0),
                state=True,
                supported_color_modes={ColorMode.RGBWW},
                unique_id="light_5",
            ),
            DemoLight(
                available=True,
                device_name="Entrance Color + White Lights",
                hs_color=LIGHT_COLORS[1],
                state=True,
                supported_color_modes=SUPPORT_DEMO_HS_WHITE,
                unique_id="light_6",
            ),
        ]
    )
 
 
class DemoLight(LightEntity):
    """Representation of a demo light."""
 
    _attr_has_entity_name = True
    _attr_name = None
    _attr_should_poll = False
 
    def __init__(
        self,
        unique_id: str,
        device_name: str,
        state: bool,
        available: bool = False,
        brightness: int = 180,
        ct: int | None = None,
        effect_list: list[str] | None = None,
        effect: str | None = None,
        hs_color: tuple[int, int] | None = None,
        rgbw_color: tuple[int, int, int, int] | None = None,
        rgbww_color: tuple[int, int, int, int, int] | None = None,
        supported_color_modes: set[ColorMode] | None = None,
    ) -> None:
        """Initialize the light."""
        self._available_available = True
        self._brightness_brightness = brightness
        self._ct_ct = ct or random.choice(LIGHT_TEMPS)
        self._effect_effect = effect
        self._effect_list_effect_list = effect_list
        self._hs_color_hs_color = hs_color
        self._rgbw_color_rgbw_color = rgbw_color
        self._rgbww_color_rgbww_color = rgbww_color
        self._state_state = state
        self._unique_id_unique_id = unique_id
        if hs_color:
            self._color_mode_color_mode = ColorMode.HS
        elif rgbw_color:
            self._color_mode_color_mode = ColorMode.RGBW
        elif rgbww_color:
            self._color_mode_color_mode = ColorMode.RGBWW
        else:
            self._color_mode_color_mode = ColorMode.COLOR_TEMP
        if not supported_color_modes:
            supported_color_modes = SUPPORT_DEMO
        self._color_modes_color_modes = supported_color_modes
        if self._effect_list_effect_list is not None:
            self._attr_supported_features |= LightEntityFeature.EFFECT
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={
                # Serial numbers are unique identifiers within a specific domain
                (DOMAIN, self.unique_idunique_idunique_id)
            },
            name=device_name,
        )
 
    @property
    def unique_id(self) -> str:
        """Return unique ID for light."""
        return self._unique_id_unique_id
 
    @property
    def available(self) -> bool:
        """Return availability."""
        # This demo light is always available, but well-behaving components
        # should implement this to inform Home Assistant accordingly.
        return self._available_available
 
    @property
    def brightness(self) -> int:
        """Return the brightness of this light between 0..255."""
        return self._brightness_brightness
 
    @property
    def color_mode(self) -> str | None:
        """Return the color mode of the light."""
        return self._color_mode_color_mode
 
    @property
    def hs_color(self) -> tuple[int, int] | None:
        """Return the hs color value."""
        return self._hs_color_hs_color
 
    @property
    def rgbw_color(self) -> tuple[int, int, int, int] | None:
        """Return the rgbw color value."""
        return self._rgbw_color_rgbw_color
 
    @property
    def rgbww_color(self) -> tuple[int, int, int, int, int] | None:
        """Return the rgbww color value."""
        return self._rgbww_color_rgbww_color
 
    @property
    def color_temp(self) -> int:
        """Return the CT color temperature."""
        return self._ct_ct
 
    @property
    def effect_list(self) -> list[str] | None:
        """Return the list of supported effects."""
        return self._effect_list_effect_list
 
    @property
    def effect(self) -> str | None:
        """Return the current effect."""
        return self._effect_effect
 
    @property
    def is_on(self) -> bool:
        """Return true if light is on."""
        return self._state_state
 
    @property
    def supported_color_modes(self) -> set[ColorMode]:
        """Flag supported color modes."""
        return self._color_modes_color_modes
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the light on."""
        self._state_state = True
 
        if ATTR_BRIGHTNESS in kwargs:
            self._brightness_brightness = kwargs[ATTR_BRIGHTNESS]
 
        if ATTR_COLOR_TEMP in kwargs:
            self._color_mode_color_mode = ColorMode.COLOR_TEMP
            self._ct_ct = kwargs[ATTR_COLOR_TEMP]
 
        if ATTR_EFFECT in kwargs:
            self._effect_effect = kwargs[ATTR_EFFECT]
 
        if ATTR_HS_COLOR in kwargs:
            self._color_mode_color_mode = ColorMode.HS
            self._hs_color_hs_color = kwargs[ATTR_HS_COLOR]
 
        if ATTR_RGBW_COLOR in kwargs:
            self._color_mode_color_mode = ColorMode.RGBW
            self._rgbw_color_rgbw_color = kwargs[ATTR_RGBW_COLOR]
 
        if ATTR_RGBWW_COLOR in kwargs:
            self._color_mode_color_mode = ColorMode.RGBWW
            self._rgbww_color_rgbww_color = kwargs[ATTR_RGBWW_COLOR]
 
        if ATTR_WHITE in kwargs:
            self._color_mode_color_mode = ColorMode.WHITE
            self._brightness_brightness = kwargs[ATTR_WHITE]
 
        # As we have disabled polling, we need to inform
        # Home Assistant about updates in our state ourselves.
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the light off."""
        self._state_state = False
 
        # As we have disabled polling, we need to inform
        # Home Assistant about updates in our state ourselves.
        self.async_write_ha_stateasync_write_ha_state()