Remove _soc formula from the LogicalMeter (#248)

This feature has been moved to the BatteryPool.

Author: ela-kotulska-frequenz

RELEASE_NOTES.md

@@ -6,7 +6,7 @@
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+* Remove `_soc` formula from the LogicalMeter. This feature has been moved to the BatteryPool.
 
 ## New Features
 

src/frequenz/sdk/timeseries/_formula_engine/_formula_generators/__init__.py

@@ -4,7 +4,6 @@
 """Generators for formulas from component graphs."""
 
 from ._battery_power_formula import BatteryPowerFormula
-from ._battery_soc_formula import BatterySoCFormula
 from ._ev_charger_current_formula import EVChargerCurrentFormula
 from ._ev_charger_power_formula import EVChargerPowerFormula
 from ._formula_generator import (
@@ -28,7 +27,6 @@
     #
     "GridPowerFormula",
     "BatteryPowerFormula",
-    "BatterySoCFormula",
     "EVChargerPowerFormula",
     "PVPowerFormula",
     #

src/frequenz/sdk/timeseries/_formula_engine/_formula_generators/_battery_soc_formula.py

@@ -16,7 +16,6 @@
 from .._formula_engine import FormulaEnginePool, FormulaReceiver, FormulaReceiver3Phase
 from .._formula_engine._formula_generators import (
     BatteryPowerFormula,
-    BatterySoCFormula,
     GridCurrentFormula,
     GridPowerFormula,
     PVPowerFormula,
@@ -196,14 +195,3 @@ async def pv_power(self) -> FormulaReceiver:
 
         """
         return await self._formula_pool.from_generator("pv_power", PVPowerFormula)
-
-    async def _soc(self) -> FormulaReceiver:
-        """Fetch the SoC of the active batteries in the microgrid.
-
-        NOTE: This method is part of the logical meter only temporarily, and will get
-        moved to the `BatteryPool` within the next few releases.
-
-        Returns:
-            A *new* receiver that will stream average SoC of active batteries.
-        """
-        return await self._formula_pool.from_generator("soc", BatterySoCFormula)

src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py

@@ -5,8 +5,6 @@
 
 from __future__ import annotations
 
-from math import isclose
-
 from pytest_mock import MockerFixture
 
 from frequenz.sdk import microgrid
@@ -188,67 +186,3 @@ async def test_battery_and_pv_power(  # pylint: disable=too-many-locals
         assert equal_float_lists(battery_results, battery_inv_sums)
         assert len(pv_results) == 10
         assert equal_float_lists(pv_results, pv_inv_sums)
-
-    async def test_soc(self, mocker: MockerFixture) -> None:
-        """Test the soc calculation."""
-        mockgrid = MockMicrogrid(grid_side_meter=False, sample_rate_s=0.02)
-        mockgrid.add_solar_inverters(2)
-        mockgrid._id_increment = 8  # pylint: disable=protected-access
-        mockgrid.add_batteries(3)
-        request_chan, channel_registry = await mockgrid.start(mocker)
-        logical_meter = LogicalMeter(
-            channel_registry,
-            request_chan.new_sender(),
-            microgrid.get().component_graph,
-        )
-
-        soc_recv = await logical_meter._soc()  # pylint: disable=protected-access
-
-        bat_receivers = {
-            bat_id: await get_resampled_stream(
-                logical_meter,
-                channel_registry,
-                request_chan.new_sender(),
-                bat_id,
-                ComponentMetricId.SOC,
-            )
-            for bat_id in mockgrid.battery_ids
-        }
-
-        bat_inv_map = mockgrid.bat_inv_map
-        inv_receivers = {
-            inverter_id: await get_resampled_stream(
-                logical_meter,
-                channel_registry,
-                request_chan.new_sender(),
-                inverter_id,
-                ComponentMetricId.ACTIVE_POWER,
-            )
-            for inverter_id in mockgrid.bat_inv_map.values()
-        }
-
-        await synchronize_receivers(
-            [soc_recv, *bat_receivers.values(), *inv_receivers.values()]
-        )
-
-        for _ in range(10):
-            bat_vals = []
-            for bat_id, bat_recv in bat_receivers.items():
-                inv_id = bat_inv_map[bat_id]
-                inv_recv = inv_receivers[inv_id]
-                inv_msg = await inv_recv.receive()
-                # We won't use batteries where adjacent inverter is not sending active
-                # power.
-                if inv_msg.value is None:
-                    continue
-
-                val = await bat_recv.receive()
-                assert val is not None and val.value is not None
-                bat_vals.append(val.value)
-
-            soc_sample = await soc_recv.receive()
-            assert soc_sample is not None and soc_sample.value is not None
-
-            assert isclose(soc_sample.value, sum(bat_vals) / len(bat_vals))
-
-        await mockgrid.cleanup()