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
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
group__power__save.html
View File

@@ -3,6 +3,7 @@
<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: Power saving utility functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -83,7 +84,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<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>,
@@ -101,18 +102,21 @@ Enumerations</h2></td></tr>
<br/>
}</td></tr>
<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>
<tr class="separator:gabdc6266a040b28c4d79028ddb0ceae36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<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="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">More...</a><br/></td></tr>
<tr class="separator:ga95c1666038493a7f95be6768882eebad"><td class="memSeparator" colspan="2">&#160;</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 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>
<tr class="separator:ga6dbe8e20a70e83cf5b068177675ec792"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<a name="details" id="details"></a><h2 class="groupheader">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>
<h2>Enumeration Type Documentation</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gabdc6266a040b28c4d79028ddb0ceae36"></a>
<div class="memitem">
<div class="memproto">
@@ -125,46 +129,44 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
<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="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>SLEEP_15_MS</em>&nbsp;</td><td>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4"></a>SLEEP_15_MS</em>&#160;</td><td class="fielddoc">
<p>Sleep for 15 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"></a>SLEEP_30_MS</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"></a>SLEEP_30_MS</em>&#160;</td><td class="fielddoc">
<p>Sleep for 30 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"></a>SLEEP_60_MS</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"></a>SLEEP_60_MS</em>&#160;</td><td class="fielddoc">
<p>Sleep for 60 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"></a>SLEEP_120_MS</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"></a>SLEEP_120_MS</em>&#160;</td><td class="fielddoc">
<p>Sleep for 120 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"></a>SLEEP_250_MS</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"></a>SLEEP_250_MS</em>&#160;</td><td class="fielddoc">
<p>Sleep for 250 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"></a>SLEEP_500_MS</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"></a>SLEEP_500_MS</em>&#160;</td><td class="fielddoc">
<p>Sleep for 500 milliseconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"></a>SLEEP_1_SEC</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"></a>SLEEP_1_SEC</em>&#160;</td><td class="fielddoc">
<p>Sleep for 1 second. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"></a>SLEEP_2_SEC</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"></a>SLEEP_2_SEC</em>&#160;</td><td class="fielddoc">
<p>Sleep for 2 seconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"></a>SLEEP_4_SEC</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"></a>SLEEP_4_SEC</em>&#160;</td><td class="fielddoc">
<p>Sleep for 4 seconds. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"></a>SLEEP_8_SEC</em>&nbsp;</td><td>
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"></a>SLEEP_8_SEC</em>&#160;</td><td class="fielddoc">
<p>Sleep for 8 seconds. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="PowerSave_8h_source.html#l00038">38</a> of file <a class="el" href="PowerSave_8h_source.html">PowerSave.h</a>.</p>
</div>
</div>
<h2>Function Documentation</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga95c1666038493a7f95be6768882eebad"></a>
<div class="memitem">
<div class="memproto">
@@ -199,9 +201,9 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
</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">
Generated on Thu Mar 12 2015 19:02:05 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
</a> 1.8.6
</small></address>
</body>
</html>