root / branches / wireless / docs / libdragonfly / html / group__rangefinder.html @ 1578
History | View | Annotate | Download (9.61 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>Colony: Rangefinder</title> |
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.8 -->
|
8 |
<div class="navigation" id="top"> |
9 |
<div class="tabs"> |
10 |
<ul>
|
11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
15 |
<li><a href="files.html"><span>Files</span></a></li> |
16 |
</ul>
|
17 |
</div>
|
18 |
</div>
|
19 |
<div class="contents"> |
20 |
<h1>Rangefinder</h1>Functions for using the IR rangefinders. |
21 |
<a href="#_details">More...</a> |
22 |
<p>
|
23 |
<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="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" --> |
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">IR1</a> 6</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 1. <br></td></tr> |
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a08e4f5cb3582e623cc14a6c92d48de"></a><!-- doxytag: member="rangefinder::IR2" ref="g5a08e4f5cb3582e623cc14a6c92d48de" args="" --> |
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">IR2</a> 5</td></tr> |
32 |
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 2. <br></td></tr> |
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26c72d21cca0ec21af4bd9b20ba3ad51"></a><!-- doxytag: member="rangefinder::IR3" ref="g26c72d21cca0ec21af4bd9b20ba3ad51" args="" --> |
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">IR3</a> 4</td></tr> |
36 |
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 3. <br></td></tr> |
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20f2f5908baa0eeba04b9ceaf718cea0"></a><!-- doxytag: member="rangefinder::IR4" ref="g20f2f5908baa0eeba04b9ceaf718cea0" args="" --> |
39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">IR4</a> 3</td></tr> |
40 |
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 4. <br></td></tr> |
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23554754d5334bdc35df623e1e012ede"></a><!-- doxytag: member="rangefinder::IR5" ref="g23554754d5334bdc35df623e1e012ede" args="" --> |
43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a> 2</td></tr> |
44 |
|
45 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g65133481288b92545c8656c562ffa473">MIN_IR_ADC8</a> 20</td></tr> |
48 |
|
49 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#gdfcbaba8ea6729bf2e0ebcfdbcff0abb">MAX_IR_ADC8</a> 133</td></tr> |
52 |
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">largest meaningful rangefinder reading (logarithmic scale) <br></td></tr> |
54 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#ge692e1187d2e8de2a213780478be131d">range_init</a> (void)</td></tr> |
56 |
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <a href="#ge692e1187d2e8de2a213780478be131d"></a><br></td></tr> |
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2">range_read_distance</a> (int range_id)</td></tr> |
59 |
|
60 |
<tr><td class="mdescLeft"> </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 </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"> </td><td class="mdescRight">Convert logarithmic-scale distance readings to a linear scale. <a href="#g12e34a97ff38b9fa2e49026804cf420f"></a><br></td></tr> |
64 |
</table>
|
65 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
66 |
Functions for using the IR rangefinders. |
67 |
<p>
|
68 |
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2> |
69 |
<a class="anchor" name="g12e34a97ff38b9fa2e49026804cf420f"></a><!-- doxytag: member="rangefinder.c::linearize_distance" ref="g12e34a97ff38b9fa2e49026804cf420f" args="(int value)" --> |
70 |
<div class="memitem"> |
71 |
<div class="memproto"> |
72 |
<table class="memname"> |
73 |
<tr>
|
74 |
<td class="memname">int linearize_distance </td> |
75 |
<td>(</td> |
76 |
<td class="paramtype">int </td> |
77 |
<td class="paramname"> <em>value</em> </td> |
78 |
<td> ) </td> |
79 |
<td></td> |
80 |
</tr>
|
81 |
</table>
|
82 |
</div>
|
83 |
<div class="memdoc"> |
84 |
|
85 |
<p>
|
86 |
Convert logarithmic-scale distance readings to a linear scale. |
87 |
<p>
|
88 |
Transforms distance readings from logarithmic to linear scale. This probably isn't the function you are looking for.<p>
|
89 |
Note: pgm_read_word() needs additional testing<p>
|
90 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
91 |
<table border="0" cellspacing="2" cellpadding="0"> |
92 |
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the 8-bit analog value from rangefinder</td></tr> |
93 |
</table>
|
94 |
</dl>
|
95 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>linearized distance reading from rangefinder (integer in [101,800]) </dd></dl> |
96 |
|
97 |
</div>
|
98 |
</div><p> |
99 |
<a class="anchor" name="ge692e1187d2e8de2a213780478be131d"></a><!-- doxytag: member="rangefinder.c::range_init" ref="ge692e1187d2e8de2a213780478be131d" args="(void)" --> |
100 |
<div class="memitem"> |
101 |
<div class="memproto"> |
102 |
<table class="memname"> |
103 |
<tr>
|
104 |
<td class="memname">int range_init </td> |
105 |
<td>(</td> |
106 |
<td class="paramtype">void </td> |
107 |
<td class="paramname"> </td> |
108 |
<td> ) </td> |
109 |
<td></td> |
110 |
</tr>
|
111 |
</table>
|
112 |
</div>
|
113 |
<div class="memdoc"> |
114 |
|
115 |
<p>
|
116 |
Initialize the rangefinders. |
117 |
<p>
|
118 |
Initializes the rangefinders. This must be called before range_read_distance.<p>
|
119 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if init succesfull, an error code otherwise</dd></dl> |
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> |
121 |
|
122 |
</div>
|
123 |
</div><p> |
124 |
<a class="anchor" name="g22bd0717784e34cb3a0762d78554dcf2"></a><!-- doxytag: member="rangefinder.c::range_read_distance" ref="g22bd0717784e34cb3a0762d78554dcf2" args="(int range_id)" --> |
125 |
<div class="memitem"> |
126 |
<div class="memproto"> |
127 |
<table class="memname"> |
128 |
<tr>
|
129 |
<td class="memname">int range_read_distance </td> |
130 |
<td>(</td> |
131 |
<td class="paramtype">int </td> |
132 |
<td class="paramname"> <em>range_id</em> </td> |
133 |
<td> ) </td> |
134 |
<td></td> |
135 |
</tr>
|
136 |
</table>
|
137 |
</div>
|
138 |
<div class="memdoc"> |
139 |
|
140 |
<p>
|
141 |
Read the distance from a rangefinder. |
142 |
<p>
|
143 |
Reads the distance measured by one of the rangefinders. This distance is in arbitrary units.<p>
|
144 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
145 |
<table border="0" cellspacing="2" cellpadding="0"> |
146 |
<tr><td valign="top"></td><td valign="top"><em>range_id</em> </td><td>the rangefinder to use. This should be one of the constants IR1 - IR5.</td></tr> |
147 |
</table>
|
148 |
</dl>
|
149 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the distance measured by the rangefinder, or an error code</dd></dl> |
150 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#ge692e1187d2e8de2a213780478be131d" title="Initialize the rangefinders.">range_init</a> </dd></dl> |
151 |
|
152 |
</div>
|
153 |
</div><p> |
154 |
</div>
|
155 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:59 2009 for Colony by |
156 |
<a href="http://www.doxygen.org/index.html"> |
157 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
158 |
</body>
|
159 |
</html>
|