Miele time sensors 2/3 - Provide consistent behavior with appliance status (home-assistant#146053)

Co-authored-by: Robert Resch <[email protected]>

Author: aturri

homeassistant/components/miele/icons.json

@@ -45,7 +45,7 @@
         "default": "mdi:tray-full"
       },
       "elapsed_time": {
-        "default": "mdi:timelapse"
+        "default": "mdi:timer-outline"
       },
       "start_time": {
         "default": "mdi:clock-start"

homeassistant/components/miele/sensor.py

@@ -364,6 +364,7 @@ class MieleSensorDefinition:
             key="state_remaining_time",
             translation_key="remaining_time",
             value_fn=lambda value: _convert_duration(value.state_remaining_time),
+            end_value_fn=lambda last_value: 0,
             device_class=SensorDeviceClass.DURATION,
             native_unit_of_measurement=UnitOfTime.MINUTES,
             entity_category=EntityCategory.DIAGNOSTIC,
@@ -417,6 +418,7 @@ class MieleSensorDefinition:
             key="state_start_time",
             translation_key="start_time",
             value_fn=lambda value: _convert_duration(value.state_start_time),
+            end_value_fn=lambda last_value: None,
             native_unit_of_measurement=UnitOfTime.MINUTES,
             device_class=SensorDeviceClass.DURATION,
             entity_category=EntityCategory.DIAGNOSTIC,
@@ -614,6 +616,8 @@ def _get_entity_class(definition: MieleSensorDefinition) -> type[MieleSensor]:
             "state_program_phase": MielePhaseSensor,
             "state_plate_step": MielePlateSensor,
             "state_elapsed_time": MieleTimeSensor,
+            "state_remaining_time": MieleTimeSensor,
+            "state_start_time": MieleTimeSensor,
         }.get(definition.description.key, MieleSensor)
 
     def _is_entity_registered(unique_id: str) -> bool:
@@ -769,7 +773,7 @@ async def async_added_to_hass(self) -> None:
         """When entity is added to hass."""
         await super().async_added_to_hass()
 
-        # recover last value from cache
+        # recover last value from cache when adding entity
         last_value = await self.async_get_last_state()
         if last_value and last_value.state != STATE_UNKNOWN:
             self._last_value = last_value.state
@@ -779,6 +783,16 @@ def native_value(self) -> StateType:
         """Return the state of the sensor."""
         return self._last_value
 
+    def _update_last_value(self) -> None:
+        """Update the last value of the sensor."""
+        self._last_value = self.entity_description.value_fn(self.device)
+
+    @callback
+    def _handle_coordinator_update(self) -> None:
+        """Handle updated data from the coordinator."""
+        self._update_last_value()
+        super()._handle_coordinator_update()
+
 
 class MielePlateSensor(MieleSensor):
     """Representation of a Sensor."""
@@ -886,9 +900,8 @@ def options(self) -> list[str]:
 class MieleTimeSensor(MieleRestorableSensor):
     """Representation of time sensors keeping state from cache."""
 
-    @callback
-    def _handle_coordinator_update(self) -> None:
-        """Handle updated data from the coordinator."""
+    def _update_last_value(self) -> None:
+        """Update the last value of the sensor."""
 
         current_value = self.entity_description.value_fn(self.device)
         current_status = StateStatus(self.device.state_status)
@@ -911,5 +924,3 @@ def _handle_coordinator_update(self) -> None:
         # otherwise, cache value and return it
         else:
             self._last_value = current_value
-
-        super()._handle_coordinator_update()

tests/components/miele/snapshots/test_sensor.ambr

@@ -3417,7 +3417,7 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '5',
+    'state': 'unknown',
   })
 # ---
 # name: test_sensor_states[platforms0][sensor.oven_start_in-entry]
@@ -3473,7 +3473,7 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '0.0',
+    'state': 'unknown',
   })
 # ---
 # name: test_sensor_states[platforms0][sensor.oven_target_temperature-entry]
@@ -4312,7 +4312,7 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '0',
+    'state': 'unknown',
   })
 # ---
 # name: test_sensor_states[platforms0][sensor.washing_machine_spin_speed-entry]
@@ -4417,7 +4417,7 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '0.0',
+    'state': 'unknown',
   })
 # ---
 # name: test_sensor_states[platforms0][sensor.washing_machine_target_temperature-entry]
@@ -6458,7 +6458,7 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '0',
+    'state': 'unknown',
   })
 # ---
 # name: test_sensor_states_api_push[platforms0][sensor.washing_machine_spin_speed-entry]
@@ -6563,7 +6563,7 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '0.0',
+    'state': 'unknown',
   })
 # ---
 # name: test_sensor_states_api_push[platforms0][sensor.washing_machine_target_temperature-entry]
@@ -7099,6 +7099,6 @@
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
-    'state': '0',
+    'state': 'unknown',
   })
 # ---

tests/components/miele/test_sensor.py

@@ -311,7 +311,8 @@ async def test_laundry_wash_scenario(
         hass, "sensor.washing_machine_target_temperature", "unknown", step
     )
     check_sensor_state(hass, "sensor.washing_machine_spin_speed", "unknown", step)
-    check_sensor_state(hass, "sensor.washing_machine_remaining_time", "0", step)
+    # OFF -> remaining forced to unknown
+    check_sensor_state(hass, "sensor.washing_machine_remaining_time", "unknown", step)
     # OFF -> elapsed forced to unknown (some devices continue reporting last value of last cycle)
     check_sensor_state(hass, "sensor.washing_machine_elapsed_time", "unknown", step)
 
@@ -347,8 +348,8 @@ async def test_laundry_wash_scenario(
     check_sensor_state(hass, "sensor.washing_machine_program_phase", "main_wash", step)
     check_sensor_state(hass, "sensor.washing_machine_target_temperature", "30.0", step)
     check_sensor_state(hass, "sensor.washing_machine_spin_speed", "1200", step)
+    # IN_USE -> elapsed, remaining time from API (normal case)
     check_sensor_state(hass, "sensor.washing_machine_remaining_time", "105", step)
-    # IN_USE -> elapsed time from API (normal case)
     check_sensor_state(hass, "sensor.washing_machine_elapsed_time", "12", step)
 
     # Simulate rinse hold phase
@@ -373,8 +374,8 @@ async def test_laundry_wash_scenario(
     check_sensor_state(hass, "sensor.washing_machine_program_phase", "rinse_hold", step)
     check_sensor_state(hass, "sensor.washing_machine_target_temperature", "30.0", step)
     check_sensor_state(hass, "sensor.washing_machine_spin_speed", "1200", step)
+    # RINSE HOLD -> elapsed, remaining time from API (normal case)
     check_sensor_state(hass, "sensor.washing_machine_remaining_time", "8", step)
-    # RINSE HOLD -> elapsed time from API (normal case)
     check_sensor_state(hass, "sensor.washing_machine_elapsed_time", "109", step)
 
     # Simulate program ended
@@ -401,6 +402,7 @@ async def test_laundry_wash_scenario(
     )
     check_sensor_state(hass, "sensor.washing_machine_target_temperature", "30.0", step)
     check_sensor_state(hass, "sensor.washing_machine_spin_speed", "1200", step)
+    # PROGRAM_ENDED -> remaining time forced to 0
     check_sensor_state(hass, "sensor.washing_machine_remaining_time", "0", step)
     # PROGRAM_ENDED -> elapsed time kept from last program (some devices immediately go to 0)
     check_sensor_state(hass, "sensor.washing_machine_elapsed_time", "109", step)
@@ -433,8 +435,8 @@ async def test_laundry_wash_scenario(
     )
     check_sensor_state(hass, "sensor.washing_machine_target_temperature", "40.0", step)
     check_sensor_state(hass, "sensor.washing_machine_spin_speed", "1200", step)
+    # PROGRAMMED -> elapsed, remaining time from API (normal case)
     check_sensor_state(hass, "sensor.washing_machine_remaining_time", "119", step)
-    # PROGRAMMED -> elapsed time from API (normal case)
     check_sensor_state(hass, "sensor.washing_machine_elapsed_time", "0", step)
 
 
@@ -457,8 +459,8 @@ async def test_laundry_dry_scenario(
     check_sensor_state(hass, "sensor.tumble_dryer_program", "no_program", step)
     check_sensor_state(hass, "sensor.tumble_dryer_program_phase", "not_running", step)
     check_sensor_state(hass, "sensor.tumble_dryer_drying_step", "unknown", step)
-    check_sensor_state(hass, "sensor.tumble_dryer_remaining_time", "0", step)
-    # OFF -> elapsed forced to unknown (some devices continue reporting last value of last cycle)
+    # OFF -> elapsed, remaining forced to unknown (some devices continue reporting last value of last cycle)
+    check_sensor_state(hass, "sensor.tumble_dryer_remaining_time", "unknown", step)
     check_sensor_state(hass, "sensor.tumble_dryer_elapsed_time", "unknown", step)
 
     # Simulate program started
@@ -486,8 +488,8 @@ async def test_laundry_dry_scenario(
     check_sensor_state(hass, "sensor.tumble_dryer_program", "minimum_iron", step)
     check_sensor_state(hass, "sensor.tumble_dryer_program_phase", "drying", step)
     check_sensor_state(hass, "sensor.tumble_dryer_drying_step", "normal", step)
+    # IN_USE -> elapsed, remaining time from API (normal case)
     check_sensor_state(hass, "sensor.tumble_dryer_remaining_time", "49", step)
-    # IN_USE -> elapsed time from API (normal case)
     check_sensor_state(hass, "sensor.tumble_dryer_elapsed_time", "20", step)
 
     # Simulate program end
@@ -511,6 +513,7 @@ async def test_laundry_dry_scenario(
     check_sensor_state(hass, "sensor.tumble_dryer_program", "minimum_iron", step)
     check_sensor_state(hass, "sensor.tumble_dryer_program_phase", "finished", step)
     check_sensor_state(hass, "sensor.tumble_dryer_drying_step", "normal", step)
+    # PROGRAM_ENDED -> remaining time forced to 0
     check_sensor_state(hass, "sensor.tumble_dryer_remaining_time", "0", step)
     # PROGRAM_ENDED -> elapsed time kept from last program (some devices immediately go to 0)
     check_sensor_state(hass, "sensor.tumble_dryer_elapsed_time", "20", step)