root / trunk / docs / libdragonfly / lights_8h.html @ 497
History | View | Annotate | Download (11.9 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.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 class="current"><a href="files.html"><span>Files</span></a></li> |
| 14 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
<h1>lights.h File Reference</h1>Contains declarations for managing the orbs. <a href="#_details">More...</a> |
| 18 |
<p>
|
| 19 |
|
| 20 |
<p>
|
| 21 |
<a href="lights_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 22 |
<tr><td></td></tr> |
| 23 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d23feea868a983c8c2b661e1e16972f"></a><!-- doxytag: member="lights.h::RED" ref="g8d23feea868a983c8c2b661e1e16972f" args="" --> |
| 25 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g8d23feea868a983c8c2b661e1e16972f">RED</a> 0xE0</td></tr> |
| 26 |
|
| 27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Red. <br></td></tr> |
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc5b6e19bf06822021f35602c59658de3"></a><!-- doxytag: member="lights.h::ORANGE" ref="gc5b6e19bf06822021f35602c59658de3" args="" --> |
| 29 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc5b6e19bf06822021f35602c59658de3">ORANGE</a> 0xE4</td></tr> |
| 30 |
|
| 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Orange. <br></td></tr> |
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf681265909adf3d3e8116c93c0ba179"></a><!-- doxytag: member="lights.h::YELLOW" ref="gbf681265909adf3d3e8116c93c0ba179" args="" --> |
| 33 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbf681265909adf3d3e8116c93c0ba179">YELLOW</a> 0xE8</td></tr> |
| 34 |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Yellow. <br></td></tr> |
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46019a1f2c10603a54b6cbb19cbf3c21"></a><!-- doxytag: member="lights.h::LIME" ref="g46019a1f2c10603a54b6cbb19cbf3c21" args="" --> |
| 37 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g46019a1f2c10603a54b6cbb19cbf3c21">LIME</a> 0x68</td></tr> |
| 38 |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lime. <br></td></tr> |
| 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfbc006ea433ad708fdee3e82996e721"></a><!-- doxytag: member="lights.h::GREEN" ref="gcfbc006ea433ad708fdee3e82996e721" args="" --> |
| 41 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcfbc006ea433ad708fdee3e82996e721">GREEN</a> 0x1C</td></tr> |
| 42 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Green. <br></td></tr> |
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd243f93c16bc4c1d3e0a13b84421d760"></a><!-- doxytag: member="lights.h::CYAN" ref="gd243f93c16bc4c1d3e0a13b84421d760" args="" --> |
| 45 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gd243f93c16bc4c1d3e0a13b84421d760">CYAN</a> 0x1F</td></tr> |
| 46 |
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cyan. <br></td></tr> |
| 48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g79d10e672abb49ad63eeaa8aaef57c38"></a><!-- doxytag: member="lights.h::BLUE" ref="g79d10e672abb49ad63eeaa8aaef57c38" args="" --> |
| 49 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g79d10e672abb49ad63eeaa8aaef57c38">BLUE</a> 0x03</td></tr> |
| 50 |
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Blue. <br></td></tr> |
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gda419fe3b48fcf19daed7cc57ccf1174"></a><!-- doxytag: member="lights.h::PINK" ref="gda419fe3b48fcf19daed7cc57ccf1174" args="" --> |
| 53 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gda419fe3b48fcf19daed7cc57ccf1174">PINK</a> 0xA6</td></tr> |
| 54 |
|
| 55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pink. <br></td></tr> |
| 56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bb0b009e7a7390473ace4d98bd843c0"></a><!-- doxytag: member="lights.h::PURPLE" ref="g0bb0b009e7a7390473ace4d98bd843c0" args="" --> |
| 57 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0bb0b009e7a7390473ace4d98bd843c0">PURPLE</a> 0x41</td></tr> |
| 58 |
|
| 59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purple. <br></td></tr> |
| 60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f699060902f800f12aaae150f3a708e"></a><!-- doxytag: member="lights.h::MAGENTA" ref="g6f699060902f800f12aaae150f3a708e" args="" --> |
| 61 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g6f699060902f800f12aaae150f3a708e">MAGENTA</a> 0xE3</td></tr> |
| 62 |
|
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Magenta. <br></td></tr> |
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g87b537f5fa5c109d3c05c13d6b18f382"></a><!-- doxytag: member="lights.h::WHITE" ref="g87b537f5fa5c109d3c05c13d6b18f382" args="" --> |
| 65 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g87b537f5fa5c109d3c05c13d6b18f382">WHITE</a> 0xFE</td></tr> |
| 66 |
|
| 67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">White. <br></td></tr> |
| 68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf2f6da92d895ef5e594223f1e39e4b1"></a><!-- doxytag: member="lights.h::ORB_OFF" ref="gcf2f6da92d895ef5e594223f1e39e4b1" args="" --> |
| 69 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a> 0xFE</td></tr> |
| 70 |
|
| 71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the orb off (White). <br></td></tr> |
| 72 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 73 |
<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> |
| 74 |
|
| 75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs. <a href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9"></a><br></td></tr> |
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ga75385bd1398949615ee1fe78a535cff">orb_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
| 77 |
|
| 78 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="group__orbs.html#ga75385bd1398949615ee1fe78a535cff"></a><br></td></tr> |
| 79 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g2df1397345a557295b12e50451f8592e">orb1_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
| 80 |
|
| 81 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g2df1397345a557295b12e50451f8592e"></a><br></td></tr> |
| 82 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gb19679987f51d6ed35461d581ca8972b">orb2_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
| 83 |
|
| 84 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#gb19679987f51d6ed35461d581ca8972b"></a><br></td></tr> |
| 85 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g123d2880d20bf6d0bb387024c8f6da81">orb_set_color</a> (int col)</td></tr> |
| 86 |
|
| 87 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="group__orbs.html#g123d2880d20bf6d0bb387024c8f6da81"></a><br></td></tr> |
| 88 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g131d9bf3e32cf5530f4cc671ea496609">orb1_set_color</a> (int col)</td></tr> |
| 89 |
|
| 90 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g131d9bf3e32cf5530f4cc671ea496609"></a><br></td></tr> |
| 91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g3125d9c661a33b3fdeb4eca75ca00cab">orb2_set_color</a> (int col)</td></tr> |
| 92 |
|
| 93 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#g3125d9c661a33b3fdeb4eca75ca00cab"></a><br></td></tr> |
| 94 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1ea1b363a0592f80798f6a1e260a70e9">orb_disable</a> (void)</td></tr> |
| 95 |
|
| 96 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the orbs. <a href="group__orbs.html#g1ea1b363a0592f80798f6a1e260a70e9"></a><br></td></tr> |
| 97 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547">orb_enable</a> (void)</td></tr> |
| 98 |
|
| 99 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the orbs. <a href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547"></a><br></td></tr> |
| 100 |
</table>
|
| 101 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 102 |
Contains declarations for managing the orbs. |
| 103 |
<p>
|
| 104 |
Copyright (c) 2007 Colony Project<p>
|
| 105 |
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>
|
| 106 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
|
| 107 |
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>
|
| 108 |
Contains declarations for using the orbs and PWM.<p>
|
| 109 |
<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> |
| 110 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by |
| 111 |
<a href="http://www.doxygen.org/index.html"> |
| 112 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
| 113 |
</body>
|
| 114 |
</html>
|