hueso/Sensor-Watch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

deploy: af18673e1a

Browse Source
This commit is contained in:
joeycastillo
2024-02-07 19:02:57 +00:00
parent cd62140803
commit 849ae6e1c4
103 changed files with 1303 additions and 985 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
group__app.html
View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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"/>
@@ -30,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -81,31 +81,31 @@ $(function() {
<table class="memberdecls">
<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" name="gadd3190cf715f513666f4be42874d91e2"></a>
<tr class="memitem:gadd3190cf715f513666f4be42874d91e2" id="r_gadd3190cf715f513666f4be42874d91e2"><td class="memItemLeft" align="right" valign="top"><a id="gadd3190cf715f513666f4be42874d91e2" name="gadd3190cf715f513666f4be42874d91e2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>app_init</b> (void)</td></tr>
<tr class="memdesc:gadd3190cf715f513666f4be42874d91e2"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:gab6a9f08ba879ce8d28fb19ca2882890a"><td class="memItemLeft" align="right" valign="top"><a id="gab6a9f08ba879ce8d28fb19ca2882890a" name="gab6a9f08ba879ce8d28fb19ca2882890a"></a>
<tr class="memitem:gab6a9f08ba879ce8d28fb19ca2882890a" id="r_gab6a9f08ba879ce8d28fb19ca2882890a"><td class="memItemLeft" align="right" valign="top"><a id="gab6a9f08ba879ce8d28fb19ca2882890a" name="gab6a9f08ba879ce8d28fb19ca2882890a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>app_wake_from_backup</b> (void)</td></tr>
<tr class="memdesc:gab6a9f08ba879ce8d28fb19ca2882890a"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:gacce192accedbd296eb8d2182f8101f16"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gacce192accedbd296eb8d2182f8101f16">app_setup</a> (void)</td></tr>
<tr class="memdesc:gacce192accedbd296eb8d2182f8101f16"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function you will implement to set up your application. The app_setup function is like setup() in Arduino. It is called once when the program begins. You should set pin modes and enable any peripherals you want to set up (real-time clock, I2C, etc.) Depending on your application, you may or may not want to configure sensors on your sensor board here. For example, a low-power accelerometer that will run at all times should be configured here, whereas you may want to enable a more power-hungry sensor only when you need it. <a href="group__app.html#gacce192accedbd296eb8d2182f8101f16">More...</a><br /></td></tr>
<tr class="memitem:gacce192accedbd296eb8d2182f8101f16" id="r_gacce192accedbd296eb8d2182f8101f16"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gacce192accedbd296eb8d2182f8101f16">app_setup</a> (void)</td></tr>
<tr class="memdesc:gacce192accedbd296eb8d2182f8101f16"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function you will implement to set up your application. The app_setup function is like setup() in Arduino. It is called once when the program begins. You should set pin modes and enable any peripherals you want to set up (real-time clock, I2C, etc.) Depending on your application, you may or may not want to configure sensors on your sensor board here. For example, a low-power accelerometer that will run at all times should be configured here, whereas you may want to enable a more power-hungry sensor only when you need it. <br /></td></tr>
<tr class="separator:gacce192accedbd296eb8d2182f8101f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1cfce0ef962cd2afe2d8b2d2d13482a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gad1cfce0ef962cd2afe2d8b2d2d13482a">app_loop</a> (void)</td></tr>
<tr class="memdesc:gad1cfce0ef962cd2afe2d8b2d2d13482a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function you will implement to serve as the app's main run loop. This method will be called repeatedly, or if you enter STANDBY mode, as soon as the device wakes from sleep. <a href="group__app.html#gad1cfce0ef962cd2afe2d8b2d2d13482a">More...</a><br /></td></tr>
<tr class="memitem:gad1cfce0ef962cd2afe2d8b2d2d13482a" id="r_gad1cfce0ef962cd2afe2d8b2d2d13482a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#gad1cfce0ef962cd2afe2d8b2d2d13482a">app_loop</a> (void)</td></tr>
<tr class="memdesc:gad1cfce0ef962cd2afe2d8b2d2d13482a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function you will implement to serve as the app's main run loop. This method will be called repeatedly, or if you enter STANDBY mode, as soon as the device wakes from sleep. <br /></td></tr>
<tr class="separator:gad1cfce0ef962cd2afe2d8b2d2d13482a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee30a1614f76afc41117f7176fb30165"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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="memitem:gaee30a1614f76afc41117f7176fb30165" id="r_gaee30a1614f76afc41117f7176fb30165"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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). <br /></td></tr>
<tr class="separator:gaee30a1614f76afc41117f7176fb30165"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc7e7ff6108524545ab4183110811874"><td class="memItemLeft" align="right" valign="top"><a id="gacc7e7ff6108524545ab4183110811874" name="gacc7e7ff6108524545ab4183110811874"></a>
<tr class="memitem:gacc7e7ff6108524545ab4183110811874" id="r_gacc7e7ff6108524545ab4183110811874"><td class="memItemLeft" align="right" valign="top"><a id="gacc7e7ff6108524545ab4183110811874" name="gacc7e7ff6108524545ab4183110811874"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>app_wake_from_standby</b> (void)</td></tr>
<tr class="memdesc:gacc7e7ff6108524545ab4183110811874"><td class="mdescLeft">&#160;</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">&#160;</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>
@@ -208,7 +208,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><b>app_wake_from_standby
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>