Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / bom_8c.html @ 948

History | View | Annotate | Download (9.31 KB)

1 241 bcoltin 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>libdragonfly: bom.c File Reference</title>
4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 948 justin 
<!-- Generated by Doxygen 1.5.3 -->
8 869 justin 
<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>
16 241 bcoltin 
</div>
17 
<h1>bom.c File Reference</h1>Implementation for using the BOM. <a href="#_details">More...</a>
18 
<p>
19 
<code>#include &lt;<a class="el" href="dragonfly__lib_8h-source.html">dragonfly_lib.h</a>&gt;</code><br>
20 
<code>#include &quot;<a class="el" href="bom_8h-source.html">bom.h</a>&quot;</code><br>
21 
<code>#include &quot;<a class="el" href="dio_8h-source.html">dio.h</a>&quot;</code><br>
22 
<code>#include &quot;<a class="el" href="analog_8h-source.html">analog.h</a>&quot;</code><br>
23 
<table border="0" cellpadding="0" cellspacing="0">
24 
<tr><td></td></tr>
25 
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
26 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d8d40cc8142751f4b3b50fde41b6570"></a><!-- doxytag: member="bom.c::MONKI" ref="5d8d40cc8142751f4b3b50fde41b6570" args="" -->
27 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MONKI</b>&nbsp;&nbsp;&nbsp;PF0</td></tr>
28 

      

      

        29
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77120770fd09eb0f89829b4971c78775"></a><!-- doxytag: member="bom.c::MONKL" ref="77120770fd09eb0f89829b4971c78775" args="" -->


      

      

        30
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MONKL</b>&nbsp;&nbsp;&nbsp;_PIN_E2</td></tr>


      

      

        31
        
        
        
        
        

      

      

        32
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b36a82284a94cc38830919bf985ed91"></a><!-- doxytag: member="bom.c::MONK1" ref="8b36a82284a94cc38830919bf985ed91" args="" -->


      

      

        33
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MONK1</b>&nbsp;&nbsp;&nbsp;_PIN_E3</td></tr>


      

      

        34
        
        
        
        
        

      

      

        35
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="505cd1518a902fa8cd2c2e73d082efc7"></a><!-- doxytag: member="bom.c::MONK0" ref="505cd1518a902fa8cd2c2e73d082efc7" args="" -->


      

      

        36
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MONK0</b>&nbsp;&nbsp;&nbsp;_PIN_E4</td></tr>


      

      

        37
        
        
        
        
        

      

      

        38
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7b32afbc573f63cf936ca85a7489c31"></a><!-- doxytag: member="bom.c::MONK3" ref="b7b32afbc573f63cf936ca85a7489c31" args="" -->


      

      

        39
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MONK3</b>&nbsp;&nbsp;&nbsp;_PIN_E6</td></tr>


      

      

        40
        
        
        
        
        

      

      

        41
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2cb88bb258f22bbd34797987539e111c"></a><!-- doxytag: member="bom.c::MONK2" ref="2cb88bb258f22bbd34797987539e111c" args="" -->


      

      

        42
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MONK2</b>&nbsp;&nbsp;&nbsp;_PIN_E7</td></tr>


      

      

        43
        
        
        
        
        

      

      

        44
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62d3789a9837190df2131daaae722a5f"></a><!-- doxytag: member="bom.c::BOM_VALUE_THRESHOLD" ref="62d3789a9837190df2131daaae722a5f" args="" -->


      

      

        45
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>BOM_VALUE_THRESHOLD</b>&nbsp;&nbsp;&nbsp;200</td></tr>


      

      

        46
        
        
        
        
        

      

      

        47
        
            497
        
        
            kwoo
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29d7a583381e7f6918e28cb4b643ce9f"></a><!-- doxytag: member="bom.c::NUM_BOM_LEDS" ref="29d7a583381e7f6918e28cb4b643ce9f" args="" -->


      

      

        48
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>NUM_BOM_LEDS</b>&nbsp;&nbsp;&nbsp;16</td></tr>


      

      

        49
        
        
        
        
        

      

      

        50
        
            241
        
        
            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
        
            241
        
        
            bcoltin
        
        

      

      

        53
        
            497
        
        
            kwoo
        
        
<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
        
            241
        
        
            bcoltin
        
        

      

      

        56
        
            497
        
        
            kwoo
        
        
<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
        
        
        
        
        
<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>


      

      

        64
        
        
        
        
        

      

      

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


      

      

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


      

      

        67
        
        
        
        
        

      

      

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


      

      

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


      

      

        70
        
        
        
        
        

      

      

        71
        
            862
        
        
            kwoo
        
        
<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>


      

      

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


      

      

        73
        
        
        
        
        

      

      

        74
        
            862
        
        
            kwoo
        
        
<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>


      

      

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


      

      

        76
        
        
        
        
        

      

      

        77
        
            862
        
        
            kwoo
        
        
<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>


      

      

        78
        
            241
        
        
            bcoltin
        
        
</table>


      

      

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


      

      

        80
        
        
        
        
        
Implementation for using the BOM.


      

      

        81
        
        
        
        
        
<p>


      

      

        82
        
        
        
        
        
Copyright (c) 2007 Colony Project<p>


      

      

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


      

      

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


      

      

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


      

      

        86
        
        
        
        
        
Contains functions for using the Bearing and Orientation Module (BOM)<p>


      

      

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


      

      

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


      

      

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


      

      

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


      

      

        91
        
            241
        
        
            bcoltin
        
        
</body>


      

      

        92
        
        
        
        
        
</html>