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
PowerSave_8h_source.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: PowerSave.h Source File</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>
@@ -118,35 +119,48 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &lt;WProgram.h&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="group__power__save.html#ga6dbe8e20a70e83cf5b068177675ec792"> 32</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="group__power__save.html#ga6dbe8e20a70e83cf5b068177675ec792" title="Marks an I/O pin as unused.This function sets pin to be an input with pullups enabled, which will reduce power consumption compared to pins that are left floating.">unusedPin</a>(uint8_t pin)</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="group__power__save.html#ga6dbe8e20a70e83cf5b068177675ec792"> 32</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="group__power__save.html#ga6dbe8e20a70e83cf5b068177675ec792">unusedPin</a>(uint8_t pin)</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; pinMode(pin, INPUT);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; digitalWrite(pin, HIGH);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36"> 38</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36" title="Duration to put the CPU to sleep with sleepFor().">SleepDuration</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36"> 38</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4"> 40</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4" title="Sleep for 15 milliseconds.">SLEEP_15_MS</a>,</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"> 41</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825" title="Sleep for 30 milliseconds.">SLEEP_30_MS</a>,</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"> 42</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc" title="Sleep for 60 milliseconds.">SLEEP_60_MS</a>,</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"> 43</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc" title="Sleep for 120 milliseconds.">SLEEP_120_MS</a>,</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"> 44</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69" title="Sleep for 250 milliseconds.">SLEEP_250_MS</a>,</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"> 45</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0" title="Sleep for 500 milliseconds.">SLEEP_500_MS</a>,</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"> 46</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b" title="Sleep for 1 second.">SLEEP_1_SEC</a>,</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"> 47</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd" title="Sleep for 2 seconds.">SLEEP_2_SEC</a>,</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"> 48</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410" title="Sleep for 4 seconds.">SLEEP_4_SEC</a>,</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"> 49</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a" title="Sleep for 8 seconds.">SLEEP_8_SEC</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4"> 40</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4">SLEEP_15_MS</a>,</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"> 41</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825">SLEEP_30_MS</a>,</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"> 42</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc">SLEEP_60_MS</a>,</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"> 43</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc">SLEEP_120_MS</a>,</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"> 44</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69">SLEEP_250_MS</a>,</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"> 45</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0">SLEEP_500_MS</a>,</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"> 46</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b">SLEEP_1_SEC</a>,</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"> 47</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd">SLEEP_2_SEC</a>,</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"> 48</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410">SLEEP_4_SEC</a>,</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"> 49</a></span>&#160; <a class="code" href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a">SLEEP_8_SEC</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;};</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">void</span> <a class="code" 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 class="code" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36" title="Duration to put the CPU to sleep with sleepFor().">SleepDuration</a> duration, uint8_t mode = 0);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__power__save.html#ga95c1666038493a7f95be6768882eebad">sleepFor</a>(<a class="code" href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a> duration, uint8_t mode = 0);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="group__power__save_html_ga6dbe8e20a70e83cf5b068177675ec792"><div class="ttname"><a href="group__power__save.html#ga6dbe8e20a70e83cf5b068177675ec792">unusedPin</a></div><div class="ttdeci">void unusedPin(uint8_t pin)</div><div class="ttdoc">Marks an I/O pin as unused.This function sets pin to be an input with pullups enabled, which will reduce power consumption compared to pins that are left floating. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00032">PowerSave.h:32</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a716f5a9f35e77a2d334ad71f05bd5fdc">SLEEP_60_MS</a></div><div class="ttdoc">Sleep for 60 milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00042">PowerSave.h:42</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36abcbf68cfdb688220da61ac98b1a2ec69">SLEEP_250_MS</a></div><div class="ttdoc">Sleep for 250 milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00044">PowerSave.h:44</a></div></div>
<div class="ttc" id="group__power__save_html_ga95c1666038493a7f95be6768882eebad"><div class="ttname"><a href="group__power__save.html#ga95c1666038493a7f95be6768882eebad">sleepFor</a></div><div class="ttdeci">void sleepFor(SleepDuration duration, uint8_t mode=0)</div><div class="ttdoc">Puts the CPU to sleep for a specific duration.The analog to digital converter and the brown out detec...</div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8cpp_source.html#l00132">PowerSave.cpp:132</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a96fa577b54aa6f2341ea5ddd839aa8bc">SLEEP_120_MS</a></div><div class="ttdoc">Sleep for 120 milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00043">PowerSave.h:43</a></div></div>
<div class="ttc" id="group__power__save_html_gabdc6266a040b28c4d79028ddb0ceae36"><div class="ttname"><a href="group__power__save.html#gabdc6266a040b28c4d79028ddb0ceae36">SleepDuration</a></div><div class="ttdeci">SleepDuration</div><div class="ttdoc">Duration to put the CPU to sleep with sleepFor(). </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00038">PowerSave.h:38</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36af31050c5ef733b3e231920143b041825">SLEEP_30_MS</a></div><div class="ttdoc">Sleep for 30 milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00041">PowerSave.h:41</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a04571aa0b801c28cd756513303b229cd">SLEEP_2_SEC</a></div><div class="ttdoc">Sleep for 2 seconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00047">PowerSave.h:47</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a8c47dd1ef81c2f41da7525b5ee4bfc3a">SLEEP_8_SEC</a></div><div class="ttdoc">Sleep for 8 seconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00049">PowerSave.h:49</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a92310daf29e5899770b80c1c4e850b9b">SLEEP_1_SEC</a></div><div class="ttdoc">Sleep for 1 second. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00046">PowerSave.h:46</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a4cba1036d7a69225110b68b372f10410">SLEEP_4_SEC</a></div><div class="ttdoc">Sleep for 4 seconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00048">PowerSave.h:48</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36aa49e4d5f92a5f48070dde0babf75a9b0">SLEEP_500_MS</a></div><div class="ttdoc">Sleep for 500 milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00045">PowerSave.h:45</a></div></div>
<div class="ttc" id="group__power__save_html_ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4"><div class="ttname"><a href="group__power__save.html#ggabdc6266a040b28c4d79028ddb0ceae36a3d16487a7386c6348f1c1d886564e3c4">SLEEP_15_MS</a></div><div class="ttdoc">Sleep for 15 milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="PowerSave_8h_source.html#l00040">PowerSave.h:40</a></div></div>
</div><!-- fragment --></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>