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

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

AHaug — Thu, 08 May 2025 12:43:38 GMT

Hi Rahul,

Looks like the tool complains about multiple things,

Application is failing the Device Type Specification as follows:

- Check Device Type Compliance on endpoint: 0, device type: MA-rootdevice, cluster: Localization Configuration, attribute: ActiveLocale needs to be enabled
- Check Device Type Compliance on endpoint: 0, device type: MA-rootdevice, cluster: Localization Configuration, attribute: SupportedLocales needs to be enabled

Length of your custom struct:

Application is failing the Cluster Specification as follows:
using output destination: /home/rahul/nrf/template_bh/src/default_zap/zap-generated
🕐 File loading time: 520ms
Error in endpoint_config helper: ERROR: Unknown size for non-external attribute: MyStructAttribute / 4293984257

Reading the zap-generated endpoint.config.h

️ Errors:
/home/rahul/nrf/template_bh/src/default_zap/zap-generated/endpoint_config.h: ⛔ TypeError: Cannot read properties of undefined (reading 'toHTML')

Are you able to resolve these errors? I assume they refer to your configurations of your custom clusters that's causing htis

Kind regards,
Andreas

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

rahul@123 — Thu, 08 May 2025 05:56:32 GMT

Hi AHaug ,

I am able to add custom cluster with one boolean attribute in matter template application. The XML file generated through "nRF Connect Matter Manufacturer Cluster Editor tool" is buggy, I have to fix that manually. After that I have to add stub call back function in the zcl_callbacks.cpp file as I was getting undefined reference error.

I want to add attribute with struct type in my custom cluster. Through the editor tool it is not generating data in XML file. So I have manually added data in XML file which I don't know correct or not.

My structure type:

struct MyStruct

{

uint8_t width;

uint8_t length;

uint8_t height;

};

My XML File:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configurator>

   <struct name="MyStruct" isFabricScoped="true">
      <cluster code="0xFFF1FC01"/>
      <item fieldId="1" name="width" type="int8u" min="0" max="10" isFabricSensitive="true"/>
      <item fieldId="2" name="length" type="int8u" min="0" max="10" isFabricSensitive="true"/>
      <item fieldId="3" name="height" type="int8u" min="0" max="10" isFabricSensitive="true"/>
   </struct>

   <cluster>
      <domain>General</domain>
      <name>Mangoe</name>
      <code>0xFFF1FC01</code>
      <define>MANGOE</define>
      <description>The MyNewCluster cluster showcases a cluster manufacturer extensions</description>

      <attribute side="server" code="0xFFF10000" define="MY_ATTRIBUTE" type="boolean" writable="true" default="false" optional="false">MyAttribute</attribute>

      <attribute side="server" code="0xFFF10001" define="MY_STRUCT_ATTRIBUTE" type="MyStruct" length="1" writable="true" optional="false">MyStructAttribute</attribute>

      <command source="client" code="0xFFF10000" name="MyCommand" optional="false">
         <description>Command that takes two uint8 arguments and returns their sum.</description>
         <arg name="arg1" type="int8u"/>
         <arg name="arg2" type="int8u"/>
      </command>

      <event side="server" code="0xFFF10000" name="MyEvent" priority="info" optional="false">
         <description>Event that is generated by the server.</description>
         <arg name="arg1" type="int8u"/>
      </event>
   </cluster>

</configurator>

zap-gui command works fine, I am able to see my cluster and attribute in the gui tool.

west zap-gui -j zcl.json --cluster ./MyCluster.xml

After that west zap-generate --full failed with below error:

rahul@rahul-H510M-H-V2:~/nrf/template_bh$ west zap-generate --full
ZAP installation directory: /home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install
Found ZAP 2024.8.14 (up to date)
Searching for zcl file from /home/rahul/nrf/template_bh/src/default_zap/template.zap
🔧 Using temporary state directory: /tmp/zapb5bbfdmw/zap.jK6eJ7
🤖 ZAP generation started:
    🔍 input files: /home/rahul/nrf/template_bh/src/default_zap/template.zap
    🔍 output pattern: /home/rahul/nrf/template_bh/src/default_zap/zap-generated
    🔍 using templates: /home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json
    🔍 using zcl data: /home/rahul/nrf/template_bh/zcl.json
    🔍 zap version: ver. 2024.8.14, featureLevel 103, commit: dca1ad01b8affd07eae1a6ca23afc284067c151c from 2024-08-14T15:52:25.000Z, mode: binary, exe: /home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/zap-cli
🕐 Setup time: 14s 91ms 
👉 using input file: /home/rahul/nrf/template_bh/src/default_zap/template.zap


🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨

Application is failing the Device Type Specification as follows: 

  - ⚠ Check Device Type Compliance on endpoint: 0, device type: MA-rootdevice, cluster: Localization Configuration, attribute: ActiveLocale needs to be enabled
  - ⚠ Check Device Type Compliance on endpoint: 0, device type: MA-rootdevice, cluster: Localization Configuration, attribute: SupportedLocales needs to be enabled

Application is failing the Cluster Specification as follows: 


🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨


👉 using output destination: /home/rahul/nrf/template_bh/src/default_zap/zap-generated
🕐 File loading time: 520ms
Error in endpoint_config helper: ERROR: Unknown size for non-external attribute: MyStructAttribute / 4293984257
🤖 Generating files:
    ✍  /home/rahul/nrf/template_bh/src/default_zap/zap-generated/callback-stub.cpp
    ✍  /home/rahul/nrf/template_bh/src/default_zap/zap-generated/gen_config.h
    ✍  /home/rahul/nrf/template_bh/src/default_zap/zap-generated/IMClusterCommandHandler.cpp
    ✍  /home/rahul/nrf/template_bh/src/default_zap/zap-generated/PluginApplicationCallbacks.h
    ✍  /home/rahul/nrf/template_bh/src/default_zap/zap-generated/access.h
⚠️  Errors:
    👎  /home/rahul/nrf/template_bh/src/default_zap/zap-generated/endpoint_config.h: ⛔ TypeError: Cannot read properties of undefined (reading 'toHTML')
Stack trace:

TypeError: Cannot read properties of undefined (reading 'toHTML')
    at replacePlaceholdersRecursivelyIn (/snapshot/zap/node_modules/promised-handlebars/lib/markers.js:96:31)
    at /snapshot/zap/node_modules/promised-handlebars/lib/markers.js:106:22
    at /snapshot/zap/node_modules/promised-handlebars/lib/replaceP.js:44:47
    at String.replace (<anonymous>)
    at replaceP (/snapshot/zap/node_modules/promised-handlebars/lib/replaceP.js:37:14)
    at replacePlaceholdersRecursivelyIn (/snapshot/zap/node_modules/promised-handlebars/lib/markers.js:102:20)
    at /snapshot/zap/node_modules/promised-handlebars/lib/markers.js:111:18
    at produceContent (/snapshot/zap/dist/src-electron/generator/template-engine.js:152:19)
    at generateSingleTemplate (/snapshot/zap/dist/src-electron/generator/generation-engine.js:540:27)
    at async Promise.all (index 5)
🕐 Generation time: 335ms 
{"endpoint_config.h":{}}
Error: Generation failed: /home/rahul/nrf/template_bh/src/default_zap/template.zap
    at generateSingleFile (/snapshot/zap/dist/src-electron/main-process/startup.js:496:19)
    at startGeneration (/snapshot/zap/dist/src-electron/main-process/startup.js:551:5)
Zap generation error: Error: Generation failed: /home/rahul/nrf/template_bh/src/default_zap/template.zap
Traceback (most recent call last):
  File "/home/rahul/ncs/v3.0.0/modules/lib/matter/scripts/tools/zap/generate.py", line 404, in <module>
    main()
  File "/home/rahul/ncs/v3.0.0/modules/lib/matter/scripts/tools/zap/generate.py", line 382, in main
    runGeneration(cmdLineArgs)
  File "/home/rahul/ncs/v3.0.0/modules/lib/matter/scripts/tools/zap/generate.py", line 240, in runGeneration
    tool.run('generate', *args)
  File "/home/rahul/ncs/v3.0.0/modules/lib/matter/scripts/tools/zap/zap_execution.py", line 109, in run
    subprocess.check_call(
  File "/home/rahul/ncs/toolchains/7cbc0036f4/usr/local/lib/python3.12/subprocess.py", line 413, in check_call
    raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/zap-cli', 'generate', '-z', '/home/rahul/nrf/template_bh/zcl.json', '-g', '/home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json', '-o', '/home/rahul/nrf/template_bh/src/default_zap/zap-generated', '-i', '/home/rahul/nrf/template_bh/src/default_zap/template.zap', '--tempState']' returned non-zero exit status 1.
FATAL ERROR: command exited with status 1: /home/rahul/ncs/toolchains/7cbc0036f4/usr/local/bin/python3.12 /home/rahul/ncs/v3.0.0/modules/lib/matter/scripts/tools/zap/generate.py /home/rahul/nrf/template_bh/src/default_zap/template.zap -o /home/rahul/nrf/template_bh/src/default_zap/zap-generated -t /home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json
rahul@rahul-H510M-H-V2:~/nrf/template_bh$

Can you please provide some guidance here.

NCS version: v3.0.0

Board: nrf54l15dk

BR,

Rahul

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

AHaug — Mon, 05 May 2025 10:42:48 GMT

Hi Rahul,

Has anything changed on your end since last week? If not, could you try to follow the steps that resolved this case Failedto customize Cluster as per document ?

Kind regards,
Andreas

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

rahul@123 — Tue, 29 Apr 2025 12:00:11 GMT

Hi AHaug ,

I am trying to open zap-gui tool for manufacturer_specific sample using below command

west zap-gui -j ./src/default_zap/zcl.json

but getting below error

Errro:

rahul@rahul-H510M-H-V2:~/nrf/manufacturer_specific$ west zap-gui -j ./src/default_zap/zcl.json
Using ZAP file: /home/rahul/nrf/manufacturer_specific/src/default_zap/manufacturer_specific.zap
Using ZCL file: /home/rahul/nrf/manufacturer_specific/src/default_zap/zcl.json
Using app templates: /home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json
ZAP installation directory: /home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install
Found ZAP 2024.8.14 (up to date)
🔧 Using temporary state directory: /tmp/zap.Ax6DuA
[121749:0429/172609.960302:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
[121749:0429/172609.960336:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
[121749:0429/172609.960346:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
[121749:0429/172609.960353:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
Xlib:  extension "NV-GLX" missing on display ":0".
[121781:0429/172610.066499:ERROR:viz_main_impl.cc(196)] Exiting GPU process due to errors during initialization
Xlib:  extension "NV-GLX" missing on display ":0".
Error: 

Unknown cluster "Access Control" in attributeAccessInterfaceAttributes


    at loadZclJsonOrProperties (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/zcl/zcl-loader-silabs.js:2066:27)
    at loadZclMetaFilesCommon (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/zcl/zcl-loader.js:63:19)
    at Object.loadZclMetafiles (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/zcl/zcl-loader.js:150:28)
    at startNormal (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/main-process/startup.js:62:9)
    at Object.startUpMainInstance (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/main-process/startup.js:744:20)
FATAL ERROR: Error::ThrowAsJavaScriptException napi_throw
FATAL ERROR: command exited with status -6: /home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/zap /home/rahul/nrf/manufacturer_specific/src/default_zap/manufacturer_specific.zap --zcl /home/rahul/nrf/manufacturer_specific/src/default_zap/zcl.json --gen /home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json --tempState
rahul@rahul-H510M-H-V2:~/nrf/manufacturer_specific$

We will try with the template sample if its working for it or not.

BR,

Rahul

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

AHaug — Mon, 28 Apr 2025 13:50:50 GMT

Hi,

Both me and several of my colleagues have tried to reproduce the issue without any success. Here's the following steps we've used

cd nrf/samples/template
Copy MyCluster.xml content from step 2 of the mentioned guide into a new file in the Template sample directory.
west zap-gui -j ./zcl.json --clusters ./MyCluster.xml

Could you triple check that you've followed these exact steps?

Kind regards,
Andreas

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

Bhavya Mathukiya — Mon, 28 Apr 2025 12:46:26 GMT

Sure AHaug

here it is

zcl.json

{
    "description": "Matter SDK ZCL data",
    "category": "matter",
    "version": 1,
    "requiredFeatureLevel": 102,
    "xmlRoot": [
        "../../ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/zcl",
        "../../ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/zcl/data-model/chip",
        "../../ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/zcl/data-model/silabs",
        "src/default_zap"
    ],
    "_comment": "Ensure access-control-definitions.xml is first in xmlFile array",
    "xmlFile": [
        "access-control-definitions.xml",
        "chip-types.xml",
        "access-control-cluster.xml",
        "account-login-cluster.xml",
        "administrator-commissioning-cluster.xml",
        "air-quality-cluster.xml",
        "application-basic-cluster.xml",
        "application-launcher-cluster.xml",
        "audio-output-cluster.xml",
        "ballast-configuration-cluster.xml",
        "basic-information-cluster.xml",
        "binding-cluster.xml",
        "boolean-state-cluster.xml",
        "boolean-state-configuration-cluster.xml",
        "actions-cluster.xml",
        "bridged-device-basic-information.xml",
        "chime-cluster.xml",
        "chip-ota.xml",
        "channel-cluster.xml",
        "clusters-extensions.xml",
        "color-control-cluster.xml",
        "commissioner-control-cluster.xml",
        "concentration-measurement-cluster.xml",
        "content-launch-cluster.xml",
        "content-app-observer-cluster.xml",
        "content-control-cluster.xml",
        "descriptor-cluster.xml",
        "device-energy-management-cluster.xml",
        "device-energy-management-mode-cluster.xml",
        "diagnostic-logs-cluster.xml",
        "dishwasher-alarm-cluster.xml",
        "dishwasher-mode-cluster.xml",
        "microwave-oven-mode-cluster.xml",
        "door-lock-cluster.xml",
        "drlc-cluster.xml",
        "ecosystem-information-cluster.xml",
        "electrical-energy-measurement-cluster.xml",
        "electrical-power-measurement-cluster.xml",
        "energy-evse-cluster.xml",
        "energy-evse-mode-cluster.xml",
        "energy-preference-cluster.xml",
        "ethernet-network-diagnostics-cluster.xml",
        "fan-control-cluster.xml",
        "fault-injection-cluster.xml",
        "fixed-label-cluster.xml",
        "flow-measurement-cluster.xml",
        "general-commissioning-cluster.xml",
        "general-diagnostics-cluster.xml",
        "global-attributes.xml",
        "global-bitmaps.xml",
        "global-enums.xml",
        "global-structs.xml",
        "groups-cluster.xml",
        "group-key-mgmt-cluster.xml",
        "icd-management-cluster.xml",
        "identify-cluster.xml",
        "illuminance-measurement-cluster.xml",
        "keypad-input-cluster.xml",
        "laundry-washer-mode-cluster.xml",
        "laundry-dryer-controls-cluster.xml",
        "level-control-cluster.xml",
        "localization-configuration-cluster.xml",
        "low-power-cluster.xml",
        "measurement-and-sensing.xml",
        "media-input-cluster.xml",
        "media-playback-cluster.xml",
        "messages-cluster.xml",
        "mode-base-cluster.xml",
        "mode-select-cluster.xml",
        "semantic-tag-namespace-enums.xml",
        "network-commissioning-cluster.xml",
        "occupancy-sensing-cluster.xml",
        "onoff-cluster.xml",
        "operational-credentials-cluster.xml",
        "operational-state-cluster.xml",
        "operational-state-oven-cluster.xml",
        "operational-state-rvc-cluster.xml",
        "oven-mode-cluster.xml",
        "power-topology-cluster.xml",
        "pressure-measurement-cluster.xml",
        "power-source-cluster.xml",
        "power-source-configuration-cluster.xml",
        "proxy-configuration-cluster.xml",
        "proxy-discovery-cluster.xml",
        "proxy-valid-cluster.xml",
        "pump-configuration-and-control-cluster.xml",
        "pwm-cluster.xml",
        "refrigerator-and-temperature-controlled-cabinet-mode-cluster.xml",
        "refrigerator-alarm.xml",
        "relative-humidity-measurement-cluster.xml",
        "rvc-clean-mode-cluster.xml ",
        "rvc-run-mode-cluster.xml",
        "replacable-monitoring-cluster.xml",
        "resource-monitoring-cluster.xml",
        "scene.xml",
        "service-area-cluster.xml",
        "smoke-co-alarm-cluster.xml",
        "software-diagnostics-cluster.xml",
        "switch-cluster.xml",
        "target-navigator-cluster.xml",
        "temperature-control-cluster.xml",
        "microwave-oven-control-cluster.xml",
        "temperature-measurement-cluster.xml",
        "test-cluster.xml",
        "thermostat-cluster.xml",
        "thermostat-user-interface-configuration-cluster.xml",
        "thread-border-router-management-cluster.xml",
        "thread-network-diagnostics-cluster.xml",
        "thread-network-directory-cluster.xml",
        "time-format-localization-cluster.xml",
        "time-synchronization-cluster.xml",
        "timer-cluster.xml",
        "user-label-cluster.xml",
        "unit-localization-cluster.xml",
        "valve-configuration-and-control-cluster.xml",
        "wake-on-lan-cluster.xml",
        "washer-controls-cluster.xml",
        "water-heater-management-cluster.xml",
        "water-heater-mode-cluster.xml",
        "webrtc-provider-cluster.xml",
        "wifi-network-diagnostics-cluster.xml",
        "wifi-network-management-cluster.xml",
        "window-covering.xml",
        "matter-devices.xml",
        "sample-mei-cluster.xml",
        "types/door-lock.xml",
        "types/occupancy-sensing.xml",
        "types/thermostat-user-interface-configuration.xml",
        "MyCluster.xml"
    ],
    "manufacturersXml": "../../ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/zcl/data-model/manufacturers.xml",
    "options": {
        "text": {
            "defaultResponsePolicy": [
                "Always",
                "Conditional",
                "Never"
            ]
        },
        "bool": [
            "commandDiscovery"
        ]
    },
    "defaults": {
        "text": {
            "manufacturerCodes": "0x1002",
            "defaultResponsePolicy": "always"
        },
        "bool": {
            "commandDiscovery": true
        }
    },
    "listsUseAttributeAccessInterface": true,
    "attributeAccessInterfaceAttributes": {
        "Access Control": [
            "ClusterRevision",
            "SubjectsPerAccessControlEntry",
            "TargetsPerAccessControlEntry",
            "AccessControlEntriesPerFabric"
        ],
        "Administrator Commissioning": [
            "WindowStatus",
            "AdminFabricIndex",
            "AdminVendorId"
        ],
        "Basic Information": [
            "DataModelRevision",
            "VendorName",
            "VendorID",
            "ProductName",
            "ProductID",
            "Location",
            "HardwareVersion",
            "HardwareVersionString",
            "SoftwareVersion",
            "SoftwareVersionString",
            "ManufacturingDate",
            "PartNumber",
            "ProductURL",
            "ProductLabel",
            "SerialNumber",
            "UniqueID",
            "CapabilityMinima",
            "ProductAppearance",
            "SpecificationVersion",
            "MaxPathsPerInvoke"
        ],
        "Bridged Device Basic Information": [
            "ProductAppearance"
        ],
        "Descriptor": [
            "ClusterRevision",
            "FeatureMap"
        ],
        "Device Energy Management": [
            "ESAType",
            "ESACanGenerate",
            "ESAState",
            "AbsMinPower",
            "AbsMaxPower",
            "PowerAdjustmentCapability",
            "Forecast",
            "OptOutState",
            "FeatureMap"
        ],
        "Device Energy Management Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Door Lock": [
            "AliroReaderVerificationKey",
            "AliroReaderGroupIdentifier",
            "AliroReaderGroupSubIdentifier",
            "AliroGroupResolvingKey",
            "AliroBLEAdvertisingVersion",
            "NumberOfAliroCredentialIssuerKeysSupported",
            "NumberOfAliroEndpointKeysSupported"
        ],
        "Energy EVSE": [
            "State",
            "SupplyState",
            "FaultState",
            "ChargingEnabledUntil",
            "DischargingEnabledUntil",
            "CircuitCapacity",
            "MinimumChargeCurrent",
            "MaximumChargeCurrent",
            "MaximumDischargeCurrent",
            "UserMaximumChargeCurrent",
            "RandomizationDelayWindow",
            "NextChargeStartTime",
            "NextChargeTargetTime",
            "NextChargeRequiredEnergy",
            "NextChargeTargetSoC",
            "ApproximateEVEfficiency",
            "StateOfCharge",
            "BatteryCapacity",
            "VehicleID",
            "SessionID",
            "SessionDuration",
            "SessionEnergyCharged",
            "SessionEnergyDischarged",
            "FeatureMap"
        ],
        "Energy EVSE Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Ethernet Network Diagnostics": [
            "PHYRate",
            "FullDuplex",
            "CarrierDetect",
            "TimeSinceReset",
            "PacketRxCount",
            "PacketTxCount",
            "TxErrCount",
            "CollisionCount",
            "OverrunCount"
        ],
        "General Commissioning": [
            "RegulatoryConfig",
            "LocationCapability",
            "BasicCommissioningInfo",
            "SupportsConcurrentConnection"
        ],
        "General Diagnostics": [
            "NetworkInterfaces",
            "ActiveHardwareFaults",
            "ActiveRadioFaults",
            "ActiveNetworkFaults",
            "RebootCount",
            "UpTime",
            "TotalOperationalHours",
            "BootReason",
            "FeatureMap",
            "ClusterRevision"
        ],
        "Group Key Management": [
            "ClusterRevision",
            "MaxGroupsPerFabric",
            "MaxGroupKeysPerFabric",
            "FeatureMap"
        ],
        "ICD Management": [
            "IdleModeDuration",
            "ActiveModeDuration",
            "ActiveModeThreshold",
            "RegisteredClients",
            "ICDCounter",
            "ClientsSupportedPerFabric",
            "MaximumCheckInBackOff"
        ],
        "Occupancy Sensing": [
            "HoldTimeLimits",
            "HoldTime",
            "FeatureMap"
        ],
        "Operational Credentials": [
            "SupportedFabrics",
            "CommissionedFabrics",
            "CurrentFabricIndex"
        ],
        "Software Diagnostics": [
            "CurrentHeapFree",
            "CurrentHeapHighWatermark",
            "CurrentHeapUsed",
            "FeatureMap",
            "ThreadMetrics"
        ],
        "Unit Testing": [
            "struct_attr",
            "nullable_struct",
            "general_error_boolean",
            "cluster_error_boolean",
            "global_struct",
            "nullable_global_struct"
        ],
        "Thread Border Router Management": [
            "BorderRouterName",
            "BorderAgentID",
            "ThreadVersion",
            "InterfaceEnabled",
            "ActiveDatasetTimestamp",
            "PendingDatasetTimestamp",
            "FeatureMap"
        ],
        "Thread Network Diagnostics": [
            "Channel",
            "RoutingRole",
            "NetworkName",
            "PanId",
            "ExtendedPanId",
            "MeshLocalPrefix",
            "OverrunCount",
            "PartitionId",
            "Weighting",
            "DataVersion",
            "StableDataVersion",
            "LeaderRouterId",
            "DetachedRoleCount",
            "ChildRoleCount",
            "RouterRoleCount",
            "LeaderRoleCount",
            "AttachAttemptCount",
            "PartitionIdChangeCount",
            "BetterPartitionAttachAttemptCount",
            "ParentChangeCount",
            "TxTotalCount",
            "TxUnicastCount",
            "TxBroadcastCount",
            "TxAckRequestedCount",
            "TxAckedCount",
            "TxNoAckRequestedCount",
            "TxDataCount",
            "TxDataPollCount",
            "TxBeaconCount",
            "TxBeaconRequestCount",
            "TxOtherCount",
            "TxRetryCount",
            "TxDirectMaxRetryExpiryCount",
            "TxIndirectMaxRetryExpiryCount",
            "TxErrCcaCount",
            "TxErrAbortCount",
            "TxErrBusyChannelCount",
            "RxTotalCount",
            "RxUnicastCount",
            "RxBroadcastCount",
            "RxDataCount",
            "RxDataPollCount",
            "RxBeaconCount",
            "RxBeaconRequestCount",
            "RxOtherCount",
            "RxAddressFilteredCount",
            "RxDestAddrFilteredCount",
            "RxDuplicatedCount",
            "RxErrNoFrameCount",
            "RxErrUnknownNeighborCount",
            "RxErrInvalidSrcAddrCount",
            "RxErrSecCount",
            "RxErrFcsCount",
            "RxErrOtherCount",
            "ActiveTimestamp",
            "PendingTimestamp",
            "Delay",
            "SecurityPolicy",
            "ChannelPage0Mask",
            "OperationalDatasetComponents"
        ],
        "Wi-Fi Network Diagnostics": [
            "BSSID",
            "SecurityType",
            "WiFiVersion",
            "ChannelNumber",
            "RSSI",
            "BeaconLostCount",
            "BeaconRxCount",
            "PacketMulticastRxCount",
            "PacketMulticastTxCount",
            "PacketUnicastRxCount",
            "PacketUnicastTxCount",
            "CurrentMaxRate",
            "OverrunCount"
        ],
        "Channel": [
            "Lineup",
            "CurrentChannel"
        ],
        "Media Playback": [
            "SampledPosition",
            "ActiveAudioTrack",
            "ActiveTextTrack"
        ],
        "Application Launcher": [
            "CurrentApp"
        ],
        "Application Basic": [
            "Application"
        ],
        "Time Synchronization": [
            "TrustedTimeSource",
            "DefaultNTP",
            "TimeZone",
            "DSTOffset",
            "UTCTime",
            "LocalTime",
            "Granularity",
            "TimeZoneListMaxSize",
            "DSTOffsetListMaxSize"
        ],
        "Temperature Control": [
            "SupportedTemperatureLevels"
        ],
        "Dishwasher Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Microwave Oven Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Microwave Oven Control": [
            "CookTime",
            "MaxCookTime",
            "PowerSetting",
            "MinPower",
            "MaxPower",
            "PowerStep",
            "SupportedWatts",
            "SelectedWattIndex",
            "WattRating",
            "FeatureMap"
        ],
        "Laundry Washer Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Refrigerator And Temperature Controlled Cabinet Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "RVC Clean Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "RVC Run Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Operational State": [
            "OperationalState",
            "OperationalError",
            "CurrentPhase",
            "CountdownTime"
        ],
        "RVC Operational State": [
            "OperationalState",
            "OperationalError",
            "CurrentPhase",
            "CountdownTime"
        ],
        "Oven Cavity Operational State": [
            "OperationalState",
            "OperationalError",
            "CurrentPhase",
            "CountdownTime"
        ],
        "Activated Carbon Filter Monitoring": [
            "Condition",
            "DegradationDirection",
            "ChangeIndication",
            "InPlaceIndicator",
            "LastChangedTime",
            "ReplacementProductList",
            "FeatureMap"
        ],
        "HEPA Filter Monitoring": [
            "Condition",
            "DegradationDirection",
            "ChangeIndication",
            "InPlaceIndicator",
            "LastChangedTime",
            "ReplacementProductList",
            "FeatureMap"
        ],
        "Carbon Monoxide Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Carbon Dioxide Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Nitrogen Dioxide Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Ozone Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "PM2.5 Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Formaldehyde Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "PM1 Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "PM10 Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Total Volatile Organic Compounds Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Radon Concentration Measurement": [
            "MeasuredValue",
            "MinMeasuredValue",
            "MaxMeasuredValue",
            "PeakMeasuredValue",
            "PeakMeasuredValueWindow",
            "AverageMeasuredValue",
            "AverageMeasuredValueWindow",
            "Uncertainty",
            "MeasurementUnit",
            "MeasurementMedium",
            "LevelValue",
            "FeatureMap"
        ],
        "Air Quality": [
            "AirQuality",
            "FeatureMap"
        ],
        "Electrical Energy Measurement": [
            "Accuracy",
            "CumulativeEnergyImported",
            "CumulativeEnergyExported",
            "PeriodicEnergyImported",
            "PeriodicEnergyExported",
            "CumulativeEnergyReset",
            "FeatureMap"
        ],
        "Electrical Power Measurement": [
            "PowerMode",
            "NumberOfMeasurementTypes",
            "Accuracy",
            "Ranges",
            "Voltage",
            "ActiveCurrent",
            "ReactiveCurrent",
            "ApparentCurrent",
            "ActivePower",
            "ReactivePower",
            "ApparentPower",
            "RMSVoltage",
            "RMSCurrent",
            "RMSPower",
            "Frequency",
            "HarmonicCurrents",
            "HarmonicPhases",
            "PowerFactor",
            "NeutralCurrent",
            "FeatureMap"
        ],
        "Power Topology": [
            "FeatureMap"
        ],
        "Valve Configuration and Control": [
            "RemainingDuration"
        ],
        "Boolean State Configuration": [
            "CurrentSensitivityLevel"
        ],
        "Water Heater Management": [
            "HeaterTypes",
            "HeatDemand",
            "TankVolume",
            "EstimatedHeatRequired",
            "TankPercentage",
            "BoostState",
            "FeatureMap",
            "ClusterRevision"
        ],
        "Water Heater Mode": [
            "SupportedModes",
            "CurrentMode",
            "FeatureMap"
        ],
        "Wi-Fi Network Management": [
            "SSID",
            "PassphraseSurrogate"
        ],
        "Thread Network Directory": [
            "PreferredExtendedPanID",
            "ThreadNetworks",
            "ThreadNetworkTableSize"
        ],
        "Service Area": [
            "CurrentArea",
            "EstimatedEndTime",
            "FeatureMap"
        ]
    },
    "mandatoryDeviceTypes": "0x0016",
    "defaultReportingPolicy": "mandatory",
    "ZCLDataTypes": [
        "ARRAY",
        "BITMAP",
        "ENUM",
        "NUMBER",
        "STRING",
        "STRUCT"
    ],
    "fabricHandling": {
        "automaticallyCreateFields": true,
        "indexFieldId": 254,
        "indexFieldName": "FabricIndex",
        "indexType": "fabric_idx"
    },
    "uiOptions": {
        "showProfileId": false
    }
}

MyCluster.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configurator>
   <cluster>
      <domain>General</domain>
      <name>MyNewCluster</name>
      <code>0xFFF1FC01</code>
      <define>MY_NEW_CLUSTER</define>
      <description>The MyNewCluster cluster showcases a cluster manufacturer extensions</description>
      <attribute side="server" code="0xFFF10000" define="MY_ATTRIBUTE" type="boolean" writable="true" default="false" optional="false">MyAttribute</attribute>
      <command source="client" code="0xFFF10000" name="MyCommand" optional="false">
         <description>Command that takes two uint8 arguments and returns their sum.</description>
         <arg name="arg1" type="int8u"/>
         <arg name="arg2" type="int8u"/>
      </command>
      <event side="server" code="0xFFF10000" name="MyEvent" priority="info" optional="false">
         <description>Event that is generated by the server.</description>
         <arg name="arg1" type="int8u"/>
      </event>
   </cluster>
   <clusterExtension code="0x0028">
      <attribute side="server" code="0x17" define="EXTENDED_ATTRIBUTE" type="boolean" writable="true" default="false" optional="false">ExtendedAttribute</attribute>
      <command source="client" code="0x00" name="ExtendedCommand" response="ExtendedCommandResponse" optional="false">
         <description>Command that takes two uint8 arguments and returns their sum.</description>
         <arg name="arg1" type="int8u"/>
         <arg name="arg2" type="int8u"/>
      </command>
      <event side="server" code="0x04" name="ExtendedEvent" priority="info" optional="false">
         <description>Event that is generated by the server.</description>
         <arg name="arg1" type="int8u"/>
      </event>
   </clusterExtension>
   <enum name="MyNewEnum" type="int8u">
      <cluster code="0xFFF1FC01" />
      <item name="EnumValue1" value="0" />
      <item name="EnumValue2" value="1" />
   </enum>
   <struct name="MyStruct" isFabricScoped="true">
      <cluster code="0xFFF1FC01"/>
      <item fieldId="1" name="Data" type="octet_string" length="128" isFabricSensitive="true"/>
   </struct>
   <deviceType>
      <name>my-new-device</name>
      <domain>CHIP</domain>
      <typeName>My new device</typeName>
      <profileId editable="false">0x0104</profileId>
      <deviceId editable="false">0xfff10001</deviceId>
      <class>Simple</class>
      <scope>Endpoint</scope>
      <clusters lockOthers="true">
         <include cluster="MyNewCluster" client="true" server="true" clientLocked="false" serverLocked="false"/>
      </clusters>
   </deviceType>
</configurator>

BR,

Bhavya

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

AHaug — Mon, 28 Apr 2025 11:54:25 GMT

Could you also share your zcl.json file? I would like to have a look at it and see if it somehow is missing something

Kind regards,
Andreas

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

AHaug — Mon, 28 Apr 2025 11:32:34 GMT

Hi Bhavya,

Noted, thank you for verifying. I will bring it up with the Matter team ASAP

Kind regards,
Andreas

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

Bhavya Mathukiya — Mon, 28 Apr 2025 11:26:00 GMT

Hi AHaug ,

We have tried with the NCS v3.0.0 and it seems like issue is still there. We have even tried to use zap tool with manufacturer_specific sample but we are getting below error. Can you please check with the Matter team?

rahul@rahul-H510M-H-V2:~/nrf/manufacturer_specific$ west zap-gui -j ./src/default_zap/zcl.json --cluster ./src/default_zap/NordicDevKitCluster.xml 
Using ZAP file: /home/rahul/nrf/manufacturer_specific/src/default_zap/manufacturer_specific.zap
Using ZCL file: /home/rahul/nrf/manufacturer_specific/src/default_zap/zcl.json
Using app templates: /home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json
ZAP installation directory: /home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install
Found ZAP 2024.8.14 (up to date)
🔧 Using temporary state directory: /tmp/zap.TkCPEq
[120190:0428/164621.607700:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
[120190:0428/164621.607729:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
[120190:0428/164621.607737:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
[120190:0428/164621.607746:ERROR:bus.cc(407)] Failed to connect to the bus: '=' character not found or has no value following it
Xlib:  extension "NV-GLX" missing on display ":0".
[120236:0428/164621.706817:ERROR:viz_main_impl.cc(196)] Exiting GPU process due to errors during initialization
Xlib:  extension "NV-GLX" missing on display ":0".
Error: 
 
Unknown cluster "Access Control" in attributeAccessInterfaceAttributes
 
 
    at loadZclJsonOrProperties (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/zcl/zcl-loader-silabs.js:2066:27)
    at loadZclMetaFilesCommon (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/zcl/zcl-loader.js:63:19)
    at Object.loadZclMetafiles (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/zcl/zcl-loader.js:150:28)
    at startNormal (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/main-process/startup.js:62:9)
    at Object.startUpMainInstance (/home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/resources/app.asar/dist/src-electron/main-process/startup.js:744:20)
FATAL ERROR: Error::ThrowAsJavaScriptException napi_throw
FATAL ERROR: command exited with status -6: /home/rahul/ncs/v3.0.0/modules/lib/matter/.zap-install/zap /home/rahul/nrf/manufacturer_specific/src/default_zap/manufacturer_specific.zap --zcl /home/rahul/nrf/manufacturer_specific/src/default_zap/zcl.json --gen /home/rahul/ncs/v3.0.0/modules/lib/matter/src/app/zap-templates/app-templates.json --tempState

BR,

Bhavya

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

AHaug — Wed, 23 Apr 2025 12:06:32 GMT

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

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

Rahul_Chauhan — Wed, 23 Apr 2025 05:21:55 GMT

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

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

AHaug — Wed, 16 Apr 2025 15:23:38 GMT

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

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

Rahul_Chauhan — Wed, 16 Apr 2025 12:55:39 GMT

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

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

AHaug — Wed, 16 Apr 2025 12:27:26 GMT

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