mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
246 lines
39 KiB
HTML
246 lines
39 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.6"/>
|
|
<title>ArduinoLibs: RTC.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/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_f34881fcf60f680b800190d5274dfaea.html">RTC</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">RTC.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"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</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"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef RTC_h</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define RTC_h</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <inttypes.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structRTCTime.html"> 28</a></span> <span class="keyword">struct </span><a class="code" href="structRTCTime.html">RTCTime</a></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structRTCTime.html#a98ba717092ef856dd2b773ba02fcb1a4"> 30</a></span>  uint8_t <a class="code" href="structRTCTime.html#a98ba717092ef856dd2b773ba02fcb1a4">hour</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structRTCTime.html#acf2161ca037080dc4b767e636ad8db84"> 31</a></span>  uint8_t <a class="code" href="structRTCTime.html#acf2161ca037080dc4b767e636ad8db84">minute</a>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structRTCTime.html#a87b7c02e535d808dcba04c77e34abb91"> 32</a></span>  uint8_t <a class="code" href="structRTCTime.html#a87b7c02e535d808dcba04c77e34abb91">second</a>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> };</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structRTCDate.html"> 35</a></span> <span class="keyword">struct </span><a class="code" href="structRTCDate.html">RTCDate</a></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structRTCDate.html#a7d31822daff3c3fc947386abd897732f"> 37</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structRTCDate.html#a7d31822daff3c3fc947386abd897732f">year</a>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structRTCDate.html#a6e6196059b36186041a5312400ea9202"> 38</a></span>  uint8_t <a class="code" href="structRTCDate.html#a6e6196059b36186041a5312400ea9202">month</a>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structRTCDate.html#a2d68ff3fb90240df522b41222362704c"> 39</a></span>  uint8_t <a class="code" href="structRTCDate.html#a2d68ff3fb90240df522b41222362704c">day</a>;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structRTCAlarm.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="structRTCAlarm.html">RTCAlarm</a></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structRTCAlarm.html#a9cbc0c2bd8cee02917539af77e845fc4"> 44</a></span>  uint8_t <a class="code" href="structRTCAlarm.html#a9cbc0c2bd8cee02917539af77e845fc4">day</a>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structRTCAlarm.html#a764061bcf84755b4b9db07dead0d46b9"> 45</a></span>  uint8_t <a class="code" href="structRTCAlarm.html#a764061bcf84755b4b9db07dead0d46b9">dow</a>;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692"> 46</a></span>  uint8_t <a class="code" href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692">hour</a>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe"> 47</a></span>  uint8_t <a class="code" href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe">minute</a>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structRTCAlarm.html#ab749e3695ee5c5dd703aec71f72d46a1"> 48</a></span>  uint8_t <a class="code" href="structRTCAlarm.html#ab749e3695ee5c5dd703aec71f72d46a1">second</a>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e"> 49</a></span>  uint8_t <a class="code" href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">flags</a>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classRTC.html"> 52</a></span> <span class="keyword">class </span><a class="code" href="classRTC.html">RTC</a></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classRTC.html#ada31c5120d18d2dd2863b3d440308da2">RTC</a>();</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  ~<a class="code" href="classRTC.html">RTC</a>();</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11"> 58</a></span>  <span class="keyword">enum</span> <a class="code" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">DayOfWeek</a></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  {</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  Monday = 1,</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  Tuesday,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  Wednesday,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  Thursday,</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  Friday,</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  Saturday,</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  Sunday,</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> </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classRTC.html#a3690761f29654a2c9e676fcbfa32dd30">hasUpdates</a>();</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#aaf0a5c1f32f210a49718d148620b5bec">readTime</a>(<a class="code" href="structRTCTime.html">RTCTime</a> *value);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#aa1e21bf42ebd4456919744ae0f4f631e">readDate</a>(<a class="code" href="structRTCDate.html">RTCDate</a> *value);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#a102e2ec15bf0273d8f7e9ce4b6dcc96e">writeTime</a>(<span class="keyword">const</span> <a class="code" href="structRTCTime.html">RTCTime</a> *value);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#ae667600d05c8e7b06a93574dd068a4d7">writeDate</a>(<span class="keyword">const</span> <a class="code" href="structRTCDate.html">RTCDate</a> *value);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3"> 77</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> = 4;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66">readAlarm</a>(uint8_t alarmNum, <a class="code" href="structRTCAlarm.html">RTCAlarm</a> *value);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e">writeAlarm</a>(uint8_t alarmNum, <span class="keyword">const</span> <a class="code" href="structRTCAlarm.html">RTCAlarm</a> *value);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classRTC.html#acfdebfb449710e44e11f9a3675e14fd8">byteCount</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="classRTC.html#a0f47b10b436e3f9d36e04ec907579431">readByte</a>(uint8_t offset);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#a1cab6397ec04b1e2b3feea5b3cd1f749">writeByte</a>(uint8_t offset, uint8_t value);</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8"> 86</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8">NO_TEMPERATURE</a> = 32767;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a">readTemperature</a>();</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// Flags for adjustDays(), adjustMonths(), and adjustYears().</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37"> 91</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37">INCREMENT</a> = 0x0000;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f"> 92</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f">DECREMENT</a> = 0x0001;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classRTC.html#a02ace2d775063be9a99035851c9274eb"> 93</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t <a class="code" href="classRTC.html#a02ace2d775063be9a99035851c9274eb">WRAP</a> = 0x0002;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d">adjustDays</a>(<a class="code" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4">adjustMonths</a>(<a class="code" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags);</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d">adjustYears</a>(<a class="code" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">static</span> <a class="code" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">DayOfWeek</a> <a class="code" href="classRTC.html#a525a9c1dad89613708f47a683eb316aa">dayOfWeek</a>(<span class="keyword">const</span> <a class="code" href="structRTCDate.html">RTCDate</a> *date);</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> midnight;</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="structRTCDate.html">RTCDate</a> date;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="structRTCAlarm.html">RTCAlarm</a> alarms[<a class="code" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a>];</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  uint8_t *nvram;</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> };</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="structRTCDate_html_a6e6196059b36186041a5312400ea9202"><div class="ttname"><a href="structRTCDate.html#a6e6196059b36186041a5312400ea9202">RTCDate::month</a></div><div class="ttdeci">uint8_t month</div><div class="ttdoc">Month of the year (1-12) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00038">RTC.h:38</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a102e2ec15bf0273d8f7e9ce4b6dcc96e"><div class="ttname"><a href="classRTC.html#a102e2ec15bf0273d8f7e9ce4b6dcc96e">RTC::writeTime</a></div><div class="ttdeci">virtual void writeTime(const RTCTime *value)</div><div class="ttdoc">Updates the time in the realtime clock to match value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00179">RTC.cpp:179</a></div></div>
|
|
<div class="ttc" id="classRTC_html_ada31c5120d18d2dd2863b3d440308da2"><div class="ttname"><a href="classRTC.html#ada31c5120d18d2dd2863b3d440308da2">RTC::RTC</a></div><div class="ttdeci">RTC()</div><div class="ttdoc">Constructs a new realtime clock handler. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00105">RTC.cpp:105</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a525a9c1dad89613708f47a683eb316aa"><div class="ttname"><a href="classRTC.html#a525a9c1dad89613708f47a683eb316aa">RTC::dayOfWeek</a></div><div class="ttdeci">static DayOfWeek dayOfWeek(const RTCDate *date)</div><div class="ttdoc">Returns the day of the week corresponding to date. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00399">RTC.cpp:399</a></div></div>
|
|
<div class="ttc" id="structRTCTime_html_acf2161ca037080dc4b767e636ad8db84"><div class="ttname"><a href="structRTCTime.html#acf2161ca037080dc4b767e636ad8db84">RTCTime::minute</a></div><div class="ttdeci">uint8_t minute</div><div class="ttdoc">Minute within the hour (0-59) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00031">RTC.h:31</a></div></div>
|
|
<div class="ttc" id="classRTC_html_ade282d7a60147c3f0269f1fcd59c8d66"><div class="ttname"><a href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66">RTC::readAlarm</a></div><div class="ttdeci">virtual void readAlarm(uint8_t alarmNum, RTCAlarm *value)</div><div class="ttdoc">Reads the details of the alarm with index alarmNum into value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00209">RTC.cpp:209</a></div></div>
|
|
<div class="ttc" id="classRTC_html_aa1e21bf42ebd4456919744ae0f4f631e"><div class="ttname"><a href="classRTC.html#aa1e21bf42ebd4456919744ae0f4f631e">RTC::readDate</a></div><div class="ttdeci">virtual void readDate(RTCDate *value)</div><div class="ttdoc">Reads the current date from the realtime clock into value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00169">RTC.cpp:169</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html_a9cbc0c2bd8cee02917539af77e845fc4"><div class="ttname"><a href="structRTCAlarm.html#a9cbc0c2bd8cee02917539af77e845fc4">RTCAlarm::day</a></div><div class="ttdeci">uint8_t day</div><div class="ttdoc">Day of the month for the alarm if not zero. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00044">RTC.h:44</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a05b1bd1479afc80682abdd4f3e58dc6f"><div class="ttname"><a href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f">RTC::DECREMENT</a></div><div class="ttdeci">static const uint8_t DECREMENT</div><div class="ttdoc">Decrement the day, month, or year in a call to adjustDays(), adjustMonths(), or adjustYears(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00092">RTC.h:92</a></div></div>
|
|
<div class="ttc" id="classRTC_html_ab2ca0cbee608ec32d3d6e04d40298f11"><div class="ttname"><a href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">RTC::DayOfWeek</a></div><div class="ttdeci">DayOfWeek</div><div class="ttdoc">Day of the week corresponding to a date. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00058">RTC.h:58</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a0e96c91efd9e7a6340effdae3eadf17e"><div class="ttname"><a href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e">RTC::writeAlarm</a></div><div class="ttdeci">virtual void writeAlarm(uint8_t alarmNum, const RTCAlarm *value)</div><div class="ttdoc">Updates the details of the alarm with index alarmNum from value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00224">RTC.cpp:224</a></div></div>
|
|
<div class="ttc" id="classRTC_html_aee5ae8f600ee5296e65635c0d836fca3"><div class="ttname"><a href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">RTC::ALARM_COUNT</a></div><div class="ttdeci">static const uint8_t ALARM_COUNT</div><div class="ttdoc">Number of alarms that are supported by RTC::readAlarm() and RTC::writeAlarm(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00077">RTC.h:77</a></div></div>
|
|
<div class="ttc" id="classRTC_html_ae667600d05c8e7b06a93574dd068a4d7"><div class="ttname"><a href="classRTC.html#ae667600d05c8e7b06a93574dd068a4d7">RTC::writeDate</a></div><div class="ttdeci">virtual void writeDate(const RTCDate *value)</div><div class="ttdoc">Updates the date in the realtime clock to match value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00194">RTC.cpp:194</a></div></div>
|
|
<div class="ttc" id="classRTC_html_acfdebfb449710e44e11f9a3675e14fd8"><div class="ttname"><a href="classRTC.html#acfdebfb449710e44e11f9a3675e14fd8">RTC::byteCount</a></div><div class="ttdeci">virtual int byteCount() const </div><div class="ttdoc">Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00235">RTC.cpp:235</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html_a75bdc42acd3ab3ad495680c6b6a34692"><div class="ttname"><a href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692">RTCAlarm::hour</a></div><div class="ttdeci">uint8_t hour</div><div class="ttdoc">Hour of the day for the alarm (0-23). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00046">RTC.h:46</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a9ed5480b362a83f1f45c4d3bcf7c3bf8"><div class="ttname"><a href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8">RTC::NO_TEMPERATURE</a></div><div class="ttdeci">static const int NO_TEMPERATURE</div><div class="ttdoc">Value that is returned from readTemperature() if the realtime clock chip cannot determine the tempera...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00086">RTC.h:86</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html_a0f2ef7363cb60a26642d5295b77ca19e"><div class="ttname"><a href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">RTCAlarm::flags</a></div><div class="ttdeci">uint8_t flags</div><div class="ttdoc">Additional flags for the alarm. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00049">RTC.h:49</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html_a764061bcf84755b4b9db07dead0d46b9"><div class="ttname"><a href="structRTCAlarm.html#a764061bcf84755b4b9db07dead0d46b9">RTCAlarm::dow</a></div><div class="ttdeci">uint8_t dow</div><div class="ttdoc">Day of the week for the alarm if not zero. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00045">RTC.h:45</a></div></div>
|
|
<div class="ttc" id="structRTCDate_html"><div class="ttname"><a href="structRTCDate.html">RTCDate</a></div><div class="ttdoc">Stores date information from a realtime clock chip. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00035">RTC.h:35</a></div></div>
|
|
<div class="ttc" id="structRTCDate_html_a7d31822daff3c3fc947386abd897732f"><div class="ttname"><a href="structRTCDate.html#a7d31822daff3c3fc947386abd897732f">RTCDate::year</a></div><div class="ttdeci">unsigned int year</div><div class="ttdoc">Year (4-digit) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00037">RTC.h:37</a></div></div>
|
|
<div class="ttc" id="classRTC_html_aeca3c8387332e8cabfd09c1806276e5a"><div class="ttname"><a href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a">RTC::readTemperature</a></div><div class="ttdeci">virtual int readTemperature()</div><div class="ttdoc">Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00288">RTC.cpp:288</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a1cab6397ec04b1e2b3feea5b3cd1f749"><div class="ttname"><a href="classRTC.html#a1cab6397ec04b1e2b3feea5b3cd1f749">RTC::writeByte</a></div><div class="ttdeci">virtual void writeByte(uint8_t offset, uint8_t value)</div><div class="ttdoc">Writes value to offset within the realtime clock's non-volatile memory. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00262">RTC.cpp:262</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a31d10cb2f7cac8839bd4be2d858b802d"><div class="ttname"><a href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d">RTC::adjustYears</a></div><div class="ttdeci">static void adjustYears(RTCDate *date, uint8_t flags)</div><div class="ttdoc">Adjusts date up or down one year according to flags. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00370">RTC.cpp:370</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html_ad9a75ceb4b4b3474baa66dd5466e62fe"><div class="ttname"><a href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe">RTCAlarm::minute</a></div><div class="ttdeci">uint8_t minute</div><div class="ttdoc">Minute of the hour for the alarm (0-59). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00047">RTC.h:47</a></div></div>
|
|
<div class="ttc" id="classRTC_html_aacbe3ebbf893685950b05327c11d5c37"><div class="ttname"><a href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37">RTC::INCREMENT</a></div><div class="ttdeci">static const uint8_t INCREMENT</div><div class="ttdoc">Increment the day, month, or year in a call to adjustDays(), adjustMonths(), or adjustYears(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00091">RTC.h:91</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a0f47b10b436e3f9d36e04ec907579431"><div class="ttname"><a href="classRTC.html#a0f47b10b436e3f9d36e04ec907579431">RTC::readByte</a></div><div class="ttdeci">virtual uint8_t readByte(uint8_t offset)</div><div class="ttdoc">Reads the byte at offset within the realtime clock's non-volatile memory. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00247">RTC.cpp:247</a></div></div>
|
|
<div class="ttc" id="classRTC_html_adc29d7c43efc5a192d21965da5c3ee1d"><div class="ttname"><a href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d">RTC::adjustDays</a></div><div class="ttdeci">static void adjustDays(RTCDate *date, uint8_t flags)</div><div class="ttdoc">Adjusts date up or down one day according to flags. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00313">RTC.cpp:313</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html_ab749e3695ee5c5dd703aec71f72d46a1"><div class="ttname"><a href="structRTCAlarm.html#ab749e3695ee5c5dd703aec71f72d46a1">RTCAlarm::second</a></div><div class="ttdeci">uint8_t second</div><div class="ttdoc">Second of the minute for the alarm (0-59). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00048">RTC.h:48</a></div></div>
|
|
<div class="ttc" id="structRTCTime_html"><div class="ttname"><a href="structRTCTime.html">RTCTime</a></div><div class="ttdoc">Stores time information from a realtime clock chip. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00028">RTC.h:28</a></div></div>
|
|
<div class="ttc" id="structRTCAlarm_html"><div class="ttname"><a href="structRTCAlarm.html">RTCAlarm</a></div><div class="ttdoc">Stores alarm information from a realtime clock chip. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00042">RTC.h:42</a></div></div>
|
|
<div class="ttc" id="classRTC_html_aeca597e6e37a05716e664242f9cfc5f4"><div class="ttname"><a href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4">RTC::adjustMonths</a></div><div class="ttdeci">static void adjustMonths(RTCDate *date, uint8_t flags)</div><div class="ttdoc">Adjusts date up or down one month according to flags. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00343">RTC.cpp:343</a></div></div>
|
|
<div class="ttc" id="structRTCTime_html_a98ba717092ef856dd2b773ba02fcb1a4"><div class="ttname"><a href="structRTCTime.html#a98ba717092ef856dd2b773ba02fcb1a4">RTCTime::hour</a></div><div class="ttdeci">uint8_t hour</div><div class="ttdoc">Hour of the day (0-23) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00030">RTC.h:30</a></div></div>
|
|
<div class="ttc" id="structRTCDate_html_a2d68ff3fb90240df522b41222362704c"><div class="ttname"><a href="structRTCDate.html#a2d68ff3fb90240df522b41222362704c">RTCDate::day</a></div><div class="ttdeci">uint8_t day</div><div class="ttdoc">Day of the month (1-31) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00039">RTC.h:39</a></div></div>
|
|
<div class="ttc" id="structRTCTime_html_a87b7c02e535d808dcba04c77e34abb91"><div class="ttname"><a href="structRTCTime.html#a87b7c02e535d808dcba04c77e34abb91">RTCTime::second</a></div><div class="ttdeci">uint8_t second</div><div class="ttdoc">Second within the minute (0-59) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00032">RTC.h:32</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a3690761f29654a2c9e676fcbfa32dd30"><div class="ttname"><a href="classRTC.html#a3690761f29654a2c9e676fcbfa32dd30">RTC::hasUpdates</a></div><div class="ttdeci">virtual bool hasUpdates()</div><div class="ttdoc">Returns true if the realtime clock has updated since the last call to this function. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00134">RTC.cpp:134</a></div></div>
|
|
<div class="ttc" id="classRTC_html_aaf0a5c1f32f210a49718d148620b5bec"><div class="ttname"><a href="classRTC.html#aaf0a5c1f32f210a49718d148620b5bec">RTC::readTime</a></div><div class="ttdeci">virtual void readTime(RTCTime *value)</div><div class="ttdoc">Reads the current time from the realtime clock into value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00144">RTC.cpp:144</a></div></div>
|
|
<div class="ttc" id="classRTC_html"><div class="ttname"><a href="classRTC.html">RTC</a></div><div class="ttdoc">Base class for realtime clock handlers. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00052">RTC.h:52</a></div></div>
|
|
<div class="ttc" id="classRTC_html_a02ace2d775063be9a99035851c9274eb"><div class="ttname"><a href="classRTC.html#a02ace2d775063be9a99035851c9274eb">RTC::WRAP</a></div><div class="ttdeci">static const uint8_t WRAP</div><div class="ttdoc">Wrap around to the beginning of the current month/year rather than advance to the next one...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00093">RTC.h:93</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Feb 14 2016 08:32:00 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|