From 595c3cb881c14a28d37a8a9a3e4aadc79285a673 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Sat, 5 Feb 2022 18:37:05 +0000 Subject: deploy: c74cacd34f68f2897fbd63e2ba90831f87cbad49 --- group__rtc.html | 83 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 41 insertions(+), 42 deletions(-) (limited to 'group__rtc.html') diff --git a/group__rtc.html b/group__rtc.html index 334411c2..84d39c58 100644 --- a/group__rtc.html +++ b/group__rtc.html @@ -2,8 +2,8 @@ - - + + Sensor Watch: Real-Time Clock @@ -19,10 +19,9 @@
- - + @@ -31,21 +30,22 @@
-
Sensor Watch -  0.0.0 +
+
Sensor Watch 0.0.0
A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.
- + +/* @license-end */ + @@ -69,44 +69,43 @@ $(function() { Typedefs | Enumerations | Functions -
-
Real-Time Clock
+
Real-Time Clock

This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions. More...

-

+

Data Structures

union  watch_date_time
 
- -

+

Macros

+
#define WATCH_RTC_REFERENCE_YEAR   (2020)
 
- -

+

Typedefs

+
typedef enum watch_rtc_alarm_match watch_rtc_alarm_match
 
- -

+

Enumerations

enum  watch_rtc_alarm_match { ALARM_MATCH_DISABLED = 0 +
enum  watch_rtc_alarm_match { ALARM_MATCH_DISABLED = 0 , ALARM_MATCH_SS , ALARM_MATCH_MMSS , ALARM_MATCH_HHMMSS }
 
- - + @@ -118,15 +117,15 @@ bool  - + - + @@ -138,8 +137,8 @@ void  - + @@ -153,10 +152,10 @@ void 

+

Functions

-bool _watch_rtc_is_enabled (void)
+bool _watch_rtc_is_enabled (void)
 Called by main.c to check if the RTC is enabled. You may call this function, but outside of app_init, it should always return true.
 
void watch_rtc_set_date_time (watch_date_time date_time)
void watch_rtc_register_alarm_callback (ext_irq_cb_t callback, watch_date_time alarm_time, watch_rtc_alarm_match mask)
 Registers an alarm callback that will be called when the RTC time matches the target time, as masked by the provided mask. More...
 
-void watch_rtc_disable_alarm_callback (void)
+void watch_rtc_disable_alarm_callback (void)
 Disables the alarm callback.
 
void watch_rtc_register_tick_callback (ext_irq_cb_t callback)
 Registers a "tick" callback that will be called once per second. More...
 
-void watch_rtc_disable_tick_callback (void)
+void watch_rtc_disable_tick_callback (void)
 Disables the tick callback for the given period.
 
void watch_rtc_register_periodic_callback (ext_irq_cb_t callback, uint8_t frequency)
void watch_rtc_disable_matching_periodic_callbacks (uint8_t mask)
 Disables tick callbacks for the given periods (as a bitmask). More...
 
-void watch_rtc_disable_all_periodic_callbacks (void)
+void watch_rtc_disable_all_periodic_callbacks (void)
 Disables all periodic callbacks, including the once-per-second tick callback.
 
 __attribute__ ((deprecated("Use watch_rtc_set_date_time function instead"))) void watch_set_date_time(struct calendar_date_time date_time)
 

Detailed Description

-

This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions.

-

The real-time clock is the only peripheral that main.c enables for you. It is the cornerstone of low power operation on the watch, and it is required for several key functions that we assume will be available, namely the wake from BACKUP mode and the callback on the ALARM button. It is also required for the operation of the 1 Hz tick interrupt, which you will most likely use to wake from STANDBY mode.

+

This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions.

+

The real-time clock is the only peripheral that main.c enables for you. It is the cornerstone of low power operation on the watch, and it is required for several key functions that we assume will be available, namely the wake from BACKUP mode and the callback on the ALARM button. It is also required for the operation of the 1 Hz tick interrupt, which you will most likely use to wake from STANDBY mode.

Function Documentation

- +

◆ __attribute__() [1/3]

@@ -182,7 +181,7 @@ void  +

◆ __attribute__() [2/3]

@@ -208,7 +207,7 @@ void  +

◆ __attribute__() [3/3]

@@ -234,7 +233,7 @@ void  +

◆ watch_rtc_disable_matching_periodic_callbacks()

@@ -260,7 +259,7 @@ void  +

◆ watch_rtc_disable_periodic_callback()

@@ -286,7 +285,7 @@ void  +

◆ watch_rtc_get_date_time()

@@ -308,7 +307,7 @@ void  +

◆ watch_rtc_register_alarm_callback()

@@ -357,7 +356,7 @@ void  +

◆ watch_rtc_register_periodic_callback()

@@ -397,7 +396,7 @@ void  +

◆ watch_rtc_register_tick_callback()

@@ -424,7 +423,7 @@ void  +

◆ watch_rtc_set_date_time()

@@ -454,7 +453,7 @@ void  -- cgit v1.2.3