esp32-hal-adc.h

/*
 Arduino.h - Main include file for the Arduino SDK
 Copyright (c) 2005-2013 Arduino Team. All right reserved.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#pragma once

#include"soc/soc_caps.h"
#ifSOC_ADC_SUPPORTED

#ifdef__cplusplus
extern"C" {
#endif

#include"esp32-hal.h"

typedefenum {
ADC_0db,
ADC_2_5db,
ADC_6db,
ADC_11db,
ADC_ATTENDB_MAX
} adc_attenuation_t;

/*
 * Get ADC value for pin
 * */
uint16_tanalogRead(uint8_tpin);

/*
 * Get MilliVolts value for pin
 * */
uint32_tanalogReadMilliVolts(uint8_tpin);

/*
 * Set the resolution of analogRead return values. Default is 12 bits (range from 0 to 4096).
 * If between 9 and 12, it will equal the set hardware resolution, else value will be shifted.
 * Range is 1 - 16
 *
 * Note: compatibility with Arduino SAM
 */
voidanalogReadResolution(uint8_tbits);

/*
 * Set the attenuation for all channels
 * Default is 11db
 * */
voidanalogSetAttenuation(adc_attenuation_tattenuation);

/*
 * Set the attenuation for particular pin
 * Default is 11db
 * */
voidanalogSetPinAttenuation(uint8_tpin, adc_attenuation_tattenuation);

#ifCONFIG_IDF_TARGET_ESP32
/*
 * Sets the sample bits and read resolution
 * Default is 12bit (0 - 4095)
 * Range is 9 - 12
 * */
voidanalogSetWidth(uint8_tbits);

#endif

/*
 * Analog Continuous mode
 * */

typedefstruct {
uint8_tpin; /*!<ADC pin */
uint8_tchannel; /*!<ADC channel */
intavg_read_raw; /*!<ADC average raw data */
intavg_read_mvolts; /*!<ADC average voltage in mV */
} adc_continuous_data_t;

/*
 * Setup ADC continuous peripheral
 * */
boolanalogContinuous(constuint8_tpins[], size_tpins_count, uint32_tconversions_per_pin, uint32_tsampling_freq_hz, void (*userFunc)(void));

/*
 * Read ADC continuous conversion data
 * */
boolanalogContinuousRead(adc_continuous_data_t**buffer, uint32_ttimeout_ms);

/*
 * Start ADC continuous conversions
 * */
boolanalogContinuousStart();

/*
 * Stop ADC continuous conversions
 * */
boolanalogContinuousStop();

/*
 * Deinitialize ADC continuous peripheral
 * */
boolanalogContinuousDeinit();

/*
 * Sets the attenuation for continuous mode reading
 * Default is 11db
 * */
voidanalogContinuousSetAtten(adc_attenuation_tattenuation);

/*
 * Sets the read resolution for continuous mode
 * Default is 12bit (0 - 4095)
 * Range is 9 - 12
 * */
voidanalogContinuousSetWidth(uint8_tbits);

#ifdef__cplusplus
}
#endif

#endif/* SOC_ADC_SUPPORTED */