ElCap Documentation
 
Loading...
Searching...
No Matches
ZCL Advanced Platform (ZAP)

For SDK versions v2025.10.00 and later, ZAP is managed by ElCap directly. If invoking the command elcap project zap from within a Zigbee project directory that was built with SDK version v2025.10.00 or later, ElCap will download and launch ZAP directly.

Checking ZAP Readiness

To check if ZAP is ready to be used, from within a Zigbee project directory, run:

$ elcap doctor
✅ ZAP version 2025.07.24 must be installed
  • If you see ❌ instead of ✅, follow the steps below to install and configure ZAP.

ZAP Installation for SDK versions earlier than v2025.10.00

If you are using an SDK version earlier than v2025.10.00, you will need to install ZAP manually and configure ElCap to use it. Follow the steps below:

  1. Download ZAP v2025.06.09 from: https://github.com/project-chip/zap/releases/tag/v2025.06.09
  2. Install ZAP for your OS
    • for Linux use the .deb or .rpm installer to install it on your machine
    • for MacOS uncompress the downloaded .zip file and move zap.app to the location of your choice such as /Applications
    • for Windows unzip the downloaded .zip file where you would like ZAP to live
  3. Add ZAP to the elcap configuration using command: elcap config set tools.zap_path path/to/zap/directory
    • Linux example:
      elcap config set tools.zap_path /usr/bin
    • Mac example:
      elcap config set tools.zap_path /Applications/zap-mac-arm64/zap.app/Contents/MacOS
    • Windows example:
      elcap config set tools.zap_path "C:\Users\archb\Programs\zap-win-x64"
    • Confirm its correct by running elcap config:
      $ elcap config
      tools.jlink_path=/usr/bin
      tools.zap_path=/usr/bin
      NOTE: make sure to put quotes around the path if there are any spaces in directory names.
  4. Verify ZAP has been setup correctly using elcap doctor from within a zigbee project.
    • running elcap doctor from inside a Zigbee project directory will allow it to check the ZAP installation.
    • do this by creating a new Zigbee project using elcap new, then navigate to the newly created project directory and run elcap doctor inside of it.
    • NOTE: running doctor outside of a zigbee project directory will NOT check the ZAP installation!
      ~/example_zigbee_project$ elcap doctor
      Checking your environment...
      ✅ elcap config should exist
      ✅ Docker is in your Path
      ✅ The docker daemon should be running
      ✅ JLink v8.40 or newer must be installed
      ✅ ZAP v2025.6.9 must be installed and specified in elcap config
      ✅ J-Link drivers/rules must be installed
      👍 Looks good!
      Stuck?
      Contact support at: https://tridentiot.com/contact-us/
      Or send us an email at: support@tridentiot.com

Running ZAP

From within a zigbee project directory, run:

elcap project zap

See Trident IoT SDK Zigbee Documentation for more details.