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

Update Documentation For New Septentrio-Specific Driver #3253

Merged

Conversation

flyingthingsintothings
Copy link
Contributor

@flyingthingsintothings flyingthingsintothings commented Jun 18, 2024

As the Septentrio driver has moved from the PX4 GPS drivers repository into the main codebase and received new parameters and features, the documentation needs to be updated to reflect them. I checked the changes with yarn start and everything looks normal. There is one missing link (see bot reply below) which is just a future link that will point to the new parameters once they are available in the documentation, as that will automatically happen from what I understand.

As the Septentrio driver has moved from the PX4 GPS drivers repository
into the main codebase and received new parameters and features, the
documentation needs to be updated to reflect them.
Comment on lines +65 to +67
Note that you can also use a secondary Septentrio GNSS module, which is configured in a similar way.
It is common to connect a second module to the port labeled `GPS 2`
The port is configured using the [SEP_PORT2_CFG](../advanced_config/parameter_reference.md#SEP_PORT2_CFG) parameter.
Copy link
Collaborator

Choose a reason for hiding this comment

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

FYI, I added this.

@hamishwillee
Copy link
Collaborator

Thanks @flyingthingsintothings this is good thanks. I have subedited it for style - in particular for your note:

  1. I break lines on sentences rather than line length. Makes translation easier. Also use prettier for formatting.
  2. I link parameters - makes it easy to check removed components in future. IN general using linking is a "good thing".

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

@flyingthingsintothings OK, I'm going to merge, but probably a good idea for you to look at the current version and make sure my edits didn't change anything "incorrectly".

Note, one thing missing, which you can do as a post process. I think you need to add EKF2 settings to enable yaw, such as these https://docs.px4.io/main/en/gps_compass/rtk_gps_holybro_unicore_um982.html#enable-gps-heading-yaw

@hamishwillee hamishwillee merged commit e098934 into PX4:main Jun 19, 2024
2 checks passed
Copy link

No flaws found

@flyingthingsintothings
Copy link
Contributor Author

@hamishwillee I didn't find in the contribution guidelines that Prettier was used for formatting. That could maybe be added. Thank you for the edits. I always use max line length but like you say, splitting on sentences does make more sense.

@flyingthingsintothings flyingthingsintothings deleted the pr-new-septentrio-driver branch June 19, 2024 12:07
@hamishwillee
Copy link
Collaborator

@flyingthingsintothings I guess it is a bit unreasonable for you to guess the requirements :-). Thanks for the timely reminder!

I have made an update in #3261

@julianoes
Copy link
Contributor

Thanks for this @flyingthingsintothings, helped me today! ❤️

@julianoes
Copy link
Contributor

julianoes commented Oct 17, 2024

@hamishwillee this PR needs backporting to v1.15! It looks like the feature was shoved into v1.15 last minute.

See: PX4/PX4-Autopilot#23386

@hamishwillee
Copy link
Collaborator

@julianoes Well that's annoying. I manually removed it after the first cut of the build because it wasn't present :-(

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