Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / dragonfly__lib_8h.html @ 1398

History | View | Annotate | Download (12.6 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>libdragonfly: dragonfly_lib.h File Reference</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.9 -->
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>
18 
  <div class="tabs">
19 
    <ul>
20 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21 
      <li><a href="globals.html"><span>Globals</span></a></li>
22 
    </ul>
23 
  </div>
24 
</div>
25 
<div class="contents">
26 
<h1>dragonfly_lib.h File Reference</h1>Contains other include files.
27 
<a href="#_details">More...</a>
28 
<p>
29 
<code>#include &lt;inttypes.h&gt;</code><br>
30 
<code>#include &lt;stdio.h&gt;</code><br>
31 
<code>#include &lt;stdlib.h&gt;</code><br>
32 
<code>#include &lt;avr/io.h&gt;</code><br>
33 
<code>#include &lt;avr/interrupt.h&gt;</code><br>
34 
<code>#include &lt;util/delay.h&gt;</code><br>
35 
<code>#include &lt;util/twi.h&gt;</code><br>
36 
<code>#include &quot;<a class="el" href="atomic_8h_source.html">atomic.h</a>&quot;</code><br>
37 
<code>#include &lt;<a class="el" href="analog_8h_source.html">analog.h</a>&gt;</code><br>
38 
<code>#include &lt;<a class="el" href="dio_8h_source.html">dio.h</a>&gt;</code><br>
39 
<code>#include &lt;<a class="el" href="time_8h_source.html">time.h</a>&gt;</code><br>
40 
<code>#include &lt;<a class="el" href="lcd_8h_source.html">lcd.h</a>&gt;</code><br>
41 
<code>#include &lt;<a class="el" href="lights_8h_source.html">lights.h</a>&gt;</code><br>
42 
<code>#include &lt;<a class="el" href="motor_8h_source.html">motor.h</a>&gt;</code><br>
43 
<code>#include &lt;<a class="el" href="serial_8h_source.html">serial.h</a>&gt;</code><br>
44 
<code>#include &lt;<a class="el" href="buzzer_8h_source.html">buzzer.h</a>&gt;</code><br>
45 
<code>#include &lt;<a class="el" href="rangefinder_8h_source.html">rangefinder.h</a>&gt;</code><br>
46 
<code>#include &lt;<a class="el" href="bom_8h_source.html">bom.h</a>&gt;</code><br>
47 
<code>#include &lt;<a class="el" href="move_8h_source.html">move.h</a>&gt;</code><br>
48 
<code>#include &lt;<a class="el" href="reset_8h_source.html">reset.h</a>&gt;</code><br>
49 
<code>#include &lt;math.h&gt;</code><br>
50 
<code>#include &lt;<a class="el" href="eeprom_8h_source.html">eeprom.h</a>&gt;</code><br>
51 
<code>#include &lt;stdbool.h&gt;</code><br>
52 

    		
  

  

    
      53
    
    
      
<p>


    		
  

  

    
      54
    
    
      
<a href="dragonfly__lib_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">


    		
  

  

    
      55
    
    
      
<tr><td></td></tr>


    		
  

  

    
      56
    
    
      
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


    		
  

  

    
      57
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd42aa2404559d4a465d5d45e857f2881"></a><!-- doxytag: member="dragonfly_lib.h::ANALOG" ref="gd42aa2404559d4a465d5d45e857f2881" args="" -->


    		
  

  

    
      58
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd42aa2404559d4a465d5d45e857f2881">ANALOG</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>


    		
  

  

    
      59
    
    
      

    		
  

  

    
      60
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize analog. <br></td></tr>


    		
  

  

    
      61
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gae3f0b4211ba45d265973d40ccbb5fd1"></a><!-- doxytag: member="dragonfly_lib.h::SERIAL" ref="gae3f0b4211ba45d265973d40ccbb5fd1" args="" -->


    		
  

  

    
      62
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gae3f0b4211ba45d265973d40ccbb5fd1">SERIAL</a>&nbsp;&nbsp;&nbsp;0x02</td></tr>


    		
  

  

    
      63
    
    
      

    		
  

  

    
      64
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize serial communications. <br></td></tr>


    		
  

  

    
      65
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g779bf099075a999d1074357fccbd466b"></a><!-- doxytag: member="dragonfly_lib.h::USB" ref="g779bf099075a999d1074357fccbd466b" args="" -->


    		
  

  

    
      66
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g779bf099075a999d1074357fccbd466b">USB</a>&nbsp;&nbsp;&nbsp;0x02</td></tr>


    		
  

  

    
      67
    
    
      

    		
  

  

    
      68
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize USB communications. <br></td></tr>


    		
  

  

    
      69
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46fff4184b5d787de1ed367b97cb6091"></a><!-- doxytag: member="dragonfly_lib.h::COMM" ref="g46fff4184b5d787de1ed367b97cb6091" args="" -->


    		
  

  

    
      70
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g46fff4184b5d787de1ed367b97cb6091">COMM</a>&nbsp;&nbsp;&nbsp;0x02</td></tr>


    		
  

  

    
      71
    
    
      

    		
  

  

    
      72
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize communications. <br></td></tr>


    		
  

  

    
      73
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g24a9b050b733edb162cbeb44b1a417b1"></a><!-- doxytag: member="dragonfly_lib.h::ORB" ref="g24a9b050b733edb162cbeb44b1a417b1" args="" -->


    		
  

  

    
      74
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g24a9b050b733edb162cbeb44b1a417b1">ORB</a>&nbsp;&nbsp;&nbsp;0x04</td></tr>


    		
  

  

    
      75
    
    
      

    		
  

  

    
      76
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the orb. <br></td></tr>


    		
  

  

    
      77
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9bb31bba359fbb679910df0a6efde5a3"></a><!-- doxytag: member="dragonfly_lib.h::MOTORS" ref="g9bb31bba359fbb679910df0a6efde5a3" args="" -->


    		
  

  

    
      78
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g9bb31bba359fbb679910df0a6efde5a3">MOTORS</a>&nbsp;&nbsp;&nbsp;0x08</td></tr>


    		
  

  

    
      79
    
    
      

    		
  

  

    
      80
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the motors. <br></td></tr>


    		
  

  

    
      81
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g457a9aa93dbb216459873a30bdb4d84a"></a><!-- doxytag: member="dragonfly_lib.h::I2C" ref="g457a9aa93dbb216459873a30bdb4d84a" args="" -->


    		
  

  

    
      82
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g457a9aa93dbb216459873a30bdb4d84a">I2C</a>&nbsp;&nbsp;&nbsp;0x20</td></tr>


    		
  

  

    
      83
    
    
      

    		
  

  

    
      84
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize I2C. <br></td></tr>


    		
  

  

    
      85
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g145103118f6d9d1129aa4509cf214a13"></a><!-- doxytag: member="dragonfly_lib.h::BUZZER" ref="g145103118f6d9d1129aa4509cf214a13" args="" -->


    		
  

  

    
      86
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g145103118f6d9d1129aa4509cf214a13">BUZZER</a>&nbsp;&nbsp;&nbsp;0x40</td></tr>


    		
  

  

    
      87
    
    
      

    		
  

  

    
      88
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the buzzer. <br></td></tr>


    		
  

  

    
      89
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf2d80992dcfabfd1668184c3dff2733"></a><!-- doxytag: member="dragonfly_lib.h::LCD" ref="gbf2d80992dcfabfd1668184c3dff2733" args="" -->


    		
  

  

    
      90
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gbf2d80992dcfabfd1668184c3dff2733">LCD</a>&nbsp;&nbsp;&nbsp;0x80</td></tr>


    		
  

  

    
      91
    
    
      

    		
  

  

    
      92
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the LCD screen. <br></td></tr>


    		
  

  

    
      93
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc04dd0afaf7ea3eb2ade2544d2d5f907"></a><!-- doxytag: member="dragonfly_lib.h::RANGE" ref="gc04dd0afaf7ea3eb2ade2544d2d5f907" args="" -->


    		
  

  

    
      94
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gc04dd0afaf7ea3eb2ade2544d2d5f907">RANGE</a>&nbsp;&nbsp;&nbsp;0x0100</td></tr>


    		
  

  

    
      95
    
    
      

    		
  

  

    
      96
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the rangefinders. <br></td></tr>


    		
  

  

    
      97
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd555cfe7a1fcf16c3639f797120478eb"></a><!-- doxytag: member="dragonfly_lib.h::BOM" ref="gd555cfe7a1fcf16c3639f797120478eb" args="" -->


    		
  

  

    
      98
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#gd555cfe7a1fcf16c3639f797120478eb">BOM</a>&nbsp;&nbsp;&nbsp;0x0200</td></tr>


    		
  

  

    
      99
    
    
      

    		
  

  

    
      100
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the BOM. <br></td></tr>


    		
  

  

    
      101
    
    
      
<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="" -->


    		
  

  

    
      102
    
    
      
#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>


    		
  

  

    
      103
    
    
      

    		
  

  

    
      104
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize everything. <br></td></tr>


    		
  

  

    
      105
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac82e856c7683e23553431e5224d5f4"></a><!-- doxytag: member="dragonfly_lib.h::SYNC" ref="9ac82e856c7683e23553431e5224d5f4" args="" -->


    		
  

  

    
      106
    
    
      
#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>


    		
  

  

    
      107
    
    
      

    		
  

  

    
      108
    
    
      
<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>


    		
  

  

    
      109
    
    
      
<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)" -->


    		
  

  

    
      110
    
    
      
#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>


    		
  

  

    
      111
    
    
      

    		
  

  

    
      112
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">atomically grab a lock if it is free, return otherwise <br></td></tr>


    		
  

  

    
      113
    
    
      
<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)" -->


    		
  

  

    
      114
    
    
      
#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>


    		
  

  

    
      115
    
    
      

    		
  

  

    
      116
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">atomically release a lock <br></td></tr>


    		
  

  

    
      117
    
    
      
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


    		
  

  

    
      118
    
    
      
<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)" -->


    		
  

  

    
      119
    
    
      
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dragonfly.html#g8124e2c32bf25208586d500e45ba5fe3">dragonfly_init</a> (int config)</td></tr>


    		
  

  

    
      120
    
    
      

    		
  

  

    
      121
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the board. <br></td></tr>


    		
  

  

    
      122
    
    
      
</table>


    		
  

  

    
      123
    
    
      
<hr><h2>Detailed Description</h2>


    		
  

  

    
      124
    
    
      
Contains other include files. 


    		
  

  

    
      125
    
    
      
<p>


    		
  

  

    
      126
    
    
      
Copyright (c) 2007 Colony Project<p>


    		
  

  

    
      127
    
    
      
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>


    		
  

  

    
      128
    
    
      
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


    		
  

  

    
      129
    
    
      
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>


    		
  

  

    
      130
    
    
      
Include this file for all the functionality of libdragonfly.<p>


    		
  

  

    
      131
    
    
      
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


    		
  

  

    
      132
    
    
      
</div>


    		
  

  

    
      133
    
    
      
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;


    		
  

  

    
      134
    
    
      
<a href="http://www.doxygen.org/index.html">


    		
  

  

    
      135
    
    
      
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


    		
  

  

    
      136
    
    
      
</body>


    		
  

  

    
      137
    
    
      
</html>