Struct kea_hal::adc::Adc

pub struct Adc<State> {
    pub onchip_channels: OnChipChannels,
    // some fields omitted
}

Interface for ADC Peripheral.

Returned by calling HALExt::split on the pac ADC structure. Holds state of peripheral.

Fields

onchip_channels: OnChipChannels

Contains the On-Chip ADC Channels, like the MCU’s temperature sensor.

Implementations

impl Adc<Enabled>

pub fn is_done(&self) -> bool

Poll to determine if ADC conversion is complete.

Note: This flag is cleared when the sampling mode is changed, interrupts are enabled, Adc::set_channel is called, and when Adc::result is called (including Adc::try_result)

pub fn is_converting(&self) -> bool

Poll to determine if ADC conversion is underway

pub fn result(&self) -> u16

Grab the last ADC conversion result.

pub fn try_result(&self) -> Option<u16>

Poll for conversion completion, if done return the result.

pub fn set_channel<T: Channel<Adc<Enabled>, ID = u8>>(&self, _pin: &T)

Set ADC target channel.

In Single conversion mode (OneShot), setting the channel begins the conversion. In FIFO mode the channel is added to the FIFO buffer.

Note: If the channel is changed while a conversion is in progress the current conversion will be cancelled. If in FIFO mode, conversion will resume once the FIFO channels are refilled.

pub fn configure(self, config: AdcConfig) -> Adc<Enabled>

Set the ADC’s configuration

impl Adc<Disabled>

pub fn enable(self) -> Adc<Enabled>

Connects the bus clock to the adc via the SIM peripheral, allowing read and write access to ADC registers.

Any attempt to access ADC registers while disabled results in a HardFault, generated by hardware.

This also enables the bandgap voltage reference.

pub fn configure(self, config: AdcConfig) -> Adc<Enabled>

Set the ADC’s configuration

This is a sugar method for calling Adc::enable followed by Adc::configure

impl<Mode> Adc<Mode>

pub fn into_interrupt(self) -> Adc<Mode>

Not Implemented

pub fn into_fifo(self, _depth: u8) -> Adc<Mode>

Not Implemented

pub fn into_continuous(self) -> Adc<Mode>

Not Implemented

Trait Implementations

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTA0<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTA1<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTC2<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTC3<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTF4<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTF5<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTF6<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTF7<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<Vss<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<TempSense<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<Bandgap<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<VrefH<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTA6<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<VrefL<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<DummyDisable<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTA7<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTB0<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTB1<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTB2<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTB3<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTC0<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<OldMode> Channel<Adc<Enabled>> for Analog<PTC1<OldMode>>

type ID = u8

Channel ID type

fn channel() -> u8

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl<Pin> OneShot<Adc<Enabled>, u16, Pin> for Adc<Enabled> where
    Pin: Channel<Adc<Enabled>, ID = u8>, 

type Error = Infallible

Error type returned by ADC methods

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

Request that the ADC begin a conversion on the specified pin