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
2012-06-13 15:23:00 +10:00
parent 486cf115a8
commit a108e5742e
184 changed files with 687 additions and 502 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
classRTC.html
View File

@@ -61,6 +61,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
@@ -86,6 +87,20 @@ Inheritance diagram for RTC:</div>
<p><a href="classRTC-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><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><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><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="classRTC.html#ada31c5120d18d2dd2863b3d440308da2">RTC</a> ()</td></tr>
@@ -120,6 +135,8 @@ Static Public Member Functions</h2></td></tr>
<tr><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><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><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><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><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><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee5ae8f600ee5296e65635c0d836fca3"></a><!-- doxytag: member="RTC::ALARM_COUNT" ref="aee5ae8f600ee5296e65635c0d836fca3" args="" -->
@@ -146,7 +163,26 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structRTCTime.html" title="Stores time information from a realtime clock chip.">RTCTime</a>, <a class="el" href="structRTCDate.html" title="Stores date information from a realtime clock chip.">RTCDate</a>, <a class="el" href="structRTCAlarm.html" title="Stores alarm information from a realtime clock chip.">RTCAlarm</a>, <a class="el" href="classDS1307RTC.html" title="Communicates with a DS1307 realtime clock chip via I2C.">DS1307RTC</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="RTC_8h_source.html#l00049">49</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ab2ca0cbee608ec32d3d6e04d40298f11"></a><!-- doxytag: member="RTC::DayOfWeek" ref="ab2ca0cbee608ec32d3d6e04d40298f11" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">RTC::DayOfWeek</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Day of the week corresponding to a date. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classRTC.html#a525a9c1dad89613708f47a683eb316aa" title="Returns the day of the week corresponding to date.">dayOfWeek()</a> </dd></dl>
<p>Definition at line <a class="el" href="RTC_8h_source.html#l00055">55</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ada31c5120d18d2dd2863b3d440308da2"></a><!-- doxytag: member="RTC::RTC" ref="ada31c5120d18d2dd2863b3d440308da2" args="()" -->
<div class="memitem">
<div class="memproto">
@@ -164,7 +200,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Constructs a new realtime clock handler. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classRTC.html#a3690761f29654a2c9e676fcbfa32dd30" 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="RTC_8cpp_source.html#l00090">90</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00105">105</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -197,7 +233,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Adjusts <em>date</em> up or down one day according to <em>flags</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4" title="Adjusts date up or down one month according to flags.">adjustMonths()</a>, <a class="el" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d" title="Adjusts date up or down one year according to flags.">adjustYears()</a> </dd></dl>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00298">298</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00313">313</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -229,7 +265,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Adjusts <em>date</em> up or down one month according to <em>flags</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><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#a31d10cb2f7cac8839bd4be2d858b802d" title="Adjusts date up or down one year according to flags.">adjustYears()</a> </dd></dl>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00328">328</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00343">343</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -261,7 +297,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Adjusts <em>date</em> up or down one year according to <em>flags</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><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> </dd></dl>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00355">355</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00370">370</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -284,7 +320,29 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a93c25269a9b78ab3331354db26672248">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00220">220</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00235">235</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a525a9c1dad89613708f47a683eb316aa"></a><!-- doxytag: member="RTC::dayOfWeek" ref="a525a9c1dad89613708f47a683eb316aa" args="(const RTCDate *date)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">RTC::DayOfWeek</a> RTC::dayOfWeek </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structRTCDate.html">RTCDate</a> *&#160;</td>
<td class="paramname"><em>date</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the day of the week corresponding to <em>date</em>. </p>
<p>This function is only guaranteed to produce meaningful values for years between 2000 and 2099. </p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00399">399</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -307,7 +365,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a6fec8ff71f33cc1a129eb0bd009600b0">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00119">119</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00134">134</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -343,7 +401,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#aab608eb1630520ee122306b721fdc47a">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a09c7073c687dcbbc423baf48074c7873">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00194">194</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00209">209</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -368,7 +426,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a7364609a201022688778ab116c3e4f4a">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a5ba83a3ef7d65d45c2f3241afdd8fef7">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00232">232</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00247">247</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -393,7 +451,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#ab03358e3b5996e38d766e2f9f6ab62ca">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00154">154</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00169">169</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -416,7 +474,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS3232RTC.html#a0faf40c25ab019a326a60f301c2bb41b">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00273">273</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00288">288</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -440,7 +498,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#acd9800d6df2244b8e4e790480a1d62a6">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00129">129</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00144">144</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -476,7 +534,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a7354aed91d7c94d0d7b2144b1bf32c75">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a8b0a65e0ac479aec8fad6ca3147dbe75">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00209">209</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00224">224</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -511,7 +569,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a6ef435fd4aa4adf8eefdf8b1741f5ba6">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a9acebf12c5cecdd6d84e0ff9ed41765a">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00247">247</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00262">262</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -535,7 +593,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a4f7346be33612cf9ecd96080eb046230">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#a31c004a90c724979d8267c31f2dbf5ed">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00179">179</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00194">194</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -559,7 +617,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
<p>Reimplemented in <a class="el" href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8">DS1307RTC</a>, and <a class="el" href="classDS3232RTC.html#ab0ca13a8b80da856b37fc53b84e27c78">DS3232RTC</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00164">164</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
<p>Definition at line <a class="el" href="RTC_8cpp_source.html#l00179">179</a> of file <a class="el" href="RTC_8cpp_source.html">RTC.cpp</a>.</p>
</div>
</div>
@@ -582,7 +640,7 @@ static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Jun 12 2012 11:29:26 for ArduinoLibs by&#160;
<hr class="footer"/><address class="footer"><small>Generated on Wed Jun 13 2012 15:22:30 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>
</body>