Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / battery_8h.html @ 87

History | View | Annotate | Download (4.73 KB)

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">
3
<title>libdragonfly: battery.h File Reference</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.4.6 -->
8
<div class="tabs">
9
  <ul>
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
    <li><a href="modules.html"><span>Modules</span></a></li>
12
    <li id="current"><a href="files.html"><span>Files</span></a></li>
13
  </ul></div>
14
<div class="tabs">
15
  <ul>
16
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
17
    <li><a href="globals.html"><span>Globals</span></a></li>
18
  </ul></div>
19
<h1>battery.h File Reference</h1>Definitions for checking battery voltage. <a href="#_details">More...</a>
20
<p>
21

    
22
<p>
23
<a href="battery_8h-source.html">Go to the source code of this file.</a><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.h::BATTERY_NORMALV" ref="g8d3e83b7f2ff00064ba16519d1589cfd" args="" -->
27
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#g8d3e83b7f2ff00064ba16519d1589cfd">BATTERY_NORMALV</a>&nbsp;&nbsp;&nbsp;154</td></tr>
28

    
29
<tr><td class="mdescLeft">&nbsp;</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.h::BATTERY_CHARINGV" ref="gc955a8295474a62e5faeaf28abf89c6b" args="" -->
31
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#gc955a8295474a62e5faeaf28abf89c6b">BATTERY_CHARINGV</a>&nbsp;&nbsp;&nbsp;179</td></tr>
32

    
33
<tr><td class="mdescLeft">&nbsp;</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.h::BATTERY_LOWV" ref="gb23d2e4155f65f05628d1b48430c6b18" args="" -->
35
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__battery.html#gb23d2e4155f65f05628d1b48430c6b18">BATTERY_LOWV</a>&nbsp;&nbsp;&nbsp;152</td></tr>
36

    
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Low battery voltage. ( &lt; 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&nbsp;</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">&nbsp;</td><td class="mdescRight">Read the battery voltage.  <a href="group__battery.html#ga17c87ea3dd1f7539005ac596efe1b32"></a><br></td></tr>
42
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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">&nbsp;</td><td class="mdescRight">Read the battery voltage in deciVolts.  <a href="group__battery.html#g538631dcf134d98d7301d800a744e4d9"></a><br></td></tr>
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</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">&nbsp;</td><td class="mdescRight">Check if the battery is low.  <a href="group__battery.html#g4febf636fecb12a276edb51f5b9cc61e"></a><br></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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">&nbsp;</td><td class="mdescRight">get an average battery voltage reading.  <a href="group__battery.html#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr>
51
</table>
52
<hr><a name="_details"></a><h2>Detailed Description</h2>
53
Definitions for checking battery voltage. 
54
<p>
55
Contains definitions for checking the voltage of the battery.<p>
56
<dl compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>
57
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 26 17:39:30 2007 for libdragonfly by&nbsp;
58
<a href="http://www.doxygen.org/index.html">
59
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
60
</body>
61
</html>