Skip to content

Commit 6b3a9a9

Browse files
Darkl0udlucasssvaz
andauthored
Fixed typo for adc_continuous_data typedef in esp32-hal-adc.h/.c (#9529)
* Fixed typo in adc_continuous_data typedef Fixed typo in adc_continuous_data typedef * Additional typo fix for adc_continuous_data typedef Additional commit for previous commit (#9529) adding typo corrections within 1. /docs/en/api/adc.rst 2. /libraries/ESP32/examples/AnalogReadContinuous\AnalogReadContinuous.ino 3. tests/periman/periman.ino --------- Co-authored-by: Lucas Saavedra Vaz <[email protected]>
1 parent 4070a87 commit 6b3a9a9

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

Diff for: cores/esp32/esp32-hal-adc.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ static uint8_t __adcContinuousAtten = ADC_11db;
360360
static uint8_t __adcContinuousWidth = SOC_ADC_DIGI_MAX_BITWIDTH;
361361

362362
static uint8_t used_adc_channels = 0;
363-
adc_continuos_data_t *adc_result = NULL;
363+
adc_continuous_data_t *adc_result = NULL;
364364

365365
static bool adcContinuousDetachBus(void *adc_unit_number) {
366366
adc_unit_t adc_unit = (adc_unit_t)adc_unit_number - 1;
@@ -537,7 +537,7 @@ bool analogContinuous(uint8_t pins[], size_t pins_count, uint32_t conversions_pe
537537
}
538538

539539
//Allocate and prepare result structure for adc readings
540-
adc_result = malloc(pins_count * sizeof(adc_continuos_data_t));
540+
adc_result = malloc(pins_count * sizeof(adc_continuous_data_t));
541541
for (int k = 0; k < pins_count; k++) {
542542
adc_result[k].pin = pins[k];
543543
adc_result[k].channel = channel[k];
@@ -578,7 +578,7 @@ bool analogContinuous(uint8_t pins[], size_t pins_count, uint32_t conversions_pe
578578
return true;
579579
}
580580

581-
bool analogContinuousRead(adc_continuos_data_t **buffer, uint32_t timeout_ms) {
581+
bool analogContinuousRead(adc_continuous_data_t **buffer, uint32_t timeout_ms) {
582582
if (adc_handle[ADC_UNIT_1].adc_continuous_handle != NULL) {
583583
uint32_t bytes_read = 0;
584584
uint32_t read_raw[used_adc_channels];

Diff for: cores/esp32/esp32-hal-adc.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ extern "C" {
8686
uint8_t channel; /*!<ADC channel */
8787
int avg_read_raw; /*!<ADC average raw data */
8888
int avg_read_mvolts; /*!<ADC average voltage in mV */
89-
} adc_continuos_data_t;
89+
} adc_continuous_data_t;
9090

9191
/*
9292
* Setup ADC continuous peripheral
@@ -96,7 +96,7 @@ extern "C" {
9696
/*
9797
* Read ADC continuous conversion data
9898
* */
99-
bool analogContinuousRead(adc_continuos_data_t** buffer, uint32_t timeout_ms);
99+
bool analogContinuousRead(adc_continuous_data_t** buffer, uint32_t timeout_ms);
100100

101101
/*
102102
* Start ADC continuous conversions

Diff for: docs/en/api/adc.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ If ``false`` is returned, error occurs and ADC continuous was not configured.
184184
analogContinuousRead
185185
^^^^^^^^^^^^^^^^^^^^
186186

187-
This function is used to read ADC continuous data to the result buffer. The result buffer is an array of ``adc_continuos_data_t``.
187+
This function is used to read ADC continuous data to the result buffer. The result buffer is an array of ``adc_continuous_data_t``.
188188

189189
.. code-block:: arduino
190190
@@ -193,13 +193,13 @@ This function is used to read ADC continuous data to the result buffer. The resu
193193
uint8_t channel; /*!<ADC channel */
194194
int avg_read_raw; /*!<ADC average raw data */
195195
int avg_read_mvolts; /*!<ADC average voltage in mV */
196-
} adc_continuos_data_t;
196+
} adc_continuous_data_t;
197197
198198
.. code-block:: arduino
199199
200-
bool analogContinuousRead(adc_continuos_data_t ** buffer, uint32_t timeout_ms);
200+
bool analogContinuousRead(adc_continuous_data_t ** buffer, uint32_t timeout_ms);
201201
202-
* ``buffer`` conversion result buffer to read from ADC in adc_continuos_data_t format.
202+
* ``buffer`` conversion result buffer to read from ADC in adc_continuous_data_t format.
203203
* ``timeout_ms`` time to wait for data in milliseconds.
204204

205205
This function will return ``true`` if reading is successful and ``buffer`` is filled with data.

Diff for: libraries/ESP32/examples/AnalogReadContinuous/AnalogReadContinuous.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ uint8_t adc_pins_count = sizeof(adc_pins) / sizeof(uint8_t);
1616
volatile bool adc_coversion_done = false;
1717

1818
// Result structure for ADC Continuous reading
19-
adc_continuos_data_t* result = NULL;
19+
adc_continuous_data_t* result = NULL;
2020

2121
// ISR Function that will be triggered when ADC conversion is done
2222
void ARDUINO_ISR_ATTR adcComplete() {

Diff for: tests/periman/periman.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ void adc_continuous_test(void) {
158158
test_executed = true;
159159
uint8_t adc_pins[] = { ADC1_DEFAULT, ADC2_DEFAULT };
160160
uint8_t adc_pins_count = 2;
161-
adc_continuos_data_t* result = NULL;
161+
adc_continuous_data_t* result = NULL;
162162

163163
analogContinuousSetWidth(12);
164164
analogContinuousSetAtten(ADC_11db);

0 commit comments

Comments
 (0)