Rename temperature_max fields to temperature

The name `temperature_max` of a single battery indicates that a single
battery can have multiple temperatures.  This is not the case for all
batteries, and hence can't be part of the high level API.

In the high level APIs, there should be just one temperature value per
battery.

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

Author: shsms

src/frequenz/sdk/actor/_data_sourcing/microgrid_api_source.py

@@ -84,7 +84,7 @@ def get_channel_name(self) -> str:
     ComponentMetricId.CAPACITY: lambda msg: msg.capacity,
     ComponentMetricId.POWER_LOWER_BOUND: lambda msg: msg.power_lower_bound,
     ComponentMetricId.POWER_UPPER_BOUND: lambda msg: msg.power_upper_bound,
-    ComponentMetricId.TEMPERATURE_MAX: lambda msg: msg.temperature_max,
+    ComponentMetricId.TEMPERATURE: lambda msg: msg.temperature,
 }
 
 _InverterDataMethods: Dict[ComponentMetricId, Callable[[InverterData], float]] = {

src/frequenz/sdk/microgrid/component/_component.py

@@ -140,4 +140,4 @@ class ComponentMetricId(Enum):
     ACTIVE_POWER_LOWER_BOUND = "active_power_lower_bound"
     ACTIVE_POWER_UPPER_BOUND = "active_power_upper_bound"
 
-    TEMPERATURE_MAX = "temperature_max"
+    TEMPERATURE = "temperature"

src/frequenz/sdk/microgrid/component/_component_data.py

@@ -141,8 +141,8 @@ class BatteryData(ComponentData):
         This will be a positive number, or zero if no charging is possible.
     """
 
-    temperature_max: float
-    """The maximum temperature of all the blocks in a battery, in Celcius (°C)."""
+    temperature: float
+    """The (average) temperature reported by the battery a battery, in Celcius (°C)."""
 
     _relay_state: battery_pb.RelayState.ValueType
     """State of the battery relay."""
@@ -172,7 +172,7 @@ def from_proto(cls, raw: microgrid_pb.ComponentData) -> BatteryData:
             capacity=raw.battery.properties.capacity,
             power_lower_bound=raw.battery.data.dc.power.system_bounds.lower,
             power_upper_bound=raw.battery.data.dc.power.system_bounds.upper,
-            temperature_max=raw.battery.data.temperature.max,
+            temperature=raw.battery.data.temperature.avg,
             _relay_state=raw.battery.state.relay_state,
             _component_state=raw.battery.state.component_state,
             _errors=list(raw.battery.errors),

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

@@ -246,7 +246,7 @@ def __init__(self, batteries: Set[int]) -> None:
         super().__init__(batteries)
 
         self._metrics = [
-            ComponentMetricId.TEMPERATURE_MAX,
+            ComponentMetricId.TEMPERATURE,
         ]
 
     @classmethod
@@ -306,7 +306,7 @@ def calculate(
             if battery_id not in metrics_data:
                 continue
             metrics = metrics_data[battery_id]
-            temperature = metrics.get(ComponentMetricId.TEMPERATURE_MAX)
+            temperature = metrics.get(ComponentMetricId.TEMPERATURE)
             if temperature is None:
                 continue
             timestamp = max(timestamp, metrics.timestamp)

tests/utils/component_data_wrapper.py

@@ -43,7 +43,7 @@ def __init__(  # pylint: disable=too-many-arguments
         capacity: float = math.nan,
         power_lower_bound: float = math.nan,
         power_upper_bound: float = math.nan,
-        temperature_max: float = math.nan,
+        temperature: float = math.nan,
         _relay_state: battery_pb.RelayState.ValueType = (
             battery_pb.RelayState.RELAY_STATE_UNSPECIFIED
         ),
@@ -66,7 +66,7 @@ def __init__(  # pylint: disable=too-many-arguments
             capacity=capacity,
             power_lower_bound=power_lower_bound,
             power_upper_bound=power_upper_bound,
-            temperature_max=temperature_max,
+            temperature=temperature,
             _relay_state=_relay_state,
             _component_state=_component_state,
             _errors=_errors if _errors else [],