Files
Alex E 59fa7a4a7d docs(modules): add auto-generated disclaimer to every module reference page (#29673)
Only modules_main.md told readers that the module reference is generated
from source. The per-category pages (modules_driver.md, modules_system.md,
...) and the per-subcategory pages (modules_driver_imu.md, ...) had no such
note, so contributors kept fixing typos directly in docs/en/modules/ and
the next metadata sync silently reverted them (see #29614).

Emit a `::: info` block right under the H1 of every category and
subcategory page. The wording follows the existing disclaimers on the
airframe reference and the uORB message index: it links to the generator
script and names the `make module_documentation` target.

docs/en/modules/*.md are regenerated with the updated generator and run
through Prettier, mirroring what the docs-orchestrator metadata sync does
on main, so the diff is only the new note.

Fixes #29624

Assisted-by: Claude:claude-fable-5-1

Signed-off-by: Alex E <aelejandro9@gmail.com>
2026-11-10 08:51:33 +11:00

4.4 KiB

Modules Reference: Ins (Driver)

::: info This page is auto-generated from the source code using the build command: make module_documentation. Do not edit it directly; fix the module documentation in the PX4-Autopilot source instead. :::

MicroStrain

Source: drivers/ins/microstrain

Description

MicroStrain by HBK Inertial Sensor Driver. Currently supports the following sensors:

-CV7-AR -CV7-AHRS -CV7-INS -CV7-GNSS/INS

This driver is not included in the firmware by default. Include the module in firmware by setting the kconfig variables: CONFIG_DRIVERS_INS_MICROSTRAIN or CONFIG_COMMON_INS.

Examples

Attempt to start driver on a specified serial device. The driver will choose /dev/ttyS4 by default if no port is specified

microstrain start -d /dev/ttyS1

Stop driver

microstrain stop

Usage

MicroStrain <command> [arguments...]
 Commands:
   start         Start driver
     [-d <val>]  Port
                 values: <file:dev>, default: /dev/ttyS4

   stop          Stop driver

   status        Driver status

eulernav_bahrs

Source: drivers/ins/eulernav_bahrs

Description

Serial bus driver for the EULER-NAV Baro-Inertial AHRS.

Examples

Attempt to start driver on a specified serial device.

eulernav_bahrs start -d /dev/ttyS1

Stop driver

eulernav_bahrs stop

Usage

eulernav_bahrs <command> [arguments...]
 Commands:
   start         Start driver
     -d <val>    Serial device

   status        Print driver status

   stop          Stop driver

ilabs

Source: drivers/ins/ilabs

Description

Serial bus driver for the ILabs sensors.

Most boards are configured to enable/start the driver on a specified UART using the SENS_ILABS_CFG. After that you can use the ILABS_MODE parameter to config outputs:

  • Only raw sensor output (the default).
  • Sensor output and INS data such as position and velocity estimates.

Setup/usage information: https://docs.px4.io/main/en/sensor/inertiallabs.html

Examples

Attempt to start driver on a specified serial device.

ilabs start -d /dev/ttyS1

Stop driver

ilabs stop

Usage

ilabs <command> [arguments...]
 Commands:
   start         Start driver
     -d <val>    Serial device

   status        Driver status

   stop          Stop driver

sbgecom

Source: drivers/ins/sbgecom

Description du module

Usage

sbgecom <command> [arguments...]
 Commands:
   start         Start driver
     [-d <val>]  Serial device
                 default: /dev/ttyS0
     [-b <val>]  Baudrate device
                 default: 921600
     [-f <val>]  Config JSON file path
                 default: /etc/extras/sbg_settings\.json
     [-s <val>]  Config JSON string

   status        Driver status

   stop          Stop driver

vectornav

Source: drivers/ins/vectornav

Description

Serial bus driver for the VectorNav VN-100, VN-200, VN-300.

Most boards are configured to enable/start the driver on a specified UART using the SENS_VN_CFG parameter.

Setup/usage information: https://docs.px4.io/main/en/sensor/vectornav.html

Examples

Attempt to start driver on a specified serial device.

vectornav start -d /dev/ttyS1

Stop driver

vectornav stop

Usage

vectornav <command> [arguments...]
 Commands:
   start         Start driver
     -d <val>    Serial device

   status        Driver status

   stop          Stop driver