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

Add new Sensor elements (mainly) for handling relative time sources (… #147

Merged
merged 3 commits into from
Feb 16, 2024

Conversation

tgipsonMIDE
Copy link
Contributor

Copy link
Member

@StokesMIDE StokesMIDE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor requests.

@@ -110,6 +110,10 @@
<StringElement name="SensorSerialNumber" id="0x5251" multiple="0" minver="2">Sensor manufacturer-supplied serial number, if any.</StringElement>
<!-- Child elements TBD... -->
</MasterElement>
<StringElement name="SourceName" id="0x5260" multiple="0" minver="4">Human-friendly source (authority, network, or other source-of-truth) name for generic/virtual sensor types, particularly 'time' sensors.</StringElement>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be a <UnicodeElement>, since it could be a user-supplied AP name. <StringElement> is only ASCII 0x20 to 0x7e.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do. Do you know if this is the same as UTF-8 (EBML_TYPE_UTF8 in the FW)? I just want to quickly confirm the FW can actually write those :-)

<UIntegerElement name="DocTypeVersion" id="0x4287" multiple="0" mandatory="1" default="3" minver="1">The version of DocType interpreter used to create the file.</UIntegerElement>
<UIntegerElement name="DocTypeReadVersion" id="0x4285" multiple="0" mandatory="1" default="3" minver="1">The minimum DocType version an interpreter has to support to read this file.</UIntegerElement>
<UIntegerElement name="DocTypeVersion" id="0x4287" multiple="0" mandatory="1" default="4" minver="1">The version of DocType interpreter used to create the file.</UIntegerElement>
<UIntegerElement name="DocTypeReadVersion" id="0x4285" multiple="0" mandatory="1" default="4" minver="1">The minimum DocType version an interpreter has to support to read this file.</UIntegerElement>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think <DocTypeReadVersion> should only get bumped when we break compatibility. We're just adding data, which our current software will happily ignore, so I say leave it as is.

Someone (almost definitely me) needs to record the official policy for incrementing <DocTypeVersion> and <DocTypeReadVersion>.

@codecov-commenter
Copy link

codecov-commenter commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b806e05) 74.28% compared to head (77ec277) 74.27%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #147      +/-   ##
===========================================
- Coverage    74.28%   74.27%   -0.02%     
===========================================
  Files           10       10              
  Lines         3691     3689       -2     
===========================================
- Hits          2742     2740       -2     
  Misses         949      949              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tgipsonMIDE tgipsonMIDE merged commit 6420d42 into develop Feb 16, 2024
35 checks passed
@tgipsonMIDE tgipsonMIDE deleted the feature/WT-129_update_time_channel_metadata branch February 16, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants