Project

General

Profile

Revision 869

Added by Justin Scheiner over 15 years ago

Recompiled documentation with additional documentation for SPI and encoders.

View differences:

group__analog.html
4 4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.5 -->
8 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
7 
<!-- Generated by Doxygen 1.5.4 -->
8 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 
    <li><a href="files.html"><span>Files</span></a></li>
14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 
  </ul>
18 16 
</div>
19 
<div class="contents">
20 17 
<h1>Analog</h1><table border="0" cellpadding="0" cellspacing="0">
21 18 
<tr><td></td></tr>
22 19 
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
......
182 179 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>10-bit analog value for the which port requested</dd></dl>
183 180 
<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 181 

  		




  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>


  		




  186
  
  
    

  		




  187
  182
  
    
</div>


  		




  188
  183
  
    
</div><p>


  		




  189
  184
  
    
<a class="anchor" name="gf1211040ce2c54f12f98df7d47a4eb27"></a><!-- doxytag: member="analog.c::analog8" ref="gf1211040ce2c54f12f98df7d47a4eb27" args="(int which)" -->


  		




  ......




  215
  210
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>8-bit analog value for the which port requested</dd></dl>


  		




  216
  211
  
    
<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
  212
  
    

  		




  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>


  		




  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>


  		




  221
  
  
    

  		




  222
  213
  
    
</div>


  		




  223
  214
  
    
</div><p>


  		




  224
  215
  
    
<a class="anchor" name="g97e97c6d960441518b2572c42c941719"></a><!-- doxytag: member="analog.c::analog_get10" ref="g97e97c6d960441518b2572c42c941719" args="(int which)" -->


  		




  ......




  249
  240
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 10-bit number input to the specified port</dd></dl>


  		




  250
  241
  
    
<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
  242
  
    

  		




  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
  
  
    

  		




  254
  243
  
    
</div>


  		




  255
  244
  
    
</div><p>


  		




  256
  245
  
    
<a class="anchor" name="g1593f0ee57fea252a5ef0146004d7fa9"></a><!-- doxytag: member="analog.c::analog_get8" ref="g1593f0ee57fea252a5ef0146004d7fa9" args="(int which)" -->


  		




  ......




  281
  270
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 8-bit input to the specified port</dd></dl>


  		




  282
  271
  
    
<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
  272
  
    

  		




  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
  
  
    

  		




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


  		




  287
  
  
    

  		




  288
  273
  
    
</div>


  		




  289
  274
  
    
</div><p>


  		




  290
  275
  
    
<a class="anchor" name="g4be2ba5e4db17e5be950af682f9ad522"></a><!-- doxytag: member="analog.c::analog_init" ref="g4be2ba5e4db17e5be950af682f9ad522" args="(int start_conversion)" -->


  		




  ......




  309
  294
  
    
Initializes the ADC. Call analog_init before reading from the analog ports.<p>


  		




  310
  295
  
    
<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
  296
  
    

  		




  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>


  		




  313
  
  
    

  		




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


  		




  315
  
  
    

  		




  316
  297
  
    
</div>


  		




  317
  298
  
    
</div><p>


  		




  318
  299
  
    
<a class="anchor" name="g715fe1182216a43efe6c1545a76037cc"></a><!-- doxytag: member="analog.c::analog_start_loop" ref="g715fe1182216a43efe6c1545a76037cc" args="(void)" -->


  		




  ......




  337
  318
  
    
Starts the analog update loop. Will continue to run until analog_stop_loop is called.<p>


  		




  338
  319
  
    
<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
  320
  
    

  		




  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#l00134">bom_refresh()</a>.</p>


  		




  341
  
  
    

  		




  342
  321
  
    
</div>


  		




  343
  322
  
    
</div><p>


  		




  344
  323
  
    
<a class="anchor" name="g7261449d6a0a02d5717d62e9015d38a6"></a><!-- doxytag: member="analog.c::analog_stop_loop" ref="g7261449d6a0a02d5717d62e9015d38a6" args="(void)" -->


  		




  ......




  363
  342
  
    
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
  343
  
    
<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
  344
  
    

  		




  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#l00134">bom_refresh()</a>.</p>


  		




  367
  
  
    

  		




  368
  345
  
    
</div>


  		




  369
  346
  
    
</div><p>


  		




  370
  347
  
    
<a class="anchor" name="gbc63da8e5431c1d15bc9a61749628f35"></a><!-- doxytag: member="analog.c::set_adc_mux" ref="gbc63da8e5431c1d15bc9a61749628f35" args="(int which)" -->


  		




  ......




  393
  370
  
    
<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>


  		




  394
  371
  
    
<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
  372
  
    

  		




  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
  
  
    

  		




  398
  373
  
    
</div>


  		




  399
  374
  
    
</div><p>


  		




  400
  375
  
    
<a class="anchor" name="g973e63eb508819a37efe3231b6a39550"></a><!-- doxytag: member="analog.c::wheel" ref="g973e63eb508819a37efe3231b6a39550" args="(void)" -->


  		




  ......




  420
  395
  
    
<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
  396
  
    
<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
  397
  
    

  		




  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
  
  
    

  		




  425
  398
  
    
</div>


  		




  426
  399
  
    
</div><p>


  		




  427
  
  
    
</div>


  		




  428
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by&nbsp;


  		




  
  400
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 6 15:44:34 2008 for libdragonfly by&nbsp;


  		




  429
  401
  
    
<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>


  		




  
  402
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>


  		




  431
  403
  
    
</body>


  		




  432
  404
  
    
</html>


  		












Also available in:  Unified diff