Use EntityDescription - toon (#55035)

homeassistant/components/toon/sensor.py

@@ -1,21 +1,29 @@
 """Support for Toon sensors."""
 from __future__ import annotations
 
-from homeassistant.components.sensor import ATTR_STATE_CLASS, SensorEntity
+from dataclasses import dataclass
+
+from homeassistant.components.sensor import (
+    STATE_CLASS_MEASUREMENT,
+    STATE_CLASS_TOTAL_INCREASING,
+    SensorEntity,
+    SensorEntityDescription,
+)
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import (
+    DEVICE_CLASS_ENERGY,
+    DEVICE_CLASS_GAS,
+    DEVICE_CLASS_POWER,
+    DEVICE_CLASS_TEMPERATURE,
+    ENERGY_KILO_WATT_HOUR,
+    PERCENTAGE,
+    POWER_WATT,
+    TEMP_CELSIUS,
+    VOLUME_CUBIC_METERS,
+)
 from homeassistant.core import HomeAssistant
 
-from .const import (
-    ATTR_DEFAULT_ENABLED,
-    ATTR_DEVICE_CLASS,
-    ATTR_ICON,
-    ATTR_MEASUREMENT,
-    ATTR_NAME,
-    ATTR_SECTION,
-    ATTR_UNIT_OF_MEASUREMENT,
-    DOMAIN,
-    SENSOR_ENTITIES,
-)
+from .const import CURRENCY_EUR, DOMAIN, VOLUME_CM3, VOLUME_LMIN
 from .coordinator import ToonDataUpdateCoordinator
 from .models import (
     ToonBoilerDeviceEntity,
@@ -23,6 +31,7 @@ from .models import (
     ToonElectricityMeterDeviceEntity,
     ToonEntity,
     ToonGasMeterDeviceEntity,
+    ToonRequiredKeysMixin,
     ToonSolarDeviceEntity,
     ToonWaterMeterDeviceEntity,
 )
@@ -34,112 +43,54 @@ async def async_setup_entry(
     """Set up Toon sensors based on a config entry."""
     coordinator = hass.data[DOMAIN][entry.entry_id]
 
-    sensors = [
-        ToonElectricityMeterDeviceSensor(coordinator, key=key)
-        for key in (
-            "power_average_daily",
-            "power_average",
-            "power_daily_cost",
-            "power_daily_value",
-            "power_meter_reading_low",
-            "power_meter_reading",
-            "power_value",
-            "solar_meter_reading_low_produced",
-            "solar_meter_reading_produced",
-        )
+    entities = [
+        description.cls(coordinator, description) for description in SENSOR_ENTITIES
     ]
 
-    sensors.extend(
-        [ToonDisplayDeviceSensor(coordinator, key="current_display_temperature")]
-    )
-
-    sensors.extend(
-        [
-            ToonGasMeterDeviceSensor(coordinator, key=key)
-            for key in (
-                "gas_average_daily",
-                "gas_average",
-                "gas_daily_cost",
-                "gas_daily_usage",
-                "gas_meter_reading",
-                "gas_value",
-            )
-        ]
-    )
-
-    sensors.extend(
-        [
-            ToonWaterMeterDeviceSensor(coordinator, key=key)
-            for key in (
-                "water_average_daily",
-                "water_average",
-                "water_daily_cost",
-                "water_daily_usage",
-                "water_meter_reading",
-                "water_value",
-            )
-        ]
-    )
-
     if coordinator.data.agreement.is_toon_solar:
-        sensors.extend(
+        entities.extend(
             [
-                ToonSolarDeviceSensor(coordinator, key=key)
-                for key in (
-                    "solar_value",
-                    "solar_maximum",
-                    "solar_produced",
-                    "solar_average_produced",
-                    "power_usage_day_produced_solar",
-                    "power_usage_day_from_grid_usage",
-                    "power_usage_day_to_grid_usage",
-                    "power_usage_current_covered_by_solar",
-                )
+                description.cls(coordinator, description)
+                for description in SENSOR_ENTITIES_SOLAR
             ]
         )
 
     if coordinator.data.thermostat.have_opentherm_boiler:
-        sensors.extend(
+        entities.extend(
             [
-                ToonBoilerDeviceSensor(
-                    coordinator, key="thermostat_info_current_modulation_level"
-                )
+                description.cls(coordinator, description)
+                for description in SENSOR_ENTITIES_BOILER
             ]
         )
 
-    async_add_entities(sensors, True)
+    async_add_entities(entities, True)
 
 
 class ToonSensor(ToonEntity, SensorEntity):
     """Defines a Toon sensor."""
 
-    def __init__(self, coordinator: ToonDataUpdateCoordinator, *, key: str) -> None:
+    entity_description: ToonSensorEntityDescription
+
+    def __init__(
+        self,
+        coordinator: ToonDataUpdateCoordinator,
+        description: ToonSensorEntityDescription,
+    ) -> None:
         """Initialize the Toon sensor."""
-        self.key = key
+        self.entity_description = description
         super().__init__(coordinator)
 
-        sensor = SENSOR_ENTITIES[key]
-        self._attr_entity_registry_enabled_default = sensor.get(
-            ATTR_DEFAULT_ENABLED, True
-        )
-        self._attr_icon = sensor.get(ATTR_ICON)
-        self._attr_name = sensor[ATTR_NAME]
-        self._attr_state_class = sensor.get(ATTR_STATE_CLASS)
-        self._attr_native_unit_of_measurement = sensor[ATTR_UNIT_OF_MEASUREMENT]
-        self._attr_device_class = sensor.get(ATTR_DEVICE_CLASS)
         self._attr_unique_id = (
             # This unique ID is a bit ugly and contains unneeded information.
             # It is here for legacy / backward compatible reasons.
-            f"{DOMAIN}_{coordinator.data.agreement.agreement_id}_sensor_{key}"
+            f"{DOMAIN}_{coordinator.data.agreement.agreement_id}_sensor_{description.key}"
         )
 
     @property
     def native_value(self) -> str | None:
         """Return the state of the sensor."""
-        section = getattr(
-            self.coordinator.data, SENSOR_ENTITIES[self.key][ATTR_SECTION]
-        )
-        return getattr(section, SENSOR_ENTITIES[self.key][ATTR_MEASUREMENT])
+        section = getattr(self.coordinator.data, self.entity_description.section)
+        return getattr(section, self.entity_description.measurement)
 
 
 class ToonElectricityMeterDeviceSensor(ToonSensor, ToonElectricityMeterDeviceEntity):
@@ -164,3 +115,336 @@ class ToonBoilerDeviceSensor(ToonSensor, ToonBoilerDeviceEntity):
 
 class ToonDisplayDeviceSensor(ToonSensor, ToonDisplayDeviceEntity):
     """Defines a Display sensor."""
+
+
+@dataclass
+class ToonSensorRequiredKeysMixin(ToonRequiredKeysMixin):
+    """Mixin for sensor required keys."""
+
+    cls: type[ToonSensor]
+
+
+@dataclass
+class ToonSensorEntityDescription(SensorEntityDescription, ToonSensorRequiredKeysMixin):
+    """Describes Toon sensor entity."""
+
+
+SENSOR_ENTITIES: tuple[ToonSensorEntityDescription, ...] = (
+    ToonSensorEntityDescription(
+        key="current_display_temperature",
+        name="Temperature",
+        section="thermostat",
+        measurement="current_display_temperature",
+        native_unit_of_measurement=TEMP_CELSIUS,
+        device_class=DEVICE_CLASS_TEMPERATURE,
+        entity_registry_enabled_default=False,
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonDisplayDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="gas_average",
+        name="Average Gas Usage",
+        section="gas_usage",
+        measurement="average",
+        native_unit_of_measurement=VOLUME_CM3,
+        icon="mdi:gas-cylinder",
+        cls=ToonGasMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="gas_average_daily",
+        name="Average Daily Gas Usage",
+        section="gas_usage",
+        measurement="day_average",
+        device_class=DEVICE_CLASS_GAS,
+        native_unit_of_measurement=VOLUME_CUBIC_METERS,
+        entity_registry_enabled_default=False,
+        cls=ToonGasMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="gas_daily_usage",
+        name="Gas Usage Today",
+        section="gas_usage",
+        measurement="day_usage",
+        device_class=DEVICE_CLASS_GAS,
+        native_unit_of_measurement=VOLUME_CUBIC_METERS,
+        cls=ToonGasMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="gas_daily_cost",
+        name="Gas Cost Today",
+        section="gas_usage",
+        measurement="day_cost",
+        native_unit_of_measurement=CURRENCY_EUR,
+        icon="mdi:gas-cylinder",
+        cls=ToonGasMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="gas_meter_reading",
+        name="Gas Meter",
+        section="gas_usage",
+        measurement="meter",
+        native_unit_of_measurement=VOLUME_CUBIC_METERS,
+        state_class=STATE_CLASS_TOTAL_INCREASING,
+        device_class=DEVICE_CLASS_GAS,
+        entity_registry_enabled_default=False,
+        cls=ToonGasMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="gas_value",
+        name="Current Gas Usage",
+        section="gas_usage",
+        measurement="current",
+        native_unit_of_measurement=VOLUME_CM3,
+        icon="mdi:gas-cylinder",
+        cls=ToonGasMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_average",
+        name="Average Power Usage",
+        section="power_usage",
+        measurement="average",
+        native_unit_of_measurement=POWER_WATT,
+        device_class=DEVICE_CLASS_POWER,
+        entity_registry_enabled_default=False,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_average_daily",
+        name="Average Daily Energy Usage",
+        section="power_usage",
+        measurement="day_average",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        entity_registry_enabled_default=False,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_daily_cost",
+        name="Energy Cost Today",
+        section="power_usage",
+        measurement="day_cost",
+        native_unit_of_measurement=CURRENCY_EUR,
+        icon="mdi:power-plug",
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_daily_value",
+        name="Energy Usage Today",
+        section="power_usage",
+        measurement="day_usage",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_meter_reading",
+        name="Electricity Meter Feed IN Tariff 1",
+        section="power_usage",
+        measurement="meter_high",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        state_class=STATE_CLASS_TOTAL_INCREASING,
+        entity_registry_enabled_default=False,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_meter_reading_low",
+        name="Electricity Meter Feed IN Tariff 2",
+        section="power_usage",
+        measurement="meter_low",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        state_class=STATE_CLASS_TOTAL_INCREASING,
+        entity_registry_enabled_default=False,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_value",
+        name="Current Power Usage",
+        section="power_usage",
+        measurement="current",
+        native_unit_of_measurement=POWER_WATT,
+        device_class=DEVICE_CLASS_POWER,
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="solar_meter_reading_produced",
+        name="Electricity Meter Feed OUT Tariff 1",
+        section="power_usage",
+        measurement="meter_produced_high",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        state_class=STATE_CLASS_TOTAL_INCREASING,
+        entity_registry_enabled_default=False,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="solar_meter_reading_low_produced",
+        name="Electricity Meter Feed OUT Tariff 2",
+        section="power_usage",
+        measurement="meter_produced_low",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        state_class=STATE_CLASS_TOTAL_INCREASING,
+        entity_registry_enabled_default=False,
+        cls=ToonElectricityMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="water_average",
+        name="Average Water Usage",
+        section="water_usage",
+        measurement="average",
+        native_unit_of_measurement=VOLUME_LMIN,
+        icon="mdi:water",
+        entity_registry_enabled_default=False,
+        cls=ToonWaterMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="water_average_daily",
+        name="Average Daily Water Usage",
+        section="water_usage",
+        measurement="day_average",
+        native_unit_of_measurement=VOLUME_CUBIC_METERS,
+        icon="mdi:water",
+        entity_registry_enabled_default=False,
+        cls=ToonWaterMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="water_daily_usage",
+        name="Water Usage Today",
+        section="water_usage",
+        measurement="day_usage",
+        native_unit_of_measurement=VOLUME_CUBIC_METERS,
+        icon="mdi:water",
+        entity_registry_enabled_default=False,
+        cls=ToonWaterMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="water_meter_reading",
+        name="Water Meter",
+        section="water_usage",
+        measurement="meter",
+        native_unit_of_measurement=VOLUME_CUBIC_METERS,
+        icon="mdi:water",
+        entity_registry_enabled_default=False,
+        state_class=STATE_CLASS_TOTAL_INCREASING,
+        cls=ToonWaterMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="water_value",
+        name="Current Water Usage",
+        section="water_usage",
+        measurement="current",
+        native_unit_of_measurement=VOLUME_LMIN,
+        icon="mdi:water-pump",
+        entity_registry_enabled_default=False,
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonWaterMeterDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="water_daily_cost",
+        name="Water Cost Today",
+        section="water_usage",
+        measurement="day_cost",
+        native_unit_of_measurement=CURRENCY_EUR,
+        icon="mdi:water-pump",
+        entity_registry_enabled_default=False,
+        cls=ToonWaterMeterDeviceSensor,
+    ),
+)
+
+SENSOR_ENTITIES_SOLAR: tuple[ToonSensorEntityDescription, ...] = (
+    ToonSensorEntityDescription(
+        key="solar_value",
+        name="Current Solar Power Production",
+        section="power_usage",
+        measurement="current_solar",
+        native_unit_of_measurement=POWER_WATT,
+        device_class=DEVICE_CLASS_POWER,
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="solar_maximum",
+        name="Max Solar Power Production Today",
+        section="power_usage",
+        measurement="day_max_solar",
+        native_unit_of_measurement=POWER_WATT,
+        device_class=DEVICE_CLASS_POWER,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="solar_produced",
+        name="Solar Power Production to Grid",
+        section="power_usage",
+        measurement="current_produced",
+        native_unit_of_measurement=POWER_WATT,
+        device_class=DEVICE_CLASS_POWER,
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_usage_day_produced_solar",
+        name="Solar Energy Produced Today",
+        section="power_usage",
+        measurement="day_produced_solar",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_usage_day_to_grid_usage",
+        name="Energy Produced To Grid Today",
+        section="power_usage",
+        measurement="day_to_grid_usage",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        entity_registry_enabled_default=False,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_usage_day_from_grid_usage",
+        name="Energy Usage From Grid Today",
+        section="power_usage",
+        measurement="day_from_grid_usage",
+        native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
+        device_class=DEVICE_CLASS_ENERGY,
+        entity_registry_enabled_default=False,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="solar_average_produced",
+        name="Average Solar Power Production to Grid",
+        section="power_usage",
+        measurement="average_produced",
+        native_unit_of_measurement=POWER_WATT,
+        device_class=DEVICE_CLASS_POWER,
+        entity_registry_enabled_default=False,
+        cls=ToonSolarDeviceSensor,
+    ),
+    ToonSensorEntityDescription(
+        key="power_usage_current_covered_by_solar",
+        name="Current Power Usage Covered By Solar",
+        section="power_usage",
+        measurement="current_covered_by_solar",
+        native_unit_of_measurement=PERCENTAGE,
+        icon="mdi:solar-power",
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonSolarDeviceSensor,
+    ),
+)
+
+SENSOR_ENTITIES_BOILER: tuple[ToonSensorEntityDescription, ...] = (
+    ToonSensorEntityDescription(
+        key="thermostat_info_current_modulation_level",
+        name="Boiler Modulation Level",
+        section="thermostat",
+        measurement="current_modulation_level",
+        native_unit_of_measurement=PERCENTAGE,
+        icon="mdi:percent",
+        entity_registry_enabled_default=False,
+        state_class=STATE_CLASS_MEASUREMENT,
+        cls=ToonBoilerDeviceSensor,
+    ),
+)