root / trunk / docs / libdragonfly / group__dragonfly.html @ 6
History | View | Annotate | Download (10.2 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| 3 |
<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 |
<!-- Generated by Doxygen 1.4.6 -->
|
| 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="files.html"><span>Files</span></a></li> |
| 13 |
</ul></div> |
| 14 |
<h1>Dragonfly</h1>General Dragonfly Functions General functions for the dragonfly. Include <a class="el" href="dragonfly__lib_8h.html">dragonfly_lib.h</a> to access these functions. |
| 15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 16 |
<tr><td></td></tr> |
| 17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd42aa2404559d4a465d5d45e857f2881"></a><!-- doxytag: member="dragonfly::ANALOG" ref="gd42aa2404559d4a465d5d45e857f2881" args="" --> |
| 19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd42aa2404559d4a465d5d45e857f2881">ANALOG</a> 0x01</td></tr> |
| 20 |
|
| 21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize analog. <br></td></tr> |
| 22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gae3f0b4211ba45d265973d40ccbb5fd1"></a><!-- doxytag: member="dragonfly::SERIAL" ref="gae3f0b4211ba45d265973d40ccbb5fd1" args="" --> |
| 23 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gae3f0b4211ba45d265973d40ccbb5fd1">SERIAL</a> 0x02</td></tr> |
| 24 |
|
| 25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize serial communications. <br></td></tr> |
| 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g779bf099075a999d1074357fccbd466b"></a><!-- doxytag: member="dragonfly::USB" ref="g779bf099075a999d1074357fccbd466b" args="" --> |
| 27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g779bf099075a999d1074357fccbd466b">USB</a> 0x02</td></tr> |
| 28 |
|
| 29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize USB communications. <br></td></tr> |
| 30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46fff4184b5d787de1ed367b97cb6091"></a><!-- doxytag: member="dragonfly::COMM" ref="g46fff4184b5d787de1ed367b97cb6091" args="" --> |
| 31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g46fff4184b5d787de1ed367b97cb6091">COMM</a> 0x02</td></tr> |
| 32 |
|
| 33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize communications. <br></td></tr> |
| 34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g24a9b050b733edb162cbeb44b1a417b1"></a><!-- doxytag: member="dragonfly::ORB" ref="g24a9b050b733edb162cbeb44b1a417b1" args="" --> |
| 35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g24a9b050b733edb162cbeb44b1a417b1">ORB</a> 0x04</td></tr> |
| 36 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the orb. <br></td></tr> |
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9bb31bba359fbb679910df0a6efde5a3"></a><!-- doxytag: member="dragonfly::MOTORS" ref="g9bb31bba359fbb679910df0a6efde5a3" args="" --> |
| 39 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">MOTORS</a> 0x08</td></tr> |
| 40 |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the motors. <br></td></tr> |
| 42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7baed4559391f95790fea2b456a22b68"></a><!-- doxytag: member="dragonfly::SERVOS" ref="g7baed4559391f95790fea2b456a22b68" args="" --> |
| 43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g7baed4559391f95790fea2b456a22b68">SERVOS</a> 0x10</td></tr> |
| 44 |
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the servos. <br></td></tr> |
| 46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g457a9aa93dbb216459873a30bdb4d84a"></a><!-- doxytag: member="dragonfly::I2C" ref="g457a9aa93dbb216459873a30bdb4d84a" args="" --> |
| 47 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g457a9aa93dbb216459873a30bdb4d84a">I2C</a> 0x20</td></tr> |
| 48 |
|
| 49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize I2C. <br></td></tr> |
| 50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g145103118f6d9d1129aa4509cf214a13"></a><!-- doxytag: member="dragonfly::BUZZER" ref="g145103118f6d9d1129aa4509cf214a13" args="" --> |
| 51 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a> 0x40</td></tr> |
| 52 |
|
| 53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the buzzer. <br></td></tr> |
| 54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf2d80992dcfabfd1668184c3dff2733"></a><!-- doxytag: member="dragonfly::LCD" ref="gbf2d80992dcfabfd1668184c3dff2733" args="" --> |
| 55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a> 0x80</td></tr> |
| 56 |
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the LCD screen. <br></td></tr> |
| 58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1252cf7a07df96ed2561ae605eaca197"></a><!-- doxytag: member="dragonfly::ALL_ON" ref="g1252cf7a07df96ed2561ae605eaca197" args="" --> |
| 59 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a> 0xFF</td></tr> |
| 60 |
|
| 61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize everything. <br></td></tr> |
| 62 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 63 |
<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> |
| 64 |
|
| 65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the board. <a href="#g8124e2c32bf25208586d500e45ba5fe3"></a><br></td></tr> |
| 66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g3aea9deb2a0bfea9ff05a898f4822e31">reset</a> (void)</td></tr> |
| 67 |
|
| 68 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the robot. <a href="#g3aea9deb2a0bfea9ff05a898f4822e31"></a><br></td></tr> |
| 69 |
</table>
|
| 70 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 71 |
General Dragonfly Functions General functions for the dragonfly. Include <a class="el" href="dragonfly__lib_8h.html">dragonfly_lib.h</a> to access these functions. |
| 72 |
<p>
|
| 73 |
<hr><h2>Function Documentation</h2> |
| 74 |
<a class="anchor" name="g8124e2c32bf25208586d500e45ba5fe3"></a><!-- doxytag: member="dragonfly_lib.c::dragonfly_init" ref="g8124e2c32bf25208586d500e45ba5fe3" args="(int config)" --><p> |
| 75 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 76 |
<tr>
|
| 77 |
<td class="mdRow"> |
| 78 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 79 |
<tr>
|
| 80 |
<td class="md" nowrap valign="top">void dragonfly_init </td> |
| 81 |
<td class="md" valign="top">( </td> |
| 82 |
<td class="md" nowrap valign="top">int </td> |
| 83 |
<td class="mdname1" valign="top" nowrap> <em>config</em> </td> |
| 84 |
<td class="md" valign="top"> ) </td> |
| 85 |
<td class="md" nowrap></td> |
| 86 |
</tr>
|
| 87 |
</table>
|
| 88 |
</td>
|
| 89 |
</tr>
|
| 90 |
</table>
|
| 91 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 92 |
<tr>
|
| 93 |
<td>
|
| 94 |
|
| 95 |
</td>
|
| 96 |
<td>
|
| 97 |
|
| 98 |
<p>
|
| 99 |
Initialize the board. |
| 100 |
<p>
|
| 101 |
Initializes the components specified by config.<p>
|
| 102 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__analog.html#g55f66ff6f3449ef81d97b7e47f041918">analog_init</a>, <a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d">usb_init</a>, <a class="el" href="group__xbee.html#g964a1e8461e9c1187e5d69f521e5e107">xbee_init</a>, <a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a>, bom_init, <a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a>, <a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21">motors_init</a>, <a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6">lcd_init</a> </dd></dl> |
| 103 |
</td>
|
| 104 |
</tr>
|
| 105 |
</table>
|
| 106 |
<a class="anchor" name="g3aea9deb2a0bfea9ff05a898f4822e31"></a><!-- doxytag: member="dragonfly_lib.c::reset" ref="g3aea9deb2a0bfea9ff05a898f4822e31" args="(void)" --><p> |
| 107 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 108 |
<tr>
|
| 109 |
<td class="mdRow"> |
| 110 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 111 |
<tr>
|
| 112 |
<td class="md" nowrap valign="top">void reset </td> |
| 113 |
<td class="md" valign="top">( </td> |
| 114 |
<td class="md" nowrap valign="top">void </td> |
| 115 |
<td class="mdname1" valign="top" nowrap> </td> |
| 116 |
<td class="md" valign="top"> ) </td> |
| 117 |
<td class="md" nowrap></td> |
| 118 |
</tr>
|
| 119 |
</table>
|
| 120 |
</td>
|
| 121 |
</tr>
|
| 122 |
</table>
|
| 123 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 124 |
<tr>
|
| 125 |
<td>
|
| 126 |
|
| 127 |
</td>
|
| 128 |
<td>
|
| 129 |
|
| 130 |
<p>
|
| 131 |
Reset the robot. |
| 132 |
<p>
|
| 133 |
Resets the AVR when called. Sets the watchdog timer and lets it overflow to reset the AVR. The reset clears all memory and resets all registers with the exception of the Watchdog Reset Flag (WDRF) in the MCU Control and Status Register (MCUCSR). </td>
|
| 134 |
</tr>
|
| 135 |
</table>
|
| 136 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 5 16:33:32 2007 for libdragonfly by |
| 137 |
<a href="http://www.doxygen.org/index.html"> |
| 138 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
| 139 |
</body>
|
| 140 |
</html>
|