Revision 241
Updated libdragonfly documentation.
| group__battery.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
| 3 | 3 |
<title>libdragonfly: Battery</title> |
| 4 | 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 | 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.4.6 -->
|
|
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
|
| 8 | 8 |
<div class="tabs"> |
| 9 | 9 |
<ul> |
| 10 | 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 | 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 | 12 |
<li><a href="files.html"><span>Files</span></a></li> |
| 13 |
</ul></div> |
|
| 13 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 14 | 16 |
<h1>Battery</h1>Functions for reading battery voltage. |
| 15 | 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 16 | 18 |
<tr><td></td></tr> |
| ... | ... | |
| 39 | 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the battery is low. <a href="#g4febf636fecb12a276edb51f5b9cc61e"></a><br></td></tr> |
| 40 | 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> |
| 41 | 43 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">get an average battery voltage reading. <a href="#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr>
|
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an average battery voltage reading. <a href="#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr>
|
|
| 43 | 45 |
</table> |
| 44 | 46 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 45 | 47 |
Functions for reading battery voltage. |
| 46 | 48 |
<p> |
| 47 |
Contains functions for checking the current voltage of the battery. Include <a class="el" href="battery_8h.html">battery.h</a> to access these functions. <hr><h2>Function Documentation</h2> |
|
| 48 |
<a class="anchor" name="g538631dcf134d98d7301d800a744e4d9"></a><!-- doxytag: member="battery.c::battery" ref="g538631dcf134d98d7301d800a744e4d9" args="(void)" --><p> |
|
| 49 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 50 |
<tr> |
|
| 51 |
<td class="mdRow"> |
|
| 52 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 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"> |
|
| 53 | 54 |
<tr> |
| 54 |
<td class="md" nowrap valign="top">int battery </td>
|
|
| 55 |
<td class="md" valign="top">( </td>
|
|
| 56 |
<td class="md" nowrap valign="top">void </td>
|
|
| 57 |
<td class="mdname1" valign="top" nowrap> </td>
|
|
| 58 |
<td class="md" valign="top"> ) </td>
|
|
| 59 |
<td class="md" nowrap></td>
|
|
| 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>
|
|
| 60 | 61 |
</tr> |
| 61 | 62 |
</table> |
| 62 |
</td> |
|
| 63 |
</tr> |
|
| 64 |
</table> |
|
| 65 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 66 |
<tr> |
|
| 67 |
<td> |
|
| 68 |
|
|
| 69 |
</td> |
|
| 70 |
<td> |
|
| 63 |
</div> |
|
| 64 |
<div class="memdoc"> |
|
| 71 | 65 |
|
| 72 | 66 |
<p> |
| 73 | 67 |
Read the battery voltage in deciVolts. |
| 74 | 68 |
<p> |
| 75 | 69 |
Returns the voltage of the battery in deciVolts. analog_init must be called before using this function.<p> |
| 76 |
<dl compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl> |
|
| 77 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a>, <a class="el" href="group__battery.html#ga17c87ea3dd1f7539005ac596efe1b32">battery8</a> </dd></dl> |
|
| 78 |
</td> |
|
| 79 |
</tr> |
|
| 80 |
</table> |
|
| 81 |
<a class="anchor" name="ga17c87ea3dd1f7539005ac596efe1b32"></a><!-- doxytag: member="battery.c::battery8" ref="ga17c87ea3dd1f7539005ac596efe1b32" args="(void)" --><p> |
|
| 82 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 83 |
<tr> |
|
| 84 |
<td class="mdRow"> |
|
| 85 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 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"> |
|
| 86 | 79 |
<tr> |
| 87 |
<td class="md" nowrap valign="top">int battery8 </td>
|
|
| 88 |
<td class="md" valign="top">( </td>
|
|
| 89 |
<td class="md" nowrap valign="top">void </td>
|
|
| 90 |
<td class="mdname1" valign="top" nowrap> </td>
|
|
| 91 |
<td class="md" valign="top"> ) </td>
|
|
| 92 |
<td class="md" nowrap></td>
|
|
| 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>
|
|
| 93 | 86 |
</tr> |
| 94 | 87 |
</table> |
| 95 |
</td> |
|
| 96 |
</tr> |
|
| 97 |
</table> |
|
| 98 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 99 |
<tr> |
|
| 100 |
<td> |
|
| 101 |
|
|
| 102 |
</td> |
|
| 103 |
<td> |
|
| 88 |
</div> |
|
| 89 |
<div class="memdoc"> |
|
| 104 | 90 |
|
| 105 | 91 |
<p> |
| 106 | 92 |
Read the battery voltage. |
| 107 | 93 |
<p> |
| 108 | 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> |
| 109 |
<dl compact><dt><b>Returns:</b></dt><dd>the voltage of the battery as an analog8 reading</dd></dl> |
|
| 110 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a>, <a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9">battery</a>, <a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27">analog8</a> </dd></dl> |
|
| 111 |
</td> |
|
| 112 |
</tr> |
|
| 113 |
</table> |
|
| 114 |
<a class="anchor" name="g431bfea596da03bdeead863b16e0c37a"></a><!-- doxytag: member="battery.c::battery8_avg" ref="g431bfea596da03bdeead863b16e0c37a" args="(int n_samples)" --><p> |
|
| 115 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 116 |
<tr> |
|
| 117 |
<td class="mdRow"> |
|
| 118 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 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"> |
|
| 119 | 104 |
<tr> |
| 120 |
<td class="md" nowrap valign="top">int battery8_avg </td>
|
|
| 121 |
<td class="md" valign="top">( </td>
|
|
| 122 |
<td class="md" nowrap valign="top">int </td>
|
|
| 123 |
<td class="mdname1" valign="top" nowrap> <em>n_samples</em> </td>
|
|
| 124 |
<td class="md" valign="top"> ) </td>
|
|
| 125 |
<td class="md" nowrap></td>
|
|
| 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>
|
|
| 126 | 111 |
</tr> |
| 127 | 112 |
</table> |
| 128 |
</td> |
|
| 129 |
</tr> |
|
| 130 |
</table> |
|
| 131 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 132 |
<tr> |
|
| 133 |
<td> |
|
| 134 |
|
|
| 135 |
</td> |
|
| 136 |
<td> |
|
| 113 |
</div> |
|
| 114 |
<div class="memdoc"> |
|
| 137 | 115 |
|
| 138 | 116 |
<p> |
| 139 |
get an average battery voltage reading.
|
|
| 117 |
Get an average battery voltage reading.
|
|
| 140 | 118 |
<p> |
| 141 | 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> |
| 142 | 120 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 143 | 121 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 144 |
<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>
|
|
| 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>
|
|
| 145 | 123 |
</table> |
| 146 | 124 |
</dl> |
| 147 |
<dl compact><dt><b>Returns:</b></dt><dd>the average reading for the battery voltage, where 128 is approximately 5 Volts.</dd></dl> |
|
| 148 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a>, <a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9">battery</a> </dd></dl> |
|
| 149 |
</td> |
|
| 150 |
</tr> |
|
| 151 |
</table> |
|
| 152 |
<a class="anchor" name="g4febf636fecb12a276edb51f5b9cc61e"></a><!-- doxytag: member="battery.c::battery_low" ref="g4febf636fecb12a276edb51f5b9cc61e" args="(void)" --><p> |
|
| 153 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 154 |
<tr> |
|
| 155 |
<td class="mdRow"> |
|
| 156 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 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"> |
|
| 157 | 134 |
<tr> |
| 158 |
<td class="md" nowrap valign="top">char battery_low </td>
|
|
| 159 |
<td class="md" valign="top">( </td>
|
|
| 160 |
<td class="md" nowrap valign="top">void </td>
|
|
| 161 |
<td class="mdname1" valign="top" nowrap> </td>
|
|
| 162 |
<td class="md" valign="top"> ) </td>
|
|
| 163 |
<td class="md" nowrap></td>
|
|
| 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>
|
|
| 164 | 141 |
</tr> |
| 165 | 142 |
</table> |
| 166 |
</td> |
|
| 167 |
</tr> |
|
| 168 |
</table> |
|
| 169 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 170 |
<tr> |
|
| 171 |
<td> |
|
| 172 |
|
|
| 173 |
</td> |
|
| 174 |
<td> |
|
| 143 |
</div> |
|
| 144 |
<div class="memdoc"> |
|
| 175 | 145 |
|
| 176 | 146 |
<p> |
| 177 | 147 |
Check if the battery is low. |
| 178 | 148 |
<p> |
| 179 | 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> |
| 180 |
<dl compact><dt><b>Returns:</b></dt><dd>1 if the battery is low, 0 otherwise</dd></dl> |
|
| 181 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a> </dd></dl>
|
|
| 182 |
</td> |
|
| 183 |
</tr>
|
|
| 184 |
</table>
|
|
| 185 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 26 17:39:30 2007 for libdragonfly by
|
|
| 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
|
|
| 186 | 156 |
<a href="http://www.doxygen.org/index.html"> |
| 187 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
| 157 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 188 | 158 |
</body> |
| 189 | 159 |
</html> |
Also available in: Unified diff