root / branches / encoders / docs / libdragonfly / group__analog.html @ 856
History | View | Annotate | Download (16.7 KB)
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 |
<title>libdragonfly: Analog</title> |
4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.4 -->
|
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 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
14 |
</ul>
|
15 |
</div>
|
16 |
<h1>Analog</h1><table border="0" cellpadding="0" cellspacing="0"> |
17 |
<tr><td></td></tr> |
18 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
19 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g099995994c74b5fff8f7de4ff3eac550"></a><!-- doxytag: member="analog::AN0" ref="g099995994c74b5fff8f7de4ff3eac550" args="" --> |
20 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g099995994c74b5fff8f7de4ff3eac550">AN0</a> 0x00</td></tr> |
21 |
|
22 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 0. <br></td></tr> |
23 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4903de2a52966c8dc2c20faf565d451d"></a><!-- doxytag: member="analog::AN1" ref="g4903de2a52966c8dc2c20faf565d451d" args="" --> |
24 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g4903de2a52966c8dc2c20faf565d451d">AN1</a> 0x01</td></tr> |
25 |
|
26 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 1. <br></td></tr> |
27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9b0754e893d69a1e69e856853f70da1f"></a><!-- doxytag: member="analog::AN2" ref="g9b0754e893d69a1e69e856853f70da1f" args="" --> |
28 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g9b0754e893d69a1e69e856853f70da1f">AN2</a> 0x02</td></tr> |
29 |
|
30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 2. <br></td></tr> |
31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9f593faa38f1023698d74f03a457abe3"></a><!-- doxytag: member="analog::AN3" ref="g9f593faa38f1023698d74f03a457abe3" args="" --> |
32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g9f593faa38f1023698d74f03a457abe3">AN3</a> 0x03</td></tr> |
33 |
|
34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 3. <br></td></tr> |
35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdc95f1e9cdc00268d7bca5885052171f"></a><!-- doxytag: member="analog::AN4" ref="gdc95f1e9cdc00268d7bca5885052171f" args="" --> |
36 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gdc95f1e9cdc00268d7bca5885052171f">AN4</a> 0x04</td></tr> |
37 |
|
38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 4. <br></td></tr> |
39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g99ed455a0d536be03f12eba18ccff71b"></a><!-- doxytag: member="analog::AN5" ref="g99ed455a0d536be03f12eba18ccff71b" args="" --> |
40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g99ed455a0d536be03f12eba18ccff71b">AN5</a> 0x05</td></tr> |
41 |
|
42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 5. <br></td></tr> |
43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd63d6861c3fa5e606de5c18ada3b4d10"></a><!-- doxytag: member="analog::AN6" ref="gd63d6861c3fa5e606de5c18ada3b4d10" args="" --> |
44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gd63d6861c3fa5e606de5c18ada3b4d10">AN6</a> 0x06</td></tr> |
45 |
|
46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 6. <br></td></tr> |
47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g277d706ee82bd70459b63e85489c7074"></a><!-- doxytag: member="analog::AN7" ref="g277d706ee82bd70459b63e85489c7074" args="" --> |
48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g277d706ee82bd70459b63e85489c7074">AN7</a> 0x07</td></tr> |
49 |
|
50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 7. <br></td></tr> |
51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g28b64348820dbb25c903d24f2e38a8a7"></a><!-- doxytag: member="analog::AN8" ref="g28b64348820dbb25c903d24f2e38a8a7" args="" --> |
52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g28b64348820dbb25c903d24f2e38a8a7">AN8</a> 0x08</td></tr> |
53 |
|
54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 8. <br></td></tr> |
55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2fb7e4f4e0ea1f172eef79ed1f92e15f"></a><!-- doxytag: member="analog::AN9" ref="g2fb7e4f4e0ea1f172eef79ed1f92e15f" args="" --> |
56 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g2fb7e4f4e0ea1f172eef79ed1f92e15f">AN9</a> 0x09</td></tr> |
57 |
|
58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 9. <br></td></tr> |
59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc63caaf5f7a06a02522cb7f90d6c1959"></a><!-- doxytag: member="analog::AN10" ref="gc63caaf5f7a06a02522cb7f90d6c1959" args="" --> |
60 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gc63caaf5f7a06a02522cb7f90d6c1959">AN10</a> 0x0a</td></tr> |
61 |
|
62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 10. <br></td></tr> |
63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfeb79b00aaef4734408a910838f7872"></a><!-- doxytag: member="analog::AN11" ref="gdfeb79b00aaef4734408a910838f7872" args="" --> |
64 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gdfeb79b00aaef4734408a910838f7872">AN11</a> 0x0b</td></tr> |
65 |
|
66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 11. <br></td></tr> |
67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7a50a07e69f38b6674b0494dfbc653f9"></a><!-- doxytag: member="analog::AN12" ref="g7a50a07e69f38b6674b0494dfbc653f9" args="" --> |
68 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g7a50a07e69f38b6674b0494dfbc653f9">AN12</a> 0x0c</td></tr> |
69 |
|
70 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 12. <br></td></tr> |
71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf80851ae45ddfe4bfdfc10541c255ad"></a><!-- doxytag: member="analog::AN13" ref="gbf80851ae45ddfe4bfdfc10541c255ad" args="" --> |
72 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gbf80851ae45ddfe4bfdfc10541c255ad">AN13</a> 0x0d</td></tr> |
73 |
|
74 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 13. <br></td></tr> |
75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g817772a1db513b734dfe4475c3616061"></a><!-- doxytag: member="analog::AN14" ref="g817772a1db513b734dfe4475c3616061" args="" --> |
76 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g817772a1db513b734dfe4475c3616061">AN14</a> 0x0e</td></tr> |
77 |
|
78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 14. <br></td></tr> |
79 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g797adbadae057ff7aa766d84b4f180f9"></a><!-- doxytag: member="analog::AN15" ref="g797adbadae057ff7aa766d84b4f180f9" args="" --> |
80 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g797adbadae057ff7aa766d84b4f180f9">AN15</a> 0x0f</td></tr> |
81 |
|
82 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port 15. <br></td></tr> |
83 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3434ce39eaea22b46a0100b7fd3a6f47"></a><!-- doxytag: member="analog::EXT_MUX" ref="g3434ce39eaea22b46a0100b7fd3a6f47" args="" --> |
84 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g3434ce39eaea22b46a0100b7fd3a6f47">EXT_MUX</a> AN7</td></tr> |
85 |
|
86 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">EXT_MUX analog port. <br></td></tr> |
87 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6538d2deb002b8441891dc4e15cd104"></a><!-- doxytag: member="analog::WHEEL_PORT" ref="ga6538d2deb002b8441891dc4e15cd104" args="" --> |
88 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#ga6538d2deb002b8441891dc4e15cd104">WHEEL_PORT</a> AN10</td></tr> |
89 |
|
90 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port for the wheel. <br></td></tr> |
91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gadcd026a2c91fe96c8134619c87bb72a"></a><!-- doxytag: member="analog::BATT_PORT" ref="gadcd026a2c91fe96c8134619c87bb72a" args="" --> |
92 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gadcd026a2c91fe96c8134619c87bb72a">BATT_PORT</a> AN11</td></tr> |
93 |
|
94 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analog port for the battery voltage detector. <br></td></tr> |
95 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
96 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a> (void)</td></tr> |
97 |
|
98 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize analog ports. <a href="#g55f66ff6f3449ef81d97b7e47f041918"></a><br></td></tr> |
99 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27">analog8</a> (int which)</td></tr> |
100 |
|
101 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read an 8-bit number from an analog port. <a href="#gf1211040ce2c54f12f98df7d47a4eb27"></a><br></td></tr> |
102 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3">analog10</a> (int which)</td></tr> |
103 |
|
104 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a 10-bit number from an analog port. <a href="#g875bf8cb165a3a288eb1aa2ac06be4f3"></a><br></td></tr> |
105 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__analog.html#g973e63eb508819a37efe3231b6a39550">wheel</a> (void)</td></tr> |
106 |
|
107 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the position of the wheel. <a href="#g973e63eb508819a37efe3231b6a39550"></a><br></td></tr> |
108 |
</table>
|
109 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
110 |
Functions for manipulation the ADC on the dragonfly board. All definitions may be found in <a class="el" href="analog_8h.html" title="Contains functions and definitions for using the ADC.">analog.h</a>. <hr><h2>Function Documentation</h2> |
111 |
<a class="anchor" name="g875bf8cb165a3a288eb1aa2ac06be4f3"></a><!-- doxytag: member="analog.c::analog10" ref="g875bf8cb165a3a288eb1aa2ac06be4f3" args="(int which)" --> |
112 |
<div class="memitem"> |
113 |
<div class="memproto"> |
114 |
<table class="memname"> |
115 |
<tr>
|
116 |
<td class="memname">unsigned int analog10 </td> |
117 |
<td>(</td> |
118 |
<td class="paramtype">int </td> |
119 |
<td class="paramname"> <em>which</em> </td> |
120 |
<td> ) </td> |
121 |
<td width="100%"></td> |
122 |
</tr>
|
123 |
</table>
|
124 |
</div>
|
125 |
<div class="memdoc"> |
126 |
|
127 |
<p>
|
128 |
Read a 10-bit number from an analog port. |
129 |
<p>
|
130 |
Reads a ten bit number from the specified port. analog_init must be called before using this function.<p>
|
131 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
132 |
<table border="0" cellspacing="2" cellpadding="0"> |
133 |
<tr><td valign="top"></td><td valign="top"><em>which</em> </td><td>the analog port to read from. Typically a constant, one of AN0 - AN7.</td></tr> |
134 |
</table>
|
135 |
</dl>
|
136 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the ten bit number input to the specified port</dd></dl> |
137 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27" title="Read an 8-bit number from an analog port.">analog8</a> </dd></dl> |
138 |
|
139 |
</div>
|
140 |
</div><p> |
141 |
<a class="anchor" name="gf1211040ce2c54f12f98df7d47a4eb27"></a><!-- doxytag: member="analog.c::analog8" ref="gf1211040ce2c54f12f98df7d47a4eb27" args="(int which)" --> |
142 |
<div class="memitem"> |
143 |
<div class="memproto"> |
144 |
<table class="memname"> |
145 |
<tr>
|
146 |
<td class="memname">unsigned int analog8 </td> |
147 |
<td>(</td> |
148 |
<td class="paramtype">int </td> |
149 |
<td class="paramname"> <em>which</em> </td> |
150 |
<td> ) </td> |
151 |
<td width="100%"></td> |
152 |
</tr>
|
153 |
</table>
|
154 |
</div>
|
155 |
<div class="memdoc"> |
156 |
|
157 |
<p>
|
158 |
Read an 8-bit number from an analog port. |
159 |
<p>
|
160 |
Reads an eight bit number from an analog port. analog_init must be called before using this function.<p>
|
161 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
162 |
<table border="0" cellspacing="2" cellpadding="0"> |
163 |
<tr><td valign="top"></td><td valign="top"><em>which</em> </td><td>the analog port to read from. One of the constants AN0 - AN7.</td></tr> |
164 |
</table>
|
165 |
</dl>
|
166 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the eight bit input to the specified port</dd></dl> |
167 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a>, <a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3" title="Read a 10-bit number from an analog port.">analog10</a> </dd></dl> |
168 |
|
169 |
</div>
|
170 |
</div><p> |
171 |
<a class="anchor" name="g55f66ff6f3449ef81d97b7e47f041918"></a><!-- doxytag: member="analog.c::analog_init" ref="g55f66ff6f3449ef81d97b7e47f041918" args="(void)" --> |
172 |
<div class="memitem"> |
173 |
<div class="memproto"> |
174 |
<table class="memname"> |
175 |
<tr>
|
176 |
<td class="memname">void analog_init </td> |
177 |
<td>(</td> |
178 |
<td class="paramtype">void </td> |
179 |
<td class="paramname"> </td> |
180 |
<td> ) </td> |
181 |
<td width="100%"></td> |
182 |
</tr>
|
183 |
</table>
|
184 |
</div>
|
185 |
<div class="memdoc"> |
186 |
|
187 |
<p>
|
188 |
Initialize analog ports. |
189 |
<p>
|
190 |
Initializes the ADC. Call analog_init before reading from the analog ports.<p>
|
191 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27" title="Read an 8-bit number from an analog port.">analog8</a>, <a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3" title="Read a 10-bit number from an analog port.">analog10</a> </dd></dl> |
192 |
|
193 |
</div>
|
194 |
</div><p> |
195 |
<a class="anchor" name="g973e63eb508819a37efe3231b6a39550"></a><!-- doxytag: member="analog.c::wheel" ref="g973e63eb508819a37efe3231b6a39550" args="(void)" --> |
196 |
<div class="memitem"> |
197 |
<div class="memproto"> |
198 |
<table class="memname"> |
199 |
<tr>
|
200 |
<td class="memname">int wheel </td> |
201 |
<td>(</td> |
202 |
<td class="paramtype">void </td> |
203 |
<td class="paramname"> </td> |
204 |
<td> ) </td> |
205 |
<td width="100%"></td> |
206 |
</tr>
|
207 |
</table>
|
208 |
</div>
|
209 |
<div class="memdoc"> |
210 |
|
211 |
<p>
|
212 |
Read the position of the wheel. |
213 |
<p>
|
214 |
Returns the current position of the wheel, as an integer in the range 0 - 255. analog_init must be called before using this function.<p>
|
215 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the orientation of the wheel, as an integer in the range 0 - 255.</dd></dl> |
216 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918" title="Initialize analog ports.">analog_init</a> </dd></dl> |
217 |
|
218 |
</div>
|
219 |
</div><p> |
220 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 22 22:30:16 2008 for libdragonfly by |
221 |
<a href="http://www.doxygen.org/index.html"> |
222 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> |
223 |
</body>
|
224 |
</html>
|