Improve naming of grid per-phase metrics

Single 3-phase metrics like `power` have had no suffix, and those stay
as they are.

3-phase metrics specified per-phase now use the `per_phase` suffix.

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

Author: shsms

src/frequenz/sdk/timeseries/formula_engine/_formula_engine.py

@@ -461,7 +461,7 @@ class FormulaEngine3Phase(
 
     ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
 
-    async for sample in ev_charger_pool.current.new_receiver():
+    async for sample in ev_charger_pool.current_per_phase.new_receiver():
         print(f"Current: {sample}")
     ```
 
@@ -478,7 +478,9 @@ class FormulaEngine3Phase(
     grid = microgrid.grid()
 
     # Calculate grid consumption current that's not used by the EV chargers
-    other_current = (grid.current - ev_charger_pool.current).build("other_current")
+    other_current = (grid.current_per_phase - ev_charger_pool.current).build(
+        "other_current"
+    )
 
     async for sample in other_current.new_receiver():
         print(f"Other current: {sample}")

src/frequenz/sdk/timeseries/grid.py

@@ -99,8 +99,8 @@ def power(self) -> FormulaEngine[Power]:
         return engine
 
     @property
-    def _power_3_phase(self) -> FormulaEngine3Phase[Power]:
-        """Fetch the grid 3-phase power for the microgrid.
+    def _power_per_phase(self) -> FormulaEngine3Phase[Power]:
+        """Fetch the per-phase grid power for the microgrid.
 
         This formula produces values that are in the Passive Sign Convention (PSC).
 
@@ -117,8 +117,8 @@ def _power_3_phase(self) -> FormulaEngine3Phase[Power]:
         return engine
 
     @property
-    def current(self) -> FormulaEngine3Phase[Current]:
-        """Fetch the grid current for the microgrid.
+    def current_per_phase(self) -> FormulaEngine3Phase[Current]:
+        """Fetch the per-phase grid current for the microgrid.
 
         This formula produces values that are in the Passive Sign Convention (PSC).
 

tests/microgrid/test_grid.py

@@ -200,8 +200,8 @@ async def test_grid_power_3_phase_side_meter(mocker: MockerFixture) -> None:
         assert grid, "Grid is not initialized"
         stack.push_async_callback(grid.stop)
 
-        grid_power_3_phase_recv = (
-            grid._power_3_phase.new_receiver()  # pylint: disable=protected-access
+        grid_power_per_phase_recv = (
+            grid._power_per_phase.new_receiver()  # pylint: disable=protected-access
         )
 
         for count in range(10):
@@ -216,7 +216,7 @@ async def test_grid_power_3_phase_side_meter(mocker: MockerFixture) -> None:
                 [watts_phases, watts_phases]
             )
 
-            val = await grid_power_3_phase_recv.receive()
+            val = await grid_power_per_phase_recv.receive()
             assert val is not None
             assert val.value_p1 and val.value_p2 and val.value_p3
             assert val.value_p1.as_watts() == watts_phases[0]
@@ -234,8 +234,8 @@ async def test_grid_power_3_phase_none_values(mocker: MockerFixture) -> None:
         assert grid, "Grid is not initialized"
         stack.push_async_callback(grid.stop)
 
-        grid_power_3_phase_recv = (
-            grid._power_3_phase.new_receiver()  # pylint: disable=protected-access
+        grid_power_per_phase_recv = (
+            grid._power_per_phase.new_receiver()  # pylint: disable=protected-access
         )
 
         for count in range(10):
@@ -250,7 +250,7 @@ async def test_grid_power_3_phase_none_values(mocker: MockerFixture) -> None:
                 [watts_phases, [None, None, None], [None, 219.8, 220.2]]
             )
 
-            val = await grid_power_3_phase_recv.receive()
+            val = await grid_power_per_phase_recv.receive()
             assert val is not None
             assert val.value_p1 and val.value_p2 and val.value_p3
             assert val.value_p1.as_watts() == watts_phases[0]

tests/timeseries/_formula_engine/test_formula_composition.py

@@ -428,10 +428,10 @@ async def test_3_phase_formulas(self, mocker: MockerFixture) -> None:
             grid = microgrid.grid()
             stack.push_async_callback(grid.stop)
 
-            grid_current_recv = grid.current.new_receiver()
+            grid_current_recv = grid.current_per_phase.new_receiver()
             ev_current_recv = ev_pool.current.new_receiver()
 
-            engine = (grid.current - ev_pool.current).build("net_current")
+            engine = (grid.current_per_phase - ev_pool.current).build("net_current")
             stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
             net_current_recv = engine.new_receiver()