Files
PX4-Autopilot/docs/en/modules/modules_driver_magnetometer.md
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

15 KiB

Modules Reference: Magnetometer (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. :::

af9838

Source: drivers/magnetometer/voltafield/af9838

Usage

af9838 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 12
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

ak09916

Source: drivers/magnetometer/akm/ak09916

Usage

ak09916 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 12
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

ak09940a

Source: drivers/magnetometer/akm/ak09940a

Usage

ak09940a <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 12
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

ak8963

Source: drivers/magnetometer/akm/ak8963

Usage

ak8963 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 12
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

bmm150

Source: drivers/magnetometer/bosch/bmm150

Usage

bmm150 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 16
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

bmm350

Source: drivers/magnetometer/bosch/bmm350

Usage

bmm350 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 20
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

hmc5883

Source: drivers/magnetometer/hmc5883

Usage

hmc5883 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-s]        Internal SPI bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-S]        External SPI bus (connector sensors, including shared buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-c <val>]  chip-select pin (for internal SPI) or index (for external SPI)
     [-m <val>]  SPI mode
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-R <val>]  Rotation
                 default: 0
     [-T]        Enable temperature compensation

   stop

   status        print status info

iis2mdc

Source: drivers/magnetometer/st/iis2mdc

Usage

iis2mdc <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 30

   stop

   status        print status info

ist8308

Source: drivers/magnetometer/isentek/ist8308

Usage

ist8308 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 12
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

ist8310

Source: drivers/magnetometer/isentek/ist8310

Usage

ist8310 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 14
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

lis3mdl

Source: drivers/magnetometer/lis3mdl

Usage

lis3mdl <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-s]        Internal SPI bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-S]        External SPI bus (connector sensors, including shared buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-c <val>]  chip-select pin (for internal SPI) or index (for external SPI)
     [-m <val>]  SPI mode
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 30
     [-R <val>]  Rotation
                 default: 0

   reset

   stop

   status        print status info

lsm9ds1_mag

Source: drivers/magnetometer/lsm9ds1_mag

Usage

lsm9ds1_mag <command> [arguments...]
 Commands:
   start
     [-s]        Internal SPI bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-S]        External SPI bus (connector sensors, including shared buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-c <val>]  chip-select pin (for internal SPI) or index (for external SPI)
     [-m <val>]  SPI mode
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

mmc5983ma

Source: drivers/magnetometer/memsic/mmc5983ma

Usage

mmc5983ma <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-s]        Internal SPI bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-S]        External SPI bus (connector sensors, including shared buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-c <val>]  chip-select pin (for internal SPI) or index (for external SPI)
     [-m <val>]  SPI mode
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 48
     [-R <val>]  Rotation
                 default: 0

   reset

   stop

   status        print status info

qmc5883l

Source: drivers/magnetometer/qmc5883l

Usage

qmc5883l <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 13
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

qmc5883p

Source: drivers/magnetometer/qmc5883p

Usage

qmc5883p <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-a <val>]  I2C address
                 default: 44
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

rm3100

Source: drivers/magnetometer/rm3100

Usage

rm3100 <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-s]        Internal SPI bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-S]        External SPI bus (connector sensors, including shared buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-c <val>]  chip-select pin (for internal SPI) or index (for external SPI)
     [-m <val>]  SPI mode
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info

vcm1193l

Source: drivers/magnetometer/vtrantech/vcm1193l

Usage

vcm1193l <command> [arguments...]
 Commands:
   start
     [-I]        Internal I2C bus(es) (onboard sensors; shared bus only if -b is
                 given)
     [-X]        External I2C bus(es) (connector sensors, including shared
                 buses)
     [-b <val>]  board-specific bus (default=all) (external SPI: n-th bus
                 (default=1))
     [-f <val>]  bus frequency in kHz
     [-q]        quiet startup (no message if no device found)
     [-R <val>]  Rotation
                 default: 0

   stop

   status        print status info