Michel2/RTClib
1
0
Fork 0
mirror of https://github.com/adafruit/RTClib.git synced 2026-07-28 04:05:31 +00:00
Code Issues Releases Activity

Deploy code docs to GitHub Pages Travis build:

Browse Source 
Commit:
This commit is contained in:
Doxygen CI
2020-07-15 17:17:01 +00:00
parent 974b657e0e
commit c6c054c49f
9 changed files with 68 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
html/_r_t_clib_8h_source.html
+7 -7
View File
File diff suppressed because one or more lines are too long
html/class_r_t_c___p_c_f8523-members.html
+7 -4
View File
@@ -75,10 +75,13 @@ $(function() {
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#ac6f20e1ea2efc9c4b76e8d49534fa229">enableCountdownTimer</a>(PCF8523TimerClockFreq clkFreq, uint8_t numPeriods)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#aebd5623666c6809e747570fe4c36a4f3">enableSecondTimer</a>(void)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#aa2f261383ef95f88108405f5d7ae4e2f">initialized</a>(void)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#a47962a5ca20578497496df2ee979ca43">lostPower</a>(void)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#a5c61a02e752fd1f49fe17ed44f0506f9">now</a>()</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#ae8d6c49c65fa7b509f76380a33b282ca">readSqwPinMode</a>()</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#afac1866e69541cfb93251dee683f0e63">writeSqwPinMode</a>(Pcf8523SqwPinMode mode)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c">isrunning</a>()</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#a47962a5ca20578497496df2ee979ca43">lostPower</a>(void)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#a5c61a02e752fd1f49fe17ed44f0506f9">now</a>()</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#ae8d6c49c65fa7b509f76380a33b282ca">readSqwPinMode</a>()</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4">start</a>(void)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f">stop</a>(void)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html#afac1866e69541cfb93251dee683f0e63">writeSqwPinMode</a>(Pcf8523SqwPinMode mode)</td><td class="entry"><a class="el" href="class_r_t_c___p_c_f8523.html">RTC_PCF8523</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
html/class_r_t_c___p_c_f8523.html
+32
View File
@@ -86,6 +86,17 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:aa2f261383ef95f88108405f5d7ae4e2f"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c___p_c_f8523.html#aa2f261383ef95f88108405f5d7ae4e2f">initialized</a> (void)</td></tr>
<tr class="memdesc:aa2f261383ef95f88108405f5d7ae4e2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check control register 3 to see if we've run <a class="el" href="class_r_t_c___p_c_f8523.html#a58c717aba56f84fd4be51cdcf88fb470" title="Set the date and time, set battery switchover mode. ">adjust()</a> yet (setting the date/time and battery switchover mode) <a href="#aa2f261383ef95f88108405f5d7ae4e2f">More...</a><br /></td></tr>
<tr class="separator:aa2f261383ef95f88108405f5d7ae4e2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2c5977b18ef47b58dbba32b1f507ea4"><td class="memItemLeft" align="right" valign="top"><a id="ab2c5977b18ef47b58dbba32b1f507ea4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4">start</a> (void)</td></tr>
<tr class="memdesc:ab2c5977b18ef47b58dbba32b1f507ea4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the STOP bit in register Control_1. <br /></td></tr>
<tr class="separator:ab2c5977b18ef47b58dbba32b1f507ea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1783d2501ea0d88792f50abbc5e450f"><td class="memItemLeft" align="right" valign="top"><a id="ab1783d2501ea0d88792f50abbc5e450f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f">stop</a> (void)</td></tr>
<tr class="memdesc:ab1783d2501ea0d88792f50abbc5e450f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the STOP bit in register Control_1. <br /></td></tr>
<tr class="separator:ab1783d2501ea0d88792f50abbc5e450f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dfb7557baf6f32a49fc71f45b19095c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c">isrunning</a> ()</td></tr>
<tr class="memdesc:a0dfb7557baf6f32a49fc71f45b19095c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the PCF8523 running? Check the STOP bit in register Control_1. <a href="#a0dfb7557baf6f32a49fc71f45b19095c">More...</a><br /></td></tr>
<tr class="separator:a0dfb7557baf6f32a49fc71f45b19095c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8d6c49c65fa7b509f76380a33b282ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_r_t_clib_8h.html#ab06ba706f2d9f1e59b1ce1fe3048c54c">Pcf8523SqwPinMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c___p_c_f8523.html#ae8d6c49c65fa7b509f76380a33b282ca">readSqwPinMode</a> ()</td></tr>
<tr class="memdesc:ae8d6c49c65fa7b509f76380a33b282ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the mode of the INT/SQW pin on the PCF8523. <a href="#ae8d6c49c65fa7b509f76380a33b282ca">More...</a><br /></td></tr>
<tr class="separator:ae8d6c49c65fa7b509f76380a33b282ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -239,6 +250,27 @@ Static Public Member Functions</h2></td></tr>
<p>Get the current date/time. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_date_time.html" title="Simple general-purpose date/time class (no TZ / DST / leap seconds). ">DateTime</a> object containing the current date/time </dd></dl>
</div>
</div>
<a id="a0dfb7557baf6f32a49fc71f45b19095c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dfb7557baf6f32a49fc71f45b19095c">&#9670;&nbsp;</a></span>isrunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t RTC_PCF8523::isrunning </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Is the PCF8523 running? Check the STOP bit in register Control_1. </p>
<dl class="section return"><dt>Returns</dt><dd>1 if the RTC is running, 0 if not </dd></dl>
</div>
</div>
<a id="ae8d6c49c65fa7b509f76380a33b282ca"></a>
html/functions.html
+7
View File
@@ -184,6 +184,7 @@ $(function() {
</li>
<li>isrunning()
: <a class="el" href="class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f">RTC_DS1307</a>
, <a class="el" href="class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c">RTC_PCF8523</a>
</li>
<li>isValid()
: <a class="el" href="class_date_time.html#a21b2a59fbde555e5c5688d44e9d95aec">DateTime</a>
@@ -303,6 +304,12 @@ $(function() {
<li>ss
: <a class="el" href="class_date_time.html#a38da3481e6355fcf8ceb4c57eb9db0ce">DateTime</a>
</li>
<li>start()
: <a class="el" href="class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4">RTC_PCF8523</a>
</li>
<li>stop()
: <a class="el" href="class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f">RTC_PCF8523</a>
</li>
</ul>
html/functions_func.html
+7
View File
@@ -171,6 +171,7 @@ $(function() {
</li>
<li>isrunning()
: <a class="el" href="class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f">RTC_DS1307</a>
, <a class="el" href="class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c">RTC_PCF8523</a>
</li>
<li>isValid()
: <a class="el" href="class_date_time.html#a21b2a59fbde555e5c5688d44e9d95aec">DateTime</a>
@@ -268,6 +269,12 @@ $(function() {
<li>setAlarm2()
: <a class="el" href="class_r_t_c___d_s3231.html#a686299444985b8c36d12a7ce32c9add6">RTC_DS3231</a>
</li>
<li>start()
: <a class="el" href="class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4">RTC_PCF8523</a>
</li>
<li>stop()
: <a class="el" href="class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f">RTC_PCF8523</a>
</li>
</ul>
html/search/all_8.js
+1 -1
View File
@@ -3,6 +3,6 @@ var searchData=
['initialized',['initialized',['../class_r_t_c___p_c_f8523.html#aa2f261383ef95f88108405f5d7ae4e2f',1,'RTC_PCF8523']]],
['isenabled32k',['isEnabled32K',['../class_r_t_c___d_s3231.html#ada935a4541328b627b4dbba95fa133c8',1,'RTC_DS3231']]],
['ispm',['isPM',['../class_date_time.html#a0c11137c3e56e1b7cc7a6dccee755b8e',1,'DateTime']]],
['isrunning',['isrunning',['../class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f',1,'RTC_DS1307']]],
['isrunning',['isrunning',['../class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f',1,'RTC_DS1307::isrunning()'],['../class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c',1,'RTC_PCF8523::isrunning()']]],
['isvalid',['isValid',['../class_date_time.html#a21b2a59fbde555e5c5688d44e9d95aec',1,'DateTime']]]
];
html/search/all_f.js
+3 -1
View File
@@ -7,5 +7,7 @@ var searchData=
['secondstime',['secondstime',['../class_date_time.html#a15a271a5c566550e3feae2b9624430f0',1,'DateTime']]],
['setalarm1',['setAlarm1',['../class_r_t_c___d_s3231.html#ad12211e56637221b0c6b956bfe764404',1,'RTC_DS3231']]],
['setalarm2',['setAlarm2',['../class_r_t_c___d_s3231.html#a686299444985b8c36d12a7ce32c9add6',1,'RTC_DS3231']]],
['ss',['ss',['../class_date_time.html#a38da3481e6355fcf8ceb4c57eb9db0ce',1,'DateTime']]]
['ss',['ss',['../class_date_time.html#a38da3481e6355fcf8ceb4c57eb9db0ce',1,'DateTime']]],
['start',['start',['../class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4',1,'RTC_PCF8523']]],
['stop',['stop',['../class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f',1,'RTC_PCF8523']]]
];
html/search/functions_7.js
+1 -1
View File
@@ -3,6 +3,6 @@ var searchData=
['initialized',['initialized',['../class_r_t_c___p_c_f8523.html#aa2f261383ef95f88108405f5d7ae4e2f',1,'RTC_PCF8523']]],
['isenabled32k',['isEnabled32K',['../class_r_t_c___d_s3231.html#ada935a4541328b627b4dbba95fa133c8',1,'RTC_DS3231']]],
['ispm',['isPM',['../class_date_time.html#a0c11137c3e56e1b7cc7a6dccee755b8e',1,'DateTime']]],
['isrunning',['isrunning',['../class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f',1,'RTC_DS1307']]],
['isrunning',['isrunning',['../class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f',1,'RTC_DS1307::isrunning()'],['../class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c',1,'RTC_PCF8523::isrunning()']]],
['isvalid',['isValid',['../class_date_time.html#a21b2a59fbde555e5c5688d44e9d95aec',1,'DateTime']]]
];
html/search/functions_d.js
+3 -1
View File
@@ -4,5 +4,7 @@ var searchData=
['seconds',['seconds',['../class_time_span.html#ad1860591ff7f8c021c6bbadcc6d9ec02',1,'TimeSpan']]],
['secondstime',['secondstime',['../class_date_time.html#a15a271a5c566550e3feae2b9624430f0',1,'DateTime']]],
['setalarm1',['setAlarm1',['../class_r_t_c___d_s3231.html#ad12211e56637221b0c6b956bfe764404',1,'RTC_DS3231']]],
['setalarm2',['setAlarm2',['../class_r_t_c___d_s3231.html#a686299444985b8c36d12a7ce32c9add6',1,'RTC_DS3231']]]
['setalarm2',['setAlarm2',['../class_r_t_c___d_s3231.html#a686299444985b8c36d12a7ce32c9add6',1,'RTC_DS3231']]],
['start',['start',['../class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4',1,'RTC_PCF8523']]],
['stop',['stop',['../class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f',1,'RTC_PCF8523']]]
];