Project

General

Profile

Revision 1398

Added by Chris Mar over 14 years ago

recompiled libdragonfly to include new rangefinder doxygen comments

View differences:

group__rangefinder.html
1 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3 
<title>libdragonfly: Rangefinder</title>
4 
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.5 -->
7 
<!-- Generated by Doxygen 1.5.9 -->
8 8 
<div class="navigation" id="top">
9 9 
  <div class="tabs">
10 10 
    <ul>
......
18 18 
</div>
19 19 
<div class="contents">
20 20 
<h1>Rangefinder</h1>Functions for using the IR rangefinders.
21 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
21 
<a href="#_details">More...</a>
22 
<p>
23 
<table border="0" cellpadding="0" cellspacing="0">
22 24 
<tr><td></td></tr>
23 25 
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
24 26 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" -->
......
41 43 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a>&nbsp;&nbsp;&nbsp;2</td></tr>
42 44 

  		




  43
  45
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IR Rangefinder 5. <br></td></tr>


  		




  
  46
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g65133481288b92545c8656c562ffa473"></a><!-- doxytag: member="rangefinder::MIN_IR_ADC8" ref="g65133481288b92545c8656c562ffa473" args="" -->


  		




  
  47
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g65133481288b92545c8656c562ffa473">MIN_IR_ADC8</a>&nbsp;&nbsp;&nbsp;20</td></tr>


  		




  
  48
  
    

  		




  
  49
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">smallest meaningful rangefinder reading (logarithmic scale) <br></td></tr>


  		




  
  50
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfcbaba8ea6729bf2e0ebcfdbcff0abb"></a><!-- doxytag: member="rangefinder::MAX_IR_ADC8" ref="gdfcbaba8ea6729bf2e0ebcfdbcff0abb" args="" -->


  		




  
  51
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#gdfcbaba8ea6729bf2e0ebcfdbcff0abb">MAX_IR_ADC8</a>&nbsp;&nbsp;&nbsp;133</td></tr>


  		




  
  52
  
    

  		




  
  53
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">largest meaningful rangefinder reading (logarithmic scale) <br></td></tr>


  		




  44
  54
  
    
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


  		




  45
  55
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a> (void)</td></tr>


  		




  46
  56
  
    

  		




  ......




  48
  58
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2">range_read_distance</a> (int range_id)</td></tr>


  		




  49
  59
  
    

  		




  50
  60
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the distance from a rangefinder.  <a href="#g22bd0717784e34cb3a0762d78554dcf2"></a><br></td></tr>


  		




  
  61
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g12e34a97ff38b9fa2e49026804cf420f">linearize_distance</a> (int value)</td></tr>


  		




  
  62
  
    

  		




  
  63
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert logarithmic-scale distance readings to a linear scale.  <a href="#g12e34a97ff38b9fa2e49026804cf420f"></a><br></td></tr>


  		




  51
  64
  
    
</table>


  		




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


  		




  53
  
  
    
Functions for using the IR rangefinders. 


  		




  
  66
  
    
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2>


  		




  
  67
  
    
<a class="anchor" name="g12e34a97ff38b9fa2e49026804cf420f"></a><!-- doxytag: member="rangefinder.c::linearize_distance" ref="g12e34a97ff38b9fa2e49026804cf420f" args="(int value)" -->


  		




  
  68
  
    
<div class="memitem">


  		




  
  69
  
    
<div class="memproto">


  		




  
  70
  
    
      <table class="memname">


  		




  
  71
  
    
        <tr>


  		




  
  72
  
    
          <td class="memname">int linearize_distance           </td>


  		




  
  73
  
    
          <td>(</td>


  		




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


  		




  
  75
  
    
          <td class="paramname"> <em>value</em>          </td>


  		




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


  		




  
  77
  
    
          <td></td>


  		




  
  78
  
    
        </tr>


  		




  
  79
  
    
      </table>


  		




  
  80
  
    
</div>


  		




  
  81
  
    
<div class="memdoc">


  		




  
  82
  
    

  		




  54
  83
  
    
<p>


  		




  55
  
  
    
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2>


  		




  
  84
  
    
Convert logarithmic-scale distance readings to a linear scale. 


  		




  
  85
  
    
<p>


  		




  
  86
  
    
Transforms distance readings from logarithmic to linear scale. This probably isn't the function you are looking for.<p>


  		




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


  		




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


  		




  
  89
  
    
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>the 8-bit analog value from rangefinder</td></tr>


  		




  
  90
  
    
  </table>


  		




  
  91
  
    
</dl>


  		




  
  92
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>linearized distance reading from rangefinder (integer in [101,800]) </dd></dl>


  		




  
  93
  
    

  		




  
  94
  
    
<p>References <a class="el" href="rangefinder_8h_source.html#l00058">MAX_IR_ADC8</a>, and <a class="el" href="rangefinder_8h_source.html#l00056">MIN_IR_ADC8</a>.</p>


  		




  
  95
  
    

  		




  
  96
  
    
<p>Referenced by <a class="el" href="rangefinder_8c_source.html#l00131">range_read_distance()</a>.</p>


  		




  
  97
  
    

  		




  
  98
  
    
</div>


  		




  
  99
  
    
</div><p>


  		




  56
  100
  
    
<a class="anchor" name="g52d0666b725e6d3a14b5bddc28190e59"></a><!-- doxytag: member="rangefinder.c::range_init" ref="g52d0666b725e6d3a14b5bddc28190e59" args="(void)" -->


  		




  57
  101
  
    
<div class="memitem">


  		




  58
  102
  
    
<div class="memproto">


  		




  ......




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


  		




  64
  108
  
    
          <td class="paramname">          </td>


  		




  65
  109
  
    
          <td>&nbsp;)&nbsp;</td>


  		




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


  		




  
  110
  
    
          <td></td>


  		




  67
  111
  
    
        </tr>


  		




  68
  112
  
    
      </table>


  		




  69
  113
  
    
</div>


  		




  ......




  75
  119
  
    
Initializes the rangefinders. This must be called before range_read_distance.<p>


  		




  76
  120
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2" title="Read the distance from a rangefinder.">range_read_distance</a> </dd></dl>


  		




  77
  121
  
    

  		




  78
  
  
    
<p>References <a class="el" href="dio_8h-source.html#l00096">_PIN_B4</a>, and <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>.</p>


  		




  
  122
  
    
<p>References <a class="el" href="dio_8h_source.html#l00096">_PIN_B4</a>, and <a class="el" href="dio_8c_source.html#l00162">digital_output()</a>.</p>


  		




  79
  123
  
    

  		




  80
  
  
    
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>


  		




  
  124
  
    
<p>Referenced by <a class="el" href="dragonfly__lib_8c_source.html#l00068">dragonfly_init()</a>.</p>


  		




  81
  125
  
    

  		




  82
  126
  
    
</div>


  		




  83
  127
  
    
</div><p>


  		




  ......




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


  		




  92
  136
  
    
          <td class="paramname"> <em>range_id</em>          </td>


  		




  93
  137
  
    
          <td>&nbsp;)&nbsp;</td>


  		




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


  		




  
  138
  
    
          <td></td>


  		




  95
  139
  
    
        </tr>


  		




  96
  140
  
    
      </table>


  		




  97
  141
  
    
</div>


  		




  ......




  109
  153
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the distance measured by the rangefinder</dd></dl>


  		




  110
  154
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59" title="Initialize the rangefinders.">range_init</a> </dd></dl>


  		




  111
  155
  
    

  		




  112
  
  
    
<p>References <a class="el" href="analog_8c-source.html#l00119">analog8()</a>.</p>


  		




  
  156
  
    
<p>References <a class="el" href="analog_8c_source.html#l00119">analog8()</a>, and <a class="el" href="rangefinder_8c_source.html#l00143">linearize_distance()</a>.</p>


  		




  113
  157
  
    

  		




  114
  
  
    
<p>Referenced by <a class="el" href="move_8c-source.html#l00107">move_avoid()</a>.</p>


  		




  
  158
  
    
<p>Referenced by <a class="el" href="move_8c_source.html#l00107">move_avoid()</a>.</p>


  		




  115
  159
  
    

  		




  116
  160
  
    
</div>


  		




  117
  161
  
    
</div><p>


  		




  118
  162
  
    
</div>


  		




  119
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:09 2009 for libdragonfly by&nbsp;


  		




  
  163
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;


  		




  120
  164
  
    
<a href="http://www.doxygen.org/index.html">


  		




  121
  
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>


  		




  
  165
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


  		




  122
  166
  
    
</body>


  		




  123
  167
  
    
</html>


  		












Also available in:  Unified diff