Replace TemperatureMetrics with Sample[Temperature]

This would just stream average of average temperatures of all
batteries in a pool.

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/timeseries/battery_pool/__init__.py

@@ -3,12 +3,11 @@
 
 """Manage a pool of batteries."""
 
-from ._result_types import Bound, PowerMetrics, TemperatureMetrics
+from ._result_types import Bound, PowerMetrics
 from .battery_pool import BatteryPool
 
 __all__ = [
     "BatteryPool",
     "PowerMetrics",
-    "TemperatureMetrics",
     "Bound",
 ]

src/frequenz/sdk/timeseries/battery_pool/_metric_calculator.py

@@ -14,7 +14,7 @@
 from ...microgrid.component import ComponentCategory, ComponentMetricId, InverterType
 from ...timeseries import Energy, Percentage, Sample, Temperature
 from ._component_metrics import ComponentMetricsData
-from ._result_types import Bound, PowerMetrics, TemperatureMetrics
+from ._result_types import Bound, PowerMetrics
 
 _logger = logging.getLogger(__name__)
 _MIN_TIMESTAMP = datetime.min.replace(tzinfo=timezone.utc)
@@ -59,7 +59,7 @@ def battery_inverter_mapping(batteries: Iterable[int]) -> dict[int, int]:
 
 # Formula output types class have no common interface
 # Print all possible types here.
-T = TypeVar("T", Sample[Percentage], Sample[Energy], PowerMetrics, TemperatureMetrics)
+T = TypeVar("T", Sample[Percentage], Sample[Energy], PowerMetrics, Sample[Temperature])
 
 
 class MetricCalculator(ABC, Generic[T]):
@@ -234,7 +234,7 @@ def calculate(
         )
 
 
-class TemperatureCalculator(MetricCalculator[TemperatureMetrics]):
+class TemperatureCalculator(MetricCalculator[Sample[Temperature]]):
     """Define how to calculate temperature metrics."""
 
     def __init__(self, batteries: Set[int]) -> None:
@@ -280,7 +280,7 @@ def calculate(
         self,
         metrics_data: dict[int, ComponentMetricsData],
         working_batteries: set[int],
-    ) -> TemperatureMetrics | None:
+    ) -> Sample[Temperature] | None:
         """Aggregate the metrics_data and calculate high level metric for temperature.
 
         Missing components will be ignored. Formula will be calculated for all
@@ -298,9 +298,7 @@ def calculate(
             Return None if there are no component metrics.
         """
         timestamp = _MIN_TIMESTAMP
-        temperature_sum: float = 0
-        temperature_min: float = float("inf")
-        temperature_max: float = float("-inf")
+        temperature_sum: float = 0.0
         temperature_count: int = 0
         for battery_id in working_batteries:
             if battery_id not in metrics_data:
@@ -311,19 +309,15 @@ def calculate(
                 continue
             timestamp = max(timestamp, metrics.timestamp)
             temperature_sum += temperature
-            temperature_min = min(temperature_min, temperature)
-            temperature_max = max(temperature_max, temperature)
             temperature_count += 1
         if timestamp == _MIN_TIMESTAMP:
             return None
 
         temperature_avg = temperature_sum / temperature_count
 
-        return TemperatureMetrics(
+        return Sample[Temperature](
             timestamp=timestamp,
-            min=Temperature.from_celsius(value=temperature_min),
-            avg=Temperature.from_celsius(value=temperature_avg),
-            max=Temperature.from_celsius(value=temperature_max),
+            value=Temperature.from_celsius(value=temperature_avg),
         )
 
 

src/frequenz/sdk/timeseries/battery_pool/_result_types.py

@@ -6,8 +6,6 @@
 from dataclasses import dataclass, field
 from datetime import datetime
 
-from ...timeseries import Temperature
-
 
 @dataclass
 class Bound:
@@ -63,20 +61,3 @@ class PowerMetrics:
         )
     ```
     """
-
-
-@dataclass
-class TemperatureMetrics:
-    """Container for temperature metrics."""
-
-    timestamp: datetime
-    """Timestamp of the metrics."""
-
-    max: Temperature
-    """Maximum temperature of the collection of temperatures."""
-
-    min: Temperature
-    """Minimum temperature of the collection of temperatures."""
-
-    avg: Temperature
-    """Average temperature of the collection of temperatures."""

src/frequenz/sdk/timeseries/battery_pool/battery_pool.py

@@ -27,15 +27,15 @@
     FormulaGeneratorConfig,
     FormulaType,
 )
-from .._quantities import Energy, Percentage, Power
+from .._quantities import Energy, Percentage, Power, Temperature
 from ._methods import MetricAggregator, SendOnUpdate
 from ._metric_calculator import (
     CapacityCalculator,
     PowerBoundsCalculator,
     SoCCalculator,
     TemperatureCalculator,
 )
-from ._result_types import PowerMetrics, TemperatureMetrics
+from ._result_types import PowerMetrics
 
 
 class BatteryPool:
@@ -388,11 +388,11 @@ def soc(self) -> MetricAggregator[Sample[Percentage]]:
         return self._active_methods[method_name]
 
     @property
-    def temperature(self) -> MetricAggregator[TemperatureMetrics]:
-        """Fetch the maximum temperature of the batteries in the pool.
+    def temperature(self) -> MetricAggregator[Sample[Temperature]]:
+        """Fetch the average temperature of the batteries in the pool.
 
         Returns:
-            A MetricAggregator that will calculate and stream the maximum temperature
+            A MetricAggregator that will calculate and stream the average temperature
                 of all batteries in the pool.
         """
         method_name = SendOnUpdate.name() + "_" + TemperatureCalculator.name()