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