Struct stm32f3xx_hal::adc::Adc

pub struct Adc<ADC> { /* fields omitted */ }

Analog Digital Converter Peripheral

Implementations

impl Adc<ADC1>

pub fn adc1(
    adc: ADC1,
    adc_common: &mut ADC1_2,
    ahb: &mut AHB,
    clock_mode: ClockMode,
    clocks: Clocks
) -> Self

Init a new ADC

Enables the clock, performs a calibration and enables the ADC

Panics

If one of the following occurs:

• the clocksetting is not well defined.
• the clock was already enabled with a different setting

pub fn free(self) -> ADC1

Releases the ADC peripheral and associated pins

pub fn setup_oneshot(&mut self)

sets up adc in one shot mode for a single channel

pub unsafe fn peripheral(&mut self) -> &mut ADC1

Get access to the underlying register block.

Safety

This function is not memory unsafe per se, but does not guarantee anything about assumptions of invariants made in this implementation.

Changing specific options can lead to un-expected behavior and nothing is guaranteed.

impl Adc<ADC2>

pub fn adc2(
    adc: ADC2,
    adc_common: &mut ADC1_2,
    ahb: &mut AHB,
    clock_mode: ClockMode,
    clocks: Clocks
) -> Self

Init a new ADC

Enables the clock, performs a calibration and enables the ADC

Panics

If one of the following occurs:

• the clocksetting is not well defined.
• the clock was already enabled with a different setting

pub fn free(self) -> ADC2

Releases the ADC peripheral and associated pins

pub fn setup_oneshot(&mut self)

sets up adc in one shot mode for a single channel

pub unsafe fn peripheral(&mut self) -> &mut ADC2

Get access to the underlying register block.

Safety

This function is not memory unsafe per se, but does not guarantee anything about assumptions of invariants made in this implementation.

Changing specific options can lead to un-expected behavior and nothing is guaranteed.

impl Adc<ADC3>

pub fn adc3(
    adc: ADC3,
    adc_common: &mut ADC3_4,
    ahb: &mut AHB,
    clock_mode: ClockMode,
    clocks: Clocks
) -> Self

Init a new ADC

Enables the clock, performs a calibration and enables the ADC

Panics

If one of the following occurs:

• the clocksetting is not well defined.
• the clock was already enabled with a different setting

pub fn free(self) -> ADC3

Releases the ADC peripheral and associated pins

pub fn setup_oneshot(&mut self)

sets up adc in one shot mode for a single channel

pub unsafe fn peripheral(&mut self) -> &mut ADC3

Get access to the underlying register block.

Safety

This function is not memory unsafe per se, but does not guarantee anything about assumptions of invariants made in this implementation.

Changing specific options can lead to un-expected behavior and nothing is guaranteed.

impl Adc<ADC4>

pub fn adc4(
    adc: ADC4,
    adc_common: &mut ADC3_4,
    ahb: &mut AHB,
    clock_mode: ClockMode,
    clocks: Clocks
) -> Self

Init a new ADC

Enables the clock, performs a calibration and enables the ADC

Panics

If one of the following occurs:

• the clocksetting is not well defined.
• the clock was already enabled with a different setting

pub fn free(self) -> ADC4

Releases the ADC peripheral and associated pins

pub fn setup_oneshot(&mut self)

sets up adc in one shot mode for a single channel

pub unsafe fn peripheral(&mut self) -> &mut ADC4

Get access to the underlying register block.

Safety

This function is not memory unsafe per se, but does not guarantee anything about assumptions of invariants made in this implementation.

Changing specific options can lead to un-expected behavior and nothing is guaranteed.

Trait Implementations

impl<Word, Pin> OneShot<ADC1, Word, Pin> for Adc<ADC1> where
    Word: From<u16>,
    Pin: Channel<ADC1, ID = u8>, 

type 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

impl<Word, Pin> OneShot<ADC2, Word, Pin> for Adc<ADC2> where
    Word: From<u16>,
    Pin: Channel<ADC2, ID = u8>, 

type 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

impl<Word, Pin> OneShot<ADC3, Word, Pin> for Adc<ADC3> where
    Word: From<u16>,
    Pin: Channel<ADC3, ID = u8>, 

type 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

impl<Word, Pin> OneShot<ADC4, Word, Pin> for Adc<ADC4> where
    Word: From<u16>,
    Pin: Channel<ADC4, ID = u8>, 

type 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