diff options
Diffstat (limited to 'group__app.html')
| -rw-r--r-- | group__app.html | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/group__app.html b/group__app.html index a2cea10c..9f34b744 100644 --- a/group__app.html +++ b/group__app.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: Application Framework</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 --> @@ -65,22 +65,21 @@ $(function() { <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Application Framework</div> </div> + <div class="headertitle"><div class="title">Application Framework</div></div> </div><!--header--> <div class="contents"> <p>This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app. <a href="#details">More...</a></p> <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:gadd3190cf715f513666f4be42874d91e2"><td class="memItemLeft" align="right" valign="top"><a id="gadd3190cf715f513666f4be42874d91e2"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gadd3190cf715f513666f4be42874d91e2">app_init</a> (void)</td></tr> +<tr class="memitem:gadd3190cf715f513666f4be42874d91e2"><td class="memItemLeft" align="right" valign="top"><a id="gadd3190cf715f513666f4be42874d91e2" name="gadd3190cf715f513666f4be42874d91e2"></a> +void </td><td class="memItemRight" valign="bottom"><b>app_init</b> (void)</td></tr> <tr class="memdesc:gadd3190cf715f513666f4be42874d91e2"><td class="mdescLeft"> </td><td class="mdescRight">A function you will implement to initialize your application state. The app_init function is called before anything else. Use it to set up any internal data structures or application state required by your app, but don't configure any peripherals just yet. <br /></td></tr> <tr class="separator:gadd3190cf715f513666f4be42874d91e2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab6a9f08ba879ce8d28fb19ca2882890a"><td class="memItemLeft" align="right" valign="top"><a id="gab6a9f08ba879ce8d28fb19ca2882890a"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gab6a9f08ba879ce8d28fb19ca2882890a">app_wake_from_backup</a> (void)</td></tr> +<tr class="memitem:gab6a9f08ba879ce8d28fb19ca2882890a"><td class="memItemLeft" align="right" valign="top"><a id="gab6a9f08ba879ce8d28fb19ca2882890a" name="gab6a9f08ba879ce8d28fb19ca2882890a"></a> +void </td><td class="memItemRight" valign="bottom"><b>app_wake_from_backup</b> (void)</td></tr> <tr class="memdesc:gab6a9f08ba879ce8d28fb19ca2882890a"><td class="mdescLeft"> </td><td class="mdescRight">A function you will implement to wake from BACKUP mode, which wipes the system's RAM, and with it, your application's state. You may have chosen to store some important application state in the RTC's backup registers prior to entering this mode. You may restore that state here. <br /></td></tr> <tr class="separator:gab6a9f08ba879ce8d28fb19ca2882890a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gacce192accedbd296eb8d2182f8101f16"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gacce192accedbd296eb8d2182f8101f16">app_setup</a> (void)</td></tr> @@ -92,14 +91,14 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou <tr class="memitem:gaee30a1614f76afc41117f7176fb30165"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gaee30a1614f76afc41117f7176fb30165">app_prepare_for_standby</a> (void)</td></tr> <tr class="memdesc:gaee30a1614f76afc41117f7176fb30165"><td class="mdescLeft"> </td><td class="mdescRight">A function you will implement to prepare to enter STANDBY mode. The app_prepare_for_standby function is called after your app_loop function returns true, and just before the watch enters STANDBY mode. In this mode most peripherals are shut down, and no code will run until the watch receives an interrupt (generally either the 1Hz tick or a press on one of the buttons). <a href="group__app.html#gaee30a1614f76afc41117f7176fb30165">More...</a><br /></td></tr> <tr class="separator:gaee30a1614f76afc41117f7176fb30165"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gacc7e7ff6108524545ab4183110811874"><td class="memItemLeft" align="right" valign="top"><a id="gacc7e7ff6108524545ab4183110811874"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gacc7e7ff6108524545ab4183110811874">app_wake_from_standby</a> (void)</td></tr> +<tr class="memitem:gacc7e7ff6108524545ab4183110811874"><td class="memItemLeft" align="right" valign="top"><a id="gacc7e7ff6108524545ab4183110811874" name="gacc7e7ff6108524545ab4183110811874"></a> +void </td><td class="memItemRight" valign="bottom"><b>app_wake_from_standby</b> (void)</td></tr> <tr class="memdesc:gacc7e7ff6108524545ab4183110811874"><td class="mdescLeft"> </td><td class="mdescRight">A method you will implement to configure the app after waking from STANDBY mode. <br /></td></tr> <tr class="separator:gacc7e7ff6108524545ab4183110811874"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app. </p> -<p>You should be able to write a watch app by simply implementing these functions and declaring callbacks for various GPIO and peripheral interrupts. The main.c file takes care of calling these functions for you. The general flow:</p> +<p >This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app. </p> +<p >You should be able to write a watch app by simply implementing these functions and declaring callbacks for various GPIO and peripheral interrupts. The main.c file takes care of calling these functions for you. The general flow:</p> <ol type="1"> <li>Your <a class="el" href="group__app.html#gadd3190cf715f513666f4be42874d91e2" title="A function you will implement to initialize your application state. The app_init function is called b...">app_init()</a> function is called.<ul> <li>This method should only be used to set your initial application state.</li> @@ -135,7 +134,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </li> </ol> <h2 class="groupheader">Function Documentation</h2> -<a id="gad1cfce0ef962cd2afe2d8b2d2d13482a"></a> +<a id="gad1cfce0ef962cd2afe2d8b2d2d13482a" name="gad1cfce0ef962cd2afe2d8b2d2d13482a"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad1cfce0ef962cd2afe2d8b2d2d13482a">◆ </a></span>app_loop()</h2> <div class="memitem"> @@ -157,7 +156,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gaee30a1614f76afc41117f7176fb30165"></a> +<a id="gaee30a1614f76afc41117f7176fb30165" name="gaee30a1614f76afc41117f7176fb30165"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaee30a1614f76afc41117f7176fb30165">◆ </a></span>app_prepare_for_standby()</h2> <div class="memitem"> @@ -178,7 +177,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gacce192accedbd296eb8d2182f8101f16"></a> +<a id="gacce192accedbd296eb8d2182f8101f16" name="gacce192accedbd296eb8d2182f8101f16"></a> <h2 class="memtitle"><span class="permalink"><a href="#gacce192accedbd296eb8d2182f8101f16">◆ </a></span>app_setup()</h2> <div class="memitem"> @@ -202,7 +201,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> |