feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'change/adc_conti_read_api_doc_update' into 'master'

Browse Source 
adc: updated continuous mode read API doc about block timeout description

Closes IDFGH-14033

See merge request espressif/esp-idf!34796
This commit is contained in:
Armando (Dou Yiwen)
2024-11-11 14:30:54 +08:00
parent 87e4f63c77 4df585e1a8
commit 08ef00d82d
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/peripherals/adc_continuous.rst
View File

@@ -289,7 +289,7 @@ After calling :cpp:func:`adc_continuous_start`, the ADC continuous conversion st
Function :cpp:func:`adc_continuous_read` tries to read the expected length of conversion results each time. Function :cpp:func:`adc_continuous_read` tries to read the expected length of conversion results each time.
- When calling :cpp:func:`adc_continuous_read`, you can request to read a conversion result of the specified length. Sometimes, however, the actual available conversion results may be less than the requested length, in which case the function still moves the data from the internal pool into the buffer you provided. Therefore, to learn the number of conversion results actually moved into the buffer, please check the value of ``out_length``. - When calling :cpp:func:`adc_continuous_read`, you can request to read a conversion result of the specified length. Sometimes, however, the actual available conversion results may be less than the requested length, in which case the function still moves the data from the internal pool into the buffer you provided. Therefore, to learn the number of conversion results actually moved into the buffer, please check the value of ``out_length``.
- If there is no conversion result generated in the internal pool, the function will block for ``timeout_ms`` until the conversion results are generated. If there are still no generated results, the function will return :c:macro:`ESP_ERR_TIMEOUT`. - If there is no conversion result generated in the internal pool, the function will block for ``timeout_ms`` until at least one conversion result is generated. If there are still no generated results, the function will return :c:macro:`ESP_ERR_TIMEOUT`.
- If the generated results fill up the internal pool, newly generated results will be lost. Next time when :cpp:func:`adc_continuous_read` is called, this function will return :c:macro:`ESP_ERR_INVALID_STATE` to indicate this situation. - If the generated results fill up the internal pool, newly generated results will be lost. Next time when :cpp:func:`adc_continuous_read` is called, this function will return :c:macro:`ESP_ERR_INVALID_STATE` to indicate this situation.
This API aims to give you a chance to read all the ADC continuous conversion results. This API aims to give you a chance to read all the ADC continuous conversion results.