root / trunk / docs / libdragonfly / group__rangefinder.html @ 862
History | View | Annotate | Download (7.17 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: Rangefinder</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.5 -->
|
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><table border="0" cellpadding="0" cellspacing="0"> |
22 |
<tr><td></td></tr> |
23 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" --> |
25 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">IR1</a> 6</td></tr> |
26 |
|
27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 1. <br></td></tr> |
28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a08e4f5cb3582e623cc14a6c92d48de"></a><!-- doxytag: member="rangefinder::IR2" ref="g5a08e4f5cb3582e623cc14a6c92d48de" args="" --> |
29 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">IR2</a> 5</td></tr> |
30 |
|
31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 2. <br></td></tr> |
32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26c72d21cca0ec21af4bd9b20ba3ad51"></a><!-- doxytag: member="rangefinder::IR3" ref="g26c72d21cca0ec21af4bd9b20ba3ad51" args="" --> |
33 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">IR3</a> 4</td></tr> |
34 |
|
35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 3. <br></td></tr> |
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20f2f5908baa0eeba04b9ceaf718cea0"></a><!-- doxytag: member="rangefinder::IR4" ref="g20f2f5908baa0eeba04b9ceaf718cea0" args="" --> |
37 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">IR4</a> 3</td></tr> |
38 |
|
39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 4. <br></td></tr> |
40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23554754d5334bdc35df623e1e012ede"></a><!-- doxytag: member="rangefinder::IR5" ref="g23554754d5334bdc35df623e1e012ede" args="" --> |
41 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a> 2</td></tr> |
42 |
|
43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 5. <br></td></tr> |
44 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a> (void)</td></tr> |
46 |
|
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <a href="#g52d0666b725e6d3a14b5bddc28190e59"></a><br></td></tr> |
48 |
<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> |
49 |
|
50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the distance from a rangefinder. <a href="#g22bd0717784e34cb3a0762d78554dcf2"></a><br></td></tr> |
51 |
</table>
|
52 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
53 |
Functions for using the IR rangefinders. |
54 |
<p>
|
55 |
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2> |
56 |
<a class="anchor" name="g52d0666b725e6d3a14b5bddc28190e59"></a><!-- doxytag: member="rangefinder.c::range_init" ref="g52d0666b725e6d3a14b5bddc28190e59" args="(void)" --> |
57 |
<div class="memitem"> |
58 |
<div class="memproto"> |
59 |
<table class="memname"> |
60 |
<tr>
|
61 |
<td class="memname">void range_init </td> |
62 |
<td>(</td> |
63 |
<td class="paramtype">void </td> |
64 |
<td class="paramname"> </td> |
65 |
<td> ) </td> |
66 |
<td width="100%"></td> |
67 |
</tr>
|
68 |
</table>
|
69 |
</div>
|
70 |
<div class="memdoc"> |
71 |
|
72 |
<p>
|
73 |
Initialize the rangefinders. |
74 |
<p>
|
75 |
Initializes the rangefinders. This must be called before range_read_distance.<p>
|
76 |
<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 |
|
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> |
79 |
|
80 |
</div>
|
81 |
</div><p> |
82 |
<a class="anchor" name="g22bd0717784e34cb3a0762d78554dcf2"></a><!-- doxytag: member="rangefinder.c::range_read_distance" ref="g22bd0717784e34cb3a0762d78554dcf2" args="(int range_id)" --> |
83 |
<div class="memitem"> |
84 |
<div class="memproto"> |
85 |
<table class="memname"> |
86 |
<tr>
|
87 |
<td class="memname">int range_read_distance </td> |
88 |
<td>(</td> |
89 |
<td class="paramtype">int </td> |
90 |
<td class="paramname"> <em>range_id</em> </td> |
91 |
<td> ) </td> |
92 |
<td width="100%"></td> |
93 |
</tr>
|
94 |
</table>
|
95 |
</div>
|
96 |
<div class="memdoc"> |
97 |
|
98 |
<p>
|
99 |
Read the distance from a rangefinder. |
100 |
<p>
|
101 |
Reads the distance measured by one of the rangefinders. This distance is in arbitrary units.<p>
|
102 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
103 |
<table border="0" cellspacing="2" cellpadding="0"> |
104 |
<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> |
105 |
</table>
|
106 |
</dl>
|
107 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the distance measured by the rangefinder</dd></dl> |
108 |
<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> |
109 |
|
110 |
<p>References <a class="el" href="analog_8c-source.html#l00119">analog8()</a>.</p> |
111 |
|
112 |
<p>Referenced by <a class="el" href="move_8c-source.html#l00107">move_avoid()</a>.</p> |
113 |
|
114 |
</div>
|
115 |
</div><p> |
116 |
</div>
|
117 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by |
118 |
<a href="http://www.doxygen.org/index.html"> |
119 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
120 |
</body>
|
121 |
</html>
|