mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
457 lines
29 KiB
HTML
457 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"/>
|
|
<title>ArduinoLibs: DS1307RTC Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<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"/>
|
|
</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">
|
|
<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>
|
|
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li id="searchli">
|
|
<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="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DS1307RTC Class Reference</div> </div>
|
|
</div>
|
|
<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>
|
|
|
|
<p><code>#include <<a class="el" href="DS1307RTC_8h_source.html">DS1307RTC.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for DS1307RTC:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classDS1307RTC.png" usemap="#DS1307RTC_map" alt=""/>
|
|
<map id="DS1307RTC_map" name="DS1307RTC_map">
|
|
<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>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a092805d75bea323dc4be062638bff866">DS1307RTC</a> (<a class="el" href="classI2CMaster.html">I2CMaster</a> &bus, uint8_t oneHzPin=255)</td></tr>
|
|
<tr><td class="mdescLeft"> </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 " -->
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#aba01ca4c2f7863b610e5dfe9146886bd">isRealTime</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0">hasUpdates</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248">byteCount</a> () const </td></tr>
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a">readByte</a> (uint8_t offset)</td></tr>
|
|
<tr><td class="mdescLeft"> </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 </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"> </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>
|
|
</table>
|
|
<hr/><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>
|
|
|
|
<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 & Destructor Documentation</h2>
|
|
<a class="anchor" id="a092805d75bea323dc4be062638bff866"></a><!-- doxytag: member="DS1307RTC::DS1307RTC" ref="a092805d75bea323dc4be062638bff866" args="(I2CMaster &bus, uint8_t oneHzPin=255)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DS1307RTC::DS1307RTC </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classI2CMaster.html">I2CMaster</a> & </td>
|
|
<td class="paramname"><em>bus</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>oneHzPin</em> = <code>255</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</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>
|
|
|
|
<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 " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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>
|
|
</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's non-volatile memory.">readByte()</a>, <a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6" title="Writes value to offset within the realtime clock's non-volatile memory.">writeByte()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#acfdebfb449710e44e11f9a3675e14fd8">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00264">264</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fec8ff71f33cc1a129eb0bd009600b0"></a><!-- doxytag: member="DS1307RTC::hasUpdates" ref="a6fec8ff71f33cc1a129eb0bd009600b0" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool DS1307RTC::hasUpdates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a3690761f29654a2c9e676fcbfa32dd30">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00118">118</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aab608eb1630520ee122306b721fdc47a"></a><!-- doxytag: member="DS1307RTC::readAlarm" ref="aab608eb1630520ee122306b721fdc47a" args="(uint8_t alarmNum, RTCAlarm *value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS1307RTC::readAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>alarmNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structRTCAlarm.html">RTCAlarm</a> * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00230">230</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7364609a201022688778ab116c3e4f4a"></a><!-- doxytag: member="DS1307RTC::readByte" ref="a7364609a201022688778ab116c3e4f4a" args="(uint8_t offset)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t DS1307RTC::readByte </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>offset</em></td><td>)</td>
|
|
<td><code> [virtual]</code></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'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>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00269">269</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fb56d1690bc30e7995961a5b5e5fdc4"></a><!-- doxytag: member="DS1307RTC::readDate" ref="a6fb56d1690bc30e7995961a5b5e5fdc4" args="(RTCDate *value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS1307RTC::readDate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structRTCDate.html">RTCDate</a> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#aa1e21bf42ebd4456919744ae0f4f631e">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00177">177</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acd9800d6df2244b8e4e790480a1d62a6"></a><!-- doxytag: member="DS1307RTC::readTime" ref="acd9800d6df2244b8e4e790480a1d62a6" args="(RTCTime *value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS1307RTC::readTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structRTCTime.html">RTCTime</a> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#aaf0a5c1f32f210a49718d148620b5bec">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00157">157</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7354aed91d7c94d0d7b2144b1bf32c75"></a><!-- doxytag: member="DS1307RTC::writeAlarm" ref="a7354aed91d7c94d0d7b2144b1bf32c75" args="(uint8_t alarmNum, const RTCAlarm *value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS1307RTC::writeAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>alarmNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structRTCAlarm.html">RTCAlarm</a> * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00250">250</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6ef435fd4aa4adf8eefdf8b1741f5ba6"></a><!-- doxytag: member="DS1307RTC::writeByte" ref="a6ef435fd4aa4adf8eefdf8b1741f5ba6" args="(uint8_t offset, uint8_t value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS1307RTC::writeByte </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td><code> [virtual]</code></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'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>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00277">277</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4f7346be33612cf9ecd96080eb046230"></a><!-- doxytag: member="DS1307RTC::writeDate" ref="a4f7346be33612cf9ecd96080eb046230" args="(const RTCDate *value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#ae667600d05c8e7b06a93574dd068a4d7">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00216">216</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0a5d0d86a0345420ebb289ea724b19e8"></a><!-- doxytag: member="DS1307RTC::writeTime" ref="a0a5d0d86a0345420ebb289ea724b19e8" args="(const RTCTime *value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td><code> [virtual]</code></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>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a102e2ec15bf0273d8f7e9ce4b6dcc96e">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS1307RTC_8cpp_source.html#l00202">202</a> of file <a class="el" href="DS1307RTC_8cpp_source.html">DS1307RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<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"> </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></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 Fri Jun 1 2012 14:29:17 for ArduinoLibs by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|