root / trunk / docs / libdragonfly / bom_8c.html @ 1145
History | View | Annotate | Download (11.9 KB)
| 1 |
<!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 |
<!-- 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 Page</span></a></li> |
| 12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
| 13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 15 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
</div>
|
| 19 |
<div class="contents"> |
| 20 |
<h1>bom.c File Reference</h1>Implementation for using the BOM. <a href="#_details">More...</a> |
| 21 |
<p>
|
| 22 |
<code>#include <<a class="el" href="dragonfly__lib_8h-source.html">dragonfly_lib.h</a>></code><br> |
| 23 |
<code>#include "<a class="el" href="bom_8h-source.html">bom.h</a>"</code><br> |
| 24 |
<code>#include "<a class="el" href="dio_8h-source.html">dio.h</a>"</code><br> |
| 25 |
<code>#include "<a class="el" href="serial_8h-source.html">serial.h</a>"</code><br> |
| 26 |
<code>#include "<a class="el" href="analog_8h-source.html">analog.h</a>"</code><br> |
| 27 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 28 |
<tr><td></td></tr> |
| 29 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d8d40cc8142751f4b3b50fde41b6570"></a><!-- doxytag: member="bom.c::MONKI" ref="5d8d40cc8142751f4b3b50fde41b6570" args="" --> |
| 31 |
#define </td><td class="memItemRight" valign="bottom"><b>MONKI</b> PF0</td></tr> |
| 32 |
|
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77120770fd09eb0f89829b4971c78775"></a><!-- doxytag: member="bom.c::MONKL" ref="77120770fd09eb0f89829b4971c78775" args="" --> |
| 34 |
#define </td><td class="memItemRight" valign="bottom"><b>MONKL</b> _PIN_E2</td></tr> |
| 35 |
|
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b36a82284a94cc38830919bf985ed91"></a><!-- doxytag: member="bom.c::MONK1" ref="8b36a82284a94cc38830919bf985ed91" args="" --> |
| 37 |
#define </td><td class="memItemRight" valign="bottom"><b>MONK1</b> _PIN_E3</td></tr> |
| 38 |
|
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="505cd1518a902fa8cd2c2e73d082efc7"></a><!-- doxytag: member="bom.c::MONK0" ref="505cd1518a902fa8cd2c2e73d082efc7" args="" --> |
| 40 |
#define </td><td class="memItemRight" valign="bottom"><b>MONK0</b> _PIN_E4</td></tr> |
| 41 |
|
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7b32afbc573f63cf936ca85a7489c31"></a><!-- doxytag: member="bom.c::MONK3" ref="b7b32afbc573f63cf936ca85a7489c31" args="" --> |
| 43 |
#define </td><td class="memItemRight" valign="bottom"><b>MONK3</b> _PIN_E6</td></tr> |
| 44 |
|
| 45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2cb88bb258f22bbd34797987539e111c"></a><!-- doxytag: member="bom.c::MONK2" ref="2cb88bb258f22bbd34797987539e111c" args="" --> |
| 46 |
#define </td><td class="memItemRight" valign="bottom"><b>MONK2</b> _PIN_E7</td></tr> |
| 47 |
|
| 48 |
<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="" --> |
| 49 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_VALUE_THRESHOLD</b> 200</td></tr> |
| 50 |
|
| 51 |
<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="" --> |
| 52 |
#define </td><td class="memItemRight" valign="bottom"><b>NUM_BOM_LEDS</b> 16</td></tr> |
| 53 |
|
| 54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b05397a2f5b2b19557bb823920c0df7f"></a><!-- doxytag: member="bom.c::BOM_MODE" ref="b05397a2f5b2b19557bb823920c0df7f" args="" --> |
| 55 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_MODE</b> _PIN_E2</td></tr> |
| 56 |
|
| 57 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f955163187ac52f024179641f855ef9b"></a><!-- doxytag: member="bom.c::BOM_STROBE" ref="f955163187ac52f024179641f855ef9b" args="" --> |
| 58 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_STROBE</b> _PIN_E3</td></tr> |
| 59 |
|
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="540ae969f53e326cb857a7ae09de9d10"></a><!-- doxytag: member="bom.c::BOM_DATA" ref="540ae969f53e326cb857a7ae09de9d10" args="" --> |
| 61 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_DATA</b> _PIN_A0</td></tr> |
| 62 |
|
| 63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e1bc0d3a2ead8130243767c7e46f5a5"></a><!-- doxytag: member="bom.c::BOM_CLOCK" ref="7e1bc0d3a2ead8130243767c7e46f5a5" args="" --> |
| 64 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_CLOCK</b> _PIN_A1</td></tr> |
| 65 |
|
| 66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33b49175a1e5636ef29c002e809f5457"></a><!-- doxytag: member="bom.c::BOM_S0" ref="33b49175a1e5636ef29c002e809f5457" args="" --> |
| 67 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_S0</b> _PIN_E5</td></tr> |
| 68 |
|
| 69 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="480f4efafa11c09bd666f12096b404bd"></a><!-- doxytag: member="bom.c::BOM_S1" ref="480f4efafa11c09bd666f12096b404bd" args="" --> |
| 70 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_S1</b> _PIN_E4</td></tr> |
| 71 |
|
| 72 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6815e64169be3f4867222411ceb51f9"></a><!-- doxytag: member="bom.c::BOM_S2" ref="a6815e64169be3f4867222411ceb51f9" args="" --> |
| 73 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_S2</b> _PIN_E7</td></tr> |
| 74 |
|
| 75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42c6f96fa0ba3259e19354d5a54dad08"></a><!-- doxytag: member="bom.c::BOM_S3" ref="42c6f96fa0ba3259e19354d5a54dad08" args="" --> |
| 76 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_S3</b> _PIN_E6</td></tr> |
| 77 |
|
| 78 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e32c39b58a16cfdb86b192bd72f95b8b"></a><!-- doxytag: member="bom.c::BOM_OUT" ref="e32c39b58a16cfdb86b192bd72f95b8b" args="" --> |
| 79 |
#define </td><td class="memItemRight" valign="bottom"><b>BOM_OUT</b> PF0</td></tr> |
| 80 |
|
| 81 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 82 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g101f932380b02b48a0ca3d20ffc8c08f">bom_init</a> (char type)</td></tr> |
| 83 |
|
| 84 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the bom according to bom type. <a href="group__bom.html#g101f932380b02b48a0ca3d20ffc8c08f"></a><br></td></tr> |
| 85 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc">bom_refresh</a> (int bit_field)</td></tr> |
| 86 |
|
| 87 |
<tr><td class="mdescLeft"> </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> |
| 88 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gd28d2a59a5090390e20f87cfd05b0a8b">bom_get</a> (int which)</td></tr> |
| 89 |
|
| 90 |
<tr><td class="mdescLeft"> </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> |
| 91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gbce8d8dd8f11d8f5e9f9d74d84ea15db">bom_get_max</a> (void)</td></tr> |
| 92 |
|
| 93 |
<tr><td class="mdescLeft"> </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> |
| 94 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g8e42fe2740ecc49e7c057e9d7df9c9eb">bom_set_leds</a> (int bit_field)</td></tr> |
| 95 |
|
| 96 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the selected bom leds on a BOM1.5. <a href="group__bom.html#g8e42fe2740ecc49e7c057e9d7df9c9eb"></a><br></td></tr> |
| 97 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g86753fe7440cd64e60c58ad31c62264a">get_max_bom</a> (void)</td></tr> |
| 98 |
|
| 99 |
<tr><td class="mdescLeft"> </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> |
| 100 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf">bom_on</a> (void)</td></tr> |
| 101 |
|
| 102 |
<tr><td class="mdescLeft"> </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> |
| 103 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30">bom_off</a> (void)</td></tr> |
| 104 |
|
| 105 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turns off all bom leds. <a href="group__bom.html#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr> |
| 106 |
</table>
|
| 107 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 108 |
Implementation for using the BOM. |
| 109 |
<p>
|
| 110 |
Copyright (c) 2007 Colony Project<p>
|
| 111 |
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>
|
| 112 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
|
| 113 |
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>
|
| 114 |
Contains functions for using the Bearing and Orientation Module (BOM)<p>
|
| 115 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
| 116 |
</div>
|
| 117 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by |
| 118 |
<a href="http://www.doxygen.org/index.html"> |
| 119 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
| 120 |
</body>
|
| 121 |
</html>
|