Struct shared_bus::AdcProxy

pub struct AdcProxy<'a, M> { /* private fields */ }

Proxy type for ADC sharing.

The AdcProxy implements OneShot trait so it can be passed to drivers instead of ADC instance. Internally, it holds reference to the bus via a mutex, ensuring that all accesses are strictly synchronized.

An AdcProxy is created by calling BusManager::acquire_adc().

Note: The adc::OneShot trait proxied by this type describes a non-blocking contract for ADC read operation. However access to a shared ADC unit can not be arbitrated in a completely non-blocking and concurrency safe way. Any reading from a channel shall be completed before shared-bus can allow the next read from the same or another channel. So the current implementation breaks the non-blocking contract of the trait and just busy-spins until a sample is returned.

Trait Implementations

impl<'a, M: BusMutex> Clone for AdcProxy<'a, M>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, M: Debug> Debug for AdcProxy<'a, M>

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

Formats the value using the given formatter.

impl<'a, M: BusMutex, ADC, Word, Pin> OneShot<ADC, Word, Pin> for AdcProxy<'a, M>where
    Pin: Channel<ADC>,
    M::Bus: OneShot<ADC, Word, Pin>,

type Error = <<M as BusMutex>::Bus as OneShot<ADC, Word, Pin>>::Error

Error type returned by ADC methods

fn read(&mut self, pin: &mut Pin) -> Result<Word, Self::Error>

Request that the ADC begin a conversion on the specified pin