Struct AdcInterpolator 

pub struct AdcInterpolator<Pin, Word, const LENGTH: usize> { /* private fields */ }

Implementations

impl<Pin, Word, const LENGTH: usize> AdcInterpolator<Pin, Word, LENGTH>

pub fn new<ADC>(pin: Pin, config: Config<LENGTH>) -> Self

where Word: Copy + PartialOrd + TryFrom<u32>, <Word as TryFrom<u32>>::Error: Debug, Pin: Channel<ADC>,

Returns an interpolator using the provided config.

The values in config’s voltage_to_values field must be in ascending order by voltage or this function will panic when running in debug mode.

Examples

use adc_interpolator::{AdcInterpolator, Config};

let config = Config {
    max_voltage: 1000,
    precision: 12,
    voltage_to_values: [
        (100, 40),
        (200, 30),
        (300, 10),
    ],
};

let interpolator = AdcInterpolator::new(pin, config);

pub fn free(self) -> Pin

Destroys the interpolator and returns the Pin.

pub fn read<Adc, ADC>( &mut self, adc: &mut Adc, ) -> Result<Option<u32>, Error<<Adc as OneShot<ADC, Word, Pin>>::Error>>

where Word: Copy + Into<u32> + PartialEq + PartialOrd, Pin: Channel<ADC>, Adc: OneShot<ADC, Word, Pin>,

Returns a value based on the table, using linear interpolation between values in the table if necessary. If adc_value falls outside the range of the table, returns Ok(None).

Examples

use adc_interpolator::{AdcInterpolator, Config};

let config = Config {
    max_voltage: 1000,
    precision: 12,
    voltage_to_values: [
        (100, 40),
        (200, 30),
        (300, 10),
    ],
};

let mut interpolator = AdcInterpolator::new(pin, config);

// With voltage at 150 mV, the value is 35
assert_eq!(interpolator.read(&mut adc), Ok(Some(35)));

pub fn min_value(&self) -> u32

Returns the smallest value that can be returned by read.

pub fn max_value(&self) -> u32

Returns the largest value that can be returned by read.

Trait Implementations

impl<Pin: Debug, Word: Debug, const LENGTH: usize> Debug for AdcInterpolator<Pin, Word, LENGTH>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.