Sound Byte Libs 1ee2ca6
C++ firmware library for audio applications on 32-bit ARM Cortex-M processors
Loading...
Searching...
No Matches
Typedefs | Functions
sbl::adc Namespace Reference

Typedefs

using SampleTime = sbl::core::hal::adc::SampleTime
 
using Resolution = sbl::core::hal::adc::Resolution
 

Functions

template<typename Driver >
uint16_t read (const AdcHandle &handle, SampleTime sample_time=SampleTime::Medium)
 Blocking single-channel ADC read.
 
template<typename Driver >
uint32_t to_millivolts (uint16_t raw_value, uint32_t vref_mv=3300)
 Convert raw ADC value to voltage (millivolts)
 

Typedef Documentation

◆ Resolution

Definition at line 58 of file driver.hpp.

◆ SampleTime

Definition at line 57 of file driver.hpp.

Function Documentation

◆ read()

template<typename Driver >
uint16_t sbl::adc::read ( const AdcHandle handle,
SampleTime  sample_time = SampleTime::Medium 
)
inline

Blocking single-channel ADC read.

Convenience function that composes low-level driver primitives. Configures the channel, starts conversion, waits for completion, and returns the raw value.

Template Parameters
DriverADC driver type (e.g., sbl::driver::Adc)
Parameters
handleADC channel handle from hardware config
sample_timeSampling duration (default: Medium)
Returns
Raw ADC value (resolution depends on driver)

Example: auto value = sbl::adc::read<sbl::driver::Adc>(sbl::hw::adc::knob1);

Definition at line 76 of file driver.hpp.

◆ to_millivolts()

template<typename Driver >
uint32_t sbl::adc::to_millivolts ( uint16_t  raw_value,
uint32_t  vref_mv = 3300 
)
inline

Convert raw ADC value to voltage (millivolts)

Template Parameters
DriverADC driver type for resolution info
Parameters
raw_valueRaw ADC reading
vref_mvReference voltage in millivolts (default: 3300mV)
Returns
Voltage in millivolts

Definition at line 95 of file driver.hpp.