Alternate Oven Op State per Issue 8349 (project-chip#30645)

* Updating for issue 8349 * Updating regen * Attempting to fix CI failures * Attempting to regen again * Reverting changes back * Adding provisional * Attempting to fix CI issues with global attribute fix * Fixing regen and CI issues with missing zcl addition * Fixing zcl with test file --------- Co-authored-by: abeck-riis <[email protected]>
shripad621git · Nov 28, 2023 · 4b1f556 · 4b1f556
1 parent 8b1071a
commit 4b1f556
Show file tree

Hide file tree

Showing 67 changed files with 8,857 additions and 0 deletions.
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -145,6 +145,7 @@ jobs:
                       src/app/zap-templates/zcl/data-model/chip/onoff-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/operational-credentials-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/operational-state-cluster.xml \
+                      src/app/zap-templates/zcl/data-model/chip/operational-state-oven-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/operational-state-rvc-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/oven-mode-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/pressure-measurement-cluster.xml \

diff --git a/scripts/rules.matterlint b/scripts/rules.matterlint
@@ -56,6 +56,7 @@ load "../src/app/zap-templates/zcl/data-model/chip/occupancy-sensing-cluster.xml
 load "../src/app/zap-templates/zcl/data-model/chip/onoff-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/operational-credentials-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/operational-state-cluster.xml";
+load "../src/app/zap-templates/zcl/data-model/chip/operational-state-oven-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/operational-state-rvc-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/oven-mode-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/power-source-cluster.xml";

diff --git a/src/app/zap-templates/zcl/data-model/all.xml b/src/app/zap-templates/zcl/data-model/all.xml
@@ -57,6 +57,7 @@
    <xi:include href="chip/onoff-cluster.xml" />
    <xi:include href="chip/operational-credentials-cluster.xml" />
    <xi:include href="chip/operational-state-cluster.xml" />
+   <xi:include href="chip/operational-state-oven-cluster.xml" />
    <xi:include href="chip/operational-state-rvc-cluster.xml" />
    <xi:include href="chip/oven-mode-cluster.xml" />
    <xi:include href="chip/pressure-measurement-cluster.xml" />

diff --git a/src/app/zap-templates/zcl/data-model/chip/operational-state-cluster.xml b/src/app/zap-templates/zcl/data-model/chip/operational-state-cluster.xml
@@ -19,6 +19,7 @@ limitations under the License.
 
   <enum name="OperationalStateEnum" type="enum8">
     <cluster code="0x0060"/>
+    <cluster code="0x0048"/>
     <item name="Stopped" value="0x00"/>
     <item name="Running" value="0x01"/>
     <item name="Paused"  value="0x02"/>
@@ -27,6 +28,7 @@ limitations under the License.
 
   <enum name="ErrorStateEnum" type="enum8">
     <cluster code="0x0060"/>
+    <cluster code="0x0048"/>
     <item name="NoError"                    value="0x00"/>
     <item name="UnableToStartOrResume"      value="0x01"/>
     <item name="UnableToCompleteOperation"  value="0x02"/>
@@ -36,13 +38,15 @@ limitations under the License.
   <struct name="OperationalStateStruct">
     <cluster code="0x0060"/>
     <cluster code="0x0061"/>
+    <cluster code="0x0048"/>
     <item name="OperationalStateID"    type="enum8" optional="false"/>
     <item name="OperationalStateLabel" type="char_string" optional="true" length="64"/>
   </struct>
 
   <struct name="ErrorStateStruct">
     <cluster code="0x0060"/>
     <cluster code="0x0061"/>
+    <cluster code="0x0048"/>
     <item name="ErrorStateID" type="enum8" optional="false" />
     <item name="ErrorStateLabel" type="char_string" optional="true" length="64" />
     <item name="ErrorStateDetails" type="char_string" optional="true" length="64" />

diff --git a/src/app/zap-templates/zcl/data-model/chip/operational-state-oven-cluster.xml b/src/app/zap-templates/zcl/data-model/chip/operational-state-oven-cluster.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<!--
+Copyright (c) 2023 Project CHIP Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<configurator>
+  <domain name="CHIP"/>
+  <cluster apiMaturity="provisional">
+    <domain>Appliances</domain>
+    <name>Oven Cavity Operational State</name>
+    <code>0x0048</code>
+    <define>OPERATIONAL_STATE_OVEN_CLUSTER</define>
+    <client init="false" tick="false">true</client>
+    <server init="false" tick="false">true</server>
+    <description>This cluster supports remotely monitoring and, where supported, changing the operational state of an Oven.</description>
+
+    <globalAttribute side="either" code="0xFFFD" value="1"/>
+
+    <attribute side="server" code="0x0000" define="PHASE_LIST"              type="ARRAY" entryType="char_string"                                     writable="false" isNullable="true"  optional="false">PhaseList</attribute>
+    <attribute side="server" code="0x0001" define="CURRENT_PHASE"           type="int8u"                                    min="0x00" max="0x1F"    writable="false" isNullable="true"  optional="false">CurrentPhase</attribute>
+    <attribute side="server" code="0x0002" define="COUNTDOWN_TIME"          type="elapsed_s"                                min="0x00" max="259200"  writable="false" isNullable="true"  optional="true">CountdownTime</attribute>
+    <attribute side="server" code="0x0003" define="OPERATIONAL_STATE_LIST"  type="ARRAY" entryType="OperationalStateStruct"                          writable="false"                    optional="false">OperationalStateList</attribute>
+    <attribute side="server" code="0x0004" define="OPERATIONAL_STATE"       type="OperationalStateEnum"                                              writable="false"                    optional="false">OperationalState</attribute>
+    <attribute side="server" code="0x0005" define="OPERATIONAL_ERROR"       type="ErrorStateStruct"                                                  writable="false"                    optional="false">OperationalError</attribute>
+
+    <command source="client" code="0x00" name="Pause" response="OperationalCommandResponse" optional="true">
+      <description>Upon receipt, the device SHALL pause its operation if it is possible based on the current function of the server.</description>
+    </command>
+
+    <command source="client" code="0x01" name="Stop" response="OperationalCommandResponse" optional="true">
+      <description>Upon receipt, the device SHALL stop its operation if it is at a position where it is safe to do so and/or permitted.</description>
+    </command>
+
+    <command source="client" code="0x02" name="Start" response="OperationalCommandResponse" optional="true">
+      <description>Upon receipt, the device SHALL start its operation if it is safe to do so and the device is in an operational state from which it can be started.</description>
+    </command>
+
+    <command source="client" code="0x03" name="Resume" response="OperationalCommandResponse" optional="true">
+      <description>Upon receipt, the device SHALL resume its operation from the point it was at when it received the Pause command, or from the point when it was paused by means outside of this cluster (for example by manual button press).</description>
+    </command>
+
+    <command source="server" code="0x04" name="OperationalCommandResponse" optional="true">
+      <description>This command SHALL be generated in response to any of the Start, Stop, Pause, or Resume commands.</description>
+      <arg name="CommandResponseState" type="ErrorStateStruct"/>
+    </command>
+
+    <event side="server" code="0x00" priority="critical" name="OperationalError" optional="false">
+      <description>OperationalError</description>
+      <field id="0" name="ErrorState" type="ErrorStateStruct" />
+    </event>
+
+     <event side="server" code="0x01" priority="info" name="OperationCompletion" optional="true">
+      <description>OperationCompletion</description>
+      <field id="0" name="CompletionErrorCode"  type="enum8" />
+      <field id="1" name="TotalOperationalTime" type="elapsed_s" isNullable="true" optional="true"/>
+      <field id="2" name="PausedTime"           type="elapsed_s" isNullable="true" optional="true"/>
+    </event>
+  </cluster>
+</configurator>
diff --git a/src/app/zap-templates/zcl/zcl-with-test-extensions.json b/src/app/zap-templates/zcl/zcl-with-test-extensions.json
@@ -75,6 +75,7 @@
         "onoff-switch-configuration-cluster.xml",
         "operational-credentials-cluster.xml",
         "operational-state-cluster.xml",
+        "operational-state-oven-cluster.xml",
         "operational-state-rvc-cluster.xml",
         "oven-mode-cluster.xml",
         "pressure-measurement-cluster.xml",
@@ -372,6 +373,12 @@
             "CurrentPhase",
             "CountdownTime"
         ],
+        "Oven Cavity Operational State": [
+            "OperationalState",
+            "OperationalError",
+            "CurrentPhase",
+            "CountdownTime"
+        ],
         "Activated Carbon Filter Monitoring": [
             "Condition",
             "DegradationDirection",

diff --git a/src/app/zap-templates/zcl/zcl.json b/src/app/zap-templates/zcl/zcl.json
@@ -72,6 +72,7 @@
         "onoff-switch-configuration-cluster.xml",
         "operational-credentials-cluster.xml",
         "operational-state-cluster.xml",
+        "operational-state-oven-cluster.xml",
         "operational-state-rvc-cluster.xml",
         "oven-mode-cluster.xml",
         "pressure-measurement-cluster.xml",
@@ -370,6 +371,12 @@
             "CurrentPhase",
             "CountdownTime"
         ],
+        "Oven Cavity Operational State": [
+            "OperationalState",
+            "OperationalError",
+            "CurrentPhase",
+            "CountdownTime"
+        ],
         "Activated Carbon Filter Monitoring": [
             "Condition",
             "DegradationDirection",

diff --git a/src/app/zap_cluster_list.json b/src/app/zap_cluster_list.json
@@ -66,6 +66,7 @@
         "ON_OFF_SWITCH_CONFIGURATION_CLUSTER": [],
         "OPERATIONAL_CREDENTIALS_CLUSTER": [],
         "OPERATIONAL_STATE_CLUSTER": [],
+        "OPERATIONAL_STATE_OVEN_CLUSTER": [],
         "OPERATIONAL_STATE_RVC_CLUSTER": [],
         "OTA_BOOTLOAD_CLUSTER": [],
         "OTA_SOFTWARE_UPDATE_PROVIDER_CLUSTER": [],
@@ -205,6 +206,7 @@
         "ON_OFF_SWITCH_CONFIGURATION_CLUSTER": [],
         "OPERATIONAL_CREDENTIALS_CLUSTER": ["operational-credentials-server"],
         "OPERATIONAL_STATE_CLUSTER": ["operational-state-server"],
+        "OPERATIONAL_STATE_OVEN_CLUSTER": ["operational-state-server"],
         "OPERATIONAL_STATE_RVC_CLUSTER": ["operational-state-server"],
         "OTA_BOOTLOAD_CLUSTER": [],
         "OTA_SOFTWARE_UPDATE_PROVIDER_CLUSTER": ["ota-provider"],

diff --git a/src/controller/data_model/BUILD.gn b/src/controller/data_model/BUILD.gn
@@ -182,6 +182,8 @@ if (current_os == "android" || matter_enable_java_compilation) {
       "jni/OperationalCredentialsClient-ReadImpl.cpp",
       "jni/OperationalStateClient-InvokeSubscribeImpl.cpp",
       "jni/OperationalStateClient-ReadImpl.cpp",
+      "jni/OvenCavityOperationalStateClient-InvokeSubscribeImpl.cpp",
+      "jni/OvenCavityOperationalStateClient-ReadImpl.cpp",
       "jni/OtaSoftwareUpdateProviderClient-InvokeSubscribeImpl.cpp",
       "jni/OtaSoftwareUpdateProviderClient-ReadImpl.cpp",
       "jni/OtaSoftwareUpdateRequestorClient-InvokeSubscribeImpl.cpp",

diff --git a/src/controller/data_model/controller-clusters.matter b/src/controller/data_model/controller-clusters.matter
@@ -2968,6 +2968,72 @@ provisional client cluster Timer = 71 {
   command ReduceTime(ReduceTimeRequest): DefaultSuccess = 3;
 }
 
+/** This cluster supports remotely monitoring and, where supported, changing the operational state of an Oven. */
+provisional client cluster OvenCavityOperationalState = 72 {
+  revision 1;
+
+  enum ErrorStateEnum : enum8 {
+    kNoError = 0;
+    kUnableToStartOrResume = 1;
+    kUnableToCompleteOperation = 2;
+    kCommandInvalidInState = 3;
+  }
+
+  enum OperationalStateEnum : enum8 {
+    kStopped = 0;
+    kRunning = 1;
+    kPaused = 2;
+    kError = 3;
+  }
+
+  struct ErrorStateStruct {
+    enum8 errorStateID = 0;
+    optional char_string<64> errorStateLabel = 1;
+    optional char_string<64> errorStateDetails = 2;
+  }
+
+  struct OperationalStateStruct {
+    enum8 operationalStateID = 0;
+    optional char_string<64> operationalStateLabel = 1;
+  }
+
+  critical event OperationalError = 0 {
+    ErrorStateStruct errorState = 0;
+  }
+
+  info event OperationCompletion = 1 {
+    enum8 completionErrorCode = 0;
+    optional nullable elapsed_s totalOperationalTime = 1;
+    optional nullable elapsed_s pausedTime = 2;
+  }
+
+  readonly attribute nullable char_string phaseList[] = 0;
+  readonly attribute nullable int8u currentPhase = 1;
+  readonly attribute optional nullable elapsed_s countdownTime = 2;
+  readonly attribute OperationalStateStruct operationalStateList[] = 3;
+  readonly attribute OperationalStateEnum operationalState = 4;
+  readonly attribute ErrorStateStruct operationalError = 5;
+  readonly attribute command_id generatedCommandList[] = 65528;
+  readonly attribute command_id acceptedCommandList[] = 65529;
+  readonly attribute event_id eventList[] = 65530;
+  readonly attribute attrib_id attributeList[] = 65531;
+  readonly attribute bitmap32 featureMap = 65532;
+  readonly attribute int16u clusterRevision = 65533;
+
+  response struct OperationalCommandResponse = 4 {
+    ErrorStateStruct commandResponseState = 0;
+  }
+
+  /** Upon receipt, the device SHALL pause its operation if it is possible based on the current function of the server. */
+  command Pause(): OperationalCommandResponse = 0;
+  /** Upon receipt, the device SHALL stop its operation if it is at a position where it is safe to do so and/or permitted. */
+  command Stop(): OperationalCommandResponse = 1;
+  /** Upon receipt, the device SHALL start its operation if it is safe to do so and the device is in an operational state from which it can be started. */
+  command Start(): OperationalCommandResponse = 2;
+  /** Upon receipt, the device SHALL resume its operation from the point it was at when it received the Pause command, or from the point when it was paused by means outside of this cluster (for example by manual button press). */
+  command Resume(): OperationalCommandResponse = 3;
+}
+
 /** Attributes and commands for selecting a mode from a list of supported options. */
 provisional client cluster OvenMode = 73 {
   revision 1;

diff --git a/src/controller/data_model/controller-clusters.zap b/src/controller/data_model/controller-clusters.zap
@@ -2052,6 +2052,48 @@
             }
           ]
         },
+        {
+          "name": "Oven Cavity Operational State",
+          "code": 72,
+          "mfgCode": null,
+          "define": "OPERATIONAL_STATE_OVEN_CLUSTER",
+          "side": "client",
+          "enabled": 1,
+          "attributes": [
+            {
+              "name": "FeatureMap",
+              "code": 65532,
+              "mfgCode": null,
+              "side": "client",
+              "type": "bitmap32",
+              "included": 1,
+              "storageOption": "RAM",
+              "singleton": 0,
+              "bounded": 0,
+              "defaultValue": "0",
+              "reportable": 1,
+              "minInterval": 1,
+              "maxInterval": 65534,
+              "reportableChange": 0
+            },
+            {
+              "name": "ClusterRevision",
+              "code": 65533,
+              "mfgCode": null,
+              "side": "client",
+              "type": "int16u",
+              "included": 1,
+              "storageOption": "RAM",
+              "singleton": 0,
+              "bounded": 0,
+              "defaultValue": "1",
+              "reportable": 1,
+              "minInterval": 1,
+              "maxInterval": 65534,
+              "reportableChange": 0
+            }
+          ]
+        },
         {
           "name": "Oven Mode",
           "code": 73,