WIP

Author: llucax

benchmarks/power_distribution/power_distributor.py

@@ -12,7 +12,8 @@
 from typing import Any
 
 from frequenz.channels import Broadcast
-from frequenz.client.microgrid import Component, ComponentCategory
+from frequenz.client.microgrid import ComponentId
+from frequenz.client.microgrid.component import Battery
 from frequenz.quantities import Power
 
 from frequenz.sdk import microgrid
@@ -37,7 +38,7 @@
 # send requests, and those no longer go directly to the power distributing actor, but
 # instead through the power managing actor.  So the below function needs to be updated
 # to use the PowerDistributingActor directly.
-async def send_requests(batteries: set[int], request_num: int) -> list[Result]:
+async def send_requests(batteries: set[ComponentId], request_num: int) -> list[Result]:
     """Send requests to the PowerDistributingActor and wait for the response.
 
     Args:
@@ -98,7 +99,7 @@ def parse_result(result: list[list[Result]]) -> dict[str, float]:
 
 async def run_test(  # pylint: disable=too-many-locals
     num_requests: int,
-    batteries: set[int],
+    batteries: set[ComponentId],
 ) -> dict[str, Any]:
     """Run test.
 
@@ -115,8 +116,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,
-        component_type=None,
+        component_type=Battery,
         requests_receiver=power_request_channel.new_receiver(),
         results_sender=power_result_channel.new_sender(),
         component_pool_status_sender=battery_status_channel.new_sender(),
@@ -142,10 +142,10 @@ async def run() -> None:
         ResamplerConfig(resampling_period=timedelta(seconds=1.0)),
     )
 
-    all_batteries: set[Component] = connection_manager.get().component_graph.components(
-        component_categories={ComponentCategory.BATTERY}
+    all_batteries = connection_manager.get().component_graph.components(
+        filter_by_types={Battery},
     )
-    batteries_ids = {c.component_id for c in all_batteries}
+    batteries_ids = {c.id for c in all_batteries}
     # Take some time to get data from components
     await asyncio.sleep(4)
     with open("/dev/stdout", "w", encoding="utf-8") as csvfile:

benchmarks/timeseries/benchmark_datasourcing.py

@@ -17,7 +17,7 @@
 from typing import Any
 
 from frequenz.channels import Broadcast, Receiver, ReceiverStoppedError
-from frequenz.client.microgrid import ComponentMetricId
+from frequenz.client.microgrid.metrics import Metric
 
 from frequenz.sdk import microgrid
 from frequenz.sdk._internal._channels import ChannelRegistry
@@ -37,9 +37,9 @@
     sys.exit(1)
 
 COMPONENT_METRIC_IDS = [
-    ComponentMetricId.CURRENT_PHASE_1,
-    ComponentMetricId.CURRENT_PHASE_2,
-    ComponentMetricId.CURRENT_PHASE_3,
+    Metric.AC_CURRENT_PHASE_1,
+    Metric.AC_CURRENT_PHASE_2,
+    Metric.AC_CURRENT_PHASE_3,
 ]
 
 

examples/battery_pool.py

@@ -13,7 +13,7 @@
 from frequenz.sdk import microgrid
 from frequenz.sdk.actor import ResamplerConfig
 
-MICROGRID_API_URL = "grpc://microgrid.sandbox.api.frequenz.io:62060"
+MICROGRID_API_URL = "grpc://microgrid.sandbox.api.frequenz.io:61060"
 
 
 async def main() -> None:

pyproject.toml

@@ -29,7 +29,8 @@ dependencies = [
   # Make sure to update the mkdocs.yml file when
   # changing the version
   # (plugins.mkdocstrings.handlers.python.import)
-  "frequenz-client-microgrid >= 0.6.0, < 0.7.0",
+  #"frequenz-client-microgrid >= 0.6.0, < 0.7.0",
+  "frequenz-client-microgrid @ git+https://github.com/frequenz-floss/frequenz-client-microgrid-python@refs/pull/94/head",
   "frequenz-channels >= 1.6.0, < 2.0.0",
   "frequenz-quantities[marshmallow] >= 1.0.0, < 2.0.0",
   "networkx >= 2.8, < 4",

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -17,7 +17,8 @@
 from datetime import timedelta
 
 from frequenz.channels import Broadcast, Sender
-from frequenz.client.microgrid import ComponentCategory, InverterType
+from frequenz.client.microgrid import ComponentId
+from frequenz.client.microgrid.component import Battery, EvCharger, SolarInverter
 
 from .._internal._channels import ChannelRegistry
 from ..actor._actor import Actor
@@ -103,31 +104,32 @@ def __init__(
         self._battery_power_wrapper = PowerWrapper(
             self._channel_registry,
             api_power_request_timeout=api_power_request_timeout,
-            component_category=ComponentCategory.BATTERY,
+            component_class=Battery,
         )
         self._ev_power_wrapper = PowerWrapper(
             self._channel_registry,
             api_power_request_timeout=api_power_request_timeout,
-            component_category=ComponentCategory.EV_CHARGER,
+            component_class=EvCharger,
         )
         self._pv_power_wrapper = PowerWrapper(
             self._channel_registry,
             api_power_request_timeout=api_power_request_timeout,
-            component_category=ComponentCategory.INVERTER,
-            component_type=InverterType.SOLAR,
+            component_class=SolarInverter,
         )
 
         self._logical_meter: LogicalMeter | None = None
         self._consumer: Consumer | None = None
         self._producer: Producer | None = None
         self._grid: Grid | None = None
         self._ev_charger_pool_reference_stores: dict[
-            frozenset[int], EVChargerPoolReferenceStore
+            frozenset[ComponentId], EVChargerPoolReferenceStore
         ] = {}
         self._battery_pool_reference_stores: dict[
-            frozenset[int], BatteryPoolReferenceStore
+            frozenset[ComponentId], BatteryPoolReferenceStore
+        ] = {}
+        self._pv_pool_reference_stores: dict[
+            frozenset[ComponentId], PVPoolReferenceStore
         ] = {}
-        self._pv_pool_reference_stores: dict[frozenset[int], PVPoolReferenceStore] = {}
         self._frequency_instance: GridFrequency | None = None
         self._voltage_instance: VoltageStreamer | None = None
 
@@ -208,7 +210,7 @@ def new_ev_charger_pool(
         self,
         *,
         priority: int,
-        component_ids: abc.Set[int] | None = None,
+        component_ids: abc.Set[ComponentId] | None = None,
         name: str | None = None,
         set_operating_point: bool = False,
     ) -> EVChargerPool:
@@ -238,7 +240,7 @@ def new_ev_charger_pool(
             self._ev_power_wrapper.start()
 
         # We use frozenset to make a hashable key from the input set.
-        ref_store_key: frozenset[int] = frozenset()
+        ref_store_key: frozenset[ComponentId] = frozenset()
         if component_ids is not None:
             ref_store_key = frozenset(component_ids)
 
@@ -288,7 +290,7 @@ def new_pv_pool(
         self,
         *,
         priority: int,
-        component_ids: abc.Set[int] | None = None,
+        component_ids: abc.Set[ComponentId] | None = None,
         name: str | None = None,
         set_operating_point: bool = False,
     ) -> PVPool:
@@ -316,7 +318,7 @@ def new_pv_pool(
             self._pv_power_wrapper.start()
 
         # We use frozenset to make a hashable key from the input set.
-        ref_store_key: frozenset[int] = frozenset()
+        ref_store_key: frozenset[ComponentId] = frozenset()
         if component_ids is not None:
             ref_store_key = frozenset(component_ids)
 
@@ -365,7 +367,7 @@ def new_battery_pool(
         self,
         *,
         priority: int,
-        component_ids: abc.Set[int] | None = None,
+        component_ids: abc.Set[ComponentId] | None = None,
         name: str | None = None,
         set_operating_point: bool = False,
     ) -> BatteryPool:
@@ -395,7 +397,7 @@ def new_battery_pool(
             self._battery_power_wrapper.start()
 
         # We use frozenset to make a hashable key from the input set.
-        ref_store_key: frozenset[int] = frozenset()
+        ref_store_key: frozenset[ComponentId] = frozenset()
         if component_ids is not None:
             ref_store_key = frozenset(component_ids)
 
@@ -555,7 +557,7 @@ def producer() -> Producer:
 def new_ev_charger_pool(
     *,
     priority: int,
-    component_ids: abc.Set[int] | None = None,
+    component_ids: abc.Set[ComponentId] | None = None,
     name: str | None = None,
     set_operating_point: bool = False,
 ) -> EVChargerPool:
@@ -600,7 +602,7 @@ def new_ev_charger_pool(
 def new_battery_pool(
     *,
     priority: int,
-    component_ids: abc.Set[int] | None = None,
+    component_ids: abc.Set[ComponentId] | None = None,
     name: str | None = None,
     set_operating_point: bool = False,
 ) -> BatteryPool:
@@ -645,7 +647,7 @@ def new_battery_pool(
 def new_pv_pool(
     *,
     priority: int,
-    component_ids: abc.Set[int] | None = None,
+    component_ids: abc.Set[ComponentId] | None = None,
     name: str | None = None,
     set_operating_point: bool = False,
 ) -> PVPool:

src/frequenz/sdk/microgrid/_data_sourcing/__init__.py

@@ -3,11 +3,13 @@
 
 """The DataSourcingActor."""
 
-from ._component_metric_request import ComponentMetricId, ComponentMetricRequest
+from frequenz.client.microgrid.metrics import Metric
+
+from ._component_metric_request import ComponentMetricRequest
 from .data_sourcing import DataSourcingActor
 
 __all__ = [
-    "ComponentMetricId",
+    "Metric",
     "ComponentMetricRequest",
     "DataSourcingActor",
 ]

src/frequenz/sdk/microgrid/_data_sourcing/_component_metric_request.py

@@ -6,9 +6,12 @@
 from dataclasses import dataclass
 from datetime import datetime
 
-from frequenz.client.microgrid import ComponentMetricId
+from frequenz.client.microgrid import ComponentId
+from frequenz.client.microgrid.metrics import Metric
 
-__all__ = ["ComponentMetricRequest", "ComponentMetricId"]
+from frequenz.sdk.microgrid._old_component_data import TransitionalMetric
+
+__all__ = ["ComponentMetricRequest", "Metric"]
 
 
 @dataclass
@@ -24,7 +27,7 @@ class ComponentMetricRequest:
     metric. For example, requesters can use different `namespace` values to subscribe to
     raw or resampled data streams separately. This ensures that each requester receives
     the appropriate type of data without interference. Requests with the same
-    `namespace`, `component_id`, and `metric_id` will use the same channel, preventing
+    `namespace`, `component_id`, and `metric` will use the same channel, preventing
     unnecessary duplication of data streams.
 
     The requester and provider must use the same channel name so that they can
@@ -36,10 +39,10 @@ class ComponentMetricRequest:
     namespace: str
     """A client-defined identifier influencing the channel name."""
 
-    component_id: int
+    component_id: ComponentId
     """The ID of the requested component."""
 
-    metric_id: ComponentMetricId
+    metric: Metric | TransitionalMetric
     """The ID of the requested component's metric."""
 
     start_time: datetime | None
@@ -59,7 +62,7 @@ def get_channel_name(self) -> str:
             "component_metric_request<"
             f"namespace={self.namespace},"
             f"component_id={self.component_id},"
-            f"metric_id={self.metric_id.name}"
+            f"metric={self.metric.name}"
             f"{start}"
             ">"
         )