Add a ComponentCategory parameter to the PowerDistributingActor

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]("battery-status")
     power_result_channel = Broadcast[Result]("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

@@ -17,7 +17,8 @@
 from frequenz.channels import Receiver, Sender
 
 from ...actor._actor import Actor
-from ._component_managers import BatteryManager, ComponentManager
+from ...microgrid.component import ComponentCategory
+from ._component_managers import BatteryManager, ComponentManager, EVChargerManager
 from ._component_status import ComponentPoolStatus
 from .request import Request
 from .result import Result
@@ -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,25 @@ 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)
+        elif component_category == ComponentCategory.EV_CHARGER:
+            self._component_manager = EVChargerManager(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

@@ -18,6 +18,7 @@
 from frequenz.channels import Broadcast, Sender
 
 from ..actor._actor import Actor
+from ..microgrid.component import ComponentCategory
 from ..timeseries._grid_frequency import GridFrequency
 from ..timeseries._voltage_streamer import VoltageStreamer
 from ..timeseries.grid import Grid
@@ -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(
@@ -123,6 +128,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

@@ -183,6 +183,7 @@ async def test_constructor_with_grid_meter(self, mocker: MockerFixture) -> None:
             results_channel = Broadcast[Result]("power_distributor results")
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -210,6 +211,7 @@ async def test_constructor_without_grid_meter(self, mocker: MockerFixture) -> No
             results_channel = Broadcast[Result]("power_distributor results")
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -273,6 +275,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
 
         battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -330,6 +333,7 @@ async def test_power_distributor_exclusion_bounds(
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -429,6 +433,7 @@ async def test_two_batteries_one_inverters(self, mocker: MockerFixture) -> None:
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -505,6 +510,7 @@ async def test_two_batteries_one_broken_one_inverters(
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -557,6 +563,7 @@ async def test_battery_two_inverters(self, mocker: MockerFixture) -> None:
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -605,6 +612,7 @@ async def test_two_batteries_three_inverters(self, mocker: MockerFixture) -> Non
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -687,6 +695,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds_2(
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -770,6 +779,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds(
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -832,6 +842,7 @@ async def test_connected_but_not_requested_batteries(
             battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
             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(),
@@ -886,6 +897,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
             await self._patch_battery_pool_status(mocks, mocker, request.component_ids)
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -937,6 +949,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1007,6 +1020,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1049,6 +1063,7 @@ async def test_power_distributor_invalid_battery_id(
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1090,6 +1105,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1133,6 +1149,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1176,6 +1193,7 @@ async def test_power_distributor_one_user_adjust_power_success(
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1212,6 +1230,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),
@@ -1262,6 +1281,7 @@ async def test_partial_failure_result(self, mocker: MockerFixture) -> None:
 
             battery_status_channel = Broadcast[ComponentPoolStatus]("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(),