mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
199 lines
27 KiB
HTML
199 lines
27 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: DS3232RTC.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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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">DS3232RTC.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 DS3232RTC_h</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define DS3232RTC_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 "RTC.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"> 28</span> <span class="keyword">class </span><a class="code" href="classI2CMaster.html">I2CMaster</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="classDS3232RTC.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="classDS3232RTC.html">DS3232RTC</a> : <span class="keyword">public</span> <a class="code" href="classRTC.html">RTC</a> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classDS3232RTC.html#aa959454ae01b11c48d6ec7ec192b4ccb">DS3232RTC</a>(<a class="code" href="classI2CMaster.html">I2CMaster</a> &bus, uint8_t oneHzPin = 255);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classDS3232RTC.html#acc5908a3743afb4c26bd75e22cad87a4"> 34</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classDS3232RTC.html#acc5908a3743afb4c26bd75e22cad87a4">isRealTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _isRealTime; }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> <a class="code" href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc">hasUpdates</a>();</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747">readTime</a>(<a class="code" href="structRTCTime.html">RTCTime</a> *value);</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#ab03358e3b5996e38d766e2f9f6ab62ca">readDate</a>(<a class="code" href="structRTCDate.html">RTCDate</a> *value);</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>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#ab0ca13a8b80da856b37fc53b84e27c78">writeTime</a>(<span class="keyword">const</span> <a class="code" href="structRTCTime.html">RTCTime</a> *value);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#a31c004a90c724979d8267c31f2dbf5ed">writeDate</a>(<span class="keyword">const</span> <a class="code" href="structRTCDate.html">RTCDate</a> *value);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#a09c7073c687dcbbc423baf48074c7873">readAlarm</a>(uint8_t alarmNum, <a class="code" href="structRTCAlarm.html">RTCAlarm</a> *value);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#a8b0a65e0ac479aec8fad6ca3147dbe75">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="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> <a class="code" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e">byteCount</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  uint8_t <a class="code" href="classDS3232RTC.html#a5ba83a3ef7d65d45c2f3241afdd8fef7">readByte</a>(uint8_t offset);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#a9acebf12c5cecdd6d84e0ff9ed41765a">writeByte</a>(uint8_t offset, uint8_t value);</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>  <span class="keywordtype">int</span> <a class="code" href="classDS3232RTC.html#a0faf40c25ab019a326a60f301c2bb41b">readTemperature</a>();</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9">enableAlarmInterrupts</a>();</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#a225b8c62d617aa1b7be7d20e8a033be9">disableAlarmInterrupts</a>();</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> <a class="code" href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3">firedAlarm</a>();</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#a3966de6f4241d86f198a8b9dd5e7e59a">enable32kHzOutput</a>();</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3232RTC.html#ada732bae42fc2833e59ae293aa27ddcb">disable32kHzOutput</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> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classI2CMaster.html">I2CMaster</a> *_bus;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uint8_t _oneHzPin;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> prevOneHz;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">bool</span> _isRealTime;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">bool</span> alarmInterrupts;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> initAlarms();</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>  uint8_t readRegister(uint8_t reg);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> writeRegister(uint8_t reg, uint8_t value);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> updateAlarmInterrupts();</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> </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="classDS3232RTC_html_ab91e79271a1f8e75b07bddbb04445dc9"><div class="ttname"><a href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9">DS3232RTC::enableAlarmInterrupts</a></div><div class="ttdeci">void enableAlarmInterrupts()</div><div class="ttdoc">Enables the generation of interrupts for alarms 0 and 1. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8cpp_source.html#l00380">DS3232RTC.cpp:380</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_ada732bae42fc2833e59ae293aa27ddcb"><div class="ttname"><a href="classDS3232RTC.html#ada732bae42fc2833e59ae293aa27ddcb">DS3232RTC::disable32kHzOutput</a></div><div class="ttdeci">void disable32kHzOutput()</div><div class="ttdoc">Disables the 32 kHz output on the DS3232 chip. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8cpp_source.html#l00458">DS3232RTC.cpp:458</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_af89e68c68f1c4b7e94286f800b5b2747"><div class="ttname"><a href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747">DS3232RTC::readTime</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00205">DS3232RTC.cpp:205</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a0faf40c25ab019a326a60f301c2bb41b"><div class="ttname"><a href="classDS3232RTC.html#a0faf40c25ab019a326a60f301c2bb41b">DS3232RTC::readTemperature</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00356">DS3232RTC.cpp:356</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a1319fe936dcb7e9d6bdf200b77a94f8e"><div class="ttname"><a href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e">DS3232RTC::byteCount</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00335">DS3232RTC.cpp:335</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_ab03358e3b5996e38d766e2f9f6ab62ca"><div class="ttname"><a href="classDS3232RTC.html#ab03358e3b5996e38d766e2f9f6ab62ca">DS3232RTC::readDate</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00225">DS3232RTC.cpp:225</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a3966de6f4241d86f198a8b9dd5e7e59a"><div class="ttname"><a href="classDS3232RTC.html#a3966de6f4241d86f198a8b9dd5e7e59a">DS3232RTC::enable32kHzOutput</a></div><div class="ttdeci">void enable32kHzOutput()</div><div class="ttdoc">Enables the 32 kHz output on the DS3232 chip. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8cpp_source.html#l00444">DS3232RTC.cpp:444</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a8b0a65e0ac479aec8fad6ca3147dbe75"><div class="ttname"><a href="classDS3232RTC.html#a8b0a65e0ac479aec8fad6ca3147dbe75">DS3232RTC::writeAlarm</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00298">DS3232RTC.cpp:298</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html"><div class="ttname"><a href="classDS3232RTC.html">DS3232RTC</a></div><div class="ttdoc">Communicates with a DS3232 realtime clock chip via I2C. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8h_source.html#l00030">DS3232RTC.h:30</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a225b8c62d617aa1b7be7d20e8a033be9"><div class="ttname"><a href="classDS3232RTC.html#a225b8c62d617aa1b7be7d20e8a033be9">DS3232RTC::disableAlarmInterrupts</a></div><div class="ttdeci">void disableAlarmInterrupts()</div><div class="ttdoc">Disables the generation of interrupts for alarms 0 and 1. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8cpp_source.html#l00393">DS3232RTC.cpp:393</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="classDS3232RTC_html_ab0ca13a8b80da856b37fc53b84e27c78"><div class="ttname"><a href="classDS3232RTC.html#ab0ca13a8b80da856b37fc53b84e27c78">DS3232RTC::writeTime</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00250">DS3232RTC.cpp:250</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a5ba83a3ef7d65d45c2f3241afdd8fef7"><div class="ttname"><a href="classDS3232RTC.html#a5ba83a3ef7d65d45c2f3241afdd8fef7">DS3232RTC::readByte</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00340">DS3232RTC.cpp:340</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a79649f100a4562b9c1ba7c69e85cbca3"><div class="ttname"><a href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3">DS3232RTC::firedAlarm</a></div><div class="ttdeci">int firedAlarm()</div><div class="ttdoc">Determines which of alarms 0 or 1 have fired since the last call. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8cpp_source.html#l00416">DS3232RTC.cpp:416</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_aa959454ae01b11c48d6ec7ec192b4ccb"><div class="ttname"><a href="classDS3232RTC.html#aa959454ae01b11c48d6ec7ec192b4ccb">DS3232RTC::DS3232RTC</a></div><div class="ttdeci">DS3232RTC(I2CMaster &bus, uint8_t oneHzPin=255)</div><div class="ttdoc">Attaches to a realtime clock slave device on bus. </div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8cpp_source.html#l00126">DS3232RTC.cpp:126</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_acc5908a3743afb4c26bd75e22cad87a4"><div class="ttname"><a href="classDS3232RTC.html#acc5908a3743afb4c26bd75e22cad87a4">DS3232RTC::isRealTime</a></div><div class="ttdeci">bool isRealTime() const </div><div class="ttdoc">Returns true if the realtime clock is on the I2C bus; false if the time and date are simulated...</div><div class="ttdef"><b>Definition:</b> <a href="DS3232RTC_8h_source.html#l00034">DS3232RTC.h:34</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a619ffee1bc013c9ddf4ae415115798bc"><div class="ttname"><a href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc">DS3232RTC::hasUpdates</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00166">DS3232RTC.cpp:166</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="classI2CMaster_html"><div class="ttname"><a href="classI2CMaster.html">I2CMaster</a></div><div class="ttdoc">Abstract base class for I2C master implementations. </div><div class="ttdef"><b>Definition:</b> <a href="I2CMaster_8h_source.html#l00028">I2CMaster.h:28</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a31c004a90c724979d8267c31f2dbf5ed"><div class="ttname"><a href="classDS3232RTC.html#a31c004a90c724979d8267c31f2dbf5ed">DS3232RTC::writeDate</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00264">DS3232RTC.cpp:264</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="classDS3232RTC_html_a09c7073c687dcbbc423baf48074c7873"><div class="ttname"><a href="classDS3232RTC.html#a09c7073c687dcbbc423baf48074c7873">DS3232RTC::readAlarm</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00278">DS3232RTC.cpp:278</a></div></div>
|
|
<div class="ttc" id="classDS3232RTC_html_a9acebf12c5cecdd6d84e0ff9ed41765a"><div class="ttname"><a href="classDS3232RTC.html#a9acebf12c5cecdd6d84e0ff9ed41765a">DS3232RTC::writeByte</a></div><div class="ttdeci">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="DS3232RTC_8cpp_source.html#l00348">DS3232RTC.cpp:348</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><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Apr 2 2018 18:36:52 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>
|