Move the PV power formula from logical_meter to PVPool

Also update the PV formula builder to use the component IDs from the
PV pool if specified.

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

Author: shsms

src/frequenz/sdk/timeseries/formula_engine/_formula_generators/_pv_power_formula.py

@@ -38,11 +38,15 @@ def generate(  # noqa: DOC502
         )
 
         component_graph = connection_manager.get().component_graph
-        pv_components = component_graph.dfs(
-            self._get_grid_component(),
-            set(),
-            component_graph.is_pv_chain,
-        )
+        component_ids = self._config.component_ids
+        if component_ids:
+            pv_components = component_graph.components(set(component_ids))
+        else:
+            pv_components = component_graph.dfs(
+                self._get_grid_component(),
+                set(),
+                component_graph.is_pv_chain,
+            )
 
         if not pv_components:
             _logger.warning(

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

@@ -13,7 +13,7 @@
 from .._quantities import Power, Quantity
 from ..formula_engine import FormulaEngine
 from ..formula_engine._formula_engine_pool import FormulaEnginePool
-from ..formula_engine._formula_generators import CHPPowerFormula, PVPowerFormula
+from ..formula_engine._formula_generators import CHPPowerFormula
 
 
 class LogicalMeter:
@@ -42,17 +42,18 @@ class LogicalMeter:
         )
 
         logical_meter = microgrid.logical_meter()
+        pv_pool = microgrid.pv_pool()
         grid = microgrid.grid()
 
         # Get a receiver for a builtin formula
-        pv_power_recv = logical_meter.pv_power.new_receiver()
+        pv_power_recv = pv_pool.power.new_receiver()
         async for pv_power_sample in pv_power_recv:
             print(pv_power_sample)
 
         # or compose formulas to create a new formula
         net_power_recv = (
             (
-                grid.power - logical_meter.pv_power
+                grid.power - pv_pool.power
             )
             .build("net_power")
             .new_receiver()
@@ -123,28 +124,6 @@ def start_formula(
             formula, component_metric_id, nones_are_zeros=nones_are_zeros
         )
 
-    @property
-    def pv_power(self) -> FormulaEngine[Power]:
-        """Fetch the PV power in the microgrid.
-
-        This formula produces values that are in the Passive Sign Convention (PSC).
-
-        If a formula engine to calculate PV power is not already running, it will be
-        started.
-
-        A receiver from the formula engine can be created using the `new_receiver`
-        method.
-
-        Returns:
-            A FormulaEngine that will calculate and stream PV total power.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "pv_power",
-            PVPowerFormula,
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
     @property
     def chp_power(self) -> FormulaEngine[Power]:
         """Fetch the CHP power production in the microgrid.

src/frequenz/sdk/timeseries/pv_pool/_pv_pool.py

@@ -14,6 +14,8 @@
 from ...timeseries import Bounds
 from .._base_types import SystemBounds
 from .._quantities import Power
+from ..formula_engine import FormulaEngine
+from ..formula_engine._formula_generators import FormulaGeneratorConfig, PVPowerFormula
 from ._pv_pool_reference_store import PVPoolReferenceStore
 from ._result_types import PVPoolReport
 
@@ -131,6 +133,32 @@ def component_ids(self) -> abc.Set[int]:
         """
         return self._pv_pool_ref.component_ids
 
+    @property
+    def power(self) -> FormulaEngine[Power]:
+        """Fetch the total power for the EV Chargers in the pool.
+
+        This formula produces values that are in the Passive Sign Convention (PSC).
+
+        If a formula engine to calculate EV Charger power is not already running, it
+        will be started.
+
+        A receiver from the formula engine can be created using the `new_receiver`
+        method.
+
+        Returns:
+            A FormulaEngine that will calculate and stream the total power of all EV
+                Chargers.
+        """
+        engine = self._pv_pool_ref.formula_pool.from_power_formula_generator(
+            "pv_power",
+            PVPowerFormula,
+            FormulaGeneratorConfig(
+                component_ids=self._pv_pool_ref.component_ids,
+            ),
+        )
+        assert isinstance(engine, FormulaEngine)
+        return engine
+
     @property
     def power_status(self) -> ReceiverFetcher[PVPoolReport]:
         """Get a receiver to receive new power status reports when they change.
@@ -163,6 +191,10 @@ def power_status(self) -> ReceiverFetcher[PVPoolReport]:
         # https://github.com/frequenz-floss/frequenz-sdk-python/issues/823
         return typing.cast(ReceiverFetcher[PVPoolReport], channel)
 
+    async def stop(self) -> None:
+        """Stop all tasks and channels owned by the PVPool."""
+        await self._pv_pool_ref.stop()
+
     @property
     def _system_power_bounds(self) -> ReceiverFetcher[SystemBounds]:
         """Return a receiver fetcher for the system power bounds."""

tests/timeseries/_formula_engine/test_formula_composition.py

@@ -40,6 +40,9 @@ async def test_formula_composition(  # pylint: disable=too-many-locals
                 battery_pool._battery_pool.stop  # pylint: disable=protected-access
             )
 
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+
             grid = microgrid.grid()
             stack.push_async_callback(grid.stop)
 
@@ -51,9 +54,9 @@ async def test_formula_composition(  # pylint: disable=too-many-locals
             )
             grid_power_recv = grid.power.new_receiver()
             battery_power_recv = battery_pool.power.new_receiver()
-            pv_power_recv = logical_meter.pv_power.new_receiver()
+            pv_power_recv = pv_pool.power.new_receiver()
 
-            engine = (logical_meter.pv_power + battery_pool.power).build("inv_power")
+            engine = (pv_pool.power + battery_pool.power).build("inv_power")
             stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
 
             inv_calc_recv = engine.new_receiver()
@@ -62,6 +65,7 @@ async def test_formula_composition(  # pylint: disable=too-many-locals
             await mockgrid.mock_resampler.send_meter_power(
                 [100.0, 10.0, 12.0, 14.0, -100.0, -200.0]
             )
+            await mockgrid.mock_resampler.send_pv_inverter_power([-100.0, -200.0])
 
             grid_pow = await grid_power_recv.receive()
             pv_pow = await pv_power_recv.receive()
@@ -116,12 +120,15 @@ async def test_formula_composition_missing_pv(self, mocker: MockerFixture) -> No
                 battery_pool._battery_pool.stop  # pylint: disable=protected-access
             )
 
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+
             logical_meter = microgrid.logical_meter()
             stack.push_async_callback(logical_meter.stop)
 
             battery_power_recv = battery_pool.power.new_receiver()
-            pv_power_recv = logical_meter.pv_power.new_receiver()
-            engine = (logical_meter.pv_power + battery_pool.power).build("inv_power")
+            pv_power_recv = pv_pool.power.new_receiver()
+            engine = (pv_pool.power + battery_pool.power).build("inv_power")
             stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
 
             inv_calc_recv = engine.new_receiver()
@@ -156,18 +163,22 @@ async def test_formula_composition_missing_bat(self, mocker: MockerFixture) -> N
             stack.push_async_callback(
                 battery_pool._battery_pool.stop  # pylint: disable=protected-access
             )
+
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+
             logical_meter = microgrid.logical_meter()
             stack.push_async_callback(logical_meter.stop)
 
             battery_power_recv = battery_pool.power.new_receiver()
-            pv_power_recv = logical_meter.pv_power.new_receiver()
-            engine = (logical_meter.pv_power + battery_pool.power).build("inv_power")
+            pv_power_recv = pv_pool.power.new_receiver()
+            engine = (pv_pool.power + battery_pool.power).build("inv_power")
             stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
 
             inv_calc_recv = engine.new_receiver()
 
             for _ in range(10):
-                await mockgrid.mock_resampler.send_meter_power(
+                await mockgrid.mock_resampler.send_pv_inverter_power(
                     [12.0 + count, 14.0 + count]
                 )
                 await mockgrid.mock_resampler.send_non_existing_component_value()

tests/timeseries/test_formula_formatter.py

@@ -123,15 +123,16 @@ async def test_higher_order_formula(self, mocker: MockerFixture) -> None:
             logical_meter = microgrid.logical_meter()
             stack.push_async_callback(logical_meter.stop)
 
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+
             grid = microgrid.grid()
             stack.push_async_callback(grid.stop)
 
             assert str(grid.power) == "#36 + #7 + #47 + #17 + #57 + #27"
 
-            composed_formula = (grid.power - logical_meter.pv_power).build(
-                "grid_minus_pv"
-            )
+            composed_formula = (grid.power - pv_pool.power).build("grid_minus_pv")
             assert (
                 str(composed_formula)
-                == "[grid-power](#36 + #7 + #47 + #17 + #57 + #27) - [pv-power](#57 + #47)"
+                == "[grid-power](#36 + #7 + #47 + #17 + #57 + #27) - [pv-power](#48 + #58)"
             )

tests/timeseries/test_logical_meter.py

@@ -44,11 +44,11 @@ async def test_pv_power(self, mocker: MockerFixture) -> None:
         mockgrid.add_solar_inverters(2)
 
         async with mockgrid, AsyncExitStack() as stack:
-            logical_meter = microgrid.logical_meter()
-            stack.push_async_callback(logical_meter.stop)
-            pv_power_receiver = logical_meter.pv_power.new_receiver()
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+            pv_power_receiver = pv_pool.power.new_receiver()
 
-            await mockgrid.mock_resampler.send_meter_power([-1.0, -2.0])
+            await mockgrid.mock_resampler.send_pv_inverter_power([-1.0, -2.0])
             assert (await pv_power_receiver.receive()).value == Power.from_watts(-3.0)
 
     async def test_pv_power_no_meter(self, mocker: MockerFixture) -> None:
@@ -57,9 +57,9 @@ async def test_pv_power_no_meter(self, mocker: MockerFixture) -> None:
         mockgrid.add_solar_inverters(2, no_meter=True)
 
         async with mockgrid, AsyncExitStack() as stack:
-            logical_meter = microgrid.logical_meter()
-            stack.push_async_callback(logical_meter.stop)
-            pv_power_receiver = logical_meter.pv_power.new_receiver()
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+            pv_power_receiver = pv_pool.power.new_receiver()
 
             await mockgrid.mock_resampler.send_pv_inverter_power([-1.0, -2.0])
             assert (await pv_power_receiver.receive()).value == Power.from_watts(-3.0)
@@ -70,9 +70,9 @@ async def test_pv_power_no_pv_components(self, mocker: MockerFixture) -> None:
             MockMicrogrid(grid_meter=True, mocker=mocker) as mockgrid,
             AsyncExitStack() as stack,
         ):
-            logical_meter = microgrid.logical_meter()
-            stack.push_async_callback(logical_meter.stop)
-            pv_power_receiver = logical_meter.pv_power.new_receiver()
+            pv_pool = microgrid.pv_pool()
+            stack.push_async_callback(pv_pool.stop)
+            pv_power_receiver = pv_pool.power.new_receiver()
 
             await mockgrid.mock_resampler.send_non_existing_component_value()
             assert (await pv_power_receiver.receive()).value == Power.zero()