Remove the cons/prod formulas from logical meter

These formulas are replaced by a combination of the corresponding
passive sign convention formulas and the recently added consumption
and production operators.

Signed-off-by: Matthias Wende <[email protected]>

Author: matthias-wende-frequenz

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

@@ -152,52 +152,6 @@ def grid_power(self) -> FormulaEngine[Power]:
         assert isinstance(engine, FormulaEngine)
         return engine
 
-    @property
-    def grid_consumption_power(self) -> FormulaEngine[Power]:
-        """Fetch the grid consumption power for the microgrid.
-
-        This formula produces positive values when consuming power and 0 otherwise.
-
-        If a formula engine to calculate grid consumption 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 grid consumption power.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "grid_consumption_power",
-            GridPowerFormula,
-            FormulaGeneratorConfig(formula_type=FormulaType.CONSUMPTION),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def grid_production_power(self) -> FormulaEngine[Power]:
-        """Fetch the grid production power for the microgrid.
-
-        This formula produces positive values when producing power and 0 otherwise.
-
-        If a formula engine to calculate grid production 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 grid production power.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "grid_production_power",
-            GridPowerFormula,
-            FormulaGeneratorConfig(formula_type=FormulaType.PRODUCTION),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
     @property
     def grid_current(self) -> FormulaEngine3Phase[Current]:
         """Fetch the grid power for the microgrid.
@@ -293,52 +247,6 @@ def pv_power(self) -> FormulaEngine[Power]:
         assert isinstance(engine, FormulaEngine)
         return engine
 
-    @property
-    def pv_production_power(self) -> FormulaEngine[Power]:
-        """Fetch the PV power production in the microgrid.
-
-        This formula produces positive values when producing power and 0 otherwise.
-
-        If a formula engine to calculate PV power production 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 power production.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "pv_production_power",
-            PVPowerFormula,
-            FormulaGeneratorConfig(formula_type=FormulaType.PRODUCTION),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def pv_consumption_power(self) -> FormulaEngine[Power]:
-        """Fetch the PV power consumption in the microgrid.
-
-        This formula produces positive values when consuming power and 0 otherwise.
-
-        If a formula engine to calculate PV power consumption 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 power consumption.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "pv_consumption_power",
-            PVPowerFormula,
-            FormulaGeneratorConfig(formula_type=FormulaType.CONSUMPTION),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
     @property
     def chp_power(self) -> FormulaEngine[Power]:
         """Fetch the CHP power production in the microgrid.
@@ -362,56 +270,6 @@ def chp_power(self) -> FormulaEngine[Power]:
         assert isinstance(engine, FormulaEngine)
         return engine
 
-    @property
-    def chp_production_power(self) -> FormulaEngine[Power]:
-        """Fetch the CHP power production in the microgrid.
-
-        This formula produces positive values when producing power and 0 otherwise.
-
-        If a formula engine to calculate CHP power production 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 CHP power production.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "chp_production_power",
-            CHPPowerFormula,
-            FormulaGeneratorConfig(
-                formula_type=FormulaType.PRODUCTION,
-            ),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def chp_consumption_power(self) -> FormulaEngine[Power]:
-        """Fetch the CHP power consumption in the microgrid.
-
-        This formula produces positive values when consuming power and 0 otherwise.
-
-        If a formula engine to calculate CHP power consumption 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 CHP power consumption.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "chp_consumption_power",
-            CHPPowerFormula,
-            FormulaGeneratorConfig(
-                formula_type=FormulaType.CONSUMPTION,
-            ),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
     async def stop(self) -> None:
         """Stop all formula engines."""
         await self._formula_pool.stop()

tests/timeseries/test_logical_meter.py

@@ -269,18 +269,12 @@ async def test_grid_production_consumption_power_consumer_meter(
 
         logical_meter = microgrid.logical_meter()
         grid_recv = logical_meter.grid_power.new_receiver()
-        grid_production_recv = logical_meter.grid_production_power.new_receiver()
-        grid_consumption_recv = logical_meter.grid_consumption_power.new_receiver()
 
         await mockgrid.mock_resampler.send_meter_power([1.0, 2.0, 3.0, 4.0])
         assert (await grid_recv.receive()).value == Power.from_watts(10.0)
-        assert (await grid_production_recv.receive()).value == Power.from_watts(0.0)
-        assert (await grid_consumption_recv.receive()).value == Power.from_watts(10.0)
 
         await mockgrid.mock_resampler.send_meter_power([1.0, 2.0, -3.0, -4.0])
         assert (await grid_recv.receive()).value == Power.from_watts(-4.0)
-        assert (await grid_production_recv.receive()).value == Power.from_watts(4.0)
-        assert (await grid_consumption_recv.receive()).value == Power.from_watts(0.0)
 
     async def test_grid_production_consumption_power_no_grid_meter(
         self,
@@ -294,18 +288,12 @@ async def test_grid_production_consumption_power_no_grid_meter(
 
         logical_meter = microgrid.logical_meter()
         grid_recv = logical_meter.grid_power.new_receiver()
-        grid_production_recv = logical_meter.grid_production_power.new_receiver()
-        grid_consumption_recv = logical_meter.grid_consumption_power.new_receiver()
 
         await mockgrid.mock_resampler.send_meter_power([2.5, 3.5, 4.0])
         assert (await grid_recv.receive()).value == Power.from_watts(10.0)
-        assert (await grid_production_recv.receive()).value == Power.from_watts(0.0)
-        assert (await grid_consumption_recv.receive()).value == Power.from_watts(10.0)
 
         await mockgrid.mock_resampler.send_meter_power([3.0, -3.0, -4.0])
         assert (await grid_recv.receive()).value == Power.from_watts(-4.0)
-        assert (await grid_production_recv.receive()).value == Power.from_watts(4.0)
-        assert (await grid_consumption_recv.receive()).value == Power.from_watts(0.0)
 
     async def test_chp_power(self, mocker: MockerFixture) -> None:
         """Test the chp power formula."""
@@ -316,30 +304,12 @@ async def test_chp_power(self, mocker: MockerFixture) -> None:
 
         logical_meter = microgrid.logical_meter()
         chp_power_receiver = logical_meter.chp_power.new_receiver()
-        chp_production_power_receiver = (
-            logical_meter.chp_production_power.new_receiver()
-        )
-        chp_consumption_power_receiver = (
-            logical_meter.chp_consumption_power.new_receiver()
-        )
 
         await mockgrid.mock_resampler.send_meter_power([2.0, 3.0, 4.0])
         assert (await chp_power_receiver.receive()).value == Power.from_watts(2.0)
-        assert (
-            await chp_production_power_receiver.receive()
-        ).value == Power.from_watts(0.0)
-        assert (
-            await chp_consumption_power_receiver.receive()
-        ).value == Power.from_watts(2.0)
 
         await mockgrid.mock_resampler.send_meter_power([-12.0, None, 10.2])
         assert (await chp_power_receiver.receive()).value == Power.from_watts(-12.0)
-        assert (
-            await chp_production_power_receiver.receive()
-        ).value == Power.from_watts(12.0)
-        assert (
-            await chp_consumption_power_receiver.receive()
-        ).value == Power.from_watts(0.0)
 
     async def test_pv_power(self, mocker: MockerFixture) -> None:
         """Test the pv power formula."""
@@ -349,19 +319,9 @@ async def test_pv_power(self, mocker: MockerFixture) -> None:
 
         logical_meter = microgrid.logical_meter()
         pv_power_receiver = logical_meter.pv_power.new_receiver()
-        pv_production_power_receiver = logical_meter.pv_production_power.new_receiver()
-        pv_consumption_power_receiver = (
-            logical_meter.pv_consumption_power.new_receiver()
-        )
 
         await mockgrid.mock_resampler.send_meter_power([-1.0, -2.0])
         assert (await pv_power_receiver.receive()).value == Power.from_watts(-3.0)
-        assert (await pv_production_power_receiver.receive()).value == Power.from_watts(
-            3.0
-        )
-        assert (
-            await pv_consumption_power_receiver.receive()
-        ).value == Power.from_watts(0.0)
 
     async def test_pv_power_no_meter(self, mocker: MockerFixture) -> None:
         """Test the pv power formula."""
@@ -371,19 +331,9 @@ async def test_pv_power_no_meter(self, mocker: MockerFixture) -> None:
 
         logical_meter = microgrid.logical_meter()
         pv_power_receiver = logical_meter.pv_power.new_receiver()
-        pv_production_power_receiver = logical_meter.pv_production_power.new_receiver()
-        pv_consumption_power_receiver = (
-            logical_meter.pv_consumption_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)
-        assert (await pv_production_power_receiver.receive()).value == Power.from_watts(
-            3.0
-        )
-        assert (
-            await pv_consumption_power_receiver.receive()
-        ).value == Power.from_watts(0.0)
 
     async def test_pv_power_no_pv_components(self, mocker: MockerFixture) -> None:
         """Test the pv power formula without having any pv components."""
@@ -427,17 +377,17 @@ async def test_consumer_power_2_grid_meters(
         self,
         mocker: MockerFixture,
     ) -> None:
-        """Test the grid power formula with grid meters."""
+        """Test the grid power formula with two grid meters."""
         mockgrid = MockMicrogrid(grid_meter=False)
         # with no further sucessor these will be detected as grid meters
         mockgrid.add_consumer_meters(2)
         await mockgrid.start(mocker)
 
         logical_meter = microgrid.logical_meter()
-        grid_consumption_recv = logical_meter.grid_consumption_power.new_receiver()
+        grid_recv = logical_meter.grid_power.new_receiver()
 
         await mockgrid.mock_resampler.send_meter_power([1.0, 2.0])
-        assert (await grid_consumption_recv.receive()).value == Power.from_watts(3.0)
+        assert (await grid_recv.receive()).value == Power.from_watts(3.0)
 
     async def test_consumer_power_no_grid_meter_no_consumer_meter(
         self, mocker: MockerFixture