[Scenes] Removal of Optional for AttributeId (#27509)

* Removed the optionnal quality from the AttributeId in scene xml and refactored tests and clusters to work with the changes * Update src/app/tests/TestSceneTable.cpp Co-authored-by: Boris Zbarsky <[email protected]> --------- Co-authored-by: Andrei Litvin <[email protected]> Co-authored-by: Boris Zbarsky <[email protected]>
project-chip · Jul 7, 2023 · 331e11d · 331e11d
1 parent 6aa4d62
commit 331e11d
Show file tree

Hide file tree

Showing 26 changed files with 99 additions and 181 deletions.
diff --git a/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter b/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter
@@ -159,7 +159,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter b/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
@@ -153,7 +153,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/light-switch-app/light-switch-common/light-switch-app.matter b/examples/light-switch-app/light-switch-common/light-switch-app.matter
@@ -207,7 +207,7 @@ client cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/lighting-app/lighting-common/lighting-app.matter b/examples/lighting-app/lighting-common/lighting-app.matter
@@ -159,7 +159,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/lighting-app/silabs/data_model/lighting-thread-app.matter b/examples/lighting-app/silabs/data_model/lighting-thread-app.matter
@@ -159,7 +159,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/lighting-app/silabs/data_model/lighting-wifi-app.matter b/examples/lighting-app/silabs/data_model/lighting-wifi-app.matter
@@ -159,7 +159,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/placeholder/linux/apps/app1/config.matter b/examples/placeholder/linux/apps/app1/config.matter
@@ -207,7 +207,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/placeholder/linux/apps/app2/config.matter b/examples/placeholder/linux/apps/app2/config.matter
@@ -207,7 +207,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/thermostat/thermostat-common/thermostat.matter b/examples/thermostat/thermostat-common/thermostat.matter
@@ -207,7 +207,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/examples/window-app/common/window-app.matter b/examples/window-app/common/window-app.matter
@@ -159,7 +159,7 @@ server cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/src/app/clusters/on-off-server/on-off-server.cpp b/src/app/clusters/on-off-server/on-off-server.cpp
@@ -199,7 +199,7 @@ class DefaultOnOffSceneHandler : public scenes::DefaultSceneHandlerImpl
 
         AttributeValuePair pairs[scenableAttributeCount];
 
-        pairs[0].attributeID.SetValue(Attributes::OnOff::Id);
+        pairs[0].attributeID    = Attributes::OnOff::Id;
         pairs[0].attributeValue = currentValue;
 
         app::DataModel::List<AttributeValuePair> attributeValueList(pairs);
@@ -230,11 +230,7 @@ class DefaultOnOffSceneHandler : public scenes::DefaultSceneHandlerImpl
         while (pair_iterator.Next())
         {
             auto & decodePair = pair_iterator.GetValue();
-            if (decodePair.attributeID.HasValue())
-            {
-                // If attribute ID was encoded, verify it is the proper ID for the OnOff attribute
-                VerifyOrReturnError(decodePair.attributeID.Value() == Attributes::OnOff::Id, CHIP_ERROR_INVALID_ARGUMENT);
-            }
+            VerifyOrReturnError(decodePair.attributeID == Attributes::OnOff::Id, CHIP_ERROR_INVALID_ARGUMENT);
             ReturnErrorOnFailure(
                 mSceneEndpointStatePairs.InsertPair(EndpointStatePair(endpoint, static_cast<bool>(decodePair.attributeValue))));
         }
@@ -545,7 +541,7 @@ void OnOffServer::initOnOffServer(chip::EndpointId endpoint)
 
 #ifdef EMBER_AF_PLUGIN_SCENES
         // Registers Scene handlers for the On/Off cluster on the server
-        // app::Clusters::Scenes::ScenesServer::Instance().RegisterSceneHandler(OnOffServer::Instance().GetSceneHandler());
+        app::Clusters::Scenes::ScenesServer::Instance().RegisterSceneHandler(OnOffServer::Instance().GetSceneHandler());
 #endif
 
 #ifdef EMBER_AF_PLUGIN_MODE_SELECT

diff --git a/src/app/tests/TestSceneTable.cpp b/src/app/tests/TestSceneTable.cpp
@@ -494,29 +494,29 @@ void TestHandlerFunctions(nlTestSuite * aSuite, void * aContext)
     static const uint16_t LC_av_payload[2] = { 0x64, 0x01F0 };
     static const uint16_t CC_av_payload[8] = { 0 };
 
-    OOPairs[0].attributeID.SetValue(kOnOffAttId);
+    OOPairs[0].attributeID    = kOnOffAttId;
     OOPairs[0].attributeValue = OO_av_payload;
 
-    LCPairs[0].attributeID.SetValue(kCurrentLevelId);
+    LCPairs[0].attributeID    = kCurrentLevelId;
     LCPairs[0].attributeValue = LC_av_payload[0];
-    LCPairs[1].attributeID.SetValue(kCurrentFrequencyId);
+    LCPairs[1].attributeID    = kCurrentFrequencyId;
     LCPairs[1].attributeValue = LC_av_payload[1];
 
-    CCPairs[0].attributeID.SetValue(kCurrentSaturationId);
+    CCPairs[0].attributeID    = kCurrentSaturationId;
     CCPairs[0].attributeValue = CC_av_payload[0];
-    CCPairs[1].attributeID.SetValue(kCurrentXId);
+    CCPairs[1].attributeID    = kCurrentXId;
     CCPairs[1].attributeValue = CC_av_payload[1];
-    CCPairs[2].attributeID.SetValue(kCurrentYId);
+    CCPairs[2].attributeID    = kCurrentYId;
     CCPairs[2].attributeValue = CC_av_payload[2];
-    CCPairs[3].attributeID.SetValue(kColorTemperatureMiredsId);
+    CCPairs[3].attributeID    = kColorTemperatureMiredsId;
     CCPairs[3].attributeValue = CC_av_payload[3];
-    CCPairs[4].attributeID.SetValue(kEnhancedCurrentHueId);
+    CCPairs[4].attributeID    = kEnhancedCurrentHueId;
     CCPairs[4].attributeValue = CC_av_payload[4];
-    CCPairs[5].attributeID.SetValue(kColorLoopActiveId);
+    CCPairs[5].attributeID    = kColorLoopActiveId;
     CCPairs[5].attributeValue = CC_av_payload[5];
-    CCPairs[6].attributeID.SetValue(kColorLoopDirectionId);
+    CCPairs[6].attributeID    = kColorLoopDirectionId;
     CCPairs[6].attributeValue = CC_av_payload[6];
-    CCPairs[7].attributeID.SetValue(kColorLoopTimeId);
+    CCPairs[7].attributeID    = kColorLoopTimeId;
     CCPairs[7].attributeValue = CC_av_payload[7];
 
     // Initialize Extension Field sets as if they were received by add commands
@@ -637,7 +637,6 @@ void TestHandlerFunctions(nlTestSuite * aSuite, void * aContext)
     app::Clusters::Scenes::Structs::AttributeValuePair::Type TooManyPairs[16];
 
     uint8_t payloadOk = 0;
-
     for (uint8_t i = 0; i < 16; i++)
     {
         TooManyPairs[i].attributeValue = payloadOk;
@@ -646,7 +645,8 @@ void TestHandlerFunctions(nlTestSuite * aSuite, void * aContext)
     extensionFieldFailTestOut.clusterID          = kColorControlClusterId;
     extensionFieldFailTestOut.attributeValueList = TooManyPairs;
 
-    uint8_t failBuffer[scenes::kMaxFieldBytesPerCluster] = { 0 };
+    // Give a bigger buffer given we are using too many pairs on purpose
+    uint8_t failBuffer[2 * scenes::kMaxFieldBytesPerCluster] = { 0 };
     ByteSpan fail_list(failBuffer);
 
     // Serialize Extension Field sets as if they were recovered from memory

diff --git a/src/app/zap-templates/zcl/data-model/chip/scene.xml b/src/app/zap-templates/zcl/data-model/chip/scene.xml
@@ -22,7 +22,7 @@ limitations under the License.
 
   <struct name="AttributeValuePair">
     <cluster code="0x0005"/>
-    <item name="AttributeID" type="attrib_id" optional="true"/>
+    <item name="AttributeID" type="attrib_id" optional="false"/>
     <item name="AttributeValue" type="INT32U" optional="false"/>
   </struct>
 

diff --git a/src/controller/data_model/controller-clusters.matter b/src/controller/data_model/controller-clusters.matter
@@ -167,7 +167,7 @@ client cluster Scenes = 5 {
   }
 
   struct AttributeValuePair {
-    optional attrib_id attributeID = 0;
+    attrib_id attributeID = 0;
     int32u attributeValue = 1;
   }
 

diff --git a/src/controller/java/zap-generated/CHIPInvokeCallbacks.cpp b/src/controller/java/zap-generated/CHIPInvokeCallbacks.cpp
diff --git a/src/controller/java/zap-generated/chip/devicecontroller/ChipStructs.java b/src/controller/java/zap-generated/chip/devicecontroller/ChipStructs.java
diff --git a/src/controller/python/chip/clusters/Objects.py b/src/controller/python/chip/clusters/Objects.py
diff --git a/src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.mm b/src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.mm
diff --git a/src/darwin/Framework/CHIP/zap-generated/MTRClusters.mm b/src/darwin/Framework/CHIP/zap-generated/MTRClusters.mm
diff --git a/src/darwin/Framework/CHIP/zap-generated/MTRCommandPayloadsObjc.mm b/src/darwin/Framework/CHIP/zap-generated/MTRCommandPayloadsObjc.mm