[nrf noup] Add zcl_generate to west command #547
Conversation
scripts/west/zap_common.py
Outdated
| DEFAULT_DATA_MODEL_PATH = f'{DEFAULT_MATTER_PATH}/src/app/zap-templates/zcl' | ||
| DEFAULT_ZCL_PATH = f'{DEFAULT_DATA_MODEL_PATH}/zcl.json' | ||
| DEFAULT_APP_TEMPLATES_PATH = f'{DEFAULT_MATTER_PATH}/src/app/zap-templates/app-templates.json' |
scripts/west/west-commands.yml
Outdated
| commands: | ||
| - name: zcl-generate | ||
| class: ZCLGenerate | ||
| help: Generate ZCL code from XML cluster definition file |
There was a problem hiding this comment.
I think that naming is a bit unfortunate here and there. According to name and help it seems that it generates source code, while it's not true, as it generates only json file that describes data model. Source code is generated by zap-generate, which is also unfortunate name, because it sounds like it could generate zap file, not the code.
I don't know if we should change zap-generate name, as customers could already have learned how to use it, but I would try to name the new command in a different way (and change help as well). Maybe zap-generate-json?
There was a problem hiding this comment.
Or maybe zcl-append-cluster
There was a problem hiding this comment.
But the other commands start with zap, so why do we want to use zcl now?
There was a problem hiding this comment.
Because, actually it is more about ZCL than zap.
There was a problem hiding this comment.
Changed to zap-append :)
ArekBalysNordic
force-pushed
the
zcl_generate_command
branch
from
77f534d to
15b657a
Compare
ArekBalysNordic
force-pushed
the
zcl_generate_command
branch
from
15b657a to
93bbf4e
Compare
scripts/west/zap_gui.py
Outdated
|
|
||
| zap_installer = ZapInstaller(args.matter_path) | ||
| zap_installer.update_zap_if_needed() | ||
| zap_cache_path = zap_installer.get_install_path() / ".zap" | ||
| zap_cache_path = zap_installer.get_cache_path() |
There was a problem hiding this comment.
I will add here temporary cache directory instead of using the global one inside the installation dir.
Added zap_append command to the west. use `west zap-append -h` to see all options. Now you can add new clusters to the matter ZCL datamodel. Use a `west zap-append` and provide the new cluster definitionsas XML files to add them to the zcl.json file. You can generate the new zcl.json file by providing `-o, --output` argument, or overwrite the existing one. The zcl_generate is integrated with `west zap-gui` commands. If you want to use it call the `west zap-gui` command with the additional argument `--clusters`. You can provide multiple clusters at once. If you provide an additional `-j` / `--zcl-json` argument alongside the `--clusters` argument to the `west zap-gui` command, the new zcl.json will be created and contain the new clusters. Signed-off-by: Arkadiusz Balys <[email protected]>
ArekBalysNordic
force-pushed
the
zcl_generate_command
branch
from
93bbf4e to
4a4c48c
Compare
Added zap_append command to the west.
use
west zap-append -hto see all options.Now you can add new clusters to the matter ZCL datamodel.
Use a
west zap-appendand provide the new cluster definitionsas XML files to add them to the zcl.json file.You can generate the new zcl.json file by providing
-o, --outputargument, or overwrite the existing one.The zcl_generate is integrated with
west zap-guicommands.If you want to use it call the
west zap-guicommand with the additional argument--clusters.You can provide multiple clusters at once.
If you provide an additional
-j/--zcl-jsonargument alongside the--clustersargument to thewest zap-guicommand, the new zcl.json will be created and contain the new clusters.manifest-pr-skip