diff options
Diffstat (limited to 'watch__utility_8h_source.html')
-rw-r--r-- | watch__utility_8h_source.html | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/watch__utility_8h_source.html b/watch__utility_8h_source.html new file mode 100644 index 00000000..eb783993 --- /dev/null +++ b/watch__utility_8h_source.html @@ -0,0 +1,131 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<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 name="viewport" content="width=device-width, initial-scale=1"/> +<title>Sensor Watch: watch-library/shared/watch/watch_utility.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<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> + </div> + <div id="projectbrief">A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<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-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 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_f1a087a6659d970f5756e21fc1ac4961.html">watch-library</a></li><li class="navelem"><a class="el" href="dir_3351a3556ab4b770be21f3a77a6d7b80.html">shared</a></li><li class="navelem"><a class="el" href="dir_280ec1f3fe74f12cdd5c78898ed1ca3c.html">watch</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">watch_utility.h</div> </div> +</div><!--header--> +<div class="contents"> +<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) 2021 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="l00024"></a><span class="lineno"> 24</span>  </div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef _WATCH_UTILITY_H_INCLUDED</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define _WATCH_UTILITY_H_INCLUDED</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="watch_8h.html">watch.h</a>"</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="group__utility.html#ga8f3d6ddf5f22bc61e1dc4b569009b127">watch_utility_get_weekday</a>(<a class="code" href="unionwatch__date__time.html">watch_date_time</a> date_time);</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> uint32_t <a class="code" href="group__utility.html#ga94f5cc404949bf4c0ac4bc4770ec8eda">watch_utility_convert_to_unix_time</a>(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint32_t utc_offset);</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> uint32_t <a class="code" href="group__utility.html#gaffafef58755ff2704cf93fe1a0849a27">watch_utility_date_time_to_unix_time</a>(<a class="code" href="unionwatch__date__time.html">watch_date_time</a> date_time, uint32_t utc_offset);</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <a class="code" href="unionwatch__date__time.html">watch_date_time</a> <a class="code" href="group__utility.html#ga396e56109234aaa00993c3dd84f3f43c">watch_utility_date_time_from_unix_time</a>(uint32_t timestamp, uint32_t utc_offset);</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <a class="code" href="unionwatch__date__time.html">watch_date_time</a> <a class="code" href="group__utility.html#ga94f038ec0e1b8f3c48c4364b56566327">watch_utility_date_time_convert_zone</a>(<a class="code" href="unionwatch__date__time.html">watch_date_time</a> date_time, uint32_t origin_utc_offset, uint32_t destination_utc_offset);</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">float</span> <a class="code" href="group__utility.html#ga2753ff031c28202d23b0f3e80de2c920">watch_utility_thermistor_temperature</a>(uint16_t value, <span class="keywordtype">bool</span> highside, <span class="keywordtype">float</span> b_coefficient, <span class="keywordtype">float</span> nominal_temperature, <span class="keywordtype">float</span> nominal_resistance, <span class="keywordtype">float</span> series_resistance);</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif</span></div> +<div class="ttc" id="agroup__utility_html_ga2753ff031c28202d23b0f3e80de2c920"><div class="ttname"><a href="group__utility.html#ga2753ff031c28202d23b0f3e80de2c920">watch_utility_thermistor_temperature</a></div><div class="ttdeci">float watch_utility_thermistor_temperature(uint16_t value, bool highside, float b_coefficient, float nominal_temperature, float nominal_resistance, float series_resistance)</div><div class="ttdoc">Returns a temperature in degrees Celsius for a given thermistor voltage divider circuit.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:154</div></div> +<div class="ttc" id="agroup__utility_html_ga396e56109234aaa00993c3dd84f3f43c"><div class="ttname"><a href="group__utility.html#ga396e56109234aaa00993c3dd84f3f43c">watch_utility_date_time_from_unix_time</a></div><div class="ttdeci">watch_date_time watch_utility_date_time_from_unix_time(uint32_t timestamp, uint32_t utc_offset)</div><div class="ttdoc">Returns the UNIX time (seconds since 1970) for a given watch_date_time struct.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:79</div></div> +<div class="ttc" id="agroup__utility_html_ga8f3d6ddf5f22bc61e1dc4b569009b127"><div class="ttname"><a href="group__utility.html#ga8f3d6ddf5f22bc61e1dc4b569009b127">watch_utility_get_weekday</a></div><div class="ttdeci">const char * watch_utility_get_weekday(watch_date_time date_time)</div><div class="ttdoc">Returns a two-letter weekday for the given timestamp, suitable for display in positions 0-1 of the wa...</div><div class="ttdef"><b>Definition:</b> watch_utility.c:28</div></div> +<div class="ttc" id="agroup__utility_html_ga94f038ec0e1b8f3c48c4364b56566327"><div class="ttname"><a href="group__utility.html#ga94f038ec0e1b8f3c48c4364b56566327">watch_utility_date_time_convert_zone</a></div><div class="ttdeci">watch_date_time watch_utility_date_time_convert_zone(watch_date_time date_time, uint32_t origin_utc_offset, uint32_t destination_utc_offset)</div><div class="ttdoc">Converts a time from a given time zone to another time zone.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:149</div></div> +<div class="ttc" id="agroup__utility_html_ga94f5cc404949bf4c0ac4bc4770ec8eda"><div class="ttname"><a href="group__utility.html#ga94f5cc404949bf4c0ac4bc4770ec8eda">watch_utility_convert_to_unix_time</a></div><div class="ttdeci">uint32_t watch_utility_convert_to_unix_time(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint32_t utc_offset)</div><div class="ttdoc">Returns the UNIX time (seconds since 1970) for a given date/time in UTC.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:38</div></div> +<div class="ttc" id="agroup__utility_html_gaffafef58755ff2704cf93fe1a0849a27"><div class="ttname"><a href="group__utility.html#gaffafef58755ff2704cf93fe1a0849a27">watch_utility_date_time_to_unix_time</a></div><div class="ttdeci">uint32_t watch_utility_date_time_to_unix_time(watch_date_time date_time, uint32_t utc_offset)</div><div class="ttdoc">Returns the UNIX time (seconds since 1970) for a given watch_date_time struct.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:69</div></div> +<div class="ttc" id="aunionwatch__date__time_html"><div class="ttname"><a href="unionwatch__date__time.html">watch_date_time</a></div><div class="ttdef"><b>Definition:</b> watch_rtc.h:44</div></div> +<div class="ttc" id="awatch_8h_html"><div class="ttname"><a href="watch_8h.html">watch.h</a></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 +</small></address> +</body> +</html> |