Adding features in cluster xml as a bitmap such that bitmap name='feature' can be removed from the xml in favor of features which holds the featuremap information as well as defines the feature bitmap such that there is no duplicate information between features and bitmap name=feature

JIRA: ZAPP-1346

Author: brdandu

apack.json

@@ -4,7 +4,7 @@
   "description": "Graphical configuration tool for application and libraries based on Zigbee Cluster Library.",
   "path": [".", "node_modules/.bin/", "ZAP.app/Contents/MacOS"],
   "requiredFeatureLevel": "apack.core:9",
-  "featureLevel": 101,
+  "featureLevel": 102,
   "uc.triggerExtension": "zap",
   "executable": {
     "zap:win32.x86_64": {

src-electron/zcl/zcl-loader-silabs.js

@@ -1012,7 +1012,11 @@ function prepareDataType(a, dataType, typeMap) {
     id: parseInt(a.$.id),
     description: a.$.description ? a.$.description : a.$.name,
     discriminator_ref: dataType ? dataType : dataTypeRef,
-    cluster_code: a.cluster ? a.cluster : null,
+    cluster_code: a.cluster
+      ? a.cluster
+      : a.$.cluster_code
+      ? [{ $: { code: a.$.cluster_code[0] } }]
+      : null, // else case: Treating features in a cluster as a bitmap
   }
 }
 
@@ -1274,7 +1278,11 @@ function prepareEnumOrBitmap(db, packageId, a, dataType, typeMap) {
   return {
     name: a.$.name,
     type: a.$.type.toLowerCase(),
-    cluster_code: a.cluster ? a.cluster : null,
+    cluster_code: a.cluster
+      ? a.cluster
+      : a.$.cluster_code
+      ? [{ $: { code: a.$.cluster_code[0] } }]
+      : null, // else case: Treating features in a cluster as a bitmap
     discriminator_ref: dataType,
   }
 }
@@ -1420,21 +1428,40 @@ async function processBitmapFields(
   env.logDebug(`${filePath}, ${packageId}: ${data.length} Bitmap Fields.`)
   let bitmapFields = []
   let lastFieldId = -1
-  data.forEach((bm) => {
-    if ('field' in bm) {
-      bm.field.forEach((item) => {
-        let defaultFieldId = lastFieldId + 1
-        lastFieldId = item.$.fieldId ? parseInt(item.$.fieldId) : defaultFieldId
-        bitmapFields.push({
-          bitmapName: bm.$.name,
-          bitmapClusterCode: bm.cluster ? bm.cluster : null,
-          name: item.$.name,
-          mask: parseInt(item.$.mask),
-          fieldIdentifier: lastFieldId,
+  if (!('features' in data)) {
+    data.forEach((bm) => {
+      if ('field' in bm) {
+        bm.field.forEach((item) => {
+          let defaultFieldId = lastFieldId + 1
+          lastFieldId = item.$.fieldId
+            ? parseInt(item.$.fieldId)
+            : defaultFieldId
+          bitmapFields.push({
+            bitmapName: bm.$.name,
+            bitmapClusterCode: bm.cluster ? bm.cluster : null,
+            name: item.$.name,
+            mask: parseInt(item.$.mask),
+            fieldIdentifier: lastFieldId,
+          })
         })
+      }
+    })
+    // Treating features in a cluster as a bitmap
+  } else if (
+    'features' in data &&
+    data.features.length == 1 &&
+    'feature' in data.features[0]
+  ) {
+    data.features[0].feature.forEach((item) => {
+      bitmapFields.push({
+        bitmapName: 'Feature',
+        bitmapClusterCode: [{ $: { code: data.code[0] } }],
+        name: item.$.name,
+        mask: 1 << item.$.bit,
+        fieldIdentifier: item.$.bit,
       })
-    }
-  })
+    })
+  }
   return queryLoader.insertBitmapFields(
     db,
     packageId,
@@ -1577,7 +1604,7 @@ function prepareDeviceType(deviceType) {
           if ('features' in include) {
             include.features[0].feature.forEach((f) => {
               // Only adding madatory features for now
-              if (f.mandatoryConform[0] === '') {
+              if (f.mandatoryConform && f.mandatoryConform[0] === '') {
                 features.push(f.$.name)
               }
             })
@@ -1637,6 +1664,7 @@ async function processParsedZclData(
   let packageId = argument.packageId
   previouslyKnownPackages.add(packageId)
   let knownPackages = Array.from(previouslyKnownPackages)
+  let featureClusters = []
 
   if (!('result' in argument)) {
     return []
@@ -1685,6 +1713,7 @@ async function processParsedZclData(
       )
     }
     if ('cluster' in toplevel) {
+      featureClusters = toplevel.cluster.filter((c) => 'features' in c)
       batch2.push(
         processClusters(db, filePath, packageId, toplevel.cluster, context)
       )
@@ -1717,6 +1746,31 @@ async function processParsedZclData(
         )
       )
     }
+
+    // Treating features in a cluster as a bitmap
+    if (featureClusters.length > 0) {
+      featureClusters.forEach((fc) => {
+        batch3.push(
+          processDataType(
+            db,
+            filePath,
+            packageId,
+            knownPackages,
+            [
+              {
+                $: {
+                  name: 'Feature',
+                  type: 'BITMAP32',
+                  cluster_code: [fc.code[0]],
+                },
+              },
+            ],
+            dbEnum.zclType.bitmap
+          )
+        )
+      })
+    }
+
     if (dbEnum.zclType.enum in toplevel) {
       batch3.push(
         processDataType(
@@ -1785,6 +1839,22 @@ async function processParsedZclData(
         processBitmap(db, filePath, packageId, knownPackages, toplevel.bitmap)
       )
     }
+    // Treating features in a cluster as a bitmap
+    if (featureClusters.length > 0) {
+      featureClusters.forEach((fc) => {
+        Batch5.push(
+          processBitmap(db, filePath, packageId, knownPackages, [
+            {
+              $: {
+                name: 'Feature',
+                type: 'BITMAP32',
+                cluster_code: [fc.code[0]],
+              },
+            },
+          ])
+        )
+      })
+    }
     if (dbEnum.zclType.struct in toplevel) {
       Batch5.push(
         processStruct(db, filePath, packageId, knownPackages, toplevel.struct)
@@ -1810,6 +1880,14 @@ async function processParsedZclData(
         )
       )
     }
+    // Treating features in a cluster as a bitmap
+    if (featureClusters.length > 0) {
+      featureClusters.forEach((fc) => {
+        batch6.push(
+          processBitmapFields(db, filePath, packageId, knownPackages, fc)
+        )
+      })
+    }
     if (dbEnum.zclType.struct in toplevel) {
       batch6.push(
         processStructItems(

test/gen-matter-1.test.js

@@ -79,6 +79,34 @@ test('Validate loading', async () => {
   expect(cluster.name).toBe('OTA Software Update Provider')
 })
 
+test('Validate loading of features as bitmap', async () => {
+  /* See level-control-cluster.xml which has the following:
+  <features>
+      <feature bit="0" code="OO" name="OnOff" default="1" summary="Dependency with the On/Off cluster">
+        <optionalConform/>
+      </feature>
+      <feature bit="1" code="LT" name="Lighting" default="0" summary="Behavior that supports lighting applications">
+        <optionalConform/>
+      </feature>
+      <feature bit="2" code="FQ" name="Frequency" default="0" summary="Supports frequency attributes and behavior.
+                                        The Pulse Width Modulation cluster was created
+                                        for frequency control.">
+        <provisionalConform/>
+      </feature>
+    </features>
+  */
+  let clusterInfo = await queryZcl.selectClusterByCode(db, zclPackageId, 0x0008)
+
+  let dataType = await queryZcl.selectDataTypeByNameAndClusterId(
+    db,
+    'Feature',
+    clusterInfo.id,
+    [zclPackageId]
+  )
+  expect(dataType).not.toBeNull()
+  expect(dataType.name).toEqual('Feature')
+})
+
 test(
   'Basic gen template parsing and generation',
   async () => {