Add "profile" extra attribute to Miele program sensor on coffee machines (#145073)

Author: aturri

homeassistant/components/miele/const.py

@@ -850,6 +850,14 @@ class StateDryingStep(MieleEnum):
     24813: "appliance_settings",  # modify profile name
 }
 
+COFFEE_SYSTEM_PROFILE: dict[range, str] = {
+    range(24000, 24032): "profile_1",
+    range(24032, 24064): "profile_2",
+    range(24064, 24096): "profile_3",
+    range(24096, 24128): "profile_4",
+    range(24128, 24160): "profile_5",
+}
+
 STEAM_OVEN_MICRO_PROGRAM_ID: dict[int, str] = {
     8: "steam_cooking",
     19: "microwave",

homeassistant/components/miele/sensor.py

@@ -2,10 +2,10 @@
 
 from __future__ import annotations
 
-from collections.abc import Callable
+from collections.abc import Callable, Mapping
 from dataclasses import dataclass
 import logging
-from typing import Final, cast
+from typing import Any, Final, cast
 
 from pymiele import MieleDevice, MieleTemperature
 
@@ -30,6 +30,7 @@
 from homeassistant.helpers.typing import StateType
 
 from .const import (
+    COFFEE_SYSTEM_PROFILE,
     DISABLED_TEMP_ENTITIES,
     DOMAIN,
     STATE_PROGRAM_ID,
@@ -61,6 +62,8 @@
     "KMX": 6,
 }
 
+ATTRIBUTE_PROFILE = "profile"
+
 
 def _get_plate_count(tech_type: str) -> int:
     """Get number of zones for hob."""
@@ -88,11 +91,21 @@ def _convert_temperature(
     return raw_value
 
 
+def _get_coffee_profile(value: MieleDevice) -> str | None:
+    """Get coffee profile from value."""
+    if value.state_program_id is not None:
+        for key_range, profile in COFFEE_SYSTEM_PROFILE.items():
+            if value.state_program_id in key_range:
+                return profile
+    return None
+
+
 @dataclass(frozen=True, kw_only=True)
 class MieleSensorDescription(SensorEntityDescription):
     """Class describing Miele sensor entities."""
 
     value_fn: Callable[[MieleDevice], StateType]
+    extra_attributes: dict[str, Callable[[MieleDevice], StateType]] | None = None
     zone: int | None = None
     unique_id_fn: Callable[[str, MieleSensorDescription], str] | None = None
 
@@ -157,7 +170,6 @@ class MieleSensorDefinition:
             MieleAppliance.OVEN_MICROWAVE,
             MieleAppliance.STEAM_OVEN,
             MieleAppliance.MICROWAVE,
-            MieleAppliance.COFFEE_SYSTEM,
             MieleAppliance.ROBOT_VACUUM_CLEANER,
             MieleAppliance.WASHER_DRYER,
             MieleAppliance.STEAM_OVEN_COMBI,
@@ -172,6 +184,18 @@ class MieleSensorDefinition:
             value_fn=lambda value: value.state_program_id,
         ),
     ),
+    MieleSensorDefinition(
+        types=(MieleAppliance.COFFEE_SYSTEM,),
+        description=MieleSensorDescription(
+            key="state_program_id",
+            translation_key="program_id",
+            device_class=SensorDeviceClass.ENUM,
+            value_fn=lambda value: value.state_program_id,
+            extra_attributes={
+                ATTRIBUTE_PROFILE: _get_coffee_profile,
+            },
+        ),
+    ),
     MieleSensorDefinition(
         types=(
             MieleAppliance.WASHING_MACHINE,
@@ -710,6 +734,16 @@ def native_value(self) -> StateType:
         """Return the state of the sensor."""
         return self.entity_description.value_fn(self.device)
 
+    @property
+    def extra_state_attributes(self) -> Mapping[str, Any] | None:
+        """Return extra_state_attributes."""
+        if self.entity_description.extra_attributes is None:
+            return None
+        attr = {}
+        for key, value in self.entity_description.extra_attributes.items():
+            attr[key] = value(self.device)
+        return attr
+
 
 class MielePlateSensor(MieleSensor):
     """Representation of a Sensor."""
@@ -792,6 +826,8 @@ def options(self) -> list[str]:
 class MieleProgramIdSensor(MieleSensor):
     """Representation of the program id sensor."""
 
+    _unrecorded_attributes = frozenset({ATTRIBUTE_PROFILE})
+
     @property
     def native_value(self) -> StateType:
         """Return the state of the sensor."""

homeassistant/components/miele/strings.json

@@ -991,6 +991,18 @@
           "yom_tov": "Yom tov",
           "yorkshire_pudding": "Yorkshire pudding",
           "zander_fillet": "Zander (fillet)"
+        },
+        "state_attributes": {
+          "profile": {
+            "name": "Profile",
+            "state": {
+              "profile_1": "Profile 1",
+              "profile_2": "Profile 2",
+              "profile_3": "Profile 3",
+              "profile_4": "Profile 4",
+              "profile_5": "Profile 5"
+            }
+          }
         }
       },
       "spin_speed": {

tests/components/miele/fixtures/coffee_system.json

@@ -0,0 +1,126 @@
+{
+  "DummyAppliance_CoffeeSystem": {
+    "ident": {
+      "type": {
+        "key_localized": "Device type",
+        "value_raw": 17,
+        "value_localized": "Coffee machine"
+      },
+      "deviceName": "",
+      "protocolVersion": 4,
+      "deviceIdentLabel": {
+        "fabNumber": "**REDACTED**",
+        "fabIndex": "11",
+        "techType": "CM6160",
+        "matNumber": "11488670",
+        "swids": []
+      },
+      "xkmIdentLabel": {
+        "techType": "EK037",
+        "releaseVersion": "04.05"
+      }
+    },
+    "state": {
+      "ProgramID": {
+        "value_raw": 24001,
+        "value_localized": "espresso",
+        "key_localized": "Program name"
+      },
+      "status": {
+        "value_raw": 5,
+        "value_localized": "In use",
+        "key_localized": "status"
+      },
+      "programType": {
+        "value_raw": 1,
+        "value_localized": "Program",
+        "key_localized": "Program type"
+      },
+      "programPhase": {
+        "value_raw": 4353,
+        "value_localized": "Espresso",
+        "key_localized": "Program phase"
+      },
+      "remainingTime": [0, 0],
+      "startTime": [0, 0],
+      "targetTemperature": [
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        },
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        },
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        }
+      ],
+      "coreTargetTemperature": [
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        }
+      ],
+      "temperature": [
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        },
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        },
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        }
+      ],
+      "coreTemperature": [
+        {
+          "value_raw": -32768,
+          "value_localized": null,
+          "unit": "Celsius"
+        }
+      ],
+      "signalInfo": false,
+      "signalFailure": false,
+      "signalDoor": false,
+      "remoteEnable": {
+        "fullRemoteControl": true,
+        "smartGrid": false,
+        "mobileStart": false
+      },
+      "ambientLight": null,
+      "light": 1,
+      "elapsedTime": [],
+      "spinningSpeed": {
+        "unit": "rpm",
+        "value_raw": null,
+        "value_localized": null,
+        "key_localized": "Spin speed"
+      },
+      "dryingStep": {
+        "value_raw": null,
+        "value_localized": "",
+        "key_localized": "Drying level"
+      },
+      "ventilationStep": {
+        "value_raw": null,
+        "value_localized": "",
+        "key_localized": "Fan level"
+      },
+      "plateStep": [],
+      "ecoFeedback": null,
+      "batteryLevel": null
+    }
+  }
+}