Revision 1145
Generated documentation for new orbs code
| group__dragonfly.html | ||
|---|---|---|
| 4 | 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 | 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.3 --> |
|
| 8 |
<div class="tabs"> |
|
| 9 |
<ul> |
|
| 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
| 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
|
| 15 |
</ul> |
|
| 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> |
|
| 16 | 18 |
</div> |
| 19 |
<div class="contents"> |
|
| 17 | 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. |
| 18 | 21 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 19 | 22 |
<tr><td></td></tr> |
| ... | ... | |
| 42 | 45 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">MOTORS</a> 0x08</td></tr> |
| 43 | 46 |
|
| 44 | 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="g457a9aa93dbb216459873a30bdb4d84a"></a><!-- doxytag: member="dragonfly::I2C" ref="g457a9aa93dbb216459873a30bdb4d84a" args="" --> |
|
| 49 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g457a9aa93dbb216459873a30bdb4d84a">I2C</a> 0x20</td></tr> |
|
| 50 |
|
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize I2C. <br></td></tr> |
|
| 45 | 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g145103118f6d9d1129aa4509cf214a13"></a><!-- doxytag: member="dragonfly::BUZZER" ref="g145103118f6d9d1129aa4509cf214a13" args="" --> |
| 46 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a> 0x10</td></tr>
|
|
| 53 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a> 0x40</td></tr>
|
|
| 47 | 54 |
|
| 48 | 55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the buzzer. <br></td></tr> |
| 49 | 56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf2d80992dcfabfd1668184c3dff2733"></a><!-- doxytag: member="dragonfly::LCD" ref="gbf2d80992dcfabfd1668184c3dff2733" args="" --> |
| 50 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a> 0x20</td></tr>
|
|
| 57 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a> 0x80</td></tr>
|
|
| 51 | 58 |
|
| 52 | 59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the LCD screen. <br></td></tr> |
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc04dd0afaf7ea3eb2ade2544d2d5f907"></a><!-- doxytag: member="dragonfly::RANGE" ref="gc04dd0afaf7ea3eb2ade2544d2d5f907" args="" --> |
|
| 61 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gc04dd0afaf7ea3eb2ade2544d2d5f907">RANGE</a> 0x0100</td></tr> |
|
| 62 |
|
|
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <br></td></tr> |
|
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd555cfe7a1fcf16c3639f797120478eb"></a><!-- doxytag: member="dragonfly::BOM" ref="gd555cfe7a1fcf16c3639f797120478eb" args="" --> |
|
| 65 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd555cfe7a1fcf16c3639f797120478eb">BOM</a> 0x0200</td></tr> |
|
| 66 |
|
|
| 67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the BOM. <br></td></tr> |
|
| 53 | 68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1252cf7a07df96ed2561ae605eaca197"></a><!-- doxytag: member="dragonfly::ALL_ON" ref="g1252cf7a07df96ed2561ae605eaca197" args="" --> |
| 54 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a> 0xFF</td></tr> |
|
| 69 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a> 0x03FF</td></tr>
|
|
| 55 | 70 |
|
| 56 | 71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize everything. <br></td></tr> |
| 57 | 72 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 58 |
<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>
|
|
| 73 |
<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>
|
|
| 59 | 74 |
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the board. <a href="#g8124e2c32bf25208586d500e45ba5fe3"></a><br></td></tr> |
|
| 75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8124e2c32bf25208586d500e45ba5fe3"></a><!-- doxytag: member="dragonfly::dragonfly_init" ref="g8124e2c32bf25208586d500e45ba5fe3" args="(int config)" --> |
|
| 76 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g8124e2c32bf25208586d500e45ba5fe3">dragonfly_init</a> (int config)</td></tr> |
|
| 77 |
|
|
| 78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the board. <br></td></tr> |
|
| 61 | 79 |
</table> |
| 62 | 80 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 63 | 81 |
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. |
| 64 | 82 |
<p> |
| 65 |
init_dragonfly - Initializes functions based on configuration parameters examples:<p> |
|
| 66 |
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> |
|
| 67 |
init_dragonfly (ANALOG | SERIAL | BUZZER); Initialize ADC, USB, XBee, and Buzzer<p> |
|
| 68 |
init_dragonfly (MOTORS | ORB); Initialize the motors and ORB. <hr><h2>Function Documentation</h2> |
|
| 69 |
<a class="anchor" name="g8124e2c32bf25208586d500e45ba5fe3"></a><!-- doxytag: member="dragonfly_lib.c::dragonfly_init" ref="g8124e2c32bf25208586d500e45ba5fe3" args="(int config)" --> |
|
| 83 |
<hr><h2>Function Documentation</h2> |
|
| 84 |
<a class="anchor" name="g11289903a89d284a2d7acbe5fbf8d9f9"></a><!-- doxytag: member="dragonfly_lib.c::flash_red" ref="g11289903a89d284a2d7acbe5fbf8d9f9" args="(void)" --> |
|
| 70 | 85 |
<div class="memitem"> |
| 71 | 86 |
<div class="memproto"> |
| 72 | 87 |
<table class="memname"> |
| 73 | 88 |
<tr> |
| 74 |
<td class="memname">void dragonfly_init </td>
|
|
| 89 |
<td class="memname">void flash_red </td>
|
|
| 75 | 90 |
<td>(</td> |
| 76 |
<td class="paramtype">int </td>
|
|
| 77 |
<td class="paramname"> <em>config</em> </td>
|
|
| 91 |
<td class="paramtype">void </td>
|
|
| 92 |
<td class="paramname"> </td> |
|
| 78 | 93 |
<td> ) </td> |
| 79 | 94 |
<td width="100%"></td> |
| 80 | 95 |
</tr> |
| ... | ... | |
| 83 | 98 |
<div class="memdoc"> |
| 84 | 99 |
|
| 85 | 100 |
<p> |
| 86 |
Initialize the board. |
|
| 87 |
<p> |
|
| 88 |
Initializes the components specified by config. Will turn on interrupts automatically.<p> |
|
| 89 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 90 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 91 |
<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> |
|
| 92 |
</table> |
|
| 93 |
</dl> |
|
| 94 |
<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> |
|
| 101 |
Initializes the components specified by config.<p> |
|
| 102 |
<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 in default mode.">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> |
|
| 95 | 103 |
|
| 104 |
<p>References <a class="el" href="time_8c-source.html#l00104">delay_ms()</a>.</p> |
|
| 105 |
|
|
| 106 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p> |
|
| 107 |
|
|
| 96 | 108 |
</div> |
| 97 | 109 |
</div><p> |
| 98 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:43 2008 for libdragonfly by |
|
| 110 |
</div> |
|
| 111 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by |
|
| 99 | 112 |
<a href="http://www.doxygen.org/index.html"> |
| 100 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 113 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
| 101 | 114 |
</body> |
| 102 | 115 |
</html> |
Also available in: Unified diff