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 sbgECom driver documentation #3529

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

tolesam
Copy link

@tolesam tolesam commented Dec 19, 2024

No description provided.

Copy link

github-actions bot commented Jan 9, 2025

No flaws found

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

@@ -30048,6 +30048,42 @@ Reboot | minValue | maxValue | increment | default | unit
--- | --- | --- | --- | --- | ---
✓ | | | | 500000 |

### SBG_BAUDRATE (`INT32`) {#SBG_BAUDRATE}
Copy link
Collaborator

Choose a reason for hiding this comment

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

The parameter docs are autogenerated from source. So when your driver PR is merged you'll get this stuff appearing automatically. Please remove this for now.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Actually, I see that at least some of these are already defined.


[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

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.

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

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