diff options
Diffstat (limited to 'group__rtc.html')
| -rw-r--r-- | group__rtc.html | 83 |
1 files changed, 41 insertions, 42 deletions
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 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.9.1"/> +<meta http-equiv="X-UA-Compatible" content="IE=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Sensor Watch: Real-Time Clock</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -19,10 +19,9 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr style="height: 56px;"> - <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">Sensor Watch -  <span id="projectnumber">0.0.0</span> + <tr id="projectrow"> + <td id="projectalign"> + <div id="projectname">Sensor Watch<span id="projectnumber"> 0.0.0</span> </div> <div id="projectbrief">A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.</div> </td> @@ -31,21 +30,22 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.1 --> +<!-- Generated by Doxygen 1.9.3 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'Search','.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -/* @license-end */</script> +/* @license-end */ +</script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> @@ -69,44 +69,43 @@ $(function() { <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Real-Time Clock</div> </div> + <div class="headertitle"><div class="title">Real-Time Clock</div></div> </div><!--header--> <div class="contents"> <p>This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions. <a href="#details">More...</a></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="unionwatch__date__time.html">watch_date_time</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:ga9bc41a324472cc3c2f39679849e3a4e9"><td class="memItemLeft" align="right" valign="top"><a id="ga9bc41a324472cc3c2f39679849e3a4e9"></a> +<tr class="memitem:ga9bc41a324472cc3c2f39679849e3a4e9"><td class="memItemLeft" align="right" valign="top"><a id="ga9bc41a324472cc3c2f39679849e3a4e9" name="ga9bc41a324472cc3c2f39679849e3a4e9"></a> #define </td><td class="memItemRight" valign="bottom"><b>WATCH_RTC_REFERENCE_YEAR</b>   (2020)</td></tr> <tr class="separator:ga9bc41a324472cc3c2f39679849e3a4e9"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a> Typedefs</h2></td></tr> -<tr class="memitem:ga13ec58aba1f66d56e859e6b64dc0b47a"><td class="memItemLeft" align="right" valign="top"><a id="ga13ec58aba1f66d56e859e6b64dc0b47a"></a> +<tr class="memitem:ga13ec58aba1f66d56e859e6b64dc0b47a"><td class="memItemLeft" align="right" valign="top"><a id="ga13ec58aba1f66d56e859e6b64dc0b47a" name="ga13ec58aba1f66d56e859e6b64dc0b47a"></a> typedef enum watch_rtc_alarm_match </td><td class="memItemRight" valign="bottom"><b>watch_rtc_alarm_match</b></td></tr> <tr class="separator:ga13ec58aba1f66d56e859e6b64dc0b47a"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> Enumerations</h2></td></tr> -<tr class="memitem:gaa0a79638c3b14ee82798ca18fbb2014a"><td class="memItemLeft" align="right" valign="top"><a id="gaa0a79638c3b14ee82798ca18fbb2014a"></a>enum  </td><td class="memItemRight" valign="bottom"><b>watch_rtc_alarm_match</b> { <b>ALARM_MATCH_DISABLED</b> = 0 +<tr class="memitem:gaa0a79638c3b14ee82798ca18fbb2014a"><td class="memItemLeft" align="right" valign="top"><a id="gaa0a79638c3b14ee82798ca18fbb2014a" name="gaa0a79638c3b14ee82798ca18fbb2014a"></a>enum  </td><td class="memItemRight" valign="bottom"><b>watch_rtc_alarm_match</b> { <b>ALARM_MATCH_DISABLED</b> = 0 , <b>ALARM_MATCH_SS</b> , <b>ALARM_MATCH_MMSS</b> , <b>ALARM_MATCH_HHMMSS</b> }</td></tr> <tr class="separator:gaa0a79638c3b14ee82798ca18fbb2014a"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga3ac65a314540ae8b7be5b9015785d565"><td class="memItemLeft" align="right" valign="top"><a id="ga3ac65a314540ae8b7be5b9015785d565"></a> -bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga3ac65a314540ae8b7be5b9015785d565">_watch_rtc_is_enabled</a> (void)</td></tr> +<tr class="memitem:ga3ac65a314540ae8b7be5b9015785d565"><td class="memItemLeft" align="right" valign="top"><a id="ga3ac65a314540ae8b7be5b9015785d565" name="ga3ac65a314540ae8b7be5b9015785d565"></a> +bool </td><td class="memItemRight" valign="bottom"><b>_watch_rtc_is_enabled</b> (void)</td></tr> <tr class="memdesc:ga3ac65a314540ae8b7be5b9015785d565"><td class="mdescLeft"> </td><td class="mdescRight">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. <br /></td></tr> <tr class="separator:ga3ac65a314540ae8b7be5b9015785d565"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadfcc143db9d71e95c2d2dc45732ab4e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gadfcc143db9d71e95c2d2dc45732ab4e5">watch_rtc_set_date_time</a> (<a class="el" href="unionwatch__date__time.html">watch_date_time</a> date_time)</td></tr> @@ -118,15 +117,15 @@ bool </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <tr class="memitem:gaa5220d0d7f542a0bc6c9bef176d6d83b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gaa5220d0d7f542a0bc6c9bef176d6d83b">watch_rtc_register_alarm_callback</a> (ext_irq_cb_t callback, <a class="el" href="unionwatch__date__time.html">watch_date_time</a> alarm_time, watch_rtc_alarm_match mask)</td></tr> <tr class="memdesc:gaa5220d0d7f542a0bc6c9bef176d6d83b"><td class="mdescLeft"> </td><td class="mdescRight">Registers an alarm callback that will be called when the RTC time matches the target time, as masked by the provided mask. <a href="group__rtc.html#gaa5220d0d7f542a0bc6c9bef176d6d83b">More...</a><br /></td></tr> <tr class="separator:gaa5220d0d7f542a0bc6c9bef176d6d83b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga836cade77c24e93c06bf534eaded55bf"><td class="memItemLeft" align="right" valign="top"><a id="ga836cade77c24e93c06bf534eaded55bf"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga836cade77c24e93c06bf534eaded55bf">watch_rtc_disable_alarm_callback</a> (void)</td></tr> +<tr class="memitem:ga836cade77c24e93c06bf534eaded55bf"><td class="memItemLeft" align="right" valign="top"><a id="ga836cade77c24e93c06bf534eaded55bf" name="ga836cade77c24e93c06bf534eaded55bf"></a> +void </td><td class="memItemRight" valign="bottom"><b>watch_rtc_disable_alarm_callback</b> (void)</td></tr> <tr class="memdesc:ga836cade77c24e93c06bf534eaded55bf"><td class="mdescLeft"> </td><td class="mdescRight">Disables the alarm callback. <br /></td></tr> <tr class="separator:ga836cade77c24e93c06bf534eaded55bf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga969ea57aaedf13d4950edbeacff3f2be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga969ea57aaedf13d4950edbeacff3f2be">watch_rtc_register_tick_callback</a> (ext_irq_cb_t callback)</td></tr> <tr class="memdesc:ga969ea57aaedf13d4950edbeacff3f2be"><td class="mdescLeft"> </td><td class="mdescRight">Registers a "tick" callback that will be called once per second. <a href="group__rtc.html#ga969ea57aaedf13d4950edbeacff3f2be">More...</a><br /></td></tr> <tr class="separator:ga969ea57aaedf13d4950edbeacff3f2be"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga685f2afb2e99dfebf8d2ef058a5bc19d"><td class="memItemLeft" align="right" valign="top"><a id="ga685f2afb2e99dfebf8d2ef058a5bc19d"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga685f2afb2e99dfebf8d2ef058a5bc19d">watch_rtc_disable_tick_callback</a> (void)</td></tr> +<tr class="memitem:ga685f2afb2e99dfebf8d2ef058a5bc19d"><td class="memItemLeft" align="right" valign="top"><a id="ga685f2afb2e99dfebf8d2ef058a5bc19d" name="ga685f2afb2e99dfebf8d2ef058a5bc19d"></a> +void </td><td class="memItemRight" valign="bottom"><b>watch_rtc_disable_tick_callback</b> (void)</td></tr> <tr class="memdesc:ga685f2afb2e99dfebf8d2ef058a5bc19d"><td class="mdescLeft"> </td><td class="mdescRight">Disables the tick callback for the given period. <br /></td></tr> <tr class="separator:ga685f2afb2e99dfebf8d2ef058a5bc19d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaeb4e67aa0062e39eaff465aeebc24f53"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gaeb4e67aa0062e39eaff465aeebc24f53">watch_rtc_register_periodic_callback</a> (ext_irq_cb_t callback, uint8_t frequency)</td></tr> @@ -138,8 +137,8 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <tr class="memitem:gadccd826da474b5fe24cac8d8edc88ae6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gadccd826da474b5fe24cac8d8edc88ae6">watch_rtc_disable_matching_periodic_callbacks</a> (uint8_t mask)</td></tr> <tr class="memdesc:gadccd826da474b5fe24cac8d8edc88ae6"><td class="mdescLeft"> </td><td class="mdescRight">Disables tick callbacks for the given periods (as a bitmask). <a href="group__rtc.html#gadccd826da474b5fe24cac8d8edc88ae6">More...</a><br /></td></tr> <tr class="separator:gadccd826da474b5fe24cac8d8edc88ae6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0150da34307ba61e44f1a00aa90a7f0f"><td class="memItemLeft" align="right" valign="top"><a id="ga0150da34307ba61e44f1a00aa90a7f0f"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga0150da34307ba61e44f1a00aa90a7f0f">watch_rtc_disable_all_periodic_callbacks</a> (void)</td></tr> +<tr class="memitem:ga0150da34307ba61e44f1a00aa90a7f0f"><td class="memItemLeft" align="right" valign="top"><a id="ga0150da34307ba61e44f1a00aa90a7f0f" name="ga0150da34307ba61e44f1a00aa90a7f0f"></a> +void </td><td class="memItemRight" valign="bottom"><b>watch_rtc_disable_all_periodic_callbacks</b> (void)</td></tr> <tr class="memdesc:ga0150da34307ba61e44f1a00aa90a7f0f"><td class="mdescLeft"> </td><td class="mdescRight">Disables all periodic callbacks, including the once-per-second tick callback. <br /></td></tr> <tr class="separator:ga0150da34307ba61e44f1a00aa90a7f0f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga98366c1b71e09089b441d704193bb0d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga98366c1b71e09089b441d704193bb0d4">__attribute__</a> ((deprecated("Use <a class="el" href="group__rtc.html#gadfcc143db9d71e95c2d2dc45732ab4e5">watch_rtc_set_date_time</a> function instead"))) void watch_set_date_time(struct calendar_date_time date_time)</td></tr> @@ -153,10 +152,10 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <tr class="separator:ga811201003a3985a040f1f6bd3c5a69eb"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions. </p> -<p>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. </p> +<p >This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions. </p> +<p >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. </p> <h2 class="groupheader">Function Documentation</h2> -<a id="ga7ce8c01a25eb364efb7ae6ed6dbca373"></a> +<a id="ga7ce8c01a25eb364efb7ae6ed6dbca373" name="ga7ce8c01a25eb364efb7ae6ed6dbca373"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7ce8c01a25eb364efb7ae6ed6dbca373">◆ </a></span>__attribute__() <span class="overload">[1/3]</span></h2> <div class="memitem"> @@ -182,7 +181,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga811201003a3985a040f1f6bd3c5a69eb"></a> +<a id="ga811201003a3985a040f1f6bd3c5a69eb" name="ga811201003a3985a040f1f6bd3c5a69eb"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga811201003a3985a040f1f6bd3c5a69eb">◆ </a></span>__attribute__() <span class="overload">[2/3]</span></h2> <div class="memitem"> @@ -208,7 +207,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga98366c1b71e09089b441d704193bb0d4"></a> +<a id="ga98366c1b71e09089b441d704193bb0d4" name="ga98366c1b71e09089b441d704193bb0d4"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga98366c1b71e09089b441d704193bb0d4">◆ </a></span>__attribute__() <span class="overload">[3/3]</span></h2> <div class="memitem"> @@ -234,7 +233,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gadccd826da474b5fe24cac8d8edc88ae6"></a> +<a id="gadccd826da474b5fe24cac8d8edc88ae6" name="gadccd826da474b5fe24cac8d8edc88ae6"></a> <h2 class="memtitle"><span class="permalink"><a href="#gadccd826da474b5fe24cac8d8edc88ae6">◆ </a></span>watch_rtc_disable_matching_periodic_callbacks()</h2> <div class="memitem"> @@ -260,7 +259,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga4e025485bb50e1c93abd4a185447705f"></a> +<a id="ga4e025485bb50e1c93abd4a185447705f" name="ga4e025485bb50e1c93abd4a185447705f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4e025485bb50e1c93abd4a185447705f">◆ </a></span>watch_rtc_disable_periodic_callback()</h2> <div class="memitem"> @@ -286,7 +285,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga166b575563d39a0061dc9a28ad0309a7"></a> +<a id="ga166b575563d39a0061dc9a28ad0309a7" name="ga166b575563d39a0061dc9a28ad0309a7"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga166b575563d39a0061dc9a28ad0309a7">◆ </a></span>watch_rtc_get_date_time()</h2> <div class="memitem"> @@ -308,7 +307,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gaa5220d0d7f542a0bc6c9bef176d6d83b"></a> +<a id="gaa5220d0d7f542a0bc6c9bef176d6d83b" name="gaa5220d0d7f542a0bc6c9bef176d6d83b"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaa5220d0d7f542a0bc6c9bef176d6d83b">◆ </a></span>watch_rtc_register_alarm_callback()</h2> <div class="memitem"> @@ -357,7 +356,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gaeb4e67aa0062e39eaff465aeebc24f53"></a> +<a id="gaeb4e67aa0062e39eaff465aeebc24f53" name="gaeb4e67aa0062e39eaff465aeebc24f53"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaeb4e67aa0062e39eaff465aeebc24f53">◆ </a></span>watch_rtc_register_periodic_callback()</h2> <div class="memitem"> @@ -397,7 +396,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga969ea57aaedf13d4950edbeacff3f2be"></a> +<a id="ga969ea57aaedf13d4950edbeacff3f2be" name="ga969ea57aaedf13d4950edbeacff3f2be"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga969ea57aaedf13d4950edbeacff3f2be">◆ </a></span>watch_rtc_register_tick_callback()</h2> <div class="memitem"> @@ -424,7 +423,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gadfcc143db9d71e95c2d2dc45732ab4e5"></a> +<a id="gadfcc143db9d71e95c2d2dc45732ab4e5" name="gadfcc143db9d71e95c2d2dc45732ab4e5"></a> <h2 class="memtitle"><span class="permalink"><a href="#gadfcc143db9d71e95c2d2dc45732ab4e5">◆ </a></span>watch_rtc_set_date_time()</h2> <div class="memitem"> @@ -454,7 +453,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </small></address> </body> </html> |