Skip to content

Commit

Permalink
[doc] Improve Terms and Conditions commissioning arguments documentation
Browse files Browse the repository at this point in the history
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
  • Loading branch information
swan-amazon committed Dec 19, 2024
1 parent 42a8f21 commit 6c18d73
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions examples/chip-tool/commands/pairing/PairingCommand.h
Original file line number Diff line number Diff line change
Expand Up @@ -204,16 +204,17 @@ class PairingCommand : public CHIPCommand,
Argument::kOptional);

AddArgument("require-tc-acknowledgements", 0, 1, &mRequireTCAcknowledgements,
"Terms and Conditions acknowledgements is known to be required or not, (when required, the commissioner "
"will wait until they are provided)");
"Indicates whether Terms and Conditions acknowledgements are required during commissioning. If set to "
"true, the commissioner must provide valid T&C acknowledgements or the commissioning will fail. If false, "
"the T&C acknowledgement step will be skipped.");

AddArgument("tc-acknowledgements", 0, UINT16_MAX, &mTCAcknowledgements,
"Terms and Conditions acknowledgements to use to set the General Commissioning cluster's TC "
"Acknowledgements bit-field");
"Bit-field value indicating which Terms and Conditions have been accepted by the user. This value is sent "
"to the device during commissioning via the General Commissioning cluster");

AddArgument("tc-acknowledgements-version", 0, UINT16_MAX, &mTCAcknowledgementVersion,
"Terms and Conditions acknowledgement version to use to set the General Commissioning cluster's TC "
"Acknowledgement version");
"Version number of the Terms and Conditions that were accepted by the user. This value is sent to the "
"device during commissioning to indicate which T&C version was acknowledged");
}

AddArgument("timeout", 0, UINT16_MAX, &mTimeout);
Expand Down

0 comments on commit 6c18d73

Please sign in to comment.