Introduce the CodeDrivenDataModelProvider #39974
Open
Conversation
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
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
src/data-model-providers/codedriven/CodeDrivenDataModelProvider.cpp
Outdated
Show resolved
Hide resolved
|
PR #39974: Size comparison from 48704fe to 82a694c Full report (32 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, psoc6, qpg, stm32, telink, tizen)
|
soares-sergio
changed the title
andy31415
reviewed
Jul 11, 2025
src/data-model-providers/codedriven/CodeDrivenDataModelProvider.h
Outdated
Show resolved
Hide resolved
|
PR #39974: Size comparison from 48704fe to 0c0e641 Full report (56 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, esp32, linux, nxp, psoc6, qpg, stm32, telink, tizen)
|
|
PR #39974: Size comparison from 48704fe to 0129dfb Full report (8 builds for telink)
|
|
PR #39974: Size comparison from e831a33 to ee489fd Full report (59 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
bzbarsky-apple
requested changes
Jul 15, 2025
| return CHIP_NO_ERROR; | ||
| } | ||
|
|
||
| DataModel::ActionReturnStatus CodeDrivenDataModelProvider::ReadAttribute(const DataModel::ReadAttributeRequest & request, |
There was a problem hiding this comment.
Before we start landing this, we need to figure out what the provider API actually looks like. The current provider API does not clearly define who (provider or the consumer of the provider) performs various spec-required checks, unfortunately, so we need to carefully go through the provider API and figure that all out and document the API expectations. Then it will be possible to actually review this PR, by checking whether the implementation actually implements the API that we have.
There was a problem hiding this comment.
Looks like #39686 addresses the API concerns I had, generally. Once that merges, can evaluate how this implementation is doing.
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.
Summary
This Pull Request (PR) introduces the
CodeDrivenDataModelProvider, enabling a code-based approach to define data models within the Matter SDK.The
CodeDrivenDataModelProvideroperates over endpoints. It uses anEndpointInterfaceRegistryto manageEndpointInterfaceinstances. EachEndpointInterface, such as theSpanEndpoint, can be configured in code to define its device types, semantic tags, and server/client clusters. This approach contrasts with the existing more static, codegen-based (zap) approach.The
EndpointInterface,EndpointInterfaceRegistryandSpanEndpointwere introduced earlier in pull/39396 and pull/39751 and they provide the basic mechanisms where applications can define its Data Model by organizing them by endpoints and adding to the CodeDrivenDataModelProvider.To build a real application that's fully code-based/dynamic, we need all of the cluster implementations to be code-driven and implement the
ServerClusterInterface. The conversion work is ongoing in parallel. Meanwhile, while this work is not finished, we've introduced in pull/39393 theServerClusterShimwhich offers a way to wrap ember/codegen-based clusters under theServerClusterInterfaceso they can be used with theCodeDrivenDataModelProvider.The following diagram describes how all these components are related to each other:
graph TD subgraph "New Data Model Provider" CDDMP[CodeDrivenDataModelProvider] EPR[EndpointInterfaceRegistry] end subgraph "Endpoint Definition" EPI["EndpointInterface (Interface)"] SEP[SpanEndpoint] end subgraph "Server Cluster Abstraction" SCI["ServerClusterInterface (Interface)"] SCS[ServerClusterShim] end CDDMP -- "Uses" --> EPR; EPR -- "Manages 1..*" --> EPI; SEP -- "Implements" --> EPI; EPI -- "Provides 0..*" --> SCI; SCS -- "Implements (wraps Ember clusters)" --> SCI; style CDDMP fill:#f9f,stroke:#333,stroke-width:2px style EPR fill:#fbf,stroke:#333,stroke-width:2px style SEP fill:#ccf,stroke:#333,stroke-width:2px style SCS fill:#cfc,stroke:#333,stroke-width:2px style EPI fill:#eee,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5 style SCI fill:#eee,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5Testing
A comprehensive set of unit tests has been added. To test the
CodeDrivenDataModelProvider, run:ninja -C out src/data-model-providers/codedriven/tests:TestCodeDrivenDataModelProvider && ./out/tests/TestCodeDrivenDataModelProvider