Struct stm32l0xx_hal::rtc::WakeupTimer

pub struct WakeupTimer<'r> { /* fields omitted */ }

The RTC wakeup timer

This timer can be used in two ways:

1. Continually call wait until it returns Ok(()).
2. Set up the RTC interrupt.

If you use an interrupt, you should still call wait once, after the interrupt fired. This should return Ok(()) immediately. Doing this will reset the timer flag. If you don't do this, the interrupt will not fire again, if you go to sleep.

You don't need to call wait, if you call cancel, as that also resets the flag. Restarting the timer by calling start will also reset the flag.

Trait Implementations

impl<'_> CountDown for WakeupTimer<'_>

type Time = u32

The unit of time used by this timer

fn start<T>(&mut self, delay: T) where
    T: Into<Self::Time>, 

Starts the wakeup timer

The delay argument specifies the timer delay in seconds. Up to 17 bits of delay are supported, giving us a range of over 36 hours.

Panics

The delay argument must be in the range 1 <= delay <= 2^17. Panics, if delay is outside of that range.

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

Non-blockingly "waits" until the count down finishes

impl<'_> Periodic for WakeupTimer<'_>

impl<'_> Cancel for WakeupTimer<'_>

type Error = Void

Error returned when a countdown can't be canceled.

fn cancel(&mut self) -> Result<(), Self::Error>

Tries to cancel this countdown.