Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the rendezvousInformation field of SetupPayload better. #23000

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/setup_payload/SetupPayload.h
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ struct PayloadContents
uint16_t vendorID = 0;
uint16_t productID = 0;
CommissioningFlow commissioningFlow = CommissioningFlow::kStandard;
// rendezvousInformation is Optional, because a payload parsed from a manual
// numeric code would not have any rendezvousInformation available. A
// payload parsed from a QR code would always have a value for
// rendezvousInformation.
Optional<RendezvousInformationFlags> rendezvousInformation;
SetupDiscriminator discriminator;
uint32_t setUpPINCode = 0;
Expand Down