-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Adding MicroStrain driver documentation #3426
Open
JoelJ18
wants to merge
8
commits into
PX4:main
Choose a base branch
from
microstrain-robotics:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ff5af19
Adding Documentation
JoelJ18 d61c8ec
Proofread edits to Microstrain documentation
0fc1d9f
link typo
JoelJ18 56cad4d
Update en/sensor/microstrain.md
hamishwillee 03a06d8
Update en/sensor/microstrain.md
hamishwillee a436775
Renaming asset
JoelJ18 a151333
Added note about INS support
2424295
Fixed typo in INS note
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# MicroStrain (INS, IMU, VRU, ARHS) | ||
|
||
MicroStrain by HBK provides high-performance inertial sensors engineered for reliability and precision in challenging environments. | ||
Widely used across industries like aerospace, robotics, industrial automation, and research, MicroStrain sensors are optimized for real-time, accurate motion tracking and orientation data. | ||
|
||
![CV7](../../assets/hardware/sensors/inertial/microstrain_3dm_cv7_hbk.png) | ||
|
||
The driver currently supports the following hardware: | ||
|
||
- [`MicroStrain CV7-AHRS`](https://www.microstrain.com/inertial-sensors/3dm-cv7-ahrs): Inertial Measurement Unit (IMU) and Attitude Heading Reference System (AHRS) | ||
- [`MicroStrain CV7-AR`](https://www.microstrain.com/inertial-sensors/3dmcv7-ar): Inertial Measurement Unit (IMU) and Vertical Reference Unit (VRU) | ||
- [`MicroStrain CV7-INS`](https://www.microstrain.com/inertial-sensors/3dmcv7-ins): Inertial Measurement Unit (IMU) and Inertial Navigation System (INS). Only sensor output (gyro, accel, mag) is currently available. Support for the full navigation solution output will be added in a future driver release. | ||
|
||
For more information, including user manuals and datasheets, please refer to the sensors product page. | ||
|
||
## Where to Buy | ||
|
||
MicroStrain sensors can be purchased through HBK's official [MicroStrain product page](https://www.microstrain.com/inertial-sensors/all-sensors) or through authorized distributors globally. | ||
For large orders, custom requirements, or technical inquiries, reach out directly to [sales](https://www.microstrain.com/contact-sales) | ||
|
||
## Hardware Setup | ||
|
||
### Wiring | ||
|
||
Connect the main UART port of the MicroStrain sensor to any unused serial port on the flight controller. | ||
This port needs to be specified while starting the device. | ||
|
||
### Mounting | ||
|
||
The MicroStrain sensor can be mounted in any orientation. | ||
The default coordinate system uses X for the front, Y for the right, and Z for down, with directions marked on the device. | ||
|
||
## Firmware Configuration | ||
|
||
### PX4 Configuration | ||
|
||
To use the MicroStrain driver: | ||
|
||
1. Include the module in firmware in the [kconfig board configuration](../hardware/porting_guide_config.md#px4-board-configuration-kconfig) by setting the kconfig variables: `CONFIG_DRIVERS_INS_MICROSTRAIN` or `CONFIG_COMMON_INS`. | ||
2. Update the [EKF2_MULTI_IMU](../advanced_config/parameter_reference.md#EKF2_MULTI_IMU) parameter to account for the added MicroStrain sensor. | ||
3. To prioritize MicroStrain sensor output, adjust the priority level of individual sensors from 0-100 using the following parameters: | ||
|
||
- [CAL_ACCn_PRIO](../advanced_config/parameter_reference.md#CAL_ACC0_PRIO) | ||
- [CAL_GYROn_PRIO](../advanced_config/parameter_reference.md#CAL_GYRO0_PRIO) | ||
- [CAL_MAGn_PRIO](../advanced_config/parameter_reference.md#CAL_MAG0_PRIO) | ||
- [CAL_BAROn_PRIO](../advanced_config/parameter_reference.md#CAL_BARO0_PRIO) | ||
|
||
where `n` corresponds to the index of the corresponding sensor. | ||
|
||
::: tip | ||
Sensors can be identified by their device id, which can be found by checking the parameters: | ||
|
||
- [CAL_ACCn_ID](../advanced_config/parameter_reference.md#CAL_ACC0_ID) | ||
- [CAL_GYROn_ID](../advanced_config/parameter_reference.md#CAL_GYRO0_ID) | ||
- [CAL_MAGn_ID](../advanced_config/parameter_reference.md#CAL_MAG0_ID) | ||
- [CAL_BAROn_ID](../advanced_config/parameter_reference.md#CAL_BARO0_ID) | ||
|
||
::: | ||
|
||
4. Reboot and start the driver | ||
|
||
## MicroStrain Configuration | ||
|
||
By default, accel and gyro data will be published 500 Hz, magnetometer at 50 Hz, and barometric pressure at 50 Hz. | ||
This can be changed by adjusting the following parameters | ||
|
||
- [MS_IMU_RATE_HZ](../advanced_config/parameter_reference.md#MS_IMU_RATE_HZ) | ||
- [MS_MAG_RATE_HZ](../advanced_config/parameter_reference.md#MS_MAG_RATE_HZ) | ||
- [MS_BARO_RATE_HZ](../advanced_config/parameter_reference.md#MS_BARO_RATE_HZ) | ||
|
||
The driver will automatically configure data outputs based on the specific sensor model and available data streams. | ||
|
||
## Published Data | ||
|
||
The MicroStrain driver publishes sensor data which can be found on the following UOrb topics: | ||
|
||
- [sensor_accel](../msg_docs/SensorAccel.md) | ||
- [sensor_gyro](../msg_docs/SensorGyro.md) | ||
- [sensor_mag](../msg_docs/SensorMag.md) | ||
- [sensor_baro](../msg_docs/SensorBaro.md) | ||
|
||
::: tip | ||
Published topics can be viewed using the `listener` command. | ||
::: | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use sentence line breaks. Not a big deal but.