Project

General

Profile

Revision 497

Added by Kevin Woo about 16 years ago

Updated the documentation for libdragonfly.

View differences:

group__battery.html
9 9 
  <ul>
10 10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
12 13 
    <li><a href="files.html"><span>Files</span></a></li>
13 14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14 15 
  </ul>
......
68 69 
<p>
69 70 
Returns the voltage of the battery in deciVolts. analog_init must be called before using this function.<p>
70 71 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the voltage of the battery in deciVolts.</dd></dl>
71 
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__battery.html#ga17c87ea3dd1f7539005ac596efe1b32" title="Read the battery voltage.">battery8</a> </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>
72 73 

  		




  73
  74
  
    
</div>


  		




  74
  75
  
    
</div><p>


  		




  ......




  93
  94
  
    
<p>


  		




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


  		




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


  		




  96
  
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">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="Read an 8-bit number from an analog port.">analog8</a> </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="Read an 8-bit number from an analog port. Loop must be stopped for this to work.">analog8</a> </dd></dl>


  		




  97
  98
  
    

  		




  98
  99
  
    
</div>


  		




  99
  100
  
    
</div><p>


  		




  ......




  123
  124
  
    
  </table>


  		




  124
  125
  
    
</dl>


  		




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


  		




  126
  
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__battery.html#g538631dcf134d98d7301d800a744e4d9" title="Read the battery voltage in deciVolts.">battery</a> </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>


  		




  127
  128
  
    

  		




  128
  129
  
    
</div>


  		




  129
  130
  
    
</div><p>


  		




  ......




  148
  149
  
    
<p>


  		




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


  		




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


  		




  151
  
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a> </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>


  		




  152
  153
  
    

  		




  153
  154
  
    
</div>


  		




  154
  155
  
    
</div><p>


  		




  155
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;


  		




  
  156
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by&nbsp;


  		




  156
  157
  
    
<a href="http://www.doxygen.org/index.html">


  		




  157
  158
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


  		




  158
  159
  
    
</body>


  		












Also available in:  Unified diff