fix: Updated various sensors to update their state based on recommend…

…ed HA practices

custom_components/octopus_energy/electricity/current_accumulative_consumption.py

@@ -1,7 +1,6 @@
 import logging
-from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity
@@ -17,6 +16,7 @@
 
 from homeassistant.util.dt import (now)
 
+from ..coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 from .base import (OctopusEnergyElectricitySensor)
 from ..utils.attributes import dict_to_typed_dict
 
@@ -81,6 +81,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the current days accumulative consumption"""
     current = now()
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
@@ -118,7 +122,7 @@ def native_value(self):
         }, consumption_and_cost["charges"]))
       }
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_accumulative_consumption_off_peak.py

@@ -1,8 +1,7 @@
 import logging
 from datetime import datetime
-from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
@@ -23,6 +22,7 @@
   calculate_electricity_consumption_and_cost,
 )
 
+from ..coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 from .base import (OctopusEnergyElectricitySensor)
 from ..utils.attributes import dict_to_typed_dict
 
@@ -93,7 +93,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
-    """Retrieve the current days accumulative consumption"""
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     current = now()
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
     consumption_data = consumption_result.data if consumption_result is not None else None
@@ -118,7 +121,7 @@ def native_value(self):
       self._attributes["last_evaluated"] = consumption_and_cost["last_evaluated"]
       self._attributes["data_last_retrieved"] = consumption_result.last_retrieved if consumption_result is not None else None
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_accumulative_consumption_peak.py

@@ -1,8 +1,7 @@
 import logging
 from datetime import datetime
-from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
@@ -22,6 +21,7 @@
   calculate_electricity_consumption_and_cost,
 )
 
+from ..coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 from .base import (OctopusEnergyElectricitySensor)
 from ..utils.attributes import dict_to_typed_dict
 
@@ -92,6 +92,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the current days accumulative consumption"""
     current = now()
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
@@ -117,7 +121,7 @@ def native_value(self):
       self._attributes["last_evaluated"] = consumption_and_cost["last_evaluated"]
       self._attributes["data_last_retrieved"] = consumption_result.last_retrieved if consumption_result is not None else None
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_accumulative_cost.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
@@ -90,6 +90,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the currently calculated state"""
     current = now()
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
@@ -131,7 +135,7 @@ def native_value(self):
         }, consumption_and_cost["charges"]))
       }
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_accumulative_cost_off_peak.py

@@ -1,8 +1,7 @@
 import logging
 from datetime import datetime
-from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
@@ -19,6 +18,7 @@
   calculate_electricity_consumption_and_cost,
 )
 
+from ..coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 from .base import (OctopusEnergyElectricitySensor)
 from ..utils.attributes import dict_to_typed_dict
 
@@ -89,6 +89,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the currently calculated state"""
     current = now()
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
@@ -114,7 +118,7 @@ def native_value(self):
       self._attributes["last_evaluated"] = consumption_and_cost["last_evaluated"]
       self._attributes["data_last_retrieved"] = consumption_result.last_retrieved if consumption_result is not None else None
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_accumulative_cost_peak.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
@@ -89,6 +89,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the currently calculated state"""
     current = now()
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
@@ -114,7 +118,7 @@ def native_value(self):
       self._attributes["last_evaluated"] = consumption_and_cost["last_evaluated"]
       self._attributes["data_last_retrieved"] = consumption_result.last_retrieved if consumption_result is not None else None
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_consumption.py

@@ -1,7 +1,7 @@
 import logging
 from custom_components.octopus_energy.coordinators.current_consumption import CurrentConsumptionCoordinatorResult
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.util.dt import (now)
 
 from homeassistant.helpers.update_coordinator import (
@@ -80,8 +80,11 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the latest electricity consumption"""
-    _LOGGER.debug('Updating OctopusEnergyCurrentElectricityConsumption')
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
     current_date = now()
 
@@ -99,7 +102,8 @@ def native_value(self):
     self._attributes["last_evaluated"] = result.last_evaluated
     self._attributes["data_last_retrieved"] = result.data_last_retrieved
 
-    return self._state
+    _LOGGER.debug('Updated OctopusEnergyCurrentElectricityConsumption')
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_demand.py

@@ -2,7 +2,7 @@
 from homeassistant.util.dt import (now)
 import logging
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity
@@ -69,6 +69,10 @@ def extra_state_attributes(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Handle updated data from the coordinator."""
     _LOGGER.debug('Updating OctopusEnergyCurrentElectricityConsumption')
     consumption_result: CurrentConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
@@ -79,7 +83,7 @@ def native_value(self):
       self._attributes["last_evaluated"] = now()
       self._attributes["data_last_retrieved"] = consumption_result.last_retrieved if consumption_result is not None else None
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/current_rate.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
 import logging
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.util.dt import (utcnow)
 from homeassistant.helpers.update_coordinator import (
@@ -87,6 +87,10 @@ def extra_state_attributes(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the current rate for the sensor."""
     # Find the current rate. We only need to do this every half an hour
     current = utcnow()
@@ -140,8 +144,7 @@ def native_value(self):
       self._attributes["data_last_retrieved"] = rates_result.last_retrieved
 
     self._attributes["last_evaluated"] = current
-
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/next_rate.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
 import logging
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.util.dt import (utcnow)
 from homeassistant.helpers.update_coordinator import (
@@ -78,6 +78,10 @@ def extra_state_attributes(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the next rate for the sensor."""
     # Find the next rate. We only need to do this every half an hour
     current = utcnow()
@@ -117,8 +121,7 @@ def native_value(self):
       self._attributes["data_last_retrieved"] = rates_result.last_retrieved
 
     self._attributes["last_evaluated"] = current
-
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/off_peak.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
 import logging
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity import generate_entity_id
 
 from homeassistant.util.dt import (now)
@@ -57,6 +57,10 @@ def extra_state_attributes(self):
 
   @property
   def is_on(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Determine if current rate is off peak."""
     current = now()
     rates = self.coordinator.data.rates if self.coordinator is not None and self.coordinator.data is not None else None
@@ -66,8 +70,8 @@ def is_on(self):
       self._state = is_off_peak(current, rates)
 
       self._last_updated = current
-    
-    return self._state
+
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/previous_accumulative_consumption_off_peak.py

@@ -1,7 +1,7 @@
 import logging
 from datetime import datetime
 
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 
 from homeassistant.helpers.update_coordinator import (
   CoordinatorEntity,
@@ -90,6 +90,10 @@ def last_reset(self):
 
   @property
   def native_value(self):
+    return self._state
+
+  @callback
+  def _handle_coordinator_update(self) -> None:
     """Retrieve the previous days accumulative consumption"""
     result: PreviousConsumptionCoordinatorResult = self.coordinator.data if self.coordinator is not None and self.coordinator.data is not None else None
     consumption_data = result.consumption if result is not None else None
@@ -117,7 +121,7 @@ def native_value(self):
     if result is not None:
       self._attributes["data_last_retrieved"] = result.last_retrieved
 
-    return self._state
+    super()._handle_coordinator_update()
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""