Struct stm32l0xx_hal::lptim::LpTimer

pub struct LpTimer<M: CountMode> { /* private fields */ }

Low-Power Timer (LPTIM).

The Low-Power Timer is a 16-bit timer with a prescaler of up to 128. It can run off of the APB1, LSI, HSI16, or LSE clocks. With LSE, the slowest clock at 32.768 kHz, this results in a maximum timeout of 256 seconds, or 4 minutes and 16 seconds.

The timer can be initialized either in one-shot mode or in periodic mode, using init_oneshot or init_periodic respectively. In periodic mode, the embedded-hal Periodic marker trait is implemented and the CountDown implementation uses Hertz as the time unit. In one-shot mode, the CountDown implementation instead uses Microseconds, allowing for a multi-second timeout to be configured (with the tradeoff being a larger code size due to use of 64-bit arithmetic).

Implementations

impl LpTimer<Periodic>

pub fn init_periodic(
    lptim: LPTIM,
    pwr: &mut PWR,
    rcc: &mut Rcc,
    clk: ClockSrc
) -> Self

Initializes the Low-Power Timer in periodic mode.

The timer needs to be started by calling .start(freq).

impl LpTimer<OneShot>

pub fn init_oneshot(
    lptim: LPTIM,
    pwr: &mut PWR,
    rcc: &mut Rcc,
    clk: ClockSrc
) -> Self

Initializes the Low-Power Timer in one-shot mode.

The timer needs to be started by calling .start(freq).

impl LpTimer<Encoder>

pub fn init_encoder(
    lptim: LPTIM,
    pwr: &mut PWR,
    rcc: &mut Rcc,
    clk: ClockSrc,
    (pb5, pb7): (PB5<Analog>, PB7<Analog>)
) -> Self

Initializes the Low-Power Timer in encoder mode.

The start method must be called to enable the encoder input.

pub fn enable(&mut self, arr: u16)

Enable the timer and begin counting encoder pulses.

The provided value is stored in the ARR (Auto Reload Register). The timer’s internal counter will wrap when this value is reached.

pub fn disable(&mut self)

Disable the timer.

pub fn count(&self) -> u16

Get the current count of the encoder.

pub fn clear_flags(&self)

Clear all LPTIM interrupt flags

impl<M: CountMode> LpTimer<M>

pub fn free(self) -> LPTIM

Disables and destructs the timer, returning the raw LPTIM peripheral.

pub fn enable_interrupts(&mut self, interrupts: Interrupts)

Disables the timer and enables the given interrupts.

pub fn disable_interrupts(&mut self, interrupts: Interrupts)

Disables the timer and disables the given interrupts.

Trait Implementations

impl CountDown for LpTimer<OneShot>

type Time = Microseconds<u32>

The unit of time used by this timer

fn start<T>(&mut self, period: T) where
    T: Into<Microseconds>, 

Starts a new count down

fn wait(&mut self) -> Result<(), Void>

Non-blockingly “waits” until the count down finishes

impl CountDown for LpTimer<Periodic>

type Time = Hertz<u32>

The unit of time used by this timer

fn start<T>(&mut self, freq: T) where
    T: Into<Hertz>, 

Starts a new count down

fn wait(&mut self) -> Result<(), Void>

Non-blockingly “waits” until the count down finishes

impl Periodic for LpTimer<Periodic>