root / trunk / docs / libdragonfly / group__bom.html @ 862
History | View | Annotate | Download (20.1 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 (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.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><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
</div>
|
| 19 |
<div class="contents"> |
| 20 |
<h1>BOM (Bearing and Orientation Module)</h1>Functions for dealing with the BOM. |
| 21 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 22 |
<tr><td></td></tr> |
| 23 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3f1e6fc7eeb6d7cffde8bb03ff8dc488"></a><!-- doxytag: member="bom::BOM_ALL" ref="g3f1e6fc7eeb6d7cffde8bb03ff8dc488" args="" --> |
| 25 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g3f1e6fc7eeb6d7cffde8bb03ff8dc488">BOM_ALL</a> 0xFFFF</td></tr> |
| 26 |
|
| 27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Include all elements in the 16-bit bitfield. <br></td></tr> |
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd555cfe7a1fcf16c3639f797120478eb"></a><!-- doxytag: member="bom::BOM" ref="gd555cfe7a1fcf16c3639f797120478eb" args="" --> |
| 29 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gd555cfe7a1fcf16c3639f797120478eb">BOM</a> 0</td></tr> |
| 30 |
|
| 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Original BOM - No Range, No Individual LED control. <br></td></tr> |
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8c5367cf01a2a7ede66be0f2a49b28d0"></a><!-- doxytag: member="bom::BOM15" ref="g8c5367cf01a2a7ede66be0f2a49b28d0" args="" --> |
| 33 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g8c5367cf01a2a7ede66be0f2a49b28d0">BOM15</a> 1</td></tr> |
| 34 |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">BOM 1.5 - No Range, Individual LED control. <br></td></tr> |
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1ff400a0e77d2266138b080061f49d01"></a><!-- doxytag: member="bom::RBOM" ref="g1ff400a0e77d2266138b080061f49d01" args="" --> |
| 37 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g1ff400a0e77d2266138b080061f49d01">RBOM</a> 2</td></tr> |
| 38 |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">RBOM - Range, Individual LED control. <br></td></tr> |
| 40 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 41 |
<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> |
| 42 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the bom according to bom type. <a href="#g101f932380b02b48a0ca3d20ffc8c08f"></a><br></td></tr> |
| 44 |
<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> |
| 45 |
|
| 46 |
<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="#gbdcdf3a1428f8145ee5eed82efdaf0fc"></a><br></td></tr> |
| 47 |
<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> |
| 48 |
|
| 49 |
<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="#gd28d2a59a5090390e20f87cfd05b0a8b"></a><br></td></tr> |
| 50 |
<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> |
| 51 |
|
| 52 |
<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="#gbce8d8dd8f11d8f5e9f9d74d84ea15db"></a><br></td></tr> |
| 53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#g2f5fae400bcc24d266c84ca441a1516c">bom_leds_on</a> (int bit_field)</td></tr> |
| 54 |
|
| 55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turns on the selected bom leds. Only works with BOM_ALL if using the original bom. <a href="#g2f5fae400bcc24d266c84ca441a1516c"></a><br></td></tr> |
| 56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bom.html#gf3fb24ce85166158df75f7d5f391f3ad">bom_leds_off</a> (int bit_field)</td></tr> |
| 57 |
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turns off the selected bom leds. Only works with BOM_ALL if using the original bom. <a href="#gf3fb24ce85166158df75f7d5f391f3ad"></a><br></td></tr> |
| 59 |
<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> |
| 60 |
|
| 61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">(DEPRECATED) Wrapper function. See bom_refresh and bom_get_max <a href="#g86753fe7440cd64e60c58ad31c62264a"></a><br></td></tr> |
| 62 |
<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> |
| 63 |
|
| 64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">(DEPRECATED) Wrapper function. See bom_leds_on. <a href="#g93b665ff81fc6b58503c6ba5ba01c1bf"></a><br></td></tr> |
| 65 |
<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> |
| 66 |
|
| 67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">(DEPRECATED) Wrapper function. See bom_leds_off. <a href="#g61a66e53cdee8bce139c707153143b30"></a><br></td></tr> |
| 68 |
</table>
|
| 69 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 70 |
Functions for dealing with the BOM. |
| 71 |
<p>
|
| 72 |
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>
|
| 73 |
Include <a class="el" href="bom_8h.html" title="Definitions for using the BOM.">bom.h</a> to access these functions. <hr><h2>Function Documentation</h2> |
| 74 |
<a class="anchor" name="gd28d2a59a5090390e20f87cfd05b0a8b"></a><!-- doxytag: member="bom.c::bom_get" ref="gd28d2a59a5090390e20f87cfd05b0a8b" args="(int which)" --> |
| 75 |
<div class="memitem"> |
| 76 |
<div class="memproto"> |
| 77 |
<table class="memname"> |
| 78 |
<tr>
|
| 79 |
<td class="memname">int bom_get </td> |
| 80 |
<td>(</td> |
| 81 |
<td class="paramtype">int </td> |
| 82 |
<td class="paramname"> <em>which</em> </td> |
| 83 |
<td> ) </td> |
| 84 |
<td width="100%"></td> |
| 85 |
</tr>
|
| 86 |
</table>
|
| 87 |
</div>
|
| 88 |
<div class="memdoc"> |
| 89 |
|
| 90 |
<p>
|
| 91 |
Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new bom values. |
| 92 |
<p>
|
| 93 |
Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new bom values.<p>
|
| 94 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 95 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 96 |
<tr><td valign="top"></td><td valign="top"><em>which</em> </td><td>which bom value to return</td></tr> |
| 97 |
</table>
|
| 98 |
</dl>
|
| 99 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the bom value</dd></dl> |
| 100 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc" title="Refresh bom_val[] with new values from analog8. analog_init and bom_init must be...">bom_refresh</a> </dd></dl> |
| 101 |
|
| 102 |
</div>
|
| 103 |
</div><p> |
| 104 |
<a class="anchor" name="gbce8d8dd8f11d8f5e9f9d74d84ea15db"></a><!-- doxytag: member="bom.c::bom_get_max" ref="gbce8d8dd8f11d8f5e9f9d74d84ea15db" args="(void)" --> |
| 105 |
<div class="memitem"> |
| 106 |
<div class="memproto"> |
| 107 |
<table class="memname"> |
| 108 |
<tr>
|
| 109 |
<td class="memname">int bom_get_max </td> |
| 110 |
<td>(</td> |
| 111 |
<td class="paramtype">void </td> |
| 112 |
<td class="paramname"> </td> |
| 113 |
<td> ) </td> |
| 114 |
<td width="100%"></td> |
| 115 |
</tr>
|
| 116 |
</table>
|
| 117 |
</div>
|
| 118 |
<div class="memdoc"> |
| 119 |
|
| 120 |
<p>
|
| 121 |
Compares all the values in bom_val[] and returns the index to the highest value element. |
| 122 |
<p>
|
| 123 |
Compares all the values in bom_val[] and returns the index to the lowest (max) value element. 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.<p>
|
| 124 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>index to the lowest (max) bom value element. -1 if no value is lower than BOM_VALUE_THRESHOLD </dd></dl> |
| 125 |
|
| 126 |
<p>Referenced by <a class="el" href="bom_8c-source.html#l00242">get_max_bom()</a>.</p> |
| 127 |
|
| 128 |
</div>
|
| 129 |
</div><p> |
| 130 |
<a class="anchor" name="g101f932380b02b48a0ca3d20ffc8c08f"></a><!-- doxytag: member="bom.c::bom_init" ref="g101f932380b02b48a0ca3d20ffc8c08f" args="(char type)" --> |
| 131 |
<div class="memitem"> |
| 132 |
<div class="memproto"> |
| 133 |
<table class="memname"> |
| 134 |
<tr>
|
| 135 |
<td class="memname">void bom_init </td> |
| 136 |
<td>(</td> |
| 137 |
<td class="paramtype">char </td> |
| 138 |
<td class="paramname"> <em>type</em> </td> |
| 139 |
<td> ) </td> |
| 140 |
<td width="100%"></td> |
| 141 |
</tr>
|
| 142 |
</table>
|
| 143 |
</div>
|
| 144 |
<div class="memdoc"> |
| 145 |
|
| 146 |
<p>
|
| 147 |
Initialize the bom according to bom type. |
| 148 |
<p>
|
| 149 |
Initializes the BOM. Call bom_init before reading bom values or turning bom leds.<p>
|
| 150 |
INCOMPLETE - need to fill in init routine for BOM15<p>
|
| 151 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc" title="Refresh bom_val[] with new values from analog8. analog_init and bom_init must be...">bom_refresh</a>, <a class="el" href="group__bom.html#g2f5fae400bcc24d266c84ca441a1516c" title="Turns on the selected bom leds. Only works with BOM_ALL if using the original bom...">bom_leds_on</a>, <a class="el" href="group__bom.html#gf3fb24ce85166158df75f7d5f391f3ad" title="Turns off the selected bom leds. Only works with BOM_ALL if using the original bom...">bom_leds_off</a> </dd></dl> |
| 152 |
|
| 153 |
<p>References <a class="el" href="bom_8h-source.html#l00049">BOM</a>, <a class="el" href="bom_8h-source.html#l00051">BOM15</a>, and <a class="el" href="bom_8h-source.html#l00053">RBOM</a>.</p> |
| 154 |
|
| 155 |
</div>
|
| 156 |
</div><p> |
| 157 |
<a class="anchor" name="gf3fb24ce85166158df75f7d5f391f3ad"></a><!-- doxytag: member="bom.c::bom_leds_off" ref="gf3fb24ce85166158df75f7d5f391f3ad" args="(int bit_field)" --> |
| 158 |
<div class="memitem"> |
| 159 |
<div class="memproto"> |
| 160 |
<table class="memname"> |
| 161 |
<tr>
|
| 162 |
<td class="memname">void bom_leds_off </td> |
| 163 |
<td>(</td> |
| 164 |
<td class="paramtype">int </td> |
| 165 |
<td class="paramname"> <em>bit_field</em> </td> |
| 166 |
<td> ) </td> |
| 167 |
<td width="100%"></td> |
| 168 |
</tr>
|
| 169 |
</table>
|
| 170 |
</div>
|
| 171 |
<div class="memdoc"> |
| 172 |
|
| 173 |
<p>
|
| 174 |
Turns off the selected bom leds. Only works with BOM_ALL if using the original bom. |
| 175 |
<p>
|
| 176 |
Iterates through each bit in the bit_field. For each set bit, turns off the corresponding bom led. bom_init must be called for this to work. Only works with BOM_ALL if using the original bom.<p>
|
| 177 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 178 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 179 |
<tr><td valign="top"></td><td valign="top"><em>bit_field</em> </td><td>specifies which leds should be turned off. Use BOM_ALL to turn off all bom leds. Ex. if 0x000B is passed, leds 0 and 3 will be turned off. </td></tr> |
| 180 |
</table>
|
| 181 |
</dl>
|
| 182 |
|
| 183 |
<p>References <a class="el" href="bom_8h-source.html#l00049">BOM</a>, <a class="el" href="bom_8h-source.html#l00051">BOM15</a>, <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00053">RBOM</a>.</p> |
| 184 |
|
| 185 |
<p>Referenced by <a class="el" href="bom_8c-source.html#l00262">bom_off()</a>.</p> |
| 186 |
|
| 187 |
</div>
|
| 188 |
</div><p> |
| 189 |
<a class="anchor" name="g2f5fae400bcc24d266c84ca441a1516c"></a><!-- doxytag: member="bom.c::bom_leds_on" ref="g2f5fae400bcc24d266c84ca441a1516c" args="(int bit_field)" --> |
| 190 |
<div class="memitem"> |
| 191 |
<div class="memproto"> |
| 192 |
<table class="memname"> |
| 193 |
<tr>
|
| 194 |
<td class="memname">void bom_leds_on </td> |
| 195 |
<td>(</td> |
| 196 |
<td class="paramtype">int </td> |
| 197 |
<td class="paramname"> <em>bit_field</em> </td> |
| 198 |
<td> ) </td> |
| 199 |
<td width="100%"></td> |
| 200 |
</tr>
|
| 201 |
</table>
|
| 202 |
</div>
|
| 203 |
<div class="memdoc"> |
| 204 |
|
| 205 |
<p>
|
| 206 |
Turns on the selected bom leds. Only works with BOM_ALL if using the original bom. |
| 207 |
<p>
|
| 208 |
Iterates through each bit in the bit_field. For each set bit, turns on the corresponding bom led. bom_init must be called for this to work. Only works with BOM_ALL if using the original bom.<p>
|
| 209 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 210 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 211 |
<tr><td valign="top"></td><td valign="top"><em>bit_field</em> </td><td>specifies which leds should be turned on. Use BOM_ALL to turn on all bom leds. Ex. if 0x0005 is passed, leds 0 and 2 will be turned on. </td></tr> |
| 212 |
</table>
|
| 213 |
</dl>
|
| 214 |
|
| 215 |
<p>References <a class="el" href="bom_8h-source.html#l00049">BOM</a>, <a class="el" href="bom_8h-source.html#l00051">BOM15</a>, <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00053">RBOM</a>.</p> |
| 216 |
|
| 217 |
<p>Referenced by <a class="el" href="bom_8c-source.html#l00252">bom_on()</a>.</p> |
| 218 |
|
| 219 |
</div>
|
| 220 |
</div><p> |
| 221 |
<a class="anchor" name="g61a66e53cdee8bce139c707153143b30"></a><!-- doxytag: member="bom.c::bom_off" ref="g61a66e53cdee8bce139c707153143b30" args="(void)" --> |
| 222 |
<div class="memitem"> |
| 223 |
<div class="memproto"> |
| 224 |
<table class="memname"> |
| 225 |
<tr>
|
| 226 |
<td class="memname">void bom_off </td> |
| 227 |
<td>(</td> |
| 228 |
<td class="paramtype">void </td> |
| 229 |
<td class="paramname"> </td> |
| 230 |
<td> ) </td> |
| 231 |
<td width="100%"></td> |
| 232 |
</tr>
|
| 233 |
</table>
|
| 234 |
</div>
|
| 235 |
<div class="memdoc"> |
| 236 |
|
| 237 |
<p>
|
| 238 |
(DEPRECATED) Wrapper function. See bom_leds_off. |
| 239 |
<p>
|
| 240 |
(DEPRECATED) Turns off all bom leds.<p>
|
| 241 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf" title="(DEPRECATED) Wrapper function. See bom_leds_on.">bom_on</a> </dd></dl> |
| 242 |
|
| 243 |
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, and <a class="el" href="bom_8c-source.html#l00218">bom_leds_off()</a>.</p> |
| 244 |
|
| 245 |
</div>
|
| 246 |
</div><p> |
| 247 |
<a class="anchor" name="g93b665ff81fc6b58503c6ba5ba01c1bf"></a><!-- doxytag: member="bom.c::bom_on" ref="g93b665ff81fc6b58503c6ba5ba01c1bf" args="(void)" --> |
| 248 |
<div class="memitem"> |
| 249 |
<div class="memproto"> |
| 250 |
<table class="memname"> |
| 251 |
<tr>
|
| 252 |
<td class="memname">void bom_on </td> |
| 253 |
<td>(</td> |
| 254 |
<td class="paramtype">void </td> |
| 255 |
<td class="paramname"> </td> |
| 256 |
<td> ) </td> |
| 257 |
<td width="100%"></td> |
| 258 |
</tr>
|
| 259 |
</table>
|
| 260 |
</div>
|
| 261 |
<div class="memdoc"> |
| 262 |
|
| 263 |
<p>
|
| 264 |
(DEPRECATED) Wrapper function. See bom_leds_on. |
| 265 |
<p>
|
| 266 |
(DEPRECATED) Turns on all bom leds.<p>
|
| 267 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30" title="(DEPRECATED) Wrapper function. See bom_leds_off.">bom_off</a> </dd></dl> |
| 268 |
|
| 269 |
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, and <a class="el" href="bom_8c-source.html#l00195">bom_leds_on()</a>.</p> |
| 270 |
|
| 271 |
</div>
|
| 272 |
</div><p> |
| 273 |
<a class="anchor" name="gbdcdf3a1428f8145ee5eed82efdaf0fc"></a><!-- doxytag: member="bom.c::bom_refresh" ref="gbdcdf3a1428f8145ee5eed82efdaf0fc" args="(int bit_field)" --> |
| 274 |
<div class="memitem"> |
| 275 |
<div class="memproto"> |
| 276 |
<table class="memname"> |
| 277 |
<tr>
|
| 278 |
<td class="memname">void bom_refresh </td> |
| 279 |
<td>(</td> |
| 280 |
<td class="paramtype">int </td> |
| 281 |
<td class="paramname"> <em>bit_field</em> </td> |
| 282 |
<td> ) </td> |
| 283 |
<td width="100%"></td> |
| 284 |
</tr>
|
| 285 |
</table>
|
| 286 |
</div>
|
| 287 |
<div class="memdoc"> |
| 288 |
|
| 289 |
<p>
|
| 290 |
Refresh bom_val[] with new values from analog8. analog_init and bom_init must be called for this to work. |
| 291 |
<p>
|
| 292 |
Iterates through each bit in the bit_field. For each set bit, sets the corresponding bom select bits and updates the corresponding bom value with an analog_get8 reading. analog_init and bom_init must be called for this to work.<p>
|
| 293 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 294 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 295 |
<tr><td valign="top"></td><td valign="top"><em>bit_field</em> </td><td>specifies which elements in bom_val[] should be updated. Use BOM_ALL to refresh all values. Ex. if 0x0003 is passed, bom_val[0] and bom_val[1] will be updated.</td></tr> |
| 296 |
</table>
|
| 297 |
</dl>
|
| 298 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gd28d2a59a5090390e20f87cfd05b0a8b" title="Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new...">bom_get</a> </dd></dl> |
| 299 |
|
| 300 |
<p>References <a class="el" href="analog_8c-source.html#l00195">analog_get8()</a>, <a class="el" href="analog_8c-source.html#l00160">analog_start_loop()</a>, and <a class="el" href="analog_8c-source.html#l00174">analog_stop_loop()</a>.</p> |
| 301 |
|
| 302 |
<p>Referenced by <a class="el" href="bom_8c-source.html#l00242">get_max_bom()</a>.</p> |
| 303 |
|
| 304 |
</div>
|
| 305 |
</div><p> |
| 306 |
<a class="anchor" name="g86753fe7440cd64e60c58ad31c62264a"></a><!-- doxytag: member="bom.c::get_max_bom" ref="g86753fe7440cd64e60c58ad31c62264a" args="(void)" --> |
| 307 |
<div class="memitem"> |
| 308 |
<div class="memproto"> |
| 309 |
<table class="memname"> |
| 310 |
<tr>
|
| 311 |
<td class="memname">int get_max_bom </td> |
| 312 |
<td>(</td> |
| 313 |
<td class="paramtype">void </td> |
| 314 |
<td class="paramname"> </td> |
| 315 |
<td> ) </td> |
| 316 |
<td width="100%"></td> |
| 317 |
</tr>
|
| 318 |
</table>
|
| 319 |
</div>
|
| 320 |
<div class="memdoc"> |
| 321 |
|
| 322 |
<p>
|
| 323 |
(DEPRECATED) Wrapper function. See bom_refresh and bom_get_max |
| 324 |
<p>
|
| 325 |
(DEPRECATED) Wrapper function for new BOM code. Refreshes buffer and returns the max bom value.<p>
|
| 326 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the direction of the maximum BOM reading</dd></dl> |
| 327 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#gbdcdf3a1428f8145ee5eed82efdaf0fc" title="Refresh bom_val[] with new values from analog8. analog_init and bom_init must be...">bom_refresh</a>, <a class="el" href="group__bom.html#gbce8d8dd8f11d8f5e9f9d74d84ea15db" title="Compares all the values in bom_val[] and returns the index to the highest value element...">bom_get_max</a> </dd></dl> |
| 328 |
|
| 329 |
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="bom_8c-source.html#l00171">bom_get_max()</a>, and <a class="el" href="bom_8c-source.html#l00134">bom_refresh()</a>.</p> |
| 330 |
|
| 331 |
</div>
|
| 332 |
</div><p> |
| 333 |
</div>
|
| 334 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by |
| 335 |
<a href="http://www.doxygen.org/index.html"> |
| 336 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
| 337 |
</body>
|
| 338 |
</html>
|