Add a select entity for homekit temperature display units (#100853)

homeassistant/components/homekit_controller/select.py

@@ -1,18 +1,54 @@
 """Support for Homekit select entities."""
 from __future__ import annotations
 
-from aiohomekit.model.characteristics import Characteristic, CharacteristicsTypes
+from dataclasses import dataclass
+from enum import IntEnum
 
-from homeassistant.components.select import SelectEntity
+from aiohomekit.model.characteristics import Characteristic, CharacteristicsTypes
+from aiohomekit.model.characteristics.const import TemperatureDisplayUnits
+
+from homeassistant.components.select import SelectEntity, SelectEntityDescription
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import Platform
+from homeassistant.const import EntityCategory, Platform
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.typing import ConfigType
 
 from . import KNOWN_DEVICES
 from .connection import HKDevice
 from .entity import CharacteristicEntity
 
+
+@dataclass
+class HomeKitSelectEntityDescriptionRequired:
+    """Required fields for HomeKitSelectEntityDescription."""
+
+    choices: dict[str, IntEnum]
+
+
+@dataclass
+class HomeKitSelectEntityDescription(
+    SelectEntityDescription, HomeKitSelectEntityDescriptionRequired
+):
+    """A generic description of a select entity backed by a single characteristic."""
+
+    name: str | None = None
+
+
+SELECT_ENTITIES: dict[str, HomeKitSelectEntityDescription] = {
+    CharacteristicsTypes.TEMPERATURE_UNITS: HomeKitSelectEntityDescription(
+        key="temperature_display_units",
+        translation_key="temperature_display_units",
+        name="Temperature Display Units",
+        icon="mdi:thermometer",
+        entity_category=EntityCategory.CONFIG,
+        choices={
+            "celsius": TemperatureDisplayUnits.CELSIUS,
+            "fahrenheit": TemperatureDisplayUnits.FAHRENHEIT,
+        },
+    ),
+}
+
 _ECOBEE_MODE_TO_TEXT = {
     0: "home",
     1: "sleep",
@@ -21,7 +57,58 @@ _ECOBEE_MODE_TO_TEXT = {
 _ECOBEE_MODE_TO_NUMBERS = {v: k for (k, v) in _ECOBEE_MODE_TO_TEXT.items()}
 
 
-class EcobeeModeSelect(CharacteristicEntity, SelectEntity):
+class BaseHomeKitSelect(CharacteristicEntity, SelectEntity):
+    """Base entity for select entities backed by a single characteristics."""
+
+
+class HomeKitSelect(BaseHomeKitSelect):
+    """Representation of a select control on a homekit accessory."""
+
+    entity_description: HomeKitSelectEntityDescription
+
+    def __init__(
+        self,
+        conn: HKDevice,
+        info: ConfigType,
+        char: Characteristic,
+        description: HomeKitSelectEntityDescription,
+    ) -> None:
+        """Initialise a HomeKit select control."""
+        self.entity_description = description
+
+        self._choice_to_enum = self.entity_description.choices
+        self._enum_to_choice = {
+            v: k for (k, v) in self.entity_description.choices.items()
+        }
+
+        self._attr_options = list(self.entity_description.choices.keys())
+
+        super().__init__(conn, info, char)
+
+    def get_characteristic_types(self) -> list[str]:
+        """Define the homekit characteristics the entity cares about."""
+        return [self._char.type]
+
+    @property
+    def name(self) -> str | None:
+        """Return the name of the device if any."""
+        if name := self.accessory.name:
+            return f"{name} {self.entity_description.name}"
+        return self.entity_description.name
+
+    @property
+    def current_option(self) -> str | None:
+        """Return the current selected option."""
+        return self._enum_to_choice.get(self._char.value)
+
+    async def async_select_option(self, option: str) -> None:
+        """Set the current option."""
+        await self.async_put_characteristics(
+            {self._char.type: self._choice_to_enum[option]}
+        )
+
+
+class EcobeeModeSelect(BaseHomeKitSelect):
     """Represents a ecobee mode select entity."""
 
     _attr_options = ["home", "sleep", "away"]
@@ -64,14 +151,23 @@ async def async_setup_entry(
 
     @callback
     def async_add_characteristic(char: Characteristic) -> bool:
-        if char.type == CharacteristicsTypes.VENDOR_ECOBEE_CURRENT_MODE:
-            info = {"aid": char.service.accessory.aid, "iid": char.service.iid}
-            entity = EcobeeModeSelect(conn, info, char)
+        entities: list[BaseHomeKitSelect] = []
+        info = {"aid": char.service.accessory.aid, "iid": char.service.iid}
+
+        if description := SELECT_ENTITIES.get(char.type):
+            entities.append(HomeKitSelect(conn, info, char, description))
+        elif char.type == CharacteristicsTypes.VENDOR_ECOBEE_CURRENT_MODE:
+            entities.append(EcobeeModeSelect(conn, info, char))
+
+        if not entities:
+            return False
+
+        for entity in entities:
             conn.async_migrate_unique_id(
                 entity.old_unique_id, entity.unique_id, Platform.SELECT
             )
-            async_add_entities([entity])
-            return True
-        return False
+
+        async_add_entities(entities)
+        return True
 
     conn.add_char_factory(async_add_characteristic)