Remove the consumption and production power formulas (#697)

Users must understand passive sign conventions to utilize these formulas
effectively, and therefore they do not provide significant benefits.

Author: matthias-wende-frequenz

RELEASE_NOTES.md

@@ -64,6 +64,8 @@ This version ships an experimental version of the **Power Manager**, adds prelim
 
 - Add consumption and production operators that will replace the logical meters production and consumption function variants.
 
+- Consumption and production power formulas have been removed.
+
 ## Bug Fixes
 
 - Fix rendering of diagrams in the documentation.

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

@@ -21,7 +21,6 @@
 from ..formula_engine._formula_generators import (
     BatteryPowerFormula,
     FormulaGeneratorConfig,
-    FormulaType,
 )
 from ._battery_pool_reference_store import BatteryPoolReferenceStore
 from ._methods import SendOnUpdate
@@ -255,61 +254,6 @@ def power(self) -> FormulaEngine[Power]:
             BatteryPowerFormula,
             FormulaGeneratorConfig(
                 component_ids=self._battery_pool._batteries,
-                formula_type=FormulaType.PASSIVE_SIGN_CONVENTION,
-            ),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def production_power(self) -> FormulaEngine[Power]:
-        """Fetch the total production power of the batteries in the pool.
-
-        This formula produces positive values when producing power and 0 otherwise.
-
-        If a formula engine to calculate this metric is not already running, it will be
-        started.
-
-        A receiver from the formula engine can be obtained by calling the `new_receiver`
-        method.
-
-        Returns:
-            A FormulaEngine that will calculate and stream the total production power of
-                all batteries in the pool.
-        """
-        engine = self._battery_pool._formula_pool.from_power_formula_generator(
-            "battery_pool_production_power",
-            BatteryPowerFormula,
-            FormulaGeneratorConfig(
-                component_ids=self._battery_pool._batteries,
-                formula_type=FormulaType.PRODUCTION,
-            ),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def consumption_power(self) -> FormulaEngine[Power]:
-        """Fetch the total consumption power of the batteries in the pool.
-
-        This formula produces positive values when consuming power and 0 otherwise.
-
-        If a formula engine to calculate this metric is not already running, it will be
-        started.
-
-        A receiver from the formula engine can be obtained by calling the `new_receiver`
-        method.
-
-        Returns:
-            A FormulaEngine that will calculate and stream the total consumption
-                power of all batteries in the pool.
-        """
-        engine = self._battery_pool._formula_pool.from_power_formula_generator(
-            "battery_pool_consumption_power",
-            BatteryPowerFormula,
-            FormulaGeneratorConfig(
-                component_ids=self._battery_pool._batteries,
-                formula_type=FormulaType.CONSUMPTION,
             ),
         )
         assert isinstance(engine, FormulaEngine)

src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py

@@ -26,7 +26,6 @@
     EVChargerCurrentFormula,
     EVChargerPowerFormula,
     FormulaGeneratorConfig,
-    FormulaType,
 )
 from ._set_current_bounds import BoundsSetter, ComponentCurrentLimit
 from ._state_tracker import EVChargerState, StateTracker
@@ -181,61 +180,6 @@ def power(self) -> FormulaEngine[Power]:
             EVChargerPowerFormula,
             FormulaGeneratorConfig(
                 component_ids=self._component_ids,
-                formula_type=FormulaType.PASSIVE_SIGN_CONVENTION,
-            ),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def production_power(self) -> FormulaEngine[Power]:
-        """Fetch the total power produced by the EV Chargers in the pool.
-
-        This formula produces positive values when producing power and 0 otherwise.
-
-        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 production power of all
-                EV Chargers.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "ev_charger_production_power",
-            EVChargerPowerFormula,
-            FormulaGeneratorConfig(
-                component_ids=self._component_ids,
-                formula_type=FormulaType.PRODUCTION,
-            ),
-        )
-        assert isinstance(engine, FormulaEngine)
-        return engine
-
-    @property
-    def consumption_power(self) -> FormulaEngine[Power]:
-        """Fetch the total power consumed by the EV Chargers in the pool.
-
-        This formula produces positive values when consuming power and 0 otherwise.
-
-        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 consumption power of all
-                EV Chargers.
-        """
-        engine = self._formula_pool.from_power_formula_generator(
-            "ev_charger_consumption_power",
-            EVChargerPowerFormula,
-            FormulaGeneratorConfig(
-                component_ids=self._component_ids,
-                formula_type=FormulaType.CONSUMPTION,
             ),
         )
         assert isinstance(engine, FormulaEngine)

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

@@ -13,7 +13,6 @@
     FormulaGenerationError,
     FormulaGenerator,
     FormulaGeneratorConfig,
-    FormulaType,
 )
 from ._grid_current_formula import GridCurrentFormula
 from ._grid_power_formula import GridPowerFormula
@@ -26,7 +25,6 @@
     #
     "FormulaGenerator",
     "FormulaGeneratorConfig",
-    "FormulaType",
     #
     # Power Formula generators
     #

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

@@ -13,7 +13,6 @@
     NON_EXISTING_COMPONENT_ID,
     ComponentNotFound,
     FormulaGenerator,
-    FormulaType,
 )
 
 _logger = logging.getLogger(__name__)
@@ -78,12 +77,5 @@ def generate(
                 builder.push_oper("+")
             builder.push_component_metric(comp.component_id, nones_are_zeros=True)
         builder.push_oper(")")
-        if self._config.formula_type == FormulaType.PRODUCTION:
-            builder.push_oper("*")
-            builder.push_constant(-1)
-        builder.push_oper(")")
-
-        if self._config.formula_type != FormulaType.PASSIVE_SIGN_CONVENTION:
-            builder.push_clipper(0.0, None)
 
         return builder.build()

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

@@ -15,7 +15,6 @@
     NON_EXISTING_COMPONENT_ID,
     FormulaGenerationError,
     FormulaGenerator,
-    FormulaType,
 )
 
 _logger = logging.getLogger(__name__)
@@ -58,13 +57,6 @@ def generate(  # noqa: DOC502 (FormulaGenerationError is raised indirectly by _g
                 builder.push_oper("+")
             builder.push_component_metric(chp_meter_id, nones_are_zeros=False)
         builder.push_oper(")")
-        if self._config.formula_type == FormulaType.PRODUCTION:
-            builder.push_oper("*")
-            builder.push_constant(-1)
-        builder.push_oper(")")
-
-        if self._config.formula_type != FormulaType.PASSIVE_SIGN_CONVENTION:
-            builder.push_clipper(0.0, None)
 
         return builder.build()
 

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

@@ -8,7 +8,7 @@
 from ....microgrid.component import ComponentMetricId
 from ..._quantities import Power
 from .._formula_engine import FormulaEngine
-from ._formula_generator import NON_EXISTING_COMPONENT_ID, FormulaGenerator, FormulaType
+from ._formula_generator import NON_EXISTING_COMPONENT_ID, FormulaGenerator
 
 _logger = logging.getLogger(__name__)
 
@@ -48,12 +48,5 @@ def generate(self) -> FormulaEngine[Power]:
                 builder.push_oper("+")
             builder.push_component_metric(component_id, nones_are_zeros=True)
         builder.push_oper(")")
-        if self._config.formula_type == FormulaType.PRODUCTION:
-            builder.push_oper("*")
-            builder.push_constant(-1)
-        builder.push_oper(")")
-
-        if self._config.formula_type != FormulaType.PASSIVE_SIGN_CONVENTION:
-            builder.push_clipper(0.0, None)
 
         return builder.build()

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

@@ -9,7 +9,6 @@
 from collections import abc
 from collections.abc import Callable
 from dataclasses import dataclass
-from enum import Enum
 from typing import Generic
 
 from frequenz.channels import Sender
@@ -41,35 +40,13 @@ class ComponentNotFound(FormulaGenerationError):
 """
 
 
-class FormulaType(Enum):
-    """Enum representing type of formula outputs."""
-
-    PASSIVE_SIGN_CONVENTION = 1
-    """Formula output will be signed values, following the passive sign convention, with
-    consumption from the grid being positive and production to the grid being negative.
-    """
-
-    PRODUCTION = 2
-    """Formula output will be unsigned values representing production to the grid.  When
-    power is being consumed from the grid instead, this formula will output zero.
-    """
-
-    CONSUMPTION = 3
-    """Formula output will be unsigned values representing consumption from the grid.
-    When power is being produced to the grid instead, this formula will output zero.
-    """
-
-
 @dataclass(frozen=True)
 class FormulaGeneratorConfig:
     """Config for formula generators."""
 
     component_ids: abc.Set[int] | None = None
     """The component IDs to use for generating the formula."""
 
-    formula_type: FormulaType = FormulaType.PASSIVE_SIGN_CONVENTION
-    """The type of formula output."""
-
 
 class FormulaGenerator(ABC, Generic[QuantityT]):
     """A class for generating formulas from the component graph."""

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

@@ -6,7 +6,7 @@
 from ....microgrid.component import ComponentCategory, ComponentMetricId
 from ..._quantities import Power
 from .._formula_engine import FormulaEngine
-from ._formula_generator import FormulaGenerator, FormulaType
+from ._formula_generator import FormulaGenerator
 
 
 class GridPowerFormula(FormulaGenerator[Power]):
@@ -67,12 +67,4 @@ def generate(  # noqa: DOC502
             )
         builder.push_oper(")")
 
-        if self._config.formula_type == FormulaType.PRODUCTION:
-            builder.push_oper("*")
-            builder.push_constant(-1)
-        builder.push_oper(")")
-
-        if self._config.formula_type != FormulaType.PASSIVE_SIGN_CONVENTION:
-            builder.push_clipper(0.0, None)
-
         return builder.build()

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

@@ -9,7 +9,7 @@
 from ....microgrid.component import ComponentCategory, ComponentMetricId
 from ..._quantities import Power
 from .._formula_engine import FormulaEngine
-from ._formula_generator import NON_EXISTING_COMPONENT_ID, FormulaGenerator, FormulaType
+from ._formula_generator import NON_EXISTING_COMPONENT_ID, FormulaGenerator
 
 _logger = logging.getLogger(__name__)
 
@@ -69,12 +69,5 @@ def generate(  # noqa: DOC502
                 nones_are_zeros=component.category != ComponentCategory.METER,
             )
         builder.push_oper(")")
-        if self._config.formula_type == FormulaType.PRODUCTION:
-            builder.push_oper("*")
-            builder.push_constant(-1)
-        builder.push_oper(")")
-
-        if self._config.formula_type != FormulaType.PASSIVE_SIGN_CONVENTION:
-            builder.push_clipper(0.0, None)
 
         return builder.build()