Use new component states and state snapshots

The new state snapshots in the v0.18 client provide errors and warnings
using a different structure, so we need to account for that.

State code were also unified and there is no more specific enums for
cable state and other component-specific states, all states are part of
the `ComponentStateCode` enum and the component data can have many
state codes in it, while before it contained only one.

In previous versions EV chargers only used one `PLUGGED` or `LOCKED`
status but now the cable status was split in 2 connector ends: station
and EV, so now all combinations of those need to be accounted for. This
might change again on the API side as it ended up a bit messy.

Also the old component data wrappers now can't be frozen because the
`ComponentData` class is not frozen (this is to allow parsing from the
new telemetry messages easier for phases).

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_battery_status_tracker.py

@@ -24,13 +24,7 @@
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
 from frequenz.client.common.microgrid.components import ComponentId
-from frequenz.client.microgrid import (
-    BatteryComponentState,
-    BatteryRelayState,
-    ErrorLevel,
-    InverterComponentState,
-)
-from frequenz.client.microgrid.component import Inverter
+from frequenz.client.microgrid.component import ComponentStateCode, Inverter
 from typing_extensions import override
 
 from frequenz.sdk._internal._asyncio import run_forever
@@ -70,28 +64,34 @@ class BatteryStatusTracker(ComponentStatusTracker, BackgroundService):
     Status updates are sent out only when there is a status change.
     """
 
-    _battery_valid_relay: set[BatteryRelayState] = {BatteryRelayState.CLOSED}
+    _battery_valid_relay: frozenset[ComponentStateCode] = frozenset(
+        [ComponentStateCode.RELAY_CLOSED]
+    )
     """The list of valid relay states of a battery.
 
     A working battery in any other battery relay state will be reported as failing.
     """
 
-    _battery_valid_state: set[BatteryComponentState] = {
-        BatteryComponentState.IDLE,
-        BatteryComponentState.CHARGING,
-        BatteryComponentState.DISCHARGING,
-    }
+    _battery_valid_state: frozenset[ComponentStateCode] = frozenset(
+        [
+            ComponentStateCode.READY,
+            ComponentStateCode.CHARGING,
+            ComponentStateCode.DISCHARGING,
+        ]
+    )
     """The list of valid states of a battery.
 
     A working battery in any other battery state will be reported as failing.
     """
 
-    _inverter_valid_state: set[InverterComponentState] = {
-        InverterComponentState.STANDBY,
-        InverterComponentState.IDLE,
-        InverterComponentState.CHARGING,
-        InverterComponentState.DISCHARGING,
-    }
+    _inverter_valid_state: frozenset[ComponentStateCode] = frozenset(
+        [
+            ComponentStateCode.STANDBY,
+            ComponentStateCode.READY,
+            ComponentStateCode.CHARGING,
+            ComponentStateCode.DISCHARGING,
+        ]
+    )
     """The list of valid states of an inverter.
 
     A working inverter in any other inverter state will be reported as failing.
@@ -371,15 +371,13 @@ def _no_critical_error(self, msg: BatteryData | InverterData) -> bool:
         Returns:
             True if message has no critical error, False otherwise.
         """
-        critical = ErrorLevel.CRITICAL
-        critical_err = next((err for err in msg.errors if err.level == critical), None)
-        if critical_err is not None:
+        if msg.errors:
             last_status = self._last_status  # pylint: disable=protected-access
             if last_status == ComponentStatusEnum.WORKING:
                 _logger.warning(
-                    "Component %d has critical error: %s",
+                    "Component %d has errors: %s",
                     msg.component_id,
-                    str(critical_err),
+                    str(msg.errors),
                 )
             return False
         return True
@@ -394,14 +392,15 @@ def _is_inverter_state_correct(self, msg: InverterData) -> bool:
             True if inverter is in correct state. False otherwise.
         """
         # Component state is not exposed to the user.
-        state = msg.component_state
+        component_states = msg.states
         # pylint: disable-next=protected-access
-        if state not in BatteryStatusTracker._inverter_valid_state:
+        valid_states = BatteryStatusTracker._inverter_valid_state
+        if not component_states & valid_states:
             if self._last_status == ComponentStatusEnum.WORKING:
                 _logger.warning(
-                    "Inverter %d has invalid state: %s",
+                    "Inverter %d has invalid states: %s",
                     msg.component_id,
-                    state.name,
+                    msg.states,
                 )
             return False
         return True
@@ -416,25 +415,27 @@ def _is_battery_state_correct(self, msg: BatteryData) -> bool:
             True if battery is in correct state. False otherwise.
         """
         # Component state is not exposed to the user.
-        state = msg.component_state
+        component_states = msg.states
         # pylint: disable-next=protected-access
-        if state not in BatteryStatusTracker._battery_valid_state:
+        valid_states = BatteryStatusTracker._battery_valid_state
+        if not component_states & valid_states:
             if self._last_status == ComponentStatusEnum.WORKING:
                 _logger.warning(
-                    "Battery %d has invalid state: %s",
+                    "Battery %d has invalid states: %s, expected: %s",
                     self.battery_id,
-                    state.name,
+                    msg.states,
+                    valid_states,
                 )
             return False
 
         # Component state is not exposed to the user.
-        relay_state = msg.relay_state
-        if relay_state not in BatteryStatusTracker._battery_valid_relay:
+        if not msg.states & BatteryStatusTracker._battery_valid_relay:
             if self._last_status == ComponentStatusEnum.WORKING:
                 _logger.warning(
-                    "Battery %d has invalid relay state: %s",
+                    "Battery %d has invalid states: %s, expected: %s",
                     self.battery_id,
-                    relay_state.name,
+                    msg.states,
+                    BatteryStatusTracker._battery_valid_relay,
                 )
             return False
         return True

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_ev_charger_status_tracker.py

@@ -11,10 +11,7 @@
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
 from frequenz.client.common.microgrid.components import ComponentId
-from frequenz.client.microgrid import (
-    EVChargerCableState,
-    EVChargerComponentState,
-)
+from frequenz.client.microgrid.component import ComponentStateCode
 from typing_extensions import override
 
 from ...._internal._asyncio import run_forever
@@ -87,14 +84,16 @@ def start(self) -> None:
 
     def _is_working(self, ev_data: EVChargerData) -> bool:
         """Return whether the given data indicates that the component is working."""
-        return ev_data.cable_state in (
-            EVChargerCableState.EV_PLUGGED,
-            EVChargerCableState.EV_LOCKED,
-        ) and ev_data.component_state in (
-            EVChargerComponentState.READY,
-            EVChargerComponentState.CHARGING,
-            EVChargerComponentState.DISCHARGING,
+        is_connected = ev_data.is_ev_connected()
+        is_ok = bool(
+            {
+                ComponentStateCode.READY,
+                ComponentStateCode.CHARGING,
+                ComponentStateCode.DISCHARGING,
+            }
+            & ev_data.states
         )
+        return is_connected and is_ok
 
     def _is_stale(self, ev_data: EVChargerData) -> bool:
         """Return whether the given data is stale."""
@@ -123,11 +122,9 @@ def _handle_ev_data(self, ev_data: EVChargerData) -> ComponentStatusEnum:
 
         if self._last_status == ComponentStatusEnum.WORKING:
             _logger.warning(
-                "EV charger %s is in NOT_WORKING state. "
-                "Cable state: %s, component state: %s",
+                "EV charger %s is in NOT_WORKING state. component states: %s",
                 self._component_id,
-                ev_data.cable_state,
-                ev_data.component_state,
+                ev_data.states,
             )
         return ComponentStatusEnum.NOT_WORKING
 

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_pv_inverter_status_tracker.py

@@ -10,7 +10,7 @@
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
 from frequenz.client.common.microgrid.components import ComponentId
-from frequenz.client.microgrid import ComponentStateCode
+from frequenz.client.microgrid.component import ComponentStateCode
 from typing_extensions import override
 
 from ...._internal._asyncio import run_forever
@@ -84,11 +84,14 @@ def start(self) -> None:
 
     def _is_working(self, pv_data: InverterData) -> bool:
         """Return whether the given data indicates that the PV inverter is working."""
-        return pv_data.component_state in (
-            InverterComponentState.DISCHARGING,
-            InverterComponentState.CHARGING,
-            InverterComponentState.IDLE,
-            InverterComponentState.STANDBY,
+        return bool(
+            {
+                ComponentStateCode.DISCHARGING,
+                ComponentStateCode.CHARGING,
+                ComponentStateCode.READY,
+                ComponentStateCode.STANDBY,
+            }
+            & pv_data.states
         )
 
     def _is_stale(self, pv_data: InverterData) -> bool:
@@ -134,9 +137,9 @@ def _handle_pv_inverter_data(self, pv_data: InverterData) -> ComponentStatusEnum
 
         if self._last_status == ComponentStatusEnum.WORKING:
             _logger.warning(
-                "PV inverter %s is in NOT_WORKING state.  Component state: %s",
+                "PV inverter %s is in NOT_WORKING state.  Component states: %s",
                 self._component_id,
-                pv_data.component_state,
+                pv_data.states,
             )
         return ComponentStatusEnum.NOT_WORKING