Revision 1398
recompiled libdragonfly to include new rangefinder doxygen comments
| group__battery.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 | 3 |
<title>libdragonfly: Battery</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 4 | 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.5 -->
|
|
| 7 |
<!-- Generated by Doxygen 1.5.9 -->
|
|
| 8 | 8 |
<div class="navigation" id="top"> |
| 9 | 9 |
<div class="tabs"> |
| 10 | 10 |
<ul> |
| ... | ... | |
| 18 | 18 |
</div> |
| 19 | 19 |
<div class="contents"> |
| 20 | 20 |
<h1>Battery</h1>Functions for reading battery voltage. |
| 21 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 21 |
<a href="#_details">More...</a> |
|
| 22 |
<p> |
|
| 23 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 22 | 24 |
<tr><td></td></tr> |
| 23 | 25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 24 | 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d3e83b7f2ff00064ba16519d1589cfd"></a><!-- doxytag: member="battery::BATTERY_NORMALV" ref="g8d3e83b7f2ff00064ba16519d1589cfd" args="" --> |
| ... | ... | |
| 61 | 63 |
<td class="paramtype">void </td> |
| 62 | 64 |
<td class="paramname"> </td> |
| 63 | 65 |
<td> ) </td> |
| 64 |
<td width="100%"></td>
|
|
| 66 |
<td></td> |
|
| 65 | 67 |
</tr> |
| 66 | 68 |
</table> |
| 67 | 69 |
</div> |
| ... | ... | |
| 74 | 76 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl> |
| 75 | 77 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a>, <a class="el" href="group__battery.html#ga17c87ea3dd1f7539005ac596efe1b32" title="Read the battery voltage.">battery8</a> </dd></dl> |
| 76 | 78 |
|
| 77 |
<p>References <a class="el" href="analog_8c-source.html#l00119">analog8()</a>, and <a class="el" href="analog_8h-source.html#l00092">BATT_PORT</a>.</p>
|
|
| 79 |
<p>References <a class="el" href="analog_8c_source.html#l00119">analog8()</a>, and <a class="el" href="analog_8h_source.html#l00092">BATT_PORT</a>.</p>
|
|
| 78 | 80 |
|
| 79 | 81 |
</div> |
| 80 | 82 |
</div><p> |
| ... | ... | |
| 88 | 90 |
<td class="paramtype">void </td> |
| 89 | 91 |
<td class="paramname"> </td> |
| 90 | 92 |
<td> ) </td> |
| 91 |
<td width="100%"></td>
|
|
| 93 |
<td></td> |
|
| 92 | 94 |
</tr> |
| 93 | 95 |
</table> |
| 94 | 96 |
</div> |
| ... | ... | |
| 101 | 103 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery as an analog8 reading</dd></dl> |
| 102 | 104 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">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="Returns an 8-bit analog value from the look up table. Use this instead of analog_get8...">analog8</a> </dd></dl> |
| 103 | 105 |
|
| 104 |
<p>References <a class="el" href="analog_8c-source.html#l00119">analog8()</a>, and <a class="el" href="analog_8h-source.html#l00092">BATT_PORT</a>.</p>
|
|
| 106 |
<p>References <a class="el" href="analog_8c_source.html#l00119">analog8()</a>, and <a class="el" href="analog_8h_source.html#l00092">BATT_PORT</a>.</p>
|
|
| 105 | 107 |
|
| 106 |
<p>Referenced by <a class="el" href="battery_8c-source.html#l00142">battery8_avg()</a>, and <a class="el" href="battery_8c-source.html#l00098">battery_low()</a>.</p>
|
|
| 108 |
<p>Referenced by <a class="el" href="battery_8c_source.html#l00142">battery8_avg()</a>, and <a class="el" href="battery_8c_source.html#l00098">battery_low()</a>.</p>
|
|
| 107 | 109 |
|
| 108 | 110 |
</div> |
| 109 | 111 |
</div><p> |
| ... | ... | |
| 117 | 119 |
<td class="paramtype">int </td> |
| 118 | 120 |
<td class="paramname"> <em>n_samples</em> </td> |
| 119 | 121 |
<td> ) </td> |
| 120 |
<td width="100%"></td>
|
|
| 122 |
<td></td> |
|
| 121 | 123 |
</tr> |
| 122 | 124 |
</table> |
| 123 | 125 |
</div> |
| ... | ... | |
| 135 | 137 |
<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> |
| 136 | 138 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a>, <a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9" title="Read the battery voltage in deciVolts.">battery</a> </dd></dl> |
| 137 | 139 |
|
| 138 |
<p>References <a class="el" href="battery_8c-source.html#l00069">battery8()</a>.</p>
|
|
| 140 |
<p>References <a class="el" href="battery_8c_source.html#l00069">battery8()</a>.</p>
|
|
| 139 | 141 |
|
| 140 | 142 |
</div> |
| 141 | 143 |
</div><p> |
| ... | ... | |
| 149 | 151 |
<td class="paramtype">void </td> |
| 150 | 152 |
<td class="paramname"> </td> |
| 151 | 153 |
<td> ) </td> |
| 152 |
<td width="100%"></td>
|
|
| 154 |
<td></td> |
|
| 153 | 155 |
</tr> |
| 154 | 156 |
</table> |
| 155 | 157 |
</div> |
| ... | ... | |
| 162 | 164 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the battery is low, 0 otherwise</dd></dl> |
| 163 | 165 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a> </dd></dl> |
| 164 | 166 |
|
| 165 |
<p>References <a class="el" href="battery_8c-source.html#l00069">battery8()</a>, and <a class="el" href="battery_8h-source.html#l00050">BATTERY_LOWV</a>.</p>
|
|
| 167 |
<p>References <a class="el" href="battery_8c_source.html#l00069">battery8()</a>, and <a class="el" href="battery_8h_source.html#l00050">BATTERY_LOWV</a>.</p>
|
|
| 166 | 168 |
|
| 167 | 169 |
</div> |
| 168 | 170 |
</div><p> |
| 169 | 171 |
</div> |
| 170 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:08 2009 for libdragonfly by
|
|
| 172 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by
|
|
| 171 | 173 |
<a href="http://www.doxygen.org/index.html"> |
| 172 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
| 174 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 173 | 175 |
</body> |
| 174 | 176 |
</html> |
Also available in: Unified diff