select.py

Go to the documentation of this file.

"""Support for KNX/IP select entities."""
 
from __future__ import annotations
 
from xknx import XKNX
from xknx.devices import Device as XknxDevice, RawValue
 
from homeassistant import config_entries
from homeassistant.components.select import SelectEntity
from homeassistant.const import (
    CONF_ENTITY_CATEGORY,
    CONF_NAME,
    CONF_PAYLOAD,
    STATE_UNAVAILABLE,
    STATE_UNKNOWN,
    Platform,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.typing import ConfigType
 
from . import KNXModule
from .const import (
    CONF_PAYLOAD_LENGTH,
    CONF_RESPOND_TO_READ,
    CONF_STATE_ADDRESS,
    CONF_SYNC_STATE,
    KNX_ADDRESS,
    KNX_MODULE_KEY,
)
from .entity import KnxYamlEntity
from .schema import SelectSchema
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: config_entries.ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up select(s) for KNX platform."""
    knx_module = hass.data[KNX_MODULE_KEY]
    config: list[ConfigType] = knx_module.config_yaml[Platform.SELECT]
 
    async_add_entities(KNXSelect(knx_module, entity_config) for entity_config in config)
 
 
def _create_raw_value(xknx: XKNX, config: ConfigType) -> RawValue:
    """Return a KNX RawValue to be used within XKNX."""
    return RawValue(
        xknx,
        name=config[CONF_NAME],
        payload_length=config[CONF_PAYLOAD_LENGTH],
        group_address=config[KNX_ADDRESS],
        group_address_state=config.get(CONF_STATE_ADDRESS),
        respond_to_read=config[CONF_RESPOND_TO_READ],
        sync_state=config[CONF_SYNC_STATE],
    )
 
 
class KNXSelect(KnxYamlEntity, SelectEntity, RestoreEntity):
    """Representation of a KNX select."""
 
    _device: RawValue
 
    def __init__(self, knx_module: KNXModule, config: ConfigType) -> None:
        """Initialize a KNX select."""
        super().__init__(
            knx_module=knx_module,
            device=_create_raw_value(knx_module.xknx, config),
        )
        self._option_payloads: dict[str, int] = {
            option[SelectSchema.CONF_OPTION]: option[CONF_PAYLOAD]
            for option in config[SelectSchema.CONF_OPTIONS]
        }
        self._attr_options_attr_options = list(self._option_payloads)
        self._attr_current_option_attr_current_option = None
        self._attr_entity_category_attr_entity_category = config.get(CONF_ENTITY_CATEGORY)
        self._attr_unique_id_attr_unique_id = str(self._device_device.remote_value.group_address)
 
    async def async_added_to_hass(self) -> None:
        """Restore last state."""
        await super().async_added_to_hass()
        if not self._device_device.remote_value.readable and (
            last_state := await self.async_get_last_stateasync_get_last_state()
        ):
            if (
                last_state.state not in (STATE_UNKNOWN, STATE_UNAVAILABLE)
                and (option := self._option_payloads.get(last_state.state)) is not None
            ):
                self._device_device.remote_value.update_value(option)
 
    def after_update_callback(self, device: XknxDevice) -> None:
        """Call after device was updated."""
        self._attr_current_option_attr_current_option = self.option_from_payloadoption_from_payload(
            self._device_device.remote_value.value
        )
        super().after_update_callback(device)
 
    def option_from_payload(self, payload: int | None) -> str | None:
        """Return the option a given payload is assigned to."""
        try:
            return next(
                key for key, value in self._option_payloads.items() if value == payload
            )
        except StopIteration:
            return None
 
    async def async_select_option(self, option: str) -> None:
        """Change the selected option."""
        payload = self._option_payloads[option]
        await self._device_device.set(payload)