Struct rp2040_hal::rtc::RealTimeClock

pub struct RealTimeClock { /* private fields */ }

A reference to the real time clock of the system

Implementations

impl RealTimeClock

pub fn new( rtc: RTC, clock: RtcClock, resets: &mut RESETS, initial_date: DateTime ) -> Result<Self, RtcError>

Create a new instance of the real time clock, with the given date as an initial value.

Note that the ClocksManager should be enabled first. See the clocks module for more information.

Errors

Will return RtcError::InvalidDateTime if the datetime is not a valid range.

pub fn set_leap_year_check(&mut self, leap_year_check_enabled: bool)

Enable or disable the leap year check. The rp2040 chip will always add a Feb 29th on every year that is divisible by 4, but this may be incorrect (e.g. on century years). This function allows you to disable this check.

Leap year checking is enabled by default.

pub fn is_running(&self) -> bool

Checks to see if this RealTimeClock is running

pub fn set_datetime(&mut self, t: DateTime) -> Result<(), RtcError>

Set the datetime to a new value.

Errors

Will return RtcError::InvalidDateTime if the datetime is not a valid range.

pub fn now(&self) -> Result<DateTime, RtcError>

Return the current datetime.

Errors

Will return an RtcError::InvalidDateTime if the stored value in the system is not a valid DayOfWeek.

pub fn disable_alarm(&mut self)

Disable the alarm that was scheduled with schedule_alarm.

pub fn schedule_alarm(&mut self, filter: DateTimeFilter)

Schedule an alarm. The filter determines at which point in time this alarm is set.

If not all fields are set, the alarm will repeat each time the RTC reaches these values. For example, to fire every minute, set:

real_time_clock.schedule_alarm(DateTimeFilter::default().second(0));

It is worth nothing that the alarm will not fire on schedule if the current time matches.

pub fn enable_interrupt(&mut self)

Enable the propagation of alarm to the NVIC.

pub fn disable_interrupt(&mut self)

Disable the propagation of the alarm to the NVIC.

pub fn clear_interrupt(&mut self)

Clear the interrupt.

This should be called every time the RTC_IRQ interrupt is triggered or the interrupt will continually fire..

pub fn free(self, resets: &mut RESETS) -> (RTC, RtcClock)

Free the RTC peripheral and RTC clock