Expose EVChargerComponentState through the ev_charger_data method

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

Author: shsms

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

@@ -14,7 +14,7 @@
     InverterData,
     MeterData,
 )
-from ._component_states import EVChargerCableState
+from ._component_states import EVChargerCableState, EVChargerComponentState
 
 __all__ = [
     "BatteryData",
@@ -23,6 +23,7 @@
     "ComponentCategory",
     "ComponentMetricId",
     "EVChargerCableState",
+    "EVChargerComponentState",
     "EVChargerData",
     "InverterData",
     "InverterType",

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

@@ -14,7 +14,7 @@
 import frequenz.api.microgrid.microgrid_pb2 as microgrid_pb
 import pytz
 
-from ._component_states import EVChargerCableState
+from ._component_states import EVChargerCableState, EVChargerComponentState
 
 
 @dataclass(frozen=True)
@@ -257,6 +257,9 @@ class EVChargerData(ComponentData):
     cable_state: EVChargerCableState
     """The state of the ev charger's cable."""
 
+    component_state: EVChargerComponentState
+    """The state of the ev charger."""
+
     @classmethod
     def from_proto(cls, raw: microgrid_pb.ComponentData) -> EVChargerData:
         """Create EVChargerData from a protobuf message.
@@ -282,6 +285,9 @@ def from_proto(cls, raw: microgrid_pb.ComponentData) -> EVChargerData:
                 raw.ev_charger.data.ac.phase_3.voltage.value,
             ),
             cable_state=EVChargerCableState.from_pb(raw.ev_charger.state.cable_state),
+            component_state=EVChargerComponentState.from_pb(
+                raw.ev_charger.state.component_state
+            ),
         )
         ev_charger_data._set_raw(raw=raw)
         return ev_charger_data

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

@@ -39,3 +39,36 @@ def from_pb(
             return cls.UNSPECIFIED
 
         return EVChargerCableState(evc_state)
+
+
+class EVChargerComponentState(Enum):
+    """Component State of an EV Charger."""
+
+    UNSPECIFIED = ev_charger_pb.ComponentState.COMPONENT_STATE_UNSPECIFIED
+    STARTING = ev_charger_pb.ComponentState.COMPONENT_STATE_STARTING
+    NOT_READY = ev_charger_pb.ComponentState.COMPONENT_STATE_NOT_READY
+    READY = ev_charger_pb.ComponentState.COMPONENT_STATE_READY
+    CHARGING = ev_charger_pb.ComponentState.COMPONENT_STATE_CHARGING
+    DISCHARGING = ev_charger_pb.ComponentState.COMPONENT_STATE_DISCHARGING
+    ERROR = ev_charger_pb.ComponentState.COMPONENT_STATE_ERROR
+    AUTHORIZATION_REJECTED = (
+        ev_charger_pb.ComponentState.COMPONENT_STATE_AUTHORIZATION_REJECTED
+    )
+    INTERRUPTED = ev_charger_pb.ComponentState.COMPONENT_STATE_INTERRUPTED
+
+    @classmethod
+    def from_pb(
+        cls, evc_state: ev_charger_pb.ComponentState.ValueType
+    ) -> EVChargerComponentState:
+        """Convert a protobuf ComponentState value to EVChargerComponentState enum.
+
+        Args:
+            evc_state: protobuf component state to convert.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(t.value == evc_state for t in EVChargerComponentState):
+            return cls.UNSPECIFIED
+
+        return EVChargerComponentState(evc_state)