Struct stm32f4xx_hal::rtc::Rtc

pub struct Rtc<CS: FrequencySource = Lse> {
    pub regs: RTC,
    /* private fields */
}

Real Time Clock peripheral

Fields

regs: RTC

RTC Peripheral register

Implementations

impl Rtc<Lse>

pub fn new(regs: RTC, pwr: &mut PWR) -> Self

Create and enable a new RTC with external crystal or ceramic resonator and default prescalers.

pub fn with_config( regs: RTC, pwr: &mut PWR, mode: LSEClockMode, prediv_s: u16, prediv_a: u8 ) -> Self

Create and enable a new RTC, and configure its clock source and prescalers.

From AN3371, Table 3, when using the LSE, set prediv_s to 255, and prediv_a to 127 to get a calendar clock of 1Hz.

impl Rtc<Lsi>

pub fn new_lsi(regs: RTC, pwr: &mut PWR) -> Self

Create and enable a new RTC with internal crystal and default prescalers.

pub fn lsi_with_config( regs: RTC, pwr: &mut PWR, prediv_s: u16, prediv_a: u8 ) -> Self

Create and enable a new RTC, and configure its clock source and prescalers.

From AN3371, Table 3, when using the LSI, set prediv_s to 249, and prediv_a to 127 to get a calendar clock of 1Hz.

impl<CS: FrequencySource> Rtc<CS>

pub fn set_prescalers(&mut self, prediv_s: u16, prediv_a: u8)

pub fn set_time(&mut self, time: &Time) -> Result<(), Error>

Set the time using time::Time.

pub fn set_seconds(&mut self, seconds: u8) -> Result<(), Error>

Set the seconds [0-59].

pub fn set_minutes(&mut self, minutes: u8) -> Result<(), Error>

Set the minutes [0-59].

pub fn set_hours(&mut self, hours: u8) -> Result<(), Error>

Set the hours [0-23].

pub fn set_weekday(&mut self, weekday: u8) -> Result<(), Error>

Set the day of week [1-7].

pub fn set_day(&mut self, day: u8) -> Result<(), Error>

Set the day of month [1-31].

pub fn set_month(&mut self, month: u8) -> Result<(), Error>

Set the month [1-12].

pub fn set_year(&mut self, year: u16) -> Result<(), Error>

Set the year [1970-2069].

The year cannot be less than 1970, since the Unix epoch is assumed (1970-01-01 00:00:00). Also, the year cannot be greater than 2069 since the RTC range is 0 - 99.

pub fn set_date(&mut self, date: &Date) -> Result<(), Error>

Set the date.

The year cannot be less than 1970, since the Unix epoch is assumed (1970-01-01 00:00:00). Also, the year cannot be greater than 2069 since the RTC range is 0 - 99.

pub fn set_datetime(&mut self, date: &PrimitiveDateTime) -> Result<(), Error>

Set the date and time.

The year cannot be less than 1970, since the Unix epoch is assumed (1970-01-01 00:00:00). Also, the year cannot be greater than 2069 since the RTC range is 0 - 99.

pub fn get_datetime(&mut self) -> PrimitiveDateTime

pub fn enable_wakeup(&mut self, interval: MicrosDurationU64)

Configures the wakeup timer to trigger periodically every interval duration

Panics

Panics if interval is greater than 2¹⁷-1 seconds.

pub fn disable_wakeup(&mut self)

Disables the wakeup timer

pub fn enable_vbat_timestamp(&mut self)

Configures the timestamp to be captured when the RTC switches to Vbat power

pub fn disable_timestamp(&mut self)

Disables the timestamp

pub fn read_timestamp(&self) -> PrimitiveDateTime

Reads the stored value of the timestamp if present

Clears the timestamp interrupt flags.

pub fn set_alarm( &mut self, alarm: Alarm, date: impl Into<AlarmDay>, time: Time ) -> Result<(), Error>

Sets the time at which an alarm will be triggered This also clears the alarm flag if it is set

pub fn listen(&mut self, exti: &mut EXTI, event: Event)

Start listening for event

pub fn unlisten(&mut self, exti: &mut EXTI, event: Event)

Stop listening for event

pub fn is_pending(&self, event: Event) -> bool

Returns true if event is pending

pub fn clear_interrupt(&mut self, event: Event)

Clears the interrupt flag for event

Trait Implementations

impl Debug for Rtc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Format for Rtc

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.