Struct stm32f1xx_hal::adc::Adc

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

ADC configuration

Implementations

impl Adc<ADC1>

pub fn read_temp(&mut self) -> i32

Temperature sensor is connected to channel 16 on ADC1. This sensor can be used to measure ambient temperature of the device. However note that the returned value is not an absolute temperature value.

In particular, according to section 11.10 from Reference Manual RM0008 Rev 20: “The temperature sensor output voltage changes linearly with temperature. The offset of this line varies from chip to chip due to process variation (up to 45 °C from one chip to another). The internal temperature sensor is more suited to applications that detect temperature variations instead of absolute temperatures. If accurate temperature readings are needed, an external temperature sensor part should be used.”

Formula to calculate temperature value is also taken from the section 11.10.

pub fn read_vref(&mut self) -> u16

Internal reference voltage Vrefint is connected to channel 17 on ADC1. According to section 5.3.4 “Embedded reference voltage” from STM32F1xx datasheets, typical value of this reference voltage is 1200 mV.

This value is useful when ADC readings need to be converted into voltages. For instance, reading from any ADC channel can be converted into voltage (mV) using the following formula: v_chan = adc.read(chan) * 1200 / adc.read_vref()

impl Adc<ADC1>

pub fn adc1(adc: ADC1, clocks: Clocks) -> Self

Init a new Adc

Sets all configurable parameters to one-shot defaults, performs a boot-time calibration.

pub fn save_cfg(&mut self) -> StoredConfig

Save current ADC config

pub fn restore_cfg(&mut self, cfg: StoredConfig)

Restore saved ADC config

pub fn default_cfg(&mut self) -> StoredConfig

Reset the ADC config to default, return existing config

pub fn set_sample_time(&mut self, t_samp: SampleTime)

Set ADC sampling time

Options can be found in SampleTime.

pub fn set_align(&mut self, align: Align)

Set the Adc result alignment

Options can be found in Align.

pub fn max_sample(&self) -> u16

Returns the largest possible sample value for the current settings

pub fn set_external_trigger(&mut self, trigger: EXTSEL_A)

pub fn release(self) -> ADC1

Powers down the ADC, disables the ADC clock and releases the ADC Peripheral

impl Adc<ADC2>

pub fn adc2(adc: ADC2, clocks: Clocks) -> Self

Init a new Adc

Sets all configurable parameters to one-shot defaults, performs a boot-time calibration.

pub fn save_cfg(&mut self) -> StoredConfig

Save current ADC config

pub fn restore_cfg(&mut self, cfg: StoredConfig)

Restore saved ADC config

pub fn default_cfg(&mut self) -> StoredConfig

Reset the ADC config to default, return existing config

pub fn set_sample_time(&mut self, t_samp: SampleTime)

Set ADC sampling time

Options can be found in SampleTime.

pub fn set_align(&mut self, align: Align)

Set the Adc result alignment

Options can be found in Align.

pub fn max_sample(&self) -> u16

Returns the largest possible sample value for the current settings

pub fn set_external_trigger(&mut self, trigger: EXTSEL_A)

pub fn release(self) -> ADC2

Powers down the ADC, disables the ADC clock and releases the ADC Peripheral

impl Adc<ADC3>

pub fn adc3(adc: ADC3, clocks: Clocks) -> Self

Init a new Adc

Sets all configurable parameters to one-shot defaults, performs a boot-time calibration.

pub fn save_cfg(&mut self) -> StoredConfig

Save current ADC config

pub fn restore_cfg(&mut self, cfg: StoredConfig)

Restore saved ADC config

pub fn default_cfg(&mut self) -> StoredConfig

Reset the ADC config to default, return existing config

pub fn set_sample_time(&mut self, t_samp: SampleTime)

Set ADC sampling time

Options can be found in SampleTime.

pub fn set_align(&mut self, align: Align)

Set the Adc result alignment

Options can be found in Align.

pub fn max_sample(&self) -> u16

Returns the largest possible sample value for the current settings

pub fn set_external_trigger(&mut self, trigger: EXTSEL_A)

pub fn release(self) -> ADC3

Powers down the ADC, disables the ADC clock and releases the ADC Peripheral

impl Adc<ADC1>

pub fn with_dma<PIN>(
    self,
    pins: PIN,
    dma_ch: C1
) -> AdcDma<ADC1, PIN, Continuous, C1>where
    PIN: Channel<ADC1, ID = u8>,

pub fn with_scan_dma<PINS>(
    self,
    pins: PINS,
    dma_ch: C1
) -> AdcDma<ADC1, PINS, Scan, C1>where
    Self: SetChannels<PINS>,

impl Adc<ADC3>

pub fn with_dma<PIN>(
    self,
    pins: PIN,
    dma_ch: C5
) -> AdcDma<ADC3, PIN, Continuous, C5>where
    PIN: Channel<ADC3, ID = u8>,

pub fn with_scan_dma<PINS>(
    self,
    pins: PINS,
    dma_ch: C5
) -> AdcDma<ADC3, PINS, Scan, C5>where
    Self: SetChannels<PINS>,

Trait Implementations

impl ChannelTimeSequence for Adc<ADC1>

fn set_channel_sample_time(&mut self, chan: u8, sample_time: SampleTime)

Set ADC sampling time for particular channel

fn set_regular_sequence(&mut self, channels: &[u8])

ADC Set a Regular Channel Conversion Sequence

fn set_continuous_mode(&mut self, continuous: bool)

Set ADC continuous conversion

fn set_discontinuous_mode(&mut self, channels: Option<u8>)

Set ADC discontinuous mode

impl ChannelTimeSequence for Adc<ADC2>

fn set_channel_sample_time(&mut self, chan: u8, sample_time: SampleTime)

Set ADC sampling time for particular channel

fn set_regular_sequence(&mut self, channels: &[u8])

ADC Set a Regular Channel Conversion Sequence

fn set_continuous_mode(&mut self, continuous: bool)

Set ADC continuous conversion

fn set_discontinuous_mode(&mut self, channels: Option<u8>)

Set ADC discontinuous mode

impl ChannelTimeSequence for Adc<ADC3>

fn set_channel_sample_time(&mut self, chan: u8, sample_time: SampleTime)

Set ADC sampling time for particular channel

fn set_regular_sequence(&mut self, channels: &[u8])

ADC Set a Regular Channel Conversion Sequence

fn set_continuous_mode(&mut self, continuous: bool)

Set ADC continuous conversion

fn set_discontinuous_mode(&mut self, channels: Option<u8>)

Set ADC discontinuous mode

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