functions_func.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>RTClib: Class Members - Functions</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">RTClib
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. </div><!-- top -->
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div class="contents">
  59. &#160;
  60. <h3><a id="index_a"></a>- a -</h3><ul>
  61. <li>adjust()
  62. : <a class="el" href="class_r_t_c___d_s1307.html#a6e38778b577a80008e9dc630384b8520">RTC_DS1307</a>
  63. , <a class="el" href="class_r_t_c___d_s3231.html#ae8d2a40c8ada023f5ab502a77631abb0">RTC_DS3231</a>
  64. , <a class="el" href="class_r_t_c___micros.html#aea8ab863c103875e38a240a560531b7a">RTC_Micros</a>
  65. , <a class="el" href="class_r_t_c___millis.html#adcf4a13317d9b785ae79613b3429a46a">RTC_Millis</a>
  66. , <a class="el" href="class_r_t_c___p_c_f8523.html#a58c717aba56f84fd4be51cdcf88fb470">RTC_PCF8523</a>
  67. , <a class="el" href="class_r_t_c___p_c_f8563.html#a131456dcfbc1cb18a1545d374cebf763">RTC_PCF8563</a>
  68. </li>
  69. <li>adjustDrift()
  70. : <a class="el" href="class_r_t_c___micros.html#a9e5c1b798e0e61058c86adb74e41b6b4">RTC_Micros</a>
  71. </li>
  72. <li>alarmFired()
  73. : <a class="el" href="class_r_t_c___d_s3231.html#a5d9b443a5c3cd574a30e22f3c5f272a1">RTC_DS3231</a>
  74. </li>
  75. </ul>
  76. <h3><a id="index_b"></a>- b -</h3><ul>
  77. <li>bcd2bin()
  78. : <a class="el" href="class_r_t_c___i2_c.html#a2078785506b49f0068c56a68d8eeda86">RTC_I2C</a>
  79. </li>
  80. <li>begin()
  81. : <a class="el" href="class_r_t_c___d_s1307.html#a13fcf2feee9d9c713f6def2745ccf48b">RTC_DS1307</a>
  82. , <a class="el" href="class_r_t_c___d_s3231.html#a7032c834738d0325f756ee149da938da">RTC_DS3231</a>
  83. , <a class="el" href="class_r_t_c___micros.html#a116c9cab0b87b2ca0a5d7284a26af320">RTC_Micros</a>
  84. , <a class="el" href="class_r_t_c___millis.html#a17670c5fcf820867a8018aa2083c62cd">RTC_Millis</a>
  85. , <a class="el" href="class_r_t_c___p_c_f8523.html#a60d24ea1b22de7e52bcdf6478a1f74b4">RTC_PCF8523</a>
  86. , <a class="el" href="class_r_t_c___p_c_f8563.html#ad28016b2aae5bd67471c50dbb64d7b81">RTC_PCF8563</a>
  87. </li>
  88. <li>bin2bcd()
  89. : <a class="el" href="class_r_t_c___i2_c.html#ab32804cf459d409d7aea2c0a307b1fc4">RTC_I2C</a>
  90. </li>
  91. </ul>
  92. <h3><a id="index_c"></a>- c -</h3><ul>
  93. <li>calibrate()
  94. : <a class="el" href="class_r_t_c___p_c_f8523.html#a33e8ae8a0e1ab3e11c4d0dc07c45d1a1">RTC_PCF8523</a>
  95. </li>
  96. <li>clearAlarm()
  97. : <a class="el" href="class_r_t_c___d_s3231.html#aa8050b94c8333d72b31fd223eeb50911">RTC_DS3231</a>
  98. </li>
  99. </ul>
  100. <h3><a id="index_d"></a>- d -</h3><ul>
  101. <li>DateTime()
  102. : <a class="el" href="class_date_time.html#af221f098098c80edfcd71fbc256f457a">DateTime</a>
  103. </li>
  104. <li>day()
  105. : <a class="el" href="class_date_time.html#a6e653eaef31e4956ee9bf67b4874a9a8">DateTime</a>
  106. </li>
  107. <li>dayOfTheWeek()
  108. : <a class="el" href="class_date_time.html#a958229f0d6a46d092658028d25a9e65c">DateTime</a>
  109. </li>
  110. <li>days()
  111. : <a class="el" href="class_time_span.html#a50f71a2e56d605b32b19ca86cce15d39">TimeSpan</a>
  112. </li>
  113. <li>deconfigureAllTimers()
  114. : <a class="el" href="class_r_t_c___p_c_f8523.html#a7ef4eb0f08c838b2ca645d35dab79e78">RTC_PCF8523</a>
  115. </li>
  116. <li>disable32K()
  117. : <a class="el" href="class_r_t_c___d_s3231.html#a68799885fdc7b5b9958b579376eb23a7">RTC_DS3231</a>
  118. </li>
  119. <li>disableAlarm()
  120. : <a class="el" href="class_r_t_c___d_s3231.html#a9f5191fed61fd8a4716572d43f300a5a">RTC_DS3231</a>
  121. </li>
  122. <li>disableCountdownTimer()
  123. : <a class="el" href="class_r_t_c___p_c_f8523.html#a8f25e43db2c61ed164d4520c2a1a563b">RTC_PCF8523</a>
  124. </li>
  125. <li>disableSecondTimer()
  126. : <a class="el" href="class_r_t_c___p_c_f8523.html#a6101663e87ffc018721c0a9a12107550">RTC_PCF8523</a>
  127. </li>
  128. <li>dowToDS3231()
  129. : <a class="el" href="class_r_t_c___d_s3231.html#a9026a1086c2874301690b5c6a2713644">RTC_DS3231</a>
  130. </li>
  131. </ul>
  132. <h3><a id="index_e"></a>- e -</h3><ul>
  133. <li>enable32K()
  134. : <a class="el" href="class_r_t_c___d_s3231.html#ab20d003e8bb8714c48cb3d06fdd7cecc">RTC_DS3231</a>
  135. </li>
  136. <li>enableCountdownTimer()
  137. : <a class="el" href="class_r_t_c___p_c_f8523.html#a54045d4b13deaa90aa7075c735a93634">RTC_PCF8523</a>
  138. </li>
  139. <li>enableSecondTimer()
  140. : <a class="el" href="class_r_t_c___p_c_f8523.html#aebd5623666c6809e747570fe4c36a4f3">RTC_PCF8523</a>
  141. </li>
  142. </ul>
  143. <h3><a id="index_g"></a>- g -</h3><ul>
  144. <li>getAlarm1()
  145. : <a class="el" href="class_r_t_c___d_s3231.html#aa8079cc5cedf5ad3178fd8f6b0f2c25c">RTC_DS3231</a>
  146. </li>
  147. <li>getAlarm1Mode()
  148. : <a class="el" href="class_r_t_c___d_s3231.html#af22bd04a5b78398f35c11207f9fc266b">RTC_DS3231</a>
  149. </li>
  150. <li>getAlarm2()
  151. : <a class="el" href="class_r_t_c___d_s3231.html#aa7075b5983e9f61175d1335d9796b272">RTC_DS3231</a>
  152. </li>
  153. <li>getAlarm2Mode()
  154. : <a class="el" href="class_r_t_c___d_s3231.html#a74aaeb9b1b27cc07b0828f20f7a56b4c">RTC_DS3231</a>
  155. </li>
  156. <li>getTemperature()
  157. : <a class="el" href="class_r_t_c___d_s3231.html#a6eb180c4c14a22322a9ea3e58b51798b">RTC_DS3231</a>
  158. </li>
  159. </ul>
  160. <h3><a id="index_h"></a>- h -</h3><ul>
  161. <li>hour()
  162. : <a class="el" href="class_date_time.html#ac17441fb0c669bcf3be5de278335e8d0">DateTime</a>
  163. </li>
  164. <li>hours()
  165. : <a class="el" href="class_time_span.html#a3033fb6ede5ac2ece3c9753901a4abf5">TimeSpan</a>
  166. </li>
  167. </ul>
  168. <h3><a id="index_i"></a>- i -</h3><ul>
  169. <li>initialized()
  170. : <a class="el" href="class_r_t_c___p_c_f8523.html#a739c2c1d770f661da06ee7afe5886d62">RTC_PCF8523</a>
  171. </li>
  172. <li>isEnabled32K()
  173. : <a class="el" href="class_r_t_c___d_s3231.html#ada935a4541328b627b4dbba95fa133c8">RTC_DS3231</a>
  174. </li>
  175. <li>isPM()
  176. : <a class="el" href="class_date_time.html#a0c11137c3e56e1b7cc7a6dccee755b8e">DateTime</a>
  177. </li>
  178. <li>isrunning()
  179. : <a class="el" href="class_r_t_c___d_s1307.html#a0ec6f600f705edfef43bd798dce9946f">RTC_DS1307</a>
  180. , <a class="el" href="class_r_t_c___p_c_f8523.html#a0dfb7557baf6f32a49fc71f45b19095c">RTC_PCF8523</a>
  181. , <a class="el" href="class_r_t_c___p_c_f8563.html#a0b12f578c46fdcca20df2340a7039c6f">RTC_PCF8563</a>
  182. </li>
  183. <li>isValid()
  184. : <a class="el" href="class_date_time.html#a21b2a59fbde555e5c5688d44e9d95aec">DateTime</a>
  185. </li>
  186. </ul>
  187. <h3><a id="index_l"></a>- l -</h3><ul>
  188. <li>lostPower()
  189. : <a class="el" href="class_r_t_c___d_s3231.html#a097dc15a79ec077073969432b1abcb88">RTC_DS3231</a>
  190. , <a class="el" href="class_r_t_c___p_c_f8523.html#a28845cecdab25b0e5620c37a610cae84">RTC_PCF8523</a>
  191. , <a class="el" href="class_r_t_c___p_c_f8563.html#ae264d5b935bd313b8ad4be8c319080c3">RTC_PCF8563</a>
  192. </li>
  193. </ul>
  194. <h3><a id="index_m"></a>- m -</h3><ul>
  195. <li>minute()
  196. : <a class="el" href="class_date_time.html#a8dac4d21cf40f1b6f1ec5973024709ed">DateTime</a>
  197. </li>
  198. <li>minutes()
  199. : <a class="el" href="class_time_span.html#ac6590f801d688a3fffff68df6707ed0b">TimeSpan</a>
  200. </li>
  201. <li>month()
  202. : <a class="el" href="class_date_time.html#a10d35aa20ebb179cdb4b61f90dfcfe74">DateTime</a>
  203. </li>
  204. </ul>
  205. <h3><a id="index_n"></a>- n -</h3><ul>
  206. <li>now()
  207. : <a class="el" href="class_r_t_c___d_s1307.html#a9f5f5dbcce65b67e00b50808a45a4249">RTC_DS1307</a>
  208. , <a class="el" href="class_r_t_c___d_s3231.html#adc740b28876022b852e0f33842632fab">RTC_DS3231</a>
  209. , <a class="el" href="class_r_t_c___micros.html#a1fc42a118907796cc95af60ab243c5bd">RTC_Micros</a>
  210. , <a class="el" href="class_r_t_c___millis.html#aac263a7087f8603199eb45cdc7c3c146">RTC_Millis</a>
  211. , <a class="el" href="class_r_t_c___p_c_f8523.html#a5c61a02e752fd1f49fe17ed44f0506f9">RTC_PCF8523</a>
  212. , <a class="el" href="class_r_t_c___p_c_f8563.html#a8a7c93ea2705e8fb2f928474b6f80f12">RTC_PCF8563</a>
  213. </li>
  214. </ul>
  215. <h3><a id="index_o"></a>- o -</h3><ul>
  216. <li>operator!=()
  217. : <a class="el" href="class_date_time.html#aa64131ebd35cb40ed616b111ea501760">DateTime</a>
  218. </li>
  219. <li>operator+()
  220. : <a class="el" href="class_date_time.html#a8d6b85fa26106369e81da7b824e78936">DateTime</a>
  221. , <a class="el" href="class_time_span.html#a5121884a13304ebf2b4346e90e205938">TimeSpan</a>
  222. </li>
  223. <li>operator-()
  224. : <a class="el" href="class_date_time.html#aef3bee1f4e9de8d79426f35db1e0dbe4">DateTime</a>
  225. , <a class="el" href="class_time_span.html#ae276db5e4710b105f5aa5b8c3710d5f1">TimeSpan</a>
  226. </li>
  227. <li>operator&lt;()
  228. : <a class="el" href="class_date_time.html#a6f1288d0205e97f86dfecfc7fd7b4e60">DateTime</a>
  229. </li>
  230. <li>operator&lt;=()
  231. : <a class="el" href="class_date_time.html#af9da2ce38916caa365f24a38f5834b47">DateTime</a>
  232. </li>
  233. <li>operator==()
  234. : <a class="el" href="class_date_time.html#a0c68b136471b6f8daf575ce399ca619c">DateTime</a>
  235. </li>
  236. <li>operator&gt;()
  237. : <a class="el" href="class_date_time.html#a0cbf838febb24c433bd517cbb75a3e8c">DateTime</a>
  238. </li>
  239. <li>operator&gt;=()
  240. : <a class="el" href="class_date_time.html#a380536b7398afa1f7dcff9df9054fcbb">DateTime</a>
  241. </li>
  242. </ul>
  243. <h3><a id="index_r"></a>- r -</h3><ul>
  244. <li>read_register()
  245. : <a class="el" href="class_r_t_c___i2_c.html#ad42493d5be1090c8cfb882a498fe350a">RTC_I2C</a>
  246. </li>
  247. <li>readnvram()
  248. : <a class="el" href="class_r_t_c___d_s1307.html#a8f4a3e283213c783130cc65e17903ec2">RTC_DS1307</a>
  249. </li>
  250. <li>readSqwPinMode()
  251. : <a class="el" href="class_r_t_c___d_s1307.html#ac2aee07ab819353d18f94a01a7a40da2">RTC_DS1307</a>
  252. , <a class="el" href="class_r_t_c___d_s3231.html#a461204c0b4dec27b6a1e9ffedc148940">RTC_DS3231</a>
  253. , <a class="el" href="class_r_t_c___p_c_f8523.html#ae8d6c49c65fa7b509f76380a33b282ca">RTC_PCF8523</a>
  254. , <a class="el" href="class_r_t_c___p_c_f8563.html#a6c143e43e399a1b95f6ff19cbd96d155">RTC_PCF8563</a>
  255. </li>
  256. </ul>
  257. <h3><a id="index_s"></a>- s -</h3><ul>
  258. <li>second()
  259. : <a class="el" href="class_date_time.html#adacdb3c0984bc73c2b48e5d1995a6c01">DateTime</a>
  260. </li>
  261. <li>seconds()
  262. : <a class="el" href="class_time_span.html#ad1860591ff7f8c021c6bbadcc6d9ec02">TimeSpan</a>
  263. </li>
  264. <li>secondstime()
  265. : <a class="el" href="class_date_time.html#a15a271a5c566550e3feae2b9624430f0">DateTime</a>
  266. </li>
  267. <li>setAlarm1()
  268. : <a class="el" href="class_r_t_c___d_s3231.html#ad12211e56637221b0c6b956bfe764404">RTC_DS3231</a>
  269. </li>
  270. <li>setAlarm2()
  271. : <a class="el" href="class_r_t_c___d_s3231.html#a686299444985b8c36d12a7ce32c9add6">RTC_DS3231</a>
  272. </li>
  273. <li>start()
  274. : <a class="el" href="class_r_t_c___p_c_f8523.html#ab2c5977b18ef47b58dbba32b1f507ea4">RTC_PCF8523</a>
  275. , <a class="el" href="class_r_t_c___p_c_f8563.html#aa5c41f5e112b239a9ae4cef449caac06">RTC_PCF8563</a>
  276. </li>
  277. <li>stop()
  278. : <a class="el" href="class_r_t_c___p_c_f8523.html#ab1783d2501ea0d88792f50abbc5e450f">RTC_PCF8523</a>
  279. , <a class="el" href="class_r_t_c___p_c_f8563.html#a75ed83eb83c0eba2e09b20f356c7df90">RTC_PCF8563</a>
  280. </li>
  281. </ul>
  282. <h3><a id="index_t"></a>- t -</h3><ul>
  283. <li>TimeSpan()
  284. : <a class="el" href="class_time_span.html#af6f4ccd4c1789c174914f1d462de74f4">TimeSpan</a>
  285. </li>
  286. <li>timestamp()
  287. : <a class="el" href="class_date_time.html#ab13d6eeee16d78b845f6eed5764951e3">DateTime</a>
  288. </li>
  289. <li>toString()
  290. : <a class="el" href="class_date_time.html#a27aad4b627b20de84c23d2b0ed657cba">DateTime</a>
  291. </li>
  292. <li>totalseconds()
  293. : <a class="el" href="class_time_span.html#acf4206e0878c620da06035ac1684dd87">TimeSpan</a>
  294. </li>
  295. <li>twelveHour()
  296. : <a class="el" href="class_date_time.html#a5738404586a60d787aaaa4735913e9c7">DateTime</a>
  297. </li>
  298. </ul>
  299. <h3><a id="index_u"></a>- u -</h3><ul>
  300. <li>unixtime()
  301. : <a class="el" href="class_date_time.html#ae4629e7b2ffeac4a0c8f8c3f9c545990">DateTime</a>
  302. </li>
  303. </ul>
  304. <h3><a id="index_w"></a>- w -</h3><ul>
  305. <li>write_register()
  306. : <a class="el" href="class_r_t_c___i2_c.html#a6ae48628766373ce608c61a71fcbdd3d">RTC_I2C</a>
  307. </li>
  308. <li>writenvram()
  309. : <a class="el" href="class_r_t_c___d_s1307.html#ac60cf11ebb0a4dc1fe6097787caecd75">RTC_DS1307</a>
  310. </li>
  311. <li>writeSqwPinMode()
  312. : <a class="el" href="class_r_t_c___d_s1307.html#a0d0871447dc3464dc8dc127433a14691">RTC_DS1307</a>
  313. , <a class="el" href="class_r_t_c___d_s3231.html#a7dd635277072b79d51d830a72dae1f72">RTC_DS3231</a>
  314. , <a class="el" href="class_r_t_c___p_c_f8523.html#afac1866e69541cfb93251dee683f0e63">RTC_PCF8523</a>
  315. , <a class="el" href="class_r_t_c___p_c_f8563.html#aa69b313f7836d709a52ca013a4545c97">RTC_PCF8563</a>
  316. </li>
  317. </ul>
  318. <h3><a id="index_y"></a>- y -</h3><ul>
  319. <li>year()
  320. : <a class="el" href="class_date_time.html#a04bc8f3d3452bf8fcc5f1e82d86d7fe8">DateTime</a>
  321. </li>
  322. </ul>
  323. </div><!-- contents -->
  324. <!-- start footer part -->
  325. <hr class="footer"/><address class="footer"><small>
  326. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  327. <img class="footer" src="doxygen.png" alt="doxygen"/>
  328. </a> 1.8.13
  329. </small></address>
  330. </body>
  331. </html>