Revert "Rename parameter in_shifting_group → set_operating_point (#970)"

This reverts commit 6a54a0b, reversing
changes made to 4c71140.

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

Author: shsms

src/frequenz/sdk/microgrid/__init__.py

@@ -186,39 +186,40 @@
 [`propose_power`][frequenz.sdk.timeseries.battery_pool.BatteryPool.propose_power]
 methods.
 
-### Shifting the target power by an Operating Point power
+### Shifting the target power by an offset
 
-There are cases where the target power needs to be shifted by an operating point.  This
-can be done by designating some actors to be able to set only the operating point power.
+There are cases where the target power needs to be shifted by a certain amount, for
+example, to make adjustments to the operating point.  This can be done by designating
+some actors to be part of the `shifting_group`.
 
 When creating a `*Pool` instance using the above-mentioned constructors, an optional
-`set_operating_point` parameter can be passed to specify that this actor is special, and
-the target power of the regular actors will be shifted by the target power of all actors
-with `set_operating_point` together.
+`in_shifting_group` parameter can be passed to specify that this actor is special, and
+the target power of the regular actors will be shifted by the target power of all
+shifting actors together.
 
-In a location with 2 regular actors and 1 `set_operating_point` actor, here's how things
+In a location with 2 regular actors and 1 shifting actor, here's how things
 would play out:
 
-1. When only regular actors have made proposals, the power bounds available from the
-   batteries are available to them exactly.
+1. When only non-shifting actors have made proposals, the power bounds available
+   from the batteries are available to them exactly.
 
-   | actor priority | in op group? | proposed power/bounds | available bounds |
-   |----------------|--------------|-----------------------|------------------|
-   | 3              | No           | 1000, -4000..2500     | -3000..3000      |
-   | 2              | No           | 2500                  | -3000..2500      |
-   | 1              | Yes          | None                  | -3000..3000      |
+   | actor priority | in shifting group? | proposed power/bounds | available bounds |
+   |----------------|--------------------|-----------------------|------------------|
+   | 3              | No                 | 1000, -4000..2500     | -3000..3000      |
+   | 2              | No                 | 2500                  | -3000..2500      |
+   | 1              | Yes                | None                  | -3000..3000      |
 
    Power actually distributed to the batteries: 2500W
 
-2. When the `set_operating_point` actor has made proposals, the bounds available to the
-   regular actors gets shifted, and the final power that actually gets distributed to
-   the batteries is also shifted.
+2. When the shifting actor has made proposals, the bounds available to the
+   regular actors gets shifted, and the final power that actually gets
+   distributed to the batteries is also shifted.
 
-   | actor priority | in op group? | proposed power/bounds | available bounds |
-   |----------------|--------------|-----------------------|------------------|
-   | 3              | No           | 1000, -4000..2500     | -2000..4000      |
-   | 2              | No           | 2500                  | -2000..2500      |
-   | 1              | Yes          | -1000                 | -3000..3000      |
+   | actor priority | in shifting group? | proposed power/bounds | available bounds |
+   |----------------|--------------------|-----------------------|------------------|
+   | 3              | No                 | 1000, -4000..2500     | -2000..4000      |
+   | 2              | No                 | 2500                  | -2000..2500      |
+   | 1              | Yes                | -1000                 | -3000..3000      |
 
    Power actually distributed to the batteries: 1500W
 """  # noqa: D205, D400

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -210,7 +210,7 @@ def new_ev_charger_pool(
         priority: int,
         component_ids: abc.Set[int] | None = None,
         name: str | None = None,
-        set_operating_point: bool = False,
+        in_shifting_group: bool = False,
     ) -> EVChargerPool:
         """Return the corresponding EVChargerPool instance for the given ids.
 
@@ -223,8 +223,8 @@ def new_ev_charger_pool(
                 EVChargerPool.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
-            set_operating_point: Whether this instance sets the operating point power or
-                the normal power for the components.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
 
         Returns:
             An EVChargerPool instance.
@@ -281,7 +281,7 @@ def new_ev_charger_pool(
             pool_ref_store=self._ev_charger_pool_reference_stores[ref_store_key],
             name=name,
             priority=priority,
-            set_operating_point=set_operating_point,
+            in_shifting_group=in_shifting_group,
         )
 
     def new_pv_pool(
@@ -290,7 +290,7 @@ def new_pv_pool(
         priority: int,
         component_ids: abc.Set[int] | None = None,
         name: str | None = None,
-        set_operating_point: bool = False,
+        in_shifting_group: bool = False,
     ) -> PVPool:
         """Return a new `PVPool` instance for the given ids.
 
@@ -303,8 +303,8 @@ def new_pv_pool(
                 `PVPool`.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
-            set_operating_point: Whether this instance sets the operating point power or
-                the normal power for the components.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
 
         Returns:
             A `PVPool` instance.
@@ -358,7 +358,7 @@ def new_pv_pool(
             pool_ref_store=self._pv_pool_reference_stores[ref_store_key],
             name=name,
             priority=priority,
-            set_operating_point=set_operating_point,
+            in_shifting_group=in_shifting_group,
         )
 
     def new_battery_pool(
@@ -367,7 +367,7 @@ def new_battery_pool(
         priority: int,
         component_ids: abc.Set[int] | None = None,
         name: str | None = None,
-        set_operating_point: bool = False,
+        in_shifting_group: bool = False,
     ) -> BatteryPool:
         """Return a new `BatteryPool` instance for the given ids.
 
@@ -380,8 +380,8 @@ def new_battery_pool(
                 `BatteryPool`.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
-            set_operating_point: Whether this instance sets the operating point power or
-                the normal power for the components.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
 
         Returns:
             A `BatteryPool` instance.
@@ -440,7 +440,7 @@ def new_battery_pool(
             pool_ref_store=self._battery_pool_reference_stores[ref_store_key],
             name=name,
             priority=priority,
-            set_operating_point=set_operating_point,
+            in_shifting_group=in_shifting_group,
         )
 
     def _data_sourcing_request_sender(self) -> Sender[ComponentMetricRequest]:
@@ -557,7 +557,7 @@ def new_ev_charger_pool(
     priority: int,
     component_ids: abc.Set[int] | None = None,
     name: str | None = None,
-    set_operating_point: bool = False,
+    in_shifting_group: bool = False,
 ) -> EVChargerPool:
     """Return a new `EVChargerPool` instance for the given parameters.
 
@@ -583,8 +583,8 @@ def new_ev_charger_pool(
             component graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
-        set_operating_point: Whether this instance sets the operating point power or the
-            normal power for the components.
+        in_shifting_group: Whether the power requests get sent to the shifting group
+            in the PowerManager or not.
 
     Returns:
         An `EVChargerPool` instance.
@@ -593,7 +593,7 @@ def new_ev_charger_pool(
         priority=priority,
         component_ids=component_ids,
         name=name,
-        set_operating_point=set_operating_point,
+        in_shifting_group=in_shifting_group,
     )
 
 
@@ -602,7 +602,7 @@ def new_battery_pool(
     priority: int,
     component_ids: abc.Set[int] | None = None,
     name: str | None = None,
-    set_operating_point: bool = False,
+    in_shifting_group: bool = False,
 ) -> BatteryPool:
     """Return a new `BatteryPool` instance for the given parameters.
 
@@ -628,8 +628,8 @@ def new_battery_pool(
             graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
-        set_operating_point: Whether this instance sets the operating point power or the
-            normal power for the components.
+        in_shifting_group: Whether the power requests get sent to the shifting group
+            in the PowerManager or not.
 
     Returns:
         A `BatteryPool` instance.
@@ -638,7 +638,7 @@ def new_battery_pool(
         priority=priority,
         component_ids=component_ids,
         name=name,
-        set_operating_point=set_operating_point,
+        in_shifting_group=in_shifting_group,
     )
 
 
@@ -647,7 +647,7 @@ def new_pv_pool(
     priority: int,
     component_ids: abc.Set[int] | None = None,
     name: str | None = None,
-    set_operating_point: bool = False,
+    in_shifting_group: bool = False,
 ) -> PVPool:
     """Return a new `PVPool` instance for the given parameters.
 
@@ -673,8 +673,8 @@ def new_pv_pool(
             graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
-        set_operating_point: Whether this instance sets the operating point power or the
-            normal power for the components.
+        in_shifting_group: Whether the power requests get sent to the shifting group
+            in the PowerManager or not.
 
     Returns:
         A `PVPool` instance.
@@ -683,7 +683,7 @@ def new_pv_pool(
         priority=priority,
         component_ids=component_ids,
         name=name,
-        set_operating_point=set_operating_point,
+        in_shifting_group=in_shifting_group,
     )
 
 

src/frequenz/sdk/microgrid/_power_managing/_base_classes.py

@@ -32,8 +32,8 @@ class ReportRequest:
     priority: int
     """The priority of the actor ."""
 
-    set_operating_point: bool
-    """Whether this proposal sets the operating point power or the normal power."""
+    in_shifting_group: bool
+    """Whether the proposal gets sent to the shifting group of the power manager."""
 
     def get_channel_name(self) -> str:
         """Get the channel name for the report request.
@@ -157,8 +157,8 @@ class Proposal:
     This is used by the power manager to determine the age of the proposal.
     """
 
-    set_operating_point: bool
-    """Whether this proposal sets the operating point power or the normal power."""
+    in_shifting_group: bool
+    """Whether the proposal gets sent to the shifting group of the power manager."""
 
     def __lt__(self, other: Proposal) -> bool:
         """Compare two proposals by their priority.