Revision 79
tried to merge lib_additions again...
branches/lib_additions/docs/lib/libdragonfly/globals_0x69.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Data Fields</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li id="current"><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<div class="tabs"> |
|
20 |
<ul> |
|
21 |
<li id="current"><a href="globals.html"><span>All</span></a></li> |
|
22 |
<li><a href="globals_func.html"><span>Functions</span></a></li> |
|
23 |
<li><a href="globals_defs.html"><span>Defines</span></a></li> |
|
24 |
</ul> |
|
25 |
</div> |
|
26 |
<div class="tabs"> |
|
27 |
<ul> |
|
28 |
<li><a href="globals.html#index__"><span>_</span></a></li> |
|
29 |
<li><a href="globals_0x61.html#index_a"><span>a</span></a></li> |
|
30 |
<li><a href="globals_0x62.html#index_b"><span>b</span></a></li> |
|
31 |
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li> |
|
32 |
<li><a href="globals_0x64.html#index_d"><span>d</span></a></li> |
|
33 |
<li><a href="globals_0x65.html#index_e"><span>e</span></a></li> |
|
34 |
<li><a href="globals_0x66.html#index_f"><span>f</span></a></li> |
|
35 |
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li> |
|
36 |
<li><a href="globals_0x68.html#index_h"><span>h</span></a></li> |
|
37 |
<li id="current"><a href="globals_0x69.html#index_i"><span>i</span></a></li> |
|
38 |
<li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> |
|
39 |
<li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> |
|
40 |
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> |
|
41 |
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> |
|
42 |
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li> |
|
43 |
<li><a href="globals_0x71.html#index_q"><span>q</span></a></li> |
|
44 |
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li> |
|
45 |
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li> |
|
46 |
<li><a href="globals_0x74.html#index_t"><span>t</span></a></li> |
|
47 |
<li><a href="globals_0x75.html#index_u"><span>u</span></a></li> |
|
48 |
<li><a href="globals_0x77.html#index_w"><span>w</span></a></li> |
|
49 |
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li> |
|
50 |
<li><a href="globals_0x79.html#index_y"><span>y</span></a></li> |
|
51 |
</ul> |
|
52 |
</div> |
|
53 |
|
|
54 |
<p> |
|
55 |
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: |
|
56 |
<p> |
|
57 |
<h3><a class="anchor" name="index_i">- i -</a></h3><ul> |
|
58 |
<li>I2C |
|
59 |
: <a class="el" href="group__dragonfly.html#g457a9aa93dbb216459873a30bdb4d84a">dragonfly_lib.h</a><li>IR1 |
|
60 |
: <a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">rangefinder.h</a><li>IR2 |
|
61 |
: <a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">rangefinder.h</a><li>IR3 |
|
62 |
: <a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">rangefinder.h</a><li>IR4 |
|
63 |
: <a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">rangefinder.h</a><li>IR5 |
|
64 |
: <a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">rangefinder.h</a></ul> |
|
65 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
66 |
<a href="http://www.doxygen.org/index.html"> |
|
67 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
68 |
</body> |
|
69 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/globals_defs_0x68.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Data Fields</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li id="current"><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<div class="tabs"> |
|
20 |
<ul> |
|
21 |
<li><a href="globals.html"><span>All</span></a></li> |
|
22 |
<li><a href="globals_func.html"><span>Functions</span></a></li> |
|
23 |
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li> |
|
24 |
</ul> |
|
25 |
</div> |
|
26 |
<div class="tabs"> |
|
27 |
<ul> |
|
28 |
<li><a href="globals_defs.html#index__"><span>_</span></a></li> |
|
29 |
<li><a href="globals_defs_0x61.html#index_a"><span>a</span></a></li> |
|
30 |
<li><a href="globals_defs_0x62.html#index_b"><span>b</span></a></li> |
|
31 |
<li><a href="globals_defs_0x63.html#index_c"><span>c</span></a></li> |
|
32 |
<li><a href="globals_defs_0x64.html#index_d"><span>d</span></a></li> |
|
33 |
<li><a href="globals_defs_0x65.html#index_e"><span>e</span></a></li> |
|
34 |
<li><a href="globals_defs_0x66.html#index_f"><span>f</span></a></li> |
|
35 |
<li><a href="globals_defs_0x67.html#index_g"><span>g</span></a></li> |
|
36 |
<li id="current"><a href="globals_defs_0x68.html#index_h"><span>h</span></a></li> |
|
37 |
<li><a href="globals_defs_0x69.html#index_i"><span>i</span></a></li> |
|
38 |
<li><a href="globals_defs_0x6c.html#index_l"><span>l</span></a></li> |
|
39 |
<li><a href="globals_defs_0x6d.html#index_m"><span>m</span></a></li> |
|
40 |
<li><a href="globals_defs_0x6e.html#index_n"><span>n</span></a></li> |
|
41 |
<li><a href="globals_defs_0x6f.html#index_o"><span>o</span></a></li> |
|
42 |
<li><a href="globals_defs_0x70.html#index_p"><span>p</span></a></li> |
|
43 |
<li><a href="globals_defs_0x71.html#index_q"><span>q</span></a></li> |
|
44 |
<li><a href="globals_defs_0x72.html#index_r"><span>r</span></a></li> |
|
45 |
<li><a href="globals_defs_0x73.html#index_s"><span>s</span></a></li> |
|
46 |
<li><a href="globals_defs_0x74.html#index_t"><span>t</span></a></li> |
|
47 |
<li><a href="globals_defs_0x75.html#index_u"><span>u</span></a></li> |
|
48 |
<li><a href="globals_defs_0x77.html#index_w"><span>w</span></a></li> |
|
49 |
<li><a href="globals_defs_0x78.html#index_x"><span>x</span></a></li> |
|
50 |
<li><a href="globals_defs_0x79.html#index_y"><span>y</span></a></li> |
|
51 |
</ul> |
|
52 |
</div> |
|
53 |
|
|
54 |
<p> |
|
55 |
|
|
56 |
<p> |
|
57 |
<h3><a class="anchor" name="index_h">- h -</a></h3><ul> |
|
58 |
<li>HALF_SECOND |
|
59 |
: <a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">time.h</a><li>HALF_SPD |
|
60 |
: <a class="el" href="group__move.html#ga0dd7c6a61a43fb8a3698988c414a9bf">move.h</a></ul> |
|
61 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
62 |
<a href="http://www.doxygen.org/index.html"> |
|
63 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
64 |
</body> |
|
65 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/group__time.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Time</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<h1>Time</h1>Time functions. |
|
15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
16 |
<tr><td></td></tr> |
|
17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd271145628da4e0e85e3e2486d117713"></a><!-- doxytag: member="time::SIXTEENTH_SECOND" ref="gd271145628da4e0e85e3e2486d117713" args="" --> |
|
19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gd271145628da4e0e85e3e2486d117713">SIXTEENTH_SECOND</a> 1</td></tr> |
|
20 |
|
|
21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A sixteenth of a second. <br></td></tr> |
|
22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7bdae984203001070e9abeb3190f844a"></a><!-- doxytag: member="time::EIGTH_SECOND" ref="g7bdae984203001070e9abeb3190f844a" args="" --> |
|
23 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g7bdae984203001070e9abeb3190f844a">EIGTH_SECOND</a> 2</td></tr> |
|
24 |
|
|
25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">An eighth of a second. <br></td></tr> |
|
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b2a348d9afca1f1182bc2bb2aa6a3d1"></a><!-- doxytag: member="time::QUARTER_SECOND" ref="g0b2a348d9afca1f1182bc2bb2aa6a3d1" args="" --> |
|
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g0b2a348d9afca1f1182bc2bb2aa6a3d1">QUARTER_SECOND</a> 4</td></tr> |
|
28 |
|
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A quarter of a second. <br></td></tr> |
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf95f27544f39827250d6bef6fa5fe18e"></a><!-- doxytag: member="time::HALF_SECOND" ref="gf95f27544f39827250d6bef6fa5fe18e" args="" --> |
|
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">HALF_SECOND</a> 8</td></tr> |
|
32 |
|
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Half of a second. <br></td></tr> |
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g94212be2394d2d37d9dfd33d07d82dba"></a><!-- doxytag: member="time::SECOND" ref="g94212be2394d2d37d9dfd33d07d82dba" args="" --> |
|
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g94212be2394d2d37d9dfd33d07d82dba">SECOND</a> 16</td></tr> |
|
36 |
|
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">One second. <br></td></tr> |
|
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c2dc0c899e1571596205f29fcc35cd6"></a><!-- doxytag: member="time::TWO_SECOND" ref="g4c2dc0c899e1571596205f29fcc35cd6" args="" --> |
|
39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4c2dc0c899e1571596205f29fcc35cd6">TWO_SECOND</a> 32</td></tr> |
|
40 |
|
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Two seconds. <br></td></tr> |
|
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g335312d1eed285bbc48a7f383ad78d97"></a><!-- doxytag: member="time::FOUR_SECOND" ref="g335312d1eed285bbc48a7f383ad78d97" args="" --> |
|
43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g335312d1eed285bbc48a7f383ad78d97">FOUR_SECOND</a> 64</td></tr> |
|
44 |
|
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Four seconds. <br></td></tr> |
|
46 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d">delay_ms</a> (int ms)</td></tr> |
|
48 |
|
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delay execution for the specified time. <a href="#g8aa473f8ae9a91df4bc9ea700983c72d"></a><br></td></tr> |
|
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a> (int prescale_opt, void(*rtc_func)(void))</td></tr> |
|
51 |
|
|
52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the realtime clock. <a href="#g4b8a034dd8e994f4a1af612806f7c553"></a><br></td></tr> |
|
53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> (void)</td></tr> |
|
54 |
|
|
55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the realtime clock. <a href="#g5c7f2bf39314463dd5f4913e05ca991d"></a><br></td></tr> |
|
56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> (void)</td></tr> |
|
57 |
|
|
58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the counter of the realtime clock. <a href="#g83ae542199d1c0e964aff89537d686a3"></a><br></td></tr> |
|
59 |
</table> |
|
60 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
61 |
Time functions. |
|
62 |
<p> |
|
63 |
Functions dealing with time. <hr><h2>Function Documentation</h2> |
|
64 |
<a class="anchor" name="g8aa473f8ae9a91df4bc9ea700983c72d"></a><!-- doxytag: member="time.c::delay_ms" ref="g8aa473f8ae9a91df4bc9ea700983c72d" args="(int ms)" --><p> |
|
65 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
66 |
<tr> |
|
67 |
<td class="mdRow"> |
|
68 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
69 |
<tr> |
|
70 |
<td class="md" nowrap valign="top">void delay_ms </td> |
|
71 |
<td class="md" valign="top">( </td> |
|
72 |
<td class="md" nowrap valign="top">int </td> |
|
73 |
<td class="mdname1" valign="top" nowrap> <em>ms</em> </td> |
|
74 |
<td class="md" valign="top"> ) </td> |
|
75 |
<td class="md" nowrap></td> |
|
76 |
</tr> |
|
77 |
</table> |
|
78 |
</td> |
|
79 |
</tr> |
|
80 |
</table> |
|
81 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
82 |
<tr> |
|
83 |
<td> |
|
84 |
|
|
85 |
</td> |
|
86 |
<td> |
|
87 |
|
|
88 |
<p> |
|
89 |
Delay execution for the specified time. |
|
90 |
<p> |
|
91 |
Delays for the specified number of milliseconds. The accuracy of this function is unknown.<p> |
|
92 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
93 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
94 |
<tr><td valign="top"></td><td valign="top"><em>ms</em> </td><td>the number of milliseconds to delay for </td></tr> |
|
95 |
</table> |
|
96 |
</dl> |
|
97 |
</td> |
|
98 |
</tr> |
|
99 |
</table> |
|
100 |
<a class="anchor" name="g5c7f2bf39314463dd5f4913e05ca991d"></a><!-- doxytag: member="time.c::rtc_get" ref="g5c7f2bf39314463dd5f4913e05ca991d" args="(void)" --><p> |
|
101 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
102 |
<tr> |
|
103 |
<td class="mdRow"> |
|
104 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
105 |
<tr> |
|
106 |
<td class="md" nowrap valign="top">int rtc_get </td> |
|
107 |
<td class="md" valign="top">( </td> |
|
108 |
<td class="md" nowrap valign="top">void </td> |
|
109 |
<td class="mdname1" valign="top" nowrap> </td> |
|
110 |
<td class="md" valign="top"> ) </td> |
|
111 |
<td class="md" nowrap></td> |
|
112 |
</tr> |
|
113 |
</table> |
|
114 |
</td> |
|
115 |
</tr> |
|
116 |
</table> |
|
117 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
118 |
<tr> |
|
119 |
<td> |
|
120 |
|
|
121 |
</td> |
|
122 |
<td> |
|
123 |
|
|
124 |
<p> |
|
125 |
Get the value of the realtime clock. |
|
126 |
<p> |
|
127 |
Returns the time elapsed in seconds since the last call to rtc_init or rtc_reset.<p> |
|
128 |
<dl compact><dt><b>Returns:</b></dt><dd>the number of seconds since the last call to rtc_init or rtc_reset</dd></dl> |
|
129 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a>, <a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> </dd></dl> |
|
130 |
</td> |
|
131 |
</tr> |
|
132 |
</table> |
|
133 |
<a class="anchor" name="g4b8a034dd8e994f4a1af612806f7c553"></a><!-- doxytag: member="time.c::rtc_init" ref="g4b8a034dd8e994f4a1af612806f7c553" args="(int prescale_opt, void(*rtc_func)(void))" --><p> |
|
134 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
135 |
<tr> |
|
136 |
<td class="mdRow"> |
|
137 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
138 |
<tr> |
|
139 |
<td class="md" nowrap valign="top">void rtc_init </td> |
|
140 |
<td class="md" valign="top">( </td> |
|
141 |
<td class="md" nowrap valign="top">int </td> |
|
142 |
<td class="mdname" nowrap> <em>prescale_opt</em>, </td> |
|
143 |
</tr> |
|
144 |
<tr> |
|
145 |
<td class="md" nowrap align="right"></td> |
|
146 |
<td class="md"></td> |
|
147 |
<td class="md" nowrap>void(*)(void) </td> |
|
148 |
<td class="mdname" nowrap> <em>rtc_func</em></td> |
|
149 |
</tr> |
|
150 |
<tr> |
|
151 |
<td class="md"></td> |
|
152 |
<td class="md">) </td> |
|
153 |
<td class="md" colspan="2"></td> |
|
154 |
</tr> |
|
155 |
</table> |
|
156 |
</td> |
|
157 |
</tr> |
|
158 |
</table> |
|
159 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
160 |
<tr> |
|
161 |
<td> |
|
162 |
|
|
163 |
</td> |
|
164 |
<td> |
|
165 |
|
|
166 |
<p> |
|
167 |
Enable the realtime clock. |
|
168 |
<p> |
|
169 |
Initializes the real time clock. Prescales are defined in <a class="el" href="time_8h.html">time.h</a>. For example, SECOND will give 1 second. The specified function is called every clock tick. For the real time clock to activate, interrupts must be enabled. (through sei() )<p> |
|
170 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
171 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
172 |
<tr><td valign="top"></td><td valign="top"><em>prescale_opt</em> </td><td>the period with which the timer is triggered </td></tr> |
|
173 |
<tr><td valign="top"></td><td valign="top"><em>rtc_func</em> </td><td>the function called when the timer is triggered</td></tr> |
|
174 |
</table> |
|
175 |
</dl> |
|
176 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a>, <a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> </dd></dl> |
|
177 |
</td> |
|
178 |
</tr> |
|
179 |
</table> |
|
180 |
<a class="anchor" name="g83ae542199d1c0e964aff89537d686a3"></a><!-- doxytag: member="time.c::rtc_reset" ref="g83ae542199d1c0e964aff89537d686a3" args="(void)" --><p> |
|
181 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
182 |
<tr> |
|
183 |
<td class="mdRow"> |
|
184 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
185 |
<tr> |
|
186 |
<td class="md" nowrap valign="top">void rtc_reset </td> |
|
187 |
<td class="md" valign="top">( </td> |
|
188 |
<td class="md" nowrap valign="top">void </td> |
|
189 |
<td class="mdname1" valign="top" nowrap> </td> |
|
190 |
<td class="md" valign="top"> ) </td> |
|
191 |
<td class="md" nowrap></td> |
|
192 |
</tr> |
|
193 |
</table> |
|
194 |
</td> |
|
195 |
</tr> |
|
196 |
</table> |
|
197 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
198 |
<tr> |
|
199 |
<td> |
|
200 |
|
|
201 |
</td> |
|
202 |
<td> |
|
203 |
|
|
204 |
<p> |
|
205 |
Reset the counter of the realtime clock. |
|
206 |
<p> |
|
207 |
Resets the real time clock counter to 0.<p> |
|
208 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a>, <a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> </dd></dl> |
|
209 |
</td> |
|
210 |
</tr> |
|
211 |
</table> |
|
212 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
213 |
<a href="http://www.doxygen.org/index.html"> |
|
214 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
215 |
</body> |
|
216 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/serial_8h-source.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: serial.h Source File</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<h1>serial.h</h1><a href="serial_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
|
20 |
<a name="l00012"></a>00012 <span class="comment">/*</span> |
|
21 |
<a name="l00013"></a>00013 <span class="comment"> serial.h - Contains definitions and function prototypes for the RS232 serial port</span> |
|
22 |
<a name="l00014"></a>00014 <span class="comment"> author(s): pkv</span> |
|
23 |
<a name="l00015"></a>00015 <span class="comment"> </span> |
|
24 |
<a name="l00016"></a>00016 <span class="comment"> Directions:</span> |
|
25 |
<a name="l00017"></a>00017 <span class="comment"> Call the initialization function for the serial port you wish to use. Then, use</span> |
|
26 |
<a name="l00018"></a>00018 <span class="comment"> either the provided functions or the stdio functions (fprintf, etc) to read and</span> |
|
27 |
<a name="l00019"></a>00019 <span class="comment"> write characters to the serial ports.</span> |
|
28 |
<a name="l00020"></a>00020 <span class="comment"> </span> |
|
29 |
<a name="l00021"></a>00021 <span class="comment"> UART Mapping:</span> |
|
30 |
<a name="l00022"></a>00022 <span class="comment"> usb_*() -> UART0</span> |
|
31 |
<a name="l00023"></a>00023 <span class="comment"> xbee_*() -> UART1</span> |
|
32 |
<a name="l00024"></a>00024 <span class="comment"> </span> |
|
33 |
<a name="l00025"></a>00025 <span class="comment"> Options: (Add the following defines to your code to configure this library)</span> |
|
34 |
<a name="l00026"></a>00026 <span class="comment"> #define USB_BAUD { 115200 | 9600 } <= pick ONE value from in here</span> |
|
35 |
<a name="l00027"></a>00027 <span class="comment"> #define XBEE_BAUD { 115200 | 9600 } <= pick ONE value from in here</span> |
|
36 |
<a name="l00028"></a>00028 <span class="comment"> #define USE_STDIO</span> |
|
37 |
<a name="l00029"></a>00029 <span class="comment"> </span> |
|
38 |
<a name="l00030"></a>00030 <span class="comment"> Note: If you enable USE_STDIO, the first init function that is called will </span> |
|
39 |
<a name="l00031"></a>00031 <span class="comment"> automatically be linked to stdin, stdout, and stderr. To use the baud rate </span> |
|
40 |
<a name="l00032"></a>00032 <span class="comment"> commands, add something like the following to your code:</span> |
|
41 |
<a name="l00033"></a>00033 <span class="comment"> </span> |
|
42 |
<a name="l00034"></a>00034 <span class="comment"> #define FOO_BAUD 9600</span> |
|
43 |
<a name="l00035"></a>00035 <span class="comment"> </span> |
|
44 |
<a name="l00036"></a>00036 <span class="comment"> **UNLESS YOU KNOW WHAT YOU ARE DOING, PLEASE DO NOT CHANGE THIS FILE**</span> |
|
45 |
<a name="l00037"></a>00037 <span class="comment"> Many, many other people use this file in their code. If you change it, you will</span> |
|
46 |
<a name="l00038"></a>00038 <span class="comment"> probably break all of their nice code. You should not need to change anything in</span> |
|
47 |
<a name="l00039"></a>00039 <span class="comment"> here, except to accomodate new hardware.</span> |
|
48 |
<a name="l00040"></a>00040 <span class="comment">*/</span> |
|
49 |
<a name="l00041"></a>00041 |
|
50 |
<a name="l00042"></a>00042 <span class="preprocessor">#ifndef _SERIAL_H</span> |
|
51 |
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define _SERIAL_H</span> |
|
52 |
<a name="l00044"></a>00044 <span class="preprocessor"></span> |
|
53 |
<a name="l00054"></a>00054 <span class="comment">// if no baud rate is defined for usb, default is set here</span> |
|
54 |
<a name="l00055"></a>00055 <span class="preprocessor">#ifndef USB_BAUD</span> |
|
55 |
<a name="l00056"></a>00056 <span class="preprocessor"></span> |
|
56 |
<a name="l00057"></a><a class="code" href="group__usb.html#g378065b4d75b008228ee41cc335474a7">00057</a> <span class="preprocessor">#define USB_BAUD 115200</span> |
|
57 |
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#endif</span> |
|
58 |
<a name="l00059"></a>00059 <span class="preprocessor"></span> |
|
59 |
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d">usb_init</a>(<span class="keywordtype">void</span>); |
|
60 |
<a name="l00063"></a>00063 <span class="keywordtype">int</span> <a class="code" href="group__usb.html#g3ee898cfe59d05c428c56021c2ccf946">usb_putc</a>(<span class="keywordtype">char</span> c); |
|
61 |
<a name="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="group__usb.html#g053a5d887edfe8e8be543ec53a3f60ae">usb_getc</a>(<span class="keywordtype">void</span>); |
|
62 |
<a name="l00067"></a>00067 <span class="keywordtype">int</span> <a class="code" href="group__usb.html#g6b1209b19e7fd2bbedc7407e0218453c">usb_getc_nb</a>(<span class="keywordtype">char</span> *c); |
|
63 |
<a name="l00069"></a>00069 <span class="keywordtype">int</span> <a class="code" href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0">usb_puts</a>(<span class="keywordtype">char</span> *s); |
|
64 |
<a name="l00071"></a>00071 <span class="keywordtype">int</span> <a class="code" href="group__usb.html#gcd371dedbff10f0c52dca4b3b7af9e3d">usb_puti</a>(<span class="keywordtype">int</span> value); |
|
65 |
<a name="l00072"></a>00072 <span class="comment">//end addtogroup</span> |
|
66 |
<a name="l00074"></a>00074 |
|
67 |
<a name="l00084"></a>00084 <span class="comment">// if no baud rate is defined for usb, default is set here</span> |
|
68 |
<a name="l00085"></a>00085 |
|
69 |
<a name="l00086"></a>00086 <span class="comment">// if no baud rate is defined for xbee, default is set here</span> |
|
70 |
<a name="l00087"></a>00087 <span class="preprocessor">#ifndef XBEE_BAUD</span> |
|
71 |
<a name="l00088"></a>00088 <span class="preprocessor"></span> |
|
72 |
<a name="l00089"></a><a class="code" href="group__xbee.html#g7125fc8f3df24a2db8e074983206b054">00089</a> <span class="preprocessor">#define XBEE_BAUD 9600</span> |
|
73 |
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#endif</span> |
|
74 |
<a name="l00091"></a>00091 <span class="preprocessor"></span> |
|
75 |
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107">xbee_init</a>(<span class="keywordtype">void</span>); |
|
76 |
<a name="l00095"></a>00095 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g70c6b231330312d4f69b9a8afb5af989">xbee_putc</a>(<span class="keywordtype">char</span> c); |
|
77 |
<a name="l00097"></a>00097 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g1f468ae159ba5d97bdfb3f4855d15d88">xbee_getc</a>(<span class="keywordtype">void</span>); |
|
78 |
<a name="l00099"></a>00099 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#gfb7bd5dd535e8251bfff78854c6c15f2">xbee_getc_nb</a>(<span class="keywordtype">char</span> *c); |
|
79 |
<a name="l00100"></a>00100 <span class="comment">//end addtogroup</span> |
|
80 |
<a name="l00102"></a>00102 |
|
81 |
<a name="l00103"></a>00103 <span class="preprocessor">#endif</span> |
|
82 |
<a name="l00104"></a>00104 <span class="preprocessor"></span> |
|
83 |
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
84 |
<a href="http://www.doxygen.org/index.html"> |
|
85 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
86 |
</body> |
|
87 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/tabs.css | ||
---|---|---|
1 |
/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ |
|
2 |
|
|
3 |
DIV.tabs |
|
4 |
{ |
|
5 |
float : left; |
|
6 |
width : 100%; |
|
7 |
background : url("tab_b.gif") repeat-x bottom; |
|
8 |
margin-bottom : 4px; |
|
9 |
} |
|
10 |
|
|
11 |
DIV.tabs UL |
|
12 |
{ |
|
13 |
margin : 0px; |
|
14 |
padding-left : 10px; |
|
15 |
list-style : none; |
|
16 |
} |
|
17 |
|
|
18 |
DIV.tabs LI, DIV.tabs FORM |
|
19 |
{ |
|
20 |
display : inline; |
|
21 |
margin : 0px; |
|
22 |
padding : 0px; |
|
23 |
} |
|
24 |
|
|
25 |
DIV.tabs FORM |
|
26 |
{ |
|
27 |
float : right; |
|
28 |
} |
|
29 |
|
|
30 |
DIV.tabs A |
|
31 |
{ |
|
32 |
float : left; |
|
33 |
background : url("tab_r.gif") no-repeat right top; |
|
34 |
border-bottom : 1px solid #84B0C7; |
|
35 |
font-size : x-small; |
|
36 |
font-weight : bold; |
|
37 |
text-decoration : none; |
|
38 |
} |
|
39 |
|
|
40 |
DIV.tabs A:hover |
|
41 |
{ |
|
42 |
background-position: 100% -150px; |
|
43 |
} |
|
44 |
|
|
45 |
DIV.tabs A:link, DIV.tabs A:visited, |
|
46 |
DIV.tabs A:active, DIV.tabs A:hover |
|
47 |
{ |
|
48 |
color: #1A419D; |
|
49 |
} |
|
50 |
|
|
51 |
DIV.tabs SPAN |
|
52 |
{ |
|
53 |
float : left; |
|
54 |
display : block; |
|
55 |
background : url("tab_l.gif") no-repeat left top; |
|
56 |
padding : 5px 9px; |
|
57 |
white-space : nowrap; |
|
58 |
} |
|
59 |
|
|
60 |
DIV.tabs INPUT |
|
61 |
{ |
|
62 |
float : right; |
|
63 |
display : inline; |
|
64 |
font-size : 1em; |
|
65 |
} |
|
66 |
|
|
67 |
DIV.tabs TD |
|
68 |
{ |
|
69 |
font-size : x-small; |
|
70 |
font-weight : bold; |
|
71 |
text-decoration : none; |
|
72 |
} |
|
73 |
|
|
74 |
|
|
75 |
|
|
76 |
/* Commented Backslash Hack hides rule from IE5-Mac \*/ |
|
77 |
DIV.tabs SPAN {float : none;} |
|
78 |
/* End IE5-Mac hack */ |
|
79 |
|
|
80 |
DIV.tabs A:hover SPAN |
|
81 |
{ |
|
82 |
background-position: 0% -150px; |
|
83 |
} |
|
84 |
|
|
85 |
DIV.tabs LI#current A |
|
86 |
{ |
|
87 |
background-position: 100% -150px; |
|
88 |
border-width : 0px; |
|
89 |
} |
|
90 |
|
|
91 |
DIV.tabs LI#current SPAN |
|
92 |
{ |
|
93 |
background-position: 0% -150px; |
|
94 |
padding-bottom : 6px; |
|
95 |
} |
|
96 |
|
|
97 |
DIV.nav |
|
98 |
{ |
|
99 |
background : none; |
|
100 |
border : none; |
|
101 |
border-bottom : 1px solid #84B0C7; |
|
102 |
} |
branches/lib_additions/docs/lib/libdragonfly/buzzer_8h-source.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: buzzer.h Source File</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<h1>buzzer.h</h1><a href="buzzer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
|
20 |
<a name="l00011"></a>00011 <span class="preprocessor">#ifndef _BUZZER_H_</span> |
|
21 |
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define _BUZZER_H_</span> |
|
22 |
<a name="l00013"></a>00013 <span class="preprocessor"></span> |
|
23 |
<a name="l00019"></a>00019 <span class="comment">//Musical note definitions</span> |
|
24 |
<a name="l00020"></a>00020 <span class="comment">//Source: http://www.answers.com/topic/piano-key-frequencies</span> |
|
25 |
<a name="l00022"></a><a class="code" href="group__buzzer.html#gcc39015f57b2efb8810b603f188bdf15">00022</a> <span class="comment"></span><span class="preprocessor">#define C4 260 //Middle C</span> |
|
26 |
<a name="l00023"></a>00023 <span class="preprocessor"></span> |
|
27 |
<a name="l00024"></a><a class="code" href="group__buzzer.html#g879790f58417f0986370ddbcda404ed0">00024</a> <span class="preprocessor">#define C4s 277 //C sharp</span> |
|
28 |
<a name="l00025"></a>00025 <span class="preprocessor"></span> |
|
29 |
<a name="l00026"></a><a class="code" href="group__buzzer.html#g3d9bb178282c3cb69740c94ba1e48fed">00026</a> <span class="preprocessor">#define D4 294</span> |
|
30 |
<a name="l00027"></a>00027 <span class="preprocessor"></span> |
|
31 |
<a name="l00028"></a><a class="code" href="group__buzzer.html#g33eb0561dd16dd44c7c23519dd22540a">00028</a> <span class="preprocessor">#define D4s 311</span> |
|
32 |
<a name="l00029"></a>00029 <span class="preprocessor"></span> |
|
33 |
<a name="l00030"></a><a class="code" href="group__buzzer.html#g4c819074c856b4e67fad4875a92cb2e9">00030</a> <span class="preprocessor">#define E4 330</span> |
|
34 |
<a name="l00031"></a>00031 <span class="preprocessor"></span> |
|
35 |
<a name="l00032"></a><a class="code" href="group__buzzer.html#g7fd7918aa90b0ce1dc7ca9fe7a00e9fb">00032</a> <span class="preprocessor">#define F4 349</span> |
|
36 |
<a name="l00033"></a>00033 <span class="preprocessor"></span> |
|
37 |
<a name="l00034"></a><a class="code" href="group__buzzer.html#g93ff98890b28a2833f1152cc95c3e628">00034</a> <span class="preprocessor">#define F4s 370</span> |
|
38 |
<a name="l00035"></a>00035 <span class="preprocessor"></span> |
|
39 |
<a name="l00036"></a><a class="code" href="group__buzzer.html#g6f984a8b01aafc34122cc8bc0d9d5691">00036</a> <span class="preprocessor">#define G4 392</span> |
|
40 |
<a name="l00037"></a>00037 <span class="preprocessor"></span> |
|
41 |
<a name="l00038"></a><a class="code" href="group__buzzer.html#gaf8daa589f172256505e028dab2954b2">00038</a> <span class="preprocessor">#define G4s 415</span> |
|
42 |
<a name="l00039"></a>00039 <span class="preprocessor"></span> |
|
43 |
<a name="l00040"></a><a class="code" href="group__buzzer.html#ga0a03ad95ca0cb887a11e321fa1c9519">00040</a> <span class="preprocessor">#define A4 440</span> |
|
44 |
<a name="l00041"></a>00041 <span class="preprocessor"></span> |
|
45 |
<a name="l00042"></a><a class="code" href="group__buzzer.html#g7063c01bf1877119a8aca7049e02a8cb">00042</a> <span class="preprocessor">#define A4s 466</span> |
|
46 |
<a name="l00043"></a>00043 <span class="preprocessor"></span> |
|
47 |
<a name="l00044"></a><a class="code" href="group__buzzer.html#g0bf59f84e29fb57d27314583365a88d6">00044</a> <span class="preprocessor">#define B4 494</span> |
|
48 |
<a name="l00045"></a>00045 <span class="preprocessor"></span> |
|
49 |
<a name="l00046"></a><a class="code" href="group__buzzer.html#g3b69b61d9deb37b13911faf2cf5cf1d5">00046</a> <span class="preprocessor">#define C5 523</span> |
|
50 |
<a name="l00047"></a>00047 <span class="preprocessor"></span> |
|
51 |
<a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a>(<span class="keywordtype">void</span>); |
|
52 |
<a name="l00051"></a>00051 <span class="keywordtype">void</span> <a class="code" href="group__buzzer.html#g9872f05325dd86a89728d47c8e9158ab">buzzer_set_val</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buzz_value); |
|
53 |
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193">buzzer_set_freq</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buzz_freq); |
|
54 |
<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="group__buzzer.html#ga78239c1255dfea31992f435659df1d7">buzzer_chirp</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ms, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buzz_freq); |
|
55 |
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f">buzzer_off</a>(<span class="keywordtype">void</span>); |
|
56 |
<a name="l00058"></a>00058 <span class="comment">//end addtogroup</span> |
|
57 |
<a name="l00060"></a>00060 |
|
58 |
<a name="l00061"></a>00061 <span class="preprocessor">#endif</span> |
|
59 |
<a name="l00062"></a>00062 <span class="preprocessor"></span> |
|
60 |
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
61 |
<a href="http://www.doxygen.org/index.html"> |
|
62 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
63 |
</body> |
|
64 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/group__move.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Movement</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<h1>Movement</h1>Functions fo controlling robot motion Higher level functions to control the movement of robots. |
|
15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
16 |
<tr><td></td></tr> |
|
17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga02f16883c5ce325e2dbb8c3835aa9a1"></a><!-- doxytag: member="move::FWD" ref="ga02f16883c5ce325e2dbb8c3835aa9a1" args="" --> |
|
19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#ga02f16883c5ce325e2dbb8c3835aa9a1">FWD</a> 0</td></tr> |
|
20 |
|
|
21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move forwards. <br></td></tr> |
|
22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb8d9d2e1ff6a03ce3b45a32e0002a405"></a><!-- doxytag: member="move::BCK" ref="gb8d9d2e1ff6a03ce3b45a32e0002a405" args="" --> |
|
23 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#gb8d9d2e1ff6a03ce3b45a32e0002a405">BCK</a> 1</td></tr> |
|
24 |
|
|
25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move backwards. <br></td></tr> |
|
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gff79b776dbd665d08a0cfcb4c2931c98"></a><!-- doxytag: member="move::SLOW_SPD" ref="gff79b776dbd665d08a0cfcb4c2931c98" args="" --> |
|
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#gff79b776dbd665d08a0cfcb4c2931c98">SLOW_SPD</a> 96</td></tr> |
|
28 |
|
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A slow speed. <br></td></tr> |
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0dd7c6a61a43fb8a3698988c414a9bf"></a><!-- doxytag: member="move::HALF_SPD" ref="ga0dd7c6a61a43fb8a3698988c414a9bf" args="" --> |
|
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#ga0dd7c6a61a43fb8a3698988c414a9bf">HALF_SPD</a> 128</td></tr> |
|
32 |
|
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Half of the full speed. <br></td></tr> |
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gab20a9de15efe0d1b5599a3dd2ae9fea"></a><!-- doxytag: member="move::NRML_SPD" ref="gab20a9de15efe0d1b5599a3dd2ae9fea" args="" --> |
|
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#gab20a9de15efe0d1b5599a3dd2ae9fea">NRML_SPD</a> 160</td></tr> |
|
36 |
|
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A normal speed. <br></td></tr> |
|
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1f2e117ff854d46ca84f16a1eb8419a"></a><!-- doxytag: member="move::FAST_SPD" ref="ga1f2e117ff854d46ca84f16a1eb8419a" args="" --> |
|
39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#ga1f2e117ff854d46ca84f16a1eb8419a">FAST_SPD</a> 192</td></tr> |
|
40 |
|
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A fast speed. <br></td></tr> |
|
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35819c1d24f97763dab51cd367514443"></a><!-- doxytag: member="move::FULL_SPD" ref="g35819c1d24f97763dab51cd367514443" args="" --> |
|
43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#g35819c1d24f97763dab51cd367514443">FULL_SPD</a> 255</td></tr> |
|
44 |
|
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum speed. <br></td></tr> |
|
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4e9e38cfcdb9bfd0f80c69a574301731"></a><!-- doxytag: member="move::SLOW_TURN" ref="g4e9e38cfcdb9bfd0f80c69a574301731" args="" --> |
|
47 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#g4e9e38cfcdb9bfd0f80c69a574301731">SLOW_TURN</a> 64</td></tr> |
|
48 |
|
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A slow turning speed. <br></td></tr> |
|
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfc67eeed7b52f97b8483af04e27a9ce"></a><!-- doxytag: member="move::NRML_TURN" ref="gdfc67eeed7b52f97b8483af04e27a9ce" args="" --> |
|
51 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#gdfc67eeed7b52f97b8483af04e27a9ce">NRML_TURN</a> 96</td></tr> |
|
52 |
|
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A medium turning speed. <br></td></tr> |
|
54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb900792066abf52697bd19cc5240ae24"></a><!-- doxytag: member="move::FAST_TURN" ref="gb900792066abf52697bd19cc5240ae24" args="" --> |
|
55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#gb900792066abf52697bd19cc5240ae24">FAST_TURN</a> 128</td></tr> |
|
56 |
|
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A high turning speed. <br></td></tr> |
|
58 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#g4e27eab618b1d874ff25fd2b2a65493b">move</a> (int velocity, int omega)</td></tr> |
|
60 |
|
|
61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the robot at the specified velocity. <a href="#g4e27eab618b1d874ff25fd2b2a65493b"></a><br></td></tr> |
|
62 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__move.html#g8e79749d6af4a0aa12aceee41ad62ebd">move_avoid</a> (int velocity, int omega, int strength)</td></tr> |
|
63 |
|
|
64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the robot while avoiding obstacles. <a href="#g8e79749d6af4a0aa12aceee41ad62ebd"></a><br></td></tr> |
|
65 |
</table> |
|
66 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
67 |
Functions fo controlling robot motion Higher level functions to control the movement of robots. |
|
68 |
<p> |
|
69 |
<hr><h2>Function Documentation</h2> |
|
70 |
<a class="anchor" name="g4e27eab618b1d874ff25fd2b2a65493b"></a><!-- doxytag: member="move.c::move" ref="g4e27eab618b1d874ff25fd2b2a65493b" args="(int velocity, int omega)" --><p> |
|
71 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
72 |
<tr> |
|
73 |
<td class="mdRow"> |
|
74 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
75 |
<tr> |
|
76 |
<td class="md" nowrap valign="top">void move </td> |
|
77 |
<td class="md" valign="top">( </td> |
|
78 |
<td class="md" nowrap valign="top">int </td> |
|
79 |
<td class="mdname" nowrap> <em>velocity</em>, </td> |
|
80 |
</tr> |
|
81 |
<tr> |
|
82 |
<td class="md" nowrap align="right"></td> |
|
83 |
<td class="md"></td> |
|
84 |
<td class="md" nowrap>int </td> |
|
85 |
<td class="mdname" nowrap> <em>omega</em></td> |
|
86 |
</tr> |
|
87 |
<tr> |
|
88 |
<td class="md"></td> |
|
89 |
<td class="md">) </td> |
|
90 |
<td class="md" colspan="2"></td> |
|
91 |
</tr> |
|
92 |
</table> |
|
93 |
</td> |
|
94 |
</tr> |
|
95 |
</table> |
|
96 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
97 |
<tr> |
|
98 |
<td> |
|
99 |
|
|
100 |
</td> |
|
101 |
<td> |
|
102 |
|
|
103 |
<p> |
|
104 |
Move the robot at the specified velocity. |
|
105 |
<p> |
|
106 |
Causes the robot to move with the given translation and rotational velocities. motors_init must be called before this function can be used.<p> |
|
107 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
108 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
109 |
<tr><td valign="top"></td><td valign="top"><em>velocity</em> </td><td>the translational velocity of the robot, in the range -255 to 255. A positive value indicates forward motion, while a negative value indicates backwards motion.</td></tr> |
|
110 |
<tr><td valign="top"></td><td valign="top"><em>omega</em> </td><td>the rotational velocity of the robot, in the range -255 to 255. A positive value indicates a counterclockwise velocity, while a negative value indicates a clockwise velocity.</td></tr> |
|
111 |
</table> |
|
112 |
</dl> |
|
113 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21">motors_init</a>, <a class="el" href="group__motors.html#g751a431c19cdb52bbbc8127455bd41ee">motor1_set</a>, <a class="el" href="group__motors.html#g23940fd8408c23fcf312b1d5937f0ab0">motor2_set</a> </dd></dl> |
|
114 |
</td> |
|
115 |
</tr> |
|
116 |
</table> |
|
117 |
<a class="anchor" name="g8e79749d6af4a0aa12aceee41ad62ebd"></a><!-- doxytag: member="move.c::move_avoid" ref="g8e79749d6af4a0aa12aceee41ad62ebd" args="(int velocity, int omega, int strength)" --><p> |
|
118 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
119 |
<tr> |
|
120 |
<td class="mdRow"> |
|
121 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
122 |
<tr> |
|
123 |
<td class="md" nowrap valign="top">void move_avoid </td> |
|
124 |
<td class="md" valign="top">( </td> |
|
125 |
<td class="md" nowrap valign="top">int </td> |
|
126 |
<td class="mdname" nowrap> <em>velocity</em>, </td> |
|
127 |
</tr> |
|
128 |
<tr> |
|
129 |
<td class="md" nowrap align="right"></td> |
|
130 |
<td class="md"></td> |
|
131 |
<td class="md" nowrap>int </td> |
|
132 |
<td class="mdname" nowrap> <em>omega</em>, </td> |
|
133 |
</tr> |
|
134 |
<tr> |
|
135 |
<td class="md" nowrap align="right"></td> |
|
136 |
<td class="md"></td> |
|
137 |
<td class="md" nowrap>int </td> |
|
138 |
<td class="mdname" nowrap> <em>strength</em></td> |
|
139 |
</tr> |
|
140 |
<tr> |
|
141 |
<td class="md"></td> |
|
142 |
<td class="md">) </td> |
|
143 |
<td class="md" colspan="2"></td> |
|
144 |
</tr> |
|
145 |
</table> |
|
146 |
</td> |
|
147 |
</tr> |
|
148 |
</table> |
|
149 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
150 |
<tr> |
|
151 |
<td> |
|
152 |
|
|
153 |
</td> |
|
154 |
<td> |
|
155 |
|
|
156 |
<p> |
|
157 |
Move the robot while avoiding obstacles. |
|
158 |
<p> |
|
159 |
Moves the robot with the given translational and angular velocities while avoiding obstacles. To be effective, this function must be called repeatedly throughout the motion. It relies on the IR rangefinders to detect obstacles. Before calling this function, motors_init and range_init must be called.<p> |
|
160 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
161 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
162 |
<tr><td valign="top"></td><td valign="top"><em>velocity</em> </td><td>the translational velocity of the robot, in the range -255 to 255. A positive value indicates forward motion.</td></tr> |
|
163 |
<tr><td valign="top"></td><td valign="top"><em>omega</em> </td><td>the rotational velocity of the robot, in the range -255 to 255. A positive value indicates a counterclockwise velocity.</td></tr> |
|
164 |
<tr><td valign="top"></td><td valign="top"><em>strength</em> </td><td>the strength of the avoid behavior, in the range 0 to 100.</td></tr> |
|
165 |
</table> |
|
166 |
</dl> |
|
167 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21">motors_init</a>, <a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a>, <a class="el" href="group__move.html#g4e27eab618b1d874ff25fd2b2a65493b">move</a> </dd></dl> |
|
168 |
</td> |
|
169 |
</tr> |
|
170 |
</table> |
|
171 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
172 |
<a href="http://www.doxygen.org/index.html"> |
|
173 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
174 |
</body> |
|
175 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/globals_defs_0x6c.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Data Fields</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li id="current"><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<div class="tabs"> |
|
20 |
<ul> |
|
21 |
<li><a href="globals.html"><span>All</span></a></li> |
|
22 |
<li><a href="globals_func.html"><span>Functions</span></a></li> |
|
23 |
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li> |
|
24 |
</ul> |
|
25 |
</div> |
|
26 |
<div class="tabs"> |
|
27 |
<ul> |
|
28 |
<li><a href="globals_defs.html#index__"><span>_</span></a></li> |
|
29 |
<li><a href="globals_defs_0x61.html#index_a"><span>a</span></a></li> |
|
30 |
<li><a href="globals_defs_0x62.html#index_b"><span>b</span></a></li> |
|
31 |
<li><a href="globals_defs_0x63.html#index_c"><span>c</span></a></li> |
|
32 |
<li><a href="globals_defs_0x64.html#index_d"><span>d</span></a></li> |
|
33 |
<li><a href="globals_defs_0x65.html#index_e"><span>e</span></a></li> |
|
34 |
<li><a href="globals_defs_0x66.html#index_f"><span>f</span></a></li> |
|
35 |
<li><a href="globals_defs_0x67.html#index_g"><span>g</span></a></li> |
|
36 |
<li><a href="globals_defs_0x68.html#index_h"><span>h</span></a></li> |
|
37 |
<li><a href="globals_defs_0x69.html#index_i"><span>i</span></a></li> |
|
38 |
<li id="current"><a href="globals_defs_0x6c.html#index_l"><span>l</span></a></li> |
|
39 |
<li><a href="globals_defs_0x6d.html#index_m"><span>m</span></a></li> |
|
40 |
<li><a href="globals_defs_0x6e.html#index_n"><span>n</span></a></li> |
|
41 |
<li><a href="globals_defs_0x6f.html#index_o"><span>o</span></a></li> |
|
42 |
<li><a href="globals_defs_0x70.html#index_p"><span>p</span></a></li> |
|
43 |
<li><a href="globals_defs_0x71.html#index_q"><span>q</span></a></li> |
|
44 |
<li><a href="globals_defs_0x72.html#index_r"><span>r</span></a></li> |
|
45 |
<li><a href="globals_defs_0x73.html#index_s"><span>s</span></a></li> |
|
46 |
<li><a href="globals_defs_0x74.html#index_t"><span>t</span></a></li> |
|
47 |
<li><a href="globals_defs_0x75.html#index_u"><span>u</span></a></li> |
|
48 |
<li><a href="globals_defs_0x77.html#index_w"><span>w</span></a></li> |
|
49 |
<li><a href="globals_defs_0x78.html#index_x"><span>x</span></a></li> |
|
50 |
<li><a href="globals_defs_0x79.html#index_y"><span>y</span></a></li> |
|
51 |
</ul> |
|
52 |
</div> |
|
53 |
|
|
54 |
<p> |
|
55 |
|
|
56 |
<p> |
|
57 |
<h3><a class="anchor" name="index_l">- l -</a></h3><ul> |
|
58 |
<li>LCD |
|
59 |
: <a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">dragonfly_lib.h</a><li>LIME |
|
60 |
: <a class="el" href="group__orbs.html#g46019a1f2c10603a54b6cbb19cbf3c21">lights.h</a></ul> |
|
61 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
62 |
<a href="http://www.doxygen.org/index.html"> |
|
63 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
64 |
</body> |
|
65 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/globals_0x6d.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Data Fields</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li id="current"><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<div class="tabs"> |
|
20 |
<ul> |
|
21 |
<li id="current"><a href="globals.html"><span>All</span></a></li> |
|
22 |
<li><a href="globals_func.html"><span>Functions</span></a></li> |
|
23 |
<li><a href="globals_defs.html"><span>Defines</span></a></li> |
|
24 |
</ul> |
|
25 |
</div> |
|
26 |
<div class="tabs"> |
|
27 |
<ul> |
|
28 |
<li><a href="globals.html#index__"><span>_</span></a></li> |
|
29 |
<li><a href="globals_0x61.html#index_a"><span>a</span></a></li> |
|
30 |
<li><a href="globals_0x62.html#index_b"><span>b</span></a></li> |
|
31 |
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li> |
|
32 |
<li><a href="globals_0x64.html#index_d"><span>d</span></a></li> |
|
33 |
<li><a href="globals_0x65.html#index_e"><span>e</span></a></li> |
|
34 |
<li><a href="globals_0x66.html#index_f"><span>f</span></a></li> |
|
35 |
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li> |
|
36 |
<li><a href="globals_0x68.html#index_h"><span>h</span></a></li> |
|
37 |
<li><a href="globals_0x69.html#index_i"><span>i</span></a></li> |
|
38 |
<li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> |
|
39 |
<li id="current"><a href="globals_0x6d.html#index_m"><span>m</span></a></li> |
|
40 |
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> |
|
41 |
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> |
|
42 |
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li> |
|
43 |
<li><a href="globals_0x71.html#index_q"><span>q</span></a></li> |
|
44 |
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li> |
|
45 |
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li> |
|
46 |
<li><a href="globals_0x74.html#index_t"><span>t</span></a></li> |
|
47 |
<li><a href="globals_0x75.html#index_u"><span>u</span></a></li> |
|
48 |
<li><a href="globals_0x77.html#index_w"><span>w</span></a></li> |
|
49 |
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li> |
|
50 |
<li><a href="globals_0x79.html#index_y"><span>y</span></a></li> |
|
51 |
</ul> |
|
52 |
</div> |
|
53 |
|
|
54 |
<p> |
|
55 |
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: |
|
56 |
<p> |
|
57 |
<h3><a class="anchor" name="index_m">- m -</a></h3><ul> |
|
58 |
<li>MAGENTA |
|
59 |
: <a class="el" href="group__orbs.html#g6f699060902f800f12aaae150f3a708e">lights.h</a><li>MOTORS |
|
60 |
: <a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">dragonfly_lib.h</a></ul> |
|
61 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
62 |
<a href="http://www.doxygen.org/index.html"> |
|
63 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
64 |
</body> |
|
65 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/lights_8h.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: lights.h File Reference</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<h1>lights.h File Reference</h1>Contains declarations for managing the orbs. <a href="#_details">More...</a> |
|
20 |
<p> |
|
21 |
|
|
22 |
<p> |
|
23 |
<a href="lights_8h-source.html">Go to the source code of this file.</a><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="g8d23feea868a983c8c2b661e1e16972f"></a><!-- doxytag: member="lights.h::RED" ref="g8d23feea868a983c8c2b661e1e16972f" args="" --> |
|
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g8d23feea868a983c8c2b661e1e16972f">RED</a> 0xE0</td></tr> |
|
28 |
|
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Red. <br></td></tr> |
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc5b6e19bf06822021f35602c59658de3"></a><!-- doxytag: member="lights.h::ORANGE" ref="gc5b6e19bf06822021f35602c59658de3" args="" --> |
|
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc5b6e19bf06822021f35602c59658de3">ORANGE</a> 0xE4</td></tr> |
|
32 |
|
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Orange. <br></td></tr> |
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf681265909adf3d3e8116c93c0ba179"></a><!-- doxytag: member="lights.h::YELLOW" ref="gbf681265909adf3d3e8116c93c0ba179" args="" --> |
|
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbf681265909adf3d3e8116c93c0ba179">YELLOW</a> 0xE8</td></tr> |
|
36 |
|
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Yellow. <br></td></tr> |
|
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46019a1f2c10603a54b6cbb19cbf3c21"></a><!-- doxytag: member="lights.h::LIME" ref="g46019a1f2c10603a54b6cbb19cbf3c21" args="" --> |
|
39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g46019a1f2c10603a54b6cbb19cbf3c21">LIME</a> 0x68</td></tr> |
|
40 |
|
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lime. <br></td></tr> |
|
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfbc006ea433ad708fdee3e82996e721"></a><!-- doxytag: member="lights.h::GREEN" ref="gcfbc006ea433ad708fdee3e82996e721" args="" --> |
|
43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcfbc006ea433ad708fdee3e82996e721">GREEN</a> 0x1C</td></tr> |
|
44 |
|
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Green. <br></td></tr> |
|
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd243f93c16bc4c1d3e0a13b84421d760"></a><!-- doxytag: member="lights.h::CYAN" ref="gd243f93c16bc4c1d3e0a13b84421d760" args="" --> |
|
47 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gd243f93c16bc4c1d3e0a13b84421d760">CYAN</a> 0x1F</td></tr> |
|
48 |
|
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cyan. <br></td></tr> |
|
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g79d10e672abb49ad63eeaa8aaef57c38"></a><!-- doxytag: member="lights.h::BLUE" ref="g79d10e672abb49ad63eeaa8aaef57c38" args="" --> |
|
51 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g79d10e672abb49ad63eeaa8aaef57c38">BLUE</a> 0x03</td></tr> |
|
52 |
|
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Blue. <br></td></tr> |
|
54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gda419fe3b48fcf19daed7cc57ccf1174"></a><!-- doxytag: member="lights.h::PINK" ref="gda419fe3b48fcf19daed7cc57ccf1174" args="" --> |
|
55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gda419fe3b48fcf19daed7cc57ccf1174">PINK</a> 0xA6</td></tr> |
|
56 |
|
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pink. <br></td></tr> |
|
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bb0b009e7a7390473ace4d98bd843c0"></a><!-- doxytag: member="lights.h::PURPLE" ref="g0bb0b009e7a7390473ace4d98bd843c0" args="" --> |
|
59 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0bb0b009e7a7390473ace4d98bd843c0">PURPLE</a> 0x41</td></tr> |
|
60 |
|
|
61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purple. <br></td></tr> |
|
62 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f699060902f800f12aaae150f3a708e"></a><!-- doxytag: member="lights.h::MAGENTA" ref="g6f699060902f800f12aaae150f3a708e" args="" --> |
|
63 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g6f699060902f800f12aaae150f3a708e">MAGENTA</a> 0xE3</td></tr> |
|
64 |
|
|
65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Magenta. <br></td></tr> |
|
66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g87b537f5fa5c109d3c05c13d6b18f382"></a><!-- doxytag: member="lights.h::WHITE" ref="g87b537f5fa5c109d3c05c13d6b18f382" args="" --> |
|
67 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g87b537f5fa5c109d3c05c13d6b18f382">WHITE</a> 0xFE</td></tr> |
|
68 |
|
|
69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">White. <br></td></tr> |
|
70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf2f6da92d895ef5e594223f1e39e4b1"></a><!-- doxytag: member="lights.h::ORB_OFF" ref="gcf2f6da92d895ef5e594223f1e39e4b1" args="" --> |
|
71 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a> 0xFE</td></tr> |
|
72 |
|
|
73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the orb off (White). <br></td></tr> |
|
74 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> (void)</td></tr> |
|
76 |
|
|
77 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs. <a href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9"></a><br></td></tr> |
|
78 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ga75385bd1398949615ee1fe78a535cff">orb_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
|
79 |
|
|
80 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="group__orbs.html#ga75385bd1398949615ee1fe78a535cff"></a><br></td></tr> |
|
81 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g2df1397345a557295b12e50451f8592e">orb1_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
|
82 |
|
|
83 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g2df1397345a557295b12e50451f8592e"></a><br></td></tr> |
|
84 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gb19679987f51d6ed35461d581ca8972b">orb2_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
|
85 |
|
|
86 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#gb19679987f51d6ed35461d581ca8972b"></a><br></td></tr> |
|
87 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g123d2880d20bf6d0bb387024c8f6da81">orb_set_color</a> (int col)</td></tr> |
|
88 |
|
|
89 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="group__orbs.html#g123d2880d20bf6d0bb387024c8f6da81"></a><br></td></tr> |
|
90 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g131d9bf3e32cf5530f4cc671ea496609">orb1_set_color</a> (int col)</td></tr> |
|
91 |
|
|
92 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g131d9bf3e32cf5530f4cc671ea496609"></a><br></td></tr> |
|
93 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g3125d9c661a33b3fdeb4eca75ca00cab">orb2_set_color</a> (int col)</td></tr> |
|
94 |
|
|
95 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#g3125d9c661a33b3fdeb4eca75ca00cab"></a><br></td></tr> |
|
96 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1ea1b363a0592f80798f6a1e260a70e9">orb_disable</a> (void)</td></tr> |
|
97 |
|
|
98 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the orbs. <a href="group__orbs.html#g1ea1b363a0592f80798f6a1e260a70e9"></a><br></td></tr> |
|
99 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547">orb_enable</a> (void)</td></tr> |
|
100 |
|
|
101 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the orbs. <a href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547"></a><br></td></tr> |
|
102 |
</table> |
|
103 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
104 |
Contains declarations for managing the orbs. |
|
105 |
<p> |
|
106 |
Contains declarations for using the orbs and PWM.<p> |
|
107 |
<dl compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club Based on Firefly Library, by Tom Lauwers and Steven Shamlian </dd></dl> |
|
108 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
109 |
<a href="http://www.doxygen.org/index.html"> |
|
110 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
111 |
</body> |
|
112 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/group__buzzer.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: Buzzer</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<h1>Buzzer</h1>Functions for controlling the buzzer. Functions for controlling the buzzer. Include <a class="el" href="buzzer_8h.html">buzzer.h</a> to access these functions. |
|
15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
16 |
<tr><td></td></tr> |
|
17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcc39015f57b2efb8810b603f188bdf15"></a><!-- doxytag: member="buzzer::C4" ref="gcc39015f57b2efb8810b603f188bdf15" args="" --> |
|
19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#gcc39015f57b2efb8810b603f188bdf15">C4</a> 260</td></tr> |
|
20 |
|
|
21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Middle C. <br></td></tr> |
|
22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g879790f58417f0986370ddbcda404ed0"></a><!-- doxytag: member="buzzer::C4s" ref="g879790f58417f0986370ddbcda404ed0" args="" --> |
|
23 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g879790f58417f0986370ddbcda404ed0">C4s</a> 277</td></tr> |
|
24 |
|
|
25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">C#. <br></td></tr> |
|
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3d9bb178282c3cb69740c94ba1e48fed"></a><!-- doxytag: member="buzzer::D4" ref="g3d9bb178282c3cb69740c94ba1e48fed" args="" --> |
|
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g3d9bb178282c3cb69740c94ba1e48fed">D4</a> 294</td></tr> |
|
28 |
|
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">D. <br></td></tr> |
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g33eb0561dd16dd44c7c23519dd22540a"></a><!-- doxytag: member="buzzer::D4s" ref="g33eb0561dd16dd44c7c23519dd22540a" args="" --> |
|
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g33eb0561dd16dd44c7c23519dd22540a">D4s</a> 311</td></tr> |
|
32 |
|
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">D#. <br></td></tr> |
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c819074c856b4e67fad4875a92cb2e9"></a><!-- doxytag: member="buzzer::E4" ref="g4c819074c856b4e67fad4875a92cb2e9" args="" --> |
|
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g4c819074c856b4e67fad4875a92cb2e9">E4</a> 330</td></tr> |
|
36 |
|
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">E. <br></td></tr> |
|
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7fd7918aa90b0ce1dc7ca9fe7a00e9fb"></a><!-- doxytag: member="buzzer::F4" ref="g7fd7918aa90b0ce1dc7ca9fe7a00e9fb" args="" --> |
|
39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g7fd7918aa90b0ce1dc7ca9fe7a00e9fb">F4</a> 349</td></tr> |
|
40 |
|
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">F. <br></td></tr> |
|
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93ff98890b28a2833f1152cc95c3e628"></a><!-- doxytag: member="buzzer::F4s" ref="g93ff98890b28a2833f1152cc95c3e628" args="" --> |
|
43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g93ff98890b28a2833f1152cc95c3e628">F4s</a> 370</td></tr> |
|
44 |
|
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">F#. <br></td></tr> |
|
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f984a8b01aafc34122cc8bc0d9d5691"></a><!-- doxytag: member="buzzer::G4" ref="g6f984a8b01aafc34122cc8bc0d9d5691" args="" --> |
|
47 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g6f984a8b01aafc34122cc8bc0d9d5691">G4</a> 392</td></tr> |
|
48 |
|
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">G. <br></td></tr> |
|
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaf8daa589f172256505e028dab2954b2"></a><!-- doxytag: member="buzzer::G4s" ref="gaf8daa589f172256505e028dab2954b2" args="" --> |
|
51 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#gaf8daa589f172256505e028dab2954b2">G4s</a> 415</td></tr> |
|
52 |
|
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">G#. <br></td></tr> |
|
54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0a03ad95ca0cb887a11e321fa1c9519"></a><!-- doxytag: member="buzzer::A4" ref="ga0a03ad95ca0cb887a11e321fa1c9519" args="" --> |
|
55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#ga0a03ad95ca0cb887a11e321fa1c9519">A4</a> 440</td></tr> |
|
56 |
|
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A. <br></td></tr> |
|
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7063c01bf1877119a8aca7049e02a8cb"></a><!-- doxytag: member="buzzer::A4s" ref="g7063c01bf1877119a8aca7049e02a8cb" args="" --> |
|
59 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g7063c01bf1877119a8aca7049e02a8cb">A4s</a> 466</td></tr> |
|
60 |
|
|
61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A#. <br></td></tr> |
|
62 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bf59f84e29fb57d27314583365a88d6"></a><!-- doxytag: member="buzzer::B4" ref="g0bf59f84e29fb57d27314583365a88d6" args="" --> |
|
63 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g0bf59f84e29fb57d27314583365a88d6">B4</a> 494</td></tr> |
|
64 |
|
|
65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">B. <br></td></tr> |
|
66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3b69b61d9deb37b13911faf2cf5cf1d5"></a><!-- doxytag: member="buzzer::C5" ref="g3b69b61d9deb37b13911faf2cf5cf1d5" args="" --> |
|
67 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g3b69b61d9deb37b13911faf2cf5cf1d5">C5</a> 523</td></tr> |
|
68 |
|
|
69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">C. <br></td></tr> |
|
70 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a> (void)</td></tr> |
|
72 |
|
|
73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the buzzer. <a href="#g0cead532fdd0c0de5fa1c1de0f6556bd"></a><br></td></tr> |
|
74 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g9872f05325dd86a89728d47c8e9158ab">buzzer_set_val</a> (unsigned int buzz_value)</td></tr> |
|
75 |
|
|
76 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value the buzzer plays. <a href="#g9872f05325dd86a89728d47c8e9158ab"></a><br></td></tr> |
|
77 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193">buzzer_set_freq</a> (unsigned int buzz_freq)</td></tr> |
|
78 |
|
|
79 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the frequency the buzzer plays. <a href="#ga0aba85b0044cb1a44bb28c675d7c193"></a><br></td></tr> |
|
80 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#ga78239c1255dfea31992f435659df1d7">buzzer_chirp</a> (unsigned int ms, unsigned int buzz_freq)</td></tr> |
|
81 |
|
|
82 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Play a frequency for a specified time. <a href="#ga78239c1255dfea31992f435659df1d7"></a><br></td></tr> |
|
83 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f">buzzer_off</a> (void)</td></tr> |
|
84 |
|
|
85 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the buzzer off. <a href="#g93d07c81691fec7a85ea85117d6eca4f"></a><br></td></tr> |
|
86 |
</table> |
|
87 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
88 |
Functions for controlling the buzzer. Functions for controlling the buzzer. Include <a class="el" href="buzzer_8h.html">buzzer.h</a> to access these functions. |
|
89 |
<p> |
|
90 |
<hr><h2>Function Documentation</h2> |
|
91 |
<a class="anchor" name="ga78239c1255dfea31992f435659df1d7"></a><!-- doxytag: member="buzzer.c::buzzer_chirp" ref="ga78239c1255dfea31992f435659df1d7" args="(unsigned int ms, unsigned int buzz_freq)" --><p> |
|
92 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
93 |
<tr> |
|
94 |
<td class="mdRow"> |
|
95 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
96 |
<tr> |
|
97 |
<td class="md" nowrap valign="top">void buzzer_chirp </td> |
|
98 |
<td class="md" valign="top">( </td> |
|
99 |
<td class="md" nowrap valign="top">unsigned int </td> |
|
100 |
<td class="mdname" nowrap> <em>ms</em>, </td> |
|
101 |
</tr> |
|
102 |
<tr> |
|
103 |
<td class="md" nowrap align="right"></td> |
|
104 |
<td class="md"></td> |
|
105 |
<td class="md" nowrap>unsigned int </td> |
|
106 |
<td class="mdname" nowrap> <em>buzz_freq</em></td> |
|
107 |
</tr> |
|
108 |
<tr> |
|
109 |
<td class="md"></td> |
|
110 |
<td class="md">) </td> |
|
111 |
<td class="md" colspan="2"></td> |
|
112 |
</tr> |
|
113 |
</table> |
|
114 |
</td> |
|
115 |
</tr> |
|
116 |
</table> |
|
117 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
118 |
<tr> |
|
119 |
<td> |
|
120 |
|
|
121 |
</td> |
|
122 |
<td> |
|
123 |
|
|
124 |
<p> |
|
125 |
Play a frequency for a specified time. |
|
126 |
<p> |
|
127 |
Plays the specified frequency for the specified amount of time. This function blocks execution until the time is completed. buzzer_init must be called before this function can be used.<p> |
|
128 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
129 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
130 |
<tr><td valign="top"></td><td valign="top"><em>ms</em> </td><td>the time in milliseconds to play the frequency </td></tr> |
|
131 |
<tr><td valign="top"></td><td valign="top"><em>buzz_freq</em> </td><td>the frequency to play</td></tr> |
|
132 |
</table> |
|
133 |
</dl> |
|
134 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a>, <a class="el" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193">buzzer_set_freq</a> </dd></dl> |
|
135 |
</td> |
|
136 |
</tr> |
|
137 |
</table> |
|
138 |
<a class="anchor" name="g0cead532fdd0c0de5fa1c1de0f6556bd"></a><!-- doxytag: member="buzzer.c::buzzer_init" ref="g0cead532fdd0c0de5fa1c1de0f6556bd" args="(void)" --><p> |
|
139 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
140 |
<tr> |
|
141 |
<td class="mdRow"> |
|
142 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
143 |
<tr> |
|
144 |
<td class="md" nowrap valign="top">void buzzer_init </td> |
|
145 |
<td class="md" valign="top">( </td> |
|
146 |
<td class="md" nowrap valign="top">void </td> |
|
147 |
<td class="mdname1" valign="top" nowrap> </td> |
|
148 |
<td class="md" valign="top"> ) </td> |
|
149 |
<td class="md" nowrap></td> |
|
150 |
</tr> |
|
151 |
</table> |
|
152 |
</td> |
|
153 |
</tr> |
|
154 |
</table> |
|
155 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
156 |
<tr> |
|
157 |
<td> |
|
158 |
|
|
159 |
</td> |
|
160 |
<td> |
|
161 |
|
|
162 |
<p> |
|
163 |
Initialize the buzzer. |
|
164 |
<p> |
|
165 |
Initializes the buzzer. Must be called before any other buzzer function may be used. </td> |
|
166 |
</tr> |
|
167 |
</table> |
|
168 |
<a class="anchor" name="g93d07c81691fec7a85ea85117d6eca4f"></a><!-- doxytag: member="buzzer.c::buzzer_off" ref="g93d07c81691fec7a85ea85117d6eca4f" args="(void)" --><p> |
|
169 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
170 |
<tr> |
|
171 |
<td class="mdRow"> |
|
172 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
173 |
<tr> |
|
174 |
<td class="md" nowrap valign="top">void buzzer_off </td> |
|
175 |
<td class="md" valign="top">( </td> |
|
176 |
<td class="md" nowrap valign="top">void </td> |
|
177 |
<td class="mdname1" valign="top" nowrap> </td> |
|
178 |
<td class="md" valign="top"> ) </td> |
|
179 |
<td class="md" nowrap></td> |
|
180 |
</tr> |
|
181 |
</table> |
|
182 |
</td> |
|
183 |
</tr> |
|
184 |
</table> |
|
185 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
186 |
<tr> |
|
187 |
<td> |
|
188 |
|
|
189 |
</td> |
|
190 |
<td> |
|
191 |
|
|
192 |
<p> |
|
193 |
Turn the buzzer off. |
|
194 |
<p> |
|
195 |
Turns off the buzzer by disabling the timer0 clock.<p> |
|
196 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a> </dd></dl> |
|
197 |
</td> |
|
198 |
</tr> |
|
199 |
</table> |
|
200 |
<a class="anchor" name="ga0aba85b0044cb1a44bb28c675d7c193"></a><!-- doxytag: member="buzzer.c::buzzer_set_freq" ref="ga0aba85b0044cb1a44bb28c675d7c193" args="(unsigned int buzz_freq)" --><p> |
|
201 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
202 |
<tr> |
|
203 |
<td class="mdRow"> |
|
204 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
205 |
<tr> |
|
206 |
<td class="md" nowrap valign="top">void buzzer_set_freq </td> |
|
207 |
<td class="md" valign="top">( </td> |
|
208 |
<td class="md" nowrap valign="top">unsigned int </td> |
|
209 |
<td class="mdname1" valign="top" nowrap> <em>buzz_freq</em> </td> |
|
210 |
<td class="md" valign="top"> ) </td> |
|
211 |
<td class="md" nowrap></td> |
|
212 |
</tr> |
|
213 |
</table> |
|
214 |
</td> |
|
215 |
</tr> |
|
216 |
</table> |
|
217 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
218 |
<tr> |
|
219 |
<td> |
|
220 |
|
|
221 |
</td> |
|
222 |
<td> |
|
223 |
|
|
224 |
<p> |
|
225 |
Set the frequency the buzzer plays. |
|
226 |
<p> |
|
227 |
Sets the buzzer frequency. Usage of constants such as C4 is highly recommended as input to this function. buzzer_init must be called before this function may be used.<p> |
|
228 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
229 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
230 |
<tr><td valign="top"></td><td valign="top"><em>buzz_freq</em> </td><td>the frequency to set the buzzer to</td></tr> |
|
231 |
</table> |
|
232 |
</dl> |
|
233 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a>, <a class="el" href="group__buzzer.html#g9872f05325dd86a89728d47c8e9158ab">buzzer_set_val</a>, <a class="el" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f">buzzer_off</a> </dd></dl> |
|
234 |
</td> |
|
235 |
</tr> |
|
236 |
</table> |
|
237 |
<a class="anchor" name="g9872f05325dd86a89728d47c8e9158ab"></a><!-- doxytag: member="buzzer.c::buzzer_set_val" ref="g9872f05325dd86a89728d47c8e9158ab" args="(unsigned int buzz_value)" --><p> |
|
238 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
239 |
<tr> |
|
240 |
<td class="mdRow"> |
|
241 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
242 |
<tr> |
|
243 |
<td class="md" nowrap valign="top">void buzzer_set_val </td> |
|
244 |
<td class="md" valign="top">( </td> |
|
245 |
<td class="md" nowrap valign="top">unsigned int </td> |
|
246 |
<td class="mdname1" valign="top" nowrap> <em>buzz_value</em> </td> |
|
247 |
<td class="md" valign="top"> ) </td> |
|
248 |
<td class="md" nowrap></td> |
|
249 |
</tr> |
|
250 |
</table> |
|
251 |
</td> |
|
252 |
</tr> |
|
253 |
</table> |
|
254 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
255 |
<tr> |
|
256 |
<td> |
|
257 |
|
|
258 |
</td> |
|
259 |
<td> |
|
260 |
|
|
261 |
<p> |
|
262 |
Set the value the buzzer plays. |
|
263 |
<p> |
|
264 |
Sets the value of the buzzer's pitch. Higher values are lower frequencies.<p> |
|
265 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
266 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
267 |
<tr><td valign="top"></td><td valign="top"><em>buzz_value</em> </td><td>the value to set the buzzer's frequency too, in the range 0-255</td></tr> |
|
268 |
</table> |
|
269 |
</dl> |
|
270 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a>, <a class="el" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193">buzzer_set_freq</a>, <a class="el" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f">buzzer_off</a> </dd></dl> |
|
271 |
</td> |
|
272 |
</tr> |
|
273 |
</table> |
|
274 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
275 |
<a href="http://www.doxygen.org/index.html"> |
|
276 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
277 |
</body> |
|
278 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/analog_8h-source.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
3 |
<title>libdragonfly: analog.h Source File</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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<div class="tabs"> |
|
15 |
<ul> |
|
16 |
<li><a href="files.html"><span>File List</span></a></li> |
|
17 |
<li><a href="globals.html"><span>Globals</span></a></li> |
|
18 |
</ul></div> |
|
19 |
<h1>analog.h</h1><a href="analog_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
|
20 |
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _ANALOG_H</span> |
|
21 |
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _ANALOG_H</span> |
|
22 |
<a name="l00019"></a>00019 <span class="preprocessor"></span> |
|
23 |
<a name="l00026"></a><a class="code" href="group__analog.html#g099995994c74b5fff8f7de4ff3eac550">00026</a> <span class="preprocessor">#define AN0 0x00</span> |
|
24 |
<a name="l00027"></a>00027 <span class="preprocessor"></span> |
|
25 |
<a name="l00028"></a><a class="code" href="group__analog.html#g4903de2a52966c8dc2c20faf565d451d">00028</a> <span class="preprocessor">#define AN1 0x01</span> |
|
26 |
<a name="l00029"></a>00029 <span class="preprocessor"></span> |
|
27 |
<a name="l00030"></a><a class="code" href="group__analog.html#g9b0754e893d69a1e69e856853f70da1f">00030</a> <span class="preprocessor">#define AN2 0x02</span> |
|
28 |
<a name="l00031"></a>00031 <span class="preprocessor"></span> |
|
29 |
<a name="l00032"></a><a class="code" href="group__analog.html#g9f593faa38f1023698d74f03a457abe3">00032</a> <span class="preprocessor">#define AN3 0x03</span> |
|
30 |
<a name="l00033"></a>00033 <span class="preprocessor"></span> |
|
31 |
<a name="l00034"></a><a class="code" href="group__analog.html#gdc95f1e9cdc00268d7bca5885052171f">00034</a> <span class="preprocessor">#define AN4 0x04</span> |
|
32 |
<a name="l00035"></a>00035 <span class="preprocessor"></span> |
|
33 |
<a name="l00036"></a><a class="code" href="group__analog.html#g99ed455a0d536be03f12eba18ccff71b">00036</a> <span class="preprocessor">#define AN5 0x05</span> |
|
34 |
<a name="l00037"></a>00037 <span class="preprocessor"></span> |
|
35 |
<a name="l00038"></a><a class="code" href="group__analog.html#gd63d6861c3fa5e606de5c18ada3b4d10">00038</a> <span class="preprocessor">#define AN6 0x06</span> |
|
36 |
<a name="l00039"></a>00039 <span class="preprocessor"></span> |
|
37 |
<a name="l00040"></a><a class="code" href="group__analog.html#g277d706ee82bd70459b63e85489c7074">00040</a> <span class="preprocessor">#define AN7 0x07</span> |
|
38 |
<a name="l00041"></a>00041 <span class="preprocessor"></span> |
|
39 |
<a name="l00042"></a><a class="code" href="group__analog.html#g28b64348820dbb25c903d24f2e38a8a7">00042</a> <span class="preprocessor">#define AN8 0x08</span> |
|
40 |
<a name="l00043"></a>00043 <span class="preprocessor"></span> |
|
41 |
<a name="l00044"></a><a class="code" href="group__analog.html#g2fb7e4f4e0ea1f172eef79ed1f92e15f">00044</a> <span class="preprocessor">#define AN9 0x09</span> |
|
42 |
<a name="l00045"></a>00045 <span class="preprocessor"></span> |
|
43 |
<a name="l00046"></a><a class="code" href="group__analog.html#gc63caaf5f7a06a02522cb7f90d6c1959">00046</a> <span class="preprocessor">#define AN10 0x0a</span> |
|
44 |
<a name="l00047"></a>00047 <span class="preprocessor"></span> |
|
45 |
<a name="l00048"></a><a class="code" href="group__analog.html#gdfeb79b00aaef4734408a910838f7872">00048</a> <span class="preprocessor">#define AN11 0x0b</span> |
|
46 |
<a name="l00049"></a>00049 <span class="preprocessor"></span> |
|
47 |
<a name="l00050"></a><a class="code" href="group__analog.html#g7a50a07e69f38b6674b0494dfbc653f9">00050</a> <span class="preprocessor">#define AN12 0x0c</span> |
|
48 |
<a name="l00051"></a>00051 <span class="preprocessor"></span> |
|
49 |
<a name="l00052"></a><a class="code" href="group__analog.html#gbf80851ae45ddfe4bfdfc10541c255ad">00052</a> <span class="preprocessor">#define AN13 0x0d</span> |
|
50 |
<a name="l00053"></a>00053 <span class="preprocessor"></span> |
|
51 |
<a name="l00054"></a><a class="code" href="group__analog.html#g817772a1db513b734dfe4475c3616061">00054</a> <span class="preprocessor">#define AN14 0x0e</span> |
|
52 |
<a name="l00055"></a>00055 <span class="preprocessor"></span> |
|
53 |
<a name="l00056"></a><a class="code" href="group__analog.html#g797adbadae057ff7aa766d84b4f180f9">00056</a> <span class="preprocessor">#define AN15 0x0f</span> |
|
54 |
<a name="l00057"></a>00057 <span class="preprocessor"></span> |
|
55 |
<a name="l00059"></a><a class="code" href="group__analog.html#g3434ce39eaea22b46a0100b7fd3a6f47">00059</a> <span class="preprocessor">#define EXT_MUX AN7</span> |
|
56 |
<a name="l00060"></a>00060 <span class="preprocessor"></span> |
|
57 |
<a name="l00061"></a><a class="code" href="group__analog.html#ga6538d2deb002b8441891dc4e15cd104">00061</a> <span class="preprocessor">#define WHEEL_PORT AN10</span> |
|
58 |
<a name="l00062"></a>00062 <span class="preprocessor"></span> |
|
59 |
<a name="l00063"></a><a class="code" href="group__analog.html#gadcd026a2c91fe96c8134619c87bb72a">00063</a> <span class="preprocessor">#define BATT_PORT AN11</span> |
|
60 |
<a name="l00064"></a>00064 <span class="preprocessor"></span> |
|
61 |
<a name="l00066"></a>00066 <span class="keywordtype">void</span> <a class="code" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a>(<span class="keywordtype">void</span>); |
|
62 |
<a name="l00068"></a>00068 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27">analog8</a>(<span class="keywordtype">int</span> which); |
|
63 |
<a name="l00070"></a>00070 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3">analog10</a>(<span class="keywordtype">int</span> which); |
|
64 |
<a name="l00072"></a>00072 <span class="keywordtype">int</span> <a class="code" href="group__analog.html#g973e63eb508819a37efe3231b6a39550">wheel</a>(<span class="keywordtype">void</span>); |
|
65 |
<a name="l00073"></a>00073 <span class="comment">//end group</span> |
|
66 |
<a name="l00075"></a>00075 |
|
67 |
<a name="l00076"></a>00076 <span class="preprocessor">#endif</span> |
|
68 |
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
|
69 |
<a href="http://www.doxygen.org/index.html"> |
|
70 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
|
71 |
</body> |
|
72 |
</html> |
branches/lib_additions/docs/lib/libdragonfly/group__rangefinder.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
|
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.4.6 --> |
|
8 |
<div class="tabs"> |
|
9 |
<ul> |
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
12 |
<li><a href="files.html"><span>Files</span></a></li> |
|
13 |
</ul></div> |
|
14 |
<h1>Rangefinder</h1>Functions for using the IR rangefinders. |
|
15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
16 |
<tr><td></td></tr> |
|
17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" --> |
|
19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">IR1</a> 6</td></tr> |
|
20 |
|
|
21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 1. <br></td></tr> |
|
22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a08e4f5cb3582e623cc14a6c92d48de"></a><!-- doxytag: member="rangefinder::IR2" ref="g5a08e4f5cb3582e623cc14a6c92d48de" args="" --> |
|
23 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">IR2</a> 5</td></tr> |
|
24 |
|
|
25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 2. <br></td></tr> |
|
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26c72d21cca0ec21af4bd9b20ba3ad51"></a><!-- doxytag: member="rangefinder::IR3" ref="g26c72d21cca0ec21af4bd9b20ba3ad51" args="" --> |
|
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">IR3</a> 4</td></tr> |
|
28 |
|
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 3. <br></td></tr> |
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20f2f5908baa0eeba04b9ceaf718cea0"></a><!-- doxytag: member="rangefinder::IR4" ref="g20f2f5908baa0eeba04b9ceaf718cea0" args="" --> |
|
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">IR4</a> 3</td></tr> |
|
32 |
|
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 4. <br></td></tr> |
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23554754d5334bdc35df623e1e012ede"></a><!-- doxytag: member="rangefinder::IR5" ref="g23554754d5334bdc35df623e1e012ede" args="" --> |
|
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a> 2</td></tr> |
|
36 |
|
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 5. <br></td></tr> |
|
38 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
39 |
<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> |
|
40 |
|
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <a href="#g52d0666b725e6d3a14b5bddc28190e59"></a><br></td></tr> |
|
42 |
<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> |
|
43 |
|
|
44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the distance from a rangefinder. <a href="#g22bd0717784e34cb3a0762d78554dcf2"></a><br></td></tr> |
|
45 |
</table> |
|
46 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
47 |
Functions for using the IR rangefinders. |
|
48 |
<p> |
|
49 |
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2> |
|
50 |
<a class="anchor" name="g52d0666b725e6d3a14b5bddc28190e59"></a><!-- doxytag: member="rangefinder.c::range_init" ref="g52d0666b725e6d3a14b5bddc28190e59" args="(void)" --><p> |
|
51 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
52 |
<tr> |
|
53 |
<td class="mdRow"> |
|
54 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
55 |
<tr> |
|
56 |
<td class="md" nowrap valign="top">void range_init </td> |
|
57 |
<td class="md" valign="top">( </td> |
|
58 |
<td class="md" nowrap valign="top">void </td> |
|
59 |
<td class="mdname1" valign="top" nowrap> </td> |
|
60 |
<td class="md" valign="top"> ) </td> |
|
61 |
<td class="md" nowrap></td> |
|
62 |
</tr> |
|
63 |
</table> |
|
64 |
</td> |
|
65 |
</tr> |
|
66 |
</table> |
Also available in: Unified diff