"""Support for the Tuya lights.""" from dataclasses import dataclass from typing import Any, override from tuya_device_handlers.definition.light import ( FallbackColorDataMode, LightDefinition, get_default_definition, ) from tuya_sharing import CustomerDevice, Manager from homeassistant.components.light import ( ATTR_BRIGHTNESS, ATTR_COLOR_TEMP_KELVIN, ATTR_HS_COLOR, ATTR_WHITE, ColorMode, LightEntity, LightEntityDescription, color_supported, filter_supported_color_modes, ) from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant, callback from homeassistant.helpers.dispatcher import async_dispatcher_connect from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback from .const import TUYA_DISCOVERY_NEW, DeviceCategory, DPCode, WorkMode from .coordinator import TuyaConfigEntry from .entity import TuyaEntity @dataclass(frozen=True) class TuyaLightEntityDescription(LightEntityDescription): """Describe an Tuya light entity.""" brightness_max: DPCode | None = None brightness_min: DPCode | None = None brightness: DPCode | tuple[DPCode, ...] | None = None color_data: DPCode | tuple[DPCode, ...] | None = None color_mode: DPCode | None = None color_temp: DPCode | tuple[DPCode, ...] | None = None fallback_color_data_mode: FallbackColorDataMode = FallbackColorDataMode.V1 LIGHTS: dict[DeviceCategory, tuple[TuyaLightEntityDescription, ...]] = { DeviceCategory.BZYD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.CLKG: ( TuyaLightEntityDescription( key=DPCode.SWITCH_BACKLIGHT, translation_key="backlight", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.CWWSQ: ( TuyaLightEntityDescription( key=DPCode.LIGHT, translation_key="light", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.DC: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.DD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, fallback_color_data_mode=FallbackColorDataMode.V2, ), ), DeviceCategory.DJ: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=(DPCode.BRIGHT_VALUE_V2, DPCode.BRIGHT_VALUE), color_temp=(DPCode.TEMP_VALUE_V2, DPCode.TEMP_VALUE), color_data=(DPCode.COLOUR_DATA_V2, DPCode.COLOUR_DATA), ), # Not documented # Based on multiple reports: manufacturer customized Dimmer 2 switches TuyaLightEntityDescription( key=DPCode.SWITCH_1, translation_key="indexed_light", translation_placeholders={"index": "1"}, brightness=DPCode.BRIGHT_VALUE_1, ), ), DeviceCategory.DSD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, ), ), DeviceCategory.FS: ( TuyaLightEntityDescription( key=DPCode.LIGHT, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, ), TuyaLightEntityDescription( key=DPCode.SWITCH_LED, translation_key="indexed_light", translation_placeholders={"index": "2"}, brightness=DPCode.BRIGHT_VALUE_1, ), ), DeviceCategory.FSD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), # Some ceiling fan lights use LIGHT for DPCode instead of SWITCH_LED TuyaLightEntityDescription( key=DPCode.LIGHT, name=None, ), ), DeviceCategory.FWD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.GYD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.HCDD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.HXD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, translation_key="light", brightness=(DPCode.BRIGHT_VALUE_V2, DPCode.BRIGHT_VALUE), brightness_max=DPCode.BRIGHTNESS_MAX_1, brightness_min=DPCode.BRIGHTNESS_MIN_1, ), ), DeviceCategory.JSQ: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_data=DPCode.COLOUR_DATA_HSV, ), ), DeviceCategory.KG: ( TuyaLightEntityDescription( key=DPCode.SWITCH_BACKLIGHT, translation_key="backlight", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.KJ: ( TuyaLightEntityDescription( key=DPCode.LIGHT, translation_key="backlight", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.KT: ( TuyaLightEntityDescription( key=DPCode.LIGHT, translation_key="backlight", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.KS: ( TuyaLightEntityDescription( key=DPCode.LIGHT, translation_key="backlight", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.MBD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.MSP: ( TuyaLightEntityDescription( key=DPCode.LIGHT, translation_key="light", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.QJDCZ: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.QN: ( TuyaLightEntityDescription( key=DPCode.LIGHT, translation_key="backlight", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.SP: ( TuyaLightEntityDescription( key=DPCode.FLOODLIGHT_SWITCH, brightness=DPCode.FLOODLIGHT_LIGHTNESS, name="Floodlight", ), TuyaLightEntityDescription( key=DPCode.BASIC_INDICATOR, name="Indicator light", entity_category=EntityCategory.CONFIG, ), ), DeviceCategory.SZ: ( TuyaLightEntityDescription( key=DPCode.LIGHT, brightness=DPCode.BRIGHT_VALUE, translation_key="light", ), ), DeviceCategory.TGKG: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED_1, translation_key="indexed_light", translation_placeholders={"index": "1"}, brightness=DPCode.BRIGHT_VALUE_1, brightness_max=DPCode.BRIGHTNESS_MAX_1, brightness_min=DPCode.BRIGHTNESS_MIN_1, ), TuyaLightEntityDescription( key=DPCode.SWITCH_LED_2, translation_key="indexed_light", translation_placeholders={"index": "2"}, brightness=DPCode.BRIGHT_VALUE_2, brightness_max=DPCode.BRIGHTNESS_MAX_2, brightness_min=DPCode.BRIGHTNESS_MIN_2, ), TuyaLightEntityDescription( key=DPCode.SWITCH_LED_3, translation_key="indexed_light", translation_placeholders={"index": "3"}, brightness=DPCode.BRIGHT_VALUE_3, brightness_max=DPCode.BRIGHTNESS_MAX_3, brightness_min=DPCode.BRIGHTNESS_MIN_3, ), ), DeviceCategory.TGQ: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, translation_key="light", brightness=(DPCode.BRIGHT_VALUE_V2, DPCode.BRIGHT_VALUE), brightness_max=DPCode.BRIGHTNESS_MAX_1, brightness_min=DPCode.BRIGHTNESS_MIN_1, ), TuyaLightEntityDescription( key=DPCode.SWITCH_LED_1, translation_key="indexed_light", translation_placeholders={"index": "1"}, brightness=DPCode.BRIGHT_VALUE_1, ), TuyaLightEntityDescription( key=DPCode.SWITCH_LED_2, translation_key="indexed_light", translation_placeholders={"index": "2"}, brightness=DPCode.BRIGHT_VALUE_2, ), ), DeviceCategory.TYD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.TYNDJ: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), ), DeviceCategory.XDD: ( TuyaLightEntityDescription( key=DPCode.SWITCH_LED, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_VALUE, color_temp=DPCode.TEMP_VALUE, color_data=DPCode.COLOUR_DATA, ), TuyaLightEntityDescription( key=DPCode.SWITCH_NIGHT_LIGHT, translation_key="night_light", ), ), DeviceCategory.YKQ: ( TuyaLightEntityDescription( key=DPCode.SWITCH_CONTROLLER, name=None, color_mode=DPCode.WORK_MODE, brightness=DPCode.BRIGHT_CONTROLLER, color_temp=DPCode.TEMP_CONTROLLER, ), ), } # Socket (duplicate of `kg`) # https://developer.tuya.com/en/docs/iot/s?id=K9gf7o5prgf7s LIGHTS[DeviceCategory.CZ] = LIGHTS[DeviceCategory.KG] # Power Socket (duplicate of `kg`) LIGHTS[DeviceCategory.PC] = LIGHTS[DeviceCategory.KG] # Smart Camera - Low power consumption camera (duplicate of `sp`) LIGHTS[DeviceCategory.DGHSXJ] = LIGHTS[DeviceCategory.SP] # Dimmer (duplicate of `tgq`) LIGHTS[DeviceCategory.TDQ] = LIGHTS[DeviceCategory.TGQ] async def async_setup_entry( hass: HomeAssistant, entry: TuyaConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up tuya light dynamically through tuya discovery.""" manager = entry.runtime_data.manager @callback def async_discover_device(device_ids: list[str]): """Discover and add a discovered tuya light.""" entities: list[TuyaLightEntity] = [] for device_id in device_ids: device = manager.device_map[device_id] if descriptions := LIGHTS.get(device.category): entities.extend( TuyaLightEntity(device, manager, description, definition) for description in descriptions if ( definition := get_default_definition( device, switch_dpcode=description.key, brightness_dpcode=description.brightness, brightness_max_dpcode=description.brightness_max, brightness_min_dpcode=description.brightness_min, color_data_dpcode=description.color_data, color_mode_dpcode=description.color_mode, color_temp_dpcode=description.color_temp, fallback_color_data_mode=description.fallback_color_data_mode, ) ) ) async_add_entities(entities) async_discover_device([*manager.device_map]) entry.async_on_unload( async_dispatcher_connect(hass, TUYA_DISCOVERY_NEW, async_discover_device) ) class TuyaLightEntity(TuyaEntity, LightEntity): """Tuya light device.""" entity_description: TuyaLightEntityDescription _white_color_mode = ColorMode.COLOR_TEMP _fixed_color_mode: ColorMode | None = None _attr_min_color_temp_kelvin = 2000 # 500 Mireds _attr_max_color_temp_kelvin = 6500 # 153 Mireds def __init__( self, device: CustomerDevice, device_manager: Manager, description: TuyaLightEntityDescription, definition: LightDefinition, ) -> None: """Init TuyaHaLight.""" super().__init__(device, device_manager, description) self._brightness_wrapper = definition.brightness_wrapper self._color_data_wrapper = definition.color_data_wrapper self._color_mode_wrapper = definition.color_mode_wrapper self._color_temp_wrapper = definition.color_temp_wrapper self._switch_wrapper = definition.switch_wrapper color_modes: set[ColorMode] = {ColorMode.ONOFF} if definition.brightness_wrapper: color_modes.add(ColorMode.BRIGHTNESS) if definition.color_data_wrapper: color_modes.add(ColorMode.HS) # Check if the light has color temperature if definition.color_temp_wrapper: color_modes.add(ColorMode.COLOR_TEMP) # If light has color but does not have color_temp, check if it has # work_mode "white" elif ( color_supported(color_modes) and definition.color_mode_wrapper is not None and WorkMode.WHITE in definition.color_mode_wrapper.options ): color_modes.add(ColorMode.WHITE) self._white_color_mode = ColorMode.WHITE self._attr_supported_color_modes = filter_supported_color_modes(color_modes) if len(self._attr_supported_color_modes) == 1: # If the light supports only a single color mode, set it now self._fixed_color_mode = next(iter(self._attr_supported_color_modes)) @property @override def is_on(self) -> bool | None: """Return true if light is on.""" return self._read_wrapper(self._switch_wrapper) @override async def async_turn_on(self, **kwargs: Any) -> None: """Turn on or control the light.""" commands = self._switch_wrapper.get_update_commands(self.device, True) if self._color_mode_wrapper and ( ATTR_WHITE in kwargs or ATTR_COLOR_TEMP_KELVIN in kwargs ): commands.extend( self._color_mode_wrapper.get_update_commands( self.device, WorkMode.WHITE ), ) if self._color_temp_wrapper and ATTR_COLOR_TEMP_KELVIN in kwargs: commands.extend( self._color_temp_wrapper.get_update_commands( self.device, kwargs[ATTR_COLOR_TEMP_KELVIN] ) ) if self._color_data_wrapper and ( ATTR_HS_COLOR in kwargs or ( ATTR_BRIGHTNESS in kwargs and self.color_mode == ColorMode.HS and ATTR_WHITE not in kwargs and ATTR_COLOR_TEMP_KELVIN not in kwargs ) ): if self._color_mode_wrapper: commands.extend( self._color_mode_wrapper.get_update_commands( self.device, WorkMode.COLOUR ), ) if not (brightness := kwargs.get(ATTR_BRIGHTNESS)): brightness = self.brightness or 0 if not (color := kwargs.get(ATTR_HS_COLOR)): color = self.hs_color or (0, 0) commands.extend( self._color_data_wrapper.get_update_commands( self.device, (color[0], color[1], brightness) ), ) elif self._brightness_wrapper and ( ATTR_BRIGHTNESS in kwargs or ATTR_WHITE in kwargs ): if ATTR_BRIGHTNESS in kwargs: brightness = kwargs[ATTR_BRIGHTNESS] else: brightness = kwargs[ATTR_WHITE] commands.extend( self._brightness_wrapper.get_update_commands(self.device, brightness), ) await self._async_send_commands(commands) @override async def async_turn_off(self, **kwargs: Any) -> None: """Instruct the light to turn off.""" await self._async_send_wrapper_updates(self._switch_wrapper, False) @property @override def brightness(self) -> int | None: """Return the brightness of this light between 0..255.""" # If the light is currently in color mode, # extract the brightness from the color data if self.color_mode == ColorMode.HS and self._color_data_wrapper: hsv_data = self._read_wrapper(self._color_data_wrapper) return None if hsv_data is None else round(hsv_data[2]) return self._read_wrapper(self._brightness_wrapper) @property @override def color_temp_kelvin(self) -> int | None: """Return the color temperature value in Kelvin.""" return self._read_wrapper(self._color_temp_wrapper) @property @override def hs_color(self) -> tuple[float, float] | None: """Return the hs_color of the light.""" if self._color_data_wrapper is None: return None hsv_data = self._read_wrapper(self._color_data_wrapper) return None if hsv_data is None else (hsv_data[0], hsv_data[1]) @property @override def color_mode(self) -> ColorMode: """Return the color_mode of the light.""" if self._fixed_color_mode: # The light supports only a single color mode, return it return self._fixed_color_mode # The light supports both white (with or without adjustable color temperature) # and HS, determine which mode the light is in. We consider it to be in HS color # mode, when work mode is anything else than "white". if ( self._color_mode_wrapper and self._read_wrapper(self._color_mode_wrapper) != WorkMode.WHITE ): return ColorMode.HS return self._white_color_mode