Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / bom_8h.html @ 1398

History | View | Annotate | Download (8.25 KB)

1 41 bcoltin 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 241 bcoltin 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 41 bcoltin 
<title>libdragonfly: bom.h File Reference</title>
4 1398 cmar 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 41 bcoltin 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 1398 cmar 
<!-- Generated by Doxygen 1.5.9 -->
8 1145 deffi 
<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>
18 1398 cmar 
  <div class="tabs">
19 
    <ul>
20 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21 
      <li><a href="globals.html"><span>Globals</span></a></li>
22 
    </ul>
23 
  </div>
24 241 bcoltin 
</div>
25 1145 deffi 
<div class="contents">
26 1398 cmar 
<h1>bom.h File Reference</h1>Definitions for using the BOM.
27 
<a href="#_details">More...</a>
28 41 bcoltin 
<p>
29 

      

      

        30
        
        
        
        
        
<p>


      

      

        31
        
            1398
        
        
            cmar
        
        
<a href="bom_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">


      

      

        32
        
            41
        
        
            bcoltin
        
        
<tr><td></td></tr>


      

      

        33
        
            497
        
        
            kwoo
        
        
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


      

      

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


      

      

        35
        
        
        
        
        
#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>


      

      

        36
        
        
        
        
        

      

      

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


      

      

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


      

      

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


      

      

        40
        
            497
        
        
            kwoo
        
        

      

      

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


      

      

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


      

      

        43
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g8c5367cf01a2a7ede66be0f2a49b28d0">BOM15</a>&nbsp;&nbsp;&nbsp;1</td></tr>


      

      

        44
        
        
        
        
        

      

      

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


      

      

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


      

      

        47
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g1ff400a0e77d2266138b080061f49d01">RBOM</a>&nbsp;&nbsp;&nbsp;2</td></tr>


      

      

        48
        
        
        
        
        

      

      

        49
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RBOM - Range, Individual LED control. <br></td></tr>


      

      

        50
        
            41
        
        
            bcoltin
        
        
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


      

      

        51
        
            497
        
        
            kwoo
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g101f932380b02b48a0ca3d20ffc8c08f">bom_init</a> (char type)</td></tr>


      

      

        52
        
        
        
        
        

      

      

        53
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the bom according to bom type.  <a href="group__bom.html#g101f932380b02b48a0ca3d20ffc8c08f"></a><br></td></tr>


      

      

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


      

      

        55
        
        
        
        
        

      

      

        56
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Refresh bom_val[] with new values from analog8. analog_init and bom_init must be called for this to work.  <a href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc"></a><br></td></tr>


      

      

        57
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gd28d2a59a5090390e20f87cfd05b0a8b">bom_get</a> (int which)</td></tr>


      

      

        58
        
        
        
        
        

      

      

        59
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new bom values.  <a href="group__bom.html#gd28d2a59a5090390e20f87cfd05b0a8b"></a><br></td></tr>


      

      

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


      

      

        61
        
        
        
        
        

      

      

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


      

      

        63
        
            1145
        
        
            deffi
        
        
<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>


      

      

        64
        
            497
        
        
            kwoo
        
        

      

      

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


      

      

        66
        
            41
        
        
            bcoltin
        
        
<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>


      

      

        67
        
        
        
        
        

      

      

        68
        
            1145
        
        
            deffi
        
        
<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>


      

      

        69
        
            41
        
        
            bcoltin
        
        
<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>


      

      

        70
        
        
        
        
        

      

      

        71
        
            1145
        
        
            deffi
        
        
<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>


      

      

        72
        
            41
        
        
            bcoltin
        
        
<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>


      

      

        73
        
        
        
        
        

      

      

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


      

      

        75
        
            41
        
        
            bcoltin
        
        
</table>


      

      

        76
        
            1398
        
        
            cmar
        
        
<hr><h2>Detailed Description</h2>


      

      

        77
        
            41
        
        
            bcoltin
        
        
Definitions for using the BOM.


      

      

        78
        
        
        
        
        
<p>


      

      

        79
        
            241
        
        
            bcoltin
        
        
Copyright (c) 2007 Colony Project<p>


      

      

        80
        
        
        
        
        
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>


      

      

        81
        
        
        
        
        
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


      

      

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


      

      

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


      

      

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


      

      

        85
        
            1145
        
        
            deffi
        
        
</div>


      

      

        86
        
            1398
        
        
            cmar
        
        
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;


      

      

        87
        
            41
        
        
            bcoltin
        
        
<a href="http://www.doxygen.org/index.html">


      

      

        88
        
            1398
        
        
            cmar
        
        
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


      

      

        89
        
            41
        
        
            bcoltin
        
        
</body>


      

      

        90
        
        
        
        
        
</html>