mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
209 lines
13 KiB
HTML
209 lines
13 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: RTCAlarm 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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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-attribs">Public Attributes</a> |
|
|
<a href="classRTCAlarm-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RTCAlarm Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Stores alarm information from a realtime clock chip.
|
|
<a href="structRTCAlarm.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="RTC_8h_source.html">RTC.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a9cbc0c2bd8cee02917539af77e845fc4"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a9cbc0c2bd8cee02917539af77e845fc4">day</a></td></tr>
|
|
<tr class="memdesc:a9cbc0c2bd8cee02917539af77e845fc4"><td class="mdescLeft"> </td><td class="mdescRight">Day of the month for the alarm if not zero. <a href="#a9cbc0c2bd8cee02917539af77e845fc4">More...</a><br/></td></tr>
|
|
<tr class="separator:a9cbc0c2bd8cee02917539af77e845fc4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a764061bcf84755b4b9db07dead0d46b9"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a764061bcf84755b4b9db07dead0d46b9">dow</a></td></tr>
|
|
<tr class="memdesc:a764061bcf84755b4b9db07dead0d46b9"><td class="mdescLeft"> </td><td class="mdescRight">Day of the week for the alarm if not zero. <a href="#a764061bcf84755b4b9db07dead0d46b9">More...</a><br/></td></tr>
|
|
<tr class="separator:a764061bcf84755b4b9db07dead0d46b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75bdc42acd3ab3ad495680c6b6a34692"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75bdc42acd3ab3ad495680c6b6a34692"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692">hour</a></td></tr>
|
|
<tr class="memdesc:a75bdc42acd3ab3ad495680c6b6a34692"><td class="mdescLeft"> </td><td class="mdescRight">Hour of the day for the alarm (0-23). <br/></td></tr>
|
|
<tr class="separator:a75bdc42acd3ab3ad495680c6b6a34692"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9a75ceb4b4b3474baa66dd5466e62fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9a75ceb4b4b3474baa66dd5466e62fe"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe">minute</a></td></tr>
|
|
<tr class="memdesc:ad9a75ceb4b4b3474baa66dd5466e62fe"><td class="mdescLeft"> </td><td class="mdescRight">Minute of the hour for the alarm (0-59). <br/></td></tr>
|
|
<tr class="separator:ad9a75ceb4b4b3474baa66dd5466e62fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab749e3695ee5c5dd703aec71f72d46a1"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#ab749e3695ee5c5dd703aec71f72d46a1">second</a></td></tr>
|
|
<tr class="memdesc:ab749e3695ee5c5dd703aec71f72d46a1"><td class="mdescLeft"> </td><td class="mdescRight">Second of the minute for the alarm (0-59). <a href="#ab749e3695ee5c5dd703aec71f72d46a1">More...</a><br/></td></tr>
|
|
<tr class="separator:ab749e3695ee5c5dd703aec71f72d46a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f2ef7363cb60a26642d5295b77ca19e"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">flags</a></td></tr>
|
|
<tr class="memdesc:a0f2ef7363cb60a26642d5295b77ca19e"><td class="mdescLeft"> </td><td class="mdescRight">Additional flags for the alarm. <a href="#a0f2ef7363cb60a26642d5295b77ca19e">More...</a><br/></td></tr>
|
|
<tr class="separator:a0f2ef7363cb60a26642d5295b77ca19e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Stores alarm information from a realtime clock chip. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structRTCTime.html" title="Stores time information from a realtime clock chip. ">RTCTime</a>, <a class="el" href="structRTCDate.html" title="Stores date information from a realtime clock chip. ">RTCDate</a>, <a class="el" href="classRTC.html" title="Base class for realtime clock handlers. ">RTC</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="RTC_8h_source.html#l00042">42</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a9cbc0c2bd8cee02917539af77e845fc4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RTCAlarm::day</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Day of the month for the alarm if not zero. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Currently this field only works with the <a class="el" href="classDS3231RTC.html" title="Communicates with a DS3231 realtime clock chip via I2C. ">DS3231RTC</a> class. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="RTC_8h_source.html#l00044">44</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a764061bcf84755b4b9db07dead0d46b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RTCAlarm::dow</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Day of the week for the alarm if not zero. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Currently this field only works with the <a class="el" href="classDS3231RTC.html" title="Communicates with a DS3231 realtime clock chip via I2C. ">DS3231RTC</a> class. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="RTC_8h_source.html#l00045">45</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0f2ef7363cb60a26642d5295b77ca19e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RTCAlarm::flags</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Additional flags for the alarm. </p>
|
|
<p>The least significant bit will be 0 if the alarm is disabled or 1 if the alarm is enabled. Other bits can be used by the application for any purpose. </p>
|
|
|
|
<p>Definition at line <a class="el" href="RTC_8h_source.html#l00049">49</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab749e3695ee5c5dd703aec71f72d46a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RTCAlarm::second</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Second of the minute for the alarm (0-59). </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Currently this field only works with the <a class="el" href="classDS3231RTC.html" title="Communicates with a DS3231 realtime clock chip via I2C. ">DS3231RTC</a> class. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="RTC_8h_source.html#l00048">48</a> of file <a class="el" href="RTC_8h_source.html">RTC.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="RTC_8h_source.html">RTC.h</a></li>
|
|
<li><a class="el" href="RTC_8cpp_source.html">RTC.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Mar 29 2015 08:30:13 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>
|