Add Matter OperationalError sensor (home-assistant#151991)

Co-authored-by: TheJulianJES <[email protected]>

Author: lboue

homeassistant/components/matter/icons.json

@@ -123,6 +123,9 @@
       "evse_fault_state": {
         "default": "mdi:ev-station"
       },
+      "operational_error": {
+        "default": "mdi:alert-circle"
+      },
       "pump_control_mode": {
         "default": "mdi:pipe-wrench"
       },

homeassistant/components/matter/sensor.py

@@ -86,6 +86,14 @@
     clusters.OperationalState.Enums.OperationalStateEnum.kError: "error",
 }
 
+OPERATIONAL_STATE_ERROR_MAP = {
+    # enum with known Error state values which we can translate
+    clusters.OperationalState.Enums.ErrorStateEnum.kNoError: "no_error",
+    clusters.OperationalState.Enums.ErrorStateEnum.kUnableToStartOrResume: "unable_to_start_or_resume",
+    clusters.OperationalState.Enums.ErrorStateEnum.kUnableToCompleteOperation: "unable_to_complete_operation",
+    clusters.OperationalState.Enums.ErrorStateEnum.kCommandInvalidInState: "command_invalid_in_state",
+}
+
 RVC_OPERATIONAL_STATE_MAP = {
     # enum with known Operation state values which we can translate
     **OPERATIONAL_STATE_MAP,
@@ -94,6 +102,29 @@
     clusters.RvcOperationalState.Enums.OperationalStateEnum.kDocked: "docked",
 }
 
+RVC_OPERATIONAL_STATE_ERROR_MAP = {
+    # enum with known Error state values which we can translate
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kNoError: "no_error",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kUnableToStartOrResume: "unable_to_start_or_resume",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kUnableToCompleteOperation: "unable_to_complete_operation",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kCommandInvalidInState: "command_invalid_in_state",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kFailedToFindChargingDock: "failed_to_find_charging_dock",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kStuck: "stuck",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kDustBinMissing: "dust_bin_missing",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kDustBinFull: "dust_bin_full",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kWaterTankEmpty: "water_tank_empty",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kWaterTankMissing: "water_tank_missing",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kWaterTankLidOpen: "water_tank_lid_open",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kMopCleaningPadMissing: "mop_cleaning_pad_missing",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kLowBattery: "low_battery",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kCannotReachTargetArea: "cannot_reach_target_area",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kDirtyWaterTankFull: "dirty_water_tank_full",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kDirtyWaterTankMissing: "dirty_water_tank_missing",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kWheelsJammed: "wheels_jammed",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kBrushJammed: "brush_jammed",
+    clusters.RvcOperationalState.Enums.ErrorStateEnum.kNavigationSensorObscured: "navigation_sensor_obscured",
+}
+
 BOOST_STATE_MAP = {
     clusters.WaterHeaterManagement.Enums.BoostStateEnum.kInactive: "inactive",
     clusters.WaterHeaterManagement.Enums.BoostStateEnum.kActive: "active",
@@ -1101,6 +1132,19 @@ def _update_from_device(self) -> None:
         # don't discover this entry if the supported state list is empty
         secondary_value_is_not=[],
     ),
+    MatterDiscoverySchema(
+        platform=Platform.SENSOR,
+        entity_description=MatterSensorEntityDescription(
+            key="OperationalStateOperationalError",
+            translation_key="operational_error",
+            device_class=SensorDeviceClass.ENUM,
+            entity_category=EntityCategory.DIAGNOSTIC,
+            options=list(OPERATIONAL_STATE_ERROR_MAP.values()),
+            device_to_ha=lambda x: OPERATIONAL_STATE_ERROR_MAP.get(x.errorStateID),
+        ),
+        entity_class=MatterSensor,
+        required_attributes=(clusters.OperationalState.Attributes.OperationalError,),
+    ),
     MatterDiscoverySchema(
         platform=Platform.SENSOR,
         entity_description=MatterListSensorEntityDescription(
@@ -1194,6 +1238,19 @@ def _update_from_device(self) -> None:
         # don't discover this entry if the supported state list is empty
         secondary_value_is_not=[],
     ),
+    MatterDiscoverySchema(
+        platform=Platform.SENSOR,
+        entity_description=MatterSensorEntityDescription(
+            key="RvcOperationalStateOperationalError",
+            translation_key="operational_error",
+            device_class=SensorDeviceClass.ENUM,
+            entity_category=EntityCategory.DIAGNOSTIC,
+            options=list(RVC_OPERATIONAL_STATE_ERROR_MAP.values()),
+            device_to_ha=lambda x: RVC_OPERATIONAL_STATE_ERROR_MAP.get(x.errorStateID),
+        ),
+        entity_class=MatterSensor,
+        required_attributes=(clusters.RvcOperationalState.Attributes.OperationalError,),
+    ),
     MatterDiscoverySchema(
         platform=Platform.SENSOR,
         entity_description=MatterOperationalStateSensorEntityDescription(

homeassistant/components/matter/strings.json

@@ -441,6 +441,30 @@
       "evse_soc": {
         "name": "State of charge"
       },
+      "operational_error": {
+        "name": "Operational error",
+        "state": {
+          "no_error": "No error",
+          "unable_to_start_or_resume": "Unable to start or resume",
+          "unable_to_complete_operation": "Unable to complete operation",
+          "command_invalid_in_state": "Command invalid in current state",
+          "failed_to_find_charging_dock": "Failed to find charging dock",
+          "stuck": "Stuck",
+          "dust_bin_missing": "Dust bin missing",
+          "dust_bin_full": "Dust bin full",
+          "water_tank_empty": "Water tank empty",
+          "water_tank_missing": "Water tank missing",
+          "water_tank_lid_open": "Water tank lid open",
+          "mop_cleaning_pad_missing": "Mop cleaning pad missing",
+          "low_battery": "Low battery",
+          "cannot_reach_target_area": "Cannot reach target area",
+          "dirty_water_tank_full": "Dirty water tank full",
+          "dirty_water_tank_missing": "Dirty water tank missing",
+          "wheels_jammed": "Wheels jammed",
+          "brush_jammed": "Brush jammed",
+          "navigation_sensor_obscured": "Navigation sensor obscured"
+        }
+      },
       "pi_heating_demand": {
         "name": "Heating demand"
       },