ZCL Advanced Platform (ZAP)

Supporting ZAP via elcap is currently done in a similar way to how elcap supports the JLink tools. ZAP will need to be installed on your computer, and the path to the directory in which the ZAP executable lives will need to be added to the elcap config.

ZAP Installation

1. Download ZAP v2025.01.15 from: https://github.com/project-chip/zap/releases/tag/v2025.01.15
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...
     ✅ config.toml should exist
     ✅ Docker should be installed and in your PATH
     ✅ The docker daemon should be running
     ✅ JLink v8.10k or newer must be installed and specified in config.toml
     ✅ ZAP v2025.1.15 must be installed and specified in config.toml
     👍 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.