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

122
group__power__save.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: Power saving utility functions</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><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"
@@ -50,7 +58,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
@@ -58,12 +80,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Power saving utility functions</div> </div>
</div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="enum-members"></a>
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> { <br/>
<tr class="memitem:gabdc6266a040b28c4d79028ddb0ceae36"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> { <br/>
&#160;&#160;<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4">SLEEP_15_MS</a>,
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825">SLEEP_30_MS</a>,
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc">SLEEP_60_MS</a>,
@@ -78,19 +100,20 @@ Enumerations</h2></td></tr>
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a">SLEEP_8_SEC</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration to put the CPU to sleep with <a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad" title="Puts the CPU to sleep for a specific duration.The analog to digital converter and the brown out detec...">sleepFor()</a>. <a href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
<tr class="memdesc:gabdc6266a040b28c4d79028ddb0ceae36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration to put the CPU to sleep with <a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad" title="Puts the CPU to sleep for a specific duration.The analog to digital converter and the brown out detec...">sleepFor()</a>. <a href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad">sleepFor</a> (<a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> duration, uint8_t mode)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts the CPU to sleep for a specific <em>duration</em>.The analog to digital converter and the brown out detector will be disabled during sleep mode. <a href="#ga95c1666038493a7f95be6768882eebad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6dbe8e20a70e83cf5b068177675ec792"></a><!-- doxytag: member="power_save::unusedPin" ref="ga6dbe8e20a70e83cf5b068177675ec792" args="(uint8_t pin)" -->
<tr class="memitem:ga95c1666038493a7f95be6768882eebad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad">sleepFor</a> (<a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> duration, uint8_t mode)</td></tr>
<tr class="memdesc:ga95c1666038493a7f95be6768882eebad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts the CPU to sleep for a specific <em>duration</em>.The analog to digital converter and the brown out detector will be disabled during sleep mode. <a href="#ga95c1666038493a7f95be6768882eebad"></a><br/></td></tr>
<tr class="memitem:ga6dbe8e20a70e83cf5b068177675ec792"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6dbe8e20a70e83cf5b068177675ec792"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__power__save.html#ga6dbe8e20a70e83cf5b068177675ec792">unusedPin</a> (uint8_t pin)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Marks an I/O <em>pin</em> as unused.This function sets <em>pin</em> to be an input with pullups enabled, which will reduce power consumption compared to pins that are left floating. <br/></td></tr>
<tr class="memdesc:ga6dbe8e20a70e83cf5b068177675ec792"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marks an I/O <em>pin</em> as unused.This function sets <em>pin</em> to be an input with pullups enabled, which will reduce power consumption compared to pins that are left floating. <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>
<p>The functions in this module assist with reducing power consumption on Arduino boards by disabling features that are not used or putting the device to sleep when it is inactive. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gabdc6266a040b28c4d79028ddb0ceae36"></a><!-- doxytag: member="PowerSave.h::SleepDuration" ref="gabdc6266a040b28c4d79028ddb0ceae36" args="" -->
<h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gabdc6266a040b28c4d79028ddb0ceae36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -98,40 +121,39 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
<td class="memname">enum <a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Duration to put the CPU to sleep with <a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad" title="Puts the CPU to sleep for a specific duration.The analog to digital converter and the brown out detec...">sleepFor()</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad" title="Puts the CPU to sleep for a specific duration.The analog to digital converter and the brown out detec...">sleepFor()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad" title="Puts the CPU to sleep for a specific duration.The analog to digital converter and the brown out detec...">sleepFor()</a> </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4"></a><!-- doxytag: member="SLEEP_15_MS" ref="ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4" args="" -->SLEEP_15_MS</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4"></a>SLEEP_15_MS</em>&nbsp;</td><td>
<p>Sleep for 15 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"></a><!-- doxytag: member="SLEEP_30_MS" ref="ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825" args="" -->SLEEP_30_MS</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"></a>SLEEP_30_MS</em>&nbsp;</td><td>
<p>Sleep for 30 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"></a><!-- doxytag: member="SLEEP_60_MS" ref="ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc" args="" -->SLEEP_60_MS</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"></a>SLEEP_60_MS</em>&nbsp;</td><td>
<p>Sleep for 60 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"></a><!-- doxytag: member="SLEEP_120_MS" ref="ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc" args="" -->SLEEP_120_MS</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"></a>SLEEP_120_MS</em>&nbsp;</td><td>
<p>Sleep for 120 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"></a><!-- doxytag: member="SLEEP_250_MS" ref="ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69" args="" -->SLEEP_250_MS</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"></a>SLEEP_250_MS</em>&nbsp;</td><td>
<p>Sleep for 250 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"></a><!-- doxytag: member="SLEEP_500_MS" ref="ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0" args="" -->SLEEP_500_MS</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"></a>SLEEP_500_MS</em>&nbsp;</td><td>
<p>Sleep for 500 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"></a><!-- doxytag: member="SLEEP_1_SEC" ref="ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b" args="" -->SLEEP_1_SEC</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"></a>SLEEP_1_SEC</em>&nbsp;</td><td>
<p>Sleep for 1 second. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"></a><!-- doxytag: member="SLEEP_2_SEC" ref="ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd" args="" -->SLEEP_2_SEC</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"></a>SLEEP_2_SEC</em>&nbsp;</td><td>
<p>Sleep for 2 seconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"></a><!-- doxytag: member="SLEEP_4_SEC" ref="ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410" args="" -->SLEEP_4_SEC</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"></a>SLEEP_4_SEC</em>&nbsp;</td><td>
<p>Sleep for 4 seconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"></a><!-- doxytag: member="SLEEP_8_SEC" ref="ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a" args="" -->SLEEP_8_SEC</em>&nbsp;</td><td>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"></a>SLEEP_8_SEC</em>&nbsp;</td><td>
<p>Sleep for 8 seconds. </p>
</td></tr>
</table>
@@ -142,8 +164,8 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga95c1666038493a7f95be6768882eebad"></a><!-- doxytag: member="PowerSave.cpp::sleepFor" ref="ga95c1666038493a7f95be6768882eebad" args="(SleepDuration duration, uint8_t mode)" -->
<h2>Function Documentation</h2>
<a class="anchor" id="ga95c1666038493a7f95be6768882eebad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -165,8 +187,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Puts the CPU to sleep for a specific <em>duration</em>.The analog to digital converter and the brown out detector will be disabled during sleep mode. </p>
<p>The <em>mode</em> parameter indicates the mode to use when the device is sleeping. The default is SLEEP_MODE_IDLE. </p>
@@ -175,23 +196,12 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</div>
</div>
</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:52 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>