Pass ComponentType as arguments to PowerManager and PowerDistributor

This is necessary to identify if an inverter is a PV inverter or not.

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

Author: shsms

benchmarks/power_distribution/power_distributor.py

@@ -116,6 +116,7 @@ async def run_test(  # pylint: disable=too-many-locals
     power_result_channel = Broadcast[Result](name="power-result")
     async with PowerDistributingActor(
         component_category=ComponentCategory.BATTERY,
+        component_type=None,
         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_managing/_power_managing_actor.py

@@ -12,7 +12,7 @@
 
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
-from frequenz.client.microgrid import ComponentCategory
+from frequenz.client.microgrid import ComponentCategory, ComponentType
 from typing_extensions import override
 
 from ...timeseries._base_types import SystemBounds
@@ -33,6 +33,7 @@ class PowerManagingActor(Actor):
     def __init__(  # pylint: disable=too-many-arguments
         self,
         component_category: ComponentCategory,
+        component_type: ComponentType | None,
         proposals_receiver: Receiver[Proposal],
         bounds_subscription_receiver: Receiver[ReportRequest],
         power_distributing_requests_sender: Sender[power_distributing.Request],
@@ -47,6 +48,8 @@ def __init__(  # pylint: disable=too-many-arguments
         Args:
             component_category: The category of the component this power manager
                 instance is going to support.
+            component_type: The type of the component of the given category that this
+                actor is responsible for.
             proposals_receiver: The receiver for proposals.
             bounds_subscription_receiver: The receiver for bounds subscriptions.
             power_distributing_requests_sender: The sender for power distribution
@@ -65,6 +68,7 @@ def __init__(  # pylint: disable=too-many-arguments
             )
 
         self._component_category = component_category
+        self._component_type = component_type
         self._bounds_subscription_receiver = bounds_subscription_receiver
         self._power_distributing_requests_sender = power_distributing_requests_sender
         self._power_distributing_results_receiver = power_distributing_results_receiver

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

@@ -15,7 +15,7 @@
 import asyncio
 
 from frequenz.channels import Receiver, Sender
-from frequenz.client.microgrid import ComponentCategory
+from frequenz.client.microgrid import ComponentCategory, ComponentType
 
 from ...actor._actor import Actor
 from ._component_managers import BatteryManager, ComponentManager, EVChargerManager
@@ -53,6 +53,7 @@ class PowerDistributingActor(Actor):
     def __init__(  # pylint: disable=too-many-arguments
         self,
         component_category: ComponentCategory,
+        component_type: ComponentType | None,
         requests_receiver: Receiver[Request],
         results_sender: Sender[Result],
         component_pool_status_sender: Sender[ComponentPoolStatus],
@@ -65,6 +66,8 @@ def __init__(  # pylint: disable=too-many-arguments
         Args:
             component_category: The category of the components that this actor is
                 responsible for.
+            component_type: The type of the component of the given category 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.
@@ -80,6 +83,7 @@ def __init__(  # pylint: disable=too-many-arguments
         """
         super().__init__(name=name)
         self._component_category = component_category
+        self._component_type = component_type
         self._requests_receiver = requests_receiver
         self._result_sender = results_sender
         self._wait_for_data_sec = wait_for_data_sec

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -96,10 +96,10 @@ def __init__(
         self._resampling_actor: _ActorInfo | None = None
 
         self._battery_power_wrapper = PowerWrapper(
-            ComponentCategory.BATTERY, self._channel_registry
+            ComponentCategory.BATTERY, None, self._channel_registry
         )
         self._ev_power_wrapper = PowerWrapper(
-            ComponentCategory.EV_CHARGER, self._channel_registry
+            ComponentCategory.EV_CHARGER, None, self._channel_registry
         )
 
         self._logical_meter: LogicalMeter | None = None

src/frequenz/sdk/microgrid/_power_wrapper.py

@@ -13,7 +13,7 @@
 # pylint seems to think this is a cyclic import, but it is not.
 #
 # pylint: disable=cyclic-import
-from frequenz.client.microgrid import ComponentCategory
+from frequenz.client.microgrid import ComponentCategory, ComponentType
 
 # A number of imports had to be done inside functions where they are used, to break
 # import cycles.
@@ -37,16 +37,22 @@ class PowerWrapper:
     """Wrapper around the power managing and power distributing actors."""
 
     def __init__(
-        self, component_category: ComponentCategory, channel_registry: ChannelRegistry
+        self,
+        component_category: ComponentCategory,
+        component_type: ComponentType | None,
+        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.
+            component_type: The type of the component of the given category that this
+                actor is responsible for.
             channel_registry: A channel registry for use in the actors.
         """
         self._component_category = component_category
+        self._component_type = component_type
         self._channel_registry = channel_registry
 
         self.status_channel: Broadcast[ComponentPoolStatus] = Broadcast(
@@ -95,6 +101,7 @@ def _start_power_managing_actor(self) -> None:
 
         self._power_managing_actor = PowerManagingActor(
             component_category=self._component_category,
+            component_type=self._component_type,
             proposals_receiver=self.proposal_channel.new_receiver(),
             bounds_subscription_receiver=(
                 self.bounds_subscription_channel.new_receiver()
@@ -134,6 +141,7 @@ def _start_power_distributing_actor(self) -> None:
         # will not be available in the high level interface.
         self._power_distributing_actor = PowerDistributingActor(
             component_category=self._component_category,
+            component_type=self._component_type,
             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

@@ -108,6 +108,7 @@ async def test_constructor_with_grid_meter(self, mocker: MockerFixture) -> None:
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -139,6 +140,7 @@ async def test_constructor_without_grid_meter(self, mocker: MockerFixture) -> No
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -204,6 +206,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,
+            component_type=None,
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
             component_pool_status_sender=battery_status_channel.new_sender(),
@@ -264,6 +267,7 @@ async def test_power_distributor_exclusion_bounds(
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -366,6 +370,7 @@ async def test_two_batteries_one_inverters(self, mocker: MockerFixture) -> None:
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -445,6 +450,7 @@ async def test_two_batteries_one_broken_one_inverters(
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -500,6 +506,7 @@ async def test_battery_two_inverters(self, mocker: MockerFixture) -> None:
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -551,6 +558,7 @@ async def test_two_batteries_three_inverters(self, mocker: MockerFixture) -> Non
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -636,6 +644,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds_2(
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -722,6 +731,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds(
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -787,6 +797,7 @@ async def test_connected_but_not_requested_batteries(
 
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
                 results_sender=results_channel.new_sender(),
@@ -844,6 +855,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -898,6 +910,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -971,6 +984,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1016,6 +1030,7 @@ async def test_power_distributor_invalid_battery_id(
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1060,6 +1075,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1106,6 +1122,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1152,6 +1169,7 @@ async def test_power_distributor_one_user_adjust_power_success(
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1191,6 +1209,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),
@@ -1244,6 +1263,7 @@ async def test_partial_failure_result(self, mocker: MockerFixture) -> None:
             )
             async with PowerDistributingActor(
                 component_category=ComponentCategory.BATTERY,
+                component_type=None,
                 requests_receiver=requests_channel.new_receiver(),
                 results_sender=results_channel.new_sender(),
                 component_pool_status_sender=battery_status_channel.new_sender(),