Allow to configure KNX time, date & datetime entities via UI

homeassistant/components/knx/const.py

@@ -162,8 +162,11 @@ class FanZeroMode(StrEnum):
     Platform.BINARY_SENSOR,
     Platform.CLIMATE,
     Platform.COVER,
+    Platform.DATE,
+    Platform.DATETIME,
     Platform.LIGHT,
     Platform.SWITCH,
+    Platform.TIME,
 }
 
 # Map KNX controller modes to HA modes. This list might not be complete.

homeassistant/components/knx/date.py

@@ -3,8 +3,8 @@
 from __future__ import annotations
 
 from datetime import date as dt_date
+from typing import Any
 
-from xknx import XKNX
 from xknx.devices import DateDevice as XknxDateDevice
 from xknx.dpt.dpt_11 import KNXDate as XKNXDate
 
@@ -18,19 +18,25 @@
     Platform,
 )
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+from homeassistant.helpers.entity_platform import (
+    AddConfigEntryEntitiesCallback,
+    async_get_current_platform,
+)
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType
 
 from .const import (
     CONF_RESPOND_TO_READ,
     CONF_STATE_ADDRESS,
     CONF_SYNC_STATE,
+    DOMAIN,
     KNX_ADDRESS,
     KNX_MODULE_KEY,
 )
-from .entity import KnxYamlEntity
+from .entity import KnxUiEntity, KnxUiEntityPlatformController, KnxYamlEntity
 from .knx_module import KNXModule
+from .storage.const import CONF_ENTITY, CONF_GA_DATE
+from .storage.util import ConfigExtractor
 
 
 async def async_setup_entry(
@@ -40,40 +46,36 @@ async def async_setup_entry(
 ) -> None:
     """Set up entities for KNX platform."""
     knx_module = hass.data[KNX_MODULE_KEY]
-    config: list[ConfigType] = knx_module.config_yaml[Platform.DATE]
-
-    async_add_entities(
-        KNXDateEntity(knx_module, entity_config) for entity_config in config
+    platform = async_get_current_platform()
+    knx_module.config_store.add_platform(
+        platform=Platform.DATE,
+        controller=KnxUiEntityPlatformController(
+            knx_module=knx_module,
+            entity_platform=platform,
+            entity_class=KnxUiDate,
+        ),
     )
 
-
-def _create_xknx_device(xknx: XKNX, config: ConfigType) -> XknxDateDevice:
-    """Return a XKNX DateTime object to be used within XKNX."""
-    return XknxDateDevice(
-        xknx,
-        name=config[CONF_NAME],
-        localtime=False,
-        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],
-    )
+    entities: list[KnxYamlEntity | KnxUiEntity] = []
+    if yaml_platform_config := knx_module.config_yaml.get(Platform.DATE):
+        entities.extend(
+            KnxYamlDate(knx_module, entity_config)
+            for entity_config in yaml_platform_config
+        )
+    if ui_config := knx_module.config_store.data["entities"].get(Platform.DATE):
+        entities.extend(
+            KnxUiDate(knx_module, unique_id, config)
+            for unique_id, config in ui_config.items()
+        )
+    if entities:
+        async_add_entities(entities)
 
 
-class KNXDateEntity(KnxYamlEntity, DateEntity, RestoreEntity):
+class _KNXDate(DateEntity, RestoreEntity):
     """Representation of a KNX date."""
 
     _device: XknxDateDevice
 
-    def __init__(self, knx_module: KNXModule, config: ConfigType) -> None:
-        """Initialize a KNX time."""
-        super().__init__(
-            knx_module=knx_module,
-            device=_create_xknx_device(knx_module.xknx, config),
-        )
-        self._attr_entity_category = config.get(CONF_ENTITY_CATEGORY)
-        self._attr_unique_id = str(self._device.remote_value.group_address)
-
     async def async_added_to_hass(self) -> None:
         """Restore last state."""
         await super().async_added_to_hass()
@@ -94,3 +96,52 @@ def native_value(self) -> dt_date | None:
     async def async_set_value(self, value: dt_date) -> None:
         """Change the value."""
         await self._device.set(value)
+
+
+class KnxYamlDate(_KNXDate, KnxYamlEntity):
+    """Representation of a KNX date configured from YAML."""
+
+    _device: XknxDateDevice
+
+    def __init__(self, knx_module: KNXModule, config: ConfigType) -> None:
+        """Initialize a KNX date."""
+        super().__init__(
+            knx_module=knx_module,
+            device=XknxDateDevice(
+                knx_module.xknx,
+                name=config[CONF_NAME],
+                localtime=False,
+                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],
+            ),
+        )
+        self._attr_entity_category = config.get(CONF_ENTITY_CATEGORY)
+        self._attr_unique_id = str(self._device.remote_value.group_address)
+
+
+class KnxUiDate(_KNXDate, KnxUiEntity):
+    """Representation of a KNX date configured from the UI."""
+
+    _device: XknxDateDevice
+
+    def __init__(
+        self, knx_module: KNXModule, unique_id: str, config: dict[str, Any]
+    ) -> None:
+        """Initialize KNX date."""
+        super().__init__(
+            knx_module=knx_module,
+            unique_id=unique_id,
+            entity_config=config[CONF_ENTITY],
+        )
+        knx_conf = ConfigExtractor(config[DOMAIN])
+        self._device = XknxDateDevice(
+            knx_module.xknx,
+            name=config[CONF_ENTITY][CONF_NAME],
+            localtime=False,
+            group_address=knx_conf.get_write(CONF_GA_DATE),
+            group_address_state=knx_conf.get_state_and_passive(CONF_GA_DATE),
+            respond_to_read=knx_conf.get(CONF_RESPOND_TO_READ),
+            sync_state=knx_conf.get(CONF_SYNC_STATE),
+        )

homeassistant/components/knx/datetime.py

@@ -3,8 +3,8 @@
 from __future__ import annotations
 
 from datetime import datetime
+from typing import Any
 
-from xknx import XKNX
 from xknx.devices import DateTimeDevice as XknxDateTimeDevice
 from xknx.dpt.dpt_19 import KNXDateTime as XKNXDateTime
 
@@ -18,7 +18,10 @@
     Platform,
 )
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+from homeassistant.helpers.entity_platform import (
+    AddConfigEntryEntitiesCallback,
+    async_get_current_platform,
+)
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType
 from homeassistant.util import dt as dt_util
@@ -27,11 +30,14 @@
     CONF_RESPOND_TO_READ,
     CONF_STATE_ADDRESS,
     CONF_SYNC_STATE,
+    DOMAIN,
     KNX_ADDRESS,
     KNX_MODULE_KEY,
 )
-from .entity import KnxYamlEntity
+from .entity import KnxUiEntity, KnxUiEntityPlatformController, KnxYamlEntity
 from .knx_module import KNXModule
+from .storage.const import CONF_ENTITY, CONF_GA_DATETIME
+from .storage.util import ConfigExtractor
 
 
 async def async_setup_entry(
@@ -41,40 +47,36 @@ async def async_setup_entry(
 ) -> None:
     """Set up entities for KNX platform."""
     knx_module = hass.data[KNX_MODULE_KEY]
-    config: list[ConfigType] = knx_module.config_yaml[Platform.DATETIME]
-
-    async_add_entities(
-        KNXDateTimeEntity(knx_module, entity_config) for entity_config in config
+    platform = async_get_current_platform()
+    knx_module.config_store.add_platform(
+        platform=Platform.DATETIME,
+        controller=KnxUiEntityPlatformController(
+            knx_module=knx_module,
+            entity_platform=platform,
+            entity_class=KnxUiDateTime,
+        ),
     )
 
-
-def _create_xknx_device(xknx: XKNX, config: ConfigType) -> XknxDateTimeDevice:
-    """Return a XKNX DateTime object to be used within XKNX."""
-    return XknxDateTimeDevice(
-        xknx,
-        name=config[CONF_NAME],
-        localtime=False,
-        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],
-    )
+    entities: list[KnxYamlEntity | KnxUiEntity] = []
+    if yaml_platform_config := knx_module.config_yaml.get(Platform.DATETIME):
+        entities.extend(
+            KnxYamlDateTime(knx_module, entity_config)
+            for entity_config in yaml_platform_config
+        )
+    if ui_config := knx_module.config_store.data["entities"].get(Platform.DATETIME):
+        entities.extend(
+            KnxUiDateTime(knx_module, unique_id, config)
+            for unique_id, config in ui_config.items()
+        )
+    if entities:
+        async_add_entities(entities)
 
 
-class KNXDateTimeEntity(KnxYamlEntity, DateTimeEntity, RestoreEntity):
+class _KNXDateTime(DateTimeEntity, RestoreEntity):
     """Representation of a KNX datetime."""
 
     _device: XknxDateTimeDevice
 
-    def __init__(self, knx_module: KNXModule, config: ConfigType) -> None:
-        """Initialize a KNX time."""
-        super().__init__(
-            knx_module=knx_module,
-            device=_create_xknx_device(knx_module.xknx, config),
-        )
-        self._attr_entity_category = config.get(CONF_ENTITY_CATEGORY)
-        self._attr_unique_id = str(self._device.remote_value.group_address)
-
     async def async_added_to_hass(self) -> None:
         """Restore last state."""
         await super().async_added_to_hass()
@@ -99,3 +101,52 @@ def native_value(self) -> datetime | None:
     async def async_set_value(self, value: datetime) -> None:
         """Change the value."""
         await self._device.set(value.astimezone(dt_util.get_default_time_zone()))
+
+
+class KnxYamlDateTime(_KNXDateTime, KnxYamlEntity):
+    """Representation of a KNX datetime configured from YAML."""
+
+    _device: XknxDateTimeDevice
+
+    def __init__(self, knx_module: KNXModule, config: ConfigType) -> None:
+        """Initialize a KNX datetime."""
+        super().__init__(
+            knx_module=knx_module,
+            device=XknxDateTimeDevice(
+                knx_module.xknx,
+                name=config[CONF_NAME],
+                localtime=False,
+                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],
+            ),
+        )
+        self._attr_entity_category = config.get(CONF_ENTITY_CATEGORY)
+        self._attr_unique_id = str(self._device.remote_value.group_address)
+
+
+class KnxUiDateTime(_KNXDateTime, KnxUiEntity):
+    """Representation of a KNX datetime configured from the UI."""
+
+    _device: XknxDateTimeDevice
+
+    def __init__(
+        self, knx_module: KNXModule, unique_id: str, config: dict[str, Any]
+    ) -> None:
+        """Initialize KNX datetime."""
+        super().__init__(
+            knx_module=knx_module,
+            unique_id=unique_id,
+            entity_config=config[CONF_ENTITY],
+        )
+        knx_conf = ConfigExtractor(config[DOMAIN])
+        self._device = XknxDateTimeDevice(
+            knx_module.xknx,
+            name=config[CONF_ENTITY][CONF_NAME],
+            localtime=False,
+            group_address=knx_conf.get_write(CONF_GA_DATETIME),
+            group_address_state=knx_conf.get_state_and_passive(CONF_GA_DATETIME),
+            respond_to_read=knx_conf.get(CONF_RESPOND_TO_READ),
+            sync_state=knx_conf.get(CONF_SYNC_STATE),
+        )

homeassistant/components/knx/storage/const.py

@@ -13,6 +13,9 @@
 
 CONF_GA_SENSOR: Final = "ga_sensor"
 CONF_GA_SWITCH: Final = "ga_switch"
+CONF_GA_DATE: Final = "ga_date"
+CONF_GA_DATETIME: Final = "ga_datetime"
+CONF_GA_TIME: Final = "ga_time"
 
 # Climate
 CONF_GA_TEMPERATURE_CURRENT: Final = "ga_temperature_current"

homeassistant/components/knx/storage/entity_store_schema.py

@@ -46,6 +46,8 @@
     CONF_GA_COLOR_TEMP,
     CONF_GA_CONTROLLER_MODE,
     CONF_GA_CONTROLLER_STATUS,
+    CONF_GA_DATE,
+    CONF_GA_DATETIME,
     CONF_GA_FAN_SPEED,
     CONF_GA_FAN_SWING,
     CONF_GA_FAN_SWING_HORIZONTAL,
@@ -72,6 +74,7 @@
     CONF_GA_SWITCH,
     CONF_GA_TEMPERATURE_CURRENT,
     CONF_GA_TEMPERATURE_TARGET,
+    CONF_GA_TIME,
     CONF_GA_UP_DOWN,
     CONF_GA_VALVE,
     CONF_GA_WHITE_BRIGHTNESS,
@@ -199,6 +202,24 @@
     ),
 )
 
+DATE_KNX_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_GA_DATE): GASelector(write_required=True, valid_dpt="11.001"),
+        vol.Optional(CONF_RESPOND_TO_READ, default=False): selector.BooleanSelector(),
+        vol.Optional(CONF_SYNC_STATE, default=True): SyncStateSelector(),
+    }
+)
+
+DATETIME_KNX_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_GA_DATETIME): GASelector(
+            write_required=True, valid_dpt="19.001"
+        ),
+        vol.Optional(CONF_RESPOND_TO_READ, default=False): selector.BooleanSelector(),
+        vol.Optional(CONF_SYNC_STATE, default=True): SyncStateSelector(),
+    }
+)
+
 
 @unique
 class LightColorMode(StrEnum):
@@ -336,6 +357,14 @@ class LightColorMode(StrEnum):
     },
 )
 
+TIME_KNX_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_GA_TIME): GASelector(write_required=True, valid_dpt="10.001"),
+        vol.Optional(CONF_RESPOND_TO_READ, default=False): selector.BooleanSelector(),
+        vol.Optional(CONF_SYNC_STATE, default=True): SyncStateSelector(),
+    }
+)
+
 
 @unique
 class ConfSetpointShiftMode(StrEnum):
@@ -482,8 +511,11 @@ class ConfClimateFanSpeedMode(StrEnum):
     Platform.BINARY_SENSOR: BINARY_SENSOR_KNX_SCHEMA,
     Platform.CLIMATE: CLIMATE_KNX_SCHEMA,
     Platform.COVER: COVER_KNX_SCHEMA,
+    Platform.DATE: DATE_KNX_SCHEMA,
+    Platform.DATETIME: DATETIME_KNX_SCHEMA,
     Platform.LIGHT: LIGHT_KNX_SCHEMA,
     Platform.SWITCH: SWITCH_KNX_SCHEMA,
+    Platform.TIME: TIME_KNX_SCHEMA,
 }
 
 ENTITY_STORE_DATA_SCHEMA: VolSchemaType = vol.All(