mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
211 lines
29 KiB
HTML
211 lines
29 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: DS3231RTC.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">DS3231RTC.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="comment">/*</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Adapted from DS3232RTC library for DS3231 RTC chip by Thijs Oppermann</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * 2014-12-07</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</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="preprocessor">#ifndef DS3231RTC_h</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="preprocessor">#define DS3231RTC_h</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "RTC.h"</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="classI2CMaster.html">I2CMaster</a>;</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="classDS3231RTC.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classDS3231RTC.html">DS3231RTC</a> : <span class="keyword">public</span> <a class="code" href="classRTC.html">RTC</a> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classDS3231RTC.html#a45df320cabed4ea2d5c34b437eda7e9f">DS3231RTC</a>(<a class="code" href="classI2CMaster.html">I2CMaster</a> &bus, uint8_t oneHzPin = 255);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classDS3231RTC.html#a2fa6fdd1f9e2b2b99be077c73639dce0"> 39</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classDS3231RTC.html#a2fa6fdd1f9e2b2b99be077c73639dce0">isRealTime</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> _isRealTime;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">bool</span> <a class="code" href="classDS3231RTC.html#a180bea03bd68df8f696e529cd1582095">hasUpdates</a>();</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a3a2c448b152c401fb598c487ef0ed288">readTime</a>(<a class="code" href="structRTCTime.html">RTCTime</a>* value);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a498a1a37b78993ab52780198c5b4a9df">readDate</a>(<a class="code" href="structRTCDate.html">RTCDate</a>* value);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#ae9bee8f68f9e124562230175ca9d15c3">writeTime</a>(<span class="keyword">const</span> <a class="code" href="structRTCTime.html">RTCTime</a>* value);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a450a143514a5aa228f8ef7a23d83d036">writeDate</a>(<span class="keyword">const</span> <a class="code" href="structRTCDate.html">RTCDate</a>* 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">void</span> <a class="code" href="classDS3231RTC.html#aab56929e759a49a90785729cceb72f2e">readAlarm</a>(uint8_t alarmNum, <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a1ed8945018024816600f709c6eb0c749">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="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span> <a class="code" href="classDS3231RTC.html#adb8b36354f00ea0a862cce6b1805d4c0">setAlarm</a>(uint8_t alarmNum, <span class="keyword">const</span> <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> <a class="code" href="classDS3231RTC.html#ad1dcb7897fd14ae745720a19fbe71e37">readTemperature</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="classDS3231RTC.html#a0e9509219b2c7259accd68a55aaa5faf">enableAlarmInterrupts</a>();</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a245a56a9396ef49a4e089d743c759cdb">disableAlarmInterrupts</a>();</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> <a class="code" href="classDS3231RTC.html#a6a5b3717ff65528de566c021eb821b94">firedAlarm</a>();</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a032cf784eb82ccf6ff0a9745b47ac86b">enable32kHzOutput</a>();</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a7c9c197c6f27c26e0cb9c5ddc95633c8">disable32kHzOutput</a>();</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#ad0a0614c48d4f809fee6017cd7350372">enableAlarm</a>(uint8_t alarmNum);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> <a class="code" href="classDS3231RTC.html#a21e2667c53d30aa425043ec08a117c47">disableAlarm</a>(uint8_t alarmNum);</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="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classI2CMaster.html">I2CMaster</a>* _bus;</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  uint8_t _oneHzPin;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> prevOneHz;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> _isRealTime;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> alarmInterrupts;</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="keywordtype">void</span> alarmSecondValues(uint8_t read_value, <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> alarmMinuteValues(uint8_t read_value, <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> alarmHourValues(uint8_t read_value, <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> alarmDayValues(uint8_t read_value, <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</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>  uint8_t getAlarmDayValue(<span class="keyword">const</span> <a class="code" href="structRTCAlarm.html">RTCAlarm</a>* value);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> clearAlarm(uint8_t alarmNum);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  uint8_t readRegister(uint8_t reg);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">bool</span> writeRegister(uint8_t reg, 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"> 86</span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a032cf784eb82ccf6ff0a9745b47ac86b"><div class="ttname"><a href="classDS3231RTC.html#a032cf784eb82ccf6ff0a9745b47ac86b">DS3231RTC::enable32kHzOutput</a></div><div class="ttdeci">void enable32kHzOutput()</div><div class="ttdoc">Enables the 32 kHz output on the DS3231 chip. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8cpp_source.html#l00562">DS3231RTC.cpp:562</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a245a56a9396ef49a4e089d743c759cdb"><div class="ttname"><a href="classDS3231RTC.html#a245a56a9396ef49a4e089d743c759cdb">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00508">DS3231RTC.cpp:508</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a498a1a37b78993ab52780198c5b4a9df"><div class="ttname"><a href="classDS3231RTC.html#a498a1a37b78993ab52780198c5b4a9df">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00228">DS3231RTC.cpp:228</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_ad1dcb7897fd14ae745720a19fbe71e37"><div class="ttname"><a href="classDS3231RTC.html#ad1dcb7897fd14ae745720a19fbe71e37">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00470">DS3231RTC.cpp:470</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a0e9509219b2c7259accd68a55aaa5faf"><div class="ttname"><a href="classDS3231RTC.html#a0e9509219b2c7259accd68a55aaa5faf">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00494">DS3231RTC.cpp:494</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html"><div class="ttname"><a href="classDS3231RTC.html">DS3231RTC</a></div><div class="ttdoc">Communicates with a DS3231 realtime clock chip via I2C. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8h_source.html#l00035">DS3231RTC.h:35</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a2fa6fdd1f9e2b2b99be077c73639dce0"><div class="ttname"><a href="classDS3231RTC.html#a2fa6fdd1f9e2b2b99be077c73639dce0">DS3231RTC::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="DS3231RTC_8h_source.html#l00039">DS3231RTC.h:39</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_ad0a0614c48d4f809fee6017cd7350372"><div class="ttname"><a href="classDS3231RTC.html#ad0a0614c48d4f809fee6017cd7350372">DS3231RTC::enableAlarm</a></div><div class="ttdeci">void enableAlarm(uint8_t alarmNum)</div><div class="ttdoc">Enables a specific alarm. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8cpp_source.html#l00606">DS3231RTC.cpp:606</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="classDS3231RTC_html_aab56929e759a49a90785729cceb72f2e"><div class="ttname"><a href="classDS3231RTC.html#aab56929e759a49a90785729cceb72f2e">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00280">DS3231RTC.cpp:280</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a45df320cabed4ea2d5c34b437eda7e9f"><div class="ttname"><a href="classDS3231RTC.html#a45df320cabed4ea2d5c34b437eda7e9f">DS3231RTC::DS3231RTC</a></div><div class="ttdeci">DS3231RTC(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="DS3231RTC_8cpp_source.html#l00125">DS3231RTC.cpp:125</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a21e2667c53d30aa425043ec08a117c47"><div class="ttname"><a href="classDS3231RTC.html#a21e2667c53d30aa425043ec08a117c47">DS3231RTC::disableAlarm</a></div><div class="ttdeci">void disableAlarm(uint8_t alarmNum)</div><div class="ttdoc">Disables a specific alarm. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8cpp_source.html#l00625">DS3231RTC.cpp:625</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_adb8b36354f00ea0a862cce6b1805d4c0"><div class="ttname"><a href="classDS3231RTC.html#adb8b36354f00ea0a862cce6b1805d4c0">DS3231RTC::setAlarm</a></div><div class="ttdeci">bool setAlarm(uint8_t alarmNum, const RTCAlarm *value)</div><div class="ttdoc">Sets the alarm with index alarmNum from value. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8cpp_source.html#l00408">DS3231RTC.cpp:408</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a450a143514a5aa228f8ef7a23d83d036"><div class="ttname"><a href="classDS3231RTC.html#a450a143514a5aa228f8ef7a23d83d036">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00266">DS3231RTC.cpp:266</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a1ed8945018024816600f709c6eb0c749"><div class="ttname"><a href="classDS3231RTC.html#a1ed8945018024816600f709c6eb0c749">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00374">DS3231RTC.cpp:374</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a7c9c197c6f27c26e0cb9c5ddc95633c8"><div class="ttname"><a href="classDS3231RTC.html#a7c9c197c6f27c26e0cb9c5ddc95633c8">DS3231RTC::disable32kHzOutput</a></div><div class="ttdeci">void disable32kHzOutput()</div><div class="ttdoc">Disables the 32 kHz output on the DS3231 chip. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8cpp_source.html#l00575">DS3231RTC.cpp:575</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="classDS3231RTC_html_ae9bee8f68f9e124562230175ca9d15c3"><div class="ttname"><a href="classDS3231RTC.html#ae9bee8f68f9e124562230175ca9d15c3">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00252">DS3231RTC.cpp:252</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="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="classDS3231RTC_html_a180bea03bd68df8f696e529cd1582095"><div class="ttname"><a href="classDS3231RTC.html#a180bea03bd68df8f696e529cd1582095">DS3231RTC::hasUpdates</a></div><div class="ttdeci">bool hasUpdates()</div><div class="ttdoc">Returns true if there are updates. </div><div class="ttdef"><b>Definition:</b> <a href="DS3231RTC_8cpp_source.html#l00166">DS3231RTC.cpp:166</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a3a2c448b152c401fb598c487ef0ed288"><div class="ttname"><a href="classDS3231RTC.html#a3a2c448b152c401fb598c487ef0ed288">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00207">DS3231RTC.cpp:207</a></div></div>
|
|
<div class="ttc" id="classDS3231RTC_html_a6a5b3717ff65528de566c021eb821b94"><div class="ttname"><a href="classDS3231RTC.html#a6a5b3717ff65528de566c021eb821b94">DS3231RTC::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="DS3231RTC_8cpp_source.html#l00530">DS3231RTC.cpp:530</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 Sat Aug 27 2016 14:32:20 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>
|