Struct adc_interpolator::AdcInterpolator

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

Implementations

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

pub fn new<ADC>(pin: Pin, table: [(Word, u32); LENGTH]) -> Self where
    Word: PartialOrd,
    Pin: Channel<ADC>, 

Returns an interpolator using the provided table.

The values in the table must be in ascending order by voltage or this function will panic. (ie. If you are using pair to create the pairs in the table, the voltage parameter must increase with each pair.)

Examples

Use pair to create the pairs in table:

use adc_interpolator::{AdcInterpolator, pair};

let interpolator = AdcInterpolator::new(
    pin,
    [
        pair::<u16>(1000, 12, 100, 40),
        pair(1000, 12, 200, 30),
        pair(1000, 12, 300, 10),
    ],
);

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, pair};

let mut interpolator = AdcInterpolator::new(
    pin,
    [
        pair(1000, 12, 100, 40),
        pair(1000, 12, 200, 30),
        pair(1000, 12, 300, 10),
    ],
);

// 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.