Project

General

Profile

Revision 1398

Added by Chris Mar over 14 years ago

recompiled libdragonfly to include new rangefinder doxygen comments

View differences:

group__analog.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libdragonfly: Analog</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6
</head><body>
7
<!-- Generated by Doxygen 1.5.5 -->
7
<!-- Generated by Doxygen 1.5.9 -->
8 8
<div class="navigation" id="top">
9 9
  <div class="tabs">
10 10
    <ul>
......
163 163
          <td class="paramtype">int&nbsp;</td>
164 164
          <td class="paramname"> <em>which</em>          </td>
165 165
          <td>&nbsp;)&nbsp;</td>
166
          <td width="100%"></td>
166
          <td></td>
167 167
        </tr>
168 168
      </table>
169 169
</div>
......
178 178
    <tr><td valign="top"></td><td valign="top"><em>which</em>&nbsp;</td><td>the port that you want to read</td></tr>
179 179
  </table>
180 180
</dl>
181
<dl compact><dt><b><a class="el" href="bug.html#_bug000002">Bug:</a></b></dt><dd>may cause a seg fault if which is a larger value than exists in an_val table. Not sure if we should fix this or not since it would add overhead.</dd></dl>
181
<dl class="bug" compact><dt><b><a class="el" href="bug.html#_bug000002">Bug:</a></b></dt><dd>may cause a seg fault if which is a larger value than exists in an_val table. Not sure if we should fix this or not since it would add overhead.</dd></dl>
182 182
<dl class="return" compact><dt><b>Returns:</b></dt><dd>10-bit analog value for the which port requested</dd></dl>
183 183
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27" title="Returns an 8-bit analog value from the look up table. Use this instead of analog_get8...">analog8</a>, <a class="el" href="group__analog.html#g1593f0ee57fea252a5ef0146004d7fa9" title="Read an 8-bit number from an analog port. Loop must be stopped for this to work.">analog_get8</a>, <a class="el" href="group__analog.html#g97e97c6d960441518b2572c42c941719" title="Read a 10-bit number from an analog port. Loop must be stopped for this to work.">analog_get10</a> </dd></dl>
184 184

  
185
<p>References <a class="el" href="analog_8h-source.html#l00102">adc_t::adc10</a>, and <a class="el" href="analog_8h-source.html#l00086">BOM_PORT</a>.</p>
185
<p>References <a class="el" href="analog_8h_source.html#l00086">BOM_PORT</a>.</p>
186 186

  
187 187
</div>
188 188
</div><p>
......
196 196
          <td class="paramtype">int&nbsp;</td>
197 197
          <td class="paramname"> <em>which</em>          </td>
198 198
          <td>&nbsp;)&nbsp;</td>
199
          <td width="100%"></td>
199
          <td></td>
200 200
        </tr>
201 201
      </table>
202 202
</div>
......
211 211
    <tr><td valign="top"></td><td valign="top"><em>which</em>&nbsp;</td><td>the port that you want to read</td></tr>
212 212
  </table>
213 213
</dl>
214
<dl compact><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>may cause a seg fault if which is a larger value than exists in an_val table. Not sure if we should fix this or not since it would add overhead.</dd></dl>
214
<dl class="bug" compact><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>may cause a seg fault if which is a larger value than exists in an_val table. Not sure if we should fix this or not since it would add overhead.</dd></dl>
215 215
<dl class="return" compact><dt><b>Returns:</b></dt><dd>8-bit analog value for the which port requested</dd></dl>
216 216
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3" title="Returns an 10-bit analog value from the look up table. Use this instead of analog_get10...">analog10</a>, <a class="el" href="group__analog.html#g1593f0ee57fea252a5ef0146004d7fa9" title="Read an 8-bit number from an analog port. Loop must be stopped for this to work.">analog_get8</a>, <a class="el" href="group__analog.html#g97e97c6d960441518b2572c42c941719" title="Read a 10-bit number from an analog port. Loop must be stopped for this to work.">analog_get10</a> </dd></dl>
217 217

  
218
<p>References <a class="el" href="analog_8h-source.html#l00101">adc_t::adc8</a>, and <a class="el" href="analog_8h-source.html#l00086">BOM_PORT</a>.</p>
218
<p>References <a class="el" href="analog_8h_source.html#l00086">BOM_PORT</a>.</p>
219 219

  
220
<p>Referenced by <a class="el" href="battery_8c-source.html#l00082">battery()</a>, <a class="el" href="battery_8c-source.html#l00069">battery8()</a>, <a class="el" href="rangefinder_8c-source.html#l00135">range_read_distance()</a>, and <a class="el" href="analog_8c-source.html#l00269">wheel()</a>.</p>
220
<p>Referenced by <a class="el" href="battery_8c_source.html#l00082">battery()</a>, <a class="el" href="battery_8c_source.html#l00069">battery8()</a>, <a class="el" href="rangefinder_8c_source.html#l00131">range_read_distance()</a>, and <a class="el" href="analog_8c_source.html#l00269">wheel()</a>.</p>
221 221

  
222 222
</div>
223 223
</div><p>
......
231 231
          <td class="paramtype">int&nbsp;</td>
232 232
          <td class="paramname"> <em>which</em>          </td>
233 233
          <td>&nbsp;)&nbsp;</td>
234
          <td width="100%"></td>
234
          <td></td>
235 235
        </tr>
236 236
      </table>
237 237
</div>
......
249 249
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 10-bit number input to the specified port</dd></dl>
250 250
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a>, <a class="el" href="group__analog.html#g1593f0ee57fea252a5ef0146004d7fa9" title="Read an 8-bit number from an analog port. Loop must be stopped for this to work.">analog_get8</a>, <a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3" title="Returns an 10-bit analog value from the look up table. Use this instead of analog_get10...">analog10</a>, <a class="el" href="group__analog.html#g7261449d6a0a02d5717d62e9015d38a6" title="Stops the analog loop. Doesn&#39;t do anything if the loop is already stopped.">analog_stop_loop</a>, <a class="el" href="group__analog.html#g715fe1182216a43efe6c1545a76037cc" title="starts the analog loop. Doesn&#39;t do anything if the loop is already running.">analog_start_loop</a> </dd></dl>
251 251

  
252
<p>References <a class="el" href="analog_8h-source.html#l00088">EXT_MUX</a>, and <a class="el" href="analog_8c-source.html#l00288">set_adc_mux()</a>.</p>
252
<p>References <a class="el" href="analog_8h_source.html#l00088">EXT_MUX</a>, and <a class="el" href="analog_8c_source.html#l00288">set_adc_mux()</a>.</p>
253 253

  
254 254
</div>
255 255
</div><p>
......
263 263
          <td class="paramtype">int&nbsp;</td>
264 264
          <td class="paramname"> <em>which</em>          </td>
265 265
          <td>&nbsp;)&nbsp;</td>
266
          <td width="100%"></td>
266
          <td></td>
267 267
        </tr>
268 268
      </table>
269 269
</div>
......
281 281
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 8-bit input to the specified port</dd></dl>
282 282
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a>, <a class="el" href="group__analog.html#g97e97c6d960441518b2572c42c941719" title="Read a 10-bit number from an analog port. Loop must be stopped for this to work.">analog_get10</a>, <a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27" title="Returns an 8-bit analog value from the look up table. Use this instead of analog_get8...">analog8</a>, <a class="el" href="group__analog.html#g7261449d6a0a02d5717d62e9015d38a6" title="Stops the analog loop. Doesn&#39;t do anything if the loop is already stopped.">analog_stop_loop</a>, <a class="el" href="group__analog.html#g715fe1182216a43efe6c1545a76037cc" title="starts the analog loop. Doesn&#39;t do anything if the loop is already running.">analog_start_loop</a> </dd></dl>
283 283

  
284
<p>References <a class="el" href="analog_8h-source.html#l00088">EXT_MUX</a>, and <a class="el" href="analog_8c-source.html#l00288">set_adc_mux()</a>.</p>
284
<p>References <a class="el" href="analog_8h_source.html#l00088">EXT_MUX</a>, and <a class="el" href="analog_8c_source.html#l00288">set_adc_mux()</a>.</p>
285 285

  
286
<p>Referenced by <a class="el" href="bom_8c-source.html#l00168">bom_refresh()</a>.</p>
286
<p>Referenced by <a class="el" href="bom_8c_source.html#l00168">bom_refresh()</a>.</p>
287 287

  
288 288
</div>
289 289
</div><p>
......
297 297
          <td class="paramtype">int&nbsp;</td>
298 298
          <td class="paramname"> <em>start_conversion</em>          </td>
299 299
          <td>&nbsp;)&nbsp;</td>
300
          <td width="100%"></td>
300
          <td></td>
301 301
        </tr>
302 302
      </table>
303 303
</div>
......
309 309
Initializes the ADC. Call analog_init before reading from the analog ports.<p>
310 310
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf1211040ce2c54f12f98df7d47a4eb27" title="Returns an 8-bit analog value from the look up table. Use this instead of analog_get8...">analog8</a>, <a class="el" href="group__analog.html#g875bf8cb165a3a288eb1aa2ac06be4f3" title="Returns an 10-bit analog value from the look up table. Use this instead of analog_get10...">analog10</a>, <a class="el" href="group__analog.html#g1593f0ee57fea252a5ef0146004d7fa9" title="Read an 8-bit number from an analog port. Loop must be stopped for this to work.">analog_get8</a>, <a class="el" href="group__analog.html#g97e97c6d960441518b2572c42c941719" title="Read a 10-bit number from an analog port. Loop must be stopped for this to work.">analog_get10</a> </dd></dl>
311 311

  
312
<p>References <a class="el" href="analog_8h-source.html#l00102">adc_t::adc10</a>, <a class="el" href="analog_8h-source.html#l00101">adc_t::adc8</a>, <a class="el" href="analog_8h-source.html#l00055">AN1</a>, <a class="el" href="analog_8c-source.html#l00160">analog_start_loop()</a>, <a class="el" href="analog_8c-source.html#l00174">analog_stop_loop()</a>, and <a class="el" href="analog_8c-source.html#l00288">set_adc_mux()</a>.</p>
312
<p>References <a class="el" href="analog_8h_source.html#l00055">AN1</a>, <a class="el" href="analog_8c_source.html#l00160">analog_start_loop()</a>, <a class="el" href="analog_8c_source.html#l00174">analog_stop_loop()</a>, and <a class="el" href="analog_8c_source.html#l00288">set_adc_mux()</a>.</p>
313 313

  
314
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>
314
<p>Referenced by <a class="el" href="dragonfly__lib_8c_source.html#l00068">dragonfly_init()</a>.</p>
315 315

  
316 316
</div>
317 317
</div><p>
......
325 325
          <td class="paramtype">void&nbsp;</td>
326 326
          <td class="paramname">          </td>
327 327
          <td>&nbsp;)&nbsp;</td>
328
          <td width="100%"></td>
328
          <td></td>
329 329
        </tr>
330 330
      </table>
331 331
</div>
......
337 337
Starts the analog update loop. Will continue to run until analog_stop_loop is called.<p>
338 338
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g7261449d6a0a02d5717d62e9015d38a6" title="Stops the analog loop. Doesn&#39;t do anything if the loop is already stopped.">analog_stop_loop</a> </dd></dl>
339 339

  
340
<p>Referenced by <a class="el" href="analog_8c-source.html#l00061">analog_init()</a>, and <a class="el" href="bom_8c-source.html#l00168">bom_refresh()</a>.</p>
340
<p>Referenced by <a class="el" href="analog_8c_source.html#l00061">analog_init()</a>, and <a class="el" href="bom_8c_source.html#l00168">bom_refresh()</a>.</p>
341 341

  
342 342
</div>
343 343
</div><p>
......
351 351
          <td class="paramtype">void&nbsp;</td>
352 352
          <td class="paramname">          </td>
353 353
          <td>&nbsp;)&nbsp;</td>
354
          <td width="100%"></td>
354
          <td></td>
355 355
        </tr>
356 356
      </table>
357 357
</div>
......
363 363
Stops the analog update loop. If there is a current read, it will finish up and be stored before the loop is interrupted. No further updates will be made until the loop is started again.<p>
364 364
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g715fe1182216a43efe6c1545a76037cc" title="starts the analog loop. Doesn&#39;t do anything if the loop is already running.">analog_start_loop</a> </dd></dl>
365 365

  
366
<p>Referenced by <a class="el" href="analog_8c-source.html#l00061">analog_init()</a>, and <a class="el" href="bom_8c-source.html#l00168">bom_refresh()</a>.</p>
366
<p>Referenced by <a class="el" href="analog_8c_source.html#l00061">analog_init()</a>, and <a class="el" href="bom_8c_source.html#l00168">bom_refresh()</a>.</p>
367 367

  
368 368
</div>
369 369
</div><p>
......
377 377
          <td class="paramtype">int&nbsp;</td>
378 378
          <td class="paramname"> <em>which</em>          </td>
379 379
          <td>&nbsp;)&nbsp;</td>
380
          <td width="100%"></td>
380
          <td></td>
381 381
        </tr>
382 382
      </table>
383 383
</div>
......
390 390
    <tr><td valign="top"></td><td valign="top"><em>which</em>&nbsp;</td><td>which analog mux port (0-7) which corresponds to AN8-AN15.</td></tr>
391 391
  </table>
392 392
</dl>
393
<dl compact><dt><b><a class="el" href="bug.html#_bug000003">Bug:</a></b></dt><dd>FIX THIS IN THE NEXT BOARD REVISION: ADDR2 ADDR1 ADDR0 G2.G4.G3 set mux to port 0-7 via vinary selection math would be much cleaner if it was G4.G3.G2</dd></dl>
393
<dl class="bug" compact><dt><b><a class="el" href="bug.html#_bug000003">Bug:</a></b></dt><dd>FIX THIS IN THE NEXT BOARD REVISION: ADDR2 ADDR1 ADDR0 G2.G4.G3 set mux to port 0-7 via vinary selection math would be much cleaner if it was G4.G3.G2</dd></dl>
394 394
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a> </dd></dl>
395 395

  
396
<p>Referenced by <a class="el" href="analog_8c-source.html#l00233">analog_get10()</a>, <a class="el" href="analog_8c-source.html#l00195">analog_get8()</a>, and <a class="el" href="analog_8c-source.html#l00061">analog_init()</a>.</p>
396
<p>Referenced by <a class="el" href="analog_8c_source.html#l00233">analog_get10()</a>, <a class="el" href="analog_8c_source.html#l00195">analog_get8()</a>, and <a class="el" href="analog_8c_source.html#l00061">analog_init()</a>.</p>
397 397

  
398 398
</div>
399 399
</div><p>
......
407 407
          <td class="paramtype">void&nbsp;</td>
408 408
          <td class="paramname">          </td>
409 409
          <td>&nbsp;)&nbsp;</td>
410
          <td width="100%"></td>
410
          <td></td>
411 411
        </tr>
412 412
      </table>
413 413
</div>
......
420 420
<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>
421 421
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a> </dd></dl>
422 422

  
423
<p>References <a class="el" href="analog_8c-source.html#l00119">analog8()</a>, and <a class="el" href="analog_8h-source.html#l00090">WHEEL_PORT</a>.</p>
423
<p>References <a class="el" href="analog_8c_source.html#l00119">analog8()</a>, and <a class="el" href="analog_8h_source.html#l00090">WHEEL_PORT</a>.</p>
424 424

  
425 425
</div>
426 426
</div><p>
427 427
</div>
428
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:08 2009 for libdragonfly by&nbsp;
428
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;
429 429
<a href="http://www.doxygen.org/index.html">
430
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
430
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
431 431
</body>
432 432
</html>

Also available in: Unified diff