Cannot run ZAP tool

RE: Cannot run ZAP tool

Chris Boyer — Thu, 06 Jul 2023 13:57:36 GMT

Hi Vidar,

I'm having this same issue. Your solutions up until here have worked, but nothing I've done has allowed me to see the matter clusters in the ZAP tool. When I open the template.zap file located at /opt/nordic/ncs/v2.4.0/nrf/samples/matter/lock/src/lock.zap This is all I see:

I see the same thing if I open the zap file in my project.

RE: Cannot run ZAP tool

Dan — Tue, 16 May 2023 21:34:46 GMT

Bless you Vidar Berg - this worked! To the Nordic team: hopefully the scripts or the documentation can be updated - it would save a lot of time/frustration. Thanks! Dan.

RE: Cannot run ZAP tool

filipmrazek — Tue, 16 May 2023 18:56:50 GMT

Okay, my project was outside `/opt/nordic/ncs/v2.3.0`.
I generated environment script with toolchain manager, executed the script and finally I see available matter clusters!
Thank you for your time.

RE: Cannot run ZAP tool

Vidar Berg — Tue, 16 May 2023 18:28:30 GMT

Good to hear that it worked. Are you opening the terminal via the toolchain manager? This will ensure that the necessary env. variables are exported/set.

RE: Cannot run ZAP tool

filipmrazek — Tue, 16 May 2023 18:24:46 GMT

Hi Vidar,

thanks for your answer. I followed your instructions and it looks zap tool works!
Unfortunately when opening zap tool with
```
zap src/template.zap
```
in my project folder I cannot add any matter endpoint. Is there any extension which I should add to see Matter clusters?

RE: Cannot run ZAP tool

Vidar Berg — Tue, 16 May 2023 18:08:30 GMT

I had another private ticket related to the same issue, and I discovered that I had to extract the zip manually instead of using the Python script for some reason:

"I was finally able to reproduce the same error here, and it appears to be related to how the zip file is being extracted by the Python script.

Please change the directory to /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path in the terminal and delete the existing files and folders before running this command.

"wget github.com/.../zap-mac.zip && unzip -d zap-mac zap-mac.zip && ../../../../nrf/samples/matter/sensor/src/template."

After the zip is downloaded and extracted, make sure that both /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/MacOS/ and /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/ are added to PATH.

I have reported this as a bug internally. It seems like only macOS is affected by this.

RE: Cannot run ZAP tool

filipmrazek — Tue, 16 May 2023 17:25:38 GMT

Hi Dan,

I've exactly the same problem. The same procedure, the same result. Also tried to download release from chip github, but I don't see matter products when adding endpoint 0.

RE: Cannot run ZAP tool

Dan — Mon, 15 May 2023 23:56:06 GMT

Hi Amanda - thanks for getting back to me so quickly on this - much appreciated.

Your suggestion did work and allowed the script to complete properly. However, I am still unable to run the zap script. I am on an Apple M1 Max.

me@MacBook-Pro matter % python3 scripts/setup/nrfconnect/get_zap.py -l location_path -o
No ZAP tool version was found installed on this device.
Trying to download ZAP tool package matching your system and recommended version.
Downloading https://github.com/project-chip/zap/releases/download/v2022.12.20-nightly/zap-mac.zip into /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac.zip
100% [..................................................] 249937313 / 249937313
Deleting zip file: /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac.zip
ZAP tool package was downloaded and extracted in the given location.
#########################################################################################################################
# Please add the following location to the system PATH: /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac #
#########################################################################################################################

me@MacBook-Pro matter % nano ~/.bash_profile 
me@MacBook-Pro matter % source ~/.bash_profile 
me@MacBook-Pro matter % zap ~/dev/nordic/template.v.2.1.0/src/template.zap
 
zsh: command not found: zap

me@MacBook-Pro matter % /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap
zsh: no such file or directory: /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap

me@MacBook-Pro matter % /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/MacOS/zap 
dyld[66554]: Library not loaded: @rpath/Electron Framework.framework/Electron Framework
  Referenced from: <4C4C44DA-5555-3144-A10D-1E87A10EA9F8> /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/MacOS/zap
  Reason: tried: '/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/Frameworks/Electron Framework.framework/Electron Framework' (not a mach-o file), '/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/Frameworks/Electron Framework.framework/Electron Framework' (not a mach-o file), '/System/Volumes/Preboot/Cryptexes/OS@rpath/Electron Framework.framework/Electron Framework' (no such file), '/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/Frameworks/Electron Framework.framework/Electron Framework' (not a mach-o file), '/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap.app/Contents/Frameworks/Electron Framework.framework/Electron Framework' (not a mach-o file), '/Library/Frameworks/Electron Framework.framework/Electron Framework' (no such file), '/System/Library/Frameworks/Electron Framework.framework/Electron Framework' (no such file, not in dyld cache)
zsh: abort      
me@MacBook-Pro matter % /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap-cli
🔧 Using state directory: /Users/me/.zap
{
  url: 'http://localhost:9070',
  version: '2022.12.20',
  featureLevel: 89,
  hash: '77fd67f73a927468033f58710333ba33823beb04',
  timestamp: 1671576409,
  date: '2022-12-20T22:46:49.000Z',
  exe: '/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap-cli'
}
-- JSON START --
{"url":"http://localhost:9070","version":"2022.12.20","featureLevel":89,"hash":"77fd67f73a927468033f58710333ba33823beb04","timestamp":1671576409,"date":"2022-12-20T22:46:49.000Z","exe":"/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap-cli"}
-- JSON END --
^C
me@MacBook-Pro matter % /opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap-cli ~/dev/nordic/template.v.2.1.0/src/template.zap
🔧 Using state directory: /Users/me/.zap
{
  url: 'http://localhost:9070',
  version: '2022.12.20',
  featureLevel: 89,
  hash: '77fd67f73a927468033f58710333ba33823beb04',
  timestamp: 1671576409,
  date: '2022-12-20T22:46:49.000Z',
  exe: '/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap-cli'
}
-- JSON START --
{"url":"http://localhost:9070","version":"2022.12.20","featureLevel":89,"hash":"77fd67f73a927468033f58710333ba33823beb04","timestamp":1671576409,"date":"2022-12-20T22:46:49.000Z","exe":"/opt/nordic/ncs/v2.3.0/modules/lib/matter/location_path/zap-mac/zap-cli"}
-- JSON END --

[this does not launch the electron browser; 
if I use chrome to go to:http://localhost:9070
I do get the ZAP tool interface, but cannot load or see the template.zap file]

Separately, it seems like either the scripts or the documentation should be corrected to deal with some of the issues that came up (e.g. despite going through the automated toolchain setup, python path was not correct, wget wasn't installed etc).

Welcome your further guidance on how I can edit the template.zap file on an M1 Mac with the v.2.3.0 of the SDK.

Thanks! Dan.

RE: Cannot run ZAP tool

Amanda Hsieh — Mon, 15 May 2023 13:15:36 GMT

Hi,

Please try to replace https://github.com/nrfconnect/sdk-connectedhomeip/blob/v2.3.0/scripts/setup/nrfconnect/get_zap.py#L121 with

zap_executable = 'zap.app/Contents/MacOS/zap'

Guess that should fix the problem.

Regards,
Amanda H.