taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2013-09-29 09:34:55 +10:00
parent 17f4fb4873
commit 8b7f9606ee
409 changed files with 21357 additions and 18181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
structRTCAlarm.html
View File

@@ -2,29 +2,37 @@
<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"/>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<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>
<div id="projectname">ArduinoLibs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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&#160;Page</span></a></li>
@@ -32,7 +40,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<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 id="searchli">
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
@@ -58,49 +66,61 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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> </div>
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classRTCAlarm-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RTCAlarm Class Reference</div> </div>
</div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="RTCAlarm" -->
<p>Stores alarm information from a realtime clock chip.
<a href="structRTCAlarm.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RTC_8h_source.html">RTC.h</a>&gt;</code></p>
<p><a href="classRTCAlarm-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75bdc42acd3ab3ad495680c6b6a34692"></a><!-- doxytag: member="RTCAlarm::hour" ref="a75bdc42acd3ab3ad495680c6b6a34692" args="" -->
<tr class="memitem:a75bdc42acd3ab3ad495680c6b6a34692"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75bdc42acd3ab3ad495680c6b6a34692"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a75bdc42acd3ab3ad495680c6b6a34692">hour</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Hour of the day for the alarm (0-23). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9a75ceb4b4b3474baa66dd5466e62fe"></a><!-- doxytag: member="RTCAlarm::minute" ref="ad9a75ceb4b4b3474baa66dd5466e62fe" args="" -->
<tr class="memdesc:a75bdc42acd3ab3ad495680c6b6a34692"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hour of the day for the alarm (0-23). <br/></td></tr>
<tr class="memitem:ad9a75ceb4b4b3474baa66dd5466e62fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9a75ceb4b4b3474baa66dd5466e62fe"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#ad9a75ceb4b4b3474baa66dd5466e62fe">minute</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Minute of the hour for the alarm (0-59). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">flags</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional flags for the alarm. <a href="#a0f2ef7363cb60a26642d5295b77ca19e"></a><br/></td></tr>
<tr class="memdesc:ad9a75ceb4b4b3474baa66dd5466e62fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minute of the hour for the alarm (0-59). <br/></td></tr>
<tr class="memitem:a0f2ef7363cb60a26642d5295b77ca19e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">flags</a></td></tr>
<tr class="memdesc:a0f2ef7363cb60a26642d5295b77ca19e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional flags for the alarm. <a href="#a0f2ef7363cb60a26642d5295b77ca19e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Stores alarm information from a realtime clock chip. </p>
<dl class="see"><dt><b>See also:</b></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>
<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><hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0f2ef7363cb60a26642d5295b77ca19e"></a><!-- doxytag: member="RTCAlarm::flags" ref="a0f2ef7363cb60a26642d5295b77ca19e" args="" -->
</div><h2>Member Data Documentation</h2>
<a class="anchor" id="a0f2ef7363cb60a26642d5295b77ca19e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structRTCAlarm.html#a0f2ef7363cb60a26642d5295b77ca19e">RTCAlarm::flags</a></td>
<td class="memname">RTCAlarm::flags</td>
</tr>
</table>
</div>
<div class="memdoc">
</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>
@@ -113,23 +133,12 @@ uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="s
<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>
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</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>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 18 2012 11:02:53 for ArduinoLibs by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>