Build Matter Light Bulb using ZAP auto generated files dynamically

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Tue, 29 Apr 2025 07:30:00 GMT

Hi Chuan,

Some files in the SDK samples were generated with an older version of the ZAP tool, and they are no longer needed, which is why they are not generated when running the ZAP tool in later versions. Since they are no longer needed, they will be removed from the samples.

You can see which files are removed in this commit: https://github.com/nrfconnect/sdk-nrf/commit/22789834d870df307b414d0ddf0dc801541684ca

Best regards,
Marte

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

susepc — Tue, 29 Apr 2025 03:19:55 GMT

Marte Myrvold

Sorry to bother you again: What do old files mean?
“The developers will remove the old files from the SDK.”
BR

Chuan

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Tue, 22 Apr 2025 11:15:16 GMT

Hi Chuan,

I asked the developers about this, and it looks like the files you mentioned were generated with an older version of the ZAP tool and are no longer used. The developers will remove the old files from the SDK.

The developers have also added a --clear argument to zap-generate that removes old files: https://github.com/nrfconnect/sdk-connectedhomeip/pull/599.

Best regards,
Marte

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

susepc — Mon, 21 Apr 2025 09:20:43 GMT

Marte Myrvold

Thanks for your solution, it work well!

Finally, I have another question：

I see there are 9 files in the zap-generated folder, namely:

-> access.h

-> callback-stub.cpp

-> CHIPClientCallbacks.h

-> CHIPClusters.h

-> endpoint_config.h

-> gen_config.h

-> gen_tokens.h

-> IMClusterCommandHandler.cpp

-> PluginApplicationCallbacks.h

But when I use ZCL tool to generate files, only 4 files generate, namely:

-> access.h

-> endpoint_config.h

-> gen_config.h

-> IMClusterCommandHandler.cpp

Can you tell me why cause this difference?

Besides, how can I generate other 5 files?

Chuan

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Wed, 16 Apr 2025 10:15:47 GMT

Hi Chuan,

Yes, I was able to build the light bulb sample on both Windows and Linux when omitting BYPASS_IDL by including the path to the light_bulb.matter IDL file in chip_configure_data_model():

IDL ${CMAKE_CURRENT_SOURCE_DIR}/src/light_bulb.matter

Please note that I have not thoroughly tested the sample, only that it builds.

Best regards,
Marte

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

susepc — Wed, 16 Apr 2025 09:29:42 GMT

Marte Myrvold

Great!

I'll have a try to use 'python' instead of 'python3'.

Besides, can you build light bulb pass even though omit 'BYPASS_IDL'?

Chuan

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Wed, 16 Apr 2025 07:11:45 GMT

Hi Chuan,

It can work by following the steps in one of my previous replies. I got it to work on both Windows and Linux.

For installing zap-cli, you might have to use python instead of python3:

python scripts/setup/nrfconnect/get_zap.py -l <location_path> -o

However, the recommended method is to generate the ZAP tools manually using the west zap generate command.

Best regards,
Marte

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

susepc — Mon, 14 Apr 2025 10:11:19 GMT

Marte Myrvold

Yes, when omit BYPASS_IDL, I'll meet build error too.

So Nordic do not support ZAP auto generate(omit BYPASS_IDL) in the build flow? And user must use zap tool to generate files manually?

Chuan

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Mon, 14 Apr 2025 07:14:31 GMT

Hi,

[quote user="susepc"]What is '<location_path>' ?[/quote]

<location_path> is where you want to install zap-cli.

[quote user="susepc"]When I run this command, there's no result output, is it reasonable?[/quote]

You should get an output showing which version you have installed if it is already installed or an output showing that it gets installed, like this:

You can also see this in Installing the ZAP tool.

Please note that this documentation is from nRF Connect SDK v2.6.2. This is because this is how the ZAP tool was installed previously. From v2.7.0 and on, the ZAP commands are provided as west commands. However, when testing, I found that not having zap-cli installed resulted in errors when trying to generate the files by removing BYPASS_IDL.

Best regards,
Marte

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

susepc — Mon, 14 Apr 2025 06:01:20 GMT

Marte Myrvold

What is '<location_path>' ?

When I run this command, there's no result output, is it reasonable?

@PC21040223 MINGW64 /c/ncs/v2.8.0
$ cd modules/lib/matter/

@PC21040223 MINGW64 /c/ncs/v2.8.0/modules/lib/matter ((v2.8.0))
$ python3 scripts/setup/nrfconnect/get_zap.py -l zap_path -o

@PC21040223 MINGW64 /c/ncs/v2.8.0/modules/lib/matter ((v2.8.0))
$

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Thu, 10 Apr 2025 11:51:03 GMT

Hi Chuan,

When you remove BYPASS_IDL, the chip_configure_data_model() function tries to generate source files from a .matter IDL file, but it cannot find the .matter file. You must provide it using the IDL option, for example:

chip_configure_data_model(app
    INCLUDE_SERVER
    GEN_DIR ${CONFIG_NCS_SAMPLE_MATTER_ZAP_FILES_PATH}/zap-generated
    ZAP_FILE ${CMAKE_CURRENT_SOURCE_DIR}/${CONFIG_NCS_SAMPLE_MATTER_ZAP_FILES_PATH}/light_bulb.zap
    IDL ${CMAKE_CURRENT_SOURCE_DIR}/src/light_bulb.matter
)

Please note that you need to have zap-cli installed, and the installed version must match the version used in the SDK you are using. If not, you will get an error when it tries to generate the zap files.
You can install it by running the following in modules/lib/matter:

python3 scripts/setup/nrfconnect/get_zap.py -l <location_path> -o

Best regards,
Marte

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

susepc — Thu, 10 Apr 2025 07:50:03 GMT

Marte Myrvold

Thanks for your support!

I have omit BYPASS_IDL as blow:

chip_configure_data_model(app
INCLUDE_SERVER
GEN_DIR ${CONFIG_NCS_SAMPLE_MATTER_ZAP_FILES_PATH}/zap-generated
ZAP_FILE ${CMAKE_CURRENT_SOURCE_DIR}/${CONFIG_NCS_SAMPLE_MATTER_ZAP_FILES_PATH}/light_bulb.zap
)

But meet build error:

ninja: error: '../../src/default_zap/light_bulb.matter', needed by 'gen/app-codegen/cpp-app/app/PluginApplicationCallbacks.h', missing and no known rule to make it
[11/23] Generating new Factory Data...
[INFO] Generating SPAKE2+ Verifier...
[WARNING] KEY password has not been provided. It means that DAC key is not encrypted.
[INFO] Validating JSON with schema...
[INFO] Validate OK
FAILED: _sysbuild/sysbuild/images/light_bulb-prefix/src/light_bulb-stamp/light_bulb-build

Can you have a try? If the same case, could you please tell me the reason and how to fix this error?

Chuan

RE: Build Matter Light Bulb using ZAP auto generated files dynamically

Marte Myrvold — Wed, 09 Apr 2025 12:13:38 GMT

Hi Chuan,

[quote user=""]But I noticed that bulb project used zap generated files, I want to auto generate zap files in the build flow(that means generating code files by light_bulb.zap dynamically), could you tell me how can I do?[/quote]

The zap files are generated with the "west zap generate" command. You cannot combine this and the west build command into one, but you can create a script that runs both commands.

[quote user=""]Furthermore, I have noticed the macro("BYPASS_IDL") in cmake file is TRUE, so it skip auto generate flow, how can I set it to FALSE?[/quote]

You can omit BYPASS_IDL from chip_configure_data_model, and it should not bypass it.

Best regards,
Marte