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.

Sign up for GitHub

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

Jump to bottom

[Documentation] Specs vs XML differences Operational Credentials Cluster #25616

Closed
Apollon77 opened this issue Mar 10, 2023 · 5 comments · Fixed by #25626
Closed

[Documentation] Specs vs XML differences Operational Credentials Cluster #25616

Apollon77 opened this issue Mar 10, 2023 · 5 comments · Fixed by #25626
Labels
Spec XML align SDK XML does not match the spec (including naming, etc)

Comments

@Apollon77
Copy link
Contributor

Apollon77 commented Mar 10, 2023 •
edited
Loading

Documentation issues

  • Attribute supportedFabrics have a min/max as of 5/254 according to specs (Core specs 11.17.6), but this is not reflected in the XML
  • Attribute curtrentFabricIntdex has a default=0 as per specs which is not reflected in the XML

Platform

No response

Anything else?

No response
@bzbarsky-apple bzbarsky-apple added the Spec XML align SDK XML does not match the spec (including naming, etc) label Mar 10, 2023
@bzbarsky-apple
Copy link
Contributor

@Apollon77 Is this meant to be about the Operational Credentials cluster?

@Apollon77 Apollon77 changed the title [Documentation] Specs vs XML differences NetworkCommissioning Cluster [Documentation] Specs vs XML differences Operational Credentials Cluster Mar 10, 2023
@Apollon77
Copy link
Contributor Author

Yes, sorry ... corrected

@bzbarsky-apple
Copy link
Contributor

Attribute curtrentFabricIntdex has a default=0 as per specs which is not reflected in the XML

"default" in the XML right now does not mean the same concept as "default" does in the spec. So there's no particular reason they should be aligned, and in some cases aligning them will be actively confusing. This is one of those cases. There is no actual "default" for CurrentFabricIndex in implementation terms; it has to be dynamically computed. We should be somehow flagging this as "don't allow specifying a default in the ZAP UI at all" or something.

bzbarsky-apple added a commit to bzbarsky-apple/connectedhomeip that referenced this issue Mar 10, 2023
@bzbarsky-apple
Fix various mis-alignments wrt spec in cluster XML.
88c1e7a 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes project-chip#25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes project-chip#25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses project-chip#25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes project-chip#25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes project-chip#25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes project-chip#25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes project-chip#25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes project-chip#25620
@bzbarsky-apple bzbarsky-apple mentioned this issue Mar 10, 2023
Merged
bzbarsky-apple added a commit to bzbarsky-apple/connectedhomeip that referenced this issue Mar 10, 2023
@bzbarsky-apple
Fix various mis-alignments wrt spec in cluster XML.
05f1c92 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes project-chip#25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes project-chip#25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses project-chip#25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes project-chip#25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes project-chip#25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes project-chip#25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes project-chip#25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes project-chip#25620
bzbarsky-apple added a commit to bzbarsky-apple/connectedhomeip that referenced this issue Mar 10, 2023
@bzbarsky-apple
Fix various mis-alignments wrt spec in cluster XML.
599ce0f 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes project-chip#25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes project-chip#25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses project-chip#25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes project-chip#25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes project-chip#25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes project-chip#25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes project-chip#25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes project-chip#25620
@Apollon77
Copy link
Contributor Author

Ok, but then also the default of 0 in the specs makes no sense ... or?!

@bzbarsky-apple
Copy link
Contributor

Well, what it means in the specs is that if for some reason you need a CurrentFabricIndex for some algorithm defined by the spec and you are in a context where there is not one available (e.g. that algorithm is not associated with a message that delivered over an encrypted channel), then you should just use 0 (i.e. "no fabric") for the value.

In practice, the preconditions for that "if" might never even be met, in that there might be no such algorithms.

kkasperczyk-no pushed a commit to kkasperczyk-no/sdk-connectedhomeip that referenced this issue Mar 15, 2023
@bzbarsky-apple @kkasperczyk-no
Fix various mis-alignments wrt spec in cluster XML. (#25626)
0e8d736 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes project-chip/connectedhomeip#25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes project-chip/connectedhomeip#25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses project-chip/connectedhomeip#25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes project-chip/connectedhomeip#25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes project-chip/connectedhomeip#25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes project-chip/connectedhomeip#25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes project-chip/connectedhomeip#25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes project-chip/connectedhomeip#25620
lecndav pushed a commit to lecndav/connectedhomeip that referenced this issue Mar 22, 2023
@bzbarsky-apple
Fix various mis-alignments wrt spec in cluster XML. (project-chip#25626)
a6169f9 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes project-chip#25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes project-chip#25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses project-chip#25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes project-chip#25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes project-chip#25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes project-chip#25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes project-chip#25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes project-chip#25620
mwswartwout pushed a commit to mwswartwout/connectedhomeip that referenced this issue Mar 27, 2023
@bzbarsky-apple @mwswartwout
Fix various mis-alignments wrt spec in cluster XML. (project-chip#25626)
9d72411 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes project-chip#25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes project-chip#25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses project-chip#25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes project-chip#25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes project-chip#25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes project-chip#25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes project-chip#25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes project-chip#25620
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Spec XML align SDK XML does not match the spec (including naming, etc)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix various mis-alignments wrt spec in cluster XML. bzbarsky-apple/connectedhomeip
2 participants
@Apollon77 @bzbarsky-apple