mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 14:19:57 +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>
144 lines
4.1 KiB
Markdown
144 lines
4.1 KiB
Markdown
# Modules Reference: Adc (Driver)
|
|
|
|
::: info
|
|
**This page is [auto-generated](https://github.com/PX4/PX4-Autopilot/blob/main/Tools/px4moduledoc/markdownout.py) from the source code** using the build command: `make module_documentation`.
|
|
Do not edit it directly; fix the module documentation in the [PX4-Autopilot](https://github.com/PX4/PX4-Autopilot) source instead.
|
|
:::
|
|
|
|
## ADS7128
|
|
|
|
Source: [drivers/adc/ads7128](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/adc/ads7128)
|
|
|
|
### Usage {#ADS7128_usage}
|
|
|
|
```
|
|
ADS7128 <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
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|
|
|
|
## TLA2528
|
|
|
|
Source: [drivers/adc/tla2528](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/adc/tla2528)
|
|
|
|
### Usage {#TLA2528_usage}
|
|
|
|
```
|
|
TLA2528 <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
|
|
```
|
|
|
|
## adc
|
|
|
|
Source: [drivers/adc/board_adc](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/adc/board_adc)
|
|
|
|
### Description
|
|
|
|
ADC driver.
|
|
|
|
### Usage {#adc_usage}
|
|
|
|
```
|
|
adc <command> [arguments...]
|
|
Commands:
|
|
start
|
|
|
|
test
|
|
[-n] Do not publish ADC report, only system power
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|
|
|
|
## ads1115
|
|
|
|
Source: [drivers/adc/ads1115](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/adc/ads1115)
|
|
|
|
### Description
|
|
|
|
Driver to enable an external [ADS1115](https://www.adafruit.com/product/1085) ADC connected via I2C.
|
|
|
|
The driver is included by default in firmware for boards that do not have an internal analog to digital converter,
|
|
such as [PilotPi](../flight_controller/raspberry_pi_pilotpi.md) or [CUAV Nora](../flight_controller/cuav_nora.md)
|
|
(search for `CONFIG_DRIVERS_ADC_ADS1115` in board configuration files).
|
|
|
|
It is enabled/disabled using the
|
|
[ADC_ADS1115_EN](../advanced_config/parameter_reference.md#ADC_ADS1115_EN)
|
|
parameter, and is disabled by default.
|
|
If enabled, internal ADCs are not used.
|
|
|
|
### Usage {#ads1115_usage}
|
|
|
|
```
|
|
ads1115 <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: 72
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|
|
|
|
## ads7953
|
|
|
|
Source: [drivers/adc/ads7953](https://github.com/PX4/PX4-Autopilot/tree/main/src/drivers/adc/ads7953)
|
|
|
|
### Usage {#ads7953_usage}
|
|
|
|
```
|
|
ads7953 <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)
|
|
|
|
stop
|
|
|
|
status print status info
|
|
```
|