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 difference PressureMeasurement Cluster #25617

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

[Documentation] Specs vs XML difference PressureMeasurement Cluster #25617

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

Comments

@Apollon77
Copy link
Contributor

Documentation issues

I noticed the following differences between 1.0 Specs and XMLs

  • measuredValue has a default=0 according to XML, but this is not reflected in the specs
  • tolerance is flagged as reportable:true in XML which is not shown in Specs (and also makes no sense in my eyes)
  • scaledValue is reportable as per XML but not in specs
  • scale has min=-127 and max 127 in 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

measuredValue has a default=0 according to XML, but this is not reflected in the specs

The spec does not list an explicit default. Per "7.17.4. Default Column" that means the type-specific default is used, which is 0.

There's a good question as to what the XML should reflect here, and an even better question whether the XML should call its thing "default", since it's not quite what the spec means by "default"... But yeah, for now we should probably just align this.

scale has min=-127 and max 127 in specs but not in XML

That constraint is redundant, since the type is int8, no?

@Apollon77
Copy link
Contributor Author

That constraint is redundant, since the type is int8, no?

Also true :-)

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
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