Add Aprilaire air cleaning and fresh air functionality (#120174)

* Add custom services for Aprilaire

* Add icons.json

* Use select/number entities instead of services

* Remove unneeded consts

* Remove number platform

* Code review updates

* Update homeassistant/components/aprilaire/strings.json

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Code review updates

---------

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

.coveragerc

@@ -87,6 +87,7 @@ omit =
     homeassistant/components/aprilaire/climate.py
     homeassistant/components/aprilaire/coordinator.py
     homeassistant/components/aprilaire/entity.py
+    homeassistant/components/aprilaire/select.py
     homeassistant/components/aprilaire/sensor.py
     homeassistant/components/apsystems/__init__.py
     homeassistant/components/apsystems/coordinator.py

homeassistant/components/aprilaire/__init__.py

@@ -15,7 +15,11 @@ from homeassistant.helpers.device_registry import format_mac
 from .const import DOMAIN
 from .coordinator import AprilaireCoordinator
 
-PLATFORMS: list[Platform] = [Platform.CLIMATE, Platform.SENSOR]
+PLATFORMS: list[Platform] = [
+    Platform.CLIMATE,
+    Platform.SELECT,
+    Platform.SENSOR,
+]
 
 _LOGGER = logging.getLogger(__name__)
 

homeassistant/components/aprilaire/select.py

@@ -0,0 +1,153 @@
+"""The Aprilaire select component."""
+
+from __future__ import annotations
+
+from collections.abc import Awaitable, Callable
+from dataclasses import dataclass
+from typing import cast
+
+from pyaprilaire.const import Attribute
+
+from homeassistant.components.select import SelectEntity, SelectEntityDescription
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .const import DOMAIN
+from .coordinator import AprilaireCoordinator
+from .entity import BaseAprilaireEntity
+
+AIR_CLEANING_EVENT_MAP = {0: "off", 3: "event_clean", 4: "allergies"}
+AIR_CLEANING_MODE_MAP = {0: "off", 1: "constant_clean", 2: "automatic"}
+FRESH_AIR_EVENT_MAP = {0: "off", 2: "3hour", 3: "24hour"}
+FRESH_AIR_MODE_MAP = {0: "off", 1: "automatic"}
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up Aprilaire select devices."""
+
+    coordinator: AprilaireCoordinator = hass.data[DOMAIN][config_entry.unique_id]
+
+    assert config_entry.unique_id is not None
+
+    descriptions: list[AprilaireSelectDescription] = []
+
+    if coordinator.data.get(Attribute.AIR_CLEANING_AVAILABLE) == 1:
+        descriptions.extend(
+            [
+                AprilaireSelectDescription(
+                    key="air_cleaning_event",
+                    translation_key="air_cleaning_event",
+                    options_map=AIR_CLEANING_EVENT_MAP,
+                    event_value_key=Attribute.AIR_CLEANING_EVENT,
+                    mode_value_key=Attribute.AIR_CLEANING_MODE,
+                    is_event=True,
+                    select_option_fn=coordinator.client.set_air_cleaning,
+                ),
+                AprilaireSelectDescription(
+                    key="air_cleaning_mode",
+                    translation_key="air_cleaning_mode",
+                    options_map=AIR_CLEANING_MODE_MAP,
+                    event_value_key=Attribute.AIR_CLEANING_EVENT,
+                    mode_value_key=Attribute.AIR_CLEANING_MODE,
+                    is_event=False,
+                    select_option_fn=coordinator.client.set_air_cleaning,
+                ),
+            ]
+        )
+
+    if coordinator.data.get(Attribute.VENTILATION_AVAILABLE) == 1:
+        descriptions.extend(
+            [
+                AprilaireSelectDescription(
+                    key="fresh_air_event",
+                    translation_key="fresh_air_event",
+                    options_map=FRESH_AIR_EVENT_MAP,
+                    event_value_key=Attribute.FRESH_AIR_EVENT,
+                    mode_value_key=Attribute.FRESH_AIR_MODE,
+                    is_event=True,
+                    select_option_fn=coordinator.client.set_fresh_air,
+                ),
+                AprilaireSelectDescription(
+                    key="fresh_air_mode",
+                    translation_key="fresh_air_mode",
+                    options_map=FRESH_AIR_MODE_MAP,
+                    event_value_key=Attribute.FRESH_AIR_EVENT,
+                    mode_value_key=Attribute.FRESH_AIR_MODE,
+                    is_event=False,
+                    select_option_fn=coordinator.client.set_fresh_air,
+                ),
+            ]
+        )
+
+    async_add_entities(
+        AprilaireSelectEntity(coordinator, description, config_entry.unique_id)
+        for description in descriptions
+    )
+
+
+@dataclass(frozen=True, kw_only=True)
+class AprilaireSelectDescription(SelectEntityDescription):
+    """Class describing Aprilaire select entities."""
+
+    options_map: dict[int, str]
+    event_value_key: str
+    mode_value_key: str
+    is_event: bool
+    select_option_fn: Callable[[int, int], Awaitable]
+
+
+class AprilaireSelectEntity(BaseAprilaireEntity, SelectEntity):
+    """Base select entity for Aprilaire."""
+
+    entity_description: AprilaireSelectDescription
+
+    def __init__(
+        self,
+        coordinator: AprilaireCoordinator,
+        description: AprilaireSelectDescription,
+        unique_id: str,
+    ) -> None:
+        """Initialize a select for an Aprilaire device."""
+
+        self.entity_description = description
+        self.values_map = {v: k for k, v in description.options_map.items()}
+
+        super().__init__(coordinator, unique_id)
+
+        self._attr_options = list(description.options_map.values())
+
+    @property
+    def current_option(self) -> str:
+        """Get the current option."""
+
+        if self.entity_description.is_event:
+            value_key = self.entity_description.event_value_key
+        else:
+            value_key = self.entity_description.mode_value_key
+
+        current_value = int(self.coordinator.data.get(value_key, 0))
+
+        return self.entity_description.options_map.get(current_value, "off")
+
+    async def async_select_option(self, option: str) -> None:
+        """Set the current option."""
+
+        if self.entity_description.is_event:
+            event_value = self.values_map[option]
+
+            mode_value = cast(
+                int, self.coordinator.data.get(self.entity_description.mode_value_key)
+            )
+        else:
+            mode_value = self.values_map[option]
+
+            event_value = cast(
+                int, self.coordinator.data.get(self.entity_description.event_value_key)
+            )
+
+        await self.entity_description.select_option_fn(mode_value, event_value)

homeassistant/components/aprilaire/strings.json

@@ -24,6 +24,39 @@
         "name": "Thermostat"
       }
     },
+    "select": {
+      "air_cleaning_event": {
+        "name": "Air cleaning event",
+        "state": {
+          "off": "[%key:common::state::off%]",
+          "event_clean": "Event clean (3 hour)",
+          "allergies": "Allergies (24 hour)"
+        }
+      },
+      "air_cleaning_mode": {
+        "name": "Air cleaning mode",
+        "state": {
+          "off": "[%key:common::state::off%]",
+          "constant_clean": "Constant clean",
+          "automatic": "Automatic"
+        }
+      },
+      "fresh_air_event": {
+        "name": "Fresh air event",
+        "state": {
+          "off": "[%key:common::state::off%]",
+          "3hour": "3 hour event",
+          "24hour": "24 hour event"
+        }
+      },
+      "fresh_air_mode": {
+        "name": "Fresh air mode",
+        "state": {
+          "off": "[%key:common::state::off%]",
+          "automatic": "[%key:component::aprilaire::entity::select::air_cleaning_mode::state::automatic%]"
+        }
+      }
+    },
     "sensor": {
       "indoor_humidity_controlling_sensor": {
         "name": "Indoor humidity controlling sensor"