root / branches / wireless / docs / libdragonfly / html / group__battery.html @ 1578
History | View | Annotate | Download (9.9 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>Colony: Battery</title> |
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.8 -->
|
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>
|
18 |
</div>
|
19 |
<div class="contents"> |
20 |
<h1>Battery</h1>Functions for reading battery voltage. |
21 |
<a href="#_details">More...</a> |
22 |
<p>
|
23 |
<table border="0" cellpadding="0" cellspacing="0"> |
24 |
<tr><td></td></tr> |
25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d3e83b7f2ff00064ba16519d1589cfd"></a><!-- doxytag: member="battery::BATTERY_NORMALV" ref="g8d3e83b7f2ff00064ba16519d1589cfd" args="" --> |
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#g8d3e83b7f2ff00064ba16519d1589cfd">BATTERY_NORMALV</a> 154</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normal battery voltage. (6 V). <br></td></tr> |
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc955a8295474a62e5faeaf28abf89c6b"></a><!-- doxytag: member="battery::BATTERY_CHARINGV" ref="gc955a8295474a62e5faeaf28abf89c6b" args="" --> |
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#gc955a8295474a62e5faeaf28abf89c6b">BATTERY_CHARINGV</a> 179</td></tr> |
32 |
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Charging battery voltage. (7 V). <br></td></tr> |
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb23d2e4155f65f05628d1b48430c6b18"></a><!-- doxytag: member="battery::BATTERY_LOWV" ref="gb23d2e4155f65f05628d1b48430c6b18" args="" --> |
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#gb23d2e4155f65f05628d1b48430c6b18">BATTERY_LOWV</a> 152</td></tr> |
36 |
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Low battery voltage. ( < 6 V). <br></td></tr> |
38 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
39 |
<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> |
40 |
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the battery voltage. <a href="#ga17c87ea3dd1f7539005ac596efe1b32"></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#g538631dcf134d98d7301d800a744e4d9">battery</a> (void)</td></tr> |
43 |
|
44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the battery voltage in deciVolts. <a href="#g538631dcf134d98d7301d800a744e4d9"></a><br></td></tr> |
45 |
<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> |
46 |
|
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the battery is low. <a href="#g4febf636fecb12a276edb51f5b9cc61e"></a><br></td></tr> |
48 |
<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> |
49 |
|
50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an average battery voltage reading. <a href="#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr> |
51 |
</table>
|
52 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
53 |
Functions for reading battery voltage. |
54 |
<p>
|
55 |
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> |
56 |
<a class="anchor" name="g538631dcf134d98d7301d800a744e4d9"></a><!-- doxytag: member="battery.c::battery" ref="g538631dcf134d98d7301d800a744e4d9" args="(void)" --> |
57 |
<div class="memitem"> |
58 |
<div class="memproto"> |
59 |
<table class="memname"> |
60 |
<tr>
|
61 |
<td class="memname">int battery </td> |
62 |
<td>(</td> |
63 |
<td class="paramtype">void </td> |
64 |
<td class="paramname"> </td> |
65 |
<td> ) </td> |
66 |
<td></td> |
67 |
</tr>
|
68 |
</table>
|
69 |
</div>
|
70 |
<div class="memdoc"> |
71 |
|
72 |
<p>
|
73 |
Read the battery voltage in deciVolts. |
74 |
<p>
|
75 |
Returns the voltage of the battery in deciVolts. analog_init must be called before using this function.<p>
|
76 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl> |
77 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf998a4653bf62164fcc93b0f58796ab5" 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> |
78 |
|
79 |
</div>
|
80 |
</div><p> |
81 |
<a class="anchor" name="ga17c87ea3dd1f7539005ac596efe1b32"></a><!-- doxytag: member="battery.c::battery8" ref="ga17c87ea3dd1f7539005ac596efe1b32" args="(void)" --> |
82 |
<div class="memitem"> |
83 |
<div class="memproto"> |
84 |
<table class="memname"> |
85 |
<tr>
|
86 |
<td class="memname">int battery8 </td> |
87 |
<td>(</td> |
88 |
<td class="paramtype">void </td> |
89 |
<td class="paramname"> </td> |
90 |
<td> ) </td> |
91 |
<td></td> |
92 |
</tr>
|
93 |
</table>
|
94 |
</div>
|
95 |
<div class="memdoc"> |
96 |
|
97 |
<p>
|
98 |
Read the battery voltage. |
99 |
<p>
|
100 |
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>
|
101 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery as an analog8 reading</dd></dl> |
102 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf998a4653bf62164fcc93b0f58796ab5" 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 |
|
104 |
</div>
|
105 |
</div><p> |
106 |
<a class="anchor" name="g431bfea596da03bdeead863b16e0c37a"></a><!-- doxytag: member="battery.c::battery8_avg" ref="g431bfea596da03bdeead863b16e0c37a" args="(int n_samples)" --> |
107 |
<div class="memitem"> |
108 |
<div class="memproto"> |
109 |
<table class="memname"> |
110 |
<tr>
|
111 |
<td class="memname">int battery8_avg </td> |
112 |
<td>(</td> |
113 |
<td class="paramtype">int </td> |
114 |
<td class="paramname"> <em>n_samples</em> </td> |
115 |
<td> ) </td> |
116 |
<td></td> |
117 |
</tr>
|
118 |
</table>
|
119 |
</div>
|
120 |
<div class="memdoc"> |
121 |
|
122 |
<p>
|
123 |
Get an average battery voltage reading. |
124 |
<p>
|
125 |
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>
|
126 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
127 |
<table border="0" cellspacing="2" cellpadding="0"> |
128 |
<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> |
129 |
</table>
|
130 |
</dl>
|
131 |
<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> |
132 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf998a4653bf62164fcc93b0f58796ab5" 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> |
133 |
|
134 |
</div>
|
135 |
</div><p> |
136 |
<a class="anchor" name="g4febf636fecb12a276edb51f5b9cc61e"></a><!-- doxytag: member="battery.c::battery_low" ref="g4febf636fecb12a276edb51f5b9cc61e" args="(void)" --> |
137 |
<div class="memitem"> |
138 |
<div class="memproto"> |
139 |
<table class="memname"> |
140 |
<tr>
|
141 |
<td class="memname">char battery_low </td> |
142 |
<td>(</td> |
143 |
<td class="paramtype">void </td> |
144 |
<td class="paramname"> </td> |
145 |
<td> ) </td> |
146 |
<td></td> |
147 |
</tr>
|
148 |
</table>
|
149 |
</div>
|
150 |
<div class="memdoc"> |
151 |
|
152 |
<p>
|
153 |
Check if the battery is low. |
154 |
<p>
|
155 |
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>
|
156 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the battery is low, 0 otherwise</dd></dl> |
157 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf998a4653bf62164fcc93b0f58796ab5" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a> </dd></dl> |
158 |
|
159 |
</div>
|
160 |
</div><p> |
161 |
</div>
|
162 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:59 2009 for Colony by |
163 |
<a href="http://www.doxygen.org/index.html"> |
164 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
165 |
</body>
|
166 |
</html>
|