[app] Allow to define external clusters in chip_data_model.* #27886
Conversation
This file contains 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
zap_cluster_list.py raises an error when the ZAP file
enables a cluster that is not implemented in the SDK. This
forces users to patch the SDK in order to use custom,
vendor-specific clusters.
Add EXTERNAL_CLUSTERS argument to chip_configure_data_model()
CMake function that takes a list of external cluster names
for which the default implementation should not included nor
required.
Usage example:
chip_configure_data_model(app
INCLUDE_SERVER
ZAP_FILE lock-app.zap
EXTERNAL_CLUSTERS BASIC_INFORMATION_CLUSTER MY_CUSTOM_CLUSTER
)
Replace the existing zap_clusters_with_custom_implementation
argument of chip_data_model() GN template with new one:
external_clusters. The previous argument took a list of
cluster implementation directories to be skipped, so it was
only useful for bypassing the default implementations, but
could not be used for custom, vendor-specific clusters.
The new argument addresses both scenarios.
Usage example:
chip_data_model("lock-common") {
zap_file = "lock-app.zap"
...
external_clusters = [
"BASIC_INFORMATION_CLUSTER",
"MY_CUSTOM_CLUSTER",
]
}
|
PR #27886: Size comparison from aaa2542 to f5dd895 Increases (13 builds for bl602, bl702, bl702l, psoc6, qpg, telink)
Decreases (12 builds for bl602, cc32xx, cyw30739, esp32, psoc6, telink)
Full report (58 builds for bl602, bl702, bl702l, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, telink)
|
markaj-nordic
approved these changes
Jul 11, 2023
I'm not sure without trying (which will take a moment). Does your change also allow for overriding existing standard cluster implementations? That's not exactly the same thing as allowing extra custom clusters, but that's what led to #22042, telling the SDK not to include specific cluster implementations, so these can be re-implemented outside of the SDK. |
Yes, the new argument addresses both scenarios you mentioned. So the difference for you will be that instead of configuring: you will have to write the following: The previous approach assumed that |
|
@Damian-Nordic: Thanks for the explanation. In the meantime I managed to successfully rebuild my target (p44mbrd bridge) having custom level-control, color-control and identity servers with the PR applied, with less complications than expected, works fine :-) So: I'm fully OK with the change! |
andy31415
approved these changes
Jul 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
zap_cluster_list.py raises an error when the ZAP file enables a cluster that is not implemented in the SDK. This forces users to patch the SDK in order to use custom, vendor-specific clusters.
Add EXTERNAL_CLUSTERS argument to chip_configure_data_model() CMake function that takes a list of external cluster names for which the default implementation should not included nor required.
Usage example:
Replace the existing zap_clusters_with_custom_implementation argument of chip_data_model() GN template with new one: external_clusters. The previous argument took a list of cluster implementation directories to be skipped, so it was only useful for bypassing the default implementations, but could not be used for custom, vendor-specific clusters. The new argument addresses both scenarios.
Usage example: