Project

General

Profile

Revision 1145

Added by Martin Herrmann about 15 years ago

Generated documentation for new orbs code

View differences:

bom_8h.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 class="current"><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 class="current"><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
16 18 
</div>
19 
<div class="contents">
17 20 
<h1>bom.h File Reference</h1>Definitions for using the BOM. <a href="#_details">More...</a>
18 21 
<p>
19 22 

  		




  ......




  25
  28
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g3f1e6fc7eeb6d7cffde8bb03ff8dc488">BOM_ALL</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>


  		




  26
  29
  
    

  		




  27
  30
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include all elements in the 16-bit bitfield. <br></td></tr>


  		




  28
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd555cfe7a1fcf16c3639f797120478eb"></a><!-- doxytag: member="bom.h::BOM" ref="gd555cfe7a1fcf16c3639f797120478eb" args="" -->


  		




  29
  
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gd555cfe7a1fcf16c3639f797120478eb">BOM</a>&nbsp;&nbsp;&nbsp;0</td></tr>


  		




  
  31
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gacc7c8241c56ea13b6d50efb281df890"></a><!-- doxytag: member="bom.h::BOM10" ref="gacc7c8241c56ea13b6d50efb281df890" args="" -->


  		




  
  32
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gacc7c8241c56ea13b6d50efb281df890">BOM10</a>&nbsp;&nbsp;&nbsp;0</td></tr>


  		




  30
  33
  
    

  		




  31
  34
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Original BOM - No Range, No Individual LED control. <br></td></tr>


  		




  32
  35
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8c5367cf01a2a7ede66be0f2a49b28d0"></a><!-- doxytag: member="bom.h::BOM15" ref="g8c5367cf01a2a7ede66be0f2a49b28d0" args="" -->


  		




  ......




  50
  53
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gbce8d8dd8f11d8f5e9f9d74d84ea15db">bom_get_max</a> (void)</td></tr>


  		




  51
  54
  
    

  		




  52
  55
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compares all the values in bom_val[] and returns the index to the highest value element.  <a href="group__bom.html#gbce8d8dd8f11d8f5e9f9d74d84ea15db"></a><br></td></tr>


  		




  53
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g2f5fae400bcc24d266c84ca441a1516c">bom_leds_on</a> (int bit_field)</td></tr>


  		




  
  56
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g8e42fe2740ecc49e7c057e9d7df9c9eb">bom_set_leds</a> (int bit_field)</td></tr>


  		




  54
  57
  
    

  		




  55
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns on the selected bom leds. Only works with BOM_ALL if using the original bom.  <a href="group__bom.html#g2f5fae400bcc24d266c84ca441a1516c"></a><br></td></tr>


  		




  56
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gf3fb24ce85166158df75f7d5f391f3ad">bom_leds_off</a> (int bit_field)</td></tr>


  		




  57
  
  
    

  		




  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="group__bom.html#gf3fb24ce85166158df75f7d5f391f3ad"></a><br></td></tr>


  		




  
  58
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables the selected bom leds on a BOM1.5.  <a href="group__bom.html#g8e42fe2740ecc49e7c057e9d7df9c9eb"></a><br></td></tr>


  		




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


  		




  60
  60
  
    

  		




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


  		




  
  61
  
    
<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="group__bom.html#g86753fe7440cd64e60c58ad31c62264a"></a><br></td></tr>


  		




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


  		




  63
  63
  
    

  		




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


  		




  
  64
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns on all BOM leds, or turns on enabled leds on a BOM1.5.  <a href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr>


  		




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


  		




  66
  66
  
    

  		




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


  		




  
  67
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns off all bom leds.  <a href="group__bom.html#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr>


  		




  68
  68
  
    
</table>


  		




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


  		




  70
  70
  
    
Definitions for using the BOM. 


  		




  ......




  75
  75
  
    
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>


  		




  76
  76
  
    
This file contains definitions for using the Bearing and Orientation Module (BOM).<p>


  		




  77
  77
  
    
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


  		




  78
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:42 2008 for libdragonfly by&nbsp;


  		




  
  78
  
    
</div>


  		




  
  79
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by&nbsp;


  		




  79
  80
  
    
<a href="http://www.doxygen.org/index.html">


  		




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


  		




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


  		




  81
  82
  
    
</body>


  		




  82
  83
  
    
</html>


  		












Also available in:  Unified diff