Additional RVC Operational States and Errors (project-chip#38420)

* additional operational states from 1.5 spec

* additional operational error states from 1.5 spec

* codegen: python

* codegen: darwin

* codegen: .matter files

* codegen:  zzz

* add timing note for provisional items

* Restyled by prettier-yaml

---------

Co-authored-by: Restyled.io <commits@restyled.io>

Author: kiel-apple

examples/all-clusters-app/all-clusters-common/all-clusters-app.matter

@@ -3839,6 +3839,13 @@ cluster RvcOperationalState = 97 {
     kWaterTankMissing = 69;
     kWaterTankLidOpen = 70;
     kMopCleaningPadMissing = 71;
+    kLowBattery = 72;
+    kCannotReachTargetArea = 73;
+    kDirtyWaterTankFull = 74;
+    kDirtyWaterTankMissing = 75;
+    kWheelsJammed = 76;
+    kBrushJammed = 77;
+    kNavigationSensorObscured = 78;
   }
 
   enum OperationalStateEnum : enum8 {
@@ -3849,6 +3856,10 @@ cluster RvcOperationalState = 97 {
     kSeekingCharger = 64;
     kCharging = 65;
     kDocked = 66;
+    kEmptyingDustBin = 67;
+    kCleaningMop = 68;
+    kFillingWaterTank = 69;
+    kUpdatingMaps = 70;
   }
 
   shared struct ErrorStateStruct {

examples/chef/devices/rootnode_roboticvacuumcleaner_1807ff0c49.matter

@@ -1771,6 +1771,13 @@ cluster RvcOperationalState = 97 {
     kWaterTankMissing = 69;
     kWaterTankLidOpen = 70;
     kMopCleaningPadMissing = 71;
+    kLowBattery = 72;
+    kCannotReachTargetArea = 73;
+    kDirtyWaterTankFull = 74;
+    kDirtyWaterTankMissing = 75;
+    kWheelsJammed = 76;
+    kBrushJammed = 77;
+    kNavigationSensorObscured = 78;
   }
 
   enum OperationalStateEnum : enum8 {
@@ -1781,6 +1788,10 @@ cluster RvcOperationalState = 97 {
     kSeekingCharger = 64;
     kCharging = 65;
     kDocked = 66;
+    kEmptyingDustBin = 67;
+    kCleaningMop = 68;
+    kFillingWaterTank = 69;
+    kUpdatingMaps = 70;
   }
 
   shared struct ErrorStateStruct {

examples/rvc-app/rvc-common/rvc-app.matter

@@ -1452,6 +1452,13 @@ cluster RvcOperationalState = 97 {
     kWaterTankMissing = 69;
     kWaterTankLidOpen = 70;
     kMopCleaningPadMissing = 71;
+    kLowBattery = 72;
+    kCannotReachTargetArea = 73;
+    kDirtyWaterTankFull = 74;
+    kDirtyWaterTankMissing = 75;
+    kWheelsJammed = 76;
+    kBrushJammed = 77;
+    kNavigationSensorObscured = 78;
   }
 
   enum OperationalStateEnum : enum8 {
@@ -1462,6 +1469,10 @@ cluster RvcOperationalState = 97 {
     kSeekingCharger = 64;
     kCharging = 65;
     kDocked = 66;
+    kEmptyingDustBin = 67;
+    kCleaningMop = 68;
+    kFillingWaterTank = 69;
+    kUpdatingMaps = 70;
   }
 
   shared struct ErrorStateStruct {

src/app/zap-templates/zcl/data-model/chip/operational-state-rvc-cluster.xml

@@ -29,9 +29,13 @@ limitations under the License.
     <item name="Error"   value="0x03"/>
 
     <!-- Derived cluster-specific values start below at 0x40 -->
-    <item name="SeekingCharger" value="0x40"/>
-    <item name="Charging"       value="0x41"/>
-    <item name="Docked"         value="0x42"/>
+    <item name="SeekingCharger"     value="0x40"/>
+    <item name="Charging"           value="0x41"/>
+    <item name="Docked"             value="0x42"/>
+    <item name="EmptyingDustBin"    value="0x43"/>
+    <item name="CleaningMop"        value="0x44"/>
+    <item name="FillingWaterTank"   value="0x45"/>
+    <item name="UpdatingMaps"       value="0x46"/>
   </enum>
 
   <enum name="ErrorStateEnum" type="enum8">
@@ -54,6 +58,13 @@ limitations under the License.
     <item name="WaterTankMissing"           value="0x45"/>
     <item name="WaterTankLidOpen"           value="0x46"/>
     <item name="MopCleaningPadMissing"      value="0x47"/>
+    <item name="LowBattery"                 value="0x48"/>
+    <item name="CannotReachTargetArea"      value="0x49"/>
+    <item name="DirtyWaterTankFull"         value="0x4a"/>
+    <item name="DirtyWaterTankMissing"      value="0x4b"/>
+    <item name="WheelsJammed"               value="0x4c"/>
+    <item name="BrushJammed"                value="0x4d"/>
+    <item name="NavigationSensorObscured"   value="0x4e"/>
   </enum>
 
   <cluster>

src/controller/data_model/controller-clusters.matter

@@ -4102,6 +4102,13 @@ cluster RvcOperationalState = 97 {
     kWaterTankMissing = 69;
     kWaterTankLidOpen = 70;
     kMopCleaningPadMissing = 71;
+    kLowBattery = 72;
+    kCannotReachTargetArea = 73;
+    kDirtyWaterTankFull = 74;
+    kDirtyWaterTankMissing = 75;
+    kWheelsJammed = 76;
+    kBrushJammed = 77;
+    kNavigationSensorObscured = 78;
   }
 
   enum OperationalStateEnum : enum8 {
@@ -4112,6 +4119,10 @@ cluster RvcOperationalState = 97 {
     kSeekingCharger = 64;
     kCharging = 65;
     kDocked = 66;
+    kEmptyingDustBin = 67;
+    kCleaningMop = 68;
+    kFillingWaterTank = 69;
+    kUpdatingMaps = 70;
   }
 
   shared struct ErrorStateStruct {

src/controller/python/chip/clusters/Objects.py

@@ -11671,6 +11671,22 @@
               MeasurementTypeEnum:
                   - ApparentEnergy
                   - ReactiveEnergy
+          RVCOperationalState:
+              # Additional error and operational states:
+              # in-progress for maybe Matter 1.5
+              ErrorStateEnum:
+                  - LowBattery
+                  - CannotReachTargetArea
+                  - DirtyWaterTankFull
+                  - DirtyWaterTankMissing
+                  - WheelsJammed
+                  - BrushJammed
+                  - NavigationSensorObscured
+              OperationalStateEnum:
+                  - EmptyingDustBin
+                  - CleaningMop
+                  - FillingWaterTank
+                  - UpdatingMaps
       device types:
           # In-progress for maybe Matter 1.5
           - Awning

src/darwin/Framework/CHIP/templates/availability.yaml

@@ -41,6 +41,13 @@ enum class ErrorStateEnum : uint8_t
     kWaterTankMissing          = 0x45,
     kWaterTankLidOpen          = 0x46,
     kMopCleaningPadMissing     = 0x47,
+    kLowBattery                = 0x48,
+    kCannotReachTargetArea     = 0x49,
+    kDirtyWaterTankFull        = 0x4A,
+    kDirtyWaterTankMissing     = 0x4B,
+    kWheelsJammed              = 0x4C,
+    kBrushJammed               = 0x4D,
+    kNavigationSensorObscured  = 0x4E,
     // kUnknownEnumValue intentionally not defined. This enum never goes
     // through DataModel::Decode, likely because it is a part of a derived
     // cluster. As a result having kUnknownEnumValue in this enum is error
@@ -51,13 +58,17 @@ enum class ErrorStateEnum : uint8_t
 // Enum for OperationalStateEnum
 enum class OperationalStateEnum : uint8_t
 {
-    kStopped        = 0x00,
-    kRunning        = 0x01,
-    kPaused         = 0x02,
-    kError          = 0x03,
-    kSeekingCharger = 0x40,
-    kCharging       = 0x41,
-    kDocked         = 0x42,
+    kStopped          = 0x00,
+    kRunning          = 0x01,
+    kPaused           = 0x02,
+    kError            = 0x03,
+    kSeekingCharger   = 0x40,
+    kCharging         = 0x41,
+    kDocked           = 0x42,
+    kEmptyingDustBin  = 0x43,
+    kCleaningMop      = 0x44,
+    kFillingWaterTank = 0x45,
+    kUpdatingMaps     = 0x46,
     // kUnknownEnumValue intentionally not defined. This enum never goes
     // through DataModel::Decode, likely because it is a part of a derived
     // cluster. As a result having kUnknownEnumValue in this enum is error