ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include "esp_err.h"
#include "hal/adc_types.h"
#include "soc/soc_caps.h"
adc_io_to_channel(int, adc_unit_t *const, adc_channel_t *const);
adc_channel_to_io(adc_unit_t, adc_channel_t, int *const);
adc_oneshot_unit_handle_t
adc_oneshot_read_isr(adc_oneshot_unit_handle_t, adc_channel_t, int *);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/esp_adc/include/esp_private/adc_private.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2020-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ // DO NOT USE THESE APIS IN ANY APPLICATIONS #pragma once #include "esp_err.h" #include "hal/adc_types.h" #include "soc/soc_caps.h" #ifdef __cplusplus extern "C" { #endif /*--------------------------------------------------------------- ADC IOs ---------------------------------------------------------------*//* ... */ /** * @brief Get ADC channel from the given GPIO number * * @param[in] io_num GPIO number * @param[out] unit_id ADC unit * @param[out] channel ADC channel * * @return * - ESP_OK: On success * - ESP_ERR_INVALID_ARG: Invalid argument * - ESP_ERR_NOT_FOUND: The IO is not a valid ADC pad *//* ... */ esp_err_t adc_io_to_channel(int io_num, adc_unit_t * const unit_id, adc_channel_t * const channel); /** * @brief Get GPIO number from the given ADC channel * * @param[in] unit_id ADC unit * @param[in] channel ADC channel * @param[out] io_num GPIO number * * @param * - ESP_OK: On success * - ESP_ERR_INVALID_ARG: Invalid argument *//* ... */ esp_err_t adc_channel_to_io(adc_unit_t unit_id, adc_channel_t channel, int * const io_num); /*--------------------------------------------------------------- ADC Oneshot Read API ISR Version ---------------------------------------------------------------*//* ... */ typedef struct adc_oneshot_unit_ctx_t *adc_oneshot_unit_handle_t; /** * @brief ISR version to get one ADC conversion raw result * * @note This API only provide atomic register settings, without hardware resources protection. When other drivers are using * SAR-ADCs, calling this API may get wrong ADC result. * @note This API can be called in an ISR context. * @note Strongly suggest using this function when there's no concurrent hardware usage to the ADC. You can refer to ADC Oneshot * Programming Guide to know ADC Hardware Limitations * * @param[in] handle ADC handle * @param[in] chan ADC channel * @param[out] out_raw ADC conversion raw result * * @return * - ESP_OK: On success * - ESP_ERR_INVALID_ARG: Invalid arguments * - ESP_ERR_INVALID_STATE: Invalid state, the ADC result is invalid *//* ... */ esp_err_t adc_oneshot_read_isr(adc_oneshot_unit_handle_t handle, adc_channel_t chan, int *out_raw); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: