mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 22:50:49 +08:00
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>
16 KiB
16 KiB
Modules Reference: Baro (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.
:::
bmp280
Source: drivers/barometer/bmp280
Usage
bmp280 <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: 118
[-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)
stop
status print status info
bmp388
Source: drivers/barometer/bmp388
Usage
bmp388 <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: 118
stop
status print status info
bmp581
Source: drivers/barometer/bmp581
Usage
bmp581 <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: 70
stop
status print status info
dps310
Source: drivers/barometer/dps310
Usage
dps310 <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: 119
[-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)
[-8] Drive DPS368
stop
status print status info
icp101xx
Source: drivers/barometer/invensense/icp101xx
Usage
icp101xx <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: 99
stop
status print status info
icp201xx
Source: drivers/barometer/invensense/icp201xx
Usage
icp201xx <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: 99
stop
status print status info
lps22hb
Source: drivers/barometer/lps22hb
Usage
lps22hb <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)
stop
status print status info
lps25h
Source: drivers/barometer/lps25h
Usage
lps25h <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)
stop
status print status info
lps33hw
Source: drivers/barometer/lps33hw
Usage
lps33hw <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: 93
[-k] if initialization (probing) fails, keep retrying periodically
stop
status print status info
mpc2520
Source: drivers/barometer/maiertek/mpc2520
Usage
mpc2520 <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: 118
stop
status print status info
mpl3115a2
Source: drivers/barometer/mpl3115a2
Usage
mpl3115a2 <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: 96
stop
status print status info
ms5611
Source: drivers/barometer/ms5611
Usage
ms5611 <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)
[-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)
[-T <val>] Device type
values: 5607|5611, default: 5611
stop
status print status info
ms5837
Source: drivers/barometer/ms5837
Usage
ms5837 <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)
stop
status print status info
spa06
Source: drivers/barometer/goertek/spa06
Usage
spa06 <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: 118
[-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)
stop
status print status info
spl06
Source: drivers/barometer/goertek/spl06
Usage
spl06 <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: 118
[-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)
stop
status print status info