Issue Launching ZAP GUI with Custom Cluster in NCS v3.0.0-preview2

[Rahul_Chauhan]

Hello Team,

I’m working on creating a custom Matter cluster using the instructions provided in the Nordic documentation: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/getting_started/custom_clusters.html#ug-matter-creating-custom-cluster

I’m currently using NCS v3.0.0-preview2 and have successfully completed Step 1 using the following command:

1.west zap-append /home/rahul/Downloads/MyCluster.xml \
-b /home/rahul/ncs/v3.0.0-preview2/modules/lib/matter/src/app/zap-templates/zcl/zcl.json \
-o ~/nrf/template/zcl.json

This correctly created the zcl.json file at ~/nrf/template/zcl.json, which includes both standard and my custom cluster.

However, when I proceed to Step 2 and try launching the ZAP GUI with the following command:

cd ~/nrf/template
2.west zap-gui -j ./zcl.json --clusters /home/rahul/Downloads/MyCluster.xml

I encounter an error.

I also tried running just:

west zap-gui -j ./zcl.json

But that also results in an error. Unfortunately, the documentation doesn’t specify what the exact requirements are for this version of NCS, or how to troubleshoot west zap-gui issues.

Could you please help me understand how to resolve this? Is there a known issue with west zap-gui in v3.0.0-preview2, or is there an alternative method I should try?

Please let me know what logs or details would be helpful to share further.

Thanks in advance,
Rahul Chauhan

   

[AHaug]

Hi Rahul,

I see that you're using the preview release of NCS v3.0.0. Unless there is any specific reasons for using the preview release. Could you try by following the documentation for a more stable, fully tagged release such as NCS v2.9.1?

Kind regards,
Andreas

[Rahul_Chauhan]

Hi Andreas,

Thanks again for the suggestion.

I’ve used NCS v2.9.1 before, but it doesn’t support west zap-append or custom Matter clusters—so I moved to the v3.0.0 series.

I tested with:

• v3.0.0-rc1

• v3.0.0-preview1

• v3.0.0-preview2

But I’m still getting this error when launching ZAP or generating output:

This Error show

FATAL ERROR: command exited with status -6: /home/rahul/ncs/v3.0.0-rc1/modules/lib/matter/.zap-install/zap /home/rahul/nrf/template/src/default_zap/template.zap --zcl /home/rahul/ncs/v3.0.0-rc1/modules/lib/matter/src/app/zap-templates/zcl/zcl.json --gen /home/rahul/ncs/v3.0.0-rc1/modules/lib/matter/src/app/zap-templates/app-templates.json --tempState

It seems related to the ZAP environment or how zcl.json and templates are handled in these versions.

Is there a known fix or workaround?

Happy to share logs or files if needed.

Best,
Rahul Chauhan

[AHaug]

Hi,

As of now there are either not a known issue or a work in progress since the sprints to finalize the 3.0.0 full release are still ongoing (if it is not an issue with the installation or conflicting tools on your workstation). It might already be a fix in the works.

I will check in with the Matter team and get back to you after Easter (after the 22nd of April)

Kind regards,
Andreas

[Rahul_Chauhan]

Hi Andreas,

Hope you had a great festival! Just checking in  I’m still stuck trying to make a custom cluster. Any updates from the Matter team?

Thanks,
Rahul Chauhan

[AHaug]

Hi Rahul,

Thank you :)

I just got a verification that NCS v3.0.0 should be fully tagged and released this week (ETA tomorrow, probably in about 24-48h from now). If you could try to perform the setup and replicate the issue with this release that would be the best approach.

Kind regards,
Andreas