Project

General

Profile

Revision 1398

Added by Chris Mar over 14 years ago

recompiled libdragonfly to include new rangefinder doxygen comments

View differences:

group__bom.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libdragonfly: BOM (Bearing and Orientation Module)</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6
</head><body>
7
<!-- Generated by Doxygen 1.5.5 -->
7
<!-- Generated by Doxygen 1.5.9 -->
8 8
<div class="navigation" id="top">
9 9
  <div class="tabs">
10 10
    <ul>
......
18 18
</div>
19 19
<div class="contents">
20 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">
21
<a href="#_details">More...</a>
22
<p>
23
<table border="0" cellpadding="0" cellspacing="0">
22 24
<tr><td></td></tr>
23 25
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
24 26
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3f1e6fc7eeb6d7cffde8bb03ff8dc488"></a><!-- doxytag: member="bom::BOM_ALL" ref="g3f1e6fc7eeb6d7cffde8bb03ff8dc488" args="" -->
......
78 80
          <td class="paramtype">int&nbsp;</td>
79 81
          <td class="paramname"> <em>which</em>          </td>
80 82
          <td>&nbsp;)&nbsp;</td>
81
          <td width="100%"></td>
83
          <td></td>
82 84
        </tr>
83 85
      </table>
84 86
</div>
......
107 109
          <td class="paramtype">void&nbsp;</td>
108 110
          <td class="paramname">          </td>
109 111
          <td>&nbsp;)&nbsp;</td>
110
          <td width="100%"></td>
112
          <td></td>
111 113
        </tr>
112 114
      </table>
113 115
</div>
......
119 121
Compares all the values in bom_val[] and returns the index to the lowest (max) value element.<p>
120 122
<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>
121 123

  
122
<p>Referenced by <a class="el" href="bom_8c-source.html#l00268">get_max_bom()</a>.</p>
124
<p>Referenced by <a class="el" href="bom_8c_source.html#l00268">get_max_bom()</a>.</p>
123 125

  
124 126
</div>
125 127
</div><p>
......
133 135
          <td class="paramtype">char&nbsp;</td>
134 136
          <td class="paramname"> <em>type</em>          </td>
135 137
          <td>&nbsp;)&nbsp;</td>
136
          <td width="100%"></td>
138
          <td></td>
137 139
        </tr>
138 140
      </table>
139 141
</div>
......
146 148
INCOMPLETE - No utilization of BOM1.5 RSSI capability. Probably leave this out until Cornell and Pras return<p>
147 149
<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>, bom_leds_on, bom_leds_off </dd></dl>
148 150

  
149
<p>References <a class="el" href="bom_8h-source.html#l00050">BOM10</a>, <a class="el" href="bom_8h-source.html#l00053">BOM15</a>, <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="bom_8c-source.html#l00228">bom_set_leds()</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00056">RBOM</a>.</p>
151
<p>References <a class="el" href="bom_8h_source.html#l00050">BOM10</a>, <a class="el" href="bom_8h_source.html#l00053">BOM15</a>, <a class="el" href="bom_8h_source.html#l00047">BOM_ALL</a>, <a class="el" href="bom_8c_source.html#l00228">bom_set_leds()</a>, <a class="el" href="dio_8c_source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h_source.html#l00056">RBOM</a>.</p>
150 152

  
151
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>
153
<p>Referenced by <a class="el" href="dragonfly__lib_8c_source.html#l00068">dragonfly_init()</a>.</p>
152 154

  
153 155
</div>
154 156
</div><p>
......
162 164
          <td class="paramtype">void&nbsp;</td>
163 165
          <td class="paramname">          </td>
164 166
          <td>&nbsp;)&nbsp;</td>
165
          <td width="100%"></td>
167
          <td></td>
166 168
        </tr>
167 169
      </table>
168 170
</div>
......
174 176
Turns off all bom leds.<p>
175 177
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g93b665ff81fc6b58503c6ba5ba01c1bf" title="Turns on all BOM leds, or turns on enabled leds on a BOM1.5.">bom_on</a> </dd></dl>
176 178

  
177
<p>References <a class="el" href="bom_8h-source.html#l00050">BOM10</a>, <a class="el" href="bom_8h-source.html#l00053">BOM15</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00056">RBOM</a>.</p>
179
<p>References <a class="el" href="bom_8h_source.html#l00050">BOM10</a>, <a class="el" href="bom_8h_source.html#l00053">BOM15</a>, <a class="el" href="dio_8c_source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h_source.html#l00056">RBOM</a>.</p>
178 180

  
179 181
</div>
180 182
</div><p>
......
188 190
          <td class="paramtype">void&nbsp;</td>
189 191
          <td class="paramname">          </td>
190 192
          <td>&nbsp;)&nbsp;</td>
191
          <td width="100%"></td>
193
          <td></td>
192 194
        </tr>
193 195
      </table>
194 196
</div>
......
200 202
Flashes the BOM. If using a BOM1.5, only the emitters that have been enabled using bom_set_leds will turn on.<p>
201 203
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__bom.html#g61a66e53cdee8bce139c707153143b30" title="Turns off all bom leds.">bom_off</a>, <a class="el" href="group__bom.html#g8e42fe2740ecc49e7c057e9d7df9c9eb" title="Enables the selected bom leds on a BOM1.5.">bom_set_leds</a> </dd></dl>
202 204

  
203
<p>References <a class="el" href="bom_8h-source.html#l00050">BOM10</a>, <a class="el" href="bom_8h-source.html#l00053">BOM15</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00056">RBOM</a>.</p>
205
<p>References <a class="el" href="bom_8h_source.html#l00050">BOM10</a>, <a class="el" href="bom_8h_source.html#l00053">BOM15</a>, <a class="el" href="dio_8c_source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h_source.html#l00056">RBOM</a>.</p>
204 206

  
205 207
</div>
206 208
</div><p>
......
214 216
          <td class="paramtype">int&nbsp;</td>
215 217
          <td class="paramname"> <em>bit_field</em>          </td>
216 218
          <td>&nbsp;)&nbsp;</td>
217
          <td width="100%"></td>
219
          <td></td>
218 220
        </tr>
219 221
      </table>
220 222
</div>
......
231 233
</dl>
232 234
<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>
233 235

  
234
<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>
236
<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>
235 237

  
236
<p>Referenced by <a class="el" href="bom_8c-source.html#l00268">get_max_bom()</a>.</p>
238
<p>Referenced by <a class="el" href="bom_8c_source.html#l00268">get_max_bom()</a>.</p>
237 239

  
238 240
</div>
239 241
</div><p>
......
247 249
          <td class="paramtype">int&nbsp;</td>
248 250
          <td class="paramname"> <em>bit_field</em>          </td>
249 251
          <td>&nbsp;)&nbsp;</td>
250
          <td width="100%"></td>
252
          <td></td>
251 253
        </tr>
252 254
      </table>
253 255
</div>
......
263 265
  </table>
264 266
</dl>
265 267

  
266
<p>References <a class="el" href="bom_8h-source.html#l00050">BOM10</a>, <a class="el" href="bom_8h-source.html#l00053">BOM15</a>, <a class="el" href="dio_8c-source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h-source.html#l00056">RBOM</a>.</p>
268
<p>References <a class="el" href="bom_8h_source.html#l00050">BOM10</a>, <a class="el" href="bom_8h_source.html#l00053">BOM15</a>, <a class="el" href="dio_8c_source.html#l00162">digital_output()</a>, and <a class="el" href="bom_8h_source.html#l00056">RBOM</a>.</p>
267 269

  
268
<p>Referenced by <a class="el" href="bom_8c-source.html#l00130">bom_init()</a>.</p>
270
<p>Referenced by <a class="el" href="bom_8c_source.html#l00130">bom_init()</a>.</p>
269 271

  
270 272
</div>
271 273
</div><p>
......
279 281
          <td class="paramtype">void&nbsp;</td>
280 282
          <td class="paramname">          </td>
281 283
          <td>&nbsp;)&nbsp;</td>
282
          <td width="100%"></td>
284
          <td></td>
283 285
        </tr>
284 286
      </table>
285 287
</div>
......
292 294
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the direction of the maximum BOM reading</dd></dl>
293 295
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g4be2ba5e4db17e5be950af682f9ad522" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a> </dd></dl>
294 296

  
295
<p>References <a class="el" href="bom_8h-source.html#l00047">BOM_ALL</a>, <a class="el" href="bom_8c-source.html#l00203">bom_get_max()</a>, and <a class="el" href="bom_8c-source.html#l00168">bom_refresh()</a>.</p>
297
<p>References <a class="el" href="bom_8h_source.html#l00047">BOM_ALL</a>, <a class="el" href="bom_8c_source.html#l00203">bom_get_max()</a>, and <a class="el" href="bom_8c_source.html#l00168">bom_refresh()</a>.</p>
296 298

  
297 299
</div>
298 300
</div><p>
299 301
</div>
300
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:08 2009 for libdragonfly by&nbsp;
302
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;
301 303
<a href="http://www.doxygen.org/index.html">
302
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
304
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
303 305
</body>
304 306
</html>

Also available in: Unified diff