Add Terms and Conditions (T&C) Feature Support for Commissioning #36863
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
This commit introduces comprehensive support for handling Terms and
Conditions (T&C) during the commissioning process, enhancing
compatibility with Matter device certification requirements.
Key changes include:
1. **Commissioning Process Updates**:
- Introduced `SetRequireTermsAndConditionsAcknowledgement`,
`SetTermsAcknowledgements`, and `SetSkipCommissioningComplete` APIs
in the commissioning library.
- Updated commissioning stages to include `kGetTCAcknowledgments` and
`kConfigureTCAcknowledgments` for seamless integration of T&C
acknowledgements.
- Added methods for processing T&C acknowledgements and advancing
commissioning stages upon user response.
2. **Test Framework Enhancements**:
- Added arguments (`tc_version`, `tc_user_response`,
`in_test_commissioning_method`) for specifying T&C configuration in
tests.
- Enhanced `populate_commissioning_args` to manage new T&C-related
arguments.
- Updated Python test bindings and Matter test infrastructure to
support T&C workflows.
3. **Chip-Tool Improvements**:
- Extended `PairingCommand` to handle T&C-related arguments
(`require-tc-acknowledgements`, `tc-acknowledgements`,
`tc-acknowledgements-version`) for test scenarios.
- Ensured backward compatibility by defaulting new parameters to
preserve pre-1.4 behavior.
|
Review changes with Changed Files
|
github-actions
bot
added
tools
examples
controller
tests
matter-1.4-te2-script-change
|
PR #36863: Size comparison from 43f66f0 to 30d5e4d Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
bzbarsky-apple
requested changes
Dec 16, 2024
|
PR #36863: Size comparison from 4e44586 to 5ce33b6 Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
|
PR #36863: Size comparison from 37fa873 to 5ce33b6 Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
|
This PR added 14720 bytes to the fabric-sync app |
Should I file an issue against that app? Or how clusters add flash space? I'm guessing it is misconfigured? |
The wait-stage is not required. The user input availability must be a pre-condition for starting the AutoCommissioner process. The wait stage was previously to support requesting user input after identifying the device VID/PID using a different channel than within the pairing payload.
|
PR #36863: Size comparison from 37fa873 to 42a8f21 Increases above 0.2%:
Full report (19 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, nrfconnect, qpg, stm32, tizen)
|
Updated documentation for T&C-related commissioning arguments to better reflect their actual usage and purpose: - require-tc-acknowledgements: Clarified the impact on commissioning flow - tc-acknowledgements: Explained the bit-field usage for user acceptance - tc-acknowledgements-version: Added context about version tracking
|
PR #36863: Size comparison from 37fa873 to 6c18d73 Increases above 0.2%:
Full report (23 builds for bl602, bl702, bl702l, cc13x4_26x4, nrfconnect, qpg, stm32, telink, tizen)
|
The Terms and Conditions acknowledgements parameter was incorrectly included in ClearExternalBufferDependentValues(). This parameter contains a fixed-size struct with two uint16_t values and does not reference any external buffers. The CommissioningParameters class appears to be designed for additive-only parameter setting without explicit clear/reset functionality, so removing this inappropriate clearing operation is the correct approach.
Move kConfigureTCAcknowledgments before kCleanup in the CommissioningStage enum to fix cirque test failures. The tests validate that commissioning stages do not exceed kCleanup, which was causing failures when T&C acknowledgements were positioned after it. While the original comment from 2 years ago suggested the enum order was fixed, testing reveals that the stages can be reordered. The cirque tests now pass with this corrected ordering, indicating that any previous constraints on enum ordering no longer apply.
|
PR #36863: Size comparison from 388be5b to f2e7ba5 Increases above 0.2%:
Full report (19 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, nrfconnect, qpg, stm32, tizen)
|
bzbarsky-apple
approved these changes
Dec 19, 2024
Update help text for require-tc-acknowledgements to explicitly state which arguments must be provided when T&C acknowledgements are required. Instead of the vague "valid T&C acknowledgements", now specifically mentions that both tc-acknowledgements and tc-acknowledgements-version arguments are mandatory for successful commissioning when this option is enabled.
|
PR #36863: Size comparison from 388be5b to c8ff0e0 Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py
Show resolved
Hide resolved
src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py
Outdated
Show resolved
Hide resolved
src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py
Outdated
Show resolved
Hide resolved
tcarmelveilleux
approved these changes
Dec 20, 2024
…matter_testing.py Co-authored-by: Tennessee Carmel-Veilleux <[email protected]>
chrisdecenzo
approved these changes
Dec 20, 2024
|
PR #36863: Size comparison from 4c725be to accf8c8 Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
|
PR #36863: Size comparison from 4c725be to 54c6291 Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
|
PR #36863: Size comparison from 4c725be to 2f0f7c4 Increases above 0.2%:
Full report (69 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
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.
This commit introduces comprehensive support for handling Terms and Conditions (T&C) during the commissioning process, enhancing compatibility with Matter device certification requirements.
Key changes include:
Commissioning Process Updates:
SetRequireTermsAndConditionsAcknowledgement,SetTermsAcknowledgements, andSetSkipCommissioningCompleteAPIs in the commissioning library.kGetTCAcknowledgmentsandkConfigureTCAcknowledgmentsfor seamless integration of T&C acknowledgements.Test Framework Enhancements:
tc_version,tc_user_response,in_test_commissioning_method) for specifying T&C configuration in tests.populate_commissioning_argsto manage new T&C-related arguments.Chip-Tool Improvements:
PairingCommandto handle T&C-related arguments (require-tc-acknowledgements,tc-acknowledgements,tc-acknowledgements-version) for test scenarios.