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

10
DS1307RTC_8cpp_source.html
View File

@@ -384,19 +384,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classDS1307RTC_html_a7354aed91d7c94d0d7b2144b1bf32c75"><div class="ttname"><a href="classDS1307RTC.html#a7354aed91d7c94d0d7b2144b1bf32c75">DS1307RTC::writeAlarm</a></div><div class="ttdeci">void writeAlarm(uint8_t alarmNum, const RTCAlarm *value)</div><div class="ttdoc">Updates the details of the alarm with index alarmNum from value. </div><div class="ttdef"><b>Definition:</b> <a href="DS1307RTC_8cpp_source.html#l00250">DS1307RTC.cpp:250</a></div></div>
<div class="ttc" id="classI2CMaster_html_a0bf6b84cb1e2b3a37a4a0260d0b6f960"><div class="ttname"><a href="classI2CMaster.html#a0bf6b84cb1e2b3a37a4a0260d0b6f960">I2CMaster::write</a></div><div class="ttdeci">virtual void write(uint8_t value)=0</div><div class="ttdoc">Writes a single byte value on the I2C bus. </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="classDS1307RTC_html_a0a5d0d86a0345420ebb289ea724b19e8"><div class="ttname"><a href="classDS1307RTC.html#a0a5d0d86a0345420ebb289ea724b19e8">DS1307RTC::writeTime</a></div><div class="ttdeci">void writeTime(const RTCTime *value)</div><div class="ttdoc">Updates the time in the realtime clock to match value. </div><div class="ttdef"><b>Definition:</b> <a href="DS1307RTC_8cpp_source.html#l00202">DS1307RTC.cpp:202</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="classI2CMaster_html_a4e5f1a1a4c2242699be5a35fc4872fde"><div class="ttname"><a href="classI2CMaster.html#a4e5f1a1a4c2242699be5a35fc4872fde">I2CMaster::startRead</a></div><div class="ttdeci">virtual bool startRead(unsigned int address, unsigned int count)=0</div><div class="ttdoc">Starts a read operation for count bytes by sending the start condition and the I2C control byte...</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="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="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="classDS1307RTC_html_a6fb56d1690bc30e7995961a5b5e5fdc4"><div class="ttname"><a href="classDS1307RTC.html#a6fb56d1690bc30e7995961a5b5e5fdc4">DS1307RTC::readDate</a></div><div class="ttdeci">void readDate(RTCDate *value)</div><div class="ttdoc">Reads the current date from the realtime clock into value. </div><div class="ttdef"><b>Definition:</b> <a href="DS1307RTC_8cpp_source.html#l00177">DS1307RTC.cpp:177</a></div></div>
<div class="ttc" id="classI2CMaster_html_a01960fc821cb25e4c88c26d2c6107e35"><div class="ttname"><a href="classI2CMaster.html#a01960fc821cb25e4c88c26d2c6107e35">I2CMaster::startWrite</a></div><div class="ttdeci">virtual void startWrite(unsigned int address)</div><div class="ttdoc">Starts a write operation by sending a start condition and the I2C control byte. </div></div>
<div class="ttc" id="classI2CMaster_html_ab29f63551ddeb032a91505d1c0b8ac41"><div class="ttname"><a href="classI2CMaster.html#ab29f63551ddeb032a91505d1c0b8ac41">I2CMaster::endWrite</a></div><div class="ttdeci">virtual bool endWrite()=0</div><div class="ttdoc">Ends the current write operation. </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_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="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="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_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="structRTCTime_html"><div class="ttname"><a href="structRTCTime.html">RTCTime</a></div><div class="ttdoc">Stores time information from a realtime clock chip. </div><div class="ttdef"><b>Definition:</b> <a href="RTC_8h_source.html#l00028">RTC.h:28</a></div></div>
<div class="ttc" id="classI2CMaster_html"><div class="ttname"><a href="classI2CMaster.html">I2CMaster</a></div><div class="ttdoc">Abstract base class for I2C master implementations. </div><div class="ttdef"><b>Definition:</b> <a href="I2CMaster_8h_source.html#l00028">I2CMaster.h:28</a></div></div>
@@ -415,7 +415,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</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>