Add a ComponentCategory parameter to the PowerDistributingActor

Currently only `ComponentCategory.BATTERY` is accepted, but making it
a parameter this paves the way for adding support for more component
categories.

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

Author: shsms

benchmarks/power_distribution/power_distributor.py

@@ -115,6 +115,7 @@ async def run_test(  # pylint: disable=too-many-locals
     battery_status_channel = Broadcast[ComponentPoolStatus](name="battery-status")
     power_result_channel = Broadcast[Result](name="power-result")
     async with PowerDistributingActor(
+        component_category=ComponentCategory.BATTERY,
         requests_receiver=power_request_channel.new_receiver(),
         results_sender=power_result_channel.new_sender(),
         component_pool_status_sender=battery_status_channel.new_sender(),

src/frequenz/sdk/actor/power_distributing/power_distributing.py

@@ -15,6 +15,7 @@
 import asyncio
 
 from frequenz.channels import Receiver, Sender
+from frequenz.client.microgrid import ComponentCategory
 
 from ...actor._actor import Actor
 from ._component_managers import BatteryManager, ComponentManager
@@ -51,6 +52,7 @@ class PowerDistributingActor(Actor):
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
+        component_category: ComponentCategory,
         requests_receiver: Receiver[Request],
         results_sender: Sender[Result],
         component_pool_status_sender: Sender[ComponentPoolStatus],
@@ -61,6 +63,8 @@ def __init__(  # pylint: disable=too-many-arguments
         """Create class instance.
 
         Args:
+            component_category: The category of the components that this actor is
+                responsible for.
             requests_receiver: Receiver for receiving power requests from the power
                 manager.
             results_sender: Sender for sending results to the power manager.
@@ -70,15 +74,23 @@ def __init__(  # pylint: disable=too-many-arguments
                 request. It is a time needed to collect first components data.
             name: The name of the actor. If `None`, `str(id(self))` will be used. This
                 is used mostly for debugging purposes.
+
+        Raises:
+            ValueError: If the given component category is not supported.
         """
         super().__init__(name=name)
+        self._component_category = component_category
         self._requests_receiver = requests_receiver
         self._result_sender = results_sender
         self._wait_for_data_sec = wait_for_data_sec
 
-        self._component_manager: ComponentManager = BatteryManager(
-            component_pool_status_sender
-        )
+        self._component_manager: ComponentManager
+        if component_category == ComponentCategory.BATTERY:
+            self._component_manager = BatteryManager(component_pool_status_sender)
+        else:
+            raise ValueError(
+                f"PowerDistributor doesn't support controlling: {component_category}"
+            )
 
     async def _run(self) -> None:  # pylint: disable=too-many-locals
         """Run actor main function.

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -16,6 +16,7 @@
 from dataclasses import dataclass
 
 from frequenz.channels import Broadcast, Sender
+from frequenz.client.microgrid import ComponentCategory
 
 from ..actor._actor import Actor
 from ..timeseries._grid_frequency import GridFrequency
@@ -88,7 +89,9 @@ def __init__(
         self._data_sourcing_actor: _ActorInfo | None = None
         self._resampling_actor: _ActorInfo | None = None
 
-        self._battery_power_wrapper = PowerWrapper(self._channel_registry)
+        self._battery_power_wrapper = PowerWrapper(
+            ComponentCategory.BATTERY, self._channel_registry
+        )
 
         self._logical_meter: LogicalMeter | None = None
         self._consumer: Consumer | None = None

src/frequenz/sdk/microgrid/_power_wrapper.py

@@ -34,12 +34,17 @@
 class PowerWrapper:
     """Wrapper around the power managing and power distributing actors."""
 
-    def __init__(self, channel_registry: ChannelRegistry):
+    def __init__(
+        self, component_category: ComponentCategory, channel_registry: ChannelRegistry
+    ):
         """Initialize the power control.
 
         Args:
+            component_category: The category of the components that actors started by
+                this instance of the PowerWrapper will be responsible for.
             channel_registry: A channel registry for use in the actors.
         """
+        self._component_category = component_category
         self._channel_registry = channel_registry
 
         self.status_channel: Broadcast[ComponentPoolStatus] = Broadcast(
@@ -74,18 +79,19 @@ def _start_power_managing_actor(self) -> None:
         # constraint needs to be relaxed if the actor is extended to support other
         # components.
         if not component_graph.components(
-            component_categories={ComponentCategory.BATTERY}
+            component_categories={self._component_category}
         ):
             _logger.warning(
-                "No batteries found in the component graph. "
-                "The power managing actor will not be started."
+                "No %s found in the component graph. "
+                "The power managing actor will not be started.",
+                self._component_category,
             )
             return
 
         from ..actor._power_managing._power_managing_actor import PowerManagingActor
 
         self._power_managing_actor = PowerManagingActor(
-            component_category=ComponentCategory.BATTERY,
+            component_category=self._component_category,
             proposals_receiver=self.proposal_channel.new_receiver(),
             bounds_subscription_receiver=(
                 self.bounds_subscription_channel.new_receiver()
@@ -109,11 +115,12 @@ def _start_power_distributing_actor(self) -> None:
 
         component_graph = microgrid.connection_manager.get().component_graph
         if not component_graph.components(
-            component_categories={ComponentCategory.BATTERY}
+            component_categories={self._component_category}
         ):
             _logger.warning(
-                "No batteries found in the component graph. "
-                "The power distributing actor will not be started."
+                "No %s found in the component graph. "
+                "The power distributing actor will not be started.",
+                self._component_category,
             )
             return
 
@@ -123,6 +130,7 @@ def _start_power_distributing_actor(self) -> None:
         # Until the PowerManager is implemented, support for multiple use-case actors
         # will not be available in the high level interface.
         self._power_distributing_actor = PowerDistributingActor(
+            component_category=self._component_category,
             requests_receiver=self._power_distribution_requests_channel.new_receiver(),
             results_sender=self._power_distribution_results_channel.new_sender(),
             component_pool_status_sender=self.status_channel.new_sender(),

tests/actor/power_distributing/test_power_distributing.py

@@ -107,6 +107,7 @@ async def test_constructor_with_grid_meter(self, mocker: MockerFixture) -> None:
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -136,6 +137,7 @@ async def test_constructor_without_grid_meter(self, mocker: MockerFixture) -> No
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -199,6 +201,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
 
         battery_status_channel = Broadcast[ComponentPoolStatus](name="battery_status")
         async with PowerDistributingActor(
+            component_category=ComponentCategory.BATTERY,
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
             component_pool_status_sender=battery_status_channel.new_sender(),
@@ -258,6 +261,7 @@ async def test_power_distributor_exclusion_bounds(
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -359,6 +363,7 @@ async def test_two_batteries_one_inverters(self, mocker: MockerFixture) -> None:
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -437,6 +442,7 @@ async def test_two_batteries_one_broken_one_inverters(
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -491,6 +497,7 @@ async def test_battery_two_inverters(self, mocker: MockerFixture) -> None:
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -541,6 +548,7 @@ async def test_two_batteries_three_inverters(self, mocker: MockerFixture) -> Non
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -625,6 +633,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds_2(
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -710,6 +719,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds(
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -774,6 +784,7 @@ async def test_connected_but_not_requested_batteries(
             )
 
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -830,6 +841,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -883,6 +895,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -955,6 +968,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -999,6 +1013,7 @@ async def test_power_distributor_invalid_battery_id(
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1042,6 +1057,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1087,6 +1103,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1132,6 +1149,7 @@ async def test_power_distributor_one_user_adjust_power_success(
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1170,6 +1188,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1222,6 +1241,7 @@ async def test_partial_failure_result(self, mocker: MockerFixture) -> None:
                 name="battery_status"
             )
             async with PowerDistributingActor(
+                component_category=ComponentCategory.BATTERY,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),