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__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.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>BOM (Bearing and Orientation Module)</h1>Functions for dealing with the BOM.
21 18 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
22 19 
<tr><td></td></tr>
......
123 120 
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>
124 121 
<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>
125 122 

  		




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


  		




  127
  
  
    

  		




  128
  123
  
    
</div>


  		




  129
  124
  
    
</div><p>


  		




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


  		




  ......




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


  		




  151
  146
  
    
<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>


  		




  152
  147
  
    

  		




  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
  
  
    

  		




  155
  148
  
    
</div>


  		




  156
  149
  
    
</div><p>


  		




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


  		




  ......




  180
  173
  
    
  </table>


  		




  181
  174
  
    
</dl>


  		




  182
  175
  
    

  		




  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
  
  
    

  		




  187
  176
  
    
</div>


  		




  188
  177
  
    
</div><p>


  		




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


  		




  ......




  212
  201
  
    
  </table>


  		




  213
  202
  
    
</dl>


  		




  214
  203
  
    

  		




  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
  
  
    

  		




  219
  204
  
    
</div>


  		




  220
  205
  
    
</div><p>


  		




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


  		




  ......




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


  		




  241
  226
  
    
<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>


  		




  242
  227
  
    

  		




  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
  
  
    

  		




  245
  228
  
    
</div>


  		




  246
  229
  
    
</div><p>


  		




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


  		




  ......




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


  		




  267
  250
  
    
<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>


  		




  268
  251
  
    

  		




  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
  
  
    

  		




  271
  252
  
    
</div>


  		




  272
  253
  
    
</div><p>


  		




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


  		




  ......




  297
  278
  
    
</dl>


  		




  298
  279
  
    
<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>


  		




  299
  280
  
    

  		




  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
  
  
    

  		




  304
  281
  
    
</div>


  		




  305
  282
  
    
</div><p>


  		




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


  		




  ......




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


  		




  327
  304
  
    
<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>


  		




  328
  305
  
    

  		




  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
  
  
    

  		




  331
  306
  
    
</div>


  		




  332
  307
  
    
</div><p>


  		




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


  		




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


  		




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


  		




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


  		




  337
  311
  
    
</body>


  		




  338
  312
  
    
</html>


  		












Also available in:  Unified diff