Project

General

Profile

Revision 1145

Generated documentation for new orbs code

View differences:

dragonfly__lib_8h.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&nbsp;Page</span></a></li>
11
    <li><a href="modules.html"><span>Modules</span></a></li>
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
    <li class="current"><a href="files.html"><span>Files</span></a></li>
14
    <li><a href="pages.html"><span>Related&nbsp;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&nbsp;Page</span></a></li>
12
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13
      <li><a href="modules.html"><span>Modules</span></a></li>
14
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16
    </ul>
17
  </div>
16 18
</div>
19
<div class="contents">
17 20
<h1>dragonfly_lib.h File Reference</h1>Contains other include files. <a href="#_details">More...</a>
18 21
<p>
19 22
<code>#include &lt;inttypes.h&gt;</code><br>
......
23 26
<code>#include &lt;avr/interrupt.h&gt;</code><br>
24 27
<code>#include &lt;util/delay.h&gt;</code><br>
25 28
<code>#include &lt;util/twi.h&gt;</code><br>
29
<code>#include &quot;<a class="el" href="atomic_8h-source.html">atomic.h</a>&quot;</code><br>
26 30
<code>#include &lt;<a class="el" href="analog_8h-source.html">analog.h</a>&gt;</code><br>
27 31
<code>#include &lt;<a class="el" href="dio_8h-source.html">dio.h</a>&gt;</code><br>
28 32
<code>#include &lt;<a class="el" href="time_8h-source.html">time.h</a>&gt;</code><br>
......
35 39
<code>#include &lt;<a class="el" href="bom_8h-source.html">bom.h</a>&gt;</code><br>
36 40
<code>#include &lt;<a class="el" href="move_8h-source.html">move.h</a>&gt;</code><br>
37 41
<code>#include &lt;<a class="el" href="reset_8h-source.html">reset.h</a>&gt;</code><br>
38
<code>#include &lt;<a class="el" href="math_8h-source.html">math.h</a>&gt;</code><br>
42
<code>#include &lt;math.h&gt;</code><br>
43
<code>#include &lt;<a class="el" href="eeprom_8h-source.html">eeprom.h</a>&gt;</code><br>
44
<code>#include &lt;stdbool.h&gt;</code><br>
39 45

  
40 46
<p>
41 47
<a href="dragonfly__lib_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
......
65 71
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">MOTORS</a>&nbsp;&nbsp;&nbsp;0x08</td></tr>
66 72

  
67 73
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the motors. <br></td></tr>
74
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g457a9aa93dbb216459873a30bdb4d84a"></a><!-- doxytag: member="dragonfly_lib.h::I2C" ref="g457a9aa93dbb216459873a30bdb4d84a" args="" -->
75
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g457a9aa93dbb216459873a30bdb4d84a">I2C</a>&nbsp;&nbsp;&nbsp;0x20</td></tr>
76

  
77
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize I2C. <br></td></tr>
68 78
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g145103118f6d9d1129aa4509cf214a13"></a><!-- doxytag: member="dragonfly_lib.h::BUZZER" ref="g145103118f6d9d1129aa4509cf214a13" args="" -->
69
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a>&nbsp;&nbsp;&nbsp;0x10</td></tr>
79
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a>&nbsp;&nbsp;&nbsp;0x40</td></tr>
70 80

  
71 81
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the buzzer. <br></td></tr>
72 82
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf2d80992dcfabfd1668184c3dff2733"></a><!-- doxytag: member="dragonfly_lib.h::LCD" ref="gbf2d80992dcfabfd1668184c3dff2733" args="" -->
73
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a>&nbsp;&nbsp;&nbsp;0x20</td></tr>
83
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a>&nbsp;&nbsp;&nbsp;0x80</td></tr>
74 84

  
75 85
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the LCD screen. <br></td></tr>
86
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc04dd0afaf7ea3eb2ade2544d2d5f907"></a><!-- doxytag: member="dragonfly_lib.h::RANGE" ref="gc04dd0afaf7ea3eb2ade2544d2d5f907" args="" -->
87
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gc04dd0afaf7ea3eb2ade2544d2d5f907">RANGE</a>&nbsp;&nbsp;&nbsp;0x0100</td></tr>
88

  
89
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the rangefinders. <br></td></tr>
90
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd555cfe7a1fcf16c3639f797120478eb"></a><!-- doxytag: member="dragonfly_lib.h::BOM" ref="gd555cfe7a1fcf16c3639f797120478eb" args="" -->
91
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd555cfe7a1fcf16c3639f797120478eb">BOM</a>&nbsp;&nbsp;&nbsp;0x0200</td></tr>
92

  
93
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the BOM. <br></td></tr>
76 94
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1252cf7a07df96ed2561ae605eaca197"></a><!-- doxytag: member="dragonfly_lib.h::ALL_ON" ref="g1252cf7a07df96ed2561ae605eaca197" args="" -->
77
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a>&nbsp;&nbsp;&nbsp;0xFF</td></tr>
95
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g1252cf7a07df96ed2561ae605eaca197">ALL_ON</a>&nbsp;&nbsp;&nbsp;0x03FF</td></tr>
78 96

  
79 97
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize everything. <br></td></tr>
98
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac82e856c7683e23553431e5224d5f4"></a><!-- doxytag: member="dragonfly_lib.h::SYNC" ref="9ac82e856c7683e23553431e5224d5f4" args="" -->
99
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="dragonfly__lib_8h.html#9ac82e856c7683e23553431e5224d5f4">SYNC</a>&nbsp;&nbsp;&nbsp;ATOMIC_BLOCK(ATOMIC_RESTORESTATE)</td></tr>
100

  
101
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">shortcut for <a class="el" href="group__util__atomic.html#gaaea265b31dabcfb3098bec7685c39e4">ATOMIC_BLOCK(ATOMIC_RESTORESTATE)</a> <br></td></tr>
102
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63040a270fd14fe3286e2b67e5927eb9"></a><!-- doxytag: member="dragonfly_lib.h::REQUIRE_LOCK_OR_RETURN" ref="63040a270fd14fe3286e2b67e5927eb9" args="(LOCK)" -->
103
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="dragonfly__lib_8h.html#63040a270fd14fe3286e2b67e5927eb9">REQUIRE_LOCK_OR_RETURN</a>(LOCK)&nbsp;&nbsp;&nbsp;do { SYNC { if (LOCK) return; LOCK=1; } } while (0)</td></tr>
104

  
105
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">atomically grab a lock if it is free, return otherwise <br></td></tr>
106
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c25d1a234d2aa700c3d5cce7ecff803a"></a><!-- doxytag: member="dragonfly_lib.h::RELEASE_LOCK" ref="c25d1a234d2aa700c3d5cce7ecff803a" args="(LOCK)" -->
107
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="dragonfly__lib_8h.html#c25d1a234d2aa700c3d5cce7ecff803a">RELEASE_LOCK</a>(LOCK)&nbsp;&nbsp;&nbsp;do { LOCK=0; } while (0)</td></tr>
108

  
109
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">atomically release a lock <br></td></tr>
80 110
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
81
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g8124e2c32bf25208586d500e45ba5fe3">dragonfly_init</a> (int config)</td></tr>
111
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8124e2c32bf25208586d500e45ba5fe3"></a><!-- doxytag: member="dragonfly_lib.h::dragonfly_init" ref="g8124e2c32bf25208586d500e45ba5fe3" args="(int config)" -->
112
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g8124e2c32bf25208586d500e45ba5fe3">dragonfly_init</a> (int config)</td></tr>
82 113

  
83
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the board.  <a href="group__dragonfly.html#g8124e2c32bf25208586d500e45ba5fe3"></a><br></td></tr>
114
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the board. <br></td></tr>
84 115
</table>
85 116
<hr><a name="_details"></a><h2>Detailed Description</h2>
86 117
Contains other include files. 
......
91 122
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>
92 123
Include this file for all the functionality of libdragonfly.<p>
93 124
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>
94
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:42 2008 for libdragonfly by&nbsp;
125
</div>
126
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by&nbsp;
95 127
<a href="http://www.doxygen.org/index.html">
96
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
128
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
97 129
</body>
98 130
</html>

Also available in: Unified diff