Add metadata to Components

This commit introduces metadata to Components by incorporating
GridMetadata, which now includes the maximum grid current,
specified in Amperes.

Signed-off-by: Tiyash Basu <[email protected]>

Author: tiyash-basu-frequenz

src/frequenz/sdk/microgrid/client/_client.py

@@ -36,6 +36,7 @@
 )
 from ..component._component import (
     _component_category_from_protobuf,
+    _component_metadata_from_protobuf,
     _component_type_from_protobuf,
 )
 from ._connection import Connection
@@ -254,6 +255,7 @@ async def components(self) -> Iterable[Component]:
                 c.id,
                 _component_category_from_protobuf(c.category),
                 _component_type_from_protobuf(c.category, c.inverter),
+                _component_metadata_from_protobuf(c.category, c.grid),
             ),
             components_only,
         )

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

@@ -6,7 +6,14 @@
 This package provides classes to operate con microgrid components.
 """
 
-from ._component import Component, ComponentCategory, ComponentMetricId, InverterType
+from ._component import (
+    Component,
+    ComponentCategory,
+    ComponentMetadata,
+    ComponentMetricId,
+    GridMetadata,
+    InverterType,
+)
 from ._component_data import (
     BatteryData,
     ComponentData,
@@ -21,10 +28,12 @@
     "Component",
     "ComponentData",
     "ComponentCategory",
+    "ComponentMetadata",
     "ComponentMetricId",
     "EVChargerCableState",
     "EVChargerComponentState",
     "EVChargerData",
+    "GridMetadata",
     "InverterData",
     "InverterType",
     "MeterData",

src/frequenz/sdk/microgrid/component/_component.py

@@ -9,6 +9,7 @@
 from enum import Enum
 
 import frequenz.api.common.components_pb2 as components_pb
+import frequenz.api.microgrid.grid_pb2 as grid_pb
 import frequenz.api.microgrid.inverter_pb2 as inverter_pb
 
 
@@ -105,13 +106,37 @@ def _component_category_from_protobuf(
     return ComponentCategory(component_category)
 
 
+@dataclass(frozen=True)
+class ComponentMetadata:
+    """Base class for component metadata classes."""
+
+
+@dataclass(frozen=True)
+class GridMetadata(ComponentMetadata):
+    """Metadata for a grid connection point."""
+
+    max_current: float
+    """maximum current rating of the grid connection point in amps."""
+
+
+def _component_metadata_from_protobuf(
+    component_category: components_pb.ComponentCategory.ValueType,
+    component_metadata: grid_pb.Metadata,
+) -> GridMetadata | None:
+    if component_category == components_pb.ComponentCategory.COMPONENT_CATEGORY_GRID:
+        return GridMetadata(float(component_metadata.rated_fuse_current))
+
+    return None
+
+
 @dataclass(frozen=True)
 class Component:
     """Metadata for a single microgrid component."""
 
     component_id: int
     category: ComponentCategory
     type: ComponentType | None = None
+    metadata: ComponentMetadata | None = None
 
     def is_valid(self) -> bool:
         """Check if this instance contains valid data.

tests/microgrid/test_client.py

@@ -21,6 +21,7 @@
     Component,
     ComponentCategory,
     EVChargerData,
+    GridMetadata,
     InverterData,
     InverterType,
     MeterData,
@@ -117,9 +118,15 @@ async def test_components(self) -> None:
                     (999, components_pb.ComponentCategory.COMPONENT_CATEGORY_SENSOR),
                 ]
             )
+
             assert set(await microgrid.components()) == {
                 Component(100, ComponentCategory.NONE),
-                Component(101, ComponentCategory.GRID),
+                Component(
+                    101,
+                    ComponentCategory.GRID,
+                    None,
+                    GridMetadata(max_current=0.0),
+                ),
                 Component(104, ComponentCategory.METER),
                 Component(105, ComponentCategory.INVERTER, InverterType.NONE),
                 Component(106, ComponentCategory.BATTERY),

tests/microgrid/test_graph.py

@@ -18,7 +18,12 @@
 
 import frequenz.sdk.microgrid._graph as gr
 from frequenz.sdk.microgrid.client import Connection, MicrogridGrpcClient
-from frequenz.sdk.microgrid.component import Component, ComponentCategory, InverterType
+from frequenz.sdk.microgrid.component import (
+    Component,
+    ComponentCategory,
+    GridMetadata,
+    InverterType,
+)
 
 from .mock_api import MockGrpcServer, MockMicrogridServicer
 
@@ -816,8 +821,16 @@ async def test_refresh_from_api(self) -> None:
         servicer.set_connections([(101, 111), (111, 131)])
         await graph.refresh_from_api(client)
 
+        # Note: we need to add GriMetadata as a dict here, because that's what
+        # the ComponentGraph does too, and we need to be able to compare the
+        # two graphs.
         expected = {
-            Component(101, ComponentCategory.GRID),
+            Component(
+                101,
+                ComponentCategory.GRID,
+                None,
+                asdict(GridMetadata(max_current=0.0)),  # type: ignore
+            ),
             Component(111, ComponentCategory.METER),
             Component(131, ComponentCategory.EV_CHARGER),
         }
@@ -843,7 +856,12 @@ async def test_refresh_from_api(self) -> None:
         servicer.set_connections([(707, 717), (717, 727), (727, 737), (717, 747)])
         await graph.refresh_from_api(client)
         expected = {
-            Component(707, ComponentCategory.GRID),
+            Component(
+                707,
+                ComponentCategory.GRID,
+                None,
+                asdict(GridMetadata(max_current=0.0)),  # type: ignore
+            ),
             Component(717, ComponentCategory.METER),
             Component(727, ComponentCategory.INVERTER, InverterType.NONE),
             Component(737, ComponentCategory.BATTERY),
@@ -1146,7 +1164,7 @@ def test__validate_grid_endpoint(self) -> None:
             gr.InvalidGraphError,
             match=r"Grid endpoint 1 has graph predecessors: \[Component"
             r"\(component_id=99, category=<ComponentCategory.METER: 2>, "
-            r"type=None\)\]",
+            r"type=None, metadata=None\)\]",
         ) as _err_predecessors:
             graph._validate_grid_endpoint()