Struct microbit::hal::Rtc

pub struct Rtc<T> { /* fields omitted */ }

An opaque high level interface to an RTC peripheral.

Implementations

impl<T> Rtc<T> where
    T: Instance, 

pub fn new(rtc: T, prescaler: u32) -> Result<Rtc<T>, Error>

Creates a new RTC peripheral instance with a 12 bits prescaler. fRTC = 32_768 / (prescaler + 1 )

pub fn enable_counter(&self)

Enable/start the Real Time Counter.

pub fn disable_counter(&self)

Disable/stop the Real Time Counter.

pub fn enable_interrupt(&mut self, int: RtcInterrupt, nvic: Option<&mut NVIC>)

Enable the generation of a hardware interrupt from a given stimulus.

If access to the NVIC is not provided, the interrupt must ALSO be enabled there outside of this function (e.g. manually call nvic.enable, or through the use of RTFM).

pub fn disable_interrupt(&mut self, int: RtcInterrupt, nvic: Option<&mut NVIC>)

Disable the generation of a hardware interrupt from a given stimulus.

If access to the NVIC is not provided, the interrupt must ALSO be disabled there outside of this function (e.g. manually call nvic.disable, or through the use of RTFM).

pub fn enable_event(&mut self, evt: RtcInterrupt)

Enable the generation of a hardware event from a given stimulus.

pub fn disable_event(&mut self, evt: RtcInterrupt)

Disables the generation of a hardware event from a given stimulus.

pub fn is_event_triggered(&self, evt: RtcInterrupt) -> bool

Checks if the given event has been triggered.

pub fn reset_event(&self, evt: RtcInterrupt)

Resets the given event.

pub fn set_compare(&mut self, reg: RtcCompareReg, val: u32) -> Result<(), Error>

Set the compare value of a given register. The compare registers have a width of 24 bits.

pub fn get_counter(&self) -> u32

Obtain the current value of the Real Time Counter, 24 bits of range.

pub fn clear_counter(&self)

Clear the Real Time Counter.

pub fn trigger_overflow(&self)

Sets the Real Time Counter value to 0xFFFFF0, to allow tests of the overflow condition. The overflow event occurs when the Real Time Counter overflows from 0xFFFFFF to 0.

pub fn release(self) -> T

Destructure the high level interface. Does not reset any configuration made to the given RTC peripheral.