Microchip® Advanced Software Framework

rtc_calendar_config Struct Reference

RTC configuration structure.

Configuration structure for the RTC instance. This structure should be initialized using the rtc_calendar_get_config_defaults() before any user configurations are set.

#include <rtc_calendar.h>

Data Fields

struct rtc_calendar_alarm_time alarm [RTC_NUM_OF_ALARMS]
 Alarm values. More...
 
bool clear_on_match
 If true, clears the clock on alarm match. More...
 
bool clock_24h
 If true, time is represented in 24 hour mode. More...
 
bool continuously_update
 If true, the digital counter registers will be continuously updated so that internal synchronization is not needed when reading the current count. More...
 
bool enable_read_sync
 Enable count read synchronization. More...
 
enum rtc_calendar_prescaler prescaler
 Input clock prescaler for the RTC module. More...
 
uint16_t year_init_value
 Initial year for counter value 0. More...
 

struct rtc_calendar_alarm_time rtc_calendar_config::alarm[RTC_NUM_OF_ALARMS]
bool rtc_calendar_config::clear_on_match

If true, clears the clock on alarm match.

Referenced by _rtc_calendar_set_config(), and rtc_calendar_get_config_defaults().

bool rtc_calendar_config::clock_24h

If true, time is represented in 24 hour mode.

Referenced by _rtc_calendar_set_config(), rtc_calendar_get_config_defaults(), rtc_calendar_init(), and run_rtc_calendar_test().

bool rtc_calendar_config::continuously_update

If true, the digital counter registers will be continuously updated so that internal synchronization is not needed when reading the current count.

Referenced by rtc_calendar_get_config_defaults().

bool rtc_calendar_config::enable_read_sync

Enable count read synchronization.

The CLOCK value requires synchronization when reading. Disabling the synchronization will prevent the CLOCK value from displaying the current value.

Referenced by _rtc_calendar_set_config(), and rtc_calendar_get_config_defaults().

enum rtc_calendar_prescaler rtc_calendar_config::prescaler

Input clock prescaler for the RTC module.

Referenced by _rtc_calendar_set_config(), and rtc_calendar_get_config_defaults().

uint16_t rtc_calendar_config::year_init_value

Initial year for counter value 0.

Referenced by rtc_calendar_get_config_defaults(), and rtc_calendar_init().