Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / group__battery.html @ 41

History | View | Annotate | Download (10.1 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</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><a href="files.html"><span>Files</span></a></li>
13
  </ul></div>
14
<h1>Battery</h1>Functions for reading battery voltage.  
15
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
16
<tr><td></td></tr>
17
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
18
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d3e83b7f2ff00064ba16519d1589cfd"></a><!-- doxytag: member="battery::BATTERY_NORMALV" ref="g8d3e83b7f2ff00064ba16519d1589cfd" args="" -->
19
#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>
20

    
21
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normal battery voltage. (6 V). <br></td></tr>
22
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc955a8295474a62e5faeaf28abf89c6b"></a><!-- doxytag: member="battery::BATTERY_CHARINGV" ref="gc955a8295474a62e5faeaf28abf89c6b" args="" -->
23
#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>
24

    
25
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Charging battery voltage. (7 V). <br></td></tr>
26
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb23d2e4155f65f05628d1b48430c6b18"></a><!-- doxytag: member="battery::BATTERY_LOWV" ref="gb23d2e4155f65f05628d1b48430c6b18" args="" -->
27
#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>
28

    
29
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Low battery voltage. ( &lt; 6 V). <br></td></tr>
30
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
31
<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>
32

    
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the battery voltage.  <a href="#ga17c87ea3dd1f7539005ac596efe1b32"></a><br></td></tr>
34
<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>
35

    
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the battery voltage in deciVolts.  <a href="#g538631dcf134d98d7301d800a744e4d9"></a><br></td></tr>
37
<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>
38

    
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if the battery is low.  <a href="#g4febf636fecb12a276edb51f5b9cc61e"></a><br></td></tr>
40
<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>
41

    
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get an average battery voltage reading.  <a href="#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr>
43
</table>
44
<hr><a name="_details"></a><h2>Detailed Description</h2>
45
Functions for reading battery voltage. 
46
<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">
53
        <tr>
54
          <td class="md" nowrap valign="top">int battery           </td>
55
          <td class="md" valign="top">(&nbsp;</td>
56
          <td class="md" nowrap valign="top">void&nbsp;</td>
57
          <td class="mdname1" valign="top" nowrap>          </td>
58
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
59
          <td class="md" nowrap></td>
60
        </tr>
61
      </table>
62
    </td>
63
  </tr>
64
</table>
65
<table cellspacing="5" cellpadding="0" border="0">
66
  <tr>
67
    <td>
68
      &nbsp;
69
    </td>
70
    <td>
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 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">
86
        <tr>
87
          <td class="md" nowrap valign="top">int battery8           </td>
88
          <td class="md" valign="top">(&nbsp;</td>
89
          <td class="md" nowrap valign="top">void&nbsp;</td>
90
          <td class="mdname1" valign="top" nowrap>          </td>
91
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
92
          <td class="md" nowrap></td>
93
        </tr>
94
      </table>
95
    </td>
96
  </tr>
97
</table>
98
<table cellspacing="5" cellpadding="0" border="0">
99
  <tr>
100
    <td>
101
      &nbsp;
102
    </td>
103
    <td>
104

    
105
<p>
106
Read the battery voltage. 
107
<p>
108
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">
119
        <tr>
120
          <td class="md" nowrap valign="top">int battery8_avg           </td>
121
          <td class="md" valign="top">(&nbsp;</td>
122
          <td class="md" nowrap valign="top">int&nbsp;</td>
123
          <td class="mdname1" valign="top" nowrap> <em>n_samples</em>          </td>
124
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125
          <td class="md" nowrap></td>
126
        </tr>
127
      </table>
128
    </td>
129
  </tr>
130
</table>
131
<table cellspacing="5" cellpadding="0" border="0">
132
  <tr>
133
    <td>
134
      &nbsp;
135
    </td>
136
    <td>
137

    
138
<p>
139
get an average battery voltage reading. 
140
<p>
141
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
<dl compact><dt><b>Parameters:</b></dt><dd>
143
  <table border="0" cellspacing="2" cellpadding="0">
144
    <tr><td valign="top"></td><td valign="top"><em>n_samples</em>&nbsp;</td><td>The number of times to sample the battery voltage</td></tr>
145
  </table>
146
</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">
157
        <tr>
158
          <td class="md" nowrap valign="top">char battery_low           </td>
159
          <td class="md" valign="top">(&nbsp;</td>
160
          <td class="md" nowrap valign="top">void&nbsp;</td>
161
          <td class="mdname1" valign="top" nowrap>          </td>
162
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
163
          <td class="md" nowrap></td>
164
        </tr>
165
      </table>
166
    </td>
167
  </tr>
168
</table>
169
<table cellspacing="5" cellpadding="0" border="0">
170
  <tr>
171
    <td>
172
      &nbsp;
173
    </td>
174
    <td>
175

    
176
<p>
177
Check if the battery is low. 
178
<p>
179
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 Fri Sep 14 15:36:18 2007 for libdragonfly by&nbsp;
186
<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>
188
</body>
189
</html>