Skip to content

Add sbgECom driver documentation #3529

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
Closed
wants to merge 3 commits into from
Closed

Add sbgECom driver documentation #3529

wants to merge 3 commits into from

Conversation

tolesam
Copy link

@tolesam tolesam commented Dec 19, 2024 •
edited by hamishwillee
Loading

hamishwillee
hamishwillee reviewed Jan 22, 2025
View reviewed changes
en/modules/modules_driver_ins.md
@@ -1,7 +1,65 @@
# Modules Reference: Ins (Driver)
Copy link
Collaborator

Choose a reason for hiding this comment

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

These docs need to be included in your driver source code, and then will automatically be generated - for example see https://docs.px4.io/main/en/modules/modules_driver_ins.html - the vectornav docs are created from this source: https://github.com/PX4/PX4-Autopilot/blob/main/src/drivers/ins/vectornav/VectorNav.cpp#L828

Copy link
Collaborator

Choose a reason for hiding this comment

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

I.e. please remove this for now.

Copy link
Author

Choose a reason for hiding this comment

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

done

hamishwillee
hamishwillee reviewed Jan 22, 2025
View reviewed changes
hamishwillee
hamishwillee reviewed Jan 22, 2025
View reviewed changes
en/sensor/sbgecom.md

[SBG-Systems](https://www.sbg-systems.com/) designs, manufactures, and support an extensive range of state-of-the-art inertial sensors such as Inertial Measurement Units (IMU), Attitude and Heading Reference Systems (AHRS), Inertial Navigation Systems with embedded GNSS (INS/GNSS) …

![Ellipse](../../assets/hardware/sensors/inertial/ellipse-inertial-navigation-system.png)
Copy link
Collaborator

@hamishwillee hamishwillee Jan 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

  1. Can you run prettier on this markdown file please. Your repo is rejecting my fixes.
  2. Can you crop the whitespace above and below the image.

Even better, give me edit rights over this repo and I can push the fixes myself.

Copy link
Author

Choose a reason for hiding this comment

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

done
I've given you write access on the repo

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you!

@hamishwillee
Copy link
Collaborator

  1. Can you please provide the PR that this went in with?
  2. Can you add a release note (i.e. https://docs.px4.io/main/en/releases/main.html with this PR linked)
  3. I'd guess the PR merged, but the docs for the module are not being generated? Or do they not exist yet?

@hamishwillee
Copy link
Collaborator

@tolesam Ping!

@tolesam tolesam force-pushed the dev/sbg branch 2 times, most recently from c07bbf3 to 80739d1 Compare January 31, 2025 16:26
@tolesam
Copy link
Author

tolesam commented Jan 31, 2025

@hamishwillee
Thank you for your review.
To answer your latest comments :

  • I've added the PX4-Autopilot PR is this PR's description
  • I've added it in the release note
  • The PX4-Autopilot PR has not been merged yet, it's still under review

hamishwillee
hamishwillee reviewed Feb 6, 2025
View reviewed changes
@hamishwillee
Copy link
Collaborator

Thanks. I've done a minor structural update. We'll do another quick check once the associated PR goes in.

@tolesam
Copy link
Author

tolesam commented Feb 7, 2025 •
edited
Loading

Thanks. I've done a minor structural update. We'll do another quick check once the associated PR goes in.

Thanks, I'll ping you as soon as the code PR is merged. I hope it will move forward.

@github-actions GitHub Actions
Copy link

/en/sensor/sbgecom.md

  • LinkedFileMissingAnchor: #SENS_SBG_CFG not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #SBG_BAUDRATE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #SBG_MODE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #SBG_CONFIGURATION_EN not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #SBG_BAUDRATE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)

@hamishwillee
Copy link
Collaborator

Hi @tolesam
We moved the sources for docs to PX4-Autopilot in the /docs/ directory. This will therefore have to be copied across. Suggest we wait until the PR merges, though you can now move the docs changes into or alongside PX4/PX4-Autopilot#24137 if you want.

Closing this version, in preparation for archiving the repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hamishwillee hamishwillee hamishwillee left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@tolesam @hamishwillee @lazibadam