Project

General

Profile

Revision 497

Added by Kevin Woo about 16 years ago

Updated the documentation for libdragonfly.

View differences:

bom_8c.html
9 9
  <ul>
10 10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 11
    <li><a href="modules.html"><span>Modules</span></a></li>
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
12 13
    <li class="current"><a href="files.html"><span>Files</span></a></li>
13 14
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14 15
  </ul>
......
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="" -->
44 45
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>BOM_VALUE_THRESHOLD</b>&nbsp;&nbsp;&nbsp;200</td></tr>
45 46

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

  
46 50
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
47
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bf764516e196235026a5967a5030214"></a><!-- doxytag: member="bom.c::output_high" ref="2bf764516e196235026a5967a5030214" args="(int which)" -->
48
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>output_high</b> (int which)</td></tr>
51
<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>
49 52

  
50
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1e8f46326b6bf95966fc9b67476d8eb"></a><!-- doxytag: member="bom.c::output_low" ref="a1e8f46326b6bf95966fc9b67476d8eb" args="(int which)" -->
51
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>output_low</b> (int which)</td></tr>
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>
52 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
<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>
53 69
<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>
54 70

  
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the location of the maximum BOM reading.  <a href="group__bom.html#g86753fe7440cd64e60c58ad31c62264a"></a><br></td></tr>
71
<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>
56 72
<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>
57 73

  
58
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns the BOM on.  <a href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr>
74
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Turns on all bom leds.  <a href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr>
59 75
<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>
60 76

  
61
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns the BOM off.  <a href="group__bom.html#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr>
62
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
63
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="767c3387c849821527ae468cb87e5cf6"></a><!-- doxytag: member="bom.c::lookup" ref="767c3387c849821527ae468cb87e5cf6" args="[16]" -->
64
const int&nbsp;</td><td class="memItemRight" valign="bottom"><b>lookup</b> [16] = {7,6,5,0xe,1,4,3,2,0xf,0,0xd,8,0xc,0xb,9,0xa}</td></tr>
65

  
77
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(DEPRECATED) Turns off all bom leds.  <a href="group__bom.html#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr>
66 78
</table>
67 79
<hr><a name="_details"></a><h2>Detailed Description</h2>
68 80
Implementation for using the BOM. 
......
73 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>
74 86
Contains functions for using the Bearing and Orientation Module (BOM)<p>
75 87
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>
76
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;
88
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by&nbsp;
77 89
<a href="http://www.doxygen.org/index.html">
78 90
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
79 91
</body>

Also available in: Unified diff