root / trunk / docs / libdragonfly / group__dragonfly.html @ 862
History | View | Annotate | Download (9.91 KB)
1 | 41 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | 241 | bcoltin | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 | 41 | bcoltin | <title>libdragonfly: Dragonfly</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 | 862 | kwoo | <!-- 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 | 241 | bcoltin | </div>
|
19 | 862 | kwoo | <div class="contents"> |
20 | 241 | bcoltin | <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 | 41 | bcoltin | <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="gd42aa2404559d4a465d5d45e857f2881"></a><!-- doxytag: member="dragonfly::ANALOG" ref="gd42aa2404559d4a465d5d45e857f2881" args="" --> |
||
25 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd42aa2404559d4a465d5d45e857f2881">ANALOG</a> 0x01</td></tr> |
||
26 | |||
27 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize analog. <br></td></tr> |
||
28 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gae3f0b4211ba45d265973d40ccbb5fd1"></a><!-- doxytag: member="dragonfly::SERIAL" ref="gae3f0b4211ba45d265973d40ccbb5fd1" args="" --> |
||
29 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gae3f0b4211ba45d265973d40ccbb5fd1">SERIAL</a> 0x02</td></tr> |
||
30 | |||
31 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize serial communications. <br></td></tr> |
||
32 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g779bf099075a999d1074357fccbd466b"></a><!-- doxytag: member="dragonfly::USB" ref="g779bf099075a999d1074357fccbd466b" args="" --> |
||
33 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g779bf099075a999d1074357fccbd466b">USB</a> 0x02</td></tr> |
||
34 | |||
35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize USB communications. <br></td></tr> |
||
36 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46fff4184b5d787de1ed367b97cb6091"></a><!-- doxytag: member="dragonfly::COMM" ref="g46fff4184b5d787de1ed367b97cb6091" args="" --> |
||
37 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g46fff4184b5d787de1ed367b97cb6091">COMM</a> 0x02</td></tr> |
||
38 | |||
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize communications. <br></td></tr> |
||
40 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g24a9b050b733edb162cbeb44b1a417b1"></a><!-- doxytag: member="dragonfly::ORB" ref="g24a9b050b733edb162cbeb44b1a417b1" args="" --> |
||
41 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g24a9b050b733edb162cbeb44b1a417b1">ORB</a> 0x04</td></tr> |
||
42 | |||
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the orb. <br></td></tr> |
||
44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9bb31bba359fbb679910df0a6efde5a3"></a><!-- doxytag: member="dragonfly::MOTORS" ref="g9bb31bba359fbb679910df0a6efde5a3" args="" --> |
||
45 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">MOTORS</a> 0x08</td></tr> |
||
46 | |||
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the motors. <br></td></tr> |
||
48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g145103118f6d9d1129aa4509cf214a13"></a><!-- doxytag: member="dragonfly::BUZZER" ref="g145103118f6d9d1129aa4509cf214a13" args="" --> |
||
49 | 862 | kwoo | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a> 0x10</td></tr> |
50 | 41 | bcoltin | |
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the buzzer. <br></td></tr> |
||
52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf2d80992dcfabfd1668184c3dff2733"></a><!-- doxytag: member="dragonfly::LCD" ref="gbf2d80992dcfabfd1668184c3dff2733" args="" --> |
||
53 | 862 | kwoo | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a> 0x20</td></tr> |
54 | 41 | bcoltin | |
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the LCD screen. <br></td></tr> |
||
56 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1252cf7a07df96ed2561ae605eaca197"></a><!-- doxytag: member="dragonfly::ALL_ON" ref="g1252cf7a07df96ed2561ae605eaca197" args="" --> |
||
57 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a> 0xFF</td></tr> |
||
58 | |||
59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize everything. <br></td></tr> |
||
60 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g8124e2c32bf25208586d500e45ba5fe3">dragonfly_init</a> (int config)</td></tr> |
||
62 | |||
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the board. <a href="#g8124e2c32bf25208586d500e45ba5fe3"></a><br></td></tr> |
||
64 | </table>
|
||
65 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
66 | 241 | bcoltin | 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. |
67 | 41 | bcoltin | <p>
|
68 | 862 | kwoo | init_dragonfly - Initializes functions based on configuration parameters examples:<p>
|
69 | init_dragonfly (ALL_ON); - Turns on all basic subsystems. More complex ones that require their own configuration parameters must still be called on their own.<p>
|
||
70 | init_dragonfly (ANALOG | SERIAL | BUZZER); Initialize ADC, USB, XBee, and Buzzer<p>
|
||
71 | init_dragonfly (MOTORS | ORB); Initialize the motors and ORB. <hr><h2>Function Documentation</h2> |
||
72 | 241 | bcoltin | <a class="anchor" name="g8124e2c32bf25208586d500e45ba5fe3"></a><!-- doxytag: member="dragonfly_lib.c::dragonfly_init" ref="g8124e2c32bf25208586d500e45ba5fe3" args="(int config)" --> |
73 | <div class="memitem"> |
||
74 | <div class="memproto"> |
||
75 | <table class="memname"> |
||
76 | 41 | bcoltin | <tr>
|
77 | 241 | bcoltin | <td class="memname">void dragonfly_init </td> |
78 | <td>(</td> |
||
79 | <td class="paramtype">int </td> |
||
80 | <td class="paramname"> <em>config</em> </td> |
||
81 | <td> ) </td> |
||
82 | <td width="100%"></td> |
||
83 | 41 | bcoltin | </tr>
|
84 | </table>
|
||
85 | 241 | bcoltin | </div>
|
86 | <div class="memdoc"> |
||
87 | 41 | bcoltin | |
88 | <p>
|
||
89 | Initialize the board. |
||
90 | <p>
|
||
91 | 862 | kwoo | Initializes the components specified by config. Will turn on interrupts automatically.<p>
|
92 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
93 | <table border="0" cellspacing="2" cellpadding="0"> |
||
94 | <tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>The subsystems that you wish to turn on. Check <a class="el" href="dragonfly__lib_8h.html" title="Contains other include files.">dragonfly_lib.h</a> for valid values.</td></tr> |
||
95 | </table>
|
||
96 | </dl>
|
||
97 | 497 | kwoo | <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>, <a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d" title="Initialize the USB.">usb_init</a>, <a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107" 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#g101f932380b02b48a0ca3d20ffc8c08f" title="Initialize the bom according to bom type.">bom_init</a>, <a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9" title="Enables the orbs.">orb_init</a>, <a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21" title="Initialize the motors.">motors_init</a>, <a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6" title="Initialize the LCD screen.">lcd_init</a> </dd></dl> |
98 | 241 | bcoltin | |
99 | 862 | kwoo | <p>References <a class="el" href="dragonfly__lib_8h-source.html#l00046">ANALOG</a>, <a class="el" href="analog_8c-source.html#l00061">analog_init()</a>, <a class="el" href="dragonfly__lib_8h-source.html#l00058">BUZZER</a>, <a class="el" href="buzzer_8c-source.html#l00054">buzzer_init()</a>, <a class="el" href="dragonfly__lib_8h-source.html#l00052">COMM</a>, <a class="el" href="dragonfly__lib_8h-source.html#l00060">LCD</a>, <a class="el" href="lcd_8c-source.html#l00173">lcd_init()</a>, <a class="el" href="dragonfly__lib_8h-source.html#l00056">MOTORS</a>, <a class="el" href="motor_8c-source.html#l00052">motors_init()</a>, <a class="el" href="dragonfly__lib_8h-source.html#l00054">ORB</a>, <a class="el" href="lights_8c-source.html#l00237">orb_init()</a>, <a class="el" href="serial_8c-source.html#l00048">usb_init()</a>, and <a class="el" href="serial_8c-source.html#l00082">xbee_init()</a>.</p> |
100 | |||
101 | 241 | bcoltin | </div>
|
102 | </div><p> |
||
103 | 862 | kwoo | </div>
|
104 | <hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by |
||
105 | 41 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
106 | 862 | kwoo | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
107 | 41 | bcoltin | </body>
|
108 | </html> |