diff options
Diffstat (limited to 'watch_8h_source.html')
| -rw-r--r-- | watch_8h_source.html | 127 |
1 files changed, 63 insertions, 64 deletions
diff --git a/watch_8h_source.html b/watch_8h_source.html index 1c31fe1c..2e75936a 100644 --- a/watch_8h_source.html +++ b/watch_8h_source.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: watch-library/shared/watch/watch.h Source File</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> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -67,66 +67,65 @@ $(function() { </div> </div><!-- top --> <div class="header"> - <div class="headertitle"> -<div class="title">watch.h</div> </div> + <div class="headertitle"><div class="title">watch.h</div></div> </div><!--header--> <div class="contents"> -<a href="watch_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> -<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * MIT License</span></div> -<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2020 Joey Castillo</span></div> -<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div> -<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span></div> -<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * in the Software without restriction, including without limitation the rights</span></div> -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div> -<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div> -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div> -<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div> -<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div> -<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div> -<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div> -<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> -<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef WATCH_H_</span></div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define WATCH_H_</span></div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stdint.h></span></div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <stdbool.h></span></div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "driver_init.h"</span></div> -<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div> -<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#include "watch_app.h"</span></div> -<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#include "watch_rtc.h"</span></div> -<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#include "watch_slcd.h"</span></div> -<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#include "watch_extint.h"</span></div> -<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#include "watch_led.h"</span></div> -<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#include "watch_buzzer.h"</span></div> -<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#include "watch_adc.h"</span></div> -<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#include "watch_gpio.h"</span></div> -<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#include "watch_i2c.h"</span></div> -<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#include "watch_spi.h"</span></div> -<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#include "watch_uart.h"</span></div> -<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#include "watch_deepsleep.h"</span></div> -<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div> -<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#include "watch_private.h"</span></div> -<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> -<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="watch_8h.html#a16023aa6b668de61af59b40b2bee5d1d"> 76</a></span> <span class="keywordtype">bool</span> <a class="code" href="watch_8h.html#a16023aa6b668de61af59b40b2bee5d1d">watch_is_battery_low</a>(<span class="keywordtype">void</span>);</div> -<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div> -<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="watch_8h.html#a6df21baf06b4a5392d95dd3cdde75d94"> 83</a></span> <span class="keywordtype">bool</span> <a class="code" href="watch_8h.html#a6df21baf06b4a5392d95dd3cdde75d94">watch_is_buzzer_or_led_enabled</a>(<span class="keywordtype">void</span>);</div> -<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> -<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif </span><span class="comment">/* WATCH_H_ */</span><span class="preprocessor"></span></div> +<a href="watch_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * MIT License</span></div> +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div> +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright (c) 2020 Joey Castillo</span></div> +<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div> +<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div> +<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span></div> +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * in the Software without restriction, including without limitation the rights</span></div> +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div> +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div> +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * furnished to do so, subject to the following conditions:</span></div> +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div> +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div> +<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * copies or substantial portions of the Software.</span></div> +<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> *</span></div> +<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div> +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div> +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div> +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div> +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div> +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div> +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * SOFTWARE.</span></div> +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> */</span></div> +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#ifndef WATCH_H_</span></div> +<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#define WATCH_H_</span></div> +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <stdint.h></span></div> +<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <stdbool.h></span></div> +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "driver_init.h"</span></div> +<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> +<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#include "watch_app.h"</span></div> +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#include "watch_rtc.h"</span></div> +<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#include "watch_slcd.h"</span></div> +<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#include "watch_extint.h"</span></div> +<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#include "watch_led.h"</span></div> +<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#include "watch_buzzer.h"</span></div> +<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#include "watch_adc.h"</span></div> +<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#include "watch_gpio.h"</span></div> +<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#include "watch_i2c.h"</span></div> +<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#include "watch_spi.h"</span></div> +<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#include "watch_uart.h"</span></div> +<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#include "watch_deepsleep.h"</span></div> +<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#include "watch_private.h"</span></div> +<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div> +<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="watch_8h.html#a16023aa6b668de61af59b40b2bee5d1d"> 76</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="watch_8h.html#a16023aa6b668de61af59b40b2bee5d1d">watch_is_battery_low</a>(<span class="keywordtype">void</span>);</div> +<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div> +<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="watch_8h.html#a6df21baf06b4a5392d95dd3cdde75d94"> 83</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="watch_8h.html#a6df21baf06b4a5392d95dd3cdde75d94">watch_is_buzzer_or_led_enabled</a>(<span class="keywordtype">void</span>);</div> +<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> +<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor">#endif </span><span class="comment">/* WATCH_H_ */</span><span class="preprocessor"></span></div> <div class="ttc" id="awatch_8h_html_a16023aa6b668de61af59b40b2bee5d1d"><div class="ttname"><a href="watch_8h.html#a16023aa6b668de61af59b40b2bee5d1d">watch_is_battery_low</a></div><div class="ttdeci">bool watch_is_battery_low(void)</div><div class="ttdoc">Returns true when the battery voltage dips below 2.5V.</div></div> <div class="ttc" id="awatch_8h_html_a6df21baf06b4a5392d95dd3cdde75d94"><div class="ttname"><a href="watch_8h.html#a6df21baf06b4a5392d95dd3cdde75d94">watch_is_buzzer_or_led_enabled</a></div><div class="ttdeci">bool watch_is_buzzer_or_led_enabled(void)</div><div class="ttdoc">Returns true if either the buzzer or the LED driver is enabled.</div></div> </div><!-- fragment --></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> |