Real-time clock interface abstraction. More...

#include <rtc.h>

Data Fields
pixelkey_error_t(*	time_get )(struct tm *p_time)
	Gets the current system time in UTC. More...

pixelkey_error_t(*	time_set )(struct tm *const p_time)
	Sets the current system time in UTC. More...

rtc_tzoffset_t(*	tzoffset_get )(void)

pixelkey_error_t(*	tzoffset_set )(rtc_tzoffset_t tzoffset)

pixelkey_error_t(*	timer_alarm_set )(rtc_period_ms_t period)
	Sets a timer alarm to go off in the near future after a set period. More...

pixelkey_error_t(*	calendar_alarm_set )(struct tm *const p_alarm_time)
	Sets a calendar alarm to go off at a set date-time in the future. More...

Detailed Description

Real-time clock interface abstraction.

Field Documentation

pixelkey_error_t(* rtc_api_t::calendar_alarm_set) (struct tm *const p_alarm_time)

Sets a calendar alarm to go off at a set date-time in the future.

Parameters

[in] p_alarm_time Data-time in UTC for the calendar alarm.

pixelkey_error_t(* rtc_api_t::time_get) (struct tm *p_time)

Gets the current system time in UTC.

Parameters

[out] p_time Pointer to time struct to populate.

pixelkey_error_t(* rtc_api_t::time_set) (struct tm *const p_time)

Sets the current system time in UTC.

Parameters

[in] p_time Pointer to the current time.

pixelkey_error_t(* rtc_api_t::timer_alarm_set) (rtc_period_ms_t period)

Sets a timer alarm to go off in the near future after a set period.

Parameters

period Number of milliseconds in the future to alarm at.

The documentation for this struct was generated from the following file: