Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge branch 'bugfix/docs_adc_attenuation' into 'master'

Browse source 
docs: Replaced 'attenuaton' with 'attenuation'

See merge request espressif/esp-idf!6672
This commit is contained in:
Krzysztof Budzynski 2019-11-18 12:10:56 +08:00
parent fb3d648e07 1487bd2edd
commit 70a93ca0c6
1 changed files with 37 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
components/driver/include/driver/adc.h
View file

@ -34,10 +34,10 @@ typedef enum {
} adc_atten_t; } adc_atten_t;
typedef enum { typedef enum {
ADC_WIDTH_BIT_9 = 0, /*!< ADC capture width is 9Bit*/ ADC_WIDTH_BIT_9 = 0, /*!< ADC capture width is 9 bits*/
ADC_WIDTH_BIT_10 = 1, /*!< ADC capture width is 10Bit*/ ADC_WIDTH_BIT_10 = 1, /*!< ADC capture width is 10 bits*/
ADC_WIDTH_BIT_11 = 2, /*!< ADC capture width is 11Bit*/ ADC_WIDTH_BIT_11 = 2, /*!< ADC capture width is 11 bits*/
ADC_WIDTH_BIT_12 = 3, /*!< ADC capture width is 12Bit*/ ADC_WIDTH_BIT_12 = 3, /*!< ADC capture width is 12 bits*/
ADC_WIDTH_MAX, ADC_WIDTH_MAX,
} adc_bits_width_t; } adc_bits_width_t;
@ -119,15 +119,15 @@ typedef enum {
} adc_i2s_source_t; } adc_i2s_source_t;
/** /**
* @brief Get the gpio number of a specific ADC1 channel. * @brief Get the GPIO number of a specific ADC1 channel.
* *
* @param channel Channel to get the gpio number * @param channel Channel to get the GPIO number
* *
* @param gpio_num output buffer to hold the gpio number * @param gpio_num output buffer to hold the GPIO number
* *
* @return * @return
* - ESP_OK if success * - ESP_OK if success
* - ESP_ERR_INVALID_ARG if channal not valid * - ESP_ERR_INVALID_ARG if channel not valid
*/ */
esp_err_t adc1_pad_get_io_num(adc1_channel_t channel, gpio_num_t *gpio_num); esp_err_t adc1_pad_get_io_num(adc1_channel_t channel, gpio_num_t *gpio_num);
@ -168,7 +168,7 @@ esp_err_t adc_set_data_width(adc_unit_t adc_unit, adc_bits_width_t width_bit);
* *
* When VDD_A is 3.3 V: * When VDD_A is 3.3 V:
* *
* - 0dB attenuaton (ADC_ATTEN_DB_0) gives full-scale voltage 1.1V * - 0 dB attenuation (ADC_ATTEN_DB_0) gives full-scale voltage 1.1 V
* - 2.5 dB attenuation (ADC_ATTEN_DB_2_5) gives full-scale voltage 1.5 V * - 2.5 dB attenuation (ADC_ATTEN_DB_2_5) gives full-scale voltage 1.5 V
* - 6 dB attenuation (ADC_ATTEN_DB_6) gives full-scale voltage 2.2 V * - 6 dB attenuation (ADC_ATTEN_DB_6) gives full-scale voltage 2.2 V
* - 11 dB attenuation (ADC_ATTEN_DB_11) gives full-scale voltage 3.9 V (see note below) * - 11 dB attenuation (ADC_ATTEN_DB_11) gives full-scale voltage 3.9 V (see note below)
@ -180,7 +180,7 @@ esp_err_t adc_set_data_width(adc_unit_t adc_unit, adc_bits_width_t width_bit);
* *
* Due to ADC characteristics, most accurate results are obtained within the following approximate voltage ranges: * Due to ADC characteristics, most accurate results are obtained within the following approximate voltage ranges:
* *
* - 0dB attenuaton (ADC_ATTEN_DB_0) between 100 and 950mV * - 0 dB attenuation (ADC_ATTEN_DB_0) between 100 and 950 mV
* - 2.5 dB attenuation (ADC_ATTEN_DB_2_5) between 100 and 1250 mV * - 2.5 dB attenuation (ADC_ATTEN_DB_2_5) between 100 and 1250 mV
* - 6 dB attenuation (ADC_ATTEN_DB_6) between 150 to 1750 mV * - 6 dB attenuation (ADC_ATTEN_DB_6) between 150 to 1750 mV
* - 11 dB attenuation (ADC_ATTEN_DB_11) between 150 to 2450 mV * - 11 dB attenuation (ADC_ATTEN_DB_11) between 150 to 2450 mV
@ -308,15 +308,15 @@ void adc1_ulp_enable(void);
int hall_sensor_read(void); int hall_sensor_read(void);
/** /**
* @brief Get the gpio number of a specific ADC2 channel. * @brief Get the GPIO number of a specific ADC2 channel.
* *
* @param channel Channel to get the gpio number * @param channel Channel to get the GPIO number
* *
* @param gpio_num output buffer to hold the gpio number * @param gpio_num output buffer to hold the GPIO number
* *
* @return * @return
* - ESP_OK if success * - ESP_OK if success
* - ESP_ERR_INVALID_ARG if channal not valid * - ESP_ERR_INVALID_ARG if channel not valid
*/ */
esp_err_t adc2_pad_get_io_num(adc2_channel_t channel, gpio_num_t *gpio_num); esp_err_t adc2_pad_get_io_num(adc2_channel_t channel, gpio_num_t *gpio_num);
@ -332,7 +332,7 @@ esp_err_t adc2_pad_get_io_num(adc2_channel_t channel, gpio_num_t *gpio_num);
* *
* When VDD_A is 3.3 V: * When VDD_A is 3.3 V:
* *
* - 0dB attenuaton (ADC_ATTEN_0db) gives full-scale voltage 1.1V * - 0 dB attenuation (ADC_ATTEN_0db) gives full-scale voltage 1.1 V
* - 2.5 dB attenuation (ADC_ATTEN_2_5db) gives full-scale voltage 1.5 V * - 2.5 dB attenuation (ADC_ATTEN_2_5db) gives full-scale voltage 1.5 V
* - 6 dB attenuation (ADC_ATTEN_6db) gives full-scale voltage 2.2 V * - 6 dB attenuation (ADC_ATTEN_6db) gives full-scale voltage 2.2 V
* - 11 dB attenuation (ADC_ATTEN_11db) gives full-scale voltage 3.9 V (see note below) * - 11 dB attenuation (ADC_ATTEN_11db) gives full-scale voltage 3.9 V (see note below)
@ -377,18 +377,18 @@ esp_err_t adc2_config_channel_atten(adc2_channel_t channel, adc_atten_t atten);
esp_err_t adc2_get_raw(adc2_channel_t channel, adc_bits_width_t width_bit, int* raw_out); esp_err_t adc2_get_raw(adc2_channel_t channel, adc_bits_width_t width_bit, int* raw_out);
/** /**
* @brief Output ADC2 reference voltage to gpio 25 or 26 or 27 * @brief Output ADC2 reference voltage to GPIO 25 or 26 or 27
* *
* This function utilizes the testing mux exclusive to ADC 2 to route the * This function utilizes the testing mux exclusive to ADC 2 to route the
* reference voltage one of ADC2's channels. Supported gpios are gpios * reference voltage one of ADC2's channels. Supported GPIOs are GPIOs
* 25, 26, and 27. This refernce voltage can be manually read from the pin * 25, 26, and 27. This refernce voltage can be manually read from the pin
* and used in the esp_adc_cal component. * and used in the esp_adc_cal component.
* *
* @param[in] gpio GPIO number (gpios 25,26,27 supported) * @param[in] gpio GPIO number (GPIOs 25, 26 and 27 are supported)
* *
* @return * @return
* - ESP_OK: v_ref successfully routed to selected gpio * - ESP_OK: v_ref successfully routed to selected GPIO
* - ESP_ERR_INVALID_ARG: Unsupported gpio * - ESP_ERR_INVALID_ARG: Unsupported GPIO
*/ */
esp_err_t adc2_vref_to_gpio(gpio_num_t gpio); esp_err_t adc2_vref_to_gpio(gpio_num_t gpio);