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 NetworkCommissioning Cluster #25612

Open
Apollon77 opened this issue Mar 10, 2023 · 2 comments
Open

[Documentation] Specs vs XML Differences NetworkCommissioning Cluster #25612

Apollon77 opened this issue Mar 10, 2023 · 2 comments
Labels
event list Spec XML align SDK XML does not match the spec (including naming, etc)
Milestone
Future

Comments

@Apollon77
Copy link
Contributor

Documentation issues

I identified the following differences between Chip XML https://github.com/project-chip/connectedhomeip/blob/master/src/app/zap-templates/zcl/data-model/chip/network-commissioning-cluster.xml and the Specs 1.0

  • Attribute maxNetworks has "min="1" according to specs, nothing set in XML
  • Attribute networks defines a maximum length of 12 in XML which is nowhere mentioned in the specs (there length is dynamic bound to attribute maxNetworks)
  • Attribute Inter­faceEn­abled has a default value true in the specs, but not in 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

Attribute maxNetworks has "min="1" according to specs, nothing set in XML

There is no way to represent that in the XML that I know of. @brdandu @tecimovic

Attribute Inter­faceEn­abled has a default value true in the specs, but not in 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 InterfaceEnabled 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
jmartinez-silabs pushed a commit that referenced this issue Mar 14, 2023
@bzbarsky-apple
Fix various mis-alignments wrt spec in cluster XML. (#25626)
0c5d81d 
1) Remove default that is not listed in spec table in Boolean State.
   * Fixes #25605
2) Remove length constraint on list in Fixed Label and User Label.
   * Fixes #25610
3) Remove length constraint on list in Network Commissioning.
   * Partially addresses #25612
4) Remove incorrect max values in Occupancy Sensing.
   * Fixes #25614
5) Add min/max for SupportedFabrics in Operational Credentials
   * Fixes #25616
6) Remove defaults and "reportable" annotations that are not in the spec table
   in Pressure Measurement
   * Fixes #25617
7) Fix max value of Tolerance attribute in Temperature Measurement
   * Fixes #25618
8) Remove stray "reportable" on Tolerance in Relative Humidity Measurement
   * Fixes #25620
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
@github-project-automation github-project-automation bot moved this to Open Cert Blockers in [Certification] Blockers May 23, 2023
@cjandhyala cjandhyala added this to the 1.2 milestone Aug 14, 2023
@andy31415
Copy link
Contributor

Removed cert blocker during triage: we expect this needs fixing, however XML differences likely do not affect SDK ability to be certified (at least regarding these issues, given that certification tests still pass).

@woody-apple woody-apple modified the milestones: 1.2, Future Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
event list Spec XML align SDK XML does not match the spec (including naming, etc)
Projects
[Enhancements] Spec/XML Alignment
Status: Todo
[Feature] Event List
Status: Todo
Milestone
Future
Development

No branches or pull requests
5 participants
@andy31415 @Apollon77 @woody-apple @bzbarsky-apple @cjandhyala