278 lines
9.7 KiB
Python
278 lines
9.7 KiB
Python
"""Support for IKEA Tradfri lights."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
from typing import Any, cast
|
|
|
|
from pytradfri.command import Command
|
|
|
|
from homeassistant.components.light import (
|
|
ATTR_BRIGHTNESS,
|
|
ATTR_COLOR_TEMP,
|
|
ATTR_HS_COLOR,
|
|
ATTR_TRANSITION,
|
|
SUPPORT_BRIGHTNESS,
|
|
SUPPORT_COLOR,
|
|
SUPPORT_COLOR_TEMP,
|
|
LightEntity,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
import homeassistant.util.color as color_util
|
|
|
|
from .base_class import TradfriBaseClass, TradfriBaseDevice
|
|
from .const import (
|
|
ATTR_DIMMER,
|
|
ATTR_HUE,
|
|
ATTR_SAT,
|
|
ATTR_TRANSITION_TIME,
|
|
CONF_GATEWAY_ID,
|
|
CONF_IMPORT_GROUPS,
|
|
DEVICES,
|
|
DOMAIN,
|
|
GROUPS,
|
|
KEY_API,
|
|
SUPPORTED_GROUP_FEATURES,
|
|
SUPPORTED_LIGHT_FEATURES,
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Load Tradfri lights based on a config entry."""
|
|
gateway_id = config_entry.data[CONF_GATEWAY_ID]
|
|
tradfri_data = hass.data[DOMAIN][config_entry.entry_id]
|
|
api = tradfri_data[KEY_API]
|
|
devices = tradfri_data[DEVICES]
|
|
|
|
entities: list[TradfriBaseClass] = [
|
|
TradfriLight(dev, api, gateway_id) for dev in devices if dev.has_light_control
|
|
]
|
|
if config_entry.data[CONF_IMPORT_GROUPS] and (groups := tradfri_data[GROUPS]):
|
|
entities.extend([TradfriGroup(group, api, gateway_id) for group in groups])
|
|
async_add_entities(entities)
|
|
|
|
|
|
class TradfriGroup(TradfriBaseClass, LightEntity):
|
|
"""The platform class for light groups required by hass."""
|
|
|
|
_attr_supported_features = SUPPORTED_GROUP_FEATURES
|
|
|
|
def __init__(
|
|
self,
|
|
device: Command,
|
|
api: Callable[[Command | list[Command]], Any],
|
|
gateway_id: str,
|
|
) -> None:
|
|
"""Initialize a Group."""
|
|
super().__init__(device, api, gateway_id)
|
|
|
|
self._attr_unique_id = f"group-{gateway_id}-{device.id}"
|
|
self._attr_should_poll = True
|
|
self._refresh(device, write_ha=False)
|
|
|
|
async def async_update(self) -> None:
|
|
"""Fetch new state data for the group.
|
|
|
|
This method is required for groups to update properly.
|
|
"""
|
|
await self._api(self._device.update())
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""Return true if group lights are on."""
|
|
return cast(bool, self._device.state)
|
|
|
|
@property
|
|
def brightness(self) -> int | None:
|
|
"""Return the brightness of the group lights."""
|
|
return cast(int, self._device.dimmer)
|
|
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
"""Instruct the group lights to turn off."""
|
|
await self._api(self._device.set_state(0))
|
|
|
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
|
"""Instruct the group lights to turn on, or dim."""
|
|
keys = {}
|
|
if ATTR_TRANSITION in kwargs:
|
|
keys["transition_time"] = int(kwargs[ATTR_TRANSITION]) * 10
|
|
|
|
if ATTR_BRIGHTNESS in kwargs:
|
|
if kwargs[ATTR_BRIGHTNESS] == 255:
|
|
kwargs[ATTR_BRIGHTNESS] = 254
|
|
|
|
await self._api(self._device.set_dimmer(kwargs[ATTR_BRIGHTNESS], **keys))
|
|
else:
|
|
await self._api(self._device.set_state(1))
|
|
|
|
|
|
class TradfriLight(TradfriBaseDevice, LightEntity):
|
|
"""The platform class required by Home Assistant."""
|
|
|
|
def __init__(
|
|
self,
|
|
device: Command,
|
|
api: Callable[[Command | list[Command]], Any],
|
|
gateway_id: str,
|
|
) -> None:
|
|
"""Initialize a Light."""
|
|
super().__init__(device, api, gateway_id)
|
|
self._attr_unique_id = f"light-{gateway_id}-{device.id}"
|
|
self._hs_color = None
|
|
|
|
# Calculate supported features
|
|
_features = SUPPORTED_LIGHT_FEATURES
|
|
if device.light_control.can_set_dimmer:
|
|
_features |= SUPPORT_BRIGHTNESS
|
|
if device.light_control.can_set_color:
|
|
_features |= SUPPORT_COLOR | SUPPORT_COLOR_TEMP
|
|
if device.light_control.can_set_temp:
|
|
_features |= SUPPORT_COLOR_TEMP
|
|
self._attr_supported_features = _features
|
|
self._refresh(device, write_ha=False)
|
|
if self._device_control:
|
|
self._attr_min_mireds = self._device_control.min_mireds
|
|
self._attr_max_mireds = self._device_control.max_mireds
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""Return true if light is on."""
|
|
if not self._device_data:
|
|
return False
|
|
return cast(bool, self._device_data.state)
|
|
|
|
@property
|
|
def brightness(self) -> int | None:
|
|
"""Return the brightness of the light."""
|
|
if not self._device_data:
|
|
return None
|
|
return cast(int, self._device_data.dimmer)
|
|
|
|
@property
|
|
def color_temp(self) -> int | None:
|
|
"""Return the color temp value in mireds."""
|
|
if not self._device_data:
|
|
return None
|
|
return cast(int, self._device_data.color_temp)
|
|
|
|
@property
|
|
def hs_color(self) -> tuple[float, float] | None:
|
|
"""HS color of the light."""
|
|
if not self._device_control or not self._device_data:
|
|
return None
|
|
if self._device_control.can_set_color:
|
|
hsbxy = self._device_data.hsb_xy_color
|
|
hue = hsbxy[0] / (self._device_control.max_hue / 360)
|
|
sat = hsbxy[1] / (self._device_control.max_saturation / 100)
|
|
if hue is not None and sat is not None:
|
|
return hue, sat
|
|
return None
|
|
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
"""Instruct the light to turn off."""
|
|
# This allows transitioning to off, but resets the brightness
|
|
# to 1 for the next set_state(True) command
|
|
if not self._device_control:
|
|
return
|
|
transition_time = None
|
|
if ATTR_TRANSITION in kwargs:
|
|
transition_time = int(kwargs[ATTR_TRANSITION]) * 10
|
|
|
|
dimmer_data = {ATTR_DIMMER: 0, ATTR_TRANSITION_TIME: transition_time}
|
|
await self._api(self._device_control.set_dimmer(**dimmer_data))
|
|
else:
|
|
await self._api(self._device_control.set_state(False))
|
|
|
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
|
"""Instruct the light to turn on."""
|
|
if not self._device_control:
|
|
return
|
|
transition_time = None
|
|
if ATTR_TRANSITION in kwargs:
|
|
transition_time = int(kwargs[ATTR_TRANSITION]) * 10
|
|
|
|
dimmer_command = None
|
|
if ATTR_BRIGHTNESS in kwargs:
|
|
brightness = kwargs[ATTR_BRIGHTNESS]
|
|
brightness = min(brightness, 254)
|
|
dimmer_data = {
|
|
ATTR_DIMMER: brightness,
|
|
ATTR_TRANSITION_TIME: transition_time,
|
|
}
|
|
dimmer_command = self._device_control.set_dimmer(**dimmer_data)
|
|
transition_time = None
|
|
else:
|
|
dimmer_command = self._device_control.set_state(True)
|
|
|
|
color_command = None
|
|
if ATTR_HS_COLOR in kwargs and self._device_control.can_set_color:
|
|
hue = int(kwargs[ATTR_HS_COLOR][0] * (self._device_control.max_hue / 360))
|
|
sat = int(
|
|
kwargs[ATTR_HS_COLOR][1] * (self._device_control.max_saturation / 100)
|
|
)
|
|
color_data = {
|
|
ATTR_HUE: hue,
|
|
ATTR_SAT: sat,
|
|
ATTR_TRANSITION_TIME: transition_time,
|
|
}
|
|
color_command = self._device_control.set_hsb(**color_data)
|
|
transition_time = None
|
|
|
|
temp_command = None
|
|
if ATTR_COLOR_TEMP in kwargs and (
|
|
self._device_control.can_set_temp or self._device_control.can_set_color
|
|
):
|
|
temp = kwargs[ATTR_COLOR_TEMP]
|
|
# White Spectrum bulb
|
|
if self._device_control.can_set_temp:
|
|
if temp > self.max_mireds:
|
|
temp = self.max_mireds
|
|
elif temp < self.min_mireds:
|
|
temp = self.min_mireds
|
|
temp_data = {
|
|
ATTR_COLOR_TEMP: temp,
|
|
ATTR_TRANSITION_TIME: transition_time,
|
|
}
|
|
temp_command = self._device_control.set_color_temp(**temp_data)
|
|
transition_time = None
|
|
# Color bulb (CWS)
|
|
# color_temp needs to be set with hue/saturation
|
|
elif self._device_control.can_set_color:
|
|
temp_k = color_util.color_temperature_mired_to_kelvin(temp)
|
|
hs_color = color_util.color_temperature_to_hs(temp_k)
|
|
hue = int(hs_color[0] * (self._device_control.max_hue / 360))
|
|
sat = int(hs_color[1] * (self._device_control.max_saturation / 100))
|
|
color_data = {
|
|
ATTR_HUE: hue,
|
|
ATTR_SAT: sat,
|
|
ATTR_TRANSITION_TIME: transition_time,
|
|
}
|
|
color_command = self._device_control.set_hsb(**color_data)
|
|
transition_time = None
|
|
|
|
# HSB can always be set, but color temp + brightness is bulb dependent
|
|
if (command := dimmer_command) is not None:
|
|
command += color_command
|
|
else:
|
|
command = color_command
|
|
|
|
if self._device_control.can_combine_commands:
|
|
await self._api(command + temp_command)
|
|
else:
|
|
if temp_command is not None:
|
|
await self._api(temp_command)
|
|
if command is not None:
|
|
await self._api(command)
|
|
|
|
def _refresh(self, device: Command, write_ha: bool = True) -> None:
|
|
"""Refresh the light data."""
|
|
# Caching of LightControl and light object
|
|
self._device_control = device.light_control
|
|
self._device_data = device.light_control.lights[0]
|
|
super()._refresh(device, write_ha=write_ha)
|