taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2013-09-29 09:34:55 +10:00
parent 17f4fb4873
commit 8b7f9606ee
409 changed files with 21357 additions and 18181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

353
classDS1307RTC.html
View File

@@ -2,29 +2,37 @@
<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"/>
<title>ArduinoLibs: DS1307RTC Class Reference</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>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<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>
<div id="projectname">ArduinoLibs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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&#160;Page</span></a></li>
@@ -32,7 +40,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
@@ -58,15 +66,30 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><a href="functions.html"><span>Class&#160;Members</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classDS1307RTC-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DS1307RTC Class Reference</div> </div>
</div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="DS1307RTC" --><!-- doxytag: inherits="RTC" -->
<p>Communicates with a DS1307 realtime clock chip via I2C.
<a href="classDS1307RTC.html#details">More...</a></p>
@@ -80,48 +103,92 @@ Inheritance diagram for DS1307RTC:</div>
<area href="classRTC.html" title="Base class for realtime clock handlers." alt="RTC" shape="rect" coords="0,0,81,24"/>
</map>
</div></div>
<p><a href="classDS1307RTC-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a092805d75bea323dc4be062638bff866">DS1307RTC</a> (<a class="el" href="classI2CMaster.html">I2CMaster</a> &amp;bus, uint8_t oneHzPin=255)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches to a realtime clock slave device on <em>bus</em>. <a href="#a092805d75bea323dc4be062638bff866"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba01ca4c2f7863b610e5dfe9146886bd"></a><!-- doxytag: member="DS1307RTC::isRealTime" ref="aba01ca4c2f7863b610e5dfe9146886bd" args="() const " -->
<tr class="memitem:a092805d75bea323dc4be062638bff866"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a092805d75bea323dc4be062638bff866">DS1307RTC</a> (<a class="el" href="classI2CMaster.html">I2CMaster</a> &amp;bus, uint8_t oneHzPin=255)</td></tr>
<tr class="memdesc:a092805d75bea323dc4be062638bff866"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches to a realtime clock slave device on <em>bus</em>. <a href="#a092805d75bea323dc4be062638bff866"></a><br/></td></tr>
<tr class="memitem:aba01ca4c2f7863b610e5dfe9146886bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba01ca4c2f7863b610e5dfe9146886bd"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#aba01ca4c2f7863b610e5dfe9146886bd">isRealTime</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the realtime clock is on the I2C bus; false if the time and date are simulated. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0">hasUpdates</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the realtime clock has updated since the last call to this function. <a href="#a6fec8ff71f33cc1a129eb0bd009600b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6">readTime</a> (<a class="el" href="structRTCTime.html">RTCTime</a> *value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current time from the realtime clock into <em>value</em>. <a href="#acd9800d6df2244b8e4e790480a1d62a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4">readDate</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current date from the realtime clock into <em>value</em>. <a href="#a6fb56d1690bc30e7995961a5b5e5fdc4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8">writeTime</a> (const <a class="el" href="structRTCTime.html">RTCTime</a> *value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the time in the realtime clock to match <em>value</em>. <a href="#a0a5d0d86a0345420ebb289ea724b19e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230">writeDate</a> (const <a class="el" href="structRTCDate.html">RTCDate</a> *value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the date in the realtime clock to match <em>value</em>. <a href="#a4f7346be33612cf9ecd96080eb046230"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#aab608eb1630520ee122306b721fdc47a">readAlarm</a> (uint8_t alarmNum, <a class="el" href="structRTCAlarm.html">RTCAlarm</a> *value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the details of the alarm with index <em>alarmNum</em> into <em>value</em>. <a href="#aab608eb1630520ee122306b721fdc47a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a7354aed91d7c94d0d7b2144b1bf32c75">writeAlarm</a> (uint8_t alarmNum, const <a class="el" href="structRTCAlarm.html">RTCAlarm</a> *value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the details of the alarm with index <em>alarmNum</em> from <em>value</em>. <a href="#a7354aed91d7c94d0d7b2144b1bf32c75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248">byteCount</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings, excluding storage used by alarms. <a href="#a93c25269a9b78ab3331354db26672248"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a">readByte</a> (uint8_t offset)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the byte at <em>offset</em> within the realtime clock's non-volatile memory. <a href="#a7364609a201022688778ab116c3e4f4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6">writeByte</a> (uint8_t offset, uint8_t value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes <em>value</em> to <em>offset</em> within the realtime clock's non-volatile memory. <a href="#a6ef435fd4aa4adf8eefdf8b1741f5ba6"></a><br/></td></tr>
<tr class="memdesc:aba01ca4c2f7863b610e5dfe9146886bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the realtime clock is on the I2C bus; false if the time and date are simulated. <br/></td></tr>
<tr class="memitem:a6fec8ff71f33cc1a129eb0bd009600b0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0">hasUpdates</a> ()</td></tr>
<tr class="memdesc:a6fec8ff71f33cc1a129eb0bd009600b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the realtime clock has updated since the last call to this function. <a href="#a6fec8ff71f33cc1a129eb0bd009600b0"></a><br/></td></tr>
<tr class="memitem:acd9800d6df2244b8e4e790480a1d62a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6">readTime</a> (<a class="el" href="structRTCTime.html">RTCTime</a> *value)</td></tr>
<tr class="memdesc:acd9800d6df2244b8e4e790480a1d62a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current time from the realtime clock into <em>value</em>. <a href="#acd9800d6df2244b8e4e790480a1d62a6"></a><br/></td></tr>
<tr class="memitem:a6fb56d1690bc30e7995961a5b5e5fdc4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4">readDate</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *value)</td></tr>
<tr class="memdesc:a6fb56d1690bc30e7995961a5b5e5fdc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current date from the realtime clock into <em>value</em>. <a href="#a6fb56d1690bc30e7995961a5b5e5fdc4"></a><br/></td></tr>
<tr class="memitem:a0a5d0d86a0345420ebb289ea724b19e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8">writeTime</a> (const <a class="el" href="structRTCTime.html">RTCTime</a> *value)</td></tr>
<tr class="memdesc:a0a5d0d86a0345420ebb289ea724b19e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the time in the realtime clock to match <em>value</em>. <a href="#a0a5d0d86a0345420ebb289ea724b19e8"></a><br/></td></tr>
<tr class="memitem:a4f7346be33612cf9ecd96080eb046230"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230">writeDate</a> (const <a class="el" href="structRTCDate.html">RTCDate</a> *value)</td></tr>
<tr class="memdesc:a4f7346be33612cf9ecd96080eb046230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the date in the realtime clock to match <em>value</em>. <a href="#a4f7346be33612cf9ecd96080eb046230"></a><br/></td></tr>
<tr class="memitem:aab608eb1630520ee122306b721fdc47a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#aab608eb1630520ee122306b721fdc47a">readAlarm</a> (uint8_t alarmNum, <a class="el" href="structRTCAlarm.html">RTCAlarm</a> *value)</td></tr>
<tr class="memdesc:aab608eb1630520ee122306b721fdc47a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the details of the alarm with index <em>alarmNum</em> into <em>value</em>. <a href="#aab608eb1630520ee122306b721fdc47a"></a><br/></td></tr>
<tr class="memitem:a7354aed91d7c94d0d7b2144b1bf32c75"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a7354aed91d7c94d0d7b2144b1bf32c75">writeAlarm</a> (uint8_t alarmNum, const <a class="el" href="structRTCAlarm.html">RTCAlarm</a> *value)</td></tr>
<tr class="memdesc:a7354aed91d7c94d0d7b2144b1bf32c75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the details of the alarm with index <em>alarmNum</em> from <em>value</em>. <a href="#a7354aed91d7c94d0d7b2144b1bf32c75"></a><br/></td></tr>
<tr class="memitem:a93c25269a9b78ab3331354db26672248"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248">byteCount</a> () const </td></tr>
<tr class="memdesc:a93c25269a9b78ab3331354db26672248"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings, excluding storage used by alarms. <a href="#a93c25269a9b78ab3331354db26672248"></a><br/></td></tr>
<tr class="memitem:a7364609a201022688778ab116c3e4f4a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a">readByte</a> (uint8_t offset)</td></tr>
<tr class="memdesc:a7364609a201022688778ab116c3e4f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the byte at <em>offset</em> within the realtime clock's non-volatile memory. <a href="#a7364609a201022688778ab116c3e4f4a"></a><br/></td></tr>
<tr class="memitem:a6ef435fd4aa4adf8eefdf8b1741f5ba6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6">writeByte</a> (uint8_t offset, uint8_t value)</td></tr>
<tr class="memdesc:a6ef435fd4aa4adf8eefdf8b1741f5ba6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes <em>value</em> to <em>offset</em> within the realtime clock's non-volatile memory. <a href="#a6ef435fd4aa4adf8eefdf8b1741f5ba6"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classRTC')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
<tr class="memitem:ada31c5120d18d2dd2863b3d440308da2 inherit pub_methods_classRTC"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#ada31c5120d18d2dd2863b3d440308da2">RTC</a> ()</td></tr>
<tr class="memdesc:ada31c5120d18d2dd2863b3d440308da2 inherit pub_methods_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new realtime clock handler. <a href="#ada31c5120d18d2dd2863b3d440308da2"></a><br/></td></tr>
<tr class="memitem:aeca3c8387332e8cabfd09c1806276e5a inherit pub_methods_classRTC"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a">readTemperature</a> ()</td></tr>
<tr class="memdesc:aeca3c8387332e8cabfd09c1806276e5a inherit pub_methods_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius. <a href="#aeca3c8387332e8cabfd09c1806276e5a"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classRTC')"><img src="closed.png" alt="-"/>&nbsp;Public Types inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
<tr class="memitem:ab2ca0cbee608ec32d3d6e04d40298f11 inherit pub_types_classRTC"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">DayOfWeek</a> { <br/>
&#160;&#160;<b>Monday</b> = 1,
<b>Tuesday</b>,
<b>Wednesday</b>,
<b>Thursday</b>,
<br/>
&#160;&#160;<b>Friday</b>,
<b>Saturday</b>,
<b>Sunday</b>
<br/>
}</td></tr>
<tr class="memdesc:ab2ca0cbee608ec32d3d6e04d40298f11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Day of the week corresponding to a date. <a href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">More...</a><br/></td></tr>
<tr class="inherit_header pub_static_methods_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classRTC')"><img src="closed.png" alt="-"/>&nbsp;Static Public Member Functions inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
<tr class="memitem:adc29d7c43efc5a192d21965da5c3ee1d inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d">adjustDays</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags)</td></tr>
<tr class="memdesc:adc29d7c43efc5a192d21965da5c3ee1d inherit pub_static_methods_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts <em>date</em> up or down one day according to <em>flags</em>. <a href="#adc29d7c43efc5a192d21965da5c3ee1d"></a><br/></td></tr>
<tr class="memitem:aeca597e6e37a05716e664242f9cfc5f4 inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4">adjustMonths</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags)</td></tr>
<tr class="memdesc:aeca597e6e37a05716e664242f9cfc5f4 inherit pub_static_methods_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts <em>date</em> up or down one month according to <em>flags</em>. <a href="#aeca597e6e37a05716e664242f9cfc5f4"></a><br/></td></tr>
<tr class="memitem:a31d10cb2f7cac8839bd4be2d858b802d inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d">adjustYears</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags)</td></tr>
<tr class="memdesc:a31d10cb2f7cac8839bd4be2d858b802d inherit pub_static_methods_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts <em>date</em> up or down one year according to <em>flags</em>. <a href="#a31d10cb2f7cac8839bd4be2d858b802d"></a><br/></td></tr>
<tr class="memitem:a525a9c1dad89613708f47a683eb316aa inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">DayOfWeek</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a525a9c1dad89613708f47a683eb316aa">dayOfWeek</a> (const <a class="el" href="structRTCDate.html">RTCDate</a> *date)</td></tr>
<tr class="memdesc:a525a9c1dad89613708f47a683eb316aa inherit pub_static_methods_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the day of the week corresponding to <em>date</em>. <a href="#a525a9c1dad89613708f47a683eb316aa"></a><br/></td></tr>
<tr class="inherit_header pub_static_attribs_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classRTC')"><img src="closed.png" alt="-"/>&nbsp;Static Public Attributes inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
<tr class="memitem:aee5ae8f600ee5296e65635c0d836fca3 inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee5ae8f600ee5296e65635c0d836fca3"></a>
static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> = 4</td></tr>
<tr class="memdesc:aee5ae8f600ee5296e65635c0d836fca3 inherit pub_static_attribs_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of alarms that are supported by <a class="el" href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66" title="Reads the details of the alarm with index alarmNum into value.">RTC::readAlarm()</a> and <a class="el" href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e" title="Updates the details of the alarm with index alarmNum from value.">RTC::writeAlarm()</a>. <br/></td></tr>
<tr class="memitem:a9ed5480b362a83f1f45c4d3bcf7c3bf8 inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ed5480b362a83f1f45c4d3bcf7c3bf8"></a>
static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8">NO_TEMPERATURE</a> = 32767</td></tr>
<tr class="memdesc:a9ed5480b362a83f1f45c4d3bcf7c3bf8 inherit pub_static_attribs_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value that is returned from <a class="el" href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a" title="Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius...">readTemperature()</a> if the realtime clock chip cannot determine the temperature. <br/></td></tr>
<tr class="memitem:aacbe3ebbf893685950b05327c11d5c37 inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacbe3ebbf893685950b05327c11d5c37"></a>
static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37">INCREMENT</a> = 0x0000</td></tr>
<tr class="memdesc:aacbe3ebbf893685950b05327c11d5c37 inherit pub_static_attribs_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the day, month, or year in a call to <a class="el" href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d" title="Adjusts date up or down one day according to flags.">adjustDays()</a>, <a class="el" href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4" title="Adjusts date up or down one month according to flags.">adjustMonths()</a>, or <a class="el" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d" title="Adjusts date up or down one year according to flags.">adjustYears()</a>. <br/></td></tr>
<tr class="memitem:a05b1bd1479afc80682abdd4f3e58dc6f inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05b1bd1479afc80682abdd4f3e58dc6f"></a>
static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f">DECREMENT</a> = 0x0001</td></tr>
<tr class="memdesc:a05b1bd1479afc80682abdd4f3e58dc6f inherit pub_static_attribs_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrement the day, month, or year in a call to <a class="el" href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d" title="Adjusts date up or down one day according to flags.">adjustDays()</a>, <a class="el" href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4" title="Adjusts date up or down one month according to flags.">adjustMonths()</a>, or <a class="el" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d" title="Adjusts date up or down one year according to flags.">adjustYears()</a>. <br/></td></tr>
<tr class="memitem:a02ace2d775063be9a99035851c9274eb inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02ace2d775063be9a99035851c9274eb"></a>
static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a02ace2d775063be9a99035851c9274eb">WRAP</a> = 0x0002</td></tr>
<tr class="memdesc:a02ace2d775063be9a99035851c9274eb inherit pub_static_attribs_classRTC"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrap around to the beginning of the current month/year rather than advance to the next one. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Communicates with a DS1307 realtime clock chip via I2C. </p>
<p>This class simplifies the process of reading and writing the time and date information in a DS1307 realtime clock chip. The class also provides support for reading and writing information about alarms and other clock settings.</p>
<p>If there is no DS1307 chip on the I2C bus, this class will fall back to the <a class="el" href="classRTC.html" title="Base class for realtime clock handlers.">RTC</a> class to simulate the current time and date based on the value of millis().</p>
<p>The DS1307 uses a 2-digit year so this class is limited to dates between 2000 and 2099 inclusive.</p>
<p>Note: if this class has not been used with the DS1307 chip before, then the contents of NVRAM will be cleared. Any previous contents will be lost.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classRTC.html" title="Base class for realtime clock handlers.">RTC</a>, <a class="el" href="classDS3232RTC.html" title="Communicates with a DS3232 realtime clock chip via I2C.">DS3232RTC</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRTC.html" title="Base class for realtime clock handlers.">RTC</a>, <a class="el" href="classDS3232RTC.html" title="Communicates with a DS3232 realtime clock chip via I2C.">DS3232RTC</a> </dd></dl>
<p>Definition at line <a class="el" href="DS1307RTC_8h_source.html#l00030">30</a> of file <a class="el" href="DS1307RTC_8h_source.html">DS1307RTC.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a092805d75bea323dc4be062638bff866"></a><!-- doxytag: member="DS1307RTC::DS1307RTC" ref="a092805d75bea323dc4be062638bff866" args="(I2CMaster &amp;bus, uint8_t oneHzPin=255)" -->
</div><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a092805d75bea323dc4be062638bff866"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -143,34 +210,40 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Attaches to a realtime clock slave device on <em>bus</em>. </p>
<p>If <em>oneHzPin</em> is not 255, then it indicates a digital input pin that is connected to the 1 Hz square wave output on the realtime clock. This input is used by <a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0" title="Returns true if the realtime clock has updated since the last call to this function.">hasUpdates()</a> to determine if the time information has changed in a non-trivial manner.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0" title="Returns true if the realtime clock has updated since the last call to this function.">hasUpdates()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0" title="Returns true if the realtime clock has updated since the last call to this function.">hasUpdates()</a> </dd></dl>
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00083">83</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a93c25269a9b78ab3331354db26672248"></a><!-- doxytag: member="DS1307RTC::byteCount" ref="a93c25269a9b78ab3331354db26672248" args="() const " -->
<h2>Member Function Documentation</h2>
<a class="anchor" id="a93c25269a9b78ab3331354db26672248"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int DS1307RTC::byteCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings, excluding storage used by alarms. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a" title="Reads the byte at offset within the realtime clock&#39;s non-volatile memory.">readByte()</a>, <a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6" title="Writes value to offset within the realtime clock&#39;s non-volatile memory.">writeByte()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a" title="Reads the byte at offset within the realtime clock&#39;s non-volatile memory.">readByte()</a>, <a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6" title="Writes value to offset within the realtime clock&#39;s non-volatile memory.">writeByte()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#acfdebfb449710e44e11f9a3675e14fd8">RTC</a>.</p>
@@ -178,19 +251,26 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a6fec8ff71f33cc1a129eb0bd009600b0"></a><!-- doxytag: member="DS1307RTC::hasUpdates" ref="a6fec8ff71f33cc1a129eb0bd009600b0" args="()" -->
<a class="anchor" id="a6fec8ff71f33cc1a129eb0bd009600b0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool DS1307RTC::hasUpdates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the realtime clock has updated since the last call to this function. </p>
<p>The default implementation returns true, indicating that an update is always available to be read. </p>
@@ -201,9 +281,12 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="aab608eb1630520ee122306b721fdc47a"></a><!-- doxytag: member="DS1307RTC::readAlarm" ref="aab608eb1630520ee122306b721fdc47a" args="(uint8_t alarmNum, RTCAlarm *value)" -->
<a class="anchor" id="aab608eb1630520ee122306b721fdc47a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::readAlarm </td>
@@ -220,16 +303,20 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the details of the alarm with index <em>alarmNum</em> into <em>value</em>. </p>
<p>The <em>alarmNum</em> parameter must be between 0 and <a class="el" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> - 1.</p>
<p>Alarm details are stored at the end of the realtime clock's non-volatile memory.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a7354aed91d7c94d0d7b2144b1bf32c75" title="Updates the details of the alarm with index alarmNum from value.">writeAlarm()</a>, alarmCount() </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a7354aed91d7c94d0d7b2144b1bf32c75" title="Updates the details of the alarm with index alarmNum from value.">writeAlarm()</a>, alarmCount() </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66">RTC</a>.</p>
@@ -237,24 +324,31 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a7364609a201022688778ab116c3e4f4a"></a><!-- doxytag: member="DS1307RTC::readByte" ref="a7364609a201022688778ab116c3e4f4a" args="(uint8_t offset)" -->
<a class="anchor" id="a7364609a201022688778ab116c3e4f4a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t DS1307RTC::readByte </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td><code> [virtual]</code></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the byte at <em>offset</em> within the realtime clock's non-volatile memory. </p>
<p>The <em>offset</em> parameter must be between 0 and <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> - 1.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6" title="Writes value to offset within the realtime clock&#39;s non-volatile memory.">writeByte()</a>, <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6" title="Writes value to offset within the realtime clock&#39;s non-volatile memory.">writeByte()</a>, <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#a0f47b10b436e3f9d36e04ec907579431">RTC</a>.</p>
@@ -262,24 +356,31 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a6fb56d1690bc30e7995961a5b5e5fdc4"></a><!-- doxytag: member="DS1307RTC::readDate" ref="a6fb56d1690bc30e7995961a5b5e5fdc4" args="(RTCDate *value)" -->
<a class="anchor" id="a6fb56d1690bc30e7995961a5b5e5fdc4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::readDate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRTCDate.html">RTCDate</a> *&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [virtual]</code></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the current date from the realtime clock into <em>value</em>. </p>
<p>The time should be read first with <a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6" title="Reads the current time from the realtime clock into value.">readTime()</a> as the default implementation only advances the date when the time is read and it crosses midnight.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230" title="Updates the date in the realtime clock to match value.">writeDate()</a>, <a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6" title="Reads the current time from the realtime clock into value.">readTime()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230" title="Updates the date in the realtime clock to match value.">writeDate()</a>, <a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6" title="Reads the current time from the realtime clock into value.">readTime()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#aa1e21bf42ebd4456919744ae0f4f631e">RTC</a>.</p>
@@ -287,23 +388,30 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="acd9800d6df2244b8e4e790480a1d62a6"></a><!-- doxytag: member="DS1307RTC::readTime" ref="acd9800d6df2244b8e4e790480a1d62a6" args="(RTCTime *value)" -->
<a class="anchor" id="acd9800d6df2244b8e4e790480a1d62a6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::readTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRTCTime.html">RTCTime</a> *&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [virtual]</code></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the current time from the realtime clock into <em>value</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8" title="Updates the time in the realtime clock to match value.">writeTime()</a>, <a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4" title="Reads the current date from the realtime clock into value.">readDate()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8" title="Updates the time in the realtime clock to match value.">writeTime()</a>, <a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4" title="Reads the current date from the realtime clock into value.">readDate()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#aaf0a5c1f32f210a49718d148620b5bec">RTC</a>.</p>
@@ -311,9 +419,12 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a7354aed91d7c94d0d7b2144b1bf32c75"></a><!-- doxytag: member="DS1307RTC::writeAlarm" ref="a7354aed91d7c94d0d7b2144b1bf32c75" args="(uint8_t alarmNum, const RTCAlarm *value)" -->
<a class="anchor" id="a7354aed91d7c94d0d7b2144b1bf32c75"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::writeAlarm </td>
@@ -330,16 +441,20 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the details of the alarm with index <em>alarmNum</em> from <em>value</em>. </p>
<p>The <em>alarmNum</em> parameter must be between 0 and <a class="el" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> - 1.</p>
<p>Alarm details are stored at the end of the realtime clock's non-volatile memory.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#aab608eb1630520ee122306b721fdc47a" title="Reads the details of the alarm with index alarmNum into value.">readAlarm()</a>, alarmCount() </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#aab608eb1630520ee122306b721fdc47a" title="Reads the details of the alarm with index alarmNum into value.">readAlarm()</a>, alarmCount() </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e">RTC</a>.</p>
@@ -347,9 +462,12 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a6ef435fd4aa4adf8eefdf8b1741f5ba6"></a><!-- doxytag: member="DS1307RTC::writeByte" ref="a6ef435fd4aa4adf8eefdf8b1741f5ba6" args="(uint8_t offset, uint8_t value)" -->
<a class="anchor" id="a6ef435fd4aa4adf8eefdf8b1741f5ba6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::writeByte </td>
@@ -366,15 +484,19 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes <em>value</em> to <em>offset</em> within the realtime clock's non-volatile memory. </p>
<p>The <em>offset</em> parameter must be between 0 and <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> - 1.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a" title="Reads the byte at offset within the realtime clock&#39;s non-volatile memory.">readByte()</a>, <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a" title="Reads the byte at offset within the realtime clock&#39;s non-volatile memory.">readByte()</a>, <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#a1cab6397ec04b1e2b3feea5b3cd1f749">RTC</a>.</p>
@@ -382,23 +504,30 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a4f7346be33612cf9ecd96080eb046230"></a><!-- doxytag: member="DS1307RTC::writeDate" ref="a4f7346be33612cf9ecd96080eb046230" args="(const RTCDate *value)" -->
<a class="anchor" id="a4f7346be33612cf9ecd96080eb046230"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::writeDate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structRTCDate.html">RTCDate</a> *&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [virtual]</code></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the date in the realtime clock to match <em>value</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4" title="Reads the current date from the realtime clock into value.">readDate()</a>, <a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8" title="Updates the time in the realtime clock to match value.">writeTime()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4" title="Reads the current date from the realtime clock into value.">readDate()</a>, <a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8" title="Updates the time in the realtime clock to match value.">writeTime()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#ae667600d05c8e7b06a93574dd068a4d7">RTC</a>.</p>
@@ -406,23 +535,30 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</div>
</div>
<a class="anchor" id="a0a5d0d86a0345420ebb289ea724b19e8"></a><!-- doxytag: member="DS1307RTC::writeTime" ref="a0a5d0d86a0345420ebb289ea724b19e8" args="(const RTCTime *value)" -->
<a class="anchor" id="a0a5d0d86a0345420ebb289ea724b19e8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DS1307RTC::writeTime </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structRTCTime.html">RTCTime</a> *&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [virtual]</code></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the time in the realtime clock to match <em>value</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6" title="Reads the current time from the realtime clock into value.">readTime()</a>, <a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230" title="Updates the date in the realtime clock to match value.">writeDate()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6" title="Reads the current time from the realtime clock into value.">readTime()</a>, <a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230" title="Updates the date in the realtime clock to match value.">writeDate()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classRTC.html#a102e2ec15bf0273d8f7e9ce4b6dcc96e">RTC</a>.</p>
@@ -434,23 +570,12 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<li><a class="el" href="DS1307RTC_8h_source.html">DS1307RTC.h</a></li>
<li><a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</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>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 18 2012 11:02:52 for ArduinoLibs by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>