Switch to dynamic zap generation - #68
Open
ArekBalysNordic wants to merge 5 commits into
Open
ArekBalysNordic wants to merge 5 commits into
ArekBalysNordic wants to merge 5 commits into
Conversation
|
You can find the documentation preview for this PR here. Preview links for modified Matter add-on documents: |
ArekBalysNordic
force-pushed
the
codegen_dynamic
branch
3 times, most recently
from
September 18, 2026 11:41
0482e6f to
9dfae28
Compare
peknis
requested changes
Sep 18, 2026
|
|
||
| On the first build of a sample, the build system downloads and installs the ZAP tool into the Matter SDK :file:`.zap-install` directory. | ||
| This happens automatically when :kconfig:option:`CONFIG_MATTER_ZAP_CLI_INSTALL_PATH` is empty and ``zap-cli`` is not already available on :envvar:`PATH`. | ||
| The download runs once per Matter SDK revision. Later builds reuse the installed tool. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The download runs once per Matter SDK revision. Later builds reuse the installed tool. | |
| The download runs once for each Matter SDK revision. | |
| Later builds reuse the installed tool. |
Comment on lines
+129
to
+130
| * :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool_gui` — edit the :file:`.zap` file. | ||
| * :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool_generate` — generate the :file:`zap-generated/` directory. |
Collaborator
There was a problem hiding this comment.
Suggested change
| * :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool_gui` — edit the :file:`.zap` file. | |
| * :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool_generate` — generate the :file:`zap-generated/` directory. | |
| * :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool_gui` - Edit the :file:`.zap` file. | |
| * :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool_generate` - Generate the :file:`zap-generated/` directory. |
|
|
||
| west zap-generate | ||
|
|
||
| Generated files are written to :file:`zap-generated/` next to the :file:`.zap` file unless you pass ``--output``. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Generated files are written to :file:`zap-generated/` next to the :file:`.zap` file unless you pass ``--output``. | |
| The generated files are written to :file:`zap-generated/` next to the :file:`.zap` file unless you pass ``--output``. |
|
|
||
| .. note:: | ||
|
|
||
| When using static generation, you are responsible for re-running ``west zap-generate`` after every :file:`.zap` change and for keeping the generated files in version control. |
Collaborator
There was a problem hiding this comment.
Suggested change
| When using static generation, you are responsible for re-running ``west zap-generate`` after every :file:`.zap` change and for keeping the generated files in version control. | |
| When using static generation, you are responsible for re-running ``west zap-generate`` after every change in the :file:`.zap` and for keeping the generated files in version control. |
| The |addon| provides migration notes for major releases to assist your transition from the previous release. | ||
|
|
||
| .. note:: | ||
| While we strive to document all breaking changes, the migration guides might not include the detailed migration steps for your use case. |
Collaborator
There was a problem hiding this comment.
Suggested change
| While we strive to document all breaking changes, the migration guides might not include the detailed migration steps for your use case. | |
| While all breaking changes are documented, the migration guides might not include the detailed migration steps for your use case. |
Comment on lines
+3
to
+4
| Migration notes | ||
| ################ |
Collaborator
There was a problem hiding this comment.
Suggested change
| Migration notes | |
| ################ | |
| Migration notes | |
| ############### |
Relocate chip_codegen_static.cmake and chip_data_model_static.cmake into the ncs-matter cmake directory so Nordic build-time ZAP generation lives in the add-on rather than the Matter SDK fork. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
Run zap_install.py during CMake configure to ensure zap-cli matching the version required by the Matter SDK is available, then symlink it next to the Python interpreter used for the build (already on PATH for the whole west build session) so build-time ZAP generation can find it. MATTER_ZAP_CLI_INSTALL_PATH can still be set to point at a preinstalled zap-cli directory instead of auto-installing. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
- Set the MATTER_ZAP_GENERATION_MODE to BUILD_TIME by default - Align scripts to this change Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
The zap-generated files are not needed because we switched to the build-time zap file generation. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
- Added migration guide entry Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
ArekBalysNordic
force-pushed
the
codegen_dynamic
branch
from
September 18, 2026 12:14
9dfae28 to
2c36a7a
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See commit messages for details.