Skip to content
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.

Sign up for GitHub

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

Jump to bottom

ADS1115 Update docs - for discussion #21638

Merged
merged 4 commits into from
Jun 8, 2023
Merged

ADS1115 Update docs - for discussion #21638

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9ef603
ADS1115 Update docs - for discussion
hamishwillee May 25, 2023
2f23373
Update src/drivers/adc/ads1115/ads1115_main.cpp
hamishwillee May 25, 2023
b2c005b
Run formatter
hamishwillee Jun 6, 2023
c333c06
Update src/drivers/adc/ads1115/ads1115_main.cpp
hamishwillee Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/drivers/adc/ads1115/ads1115_main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,22 @@ void ADS1115::RunImpl()

void ADS1115::print_usage()
{

PRINT_MODULE_DESCRIPTION(
R"DESCR_STR(
### Description

Driver to enable an external [ADS1115](https://www.adafruit.com/product/1085) ADC connected via I2C.

This 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 can be enabled with the [ADC_ADS1115_EN](../advanced_config/parameter_reference.md#ADC_ADS1115_EN) parameter.
If enabled, internal ADCs are not used.
hamishwillee marked this conversation as resolved.
Show resolved Hide resolved

)DESCR_STR");

PRINT_MODULE_USAGE_NAME("ads1115", "driver");
PRINT_MODULE_USAGE_COMMAND("start");
PRINT_MODULE_USAGE_PARAMS_I2C_SPI_DRIVER(true, false);
Expand Down