148 lines
18 KiB
HTML
148 lines
18 KiB
HTML
<!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=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_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 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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.3 -->
|
|
<script type="text/javascript">
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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 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) 2021 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="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#ifndef _WATCH_UTILITY_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#define _WATCH_UTILITY_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" 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 id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structwatch__duration__t.html"> 36</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> uint8_t seconds; <span class="comment">// 0-59</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> uint8_t minutes; <span class="comment">// 0-59</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> uint8_t hours; <span class="comment">// 0-23</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> uint32_t days; <span class="comment">// 0-4294967295</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>} <a class="code hl_struct" href="structwatch__duration__t.html">watch_duration_t</a>;</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code hl_function" href="group__utility.html#gaad14860c068aeed7a60e57874cad92b4">watch_utility_get_weekday</a>(<a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> date_time);</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>uint32_t <a class="code hl_function" 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 id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>uint32_t <a class="code hl_function" href="group__utility.html#gaffafef58755ff2704cf93fe1a0849a27">watch_utility_date_time_to_unix_time</a>(<a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> date_time, uint32_t utc_offset);</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><a class="code hl_struct" href="structwatch__duration__t.html">watch_duration_t</a> <a class="code hl_function" href="group__utility.html#ga5d6af930688b240d0f075806b5730d21">watch_utility_seconds_to_duration</a>(uint32_t seconds);</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> <a class="code hl_function" 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 id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__utility.html#ga470a4c7199afac6319c259fc459881f4">watch_utility_convert_to_12_hour</a>(<a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> *date_time);</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> <a class="code hl_function" href="group__utility.html#ga94f038ec0e1b8f3c48c4364b56566327">watch_utility_date_time_convert_zone</a>(<a class="code hl_union" 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 id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keywordtype">float</span> <a class="code hl_function" 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 id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>uint32_t <a class="code hl_function" href="group__utility.html#ga176fd2c04778c2049f6ae8b9d374725c">watch_utility_offset_timestamp</a>(uint32_t now, int8_t hours, int8_t minutes, int8_t seconds);</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="agroup__utility_html_ga176fd2c04778c2049f6ae8b9d374725c"><div class="ttname"><a href="group__utility.html#ga176fd2c04778c2049f6ae8b9d374725c">watch_utility_offset_timestamp</a></div><div class="ttdeci">uint32_t watch_utility_offset_timestamp(uint32_t now, int8_t hours, int8_t minutes, int8_t seconds)</div><div class="ttdoc">Offset a timestamp by a given amount.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:192</div></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:172</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 a watch_date_time struct for a given UNIX time and UTC offset.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:79</div></div>
|
|
<div class="ttc" id="agroup__utility_html_ga470a4c7199afac6319c259fc459881f4"><div class="ttname"><a href="group__utility.html#ga470a4c7199afac6319c259fc459881f4">watch_utility_convert_to_12_hour</a></div><div class="ttdeci">bool watch_utility_convert_to_12_hour(watch_date_time *date_time)</div><div class="ttdoc">Converts a watch_date_time for 12-hour display.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:165</div></div>
|
|
<div class="ttc" id="agroup__utility_html_ga5d6af930688b240d0f075806b5730d21"><div class="ttname"><a href="group__utility.html#ga5d6af930688b240d0f075806b5730d21">watch_utility_seconds_to_duration</a></div><div class="ttdeci">watch_duration_t watch_utility_seconds_to_duration(uint32_t seconds)</div><div class="ttdoc">Converts a duration in seconds to a watch_duration_t struct.</div><div class="ttdef"><b>Definition:</b> watch_utility.c:154</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_gaad14860c068aeed7a60e57874cad92b4"><div class="ttname"><a href="group__utility.html#gaad14860c068aeed7a60e57874cad92b4">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_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="astructwatch__duration__t_html"><div class="ttname"><a href="structwatch__duration__t.html">watch_duration_t</a></div><div class="ttdef"><b>Definition:</b> watch_utility.h:36</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.3
|
|
</small></address>
|
|
</body>
|
|
</html>
|