root / trunk / docs / libdragonfly / group__bom.html @ 6
History | View | Annotate | Download (6.48 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| 3 |
<title>libdragonfly: BOM (Bearing and Orientation Module)</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.4.6 -->
|
| 8 |
<div class="tabs"> |
| 9 |
<ul>
|
| 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 |
<li><a href="files.html"><span>Files</span></a></li> |
| 13 |
</ul></div> |
| 14 |
<h1>BOM (Bearing and Orientation Module)</h1>Functions for dealing with the BOM. |
| 15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 16 |
<tr><td></td></tr> |
| 17 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 18 |
<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> |
| 19 |
|
| 20 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the location of the maximum BOM reading. <a href="#g86753fe7440cd64e60c58ad31c62264a"></a><br></td></tr> |
| 21 |
<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> |
| 22 |
|
| 23 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turns the BOM on. <a href="#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr> |
| 24 |
<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> |
| 25 |
|
| 26 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turns the BOM off. <a href="#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr> |
| 27 |
</table>
|
| 28 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 29 |
Functions for dealing with the BOM. |
| 30 |
<p>
|
| 31 |
The Bearing and Orientation Module / Barrel of Monkeys / BOM is a custom sensor designed and built by the Colony Project. It consists of a ring of 16 IR emitters and 16 IR detectors. The BOM is most often use to determine the direction of other robots. This module contains functions for controlling the BOM.<p>
|
| 32 |
Include <a class="el" href="bom_8h.html">bom.h</a> to access these functions. <hr><h2>Function Documentation</h2> |
| 33 |
<a class="anchor" name="g61a66e53cdee8bce139c707153143b30"></a><!-- doxytag: member="bom.c::bom_off" ref="g61a66e53cdee8bce139c707153143b30" args="(void)" --><p> |
| 34 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 35 |
<tr>
|
| 36 |
<td class="mdRow"> |
| 37 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 38 |
<tr>
|
| 39 |
<td class="md" nowrap valign="top">void bom_off </td> |
| 40 |
<td class="md" valign="top">( </td> |
| 41 |
<td class="md" nowrap valign="top">void </td> |
| 42 |
<td class="mdname1" valign="top" nowrap> </td> |
| 43 |
<td class="md" valign="top"> ) </td> |
| 44 |
<td class="md" nowrap></td> |
| 45 |
</tr>
|
| 46 |
</table>
|
| 47 |
</td>
|
| 48 |
</tr>
|
| 49 |
</table>
|
| 50 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 51 |
<tr>
|
| 52 |
<td>
|
| 53 |
|
| 54 |
</td>
|
| 55 |
<td>
|
| 56 |
|
| 57 |
<p>
|
| 58 |
Turns the BOM off. |
| 59 |
<p>
|
| 60 |
Stops flashing the BOM. analog_init must be called before this function can be used.<p>
|
| 61 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf">bom_on</a>, <a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a> </dd></dl> |
| 62 |
</td>
|
| 63 |
</tr>
|
| 64 |
</table>
|
| 65 |
<a class="anchor" name="g93b665ff81fc6b58503c6ba5ba01c1bf"></a><!-- doxytag: member="bom.c::bom_on" ref="g93b665ff81fc6b58503c6ba5ba01c1bf" args="(void)" --><p> |
| 66 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 67 |
<tr>
|
| 68 |
<td class="mdRow"> |
| 69 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 70 |
<tr>
|
| 71 |
<td class="md" nowrap valign="top">void bom_on </td> |
| 72 |
<td class="md" valign="top">( </td> |
| 73 |
<td class="md" nowrap valign="top">void </td> |
| 74 |
<td class="mdname1" valign="top" nowrap> </td> |
| 75 |
<td class="md" valign="top"> ) </td> |
| 76 |
<td class="md" nowrap></td> |
| 77 |
</tr>
|
| 78 |
</table>
|
| 79 |
</td>
|
| 80 |
</tr>
|
| 81 |
</table>
|
| 82 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 83 |
<tr>
|
| 84 |
<td>
|
| 85 |
|
| 86 |
</td>
|
| 87 |
<td>
|
| 88 |
|
| 89 |
<p>
|
| 90 |
Turns the BOM on. |
| 91 |
<p>
|
| 92 |
Flashes the BOM. analog_init must be called before this function can be used.<p>
|
| 93 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30">bom_off</a>, <a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a> </dd></dl> |
| 94 |
</td>
|
| 95 |
</tr>
|
| 96 |
</table>
|
| 97 |
<a class="anchor" name="g86753fe7440cd64e60c58ad31c62264a"></a><!-- doxytag: member="bom.c::get_max_bom" ref="g86753fe7440cd64e60c58ad31c62264a" args="(void)" --><p> |
| 98 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 99 |
<tr>
|
| 100 |
<td class="mdRow"> |
| 101 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 102 |
<tr>
|
| 103 |
<td class="md" nowrap valign="top">int get_max_bom </td> |
| 104 |
<td class="md" valign="top">( </td> |
| 105 |
<td class="md" nowrap valign="top">void </td> |
| 106 |
<td class="mdname1" valign="top" nowrap> </td> |
| 107 |
<td class="md" valign="top"> ) </td> |
| 108 |
<td class="md" nowrap></td> |
| 109 |
</tr>
|
| 110 |
</table>
|
| 111 |
</td>
|
| 112 |
</tr>
|
| 113 |
</table>
|
| 114 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 115 |
<tr>
|
| 116 |
<td>
|
| 117 |
|
| 118 |
</td>
|
| 119 |
<td>
|
| 120 |
|
| 121 |
<p>
|
| 122 |
Returns the location of the maximum BOM reading. |
| 123 |
<p>
|
| 124 |
Returns the direction of the maximum BOM reading, as an integer in the range 0-15. 0 indicates to the robot's right, while the rest of the sensors are numbered counterclockwise. This is useful for determining the direction of a robot flashing its BOM, of only one robot is currently doing so. analog_init must be called before this function can be used.<p>
|
| 125 |
<dl compact><dt><b>Returns:</b></dt><dd>the direction of the maximum BOM reading</dd></dl> |
| 126 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a> </dd></dl> |
| 127 |
</td>
|
| 128 |
</tr>
|
| 129 |
</table>
|
| 130 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
| 131 |
<a href="http://www.doxygen.org/index.html"> |
| 132 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
| 133 |
</body>
|
| 134 |
</html>
|