mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
759 lines
54 KiB
HTML
759 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>ArduinoLibs: DS3232RTC Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classDS3232RTC-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DS3232RTC Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Communicates with a DS3232 realtime clock chip via I2C.
|
|
<a href="classDS3232RTC.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="DS3232RTC_8h_source.html">DS3232RTC.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for DS3232RTC:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classDS3232RTC.png" usemap="#DS3232RTC_map" alt=""/>
|
|
<map id="DS3232RTC_map" name="DS3232RTC_map">
|
|
<area href="classRTC.html" title="Base class for realtime clock handlers. " alt="RTC" shape="rect" coords="0,0,81,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa959454ae01b11c48d6ec7ec192b4ccb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#aa959454ae01b11c48d6ec7ec192b4ccb">DS3232RTC</a> (<a class="el" href="classI2CMaster.html">I2CMaster</a> &bus, uint8_t oneHzPin=255)</td></tr>
|
|
<tr class="memdesc:aa959454ae01b11c48d6ec7ec192b4ccb"><td class="mdescLeft"> </td><td class="mdescRight">Attaches to a realtime clock slave device on <em>bus</em>. <a href="#aa959454ae01b11c48d6ec7ec192b4ccb">More...</a><br/></td></tr>
|
|
<tr class="separator:aa959454ae01b11c48d6ec7ec192b4ccb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc5908a3743afb4c26bd75e22cad87a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc5908a3743afb4c26bd75e22cad87a4"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#acc5908a3743afb4c26bd75e22cad87a4">isRealTime</a> () const </td></tr>
|
|
<tr class="memdesc:acc5908a3743afb4c26bd75e22cad87a4"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the realtime clock is on the I2C bus; false if the time and date are simulated. <br/></td></tr>
|
|
<tr class="separator:acc5908a3743afb4c26bd75e22cad87a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a619ffee1bc013c9ddf4ae415115798bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc">hasUpdates</a> ()</td></tr>
|
|
<tr class="memdesc:a619ffee1bc013c9ddf4ae415115798bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the realtime clock has updated since the last call to this function. <a href="#a619ffee1bc013c9ddf4ae415115798bc">More...</a><br/></td></tr>
|
|
<tr class="separator:a619ffee1bc013c9ddf4ae415115798bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af89e68c68f1c4b7e94286f800b5b2747"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747">readTime</a> (<a class="el" href="structRTCTime.html">RTCTime</a> *value)</td></tr>
|
|
<tr class="memdesc:af89e68c68f1c4b7e94286f800b5b2747"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current time from the realtime clock into <em>value</em>. <a href="#af89e68c68f1c4b7e94286f800b5b2747">More...</a><br/></td></tr>
|
|
<tr class="separator:af89e68c68f1c4b7e94286f800b5b2747"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab03358e3b5996e38d766e2f9f6ab62ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#ab03358e3b5996e38d766e2f9f6ab62ca">readDate</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *value)</td></tr>
|
|
<tr class="memdesc:ab03358e3b5996e38d766e2f9f6ab62ca"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current date from the realtime clock into <em>value</em>. <a href="#ab03358e3b5996e38d766e2f9f6ab62ca">More...</a><br/></td></tr>
|
|
<tr class="separator:ab03358e3b5996e38d766e2f9f6ab62ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0ca13a8b80da856b37fc53b84e27c78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#ab0ca13a8b80da856b37fc53b84e27c78">writeTime</a> (const <a class="el" href="structRTCTime.html">RTCTime</a> *value)</td></tr>
|
|
<tr class="memdesc:ab0ca13a8b80da856b37fc53b84e27c78"><td class="mdescLeft"> </td><td class="mdescRight">Updates the time in the realtime clock to match <em>value</em>. <a href="#ab0ca13a8b80da856b37fc53b84e27c78">More...</a><br/></td></tr>
|
|
<tr class="separator:ab0ca13a8b80da856b37fc53b84e27c78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31c004a90c724979d8267c31f2dbf5ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a31c004a90c724979d8267c31f2dbf5ed">writeDate</a> (const <a class="el" href="structRTCDate.html">RTCDate</a> *value)</td></tr>
|
|
<tr class="memdesc:a31c004a90c724979d8267c31f2dbf5ed"><td class="mdescLeft"> </td><td class="mdescRight">Updates the date in the realtime clock to match <em>value</em>. <a href="#a31c004a90c724979d8267c31f2dbf5ed">More...</a><br/></td></tr>
|
|
<tr class="separator:a31c004a90c724979d8267c31f2dbf5ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09c7073c687dcbbc423baf48074c7873"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a09c7073c687dcbbc423baf48074c7873">readAlarm</a> (uint8_t alarmNum, <a class="el" href="structRTCAlarm.html">RTCAlarm</a> *value)</td></tr>
|
|
<tr class="memdesc:a09c7073c687dcbbc423baf48074c7873"><td class="mdescLeft"> </td><td class="mdescRight">Reads the details of the alarm with index <em>alarmNum</em> into <em>value</em>. <a href="#a09c7073c687dcbbc423baf48074c7873">More...</a><br/></td></tr>
|
|
<tr class="separator:a09c7073c687dcbbc423baf48074c7873"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b0a65e0ac479aec8fad6ca3147dbe75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a8b0a65e0ac479aec8fad6ca3147dbe75">writeAlarm</a> (uint8_t alarmNum, const <a class="el" href="structRTCAlarm.html">RTCAlarm</a> *value)</td></tr>
|
|
<tr class="memdesc:a8b0a65e0ac479aec8fad6ca3147dbe75"><td class="mdescLeft"> </td><td class="mdescRight">Updates the details of the alarm with index <em>alarmNum</em> from <em>value</em>. <a href="#a8b0a65e0ac479aec8fad6ca3147dbe75">More...</a><br/></td></tr>
|
|
<tr class="separator:a8b0a65e0ac479aec8fad6ca3147dbe75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1319fe936dcb7e9d6bdf200b77a94f8e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e">byteCount</a> () const </td></tr>
|
|
<tr class="memdesc:a1319fe936dcb7e9d6bdf200b77a94f8e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings, excluding storage used by alarms. <a href="#a1319fe936dcb7e9d6bdf200b77a94f8e">More...</a><br/></td></tr>
|
|
<tr class="separator:a1319fe936dcb7e9d6bdf200b77a94f8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ba83a3ef7d65d45c2f3241afdd8fef7"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a5ba83a3ef7d65d45c2f3241afdd8fef7">readByte</a> (uint8_t offset)</td></tr>
|
|
<tr class="memdesc:a5ba83a3ef7d65d45c2f3241afdd8fef7"><td class="mdescLeft"> </td><td class="mdescRight">Reads the byte at <em>offset</em> within the realtime clock's non-volatile memory. <a href="#a5ba83a3ef7d65d45c2f3241afdd8fef7">More...</a><br/></td></tr>
|
|
<tr class="separator:a5ba83a3ef7d65d45c2f3241afdd8fef7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9acebf12c5cecdd6d84e0ff9ed41765a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a9acebf12c5cecdd6d84e0ff9ed41765a">writeByte</a> (uint8_t offset, uint8_t value)</td></tr>
|
|
<tr class="memdesc:a9acebf12c5cecdd6d84e0ff9ed41765a"><td class="mdescLeft"> </td><td class="mdescRight">Writes <em>value</em> to <em>offset</em> within the realtime clock's non-volatile memory. <a href="#a9acebf12c5cecdd6d84e0ff9ed41765a">More...</a><br/></td></tr>
|
|
<tr class="separator:a9acebf12c5cecdd6d84e0ff9ed41765a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0faf40c25ab019a326a60f301c2bb41b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a0faf40c25ab019a326a60f301c2bb41b">readTemperature</a> ()</td></tr>
|
|
<tr class="memdesc:a0faf40c25ab019a326a60f301c2bb41b"><td class="mdescLeft"> </td><td class="mdescRight">Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius. <a href="#a0faf40c25ab019a326a60f301c2bb41b">More...</a><br/></td></tr>
|
|
<tr class="separator:a0faf40c25ab019a326a60f301c2bb41b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab91e79271a1f8e75b07bddbb04445dc9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9">enableAlarmInterrupts</a> ()</td></tr>
|
|
<tr class="memdesc:ab91e79271a1f8e75b07bddbb04445dc9"><td class="mdescLeft"> </td><td class="mdescRight">Enables the generation of interrupts for alarms 0 and 1. <a href="#ab91e79271a1f8e75b07bddbb04445dc9">More...</a><br/></td></tr>
|
|
<tr class="separator:ab91e79271a1f8e75b07bddbb04445dc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a225b8c62d617aa1b7be7d20e8a033be9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a225b8c62d617aa1b7be7d20e8a033be9">disableAlarmInterrupts</a> ()</td></tr>
|
|
<tr class="memdesc:a225b8c62d617aa1b7be7d20e8a033be9"><td class="mdescLeft"> </td><td class="mdescRight">Disables the generation of interrupts for alarms 0 and 1. <a href="#a225b8c62d617aa1b7be7d20e8a033be9">More...</a><br/></td></tr>
|
|
<tr class="separator:a225b8c62d617aa1b7be7d20e8a033be9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79649f100a4562b9c1ba7c69e85cbca3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3">firedAlarm</a> ()</td></tr>
|
|
<tr class="memdesc:a79649f100a4562b9c1ba7c69e85cbca3"><td class="mdescLeft"> </td><td class="mdescRight">Determines which of alarms 0 or 1 have fired since the last call. <a href="#a79649f100a4562b9c1ba7c69e85cbca3">More...</a><br/></td></tr>
|
|
<tr class="separator:a79649f100a4562b9c1ba7c69e85cbca3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3966de6f4241d86f198a8b9dd5e7e59a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#a3966de6f4241d86f198a8b9dd5e7e59a">enable32kHzOutput</a> ()</td></tr>
|
|
<tr class="memdesc:a3966de6f4241d86f198a8b9dd5e7e59a"><td class="mdescLeft"> </td><td class="mdescRight">Enables the 32 kHz output on the DS3232 chip. <a href="#a3966de6f4241d86f198a8b9dd5e7e59a">More...</a><br/></td></tr>
|
|
<tr class="separator:a3966de6f4241d86f198a8b9dd5e7e59a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada732bae42fc2833e59ae293aa27ddcb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDS3232RTC.html#ada732bae42fc2833e59ae293aa27ddcb">disable32kHzOutput</a> ()</td></tr>
|
|
<tr class="memdesc:ada732bae42fc2833e59ae293aa27ddcb"><td class="mdescLeft"> </td><td class="mdescRight">Disables the 32 kHz output on the DS3232 chip. <a href="#ada732bae42fc2833e59ae293aa27ddcb">More...</a><br/></td></tr>
|
|
<tr class="separator:ada732bae42fc2833e59ae293aa27ddcb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classRTC')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
|
|
<tr class="memitem:ada31c5120d18d2dd2863b3d440308da2 inherit pub_methods_classRTC"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#ada31c5120d18d2dd2863b3d440308da2">RTC</a> ()</td></tr>
|
|
<tr class="memdesc:ada31c5120d18d2dd2863b3d440308da2 inherit pub_methods_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new realtime clock handler. <a href="#ada31c5120d18d2dd2863b3d440308da2">More...</a><br/></td></tr>
|
|
<tr class="separator:ada31c5120d18d2dd2863b3d440308da2 inherit pub_methods_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classRTC')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
|
|
<tr class="memitem:ab2ca0cbee608ec32d3d6e04d40298f11 inherit pub_types_classRTC"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">DayOfWeek</a> { <br/>
|
|
  <b>Monday</b> = 1,
|
|
<b>Tuesday</b>,
|
|
<b>Wednesday</b>,
|
|
<b>Thursday</b>,
|
|
<br/>
|
|
  <b>Friday</b>,
|
|
<b>Saturday</b>,
|
|
<b>Sunday</b>
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ab2ca0cbee608ec32d3d6e04d40298f11"><td class="mdescLeft"> </td><td class="mdescRight">Day of the week corresponding to a date. <a href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">More...</a><br/></td></tr>
|
|
<tr class="separator:ab2ca0cbee608ec32d3d6e04d40298f11 inherit pub_types_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_methods_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classRTC')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
|
|
<tr class="memitem:adc29d7c43efc5a192d21965da5c3ee1d inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#adc29d7c43efc5a192d21965da5c3ee1d">adjustDays</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags)</td></tr>
|
|
<tr class="memdesc:adc29d7c43efc5a192d21965da5c3ee1d inherit pub_static_methods_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Adjusts <em>date</em> up or down one day according to <em>flags</em>. <a href="#adc29d7c43efc5a192d21965da5c3ee1d">More...</a><br/></td></tr>
|
|
<tr class="separator:adc29d7c43efc5a192d21965da5c3ee1d inherit pub_static_methods_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeca597e6e37a05716e664242f9cfc5f4 inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aeca597e6e37a05716e664242f9cfc5f4">adjustMonths</a> (<a class="el" href="structRTCDate.html">RTCDate</a> *date, uint8_t flags)</td></tr>
|
|
<tr class="memdesc:aeca597e6e37a05716e664242f9cfc5f4 inherit pub_static_methods_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Adjusts <em>date</em> up or down one month according to <em>flags</em>. <a href="#aeca597e6e37a05716e664242f9cfc5f4">More...</a><br/></td></tr>
|
|
<tr class="separator:aeca597e6e37a05716e664242f9cfc5f4 inherit pub_static_methods_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31d10cb2f7cac8839bd4be2d858b802d inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static void </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 class="memdesc:a31d10cb2f7cac8839bd4be2d858b802d inherit pub_static_methods_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Adjusts <em>date</em> up or down one year according to <em>flags</em>. <a href="#a31d10cb2f7cac8839bd4be2d858b802d">More...</a><br/></td></tr>
|
|
<tr class="separator:a31d10cb2f7cac8839bd4be2d858b802d inherit pub_static_methods_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a525a9c1dad89613708f47a683eb316aa inherit pub_static_methods_classRTC"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classRTC.html#ab2ca0cbee608ec32d3d6e04d40298f11">DayOfWeek</a> </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 class="memdesc:a525a9c1dad89613708f47a683eb316aa inherit pub_static_methods_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Returns the day of the week corresponding to <em>date</em>. <a href="#a525a9c1dad89613708f47a683eb316aa">More...</a><br/></td></tr>
|
|
<tr class="separator:a525a9c1dad89613708f47a683eb316aa inherit pub_static_methods_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_attribs_classRTC"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classRTC')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classRTC.html">RTC</a></td></tr>
|
|
<tr class="memitem:aee5ae8f600ee5296e65635c0d836fca3 inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee5ae8f600ee5296e65635c0d836fca3"></a>
|
|
static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> = 4</td></tr>
|
|
<tr class="memdesc:aee5ae8f600ee5296e65635c0d836fca3 inherit pub_static_attribs_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Number of alarms that are supported by <a class="el" href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66" title="Reads the details of the alarm with index alarmNum into value. ">RTC::readAlarm()</a> and <a class="el" href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e" title="Updates the details of the alarm with index alarmNum from value. ">RTC::writeAlarm()</a>. <br/></td></tr>
|
|
<tr class="separator:aee5ae8f600ee5296e65635c0d836fca3 inherit pub_static_attribs_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ed5480b362a83f1f45c4d3bcf7c3bf8 inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ed5480b362a83f1f45c4d3bcf7c3bf8"></a>
|
|
static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a9ed5480b362a83f1f45c4d3bcf7c3bf8">NO_TEMPERATURE</a> = 32767</td></tr>
|
|
<tr class="memdesc:a9ed5480b362a83f1f45c4d3bcf7c3bf8 inherit pub_static_attribs_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Value that is returned from <a class="el" href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a" title="Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius...">readTemperature()</a> if the realtime clock chip cannot determine the temperature. <br/></td></tr>
|
|
<tr class="separator:a9ed5480b362a83f1f45c4d3bcf7c3bf8 inherit pub_static_attribs_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacbe3ebbf893685950b05327c11d5c37 inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacbe3ebbf893685950b05327c11d5c37"></a>
|
|
static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#aacbe3ebbf893685950b05327c11d5c37">INCREMENT</a> = 0x0000</td></tr>
|
|
<tr class="memdesc:aacbe3ebbf893685950b05327c11d5c37 inherit pub_static_attribs_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Increment the day, month, or year in a call to <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>, or <a class="el" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d" title="Adjusts date up or down one year according to flags. ">adjustYears()</a>. <br/></td></tr>
|
|
<tr class="separator:aacbe3ebbf893685950b05327c11d5c37 inherit pub_static_attribs_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05b1bd1479afc80682abdd4f3e58dc6f inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05b1bd1479afc80682abdd4f3e58dc6f"></a>
|
|
static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a05b1bd1479afc80682abdd4f3e58dc6f">DECREMENT</a> = 0x0001</td></tr>
|
|
<tr class="memdesc:a05b1bd1479afc80682abdd4f3e58dc6f inherit pub_static_attribs_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Decrement the day, month, or year in a call to <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>, or <a class="el" href="classRTC.html#a31d10cb2f7cac8839bd4be2d858b802d" title="Adjusts date up or down one year according to flags. ">adjustYears()</a>. <br/></td></tr>
|
|
<tr class="separator:a05b1bd1479afc80682abdd4f3e58dc6f inherit pub_static_attribs_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02ace2d775063be9a99035851c9274eb inherit pub_static_attribs_classRTC"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02ace2d775063be9a99035851c9274eb"></a>
|
|
static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTC.html#a02ace2d775063be9a99035851c9274eb">WRAP</a> = 0x0002</td></tr>
|
|
<tr class="memdesc:a02ace2d775063be9a99035851c9274eb inherit pub_static_attribs_classRTC"><td class="mdescLeft"> </td><td class="mdescRight">Wrap around to the beginning of the current month/year rather than advance to the next one. <br/></td></tr>
|
|
<tr class="separator:a02ace2d775063be9a99035851c9274eb inherit pub_static_attribs_classRTC"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Communicates with a DS3232 realtime clock chip via I2C. </p>
|
|
<p>This class simplifies the process of reading and writing the time and date information in a DS3232 realtime clock chip. The class also provides support for reading and writing information about alarms and other clock settings.</p>
|
|
<p>If there is no DS3232 chip on the I2C bus, this class will fall back to the <a class="el" href="classRTC.html" title="Base class for realtime clock handlers. ">RTC</a> class to simulate the current time and date based on the value of millis().</p>
|
|
<p>Alarms 0 and 1 can be set to generate an interrupt when they fire using <a class="el" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9" title="Enables the generation of interrupts for alarms 0 and 1. ">enableAlarmInterrupts()</a>. The <a class="el" href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3" title="Determines which of alarms 0 or 1 have fired since the last call. ">firedAlarm()</a> function can be used to determine which alarm has fired. Alarms 2 and 3 cannot be monitored with interrupts.</p>
|
|
<p>The DS3232 uses a 2-digit year so this class is limited to dates between 2000 and 2099 inclusive.</p>
|
|
<p>Note: if this class has not been used with the DS3232 chip before, then the contents of NVRAM will be cleared. Any previous contents will be lost.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRTC.html" title="Base class for realtime clock handlers. ">RTC</a>, <a class="el" href="classDS1307RTC.html" title="Communicates with a DS1307 realtime clock chip via I2C. ">DS1307RTC</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8h_source.html#l00030">30</a> of file <a class="el" href="DS3232RTC_8h_source.html">DS3232RTC.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="aa959454ae01b11c48d6ec7ec192b4ccb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DS3232RTC::DS3232RTC </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classI2CMaster.html">I2CMaster</a> & </td>
|
|
<td class="paramname"><em>bus</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>oneHzPin</em> = <code>255</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Attaches to a realtime clock slave device on <em>bus</em>. </p>
|
|
<p>If <em>oneHzPin</em> is not 255, then it indicates a digital input pin that is connected to the 1 Hz square wave output on the realtime clock. This input is used by <a class="el" href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc" title="Returns true if the realtime clock has updated since the last call to this function. ">hasUpdates()</a> to determine if the time information has changed in a non-trivial manner.</p>
|
|
<p>If you wish to use <a class="el" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9" title="Enables the generation of interrupts for alarms 0 and 1. ">enableAlarmInterrupts()</a>, then <em>oneHzPin</em> must be 255.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc" title="Returns true if the realtime clock has updated since the last call to this function. ">hasUpdates()</a>, <a class="el" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9" title="Enables the generation of interrupts for alarms 0 and 1. ">enableAlarmInterrupts()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00126">126</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a1319fe936dcb7e9d6bdf200b77a94f8e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int DS3232RTC::byteCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings, excluding storage used by alarms. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a5ba83a3ef7d65d45c2f3241afdd8fef7" title="Reads the byte at offset within the realtime clock's non-volatile memory. ">readByte()</a>, <a class="el" href="classDS3232RTC.html#a9acebf12c5cecdd6d84e0ff9ed41765a" title="Writes value to offset within the realtime clock's non-volatile memory. ">writeByte()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#acfdebfb449710e44e11f9a3675e14fd8">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00335">335</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada732bae42fc2833e59ae293aa27ddcb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::disable32kHzOutput </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables the 32 kHz output on the DS3232 chip. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a3966de6f4241d86f198a8b9dd5e7e59a" title="Enables the 32 kHz output on the DS3232 chip. ">enable32kHzOutput()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00458">458</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a225b8c62d617aa1b7be7d20e8a033be9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::disableAlarmInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables the generation of interrupts for alarms 0 and 1. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9" title="Enables the generation of interrupts for alarms 0 and 1. ">enableAlarmInterrupts()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00393">393</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3966de6f4241d86f198a8b9dd5e7e59a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::enable32kHzOutput </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables the 32 kHz output on the DS3232 chip. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#ada732bae42fc2833e59ae293aa27ddcb" title="Disables the 32 kHz output on the DS3232 chip. ">disable32kHzOutput()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00444">444</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab91e79271a1f8e75b07bddbb04445dc9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::enableAlarmInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables the generation of interrupts for alarms 0 and 1. </p>
|
|
<p>When the interrupt occurs, use <a class="el" href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3" title="Determines which of alarms 0 or 1 have fired since the last call. ">firedAlarm()</a> to determine which alarm has fired. The application is responsible for implementing the interrupt service routine to watch for the interrupt.</p>
|
|
<p>Note: this function does nothing if the 1 Hz pin was enabled in the constructor, but <a class="el" href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3" title="Determines which of alarms 0 or 1 have fired since the last call. ">firedAlarm()</a> can still be used to determine which alarm has fired when <a class="el" href="classDS3232RTC.html#a619ffee1bc013c9ddf4ae415115798bc" title="Returns true if the realtime clock has updated since the last call to this function. ">hasUpdates()</a> reports that there is an update available.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a225b8c62d617aa1b7be7d20e8a033be9" title="Disables the generation of interrupts for alarms 0 and 1. ">disableAlarmInterrupts()</a>, <a class="el" href="classDS3232RTC.html#a79649f100a4562b9c1ba7c69e85cbca3" title="Determines which of alarms 0 or 1 have fired since the last call. ">firedAlarm()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00380">380</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a79649f100a4562b9c1ba7c69e85cbca3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int DS3232RTC::firedAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines which of alarms 0 or 1 have fired since the last call. </p>
|
|
<p>Returns 0 if alarm 0 has fired, 1 if alarm 1 has fired, 2 if both alarms have fired, or -1 if neither alarm has fired.</p>
|
|
<p>The fired alarm state will be cleared, ready for the next call.</p>
|
|
<p>This function cannot be used to determine if alarms 2 or 3 have fired as they are stored in NVRAM and are not handled specially by the DS3232.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#ab91e79271a1f8e75b07bddbb04445dc9" title="Enables the generation of interrupts for alarms 0 and 1. ">enableAlarmInterrupts()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00416">416</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a619ffee1bc013c9ddf4ae415115798bc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool DS3232RTC::hasUpdates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the realtime clock has updated since the last call to this function. </p>
|
|
<p>The default implementation returns true, indicating that an update is always available to be read. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a3690761f29654a2c9e676fcbfa32dd30">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00166">166</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a09c7073c687dcbbc423baf48074c7873"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::readAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>alarmNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structRTCAlarm.html">RTCAlarm</a> * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the details of the alarm with index <em>alarmNum</em> into <em>value</em>. </p>
|
|
<p>The <em>alarmNum</em> parameter must be between 0 and <a class="el" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> - 1.</p>
|
|
<p>Alarm details are stored at the end of the realtime clock's non-volatile memory.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a8b0a65e0ac479aec8fad6ca3147dbe75" title="Updates the details of the alarm with index alarmNum from value. ">writeAlarm()</a>, alarmCount() </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#ade282d7a60147c3f0269f1fcd59c8d66">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00278">278</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5ba83a3ef7d65d45c2f3241afdd8fef7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t DS3232RTC::readByte </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>offset</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the byte at <em>offset</em> within the realtime clock's non-volatile memory. </p>
|
|
<p>The <em>offset</em> parameter must be between 0 and <a class="el" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> - 1.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a9acebf12c5cecdd6d84e0ff9ed41765a" title="Writes value to offset within the realtime clock's non-volatile memory. ">writeByte()</a>, <a class="el" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a0f47b10b436e3f9d36e04ec907579431">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00340">340</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab03358e3b5996e38d766e2f9f6ab62ca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::readDate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structRTCDate.html">RTCDate</a> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the current date from the realtime clock into <em>value</em>. </p>
|
|
<p>The time should be read first with <a class="el" href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747" title="Reads the current time from the realtime clock into value. ">readTime()</a> as the default implementation only advances the date when the time is read and it crosses midnight.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a31c004a90c724979d8267c31f2dbf5ed" title="Updates the date in the realtime clock to match value. ">writeDate()</a>, <a class="el" href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747" title="Reads the current time from the realtime clock into value. ">readTime()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#aa1e21bf42ebd4456919744ae0f4f631e">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00225">225</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0faf40c25ab019a326a60f301c2bb41b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int DS3232RTC::readTemperature </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the value of the temperature sensor and returns the temperature in quarters of a degree celcius. </p>
|
|
<p>Returns the value NO_TEMPERATURE if the realtime clock chip cannot determine the temperature. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#aeca3c8387332e8cabfd09c1806276e5a">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00356">356</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af89e68c68f1c4b7e94286f800b5b2747"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::readTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structRTCTime.html">RTCTime</a> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the current time from the realtime clock into <em>value</em>. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#ab0ca13a8b80da856b37fc53b84e27c78" title="Updates the time in the realtime clock to match value. ">writeTime()</a>, <a class="el" href="classDS3232RTC.html#ab03358e3b5996e38d766e2f9f6ab62ca" title="Reads the current date from the realtime clock into value. ">readDate()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#aaf0a5c1f32f210a49718d148620b5bec">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00205">205</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8b0a65e0ac479aec8fad6ca3147dbe75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::writeAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>alarmNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structRTCAlarm.html">RTCAlarm</a> * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the details of the alarm with index <em>alarmNum</em> from <em>value</em>. </p>
|
|
<p>The <em>alarmNum</em> parameter must be between 0 and <a class="el" href="classRTC.html#aee5ae8f600ee5296e65635c0d836fca3">ALARM_COUNT</a> - 1.</p>
|
|
<p>Alarm details are stored at the end of the realtime clock's non-volatile memory.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a09c7073c687dcbbc423baf48074c7873" title="Reads the details of the alarm with index alarmNum into value. ">readAlarm()</a>, alarmCount() </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a0e96c91efd9e7a6340effdae3eadf17e">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00298">298</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9acebf12c5cecdd6d84e0ff9ed41765a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::writeByte </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Writes <em>value</em> to <em>offset</em> within the realtime clock's non-volatile memory. </p>
|
|
<p>The <em>offset</em> parameter must be between 0 and <a class="el" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> - 1.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#a5ba83a3ef7d65d45c2f3241afdd8fef7" title="Reads the byte at offset within the realtime clock's non-volatile memory. ">readByte()</a>, <a class="el" href="classDS3232RTC.html#a1319fe936dcb7e9d6bdf200b77a94f8e" title="Returns the number of bytes of non-volatile memory that can be used for storage of arbitrary settings...">byteCount()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a1cab6397ec04b1e2b3feea5b3cd1f749">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00348">348</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a31c004a90c724979d8267c31f2dbf5ed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::writeDate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structRTCDate.html">RTCDate</a> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the date in the realtime clock to match <em>value</em>. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#ab03358e3b5996e38d766e2f9f6ab62ca" title="Reads the current date from the realtime clock into value. ">readDate()</a>, <a class="el" href="classDS3232RTC.html#ab0ca13a8b80da856b37fc53b84e27c78" title="Updates the time in the realtime clock to match value. ">writeTime()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#ae667600d05c8e7b06a93574dd068a4d7">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00264">264</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab0ca13a8b80da856b37fc53b84e27c78"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DS3232RTC::writeTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structRTCTime.html">RTCTime</a> * </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the time in the realtime clock to match <em>value</em>. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDS3232RTC.html#af89e68c68f1c4b7e94286f800b5b2747" title="Reads the current time from the realtime clock into value. ">readTime()</a>, <a class="el" href="classDS3232RTC.html#a31c004a90c724979d8267c31f2dbf5ed" title="Updates the date in the realtime clock to match value. ">writeDate()</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classRTC.html#a102e2ec15bf0273d8f7e9ce4b6dcc96e">RTC</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="DS3232RTC_8cpp_source.html#l00250">250</a> of file <a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="DS3232RTC_8h_source.html">DS3232RTC.h</a></li>
|
|
<li><a class="el" href="DS3232RTC_8cpp_source.html">DS3232RTC.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Mar 23 2016 19:08:46 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|