Revision 1145
Generated documentation for new orbs code
group__battery.html | ||
---|---|---|
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.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="annotated.html"><span>Data Structures</span></a></li> |
|
13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
14 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
|
15 |
</ul> |
|
7 |
<!-- Generated by Doxygen 1.5.5 --> |
|
8 |
<div class="navigation" id="top"> |
|
9 |
<div class="tabs"> |
|
10 |
<ul> |
|
11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
|
13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
15 |
<li><a href="files.html"><span>Files</span></a></li> |
|
16 |
</ul> |
|
17 |
</div> |
|
16 | 18 |
</div> |
19 |
<div class="contents"> |
|
17 | 20 |
<h1>Battery</h1>Functions for reading battery voltage. |
18 | 21 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
19 | 22 |
<tr><td></td></tr> |
... | ... | |
71 | 74 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl> |
72 | 75 |
<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> |
73 | 76 |
|
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> |
|
78 |
|
|
74 | 79 |
</div> |
75 | 80 |
</div><p> |
76 | 81 |
<a class="anchor" name="ga17c87ea3dd1f7539005ac596efe1b32"></a><!-- doxytag: member="battery.c::battery8" ref="ga17c87ea3dd1f7539005ac596efe1b32" args="(void)" --> |
... | ... | |
96 | 101 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery as an analog8 reading</dd></dl> |
97 | 102 |
<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> |
98 | 103 |
|
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> |
|
105 |
|
|
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> |
|
107 |
|
|
99 | 108 |
</div> |
100 | 109 |
</div><p> |
101 | 110 |
<a class="anchor" name="g431bfea596da03bdeead863b16e0c37a"></a><!-- doxytag: member="battery.c::battery8_avg" ref="g431bfea596da03bdeead863b16e0c37a" args="(int n_samples)" --> |
... | ... | |
126 | 135 |
<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> |
127 | 136 |
<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> |
128 | 137 |
|
138 |
<p>References <a class="el" href="battery_8c-source.html#l00069">battery8()</a>.</p> |
|
139 |
|
|
129 | 140 |
</div> |
130 | 141 |
</div><p> |
131 | 142 |
<a class="anchor" name="g4febf636fecb12a276edb51f5b9cc61e"></a><!-- doxytag: member="battery.c::battery_low" ref="g4febf636fecb12a276edb51f5b9cc61e" args="(void)" --> |
... | ... | |
151 | 162 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the battery is low, 0 otherwise</dd></dl> |
152 | 163 |
<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> |
153 | 164 |
|
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> |
|
166 |
|
|
154 | 167 |
</div> |
155 | 168 |
</div><p> |
156 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:42 2008 for libdragonfly by |
|
169 |
</div> |
|
170 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by |
|
157 | 171 |
<a href="http://www.doxygen.org/index.html"> |
158 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
172 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
159 | 173 |
</body> |
160 | 174 |
</html> |
Also available in: Unified diff