root / branches / encoders / docs / libdragonfly / lights_8h.html @ 856
History | View | Annotate | Download (10.8 KB)
1 | 41 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | 855 | justin | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 | 41 | bcoltin | <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 | 855 | justin | <!-- Generated by Doxygen 1.5.4 -->
|
8 | 41 | bcoltin | <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 | 855 | justin | <li class="current"><a href="files.html"><span>Files</span></a></li> |
13 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
||
14 | </ul>
|
||
15 | </div>
|
||
16 | 41 | bcoltin | <h1>lights.h File Reference</h1>Contains declarations for managing the orbs. <a href="#_details">More...</a> |
17 | <p>
|
||
18 | |||
19 | <p>
|
||
20 | <a href="lights_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
21 | <tr><td></td></tr> |
||
22 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
23 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d23feea868a983c8c2b661e1e16972f"></a><!-- doxytag: member="lights.h::RED" ref="g8d23feea868a983c8c2b661e1e16972f" args="" --> |
||
24 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g8d23feea868a983c8c2b661e1e16972f">RED</a> 0xE0</td></tr> |
||
25 | |||
26 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Red. <br></td></tr> |
||
27 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc5b6e19bf06822021f35602c59658de3"></a><!-- doxytag: member="lights.h::ORANGE" ref="gc5b6e19bf06822021f35602c59658de3" args="" --> |
||
28 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc5b6e19bf06822021f35602c59658de3">ORANGE</a> 0xE4</td></tr> |
||
29 | |||
30 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Orange. <br></td></tr> |
||
31 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf681265909adf3d3e8116c93c0ba179"></a><!-- doxytag: member="lights.h::YELLOW" ref="gbf681265909adf3d3e8116c93c0ba179" args="" --> |
||
32 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbf681265909adf3d3e8116c93c0ba179">YELLOW</a> 0xE8</td></tr> |
||
33 | |||
34 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Yellow. <br></td></tr> |
||
35 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46019a1f2c10603a54b6cbb19cbf3c21"></a><!-- doxytag: member="lights.h::LIME" ref="g46019a1f2c10603a54b6cbb19cbf3c21" args="" --> |
||
36 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g46019a1f2c10603a54b6cbb19cbf3c21">LIME</a> 0x68</td></tr> |
||
37 | |||
38 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Lime. <br></td></tr> |
||
39 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfbc006ea433ad708fdee3e82996e721"></a><!-- doxytag: member="lights.h::GREEN" ref="gcfbc006ea433ad708fdee3e82996e721" args="" --> |
||
40 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcfbc006ea433ad708fdee3e82996e721">GREEN</a> 0x1C</td></tr> |
||
41 | |||
42 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Green. <br></td></tr> |
||
43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd243f93c16bc4c1d3e0a13b84421d760"></a><!-- doxytag: member="lights.h::CYAN" ref="gd243f93c16bc4c1d3e0a13b84421d760" args="" --> |
||
44 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gd243f93c16bc4c1d3e0a13b84421d760">CYAN</a> 0x1F</td></tr> |
||
45 | |||
46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Cyan. <br></td></tr> |
||
47 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g79d10e672abb49ad63eeaa8aaef57c38"></a><!-- doxytag: member="lights.h::BLUE" ref="g79d10e672abb49ad63eeaa8aaef57c38" args="" --> |
||
48 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g79d10e672abb49ad63eeaa8aaef57c38">BLUE</a> 0x03</td></tr> |
||
49 | |||
50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Blue. <br></td></tr> |
||
51 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gda419fe3b48fcf19daed7cc57ccf1174"></a><!-- doxytag: member="lights.h::PINK" ref="gda419fe3b48fcf19daed7cc57ccf1174" args="" --> |
||
52 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gda419fe3b48fcf19daed7cc57ccf1174">PINK</a> 0xA6</td></tr> |
||
53 | |||
54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Pink. <br></td></tr> |
||
55 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bb0b009e7a7390473ace4d98bd843c0"></a><!-- doxytag: member="lights.h::PURPLE" ref="g0bb0b009e7a7390473ace4d98bd843c0" args="" --> |
||
56 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0bb0b009e7a7390473ace4d98bd843c0">PURPLE</a> 0x41</td></tr> |
||
57 | |||
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Purple. <br></td></tr> |
||
59 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f699060902f800f12aaae150f3a708e"></a><!-- doxytag: member="lights.h::MAGENTA" ref="g6f699060902f800f12aaae150f3a708e" args="" --> |
||
60 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g6f699060902f800f12aaae150f3a708e">MAGENTA</a> 0xE3</td></tr> |
||
61 | |||
62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Magenta. <br></td></tr> |
||
63 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g87b537f5fa5c109d3c05c13d6b18f382"></a><!-- doxytag: member="lights.h::WHITE" ref="g87b537f5fa5c109d3c05c13d6b18f382" args="" --> |
||
64 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g87b537f5fa5c109d3c05c13d6b18f382">WHITE</a> 0xFE</td></tr> |
||
65 | |||
66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">White. <br></td></tr> |
||
67 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf2f6da92d895ef5e594223f1e39e4b1"></a><!-- doxytag: member="lights.h::ORB_OFF" ref="gcf2f6da92d895ef5e594223f1e39e4b1" args="" --> |
||
68 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a> 0xFE</td></tr> |
||
69 | |||
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the orb off (White). <br></td></tr> |
||
71 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
72 | <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> |
||
73 | |||
74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs. <a href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9"></a><br></td></tr> |
||
75 | <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> |
||
76 | |||
77 | <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> |
||
78 | <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> |
||
79 | |||
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g2df1397345a557295b12e50451f8592e"></a><br></td></tr> |
||
81 | <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> |
||
82 | |||
83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#gb19679987f51d6ed35461d581ca8972b"></a><br></td></tr> |
||
84 | <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> |
||
85 | |||
86 | <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> |
||
87 | <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> |
||
88 | |||
89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="group__orbs.html#g131d9bf3e32cf5530f4cc671ea496609"></a><br></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#g3125d9c661a33b3fdeb4eca75ca00cab">orb2_set_color</a> (int col)</td></tr> |
||
91 | |||
92 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="group__orbs.html#g3125d9c661a33b3fdeb4eca75ca00cab"></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#g1ea1b363a0592f80798f6a1e260a70e9">orb_disable</a> (void)</td></tr> |
||
94 | |||
95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the orbs. <a href="group__orbs.html#g1ea1b363a0592f80798f6a1e260a70e9"></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#g5911e3fa322de2e760a92a44d5a6a547">orb_enable</a> (void)</td></tr> |
||
97 | |||
98 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the orbs. <a href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547"></a><br></td></tr> |
||
99 | </table>
|
||
100 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
101 | Contains declarations for managing the orbs. |
||
102 | <p>
|
||
103 | Contains declarations for using the orbs and PWM.<p>
|
||
104 | 855 | justin | <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> |
105 | 856 | justin | <hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 22 22:30:16 2008 for libdragonfly by |
106 | 41 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
107 | 855 | justin | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> |
108 | 41 | bcoltin | </body>
|
109 | </html> |