Struct Rtc 

pub struct Rtc<'a> { /* private fields */ }

Minimal RTC handle for a specific instance I (store the zero-sized token like embassy)

Implementations

impl<'a> Rtc<'a>

pub fn new<I: Instance>( _inst: Peri<'a, I>, _irq: impl Binding<I::Interrupt, InterruptHandler<I>> + 'a, config: RtcConfig, ) -> Self

Create a new instance of the real time clock.

pub fn set_datetime(&self, datetime: RtcDateTime)

Set the current date and time

Arguments

• datetime - The date and time to set

Note

The datetime is converted to Unix timestamp and written to the time seconds register.

pub fn get_datetime(&self) -> RtcDateTime

Get the current date and time

Returns

Current date and time as RtcDateTime

Note

Reads the current Unix timestamp from the time seconds register and converts it.

pub fn set_alarm(&self, alarm: RtcDateTime)

Set the alarm date and time

Arguments

• alarm - The date and time when the alarm should trigger

Note

This function:

• Clears any existing alarm by writing 0 to the alarm register
• Waits for the clear operation to complete
• Sets the new alarm time
• Waits for the write operation to complete
• Uses timeouts to prevent infinite loops
• Enables the alarm interrupt after setting

pub fn get_alarm(&self) -> RtcDateTime

Get the current alarm date and time

Returns

Alarm date and time as RtcDateTime

Note

Reads the alarm timestamp from the time alarm register and converts it.

pub fn start(&self)

Start the RTC time counter

Note

Sets the Time Counter Enable (TCE) bit in the status register.

pub fn stop(&self)

Stop the RTC time counter

Note

Clears the Time Counter Enable (TCE) bit in the status register.

pub fn set_interrupt(&self, mask: u32)

Enable specific RTC interrupts

Arguments

• mask - Bitmask of interrupts to enable (use RtcInterruptEnable constants)

Note

This function enables the specified interrupt types and resets the alarm occurred flag. Available interrupts:

• Time Invalid Interrupt
• Time Overflow Interrupt
• Alarm Interrupt
• Seconds Interrupt

pub fn disable_interrupt(&self, mask: u32)

Disable specific RTC interrupts

Arguments

• mask - Bitmask of interrupts to disable (use RtcInterruptEnable constants)

Note

This function disables the specified interrupt types.

pub fn clear_alarm_flag(&self)

Clear the alarm interrupt flag

Note

This function clears the Time Alarm Interrupt Enable bit.

pub async fn wait_for_alarm(&mut self, alarm: RtcDateTime)

Wait for an RTC alarm to trigger.

Arguments

• alarm - The date and time when the alarm should trigger

This function will wait until the RTC alarm is triggered. If no alarm is scheduled, it will wait indefinitely until one is scheduled and triggered.