Matter : manufacturer specific cluster

[abollaert]

Hi,

We're currently developing a Matter product based on the nRF5340 SoC, and we would want to add some custom (manufacturer specific) functionality. According to the specification (coren, §7.19, Manufacturer Specific Extensions) this is possible if you define a cluster in the manufacturer-specific range (0xFC00 - 0xFFFE).

So what I did is create an XML file defining my custom cluster, like so:

<?xml version="1.0"?>
<configurator>
  <domain name="Manufacturer"/>

  <cluster manufacturerCode="0xFFF1">
    <domain>Manufacturer</domain>
    <name>MyCluster</name>
    <code>0xfc00</code>
    <define>MY_CUSTOM_CLUSTER</define>
    <description>Manufacturer specific cluster test.</description>
    
    <attribute side="server" code="0x0000" define="MY_ATTRIBUTE" type="INT32U" min="0x00000000" max="0xFFFFFFFF" writable="false" optional="false">Test manufacturer specific attribute.</attribute>

    <command source="client" code="0x00" name="Command" optional="false">
      <description>Test command.</description>
    </command>
  </cluster>
</configurator>

and I added it through the ZCL extension in my zap tool. It loads, and I can see my cluster:

I can now select my attribute, command, and save.

However, when generating the resulting code I get an error:

Error: group_id not found.
    at enhancedItem (/snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js)
    at /snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js
    at Array.forEach (<anonymous>)
    at /snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js
    at Array.forEach (<anonymous>)
    at enhancedCommands (/snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js)
    at Object.init (/snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js)
Error: group_id not found.
    at enhancedItem (/snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js)
    at /snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js
    at Array.forEach (<anonymous>)
    at /snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js
    at Array.forEach (<anonymous>)
    at enhancedCommands (/snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js)
    at Object.init (/snapshot/zap/dist/src-electron/generator/matter/app/zap-templates/common/ClustersHelper.js)

So how does one add a custom cluster to a device? The documentation does not seem to mention anything outside already defined clusters.

Kind regards and thanks

-Alex

[Axel Schlueter]

Hi  abollaert, did you end up solving this problem somehow?

I'm running into exactly the same issue with my custom cluster. Adding my XML file and its path to the zcl.json didn't help, I'm still getting the group_id error message (and having to add it shouldn't be necessary in the first place since the ZCL tool encodes the path to the custom extension XML into the Zap file).

I guess it's a limitation of the generate.py script, but before I do a deep-dive into that one I'm curious if there's an easier solution. 

[abollaert]

I haven't looked further into this no, planning on tackling it the next couple of weeks when I have some time since a lot of people are on vacation.