web/docs/rtc_8h.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/hardware/rtc.h File Reference</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0-develop
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('rtc_8h.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#typedef-members">Typedefs</a> &#124;
 107 <a href="#func-members">Functions</a>  </div>
 108   <div class="headertitle"><div class="title">rtc.h File Reference</div></div>
 109 </div><!--header-->
 110 <div class="contents">
 111 <div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
 112 <code>#include &quot;hardware/structs/rtc.h&quot;</code><br />
 113 </div><div class="textblock"><div class="dynheader">
 114 Include dependency graph for rtc.h:</div>
 115 <div class="dyncontent">
 116 <div class="center"><img src="rtc_8h__incl.png" border="0" usemap="#ainclude_2hardware_2rtc_8h" alt=""/></div>
 117 <map name="ainclude_2hardware_2rtc_8h" id="ainclude_2hardware_2rtc_8h">
 118 <area shape="rect" title=" " alt="" coords="427,5,593,32"/>
 119 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="411,80,473,107"/>
 120 <area shape="rect" title=" " alt="" coords="497,80,661,107"/>
 121 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,304,259,331"/>
 122 <area shape="rect" title=" " alt="" coords="252,155,365,181"/>
 123 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="390,155,494,181"/>
 124 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="596,155,717,181"/>
 125 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="741,155,836,181"/>
 126 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,379,111,405"/>
 127 <area shape="rect" title=" " alt="" coords="74,453,157,480"/>
 128 <area shape="rect" title=" " alt="" coords="211,379,281,405"/>
 129 <area shape="rect" title=" " alt="" coords="306,379,381,405"/>
 130 <area shape="rect" title=" " alt="" coords="173,229,337,256"/>
 131 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,229,543,256"/>
 132 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,229,746,256"/>
 133 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,229,930,256"/>
 134 <area shape="rect" title=" " alt="" coords="954,229,1165,256"/>
 135 <area shape="rect" title=" " alt="" coords="1189,229,1340,256"/>
 136 <area shape="rect" title=" " alt="" coords="357,304,548,331"/>
 137 </map>
 138 </div>
 139 </div>
 140 <p><a href="rtc_8h_source.html">Go to the source code of this file.</a></p>
 141 <table class="memberdecls">
 142 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 143 Typedefs</h2></td></tr>
 144 <tr class="memitem:ga05a9e12c70c56e6e2a9869d0682045d1"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a>) (void)</td></tr>
 145 <tr class="separator:ga05a9e12c70c56e6e2a9869d0682045d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 </table><table class="memberdecls">
 147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 148 Functions</h2></td></tr>
 149 <tr class="memitem:gacf9024748b942a7ae375cf75951afa9c"><td class="memItemLeft" align="right" valign="top">
 150 void&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_init</b> (void)</td></tr>
 151 <tr class="memdesc:gacf9024748b942a7ae375cf75951afa9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the RTC system. <br /></td></tr>
 152 <tr class="separator:gacf9024748b942a7ae375cf75951afa9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga076d68dec35129dd2b44d16ae457a3de"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#ga076d68dec35129dd2b44d16ae457a3de">rtc_set_datetime</a> (const <a class="el" href="structdatetime__t.html">datetime_t</a> *t)</td></tr>
 154 <tr class="memdesc:ga076d68dec35129dd2b44d16ae457a3de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the RTC to the specified time.  <a href="group__hardware__rtc.html#ga076d68dec35129dd2b44d16ae457a3de">More...</a><br /></td></tr>
 155 <tr class="separator:ga076d68dec35129dd2b44d16ae457a3de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga7c5528e71733b7bfc0b0543cd3bb6d3f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#ga7c5528e71733b7bfc0b0543cd3bb6d3f">rtc_get_datetime</a> (<a class="el" href="structdatetime__t.html">datetime_t</a> *t)</td></tr>
 157 <tr class="memdesc:ga7c5528e71733b7bfc0b0543cd3bb6d3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time from the RTC.  <a href="group__hardware__rtc.html#ga7c5528e71733b7bfc0b0543cd3bb6d3f">More...</a><br /></td></tr>
 158 <tr class="separator:ga7c5528e71733b7bfc0b0543cd3bb6d3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:gabf6cc1546be8d1ddb56e3d83a915f683"><td class="memItemLeft" align="right" valign="top">
 160 bool&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_running</b> (void)</td></tr>
 161 <tr class="memdesc:gabf6cc1546be8d1ddb56e3d83a915f683"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the RTC running? <br /></td></tr>
 162 <tr class="separator:gabf6cc1546be8d1ddb56e3d83a915f683"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:gaac8ad85f301295b6a130aa8e00122253"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#gaac8ad85f301295b6a130aa8e00122253">rtc_set_alarm</a> (const <a class="el" href="structdatetime__t.html">datetime_t</a> *t, <a class="el" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a> user_callback)</td></tr>
 164 <tr class="memdesc:gaac8ad85f301295b6a130aa8e00122253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a time in the future for the RTC to call a user provided callback.  <a href="group__hardware__rtc.html#gaac8ad85f301295b6a130aa8e00122253">More...</a><br /></td></tr>
 165 <tr class="separator:gaac8ad85f301295b6a130aa8e00122253"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:gab7f69ee0de1cae2518b2822fd82d5201"><td class="memItemLeft" align="right" valign="top">
 167 void&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_enable_alarm</b> (void)</td></tr>
 168 <tr class="memdesc:gab7f69ee0de1cae2518b2822fd82d5201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the RTC alarm (if inactive) <br /></td></tr>
 169 <tr class="separator:gab7f69ee0de1cae2518b2822fd82d5201"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:ga718b866eab2ba73221d37f7d15ba9737"><td class="memItemLeft" align="right" valign="top">
 171 void&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_disable_alarm</b> (void)</td></tr>
 172 <tr class="memdesc:ga718b866eab2ba73221d37f7d15ba9737"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the RTC alarm (if active) <br /></td></tr>
 173 <tr class="separator:ga718b866eab2ba73221d37f7d15ba9737"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 </table>
 175 </div><!-- contents -->
 176 </div><!-- doc-content -->
 177
 178         <script src="main.js"></script>
 179 </body>
 180 </html>