Project

General

Profile

Statistics
| Revision:

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

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

    		
  

  

    
      24
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normal battery voltage. (6 V). <br></td></tr>


    		
  

  

    
      25
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc955a8295474a62e5faeaf28abf89c6b"></a><!-- doxytag: member="battery::BATTERY_CHARINGV" ref="gc955a8295474a62e5faeaf28abf89c6b" args="" -->


    		
  

  

    
      26
    
    
      
#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>


    		
  

  

    
      27
    
    
      

    		
  

  

    
      28
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Charging battery voltage. (7 V). <br></td></tr>


    		
  

  

    
      29
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb23d2e4155f65f05628d1b48430c6b18"></a><!-- doxytag: member="battery::BATTERY_LOWV" ref="gb23d2e4155f65f05628d1b48430c6b18" args="" -->


    		
  

  

    
      30
    
    
      
#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>


    		
  

  

    
      31
    
    
      

    		
  

  

    
      32
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Low battery voltage. ( &lt; 6 V). <br></td></tr>


    		
  

  

    
      33
    
    
      
<tr><td colspan="2"><br><h2>Functions</h2></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#ga17c87ea3dd1f7539005ac596efe1b32">battery8</a> (void)</td></tr>


    		
  

  

    
      35
    
    
      

    		
  

  

    
      36
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the battery voltage.  <a href="#ga17c87ea3dd1f7539005ac596efe1b32"></a><br></td></tr>


    		
  

  

    
      37
    
    
      
<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>


    		
  

  

    
      38
    
    
      

    		
  

  

    
      39
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the battery voltage in deciVolts.  <a href="#g538631dcf134d98d7301d800a744e4d9"></a><br></td></tr>


    		
  

  

    
      40
    
    
      
<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>


    		
  

  

    
      41
    
    
      

    		
  

  

    
      42
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if the battery is low.  <a href="#g4febf636fecb12a276edb51f5b9cc61e"></a><br></td></tr>


    		
  

  

    
      43
    
    
      
<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>


    		
  

  

    
      44
    
    
      

    		
  

  

    
      45
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an average battery voltage reading.  <a href="#g431bfea596da03bdeead863b16e0c37a"></a><br></td></tr>


    		
  

  

    
      46
    
    
      
</table>


    		
  

  

    
      47
    
    
      
<hr><a name="_details"></a><h2>Detailed Description</h2>


    		
  

  

    
      48
    
    
      
Functions for reading battery voltage. 


    		
  

  

    
      49
    
    
      
<p>


    		
  

  

    
      50
    
    
      
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>


    		
  

  

    
      51
    
    
      
<a class="anchor" name="g538631dcf134d98d7301d800a744e4d9"></a><!-- doxytag: member="battery.c::battery" ref="g538631dcf134d98d7301d800a744e4d9" args="(void)" -->


    		
  

  

    
      52
    
    
      
<div class="memitem">


    		
  

  

    
      53
    
    
      
<div class="memproto">


    		
  

  

    
      54
    
    
      
      <table class="memname">


    		
  

  

    
      55
    
    
      
        <tr>


    		
  

  

    
      56
    
    
      
          <td class="memname">int battery           </td>


    		
  

  

    
      57
    
    
      
          <td>(</td>


    		
  

  

    
      58
    
    
      
          <td class="paramtype">void&nbsp;</td>


    		
  

  

    
      59
    
    
      
          <td class="paramname">          </td>


    		
  

  

    
      60
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      61
    
    
      
          <td width="100%"></td>


    		
  

  

    
      62
    
    
      
        </tr>


    		
  

  

    
      63
    
    
      
      </table>


    		
  

  

    
      64
    
    
      
</div>


    		
  

  

    
      65
    
    
      
<div class="memdoc">


    		
  

  

    
      66
    
    
      

    		
  

  

    
      67
    
    
      
<p>


    		
  

  

    
      68
    
    
      
Read the battery voltage in deciVolts. 


    		
  

  

    
      69
    
    
      
<p>


    		
  

  

    
      70
    
    
      
Returns the voltage of the battery in deciVolts. analog_init must be called before using this function.<p>


    		
  

  

    
      71
    
    
      
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl>


    		
  

  

    
      72
    
    
      
<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
    
    
      

    		
  

  

    
      74
    
    
      
</div>


    		
  

  

    
      75
    
    
      
</div><p>


    		
  

  

    
      76
    
    
      
<a class="anchor" name="ga17c87ea3dd1f7539005ac596efe1b32"></a><!-- doxytag: member="battery.c::battery8" ref="ga17c87ea3dd1f7539005ac596efe1b32" args="(void)" -->


    		
  

  

    
      77
    
    
      
<div class="memitem">


    		
  

  

    
      78
    
    
      
<div class="memproto">


    		
  

  

    
      79
    
    
      
      <table class="memname">


    		
  

  

    
      80
    
    
      
        <tr>


    		
  

  

    
      81
    
    
      
          <td class="memname">int battery8           </td>


    		
  

  

    
      82
    
    
      
          <td>(</td>


    		
  

  

    
      83
    
    
      
          <td class="paramtype">void&nbsp;</td>


    		
  

  

    
      84
    
    
      
          <td class="paramname">          </td>


    		
  

  

    
      85
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      86
    
    
      
          <td width="100%"></td>


    		
  

  

    
      87
    
    
      
        </tr>


    		
  

  

    
      88
    
    
      
      </table>


    		
  

  

    
      89
    
    
      
</div>


    		
  

  

    
      90
    
    
      
<div class="memdoc">


    		
  

  

    
      91
    
    
      

    		
  

  

    
      92
    
    
      
<p>


    		
  

  

    
      93
    
    
      
Read the battery voltage. 


    		
  

  

    
      94
    
    
      
<p>


    		
  

  

    
      95
    
    
      
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>


    		
  

  

    
      96
    
    
      
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery as an analog8 reading</dd></dl>


    		
  

  

    
      97
    
    
      
<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
    
    
      

    		
  

  

    
      99
    
    
      
</div>


    		
  

  

    
      100
    
    
      
</div><p>


    		
  

  

    
      101
    
    
      
<a class="anchor" name="g431bfea596da03bdeead863b16e0c37a"></a><!-- doxytag: member="battery.c::battery8_avg" ref="g431bfea596da03bdeead863b16e0c37a" args="(int n_samples)" -->


    		
  

  

    
      102
    
    
      
<div class="memitem">


    		
  

  

    
      103
    
    
      
<div class="memproto">


    		
  

  

    
      104
    
    
      
      <table class="memname">


    		
  

  

    
      105
    
    
      
        <tr>


    		
  

  

    
      106
    
    
      
          <td class="memname">int battery8_avg           </td>


    		
  

  

    
      107
    
    
      
          <td>(</td>


    		
  

  

    
      108
    
    
      
          <td class="paramtype">int&nbsp;</td>


    		
  

  

    
      109
    
    
      
          <td class="paramname"> <em>n_samples</em>          </td>


    		
  

  

    
      110
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      111
    
    
      
          <td width="100%"></td>


    		
  

  

    
      112
    
    
      
        </tr>


    		
  

  

    
      113
    
    
      
      </table>


    		
  

  

    
      114
    
    
      
</div>


    		
  

  

    
      115
    
    
      
<div class="memdoc">


    		
  

  

    
      116
    
    
      

    		
  

  

    
      117
    
    
      
<p>


    		
  

  

    
      118
    
    
      
Get an average battery voltage reading. 


    		
  

  

    
      119
    
    
      
<p>


    		
  

  

    
      120
    
    
      
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>


    		
  

  

    
      121
    
    
      
<dl compact><dt><b>Parameters:</b></dt><dd>


    		
  

  

    
      122
    
    
      
  <table border="0" cellspacing="2" cellpadding="0">


    		
  

  

    
      123
    
    
      
    <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>


    		
  

  

    
      124
    
    
      
  </table>


    		
  

  

    
      125
    
    
      
</dl>


    		
  

  

    
      126
    
    
      
<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
    
    
      
<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
    
    
      

    		
  

  

    
      129
    
    
      
</div>


    		
  

  

    
      130
    
    
      
</div><p>


    		
  

  

    
      131
    
    
      
<a class="anchor" name="g4febf636fecb12a276edb51f5b9cc61e"></a><!-- doxytag: member="battery.c::battery_low" ref="g4febf636fecb12a276edb51f5b9cc61e" args="(void)" -->


    		
  

  

    
      132
    
    
      
<div class="memitem">


    		
  

  

    
      133
    
    
      
<div class="memproto">


    		
  

  

    
      134
    
    
      
      <table class="memname">


    		
  

  

    
      135
    
    
      
        <tr>


    		
  

  

    
      136
    
    
      
          <td class="memname">char battery_low           </td>


    		
  

  

    
      137
    
    
      
          <td>(</td>


    		
  

  

    
      138
    
    
      
          <td class="paramtype">void&nbsp;</td>


    		
  

  

    
      139
    
    
      
          <td class="paramname">          </td>


    		
  

  

    
      140
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      141
    
    
      
          <td width="100%"></td>


    		
  

  

    
      142
    
    
      
        </tr>


    		
  

  

    
      143
    
    
      
      </table>


    		
  

  

    
      144
    
    
      
</div>


    		
  

  

    
      145
    
    
      
<div class="memdoc">


    		
  

  

    
      146
    
    
      

    		
  

  

    
      147
    
    
      
<p>


    		
  

  

    
      148
    
    
      
Check if the battery is low. 


    		
  

  

    
      149
    
    
      
<p>


    		
  

  

    
      150
    
    
      
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>


    		
  

  

    
      151
    
    
      
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the battery is low, 0 otherwise</dd></dl>


    		
  

  

    
      152
    
    
      
<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
    
    
      

    		
  

  

    
      154
    
    
      
</div>


    		
  

  

    
      155
    
    
      
</div><p>


    		
  

  

    
      156
    
    
      
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:42 2008 for libdragonfly by&nbsp;


    		
  

  

    
      157
    
    
      
<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>


    		
  

  

    
      159
    
    
      
</body>


    		
  

  

    
      160
    
    
      
</html>