ZCL Advanced Platform (ZAP)

Stay organized with collections Save and categorize content based on your preferences.

ZCL Advanced Platform (ZAP) is a node.js template engine that's based on Matter Clusters.

ZAP provides the following features for Matter apps and SDKs:

  • Configure Matter Endpoints, Clusters, Attributes, and other device features from a GUI interface.
  • Create templates that automatically generate Data Model definitions, callbacks, and other Matter source code.
  • Create and use preconfigured ZAP files to include with your SDKs.
ZAP Tool


ZAP is included in the Matter repo (connectedhomeip), available in the third_party/zap directory. You can also install ZAP directly from the ZAP repo (zap).

To install ZAP, complete the following steps:

  1. Install Node Version Manager (nvm).

    Install nvm

  2. Using nvm, install node v16.13.2.

    $ nvm install 16.13.2
  3. Install the prerequisites for your operating system. For more information, refer to the ZAP FAQ.

  4. Navigate to the ZAP repository folder and install the Node dependencies.

    $ cd third_party/zap/repo
    $ npm install folder-hash
    $ npm install


To run ZAP, you'll need to choose a ZAP file (.zap) from one of the Matter examples. A ZAP file is a JSON template that defines Endpoints, Commands, Attributes, and other device features. For example, lighting-app.zap in connectedhomeip/examples/lighting-app/lighting-common.

If you'd like to explore various Cluster configurations, you can use all-clusters-app.zap in connectedhomeip/examples/all-clusters-app/all-clusters-common. all-clusters-app.zap is preconfigured with common Matter Clusters and three Endpoints, including a Matter Secondary Network Commissioning Device Type.

To run ZAP from third_party/zap/repo:

$ ../../../scripts/tools/zap/run_zaptool.sh \

To run ZAP from the Matter connectedhomeip repo:

$ scripts/tools/zap/run_zaptool.sh \

This launches the ZAP GUI with preconfigured Endpoints and Clusters.

Set up

To configure the ZAP GUI, click settings from the ZCL menu.

From Global Options, you can select your Product Manufacturer and other options, including ZCL extensions.

ZAP Global Options



The lighting-app.zap file is preconfigured with a Matter Root Node (Endpoint - 0) and a Matter Dimmable Light (Endpoint - 1).

Endpoint - 0 includes general Clusters that are relevant to the entire node, for example Networking, Commissioning, Descriptor, Operational Credentials, and OTA Clusters.

ZAP Endpoint 0

In the next steps, you'll review and configure Endpoint - 1 Matter Dimmable Light from the example lighting-app.

  1. From the Matter repo connectedhomeip, run ZAP.

    $ scripts/tools/zap/run_zaptool.sh \
  2. Click Endpoint - 1, then EDIT.

  3. Optional: Matter supports various device types. In the Device dropdown, start typing matter to change your device, then click SAVE.

    ZAP Select Device

To learn more, refer to Devices and Endpoints in the Matter Primer.


Predefined Clusters, Attributes, and Reporting options are enabled in Endpoint - 1 by default.

To display only enabled Clusters, click Endpoint - 1 and select Enabled Clusters from the Show menu. You can also search clusters by name, for example on.

ZAP Enabled Clusters

To enable any Cluster as Client, Server or Client & Server, use the Enable dropdown. You can also select Not Enabled to disable a preconfigured Cluster that doesn't apply to your device type.

ZAP Disable Cluster

To learn more, refer to Clusters in the Matter Primer.

Attributes and Commands

To configure Attributes and Commands, complete the following steps:

  1. Locate the On/Off Cluster.
  2. From Configure, click the settings icon .

    ZAP Configure

Here you can enable or disable Attributes, set various Attribute options, and Search attributes by name.

ZAP Attributes

Click COMMANDS to configure actions for this Cluster. For example, the On/off Cluster for a light will include On, Off, and Toggle commands. Some Clusters, like the Temperature Measurement Cluster, might not have any associated Commands.

ZAP Commands

To learn more, refer to Attributes and Commands in the Matter Primer.

Generate ZAP source files

Matter examples use ZAP generated source code, available in the connectedhomeip/zzz_generated directory. Some files are app-specific, while other generic ZAP files are grouped in app-common.

#include <app-common/zap-generated/ids/Attributes.h>
#include <app-common/zap-generated/ids/Clusters.h>

Once your Endpoints are configured, you can generate source files to integrate into your project.

  1. Click GENERATE....
  2. Select a folder to save the ZAP output. For example, navigate to connectedhomeip/zzz_generated/lighting-app/zap-generated for the lighting-app.
  3. Optional. Open the files in your preferred IDE.

ZAP generates defines, functions, and other source code that's custom to your device type and ZAP configuration.

ZAP Generated Files

For example, callback-stub.cpp includes a Cluster callback method that includes only the Cluster's that you've enabled:

void emberAfClusterInitCallback(EndpointId endpoint, ClusterId clusterId)
    switch (clusterId)

Use ZAP source files

Common ZAP source files, for example Attributes.h in zzz_generated/app-common/app-common/zap-generated/ids/, can be used to get and set device type Attributes:


namespace DeviceTemperatureConfiguration {
  namespace Attributes {

  namespace CurrentTemperature {
    static constexpr AttributeId Id = 0x00000000;
    } // namespace CurrentTemperature


  } // namespace Attributes
} // namespace DeviceTemperatureConfiguration


#include <app-common/zap-generated/att-storage.h>
#include <app-common/zap-generated/attribute-id.h>
#include <app-common/zap-generated/attribute-type.h>
#include <app-common/zap-generated/attributes/Accessors.h>
#include <app-common/zap-generated/callback.h>
#include <app-common/zap-generated/cluster-id.h>
#include <app-common/zap-generated/cluster-objects.h>
#include <app-common/zap-generated/command-id.h>

using namespace ::chip;
using namespace ::chip::app::Clusters;

static void InitServer(intptr_t context)

    // Sets temperature to 20C
    int16_t temperature = 2000;
    auto status         = DeviceTemperatureConfiguration::Attributes::CurrentTemperature::Set(1, temperature);
    if (status != EMBER_ZCL_STATUS_SUCCESS)
        ChipLogError(Shell, "Temp measurement set failed");

Once you understand how ZAP files can be used in Matter source code, there are several ways that you can integrate ZAP:

  • Use the existing zzz_generated files to create new examples, unique to your device types.
  • Create custom .zap files for your projects.


ZAP files are generated from ZAP templates. When you use run_zaptool.sh to launch ZAP, this script passes in the following templates:

node src-script/zap-start.js --logToStdout \
    --gen "$CHIP_ROOT/src/app/zap-templates/app-templates.json" \
    --zcl "$CHIP_ROOT/src/app/zap-templates/zcl/zcl.json" \

templates.json defines the Matter template name and corresponding output file used in Matter examples.

    "path": "templates/app/callback-stub-src.zapt",
    "name": "ZCL callback-stub source",
    "output": "callback-stub.cpp"

To customize your Matter solutions, there are several next steps that you can take when working with ZAP:


For additional ZAP resources, refer to the ZAP repo (zap) on GitHub.