Revision 1398
recompiled libdragonfly to include new rangefinder doxygen comments
group__orbs.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: Orbs</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> |
... | ... | |
192 | 192 |
<tr> |
193 | 193 |
<td></td> |
194 | 194 |
<td>)</td> |
195 |
<td></td><td></td><td width="100%"></td>
|
|
195 |
<td></td><td></td><td></td> |
|
196 | 196 |
</tr> |
197 | 197 |
</table> |
198 | 198 |
</div> |
... | ... | |
211 | 211 |
</dl> |
212 | 212 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9" title="Enables the orbs in default mode.">orb_init</a> </dd></dl> |
213 | 213 |
|
214 |
<p>References <a class="el" href="dragonfly__lib_8h-source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h-source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
214 |
<p>References <a class="el" href="dragonfly__lib_8h_source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h_source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
215 | 215 |
|
216 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00611">orb1_set_color()</a>.</p>
|
|
216 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00611">orb1_set_color()</a>.</p>
|
|
217 | 217 |
|
218 | 218 |
</div> |
219 | 219 |
</div><p> |
... | ... | |
227 | 227 |
<td class="paramtype">uint8_t </td> |
228 | 228 |
<td class="paramname"> <em>col</em> </td> |
229 | 229 |
<td> ) </td> |
230 |
<td width="100%"></td>
|
|
230 |
<td></td> |
|
231 | 231 |
</tr> |
232 | 232 |
</table> |
233 | 233 |
</div> |
... | ... | |
243 | 243 |
</table> |
244 | 244 |
</dl> |
245 | 245 |
|
246 |
<p>References <a class="el" href="lights_8c-source.html#l00506">orb1_set()</a>.</p>
|
|
246 |
<p>References <a class="el" href="lights_8c_source.html#l00506">orb1_set()</a>.</p>
|
|
247 | 247 |
|
248 | 248 |
</div> |
249 | 249 |
</div><p> |
... | ... | |
272 | 272 |
<tr> |
273 | 273 |
<td></td> |
274 | 274 |
<td>)</td> |
275 |
<td></td><td></td><td width="100%"></td>
|
|
275 |
<td></td><td></td><td></td> |
|
276 | 276 |
</tr> |
277 | 277 |
</table> |
278 | 278 |
</div> |
... | ... | |
291 | 291 |
</dl> |
292 | 292 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9" title="Enables the orbs in default mode.">orb_init</a> </dd></dl> |
293 | 293 |
|
294 |
<p>References <a class="el" href="dragonfly__lib_8h-source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h-source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
294 |
<p>References <a class="el" href="dragonfly__lib_8h_source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h_source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
295 | 295 |
|
296 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00620">orb2_set_color()</a>.</p>
|
|
296 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00620">orb2_set_color()</a>.</p>
|
|
297 | 297 |
|
298 | 298 |
</div> |
299 | 299 |
</div><p> |
... | ... | |
307 | 307 |
<td class="paramtype">uint8_t </td> |
308 | 308 |
<td class="paramname"> <em>col</em> </td> |
309 | 309 |
<td> ) </td> |
310 |
<td width="100%"></td>
|
|
310 |
<td></td> |
|
311 | 311 |
</tr> |
312 | 312 |
</table> |
313 | 313 |
</div> |
... | ... | |
323 | 323 |
</table> |
324 | 324 |
</dl> |
325 | 325 |
|
326 |
<p>References <a class="el" href="lights_8c-source.html#l00526">orb2_set()</a>.</p>
|
|
326 |
<p>References <a class="el" href="lights_8c_source.html#l00526">orb2_set()</a>.</p>
|
|
327 | 327 |
|
328 | 328 |
</div> |
329 | 329 |
</div><p> |
... | ... | |
337 | 337 |
<td class="paramtype">void </td> |
338 | 338 |
<td class="paramname"> </td> |
339 | 339 |
<td> ) </td> |
340 |
<td width="100%"></td>
|
|
340 |
<td></td> |
|
341 | 341 |
</tr> |
342 | 342 |
</table> |
343 | 343 |
</div> |
... | ... | |
348 | 348 |
<p> |
349 | 349 |
Disables the orb timer. Note that you usually don't want to use this function directly. Instead, use orb_set_mode. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#ga1d0fbfe351097e16652a658af5c8955" title="Switches the orbs to the specified mode.">orb_set_mode</a> </dd></dl> |
350 | 350 |
|
351 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00693">orb_set_mode()</a>.</p>
|
|
351 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00693">orb_set_mode()</a>.</p>
|
|
352 | 352 |
|
353 | 353 |
</div> |
354 | 354 |
</div><p> |
... | ... | |
362 | 362 |
<td class="paramtype">void </td> |
363 | 363 |
<td class="paramname"> </td> |
364 | 364 |
<td> ) </td> |
365 |
<td width="100%"></td>
|
|
365 |
<td></td> |
|
366 | 366 |
</tr> |
367 | 367 |
</table> |
368 | 368 |
</div> |
... | ... | |
373 | 373 |
<p> |
374 | 374 |
Enables the orb timer. Note that you usually don't want to use this function directly. Instead, use orb_set_mode. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#ga1d0fbfe351097e16652a658af5c8955" title="Switches the orbs to the specified mode.">orb_set_mode</a> </dd></dl> |
375 | 375 |
|
376 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00693">orb_set_mode()</a>.</p>
|
|
376 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00693">orb_set_mode()</a>.</p>
|
|
377 | 377 |
|
378 | 378 |
</div> |
379 | 379 |
</div><p> |
... | ... | |
387 | 387 |
<td class="paramtype">void </td> |
388 | 388 |
<td class="paramname"> </td> |
389 | 389 |
<td> ) </td> |
390 |
<td width="100%"></td>
|
|
390 |
<td></td> |
|
391 | 391 |
</tr> |
392 | 392 |
</table> |
393 | 393 |
</div> |
... | ... | |
400 | 400 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#gbb9bc432db2639616a7e8b3211544891" title="Enables the orbs in PWM mode.">orb_init_pwm</a> <p> |
401 | 401 |
<a class="el" href="group__orbs.html#g55a2b60caf9fe91346bed89c7bba73b7" title="Enables the orbs in binary mode.">orb_init_binary</a> </dd></dl> |
402 | 402 |
|
403 |
<p>References <a class="el" href="lights_8c-source.html#l00743">orb_init_pwm()</a>.</p>
|
|
403 |
<p>References <a class="el" href="lights_8c_source.html#l00743">orb_init_pwm()</a>.</p>
|
|
404 | 404 |
|
405 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>
|
|
405 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c_source.html#l00068">dragonfly_init()</a>.</p>
|
|
406 | 406 |
|
407 | 407 |
</div> |
408 | 408 |
</div><p> |
... | ... | |
416 | 416 |
<td class="paramtype">void </td> |
417 | 417 |
<td class="paramname"> </td> |
418 | 418 |
<td> ) </td> |
419 |
<td width="100%"></td>
|
|
419 |
<td></td> |
|
420 | 420 |
</tr> |
421 | 421 |
</table> |
422 | 422 |
</div> |
... | ... | |
428 | 428 |
Initializes the orbs in PWM mode. One of the orb_init* functions must be called before the orbs can be used.<p> |
429 | 429 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#gbb9bc432db2639616a7e8b3211544891" title="Enables the orbs in PWM mode.">orb_init_pwm</a> </dd></dl> |
430 | 430 |
|
431 |
<p>References <a class="el" href="lights_8h-source.html#l00169">orb_mode_binary</a>, and <a class="el" href="lights_8c-source.html#l00693">orb_set_mode()</a>.</p>
|
|
431 |
<p>References <a class="el" href="lights_8h_source.html#l00169">orb_mode_binary</a>, and <a class="el" href="lights_8c_source.html#l00693">orb_set_mode()</a>.</p>
|
|
432 | 432 |
|
433 | 433 |
</div> |
434 | 434 |
</div><p> |
... | ... | |
442 | 442 |
<td class="paramtype">void </td> |
443 | 443 |
<td class="paramname"> </td> |
444 | 444 |
<td> ) </td> |
445 |
<td width="100%"></td>
|
|
445 |
<td></td> |
|
446 | 446 |
</tr> |
447 | 447 |
</table> |
448 | 448 |
</div> |
... | ... | |
454 | 454 |
Initializes the orbs in PWM mode. One of the orb_init* functions must be called before the orbs can be used.<p> |
455 | 455 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g55a2b60caf9fe91346bed89c7bba73b7" title="Enables the orbs in binary mode.">orb_init_binary</a> </dd></dl> |
456 | 456 |
|
457 |
<p>References <a class="el" href="lights_8h-source.html#l00166">orb_mode_pwm</a>, and <a class="el" href="lights_8c-source.html#l00693">orb_set_mode()</a>.</p>
|
|
457 |
<p>References <a class="el" href="lights_8h_source.html#l00166">orb_mode_pwm</a>, and <a class="el" href="lights_8c_source.html#l00693">orb_set_mode()</a>.</p>
|
|
458 | 458 |
|
459 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00755">orb_init()</a>.</p>
|
|
459 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00755">orb_init()</a>.</p>
|
|
460 | 460 |
|
461 | 461 |
</div> |
462 | 462 |
</div><p> |
... | ... | |
491 | 491 |
<tr> |
492 | 492 |
<td></td> |
493 | 493 |
<td>)</td> |
494 |
<td></td><td></td><td width="100%"></td>
|
|
494 |
<td></td><td></td><td></td> |
|
495 | 495 |
</tr> |
496 | 496 |
</table> |
497 | 497 |
</div> |
... | ... | |
511 | 511 |
</dl> |
512 | 512 |
<dl class="see" compact><dt><b>See also:</b></dt><dd></dd></dl> |
513 | 513 |
|
514 |
<p>References <a class="el" href="dragonfly__lib_8h-source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h-source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
514 |
<p>References <a class="el" href="dragonfly__lib_8h_source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h_source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
515 | 515 |
|
516 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00602">orb_n_set_color()</a>.</p>
|
|
516 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00602">orb_n_set_color()</a>.</p>
|
|
517 | 517 |
|
518 | 518 |
</div> |
519 | 519 |
</div><p> |
... | ... | |
536 | 536 |
<tr> |
537 | 537 |
<td></td> |
538 | 538 |
<td>)</td> |
539 |
<td></td><td></td><td width="100%"></td>
|
|
539 |
<td></td><td></td><td></td> |
|
540 | 540 |
</tr> |
541 | 541 |
</table> |
542 | 542 |
</div> |
... | ... | |
553 | 553 |
</table> |
554 | 554 |
</dl> |
555 | 555 |
|
556 |
<p>References <a class="el" href="lights_8c-source.html#l00486">orb_n_set()</a>.</p>
|
|
556 |
<p>References <a class="el" href="lights_8c_source.html#l00486">orb_n_set()</a>.</p>
|
|
557 | 557 |
|
558 | 558 |
</div> |
559 | 559 |
</div><p> |
... | ... | |
582 | 582 |
<tr> |
583 | 583 |
<td></td> |
584 | 584 |
<td>)</td> |
585 |
<td></td><td></td><td width="100%"></td>
|
|
585 |
<td></td><td></td><td></td> |
|
586 | 586 |
</tr> |
587 | 587 |
</table> |
588 | 588 |
</div> |
... | ... | |
601 | 601 |
</dl> |
602 | 602 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9" title="Enables the orbs in default mode.">orb_init</a>, <a class="el" href="group__orbs.html#g06c1b846b943bd327a2bc9f37b926497" title="Set orb1 to a specified color.">orb1_set</a>, <a class="el" href="group__orbs.html#g618af3d39cb8cd954248da295f7f234c" title="Set orb2 to a specified color.">orb2_set</a> </dd></dl> |
603 | 603 |
|
604 |
<p>References <a class="el" href="dragonfly__lib_8h-source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h-source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
604 |
<p>References <a class="el" href="dragonfly__lib_8h_source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h_source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
605 | 605 |
|
606 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00629">orb_set_color()</a>.</p>
|
|
606 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00629">orb_set_color()</a>.</p>
|
|
607 | 607 |
|
608 | 608 |
</div> |
609 | 609 |
</div><p> |
... | ... | |
617 | 617 |
<td class="paramtype">uint8_t </td> |
618 | 618 |
<td class="paramname"> <em>col</em> </td> |
619 | 619 |
<td> ) </td> |
620 |
<td width="100%"></td>
|
|
620 |
<td></td> |
|
621 | 621 |
</tr> |
622 | 622 |
</table> |
623 | 623 |
</div> |
... | ... | |
633 | 633 |
</table> |
634 | 634 |
</dl> |
635 | 635 |
|
636 |
<p>References <a class="el" href="lights_8c-source.html#l00544">orb_set()</a>.</p>
|
|
636 |
<p>References <a class="el" href="lights_8c_source.html#l00544">orb_set()</a>.</p>
|
|
637 | 637 |
|
638 | 638 |
</div> |
639 | 639 |
</div><p> |
... | ... | |
680 | 680 |
<tr> |
681 | 681 |
<td></td> |
682 | 682 |
<td>)</td> |
683 |
<td></td><td></td><td width="100%"></td>
|
|
683 |
<td></td><td></td><td></td> |
|
684 | 684 |
</tr> |
685 | 685 |
</table> |
686 | 686 |
</div> |
... | ... | |
702 | 702 |
<a class="el" href="group__orbs.html#g618af3d39cb8cd954248da295f7f234c" title="Set orb2 to a specified color.">orb2_set</a> <p> |
703 | 703 |
<a class="el" href="group__orbs.html#ge066e81a39023cf8a36efd432bb9a4ff" title="set the specified orb to a specified color">orb_n_set</a> </dd></dl> |
704 | 704 |
|
705 |
<p>References <a class="el" href="dragonfly__lib_8h-source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h-source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
705 |
<p>References <a class="el" href="dragonfly__lib_8h_source.html#l00110">RELEASE_LOCK</a>, and <a class="el" href="dragonfly__lib_8h_source.html#l00107">REQUIRE_LOCK_OR_RETURN</a>.</p>
|
|
706 | 706 |
|
707 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00639">orbs_set_color()</a>.</p>
|
|
707 |
<p>Referenced by <a class="el" href="lights_8c_source.html#l00639">orbs_set_color()</a>.</p>
|
|
708 | 708 |
|
709 | 709 |
</div> |
710 | 710 |
</div><p> |
... | ... | |
727 | 727 |
<tr> |
728 | 728 |
<td></td> |
729 | 729 |
<td>)</td> |
730 |
<td></td><td></td><td width="100%"></td>
|
|
730 |
<td></td><td></td><td></td> |
|
731 | 731 |
</tr> |
732 | 732 |
</table> |
733 | 733 |
</div> |
... | ... | |
744 | 744 |
</table> |
745 | 745 |
</dl> |
746 | 746 |
|
747 |
<p>References <a class="el" href="lights_8c-source.html#l00569">orbs_set()</a>.</p>
|
|
747 |
<p>References <a class="el" href="lights_8c_source.html#l00569">orbs_set()</a>.</p>
|
|
748 | 748 |
|
749 | 749 |
</div> |
750 | 750 |
</div><p> |
751 | 751 |
</div> |
752 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:09 2009 for libdragonfly by
|
|
752 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by
|
|
753 | 753 |
<a href="http://www.doxygen.org/index.html"> |
754 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
754 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
755 | 755 |
</body> |
756 | 756 |
</html> |
Also available in: Unified diff