Project

General

Profile

Revision 862

Added by Kevin Woo over 15 years ago

Updated analog.c and analog.h documentation and regenerated the docs. No need to remake the library as its just comments.

View differences:

group__bom.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.3 -->
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>
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>
16 18 
</div>
19 
<div class="contents">
17 20 
<h1>BOM (Bearing and Orientation Module)</h1>Functions for dealing with the BOM.
18 21 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
19 22 
<tr><td></td></tr>
......
55 58 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns off the selected bom leds. Only works with BOM_ALL if using the original bom.  <a href="#gf3fb24ce85166158df75f7d5f391f3ad"></a><br></td></tr>
56 59 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g86753fe7440cd64e60c58ad31c62264a">get_max_bom</a> (void)</td></tr>
57 60 

  		




  58
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Gets and compares all bom values. Returns the index to the highest value element.  <a href="#g86753fe7440cd64e60c58ad31c62264a"></a><br></td></tr>


  		




  
  61
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Wrapper function. See bom_refresh and bom_get_max  <a href="#g86753fe7440cd64e60c58ad31c62264a"></a><br></td></tr>


  		




  59
  62
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf">bom_on</a> (void)</td></tr>


  		




  60
  63
  
    

  		




  61
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Turns on all bom leds.  <a href="#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr>


  		




  
  64
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Wrapper function. See bom_leds_on.  <a href="#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr>


  		




  62
  65
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30">bom_off</a> (void)</td></tr>


  		




  63
  66
  
    

  		




  64
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Turns off all bom leds.  <a href="#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr>


  		




  
  67
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Wrapper function. See bom_leds_off.  <a href="#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr>


  		




  65
  68
  
    
</table>


  		




  66
  69
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  67
  70
  
    
Functions for dealing with the BOM. 


  		




  ......




  94
  97
  
    
  </table>


  		




  95
  98
  
    
</dl>


  		




  96
  99
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the bom value</dd></dl>


  		




  97
  
  
    
see bom_refresh 


  		




  
  100
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc" title="Refresh bom_val[] with new values from analog8. analog_init and bom_init must be...">bom_refresh</a> </dd></dl>


  		




  
  101
  
    

  		




  98
  102
  
    
</div>


  		




  99
  103
  
    
</div><p>


  		




  100
  104
  
    
<a class="anchor" name="gbce8d8dd8f11d8f5e9f9d74d84ea15db"></a><!-- doxytag: member="bom.c::bom_get_max" ref="gbce8d8dd8f11d8f5e9f9d74d84ea15db" args="(void)" -->


  		




  ......




  116
  120
  
    
<p>


  		




  117
  121
  
    
Compares all the values in bom_val[] and returns the index to the highest value element. 


  		




  118
  122
  
    
<p>


  		




  119
  
  
    
Compares all the values in bom_val[] and returns the index to the lowest (max) value element.<p>


  		




  
  123
  
    
Compares all the values in bom_val[] and returns the index to the lowest (max) value element. Returns the direction of the maximum BOM reading,as an integer in the range 0-15. 0 indicates to the robot's right, while the rest of the sensors are numbered counterclockwise.<p>


  		




  120
  124
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>index to the lowest (max) bom value element. -1 if no value is lower than BOM_VALUE_THRESHOLD </dd></dl>


  		




  121
  125
  
    

  		




  
  126
  
    
<p>Referenced by <a class="el" href="bom_8c-source.html#l00242">get_max_bom()</a>.</p>


  		




  
  127
  
    

  		




  122
  128
  
    
</div>


  		




  123
  129
  
    
</div><p>


  		




  124
  130
  
    
<a class="anchor" name="g101f932380b02b48a0ca3d20ffc8c08f"></a><!-- doxytag: member="bom.c::bom_init" ref="g101f932380b02b48a0ca3d20ffc8c08f" args="(char type)" -->


  		




  ......




  144
  150
  
    
INCOMPLETE - need to fill in init routine for BOM15<p>


  		




  145
  151
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc" title="Refresh bom_val[] with new values from analog8. analog_init and bom_init must be...">bom_refresh</a>, <a class="el" href="group__bom.html#g2f5fae400bcc24d266c84ca441a1516c" title="Turns on the selected bom leds. Only works with BOM_ALL if using the original bom...">bom_leds_on</a>, <a class="el" href="group__bom.html#gf3fb24ce85166158df75f7d5f391f3ad" title="Turns off the selected bom leds. Only works with BOM_ALL if using the original bom...">bom_leds_off</a> </dd></dl>


  		




  146
  152
  
    

  		




  
  153
  
    
<p>References <a class="el" href="bom_8h-source.html#l00049">BOM</a>, <a class="el" href="bom_8h-source.html#l00051">BOM15</a>, and <a class="el" href="bom_8h-source.html#l00053">RBOM</a>.</p>


  		




  
  154
  
    

  		




  147
  155
  
    
</div>


  		




  148
  156
  
    
</div><p>


  		




  149
  157
  
    
<a class="anchor" name="gf3fb24ce85166158df75f7d5f391f3ad"></a><!-- doxytag: member="bom.c::bom_leds_off" ref="gf3fb24ce85166158df75f7d5f391f3ad" args="(int bit_field)" -->


  		




  ......




  172
  180
  
    
  </table>


  		




  173
  181
  
    
</dl>


  		




  174
  182
  
    

  		




  
  183
  
    
<p>References <a class="el" href="bom_8h-source.html#l00049">BOM</a>, <a class="el" href="bom_8h-source.html#l00051">BOM15</a>, <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00053">RBOM</a>.</p>


  		




  
  184
  
    

  		




  
  185
  
    
<p>Referenced by <a class="el" href="bom_8c-source.html#l00262">bom_off()</a>.</p>


  		




  
  186
  
    

  		




  175
  187
  
    
</div>


  		




  176
  188
  
    
</div><p>


  		




  177
  189
  
    
<a class="anchor" name="g2f5fae400bcc24d266c84ca441a1516c"></a><!-- doxytag: member="bom.c::bom_leds_on" ref="g2f5fae400bcc24d266c84ca441a1516c" args="(int bit_field)" -->


  		




  ......




  200
  212
  
    
  </table>


  		




  201
  213
  
    
</dl>


  		




  202
  214
  
    

  		




  
  215
  
    
<p>References <a class="el" href="bom_8h-source.html#l00049">BOM</a>, <a class="el" href="bom_8h-source.html#l00051">BOM15</a>, <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00053">RBOM</a>.</p>


  		




  
  216
  
    

  		




  
  217
  
    
<p>Referenced by <a class="el" href="bom_8c-source.html#l00252">bom_on()</a>.</p>


  		




  
  218
  
    

  		




  203
  219
  
    
</div>


  		




  204
  220
  
    
</div><p>


  		




  205
  221
  
    
<a class="anchor" name="g61a66e53cdee8bce139c707153143b30"></a><!-- doxytag: member="bom.c::bom_off" ref="g61a66e53cdee8bce139c707153143b30" args="(void)" -->


  		




  ......




  219
  235
  
    
<div class="memdoc">


  		




  220
  236
  
    

  		




  221
  237
  
    
<p>


  		




  222
  
  
    
(DEPRECATED) Turns off all bom leds. 


  		




  
  238
  
    
(DEPRECATED) Wrapper function. See bom_leds_off. 


  		




  223
  239
  
    
<p>


  		




  224
  240
  
    
(DEPRECATED) Turns off all bom leds.<p>


  		




  225
  
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf" title="(DEPRECATED) Turns on all bom leds.">bom_on</a> </dd></dl>


  		




  
  241
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf" title="(DEPRECATED) Wrapper function. See bom_leds_on.">bom_on</a> </dd></dl>


  		




  226
  242
  
    

  		




  
  243
  
    
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, and <a class="el" href="bom_8c-source.html#l00218">bom_leds_off()</a>.</p>


  		




  
  244
  
    

  		




  227
  245
  
    
</div>


  		




  228
  246
  
    
</div><p>


  		




  229
  247
  
    
<a class="anchor" name="g93b665ff81fc6b58503c6ba5ba01c1bf"></a><!-- doxytag: member="bom.c::bom_on" ref="g93b665ff81fc6b58503c6ba5ba01c1bf" args="(void)" -->


  		




  ......




  243
  261
  
    
<div class="memdoc">


  		




  244
  262
  
    

  		




  245
  263
  
    
<p>


  		




  246
  
  
    
(DEPRECATED) Turns on all bom leds. 


  		




  
  264
  
    
(DEPRECATED) Wrapper function. See bom_leds_on. 


  		




  247
  265
  
    
<p>


  		




  248
  266
  
    
(DEPRECATED) Turns on all bom leds.<p>


  		




  249
  
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30" title="(DEPRECATED) Turns off all bom leds.">bom_off</a> </dd></dl>


  		




  
  267
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30" title="(DEPRECATED) Wrapper function. See bom_leds_off.">bom_off</a> </dd></dl>


  		




  250
  268
  
    

  		




  
  269
  
    
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, and <a class="el" href="bom_8c-source.html#l00195">bom_leds_on()</a>.</p>


  		




  
  270
  
    

  		




  251
  271
  
    
</div>


  		




  252
  272
  
    
</div><p>


  		




  253
  273
  
    
<a class="anchor" name="gbdcdf3a1428f8145ee5eed82efdaf0fc"></a><!-- doxytag: member="bom.c::bom_refresh" ref="gbdcdf3a1428f8145ee5eed82efdaf0fc" args="(int bit_field)" -->


  		




  ......




  277
  297
  
    
</dl>


  		




  278
  298
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gd28d2a59a5090390e20f87cfd05b0a8b" title="Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new...">bom_get</a> </dd></dl>


  		




  279
  299
  
    

  		




  
  300
  
    
<p>References <a class="el" href="analog_8c-source.html#l00195">analog_get8()</a>, <a class="el" href="analog_8c-source.html#l00160">analog_start_loop()</a>, and <a class="el" href="analog_8c-source.html#l00174">analog_stop_loop()</a>.</p>


  		




  
  301
  
    

  		




  
  302
  
    
<p>Referenced by <a class="el" href="bom_8c-source.html#l00242">get_max_bom()</a>.</p>


  		




  
  303
  
    

  		




  280
  304
  
    
</div>


  		




  281
  305
  
    
</div><p>


  		




  282
  306
  
    
<a class="anchor" name="g86753fe7440cd64e60c58ad31c62264a"></a><!-- doxytag: member="bom.c::get_max_bom" ref="g86753fe7440cd64e60c58ad31c62264a" args="(void)" -->


  		




  ......




  296
  320
  
    
<div class="memdoc">


  		




  297
  321
  
    

  		




  298
  322
  
    
<p>


  		




  299
  
  
    
(DEPRECATED) Gets and compares all bom values. Returns the index to the highest value element. 


  		




  
  323
  
    
(DEPRECATED) Wrapper function. See bom_refresh and bom_get_max 


  		




  300
  324
  
    
<p>


  		




  301
  
  
    
(DEPRECATED) Returns the direction of the maximum BOM reading, as an integer in the range 0-15. 0 indicates to the robot's right, while the rest of the sensors are numbered counterclockwise. This is useful for determining the direction of a robot flashing its BOM, of only one robot is currently doing so. analog_init must be called before this function can be used.<p>


  		




  
  325
  
    
(DEPRECATED) Wrapper function for new BOM code. Refreshes buffer and returns the max bom value.<p>


  		




  302
  326
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the direction of the maximum BOM reading</dd></dl>


  		




  303
  
  
    
<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>


  		




  
  327
  
    
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc" title="Refresh bom_val[] with new values from analog8. analog_init and bom_init must be...">bom_refresh</a>, <a class="el" href="group__bom.html#gbce8d8dd8f11d8f5e9f9d74d84ea15db" title="Compares all the values in bom_val[] and returns the index to the highest value element...">bom_get_max</a> </dd></dl>


  		




  304
  328
  
    

  		




  
  329
  
    
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="bom_8c-source.html#l00171">bom_get_max()</a>, and <a class="el" href="bom_8c-source.html#l00134">bom_refresh()</a>.</p>


  		




  
  330
  
    

  		




  305
  331
  
    
</div>


  		




  306
  332
  
    
</div><p>


  		




  307
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by&nbsp;


  		




  
  333
  
    
</div>


  		




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


  		




  308
  335
  
    
<a href="http://www.doxygen.org/index.html">


  		




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


  		




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


  		




  310
  337
  
    
</body>


  		




  311
  338
  
    
</html>


  		












Also available in:  Unified diff