root / branches / wireless / docs / libdragonfly / html / group__dragonfly.html @ 1578
History | View | Annotate | Download (12.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>Colony: Dragonfly</title> |
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.8 -->
|
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>Dragonfly</h1>General Dragonfly Functions General functions for the dragonfly. Include <a class="el" href="dragonfly__lib_8h.html" title="Contains other include files.">dragonfly_lib.h</a> to access these functions. |
21 |
<a href="#_details">More...</a> |
22 |
<p>
|
23 |
<table border="0" cellpadding="0" cellspacing="0"> |
24 |
<tr><td></td></tr> |
25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1b7e6c6d5577949f01afb9c0b91bf32"></a><!-- doxytag: member="dragonfly::ERROR_INIT_FAILED" ref="ga1b7e6c6d5577949f01afb9c0b91bf32" args="" --> |
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#ga1b7e6c6d5577949f01afb9c0b91bf32">ERROR_INIT_FAILED</a> 1</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for init failure. <br></td></tr> |
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf48cf0fb6facd1a2ab4cb396f5d888e6"></a><!-- doxytag: member="dragonfly::ERROR_INIT_ALREADY_INITD" ref="gf48cf0fb6facd1a2ab4cb396f5d888e6" args="" --> |
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gf48cf0fb6facd1a2ab4cb396f5d888e6">ERROR_INIT_ALREADY_INITD</a> 2</td></tr> |
32 |
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for duplicate init calls. <br></td></tr> |
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gef0a5135978b108998cd2bcadf2f13fe"></a><!-- doxytag: member="dragonfly::ERROR_LIBRARY_NOT_INITD" ref="gef0a5135978b108998cd2bcadf2f13fe" args="" --> |
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gef0a5135978b108998cd2bcadf2f13fe">ERROR_LIBRARY_NOT_INITD</a> 3</td></tr> |
36 |
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error code for not calling init. <br></td></tr> |
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd42aa2404559d4a465d5d45e857f2881"></a><!-- doxytag: member="dragonfly::ANALOG" ref="gd42aa2404559d4a465d5d45e857f2881" args="" --> |
39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd42aa2404559d4a465d5d45e857f2881">ANALOG</a> 0x01</td></tr> |
40 |
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize analog. <br></td></tr> |
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gae3f0b4211ba45d265973d40ccbb5fd1"></a><!-- doxytag: member="dragonfly::SERIAL" ref="gae3f0b4211ba45d265973d40ccbb5fd1" args="" --> |
43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gae3f0b4211ba45d265973d40ccbb5fd1">SERIAL</a> 0x02</td></tr> |
44 |
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize serial communications. <br></td></tr> |
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g779bf099075a999d1074357fccbd466b"></a><!-- doxytag: member="dragonfly::USB" ref="g779bf099075a999d1074357fccbd466b" args="" --> |
47 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g779bf099075a999d1074357fccbd466b">USB</a> 0x02</td></tr> |
48 |
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize USB communications. <br></td></tr> |
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46fff4184b5d787de1ed367b97cb6091"></a><!-- doxytag: member="dragonfly::COMM" ref="g46fff4184b5d787de1ed367b97cb6091" args="" --> |
51 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g46fff4184b5d787de1ed367b97cb6091">COMM</a> 0x02</td></tr> |
52 |
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize communications. <br></td></tr> |
54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g24a9b050b733edb162cbeb44b1a417b1"></a><!-- doxytag: member="dragonfly::ORB" ref="g24a9b050b733edb162cbeb44b1a417b1" args="" --> |
55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g24a9b050b733edb162cbeb44b1a417b1">ORB</a> 0x04</td></tr> |
56 |
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the orb. <br></td></tr> |
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9bb31bba359fbb679910df0a6efde5a3"></a><!-- doxytag: member="dragonfly::MOTORS" ref="g9bb31bba359fbb679910df0a6efde5a3" args="" --> |
59 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">MOTORS</a> 0x08</td></tr> |
60 |
|
61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the motors. <br></td></tr> |
62 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g457a9aa93dbb216459873a30bdb4d84a"></a><!-- doxytag: member="dragonfly::I2C" ref="g457a9aa93dbb216459873a30bdb4d84a" args="" --> |
63 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g457a9aa93dbb216459873a30bdb4d84a">I2C</a> 0x20</td></tr> |
64 |
|
65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize I2C. <br></td></tr> |
66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g145103118f6d9d1129aa4509cf214a13"></a><!-- doxytag: member="dragonfly::BUZZER" ref="g145103118f6d9d1129aa4509cf214a13" args="" --> |
67 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a> 0x40</td></tr> |
68 |
|
69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the buzzer. <br></td></tr> |
70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf2d80992dcfabfd1668184c3dff2733"></a><!-- doxytag: member="dragonfly::LCD" ref="gbf2d80992dcfabfd1668184c3dff2733" args="" --> |
71 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a> 0x80</td></tr> |
72 |
|
73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the LCD screen. <br></td></tr> |
74 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc04dd0afaf7ea3eb2ade2544d2d5f907"></a><!-- doxytag: member="dragonfly::RANGE" ref="gc04dd0afaf7ea3eb2ade2544d2d5f907" args="" --> |
75 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gc04dd0afaf7ea3eb2ade2544d2d5f907">RANGE</a> 0x0100</td></tr> |
76 |
|
77 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <br></td></tr> |
78 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd555cfe7a1fcf16c3639f797120478eb"></a><!-- doxytag: member="dragonfly::BOM" ref="gd555cfe7a1fcf16c3639f797120478eb" args="" --> |
79 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd555cfe7a1fcf16c3639f797120478eb">BOM</a> 0x0200</td></tr> |
80 |
|
81 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the BOM. <br></td></tr> |
82 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2a393eeca6113b0cdfa35725b6c6a8fc"></a><!-- doxytag: member="dragonfly::ENCODERS" ref="g2a393eeca6113b0cdfa35725b6c6a8fc" args="" --> |
83 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g2a393eeca6113b0cdfa35725b6c6a8fc">ENCODERS</a> 0x400</td></tr> |
84 |
|
85 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initilize encoders. <br></td></tr> |
86 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1252cf7a07df96ed2561ae605eaca197"></a><!-- doxytag: member="dragonfly::ALL_ON" ref="g1252cf7a07df96ed2561ae605eaca197" args="" --> |
87 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a> 0x07FF</td></tr> |
88 |
|
89 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize everything. <br></td></tr> |
90 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g11289903a89d284a2d7acbe5fbf8d9f9">flash_red</a> (void)</td></tr> |
92 |
|
93 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1a50289d8c072f56fdda95c770ee0136"></a><!-- doxytag: member="dragonfly::dragonfly_init" ref="g1a50289d8c072f56fdda95c770ee0136" args="(int config)" --> |
94 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1a50289d8c072f56fdda95c770ee0136">dragonfly_init</a> (int config)</td></tr> |
95 |
|
96 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the board. <br></td></tr> |
97 |
</table>
|
98 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
99 |
General Dragonfly Functions General functions for the dragonfly. Include <a class="el" href="dragonfly__lib_8h.html" title="Contains other include files.">dragonfly_lib.h</a> to access these functions. <hr><h2>Function Documentation</h2> |
100 |
<a class="anchor" name="g11289903a89d284a2d7acbe5fbf8d9f9"></a><!-- doxytag: member="dragonfly_lib.c::flash_red" ref="g11289903a89d284a2d7acbe5fbf8d9f9" args="(void)" --> |
101 |
<div class="memitem"> |
102 |
<div class="memproto"> |
103 |
<table class="memname"> |
104 |
<tr>
|
105 |
<td class="memname">void flash_red </td> |
106 |
<td>(</td> |
107 |
<td class="paramtype">void </td> |
108 |
<td class="paramname"> </td> |
109 |
<td> ) </td> |
110 |
<td></td> |
111 |
</tr>
|
112 |
</table>
|
113 |
</div>
|
114 |
<div class="memdoc"> |
115 |
|
116 |
<p>
|
117 |
Initializes the components specified by config.<p>
|
118 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#gf998a4653bf62164fcc93b0f58796ab5" title="Initialize analog ports. Will start running a loop if start_conversion is ADC_START...">analog_init</a>, <a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f" title="Initialize the USB.">usb_init</a>, <a class="el" href="group__xbee.html#gdde7e22c6728410a0d913b749bdcb20d" title="Initialize the XBee.">xbee_init</a>, <a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd" title="Initialize the buzzer.">buzzer_init</a>, <a class="el" href="group__bom.html#g246031da5c3e5b2a9a9e26111f94eefc" title="Initialize the bom according to bom type.">bom_init</a>, <a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9" title="Enables the orbs in default mode.">orb_init</a>, <a class="el" href="group__motors.html#gea7444d04318aa45160930076e001171" title="Initialize the motors.">motors_init</a>, <a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6" title="Initialize the LCD screen.">lcd_init</a>, <a class="el" href="group__encoders.html#g517df1c739bb887e39630553f3f10951" title="Initialize encoders.">encoders_init</a> </dd></dl> |
119 |
|
120 |
</div>
|
121 |
</div><p> |
122 |
</div>
|
123 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:59 2009 for Colony by |
124 |
<a href="http://www.doxygen.org/index.html"> |
125 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
126 |
</body>
|
127 |
</html>
|