226 lines
7.7 KiB
Python
226 lines
7.7 KiB
Python
"""Support for LCN lights."""
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
import pypck
|
|
|
|
from homeassistant.components.light import (
|
|
ATTR_BRIGHTNESS,
|
|
ATTR_TRANSITION,
|
|
DOMAIN as DOMAIN_LIGHT,
|
|
ColorMode,
|
|
LightEntity,
|
|
LightEntityFeature,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_ADDRESS, CONF_DOMAIN, CONF_ENTITIES
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType
|
|
|
|
from . import LcnEntity
|
|
from .const import (
|
|
CONF_DIMMABLE,
|
|
CONF_DOMAIN_DATA,
|
|
CONF_OUTPUT,
|
|
CONF_TRANSITION,
|
|
OUTPUT_PORTS,
|
|
)
|
|
from .helpers import DeviceConnectionType, InputType, get_device_connection
|
|
|
|
PARALLEL_UPDATES = 0
|
|
|
|
|
|
def create_lcn_light_entity(
|
|
hass: HomeAssistant, entity_config: ConfigType, config_entry: ConfigEntry
|
|
) -> LcnEntity:
|
|
"""Set up an entity for this domain."""
|
|
device_connection = get_device_connection(
|
|
hass, entity_config[CONF_ADDRESS], config_entry
|
|
)
|
|
|
|
if entity_config[CONF_DOMAIN_DATA][CONF_OUTPUT] in OUTPUT_PORTS:
|
|
return LcnOutputLight(entity_config, config_entry.entry_id, device_connection)
|
|
# in RELAY_PORTS
|
|
return LcnRelayLight(entity_config, config_entry.entry_id, device_connection)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up LCN light entities from a config entry."""
|
|
entities = []
|
|
|
|
for entity_config in config_entry.data[CONF_ENTITIES]:
|
|
if entity_config[CONF_DOMAIN] == DOMAIN_LIGHT:
|
|
entities.append(create_lcn_light_entity(hass, entity_config, config_entry))
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
class LcnOutputLight(LcnEntity, LightEntity):
|
|
"""Representation of a LCN light for output ports."""
|
|
|
|
_attr_supported_features = LightEntityFeature.TRANSITION
|
|
|
|
def __init__(
|
|
self, config: ConfigType, entry_id: str, device_connection: DeviceConnectionType
|
|
) -> None:
|
|
"""Initialize the LCN light."""
|
|
super().__init__(config, entry_id, device_connection)
|
|
|
|
self.output = pypck.lcn_defs.OutputPort[config[CONF_DOMAIN_DATA][CONF_OUTPUT]]
|
|
|
|
self._transition = pypck.lcn_defs.time_to_ramp_value(
|
|
config[CONF_DOMAIN_DATA][CONF_TRANSITION]
|
|
)
|
|
self.dimmable = config[CONF_DOMAIN_DATA][CONF_DIMMABLE]
|
|
|
|
self._brightness = 255
|
|
self._is_on = False
|
|
self._is_dimming_to_zero = False
|
|
|
|
if self.dimmable:
|
|
self._attr_color_mode = ColorMode.BRIGHTNESS
|
|
else:
|
|
self._attr_color_mode = ColorMode.ONOFF
|
|
self._attr_supported_color_modes = {self._attr_color_mode}
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Run when entity about to be added to hass."""
|
|
await super().async_added_to_hass()
|
|
if not self.device_connection.is_group:
|
|
await self.device_connection.activate_status_request_handler(self.output)
|
|
|
|
async def async_will_remove_from_hass(self) -> None:
|
|
"""Run when entity will be removed from hass."""
|
|
await super().async_will_remove_from_hass()
|
|
if not self.device_connection.is_group:
|
|
await self.device_connection.cancel_status_request_handler(self.output)
|
|
|
|
@property
|
|
def brightness(self) -> int | None:
|
|
"""Return the brightness of this light between 0..255."""
|
|
return self._brightness
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""Return True if entity is on."""
|
|
return self._is_on
|
|
|
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
|
"""Turn the entity on."""
|
|
if ATTR_BRIGHTNESS in kwargs:
|
|
percent = int(kwargs[ATTR_BRIGHTNESS] / 255.0 * 100)
|
|
else:
|
|
percent = 100
|
|
if ATTR_TRANSITION in kwargs:
|
|
transition = pypck.lcn_defs.time_to_ramp_value(
|
|
kwargs[ATTR_TRANSITION] * 1000
|
|
)
|
|
else:
|
|
transition = self._transition
|
|
|
|
if not await self.device_connection.dim_output(
|
|
self.output.value, percent, transition
|
|
):
|
|
return
|
|
self._is_on = True
|
|
self._is_dimming_to_zero = False
|
|
self.async_write_ha_state()
|
|
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
"""Turn the entity off."""
|
|
if ATTR_TRANSITION in kwargs:
|
|
transition = pypck.lcn_defs.time_to_ramp_value(
|
|
kwargs[ATTR_TRANSITION] * 1000
|
|
)
|
|
else:
|
|
transition = self._transition
|
|
|
|
if not await self.device_connection.dim_output(
|
|
self.output.value, 0, transition
|
|
):
|
|
return
|
|
self._is_dimming_to_zero = bool(transition)
|
|
self._is_on = False
|
|
self.async_write_ha_state()
|
|
|
|
def input_received(self, input_obj: InputType) -> None:
|
|
"""Set light state when LCN input object (command) is received."""
|
|
if (
|
|
not isinstance(input_obj, pypck.inputs.ModStatusOutput)
|
|
or input_obj.get_output_id() != self.output.value
|
|
):
|
|
return
|
|
|
|
self._brightness = int(input_obj.get_percent() / 100.0 * 255)
|
|
if self.brightness == 0:
|
|
self._is_dimming_to_zero = False
|
|
if not self._is_dimming_to_zero and self.brightness is not None:
|
|
self._is_on = self.brightness > 0
|
|
self.async_write_ha_state()
|
|
|
|
|
|
class LcnRelayLight(LcnEntity, LightEntity):
|
|
"""Representation of a LCN light for relay ports."""
|
|
|
|
_attr_color_mode = ColorMode.ONOFF
|
|
_attr_supported_color_modes = {ColorMode.ONOFF}
|
|
|
|
def __init__(
|
|
self, config: ConfigType, entry_id: str, device_connection: DeviceConnectionType
|
|
) -> None:
|
|
"""Initialize the LCN light."""
|
|
super().__init__(config, entry_id, device_connection)
|
|
|
|
self.output = pypck.lcn_defs.RelayPort[config[CONF_DOMAIN_DATA][CONF_OUTPUT]]
|
|
|
|
self._is_on = False
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Run when entity about to be added to hass."""
|
|
await super().async_added_to_hass()
|
|
if not self.device_connection.is_group:
|
|
await self.device_connection.activate_status_request_handler(self.output)
|
|
|
|
async def async_will_remove_from_hass(self) -> None:
|
|
"""Run when entity will be removed from hass."""
|
|
await super().async_will_remove_from_hass()
|
|
if not self.device_connection.is_group:
|
|
await self.device_connection.cancel_status_request_handler(self.output)
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""Return True if entity is on."""
|
|
return self._is_on
|
|
|
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
|
"""Turn the entity on."""
|
|
states = [pypck.lcn_defs.RelayStateModifier.NOCHANGE] * 8
|
|
states[self.output.value] = pypck.lcn_defs.RelayStateModifier.ON
|
|
if not await self.device_connection.control_relays(states):
|
|
return
|
|
self._is_on = True
|
|
self.async_write_ha_state()
|
|
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
"""Turn the entity off."""
|
|
states = [pypck.lcn_defs.RelayStateModifier.NOCHANGE] * 8
|
|
states[self.output.value] = pypck.lcn_defs.RelayStateModifier.OFF
|
|
if not await self.device_connection.control_relays(states):
|
|
return
|
|
self._is_on = False
|
|
self.async_write_ha_state()
|
|
|
|
def input_received(self, input_obj: InputType) -> None:
|
|
"""Set light state when LCN input object (command) is received."""
|
|
if not isinstance(input_obj, pypck.inputs.ModStatusRelays):
|
|
return
|
|
|
|
self._is_on = input_obj.get_state(self.output.value)
|
|
self.async_write_ha_state()
|