root / trunk / docs / libdragonfly / lights_8h.html @ 1145
History | View | Annotate | Download (16.5 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: lights.h File Reference</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.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 class="current"><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
</div>
|
| 19 |
<div class="contents"> |
| 20 |
<h1>lights.h File Reference</h1>Contains declarations for managing the orbs. <a href="#_details">More...</a> |
| 21 |
<p>
|
| 22 |
|
| 23 |
<p>
|
| 24 |
<a href="lights_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 25 |
<tr><td></td></tr> |
| 26 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d23feea868a983c8c2b661e1e16972f"></a><!-- doxytag: member="lights.h::RED" ref="g8d23feea868a983c8c2b661e1e16972f" args="" --> |
| 28 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g8d23feea868a983c8c2b661e1e16972f">RED</a> 0xE0</td></tr> |
| 29 |
|
| 30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Red. <br></td></tr> |
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc5b6e19bf06822021f35602c59658de3"></a><!-- doxytag: member="lights.h::ORANGE" ref="gc5b6e19bf06822021f35602c59658de3" args="" --> |
| 32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc5b6e19bf06822021f35602c59658de3">ORANGE</a> 0xE4</td></tr> |
| 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Orange. <br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf681265909adf3d3e8116c93c0ba179"></a><!-- doxytag: member="lights.h::YELLOW" ref="gbf681265909adf3d3e8116c93c0ba179" args="" --> |
| 36 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbf681265909adf3d3e8116c93c0ba179">YELLOW</a> 0xE8</td></tr> |
| 37 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Yellow. <br></td></tr> |
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46019a1f2c10603a54b6cbb19cbf3c21"></a><!-- doxytag: member="lights.h::LIME" ref="g46019a1f2c10603a54b6cbb19cbf3c21" args="" --> |
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g46019a1f2c10603a54b6cbb19cbf3c21">LIME</a> 0x68</td></tr> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lime. <br></td></tr> |
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfbc006ea433ad708fdee3e82996e721"></a><!-- doxytag: member="lights.h::GREEN" ref="gcfbc006ea433ad708fdee3e82996e721" args="" --> |
| 44 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcfbc006ea433ad708fdee3e82996e721">GREEN</a> 0x1C</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Green. <br></td></tr> |
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd243f93c16bc4c1d3e0a13b84421d760"></a><!-- doxytag: member="lights.h::CYAN" ref="gd243f93c16bc4c1d3e0a13b84421d760" args="" --> |
| 48 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gd243f93c16bc4c1d3e0a13b84421d760">CYAN</a> 0x1F</td></tr> |
| 49 |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cyan. <br></td></tr> |
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g79d10e672abb49ad63eeaa8aaef57c38"></a><!-- doxytag: member="lights.h::BLUE" ref="g79d10e672abb49ad63eeaa8aaef57c38" args="" --> |
| 52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g79d10e672abb49ad63eeaa8aaef57c38">BLUE</a> 0x03</td></tr> |
| 53 |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Blue. <br></td></tr> |
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gda419fe3b48fcf19daed7cc57ccf1174"></a><!-- doxytag: member="lights.h::PINK" ref="gda419fe3b48fcf19daed7cc57ccf1174" args="" --> |
| 56 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gda419fe3b48fcf19daed7cc57ccf1174">PINK</a> 0xA6</td></tr> |
| 57 |
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pink. <br></td></tr> |
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bb0b009e7a7390473ace4d98bd843c0"></a><!-- doxytag: member="lights.h::PURPLE" ref="g0bb0b009e7a7390473ace4d98bd843c0" args="" --> |
| 60 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0bb0b009e7a7390473ace4d98bd843c0">PURPLE</a> 0x41</td></tr> |
| 61 |
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purple. <br></td></tr> |
| 63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f699060902f800f12aaae150f3a708e"></a><!-- doxytag: member="lights.h::MAGENTA" ref="g6f699060902f800f12aaae150f3a708e" args="" --> |
| 64 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g6f699060902f800f12aaae150f3a708e">MAGENTA</a> 0xE3</td></tr> |
| 65 |
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Magenta. <br></td></tr> |
| 67 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g87b537f5fa5c109d3c05c13d6b18f382"></a><!-- doxytag: member="lights.h::WHITE" ref="g87b537f5fa5c109d3c05c13d6b18f382" args="" --> |
| 68 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g87b537f5fa5c109d3c05c13d6b18f382">WHITE</a> 0xFE</td></tr> |
| 69 |
|
| 70 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">White. <br></td></tr> |
| 71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf2f6da92d895ef5e594223f1e39e4b1"></a><!-- doxytag: member="lights.h::ORB_OFF" ref="gcf2f6da92d895ef5e594223f1e39e4b1" args="" --> |
| 72 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a> 0x00</td></tr> |
| 73 |
|
| 74 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the orb off. <br></td></tr> |
| 75 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc443bd65dba694ea9731f3ea455831a8"></a><!-- doxytag: member="lights.h::orb_mode_pwm" ref="gc443bd65dba694ea9731f3ea455831a8" args="" --> |
| 76 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc443bd65dba694ea9731f3ea455831a8">orb_mode_pwm</a> 0</td></tr> |
| 77 |
|
| 78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">PWM mode. <br></td></tr> |
| 79 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf6cc675aa67ca9348717db3e53f18ae9"></a><!-- doxytag: member="lights.h::orb_mode_binary" ref="gf6cc675aa67ca9348717db3e53f18ae9" args="" --> |
| 80 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gf6cc675aa67ca9348717db3e53f18ae9">orb_mode_binary</a> 1</td></tr> |
| 81 |
|
| 82 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binary mode. <br></td></tr> |
| 83 |
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> |
| 84 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba7bc1797add20fe3efdf37ced1182c5"></a><!-- doxytag: member="lights.h::uint8_t" ref="ba7bc1797add20fe3efdf37ced1182c5" args="" --> |
| 85 |
typedef unsigned char </td><td class="memItemRight" valign="bottom"><b>uint8_t</b></td></tr> |
| 86 |
|
| 87 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ge1444a97f794787d7ffaa5ec12e2a1e2">orb_mode_t</a></td></tr> |
| 88 |
|
| 89 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 90 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> (void)</td></tr> |
| 91 |
|
| 92 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs in default mode. <a href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9"></a><br></td></tr> |
| 93 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g55a2b60caf9fe91346bed89c7bba73b7">orb_init_binary</a> (void)</td></tr> |
| 94 |
|
| 95 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs in binary mode. <a href="group__orbs.html#g55a2b60caf9fe91346bed89c7bba73b7"></a><br></td></tr> |
| 96 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbb9bc432db2639616a7e8b3211544891">orb_init_pwm</a> (void)</td></tr> |
| 97 |
|
| 98 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs in PWM mode. <a href="group__orbs.html#gbb9bc432db2639616a7e8b3211544891"></a><br></td></tr> |
| 99 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1d0fbfe351097e16652a658af5c8955"></a><!-- doxytag: member="lights.h::orb_set_mode" ref="ga1d0fbfe351097e16652a658af5c8955" args="(orb_mode_t mode)" --> |
| 100 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ga1d0fbfe351097e16652a658af5c8955">orb_set_mode</a> (<a class="el" href="group__orbs.html#ge1444a97f794787d7ffaa5ec12e2a1e2">orb_mode_t</a> mode)</td></tr> |
| 101 |
|
| 102 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Switches the orbs to the specified mode. <br></td></tr> |
| 103 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gf4effc092e3f85d937cea0ff72a003bf">orb_disable_timer</a> (void)</td></tr> |
| 104 |
|
| 105 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disables the orb timer, but does not change the mode. <a href="group__orbs.html#gf4effc092e3f85d937cea0ff72a003bf"></a><br></td></tr> |
| 106 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ge626892624d9bd87fa7dcd0ebd6d19f3">orb_enable_timer</a> (void)</td></tr> |
| 107 |
|
| 108 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orb timer, but does not change the mode. <a href="group__orbs.html#ge626892624d9bd87fa7dcd0ebd6d19f3"></a><br></td></tr> |
| 109 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ge066e81a39023cf8a36efd432bb9a4ff">orb_n_set</a> (uint8_t num, uint8_t red, uint8_t green, uint8_t blue)</td></tr> |
| 110 |
|
| 111 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the specified orb to a specified color <a href="group__orbs.html#ge066e81a39023cf8a36efd432bb9a4ff"></a><br></td></tr> |
| 112 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g10dd6277826cd4c9305e48029c9011a4">orb_set</a> (uint8_t red, uint8_t green, uint8_t blue)</td></tr> |
| 113 |
|
| 114 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="group__orbs.html#g10dd6277826cd4c9305e48029c9011a4"></a><br></td></tr> |
| 115 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g06c1b846b943bd327a2bc9f37b926497">orb1_set</a> (uint8_t red_led, uint8_t green_led, uint8_t blue_led)</td></tr> |
| 116 |
|
| 117 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g06c1b846b943bd327a2bc9f37b926497"></a><br></td></tr> |
| 118 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g618af3d39cb8cd954248da295f7f234c">orb2_set</a> (uint8_t red_led, uint8_t green_led, uint8_t blue_led)</td></tr> |
| 119 |
|
| 120 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#g618af3d39cb8cd954248da295f7f234c"></a><br></td></tr> |
| 121 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g5ebe8d5597e2519d82486ce0a88906cc">orbs_set</a> (uint8_t red1, uint8_t green1, uint8_t blue1, uint8_t red2, uint8_t green2, uint8_t blue2)</td></tr> |
| 122 |
|
| 123 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g9bbced65e813e0937b7251a86853117f">orb_n_set_color</a> (uint8_t num, uint8_t col)</td></tr> |
| 124 |
|
| 125 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the specified orb to the specified color <a href="group__orbs.html#g9bbced65e813e0937b7251a86853117f"></a><br></td></tr> |
| 126 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0dede06855e46c8b8abdbce5779917ba">orb1_set_color</a> (uint8_t col)</td></tr> |
| 127 |
|
| 128 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g0dede06855e46c8b8abdbce5779917ba"></a><br></td></tr> |
| 129 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1eb5f3accec23e5a2ea137e95f5070d6">orb2_set_color</a> (uint8_t col)</td></tr> |
| 130 |
|
| 131 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#g1eb5f3accec23e5a2ea137e95f5070d6"></a><br></td></tr> |
| 132 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g39224c46d5ed891d16e08239c959a8a8">orbs_set_color</a> (uint8_t col1, uint8_t col2)</td></tr> |
| 133 |
|
| 134 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the orbs to specified colors <a href="group__orbs.html#g39224c46d5ed891d16e08239c959a8a8"></a><br></td></tr> |
| 135 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1710247e5331a3cb6076354a70e095e1">orb_set_color</a> (uint8_t col)</td></tr> |
| 136 |
|
| 137 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="group__orbs.html#g1710247e5331a3cb6076354a70e095e1"></a><br></td></tr> |
| 138 |
</table>
|
| 139 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 140 |
Contains declarations for managing the orbs. |
| 141 |
<p>
|
| 142 |
Copyright (c) 2007 Colony Project<p>
|
| 143 |
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>
|
| 144 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
|
| 145 |
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>
|
| 146 |
Contains declarations for using the orbs and PWM.<p>
|
| 147 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club Based on Firefly Library, by Tom Lauwers and Steven Shamlian </dd></dl> |
| 148 |
</div>
|
| 149 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by |
| 150 |
<a href="http://www.doxygen.org/index.html"> |
| 151 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
| 152 |
</body>
|
| 153 |
</html>
|