Rename power_bounds -> power_status and update docs

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

Author: shsms

benchmarks/power_distribution/power_distributor.py

@@ -51,7 +51,7 @@ async def send_requests(batteries: set[int], request_num: int) -> list[Result]:
         List of the results from the PowerDistributingActor.
     """
     battery_pool = microgrid.battery_pool(batteries)
-    results_rx = battery_pool.power_bounds.new_receiver()
+    results_rx = battery_pool.power_status.new_receiver()
     result: list[Any] = []
     for _ in range(request_num):
         await battery_pool.set_power(Power(float(random.randrange(100000, 1000000))))

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

@@ -383,14 +383,16 @@ def capacity(self) -> ReceiverFetcher[Sample[Energy]]:
         return self._battery_pool._active_methods[method_name]
 
     @property
-    def power_bounds(self) -> ReceiverFetcher[_power_managing.Report]:
-        """Get a receiver to receive new power bounds when they change.
+    def power_status(self) -> ReceiverFetcher[_power_managing.Report]:
+        """Get a receiver to receive new power status reports when they change.
 
-        These bounds are the bounds specified the power manager for actors with the
-        given priority.
+        These include
+          - the current inclusion/exclusion bounds available for the pool's priority,
+          - the current target power for the pool's set of batteries,
+          - the result of the last distribution request for the pool's set of batteries.
 
         Returns:
-            A receiver that will receive the power bounds for the given priority.
+            A receiver that will stream power status reports for the pool's priority.
         """
         sub = _power_managing.ReportRequest(
             source_id=self._source_id,

tests/timeseries/_battery_pool/test_battery_pool_control_methods.py

@@ -185,7 +185,7 @@ async def test_case_1(
         #
         # It will be replaced by a reporting streaming from the PowerManager in a
         # subsequent commit.
-        bounds_rx = battery_pool.power_bounds.new_receiver()
+        bounds_rx = battery_pool.power_status.new_receiver()
 
         self._assert_report(
             await bounds_rx.receive(), power=None, lower=-4000.0, upper=4000.0
@@ -279,9 +279,9 @@ async def test_case_2(self, mocks: Mocks, mocker: MockerFixture) -> None:
         await self._init_data_for_inverters(mocks)
 
         battery_pool_1 = microgrid.battery_pool(set(mocks.microgrid.battery_ids[:2]))
-        bounds_1_rx = battery_pool_1.power_bounds.new_receiver()
+        bounds_1_rx = battery_pool_1.power_status.new_receiver()
         battery_pool_2 = microgrid.battery_pool(set(mocks.microgrid.battery_ids[2:]))
-        bounds_2_rx = battery_pool_2.power_bounds.new_receiver()
+        bounds_2_rx = battery_pool_2.power_status.new_receiver()
 
         self._assert_report(
             await bounds_1_rx.receive(), power=None, lower=-2000.0, upper=2000.0
@@ -325,9 +325,9 @@ async def test_case_3(self, mocks: Mocks, mocker: MockerFixture) -> None:
         await self._init_data_for_inverters(mocks)
 
         battery_pool_1 = microgrid.battery_pool(priority=2)
-        bounds_1_rx = battery_pool_1.power_bounds.new_receiver()
+        bounds_1_rx = battery_pool_1.power_status.new_receiver()
         battery_pool_2 = microgrid.battery_pool(priority=1)
-        bounds_2_rx = battery_pool_2.power_bounds.new_receiver()
+        bounds_2_rx = battery_pool_2.power_status.new_receiver()
 
         self._assert_report(
             await bounds_1_rx.receive(), power=None, lower=-4000.0, upper=4000.0