Merge branch 'develop' into feat/fan-club-discount

Author: BottlecapDave

_docs/setup/cost_tracker.md

@@ -88,6 +88,7 @@ Each item within the `tracked_changes` and `untracked_changes` have the followin
 | `rate` | `float` | The rate the consumption is charged at. This is in pounds and pence (e.g. 1.01 = £1.01) |
 | `consumption` | `float` | The consumption value of the specified period. This will be in `kwh`. |
 | `cost` | `float` | The cost of the consumption at the specified rate. This is in pounds and pence (e.g. 1.01 = £1.01) |
+| `cost_raw` | `float` | The raw cost of the consumption at the specified rate. This is in pounds and pence, but not rounded. This is to account for low cost devices |
 
 #### Variants
 

custom_components/octopus_energy/api_client/heat_pump.py

@@ -11,9 +11,9 @@ class Connectivity(BaseModel):
 
 
 class Telemetry(BaseModel):
-    temperatureInCelsius: float
+    temperatureInCelsius: Optional[float]
     humidityPercentage: Optional[float]
-    retrievedAt: str
+    retrievedAt: Optional[str]
 
 
 class Sensor(BaseModel):

custom_components/octopus_energy/cost_tracker/__init__.py

@@ -1,11 +1,17 @@
 from datetime import datetime, timedelta
+import logging
 
 from homeassistant.components.sensor import (
   SensorStateClass,
 )
 
 from homeassistant.helpers.entity import DeviceInfo
 
+from ..utils.conversions import pence_to_pounds_pence, round_pounds, value_inc_vat_to_pounds
+from ..utils.cost import consumption_cost_in_pence
+
+_LOGGER = logging.getLogger(__name__)
+
 def get_device_info_from_device_entry(device_entry):
   if device_entry is None:
     return None
@@ -152,4 +158,82 @@ def accumulate_cost(current: datetime, accumulative_data: list, new_cost: float,
 
   return AccumulativeCostTrackerResult(new_accumulative_data, total_consumption, total_cost)
 
-  
+def __get_to(item):
+    return (item["end"].timestamp(), item["end"].fold)
+
+def __sort_consumption(consumption_data):
+  sorted = consumption_data.copy()
+  sorted.sort(key=__get_to)
+  return sorted
+
+def calculate_consumption_and_cost(
+    consumption_data,
+    rate_data,
+    standing_charge,
+    last_reset,
+    minimum_consumption_records = 0,
+    target_rate = None
+  ):
+  if (consumption_data is not None and len(consumption_data) >= minimum_consumption_records and rate_data is not None and len(rate_data) > 0 and standing_charge is not None):
+
+    sorted_consumption_data = __sort_consumption(consumption_data)
+
+    # Only calculate our consumption if our data has changed
+    if (last_reset is None or last_reset < sorted_consumption_data[0]["start"]):
+
+      charges = []
+      total_cost = 0
+      total_consumption = 0
+
+      for consumption in sorted_consumption_data:
+        consumption_value = consumption["consumption"]
+        consumption_from = consumption["start"]
+        consumption_to = consumption["end"]
+
+        try:
+          rate = next(r for r in rate_data if r["start"] == consumption_from and r["end"] == consumption_to)
+        except StopIteration:
+          raise Exception(f"Failed to find rate for consumption between {consumption_from} and {consumption_to}")
+
+        value = rate["value_inc_vat"]
+
+        if target_rate is not None and value != target_rate:
+          continue
+
+        total_consumption = total_consumption + consumption_value
+        cost = pence_to_pounds_pence(consumption_cost_in_pence(consumption_value, value))
+        cost_raw = (consumption_value * value) / 100
+        total_cost = total_cost + cost_raw
+
+        current_charge = {
+          "start": rate["start"],
+          "end": rate["end"],
+          "rate": value_inc_vat_to_pounds(value),
+          "consumption": consumption_value,
+          "cost": cost,
+          "cost_raw": cost_raw,
+        }
+
+        charges.append(current_charge)
+      
+      total_cost = round_pounds(total_cost)
+      total_cost_plus_standing_charge = total_cost + pence_to_pounds_pence(standing_charge)
+
+      last_reset = sorted_consumption_data[0]["start"] if len(sorted_consumption_data) > 0 else None
+      last_calculated_timestamp = sorted_consumption_data[-1]["end"] if len(sorted_consumption_data) > 0 else None
+
+      result = {
+        "standing_charge": pence_to_pounds_pence(standing_charge),
+        "total_cost_without_standing_charge": total_cost,
+        "total_cost": total_cost_plus_standing_charge,
+        "total_consumption": total_consumption,
+        "last_reset": last_reset,
+        "last_evaluated": last_calculated_timestamp,
+        "charges": charges,
+      }
+
+      return result
+    else:
+      _LOGGER.debug(f'Skipping consumption and cost calculation as last reset has not changed - last_reset: {last_reset}; consumption start: {sorted_consumption_data[0]["start"]}')
+  else:
+    _LOGGER.debug(f'Skipping consumption and cost calculation due to lack of data; consumption: {len(consumption_data) if consumption_data is not None else 0}; rates: {len(rate_data) if rate_data is not None else 0}; standing_charge: {standing_charge}')

custom_components/octopus_energy/cost_tracker/cost_tracker.py

@@ -41,7 +41,7 @@
 
 from ..coordinators.electricity_rates import ElectricityRatesCoordinatorResult
 from . import add_consumption, get_device_info_from_device_entry
-from ..electricity import calculate_electricity_consumption_and_cost
+from ..cost_tracker import calculate_consumption_and_cost
 from ..utils.rate_information import get_rate_index, get_unique_rates
 from ..utils.attributes import dict_to_typed_dict
 
@@ -283,7 +283,7 @@ def _recalculate_cost(self, current: datetime, tracked_consumption_data: list, u
       unique_rate_index = get_rate_index(len(unique_rates), self._peak_type)
       target_rate = unique_rates[unique_rate_index] if unique_rate_index is not None else None
 
-    tracked_result = calculate_electricity_consumption_and_cost(
+    tracked_result = calculate_consumption_and_cost(
       tracked_consumption_data,
       rates,
       0,
@@ -292,7 +292,7 @@ def _recalculate_cost(self, current: datetime, tracked_consumption_data: list, u
       target_rate=target_rate
     )
 
-    untracked_result = calculate_electricity_consumption_and_cost(
+    untracked_result = calculate_consumption_and_cost(
       untracked_consumption_data,
       rates,
       0,
@@ -309,15 +309,17 @@ def _recalculate_cost(self, current: datetime, tracked_consumption_data: list, u
         "end": charge["end"],
         "rate": charge["rate"],
         "consumption": charge["consumption"],
-        "cost": charge["cost"]
+        "cost": charge["cost"],
+        "cost_raw": charge["cost_raw"]
       }, tracked_result["charges"]))
 
       self._attributes["untracked_charges"] = list(map(lambda charge: {
         "start": charge["start"],
         "end": charge["end"],
         "rate": charge["rate"],
         "consumption": charge["consumption"],
-        "cost": charge["cost"]
+        "cost": charge["cost"],
+        "cost_raw": charge["cost_raw"]
       }, untracked_result["charges"]))
 
       self._attributes["total_consumption"] = tracked_result["total_consumption"] + untracked_result["total_consumption"]

custom_components/octopus_energy/heat_pump/__init__.py

@@ -44,9 +44,9 @@ def mock_heat_pump_status_and_configuration():
             "retrievedAt": (now - timedelta(seconds=random.randrange(1, 120))).strftime("%Y-%m-%dT%H:%M:%S.%f%z")
           },
           "telemetry": {
-            "temperatureInCelsius": -273 + (random.randrange(1, 20) * 0.1),
+            "temperatureInCelsius": None,
             "humidityPercentage": None,
-            "retrievedAt": (now - timedelta(seconds=random.randrange(1, 120))).strftime("%Y-%m-%dT%H:%M:%S.%f%z")
+            "retrievedAt": None
           }
         },
         {

custom_components/octopus_energy/heat_pump/sensor_humidity.py

@@ -92,7 +92,7 @@ def _handle_coordinator_update(self) -> None:
       for sensor in sensors:
         if sensor.code == self._sensor.code and sensor.telemetry is not None:
           self._state = sensor.telemetry.humidityPercentage
-          self._attributes["retrieved_at"] = datetime.fromisoformat(sensor.telemetry.retrievedAt)
+          self._attributes["retrieved_at"] = datetime.fromisoformat(sensor.telemetry.retrievedAt) if sensor.telemetry.retrievedAt is not None else None
 
       self._last_updated = current
 

custom_components/octopus_energy/heat_pump/sensor_temperature.py

@@ -93,7 +93,7 @@ def _handle_coordinator_update(self) -> None:
       for sensor in sensors:
         if sensor.code == self._sensor.code and sensor.telemetry is not None:
           self._state = sensor.telemetry.temperatureInCelsius
-          self._attributes["retrieved_at"] = datetime.fromisoformat(sensor.telemetry.retrievedAt)
+          self._attributes["retrieved_at"] = datetime.fromisoformat(sensor.telemetry.retrievedAt) if sensor.telemetry.retrievedAt is not None else None
 
       self._last_updated = current
 

custom_components/octopus_energy/intelligent/__init__.py

@@ -259,6 +259,7 @@ def __init__(self,
   "SENSI",
   "SMARTCAR",
   "TESLA",
+  "TESLA_V2",
   "SMART_PEAR",
   "HYPERVOLT",
   "INDRA"

tests/unit/api_client/test_heat_pump.py

@@ -36,9 +36,9 @@ def test_when_valid_dictionary_returned_then_it_can_be_parsed_into_heat_pump_obj
             "retrievedAt": "2025-05-09T17:28:51.555000+00:00"
           },
           "telemetry": {
-            "temperatureInCelsius": -90.3,
+            "temperatureInCelsius": None,
             "humidityPercentage": None,
-            "retrievedAt": "2025-05-09T17:28:44.152000+00:00"
+            "retrievedAt": None
           }
         },
         {