root / trunk / docs / libdragonfly / group__battery.html @ 241
History | View | Annotate | Download (9.51 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libdragonfly: Battery</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
| 8 |
<div class="tabs"> |
| 9 |
<ul>
|
| 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 |
<li><a href="files.html"><span>Files</span></a></li> |
| 13 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
| 14 |
</ul>
|
| 15 |
</div>
|
| 16 |
<h1>Battery</h1>Functions for reading battery voltage. |
| 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 18 |
<tr><td></td></tr> |
| 19 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 20 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d3e83b7f2ff00064ba16519d1589cfd"></a><!-- doxytag: member="battery::BATTERY_NORMALV" ref="g8d3e83b7f2ff00064ba16519d1589cfd" args="" --> |
| 21 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#g8d3e83b7f2ff00064ba16519d1589cfd">BATTERY_NORMALV</a> 154</td></tr> |
| 22 |
|
| 23 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normal battery voltage. (6 V). <br></td></tr> |
| 24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc955a8295474a62e5faeaf28abf89c6b"></a><!-- doxytag: member="battery::BATTERY_CHARINGV" ref="gc955a8295474a62e5faeaf28abf89c6b" args="" --> |
| 25 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#gc955a8295474a62e5faeaf28abf89c6b">BATTERY_CHARINGV</a> 179</td></tr> |
| 26 |
|
| 27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Charging battery voltage. (7 V). <br></td></tr> |
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb23d2e4155f65f05628d1b48430c6b18"></a><!-- doxytag: member="battery::BATTERY_LOWV" ref="gb23d2e4155f65f05628d1b48430c6b18" args="" --> |
| 29 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#gb23d2e4155f65f05628d1b48430c6b18">BATTERY_LOWV</a> 152</td></tr> |
| 30 |
|
| 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Low battery voltage. ( < 6 V). <br></td></tr> |
| 32 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#ga17c87ea3dd1f7539005ac596efe1b32">battery8</a> (void)</td></tr> |
| 34 |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the battery voltage. <a href="#ga17c87ea3dd1f7539005ac596efe1b32"></a><br></td></tr> |
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9">battery</a> (void)</td></tr> |
| 37 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the battery voltage in deciVolts. <a href="#g538631dcf134d98d7301d800a744e4d9"></a><br></td></tr> |
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#g4febf636fecb12a276edb51f5b9cc61e">battery_low</a> (void)</td></tr> |
| 40 |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the battery is low. <a href="#g4febf636fecb12a276edb51f5b9cc61e"></a><br></td></tr> |
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#g431bfea596da03bdeead863b16e0c37a">battery8_avg</a> (int n_samples)</td></tr> |
| 43 |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an average battery voltage reading. <a href="#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr> |
| 45 |
</table>
|
| 46 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 47 |
Functions for reading battery voltage. |
| 48 |
<p>
|
| 49 |
Contains functions for checking the current voltage of the battery. Include <a class="el" href="battery_8h.html" title="Definitions for checking battery voltage.">battery.h</a> to access these functions. <hr><h2>Function Documentation</h2> |
| 50 |
<a class="anchor" name="g538631dcf134d98d7301d800a744e4d9"></a><!-- doxytag: member="battery.c::battery" ref="g538631dcf134d98d7301d800a744e4d9" args="(void)" --> |
| 51 |
<div class="memitem"> |
| 52 |
<div class="memproto"> |
| 53 |
<table class="memname"> |
| 54 |
<tr>
|
| 55 |
<td class="memname">int battery </td> |
| 56 |
<td>(</td> |
| 57 |
<td class="paramtype">void </td> |
| 58 |
<td class="paramname"> </td> |
| 59 |
<td> ) </td> |
| 60 |
<td width="100%"></td> |
| 61 |
</tr>
|
| 62 |
</table>
|
| 63 |
</div>
|
| 64 |
<div class="memdoc"> |
| 65 |
|
| 66 |
<p>
|
| 67 |
Read the battery voltage in deciVolts. |
| 68 |
<p>
|
| 69 |
Returns the voltage of the battery in deciVolts. analog_init must be called before using this function.<p>
|
| 70 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl> |
| 71 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__battery.html#ga17c87ea3dd1f7539005ac596efe1b32" title="Read the battery voltage.">battery8</a> </dd></dl> |
| 72 |
|
| 73 |
</div>
|
| 74 |
</div><p> |
| 75 |
<a class="anchor" name="ga17c87ea3dd1f7539005ac596efe1b32"></a><!-- doxytag: member="battery.c::battery8" ref="ga17c87ea3dd1f7539005ac596efe1b32" args="(void)" --> |
| 76 |
<div class="memitem"> |
| 77 |
<div class="memproto"> |
| 78 |
<table class="memname"> |
| 79 |
<tr>
|
| 80 |
<td class="memname">int battery8 </td> |
| 81 |
<td>(</td> |
| 82 |
<td class="paramtype">void </td> |
| 83 |
<td class="paramname"> </td> |
| 84 |
<td> ) </td> |
| 85 |
<td width="100%"></td> |
| 86 |
</tr>
|
| 87 |
</table>
|
| 88 |
</div>
|
| 89 |
<div class="memdoc"> |
| 90 |
|
| 91 |
<p>
|
| 92 |
Read the battery voltage. |
| 93 |
<p>
|
| 94 |
Returns the voltage of the battery as an analog8 reading. 128 is approximately 5 volts. analog_init must be called before using this function.<p>
|
| 95 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery as an analog8 reading</dd></dl> |
| 96 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9" title="Read the battery voltage in deciVolts.">battery</a>, <a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27" title="Read an 8-bit number from an analog port.">analog8</a> </dd></dl> |
| 97 |
|
| 98 |
</div>
|
| 99 |
</div><p> |
| 100 |
<a class="anchor" name="g431bfea596da03bdeead863b16e0c37a"></a><!-- doxytag: member="battery.c::battery8_avg" ref="g431bfea596da03bdeead863b16e0c37a" args="(int n_samples)" --> |
| 101 |
<div class="memitem"> |
| 102 |
<div class="memproto"> |
| 103 |
<table class="memname"> |
| 104 |
<tr>
|
| 105 |
<td class="memname">int battery8_avg </td> |
| 106 |
<td>(</td> |
| 107 |
<td class="paramtype">int </td> |
| 108 |
<td class="paramname"> <em>n_samples</em> </td> |
| 109 |
<td> ) </td> |
| 110 |
<td width="100%"></td> |
| 111 |
</tr>
|
| 112 |
</table>
|
| 113 |
</div>
|
| 114 |
<div class="memdoc"> |
| 115 |
|
| 116 |
<p>
|
| 117 |
Get an average battery voltage reading. |
| 118 |
<p>
|
| 119 |
Averages n_samples battery8 readings. This function may take a while to complete, and is only made available for convenience. analog_init must be called before this function may be used.<p>
|
| 120 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 121 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 122 |
<tr><td valign="top"></td><td valign="top"><em>n_samples</em> </td><td>the number of times to sample the battery voltage</td></tr> |
| 123 |
</table>
|
| 124 |
</dl>
|
| 125 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the average reading for the battery voltage, where 128 is approximately 5 Volts.</dd></dl> |
| 126 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9" title="Read the battery voltage in deciVolts.">battery</a> </dd></dl> |
| 127 |
|
| 128 |
</div>
|
| 129 |
</div><p> |
| 130 |
<a class="anchor" name="g4febf636fecb12a276edb51f5b9cc61e"></a><!-- doxytag: member="battery.c::battery_low" ref="g4febf636fecb12a276edb51f5b9cc61e" args="(void)" --> |
| 131 |
<div class="memitem"> |
| 132 |
<div class="memproto"> |
| 133 |
<table class="memname"> |
| 134 |
<tr>
|
| 135 |
<td class="memname">char battery_low </td> |
| 136 |
<td>(</td> |
| 137 |
<td class="paramtype">void </td> |
| 138 |
<td class="paramname"> </td> |
| 139 |
<td> ) </td> |
| 140 |
<td width="100%"></td> |
| 141 |
</tr>
|
| 142 |
</table>
|
| 143 |
</div>
|
| 144 |
<div class="memdoc"> |
| 145 |
|
| 146 |
<p>
|
| 147 |
Check if the battery is low. |
| 148 |
<p>
|
| 149 |
Checks if the battery is low. analog_init must be called before this function can be used. This function waits for several low battery readings in a row to avoid false positives.<p>
|
| 150 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the battery is low, 0 otherwise</dd></dl> |
| 151 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a> </dd></dl> |
| 152 |
|
| 153 |
</div>
|
| 154 |
</div><p> |
| 155 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by |
| 156 |
<a href="http://www.doxygen.org/index.html"> |
| 157 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
| 158 |
</body>
|
| 159 |
</html>
|