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
2015-03-29 08:32:07 +10:00
parent 64da24bbf6
commit 100a18a956
931 changed files with 1212 additions and 75896 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
RTC_8cpp_source.html
View File

@@ -350,22 +350,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="structRTCTime_html_acf2161ca037080dc4b767e636ad8db84"><div class="ttname"><a href="structRTCTime.html#acf2161ca037080dc4b767e636ad8db84">RTCTime::minute</a></div><div class="ttdeci">uint8_t minute</div><div class="ttdoc">Minute within the hour (0-59) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00031">RTC.h:31</a></div></div>
<div class="ttc" id="classRTC_html_ade282d7a60147c3f0269f1fcd59c8d66"><div class="ttname"><a href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66">RTC::readAlarm</a></div><div class="ttdeci">virtual void readAlarm(uint8_t alarmNum, RTCAlarm *value)</div><div class="ttdoc">Reads the details of the alarm with index alarmNum into value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00209">RTC.cpp:209</a></div></div>
<div class="ttc" id="classRTC_html_aa1e21bf42ebd4456919744ae0f4f631e"><div class="ttname"><a href="classRTC.html#aa1e21bf42ebd4456919744ae0f4f631e">RTC::readDate</a></div><div class="ttdeci">virtual void readDate(RTCDate *value)</div><div class="ttdoc">Reads the current date from the realtime clock into value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00169">RTC.cpp:169</a></div></div>
<div class="ttc" id="classRTC_html_a05b1bd1479afc80682abdd4f3e58dc6f"><div class="ttname"><a href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f">RTC::DECREMENT</a></div><div class="ttdeci">static const uint8_t DECREMENT</div><div class="ttdoc">Decrement the day, month, or year in a call to adjustDays(), adjustMonths(), or adjustYears(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00089">RTC.h:89</a></div></div>
<div class="ttc" id="classRTC_html_ab2ca0cbee608ec32d3d6e04d40298f11"><div class="ttname"><a href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">RTC::DayOfWeek</a></div><div class="ttdeci">DayOfWeek</div><div class="ttdoc">Day of the week corresponding to a date. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00055">RTC.h:55</a></div></div>
<div class="ttc" id="classRTC_html_a05b1bd1479afc80682abdd4f3e58dc6f"><div class="ttname"><a href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f">RTC::DECREMENT</a></div><div class="ttdeci">static const uint8_t DECREMENT</div><div class="ttdoc">Decrement the day, month, or year in a call to adjustDays(), adjustMonths(), or adjustYears(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00092">RTC.h:92</a></div></div>
<div class="ttc" id="classRTC_html_ab2ca0cbee608ec32d3d6e04d40298f11"><div class="ttname"><a href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">RTC::DayOfWeek</a></div><div class="ttdeci">DayOfWeek</div><div class="ttdoc">Day of the week corresponding to a date. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00058">RTC.h:58</a></div></div>
<div class="ttc" id="classRTC_html_a0e96c91efd9e7a6340effdae3eadf17e"><div class="ttname"><a href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e">RTC::writeAlarm</a></div><div class="ttdeci">virtual void writeAlarm(uint8_t alarmNum, const RTCAlarm *value)</div><div class="ttdoc">Updates the details of the alarm with index alarmNum from value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00224">RTC.cpp:224</a></div></div>
<div class="ttc" id="classRTC_html_aee5ae8f600ee5296e65635c0d836fca3"><div class="ttname"><a href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">RTC::ALARM_COUNT</a></div><div class="ttdeci">static const uint8_t ALARM_COUNT</div><div class="ttdoc">Number of alarms that are supported by RTC::readAlarm() and RTC::writeAlarm(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00074">RTC.h:74</a></div></div>
<div class="ttc" id="classRTC_html_aee5ae8f600ee5296e65635c0d836fca3"><div class="ttname"><a href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">RTC::ALARM_COUNT</a></div><div class="ttdeci">static const uint8_t ALARM_COUNT</div><div class="ttdoc">Number of alarms that are supported by RTC::readAlarm() and RTC::writeAlarm(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00077">RTC.h:77</a></div></div>
<div class="ttc" id="classRTC_html_ae667600d05c8e7b06a93574dd068a4d7"><div class="ttname"><a href="classRTC.html#ae667600d05c8e7b06a93574dd068a4d7">RTC::writeDate</a></div><div class="ttdeci">virtual void writeDate(const RTCDate *value)</div><div class="ttdoc">Updates the date in the realtime clock to match value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00194">RTC.cpp:194</a></div></div>
<div class="ttc" id="classRTC_html_acfdebfb449710e44e11f9a3675e14fd8"><div class="ttname"><a href="classRTC.html#acfdebfb449710e44e11f9a3675e14fd8">RTC::byteCount</a></div><div class="ttdeci">virtual int byteCount() const </div><div class="ttdoc">Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00235">RTC.cpp:235</a></div></div>
<div class="ttc" id="structRTCAlarm_html_a75bdc42acd3ab3ad495680c6b6a34692"><div class="ttname"><a href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692">RTCAlarm::hour</a></div><div class="ttdeci">uint8_t hour</div><div class="ttdoc">Hour of the day for the alarm (0-23). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00044">RTC.h:44</a></div></div>
<div class="ttc" id="classRTC_html_a9ed5480b362a83f1f45c4d3bcf7c3bf8"><div class="ttname"><a href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8">RTC::NO_TEMPERATURE</a></div><div class="ttdeci">static const int NO_TEMPERATURE</div><div class="ttdoc">Value that is returned from readTemperature() if the realtime clock chip cannot determine the tempera...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00083">RTC.h:83</a></div></div>
<div class="ttc" id="structRTCAlarm_html_a0f2ef7363cb60a26642d5295b77ca19e"><div class="ttname"><a href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">RTCAlarm::flags</a></div><div class="ttdeci">uint8_t flags</div><div class="ttdoc">Additional flags for the alarm. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00046">RTC.h:46</a></div></div>
<div class="ttc" id="structRTCAlarm_html_a75bdc42acd3ab3ad495680c6b6a34692"><div class="ttname"><a href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692">RTCAlarm::hour</a></div><div class="ttdeci">uint8_t hour</div><div class="ttdoc">Hour of the day for the alarm (0-23). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00046">RTC.h:46</a></div></div>
<div class="ttc" id="classRTC_html_a9ed5480b362a83f1f45c4d3bcf7c3bf8"><div class="ttname"><a href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8">RTC::NO_TEMPERATURE</a></div><div class="ttdeci">static const int NO_TEMPERATURE</div><div class="ttdoc">Value that is returned from readTemperature() if the realtime clock chip cannot determine the tempera...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00086">RTC.h:86</a></div></div>
<div class="ttc" id="structRTCAlarm_html_a0f2ef7363cb60a26642d5295b77ca19e"><div class="ttname"><a href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">RTCAlarm::flags</a></div><div class="ttdeci">uint8_t flags</div><div class="ttdoc">Additional flags for the alarm. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00049">RTC.h:49</a></div></div>
<div class="ttc" id="structRTCDate_html"><div class="ttname"><a href="structRTCDate.html">RTCDate</a></div><div class="ttdoc">Stores date information from a realtime clock chip. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00035">RTC.h:35</a></div></div>
<div class="ttc" id="structRTCDate_html_a7d31822daff3c3fc947386abd897732f"><div class="ttname"><a href="structRTCDate.html#a7d31822daff3c3fc947386abd897732f">RTCDate::year</a></div><div class="ttdeci">unsigned int year</div><div class="ttdoc">Year (4-digit) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00037">RTC.h:37</a></div></div>
<div class="ttc" id="classRTC_html_aeca3c8387332e8cabfd09c1806276e5a"><div class="ttname"><a href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a">RTC::readTemperature</a></div><div class="ttdeci">virtual int readTemperature()</div><div class="ttdoc">Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00288">RTC.cpp:288</a></div></div>
<div class="ttc" id="classRTC_html_a1cab6397ec04b1e2b3feea5b3cd1f749"><div class="ttname"><a href="classRTC.html#a1cab6397ec04b1e2b3feea5b3cd1f749">RTC::writeByte</a></div><div class="ttdeci">virtual void writeByte(uint8_t offset, uint8_t value)</div><div class="ttdoc">Writes value to offset within the realtime clock&#39;s non-volatile memory. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00262">RTC.cpp:262</a></div></div>
<div class="ttc" id="classRTC_html_a31d10cb2f7cac8839bd4be2d858b802d"><div class="ttname"><a href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d">RTC::adjustYears</a></div><div class="ttdeci">static void adjustYears(RTCDate *date, uint8_t flags)</div><div class="ttdoc">Adjusts date up or down one year according to flags. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00370">RTC.cpp:370</a></div></div>
<div class="ttc" id="structRTCAlarm_html_ad9a75ceb4b4b3474baa66dd5466e62fe"><div class="ttname"><a href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe">RTCAlarm::minute</a></div><div class="ttdeci">uint8_t minute</div><div class="ttdoc">Minute of the hour for the alarm (0-59). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00045">RTC.h:45</a></div></div>
<div class="ttc" id="classRTC_html_aacbe3ebbf893685950b05327c11d5c37"><div class="ttname"><a href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37">RTC::INCREMENT</a></div><div class="ttdeci">static const uint8_t INCREMENT</div><div class="ttdoc">Increment the day, month, or year in a call to adjustDays(), adjustMonths(), or adjustYears(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00088">RTC.h:88</a></div></div>
<div class="ttc" id="structRTCAlarm_html_ad9a75ceb4b4b3474baa66dd5466e62fe"><div class="ttname"><a href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe">RTCAlarm::minute</a></div><div class="ttdeci">uint8_t minute</div><div class="ttdoc">Minute of the hour for the alarm (0-59). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00047">RTC.h:47</a></div></div>
<div class="ttc" id="classRTC_html_aacbe3ebbf893685950b05327c11d5c37"><div class="ttname"><a href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37">RTC::INCREMENT</a></div><div class="ttdeci">static const uint8_t INCREMENT</div><div class="ttdoc">Increment the day, month, or year in a call to adjustDays(), adjustMonths(), or adjustYears(). </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00091">RTC.h:91</a></div></div>
<div class="ttc" id="classRTC_html_a0f47b10b436e3f9d36e04ec907579431"><div class="ttname"><a href="classRTC.html#a0f47b10b436e3f9d36e04ec907579431">RTC::readByte</a></div><div class="ttdeci">virtual uint8_t readByte(uint8_t offset)</div><div class="ttdoc">Reads the byte at offset within the realtime clock&#39;s non-volatile memory. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00247">RTC.cpp:247</a></div></div>
<div class="ttc" id="classRTC_html_adc29d7c43efc5a192d21965da5c3ee1d"><div class="ttname"><a href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d">RTC::adjustDays</a></div><div class="ttdeci">static void adjustDays(RTCDate *date, uint8_t flags)</div><div class="ttdoc">Adjusts date up or down one day according to flags. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00313">RTC.cpp:313</a></div></div>
<div class="ttc" id="structRTCTime_html"><div class="ttname"><a href="structRTCTime.html">RTCTime</a></div><div class="ttdoc">Stores time information from a realtime clock chip. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00028">RTC.h:28</a></div></div>
@@ -376,11 +376,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="structRTCTime_html_a87b7c02e535d808dcba04c77e34abb91"><div class="ttname"><a href="structRTCTime.html#a87b7c02e535d808dcba04c77e34abb91">RTCTime::second</a></div><div class="ttdeci">uint8_t second</div><div class="ttdoc">Second within the minute (0-59) </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00032">RTC.h:32</a></div></div>
<div class="ttc" id="classRTC_html_a3690761f29654a2c9e676fcbfa32dd30"><div class="ttname"><a href="classRTC.html#a3690761f29654a2c9e676fcbfa32dd30">RTC::hasUpdates</a></div><div class="ttdeci">virtual bool hasUpdates()</div><div class="ttdoc">Returns true if the realtime clock has updated since the last call to this function. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00134">RTC.cpp:134</a></div></div>
<div class="ttc" id="classRTC_html_aaf0a5c1f32f210a49718d148620b5bec"><div class="ttname"><a href="classRTC.html#aaf0a5c1f32f210a49718d148620b5bec">RTC::readTime</a></div><div class="ttdeci">virtual void readTime(RTCTime *value)</div><div class="ttdoc">Reads the current time from the realtime clock into value. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8cpp_source.html#l00144">RTC.cpp:144</a></div></div>
<div class="ttc" id="classRTC_html_a02ace2d775063be9a99035851c9274eb"><div class="ttname"><a href="classRTC.html#a02ace2d775063be9a99035851c9274eb">RTC::WRAP</a></div><div class="ttdeci">static const uint8_t WRAP</div><div class="ttdoc">Wrap around to the beginning of the current month/year rather than advance to the next one...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00090">RTC.h:90</a></div></div>
<div class="ttc" id="classRTC_html_a02ace2d775063be9a99035851c9274eb"><div class="ttname"><a href="classRTC.html#a02ace2d775063be9a99035851c9274eb">RTC::WRAP</a></div><div class="ttdeci">static const uint8_t WRAP</div><div class="ttdoc">Wrap around to the beginning of the current month/year rather than advance to the next one...</div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00093">RTC.h:93</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 25 2015 19:36:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Mar 29 2015 08:30:13 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>