Merge pull request #14 from andrew-codechimp/real-change

Real change

Author: andrew-codechimp

README.md

@@ -10,6 +10,8 @@ Periodic Min/Max Helpers for Home Assistant
 
 The helpers record the minimum or maximum of a sensor until manually reset via the reset action. The value is maintained through HA restarts.
 
+A `last_modified` attribute is available to check when the min or max was really changed, this attribute does not update on HA restarts giving you an accurate indication on when the new min or max was hit. This can be useful for using as a trigger on an automation or for comparing via a template for a daily update.
+
 ## Example use cases
 
 - Record the maximum temperature today, resetting at midnight via an automation.

config/configuration.yaml

@@ -1,6 +1,10 @@
 # https://www.home-assistant.io/integrations/default_config/
 default_config:
 
+automation: !include automations.yaml
+script: !include scripts.yaml
+scene: !include scenes.yaml
+
 # https://www.home-assistant.io/integrations/logger/
 logger:
   default: warning

custom_components/periodic_min_max/const.py

@@ -23,3 +23,5 @@
 PLATFORMS = [Platform.SENSOR]
 
 CONF_ENTITY_ID = "entity_id"
+
+ATTR_LAST_MODIFIED = "last_modified"

custom_components/periodic_min_max/sensor.py

@@ -36,8 +36,15 @@
 from homeassistant.helpers.reload import async_setup_reload_service
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType, StateType
-
-from .const import CONF_ENTITY_ID, DOMAIN, LOGGER, PLATFORMS
+from homeassistant.util import dt as dt_util
+
+from .const import (
+    ATTR_LAST_MODIFIED,
+    CONF_ENTITY_ID,
+    DOMAIN,
+    LOGGER,
+    PLATFORMS,
+)
 
 ATTR_MIN_VALUE = "min_value"
 ATTR_MAX_VALUE = "max_value"
@@ -189,6 +196,8 @@ class PeriodicMinMaxSensor(SensorEntity, RestoreEntity):
     _attr_icon = ICON
     _attr_should_poll = False
     _attr_state_class = SensorStateClass.MEASUREMENT
+    _state_had_real_change = False
+    _attr_last_modified: datetime = dt_util.utcnow().isoformat()
 
     def __init__(
         self,
@@ -223,6 +232,14 @@ def __init__(
     async def async_added_to_hass(self) -> None:
         """Handle added to Hass."""
 
+        await super().async_added_to_hass()
+
+        last_state = await self.async_get_last_state()
+        if last_state:
+            last_attrs = last_state.attributes
+            if last_attrs and ATTR_LAST_MODIFIED in last_attrs:
+                self._attr_last_modified = last_attrs[ATTR_LAST_MODIFIED]
+
         self.async_on_remove(
             async_track_state_change_event(
                 self.hass,
@@ -291,6 +308,15 @@ def native_unit_of_measurement(self) -> str | None:
             return "ERR"
         return self._unit_of_measurement
 
+    @property
+    def extra_state_attributes(self) -> dict[str, Any]:
+        """Return the device specific state attributes."""
+        attributes: dict[str, Any] = {}
+
+        attributes[ATTR_LAST_MODIFIED] = self._attr_last_modified
+
+        return attributes
+
     @callback
     def _async_min_max_sensor_state_listener(
         self, event: Event[EventStateChangedData], update_state: bool = True
@@ -337,23 +363,32 @@ def _async_min_max_sensor_state_listener(
             return
 
         self._calc_values()
+
+        if self._state_had_real_change:
+            self._attr_last_modified = dt_util.utcnow().isoformat(sep=" ")
+
         self.async_write_ha_state()
 
     @callback
     def _calc_values(self) -> None:
         """Calculate the values."""
+        self._state_had_real_change = False
 
         """Calculate min value, honoring unknown states."""
-        if self._state not in [STATE_UNKNOWN, STATE_UNAVAILABLE] and (
-            self.min_value is None or self.min_value > self._state
-        ):
-            self.min_value = self._state
+        if self._sensor_attr == ATTR_MIN_VALUE:
+            if self._state not in [STATE_UNKNOWN, STATE_UNAVAILABLE] and (
+                self.min_value is None or self.min_value > self._state
+            ):
+                self.min_value = self._state
+                self._state_had_real_change = True
 
         """Calculate max value, honoring unknown states."""
-        if self._state not in [STATE_UNKNOWN, STATE_UNAVAILABLE] and (
-            self.max_value is None or self.max_value < self._state
-        ):
-            self.max_value = self._state
+        if self._sensor_attr == ATTR_MAX_VALUE:
+            if self._state not in [STATE_UNKNOWN, STATE_UNAVAILABLE] and (
+                self.max_value is None or self.max_value < self._state
+            ):
+                self.max_value = self._state
+                self._state_had_real_change = True
 
     async def handle_reset(self) -> None:
         """Set the min & max to current state."""

tests/README.md

@@ -20,5 +20,5 @@ This will install `homeassistant`, `pytest`, and `pytest-homeassistant-custom-co
 Command | Description
 ------- | -----------
 `pytest tests/` | This will run all tests in `tests/` and tell you how many passed/failed
-`pytest --durations=10 --cov-report term-missing --cov=custom_components.periodic_min_max tests` | This tells `pytest` that your target module to test is `custom_components.periodic_min_max` so that it can give you a [code coverage](https://en.wikipedia.org/wiki/Code_coverage) summary, including % of code that was executed and the line numbers of missed executions.
+`pytest --cov-report term-missing --cov=custom_components.periodic_min_max tests` | This tells `pytest` that your target module to test is `custom_components.periodic_min_max` so that it can give you a [code coverage](https://en.wikipedia.org/wiki/Code_coverage) summary, including % of code that was executed and the line numbers of missed executions.
 `pytest tests/test_init.py -k test_setup_unload_and_reload_entry` | Runs the `test_setup_unload_and_reload_entry` test function located in `tests/test_init.py`

tests/test_sensor.py

@@ -82,6 +82,7 @@ async def test_max_sensor(
     entity = entity_registry.async_get("sensor.test_max")
     assert entity.unique_id == "very_unique_id"
 
+
 async def test_value_error(
     hass: HomeAssistant, entity_registry: er.EntityRegistry
 ) -> None:
@@ -113,4 +114,4 @@ async def test_value_error(
     assert state.attributes.get(ATTR_STATE_CLASS) == SensorStateClass.MEASUREMENT
 
     entity = entity_registry.async_get("sensor.test_max")
-    assert entity.unique_id == "very_unique_id"
+    assert entity.unique_id == "very_unique_id"