mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
210 lines
14 KiB
HTML
210 lines
14 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: 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>
|
|
<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><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><!-- 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"> </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 class="header">
|
|
<div class="summary">
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#enumval-members">Enumerator</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Power saving utility functions</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<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  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> { <br/>
|
|
  <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>,
|
|
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc">SLEEP_120_MS</a>,
|
|
<br/>
|
|
  <a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69">SLEEP_250_MS</a>,
|
|
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0">SLEEP_500_MS</a>,
|
|
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b">SLEEP_1_SEC</a>,
|
|
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd">SLEEP_2_SEC</a>,
|
|
<br/>
|
|
  <a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410">SLEEP_4_SEC</a>,
|
|
<a class="el" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a">SLEEP_8_SEC</a>
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gabdc6266a040b28c4d79028ddb0ceae36"><td class="mdescLeft"> </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"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<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 </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"> </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"> </td></tr>
|
|
<tr class="memitem:ga6dbe8e20a70e83cf5b068177675ec792"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6dbe8e20a70e83cf5b068177675ec792"></a>
|
|
void </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"> </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"> </td></tr>
|
|
</table>
|
|
<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 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="gabdc6266a040b28c4d79028ddb0ceae36"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a></td>
|
|
</tr>
|
|
</table>
|
|
</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="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>
|
|
<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> </td><td class="fielddoc">
|
|
<p>Sleep for 15 milliseconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"></a>SLEEP_30_MS</em> </td><td class="fielddoc">
|
|
<p>Sleep for 30 milliseconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"></a>SLEEP_60_MS</em> </td><td class="fielddoc">
|
|
<p>Sleep for 60 milliseconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"></a>SLEEP_120_MS</em> </td><td class="fielddoc">
|
|
<p>Sleep for 120 milliseconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"></a>SLEEP_250_MS</em> </td><td class="fielddoc">
|
|
<p>Sleep for 250 milliseconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"></a>SLEEP_500_MS</em> </td><td class="fielddoc">
|
|
<p>Sleep for 500 milliseconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"></a>SLEEP_1_SEC</em> </td><td class="fielddoc">
|
|
<p>Sleep for 1 second. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"></a>SLEEP_2_SEC</em> </td><td class="fielddoc">
|
|
<p>Sleep for 2 seconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"></a>SLEEP_4_SEC</em> </td><td class="fielddoc">
|
|
<p>Sleep for 4 seconds. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"></a>SLEEP_8_SEC</em> </td><td class="fielddoc">
|
|
<p>Sleep for 8 seconds. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<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 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga95c1666038493a7f95be6768882eebad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sleepFor </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> </td>
|
|
<td class="paramname"><em>duration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</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>
|
|
|
|
<p>Definition at line <a class="el" href="PowerSave_8cpp_source.html#l00132">132</a> of file <a class="el" href="PowerSave_8cpp_source.html">PowerSave.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|