Make inverter type available through the component graph

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

Author: shsms

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

@@ -23,7 +23,10 @@
     InverterData,
     MeterData,
 )
-from ..component._component import _component_category_from_protobuf
+from ..component._component import (
+    _component_category_from_protobuf,
+    _component_type_from_protobuf,
+)
 from ._connection import Connection
 from ._retry import LinearBackoff, RetryStrategy
 
@@ -229,7 +232,11 @@ async def components(self) -> Iterable[Component]:
             component_list.components,
         )
         result: Iterable[Component] = map(
-            lambda c: Component(c.id, _component_category_from_protobuf(c.category)),
+            lambda c: Component(
+                c.id,
+                _component_category_from_protobuf(c.category),
+                _component_type_from_protobuf(c.category, c.inverter),
+            ),
             components_only,
         )
 

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

@@ -6,7 +6,7 @@
 This package provides classes to operate con microgrid components.
 """
 
-from ._component import Component, ComponentCategory, ComponentMetricId
+from ._component import Component, ComponentCategory, ComponentMetricId, InverterType
 from ._component_data import (
     BatteryData,
     ComponentData,
@@ -25,5 +25,6 @@
     "EVChargerCableState",
     "EVChargerData",
     "InverterData",
+    "InverterType",
     "MeterData",
 ]

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

@@ -7,10 +7,52 @@
 
 from dataclasses import dataclass
 from enum import Enum
+from typing import Optional
 
+import frequenz.api.microgrid.inverter_pb2 as inverter_pb
 import frequenz.api.microgrid.microgrid_pb2 as microgrid_pb
 
 
+class ComponentType(Enum):
+    """A base class from which individual component types are derived."""
+
+
+class InverterType(ComponentType):
+    """Enum representing inverter types."""
+
+    NONE = inverter_pb.Type.TYPE_UNSPECIFIED
+    BATTERY = inverter_pb.Type.TYPE_BATTERY
+    SOLAR = inverter_pb.Type.TYPE_SOLAR
+    HYBRID = inverter_pb.Type.TYPE_HYBRID
+
+
+def _component_type_from_protobuf(
+    component_category: microgrid_pb.ComponentCategory.ValueType,
+    component_type: inverter_pb.Type.ValueType,
+) -> Optional[ComponentType]:
+    """Convert a protobuf InverterType message to Component enum.
+
+    For internal-only use by the `microgrid` package.
+
+    Args:
+        component_category: category the type belongs to.
+        component_type: protobuf enum to convert.
+
+    Returns:
+        Enum value corresponding to the protobuf message.
+    """
+    # ComponentType values in the protobuf definition are not unique across categories
+    # as of v0.11.0, so we need to check the component category first, before doing any
+    # component type checks.
+    if component_category == microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_INVERTER:
+        if not any(t.value == component_type for t in InverterType):
+            return None
+
+        return InverterType(component_type)
+
+    return None
+
+
 class ComponentCategory(Enum):
     """Possible types of microgrid component."""
 
@@ -62,6 +104,7 @@ class Component:
 
     component_id: int
     category: ComponentCategory
+    type: Optional[ComponentType] = None
 
     def is_valid(self) -> bool:
         """Check if this instance contains valid data.

tests/microgrid/test_client.py

@@ -21,6 +21,7 @@
     ComponentCategory,
     EVChargerData,
     InverterData,
+    InverterType,
     MeterData,
 )
 
@@ -97,7 +98,7 @@ async def test_components(self) -> None:
             )
             assert set(await microgrid.components()) == {
                 Component(9, ComponentCategory.METER),
-                Component(99, ComponentCategory.INVERTER),
+                Component(99, ComponentCategory.INVERTER, InverterType.NONE),
                 Component(999, ComponentCategory.BATTERY),
             }
 
@@ -123,7 +124,7 @@ async def test_components(self) -> None:
                 Component(101, ComponentCategory.GRID),
                 Component(103, ComponentCategory.JUNCTION),
                 Component(104, ComponentCategory.METER),
-                Component(105, ComponentCategory.INVERTER),
+                Component(105, ComponentCategory.INVERTER, InverterType.NONE),
                 Component(106, ComponentCategory.BATTERY),
                 Component(107, ComponentCategory.EV_CHARGER),
             }

tests/microgrid/test_graph.py

@@ -18,7 +18,7 @@
 
 import frequenz.sdk.microgrid._graph as gr
 from frequenz.sdk.microgrid.client import Connection, MicrogridGrpcClient
-from frequenz.sdk.microgrid.component import Component, ComponentCategory
+from frequenz.sdk.microgrid.component import Component, ComponentCategory, InverterType
 
 from .mock_api import MockGrpcServer, MockMicrogridServicer
 
@@ -751,7 +751,7 @@ async def test_refresh_from_api(self) -> None:
         expected = {
             Component(707, ComponentCategory.GRID),
             Component(717, ComponentCategory.METER),
-            Component(727, ComponentCategory.INVERTER),
+            Component(727, ComponentCategory.INVERTER, InverterType.NONE),
             Component(737, ComponentCategory.BATTERY),
             Component(747, ComponentCategory.METER),
         }
@@ -1068,7 +1068,8 @@ def test__validate_grid_endpoint(self) -> None:
         with pytest.raises(
             gr.InvalidGraphError,
             match=r"Grid endpoint 1 has graph predecessors: \[Component"
-            r"\(component_id=99, category=<ComponentCategory.METER: 2>\)\]",
+            r"\(component_id=99, category=<ComponentCategory.METER: 2>, "
+            r"type=None\)\]",
         ) as _err_predecessors:
             graph._validate_grid_endpoint()