idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches
idfxx::adc::sampler::config Struct Reference

Configuration for a continuous sampler. More...

Public Member Functions

bool operator== (const config &) const noexcept=default
 Compares two configurations for equality.
 

Public Attributes

std::vector< idfxx::gpiopins {}
 ADC1-capable GPIOs, converted round-robin in this order (required, no duplicates).
 
enum attenuation attenuation = attenuation::db_12
 Input range selection, applied uniformly to all pins (hardware limitation).
 
freq::hertz sample_rate {20'000}
 Total conversion rate across all pins; each pin samples at this rate divided by the pin count.
 
size_t frame_samples = 256
 Samples delivered per driver transfer — the read granularity.
 
size_t buffer_samples = 1024
 Internal pool capacity in samples (at least frame_samples). Reads must drain the pool faster than it fills or data is dropped (see overruns).
 

Detailed Description

Configuration for a continuous sampler.

Definition at line 240 of file adc.hpp.

Member Function Documentation

◆ operator==()

bool idfxx::adc::sampler::config::operator== ( const config ) const
defaultnoexcept

Compares two configurations for equality.

Member Data Documentation

◆ attenuation

enum attenuation idfxx::adc::sampler::config::attenuation = attenuation::db_12

Input range selection, applied uniformly to all pins (hardware limitation).

Definition at line 244 of file adc.hpp.

◆ buffer_samples

size_t idfxx::adc::sampler::config::buffer_samples = 1024

Internal pool capacity in samples (at least frame_samples). Reads must drain the pool faster than it fills or data is dropped (see overruns).

Definition at line 252 of file adc.hpp.

◆ frame_samples

size_t idfxx::adc::sampler::config::frame_samples = 256

Samples delivered per driver transfer — the read granularity.

Definition at line 249 of file adc.hpp.

◆ pins

std::vector<idfxx::gpio> idfxx::adc::sampler::config::pins {}

ADC1-capable GPIOs, converted round-robin in this order (required, no duplicates).

Definition at line 242 of file adc.hpp.

◆ sample_rate

freq::hertz idfxx::adc::sampler::config::sample_rate {20'000}

Total conversion rate across all pins; each pin samples at this rate divided by the pin count.

Valid range is chip-specific; 20 kHz works on every target.

Definition at line 247 of file adc.hpp.


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