AnalogConfigESP32V1 Class Reference

ESP32 specific configuration for i2s input via adc using the adc_continuous API. More...

#include <AnalogConfigESP32V1.h>

Inheritance diagram for AnalogConfigESP32V1:

Collaboration diagram for AnalogConfigESP32V1:

Public Member Functions
	AnalogConfigESP32V1 (const AnalogConfigESP32V1 &cfg)=default
	Copy constructor.
	AnalogConfigESP32V1 (RxTxMode rxtxMode=TX_MODE)
	Default constructor.
virtual void	clear ()
void	copyFrom (AudioInfo info)
	Same as set.
bool	equals (AudioInfo alt)
	Returns true if alt values are the same like the current values.
bool	equalsExSampleRate (AudioInfo alt)
	Checks if only the sample rate is different.
void	logInfo ()
virtual void	logInfo (const char *source="")
	operator bool ()
	Returns true if all components are defined (no component is 0)
bool	operator!= (AudioInfo alt)
	Returns true if alt values are the different from the current values.
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like the current values.
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.

Public Attributes
uint8_t	adc_attenuation = ADC_ATTEN_DB_12
uint8_t	adc_bit_width = SOC_ADC_DIGI_MAX_BITWIDTH
bool	adc_calibration_active = false
adc_channel_t	adc_channels [NUM_ADC_CHANNELS] = ADC_CHANNELS
adc_digi_convert_mode_t	adc_conversion_mode = ADC_CONV_MODE
adc_digi_output_format_t	adc_output_type = ADC_OUTPUT_TYPE
adc_unit_t	adc_unit = ADC_UNIT_1
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
int	buffer_count = ANALOG_BUFFER_COUNT
int	buffer_size = ANALOG_BUFFER_SIZE
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
bool	is_auto_center_read = false
bool	is_scale_to_16bit = false
RxTxMode	rx_tx_mode
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
TickType_t	timeout = portMAX_DELAY

Friends
class	AnalogDriverESP32

Detailed Description

ESP32 specific configuration for i2s input via adc using the adc_continuous API.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AnalogConfigESP32V1() [1/2]

AnalogConfigESP32V1 ( RxTxMode  rxtxMode = TX_MODE )

inline

Default constructor.

AnalogConfigESP32V1() [2/2]

AnalogConfigESP32V1 ( const AnalogConfigESP32V1 &  cfg )

default

Copy constructor.

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo() [1/2]

void logInfo ( )

inline

logInfo() [2/2]

virtual void logInfo ( const char *  source = "" )

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the different from the current values.

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Friends And Related Symbol Documentation

AnalogDriverESP32

friend class AnalogDriverESP32

friend

Member Data Documentation

adc_attenuation

uint8_t adc_attenuation = ADC_ATTEN_DB_12

adc_bit_width

uint8_t adc_bit_width = SOC_ADC_DIGI_MAX_BITWIDTH

adc_calibration_active

bool adc_calibration_active = false

adc_channels

adc_channel_t adc_channels[NUM_ADC_CHANNELS] = ADC_CHANNELS

adc_conversion_mode

adc_digi_convert_mode_t adc_conversion_mode = ADC_CONV_MODE

adc_output_type

adc_digi_output_format_t adc_output_type = ADC_OUTPUT_TYPE

adc_unit

adc_unit_t adc_unit = ADC_UNIT_1

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

buffer_count

int buffer_count = ANALOG_BUFFER_COUNT

buffer_size

int buffer_size = ANALOG_BUFFER_SIZE

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

is_auto_center_read

bool is_auto_center_read = false

is_scale_to_16bit

bool is_scale_to_16bit = false

Scale the adc_bit_width ADC values to the full 16 bit range (ignored when adc_calibration_active is set, since the values are then in mV)

rx_tx_mode

RxTxMode rx_tx_mode

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

timeout

TickType_t timeout = portMAX_DELAY

---

The documentation for this class was generated from the following file:

• src/AudioTools/CoreAudio/AudioAnalog/AnalogConfigESP32V1.h