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 support for QZSS constellation [OI-1792] #1414

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Conversation

cstolowicz
Copy link
Contributor

@cstolowicz cstolowicz commented Jul 4, 2024

Description

@swift-nav/devinfra

  • Added the use_qzss_sat field to the High Level Flag Message which decreased the amount of reserved fields from 6 to 5.
  • The Validation workflow will be disabled before merging this PR. The reasons about this decision can be found here

API compatibility

Does this change introduce a API compatibility risk?

API compatibility plan

JIRA Reference

https://swift-nav.atlassian.net/browse/OI-1792

Comment on lines +34 to +35
env:
ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
Copy link
Contributor Author

@cstolowicz cstolowicz Jul 5, 2024

Choose a reason for hiding this comment

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

This was added in order to solve an error on the workflow. Discussion can be found here

@@ -18,13 +18,13 @@ tests:
use_gps_sat: 1
use_gal_sat: 2
use_bds_sat: 3
use_qzss_sat: 0
Copy link
Contributor

Choose a reason for hiding this comment

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

can you try setting a value different that zero so that we can test if this new field is being encoded/decoded correctly?
this will probably affect the raw_packet, payload and crc representation, so those will need to also be updated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll be able to tackle this change on Wednesday. I've been trying to obtain the CRC with the change and I've been having some issues with it, that's why I haven't uploaded the change yet

spec/yaml/swiftnav/sbp/gnss.yaml Show resolved Hide resolved
Comment on lines +76 to +77
uint32 use_qzss_sat = 10;
uint32 use_tropo_grid_points = 12;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think partially using the reserved field is going to cause problems here. If the original intent for the expansion was to use those fields one by one, then they should have been marked all independently.
Maybe the correct procedure here is to mark the message as deprecated and create a V2? I am not completely sure, so it would be great if someone with more experience with this repo could chime in.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've discussed about changing the reserved field array for five different reserved fields but each field should have a different name. We've also discussed about deprecating the previous high level message. I believe these changes entail a more profound thought about how to design this new message, which may be outside of the scope of my task.
Wdyt about leaving it as I defined it and creating a ticket to revisit the way the reserved fields are defined, on this and other messages as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

I guess since the byte offsets are preserved, then this should be fine
image

Copy link
Contributor

@pcrumley pcrumley left a comment

Choose a reason for hiding this comment

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

it's hard for me to approve this without having a little more context. I can see where you are coming from with disabling the message validation CI check. We should be sure to re-enable it after you merge this PR

I believe the Benchmark CI check is just flat out broken because no runners are picking up the job

@cstolowicz
Copy link
Contributor Author

it's hard for me to approve this without having a little more context. I can see where you are coming from with disabling the message validation CI check. We should be sure to re-enable it after you merge this PR

I believe the Benchmark CI check is just flat out broken because no runners are picking up the job

@pcrumley To give you more context:

We're working on adding integrity support for QZSS and that involves changing the high level flag messages to also report the status of the QZSS satellites. The new QZSS field will replace one of the reserved fields as stated on the ICD and coded here.

Feel free to ask any questions if needed.

Copy link
Contributor

@fpezzinosn fpezzinosn left a comment

Choose a reason for hiding this comment

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

There is no runner that is going to pick-up this job https://github.com/swift-nav/libsbp/actions/runs/9876111694/job/27274391320?pr=1414
macos-11 is no longer a valid label

@cstolowicz
Copy link
Contributor Author

There is no runner that is going to pick-up this job https://github.com/swift-nav/libsbp/actions/runs/9876111694/job/27274391320?pr=1414 macos-11 is no longer a valid label

Yes @fpezzinosn , sorry, I forgot to merge against your branch

@cstolowicz cstolowicz changed the base branch from master to fpezzinosn/bump-rust-image July 10, 2024 14:51
@cstolowicz cstolowicz changed the base branch from fpezzinosn/bump-rust-image to master July 10, 2024 16:54
Copy link

sonarcloud bot commented Jul 10, 2024

Copy link

@valeparrags valeparrags left a comment

Choose a reason for hiding this comment

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

Reviewed: Add support for QZSS constellation commit
LGTM!

Comment on lines +76 to +77
uint32 use_qzss_sat = 10;
uint32 use_tropo_grid_points = 12;
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess since the byte offsets are preserved, then this should be fine
image

@cstolowicz cstolowicz merged commit 32ed016 into master Jul 10, 2024
35 of 36 checks passed
@cstolowicz cstolowicz deleted the cstolowicz/OI-1792 branch July 10, 2024 20:30
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.

None yet

5 participants