root / branches / lib_additions / docs / libdragonfly / group__orbs.html @ 79
History | View | Annotate | Download (24 KB)
1 | 41 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>libdragonfly: Orbs</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.4.6 -->
|
||
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="files.html"><span>Files</span></a></li> |
||
13 | </ul></div> |
||
14 | <h1>Orbs</h1>Functions for controlling the color of the orbs. |
||
15 | <a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
||
16 | <tr><td></td></tr> |
||
17 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
18 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8d23feea868a983c8c2b661e1e16972f"></a><!-- doxytag: member="orbs::RED" ref="g8d23feea868a983c8c2b661e1e16972f" args="" --> |
||
19 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g8d23feea868a983c8c2b661e1e16972f">RED</a> 0xE0</td></tr> |
||
20 | |||
21 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Red. <br></td></tr> |
||
22 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc5b6e19bf06822021f35602c59658de3"></a><!-- doxytag: member="orbs::ORANGE" ref="gc5b6e19bf06822021f35602c59658de3" args="" --> |
||
23 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc5b6e19bf06822021f35602c59658de3">ORANGE</a> 0xE4</td></tr> |
||
24 | |||
25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Orange. <br></td></tr> |
||
26 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf681265909adf3d3e8116c93c0ba179"></a><!-- doxytag: member="orbs::YELLOW" ref="gbf681265909adf3d3e8116c93c0ba179" args="" --> |
||
27 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbf681265909adf3d3e8116c93c0ba179">YELLOW</a> 0xE8</td></tr> |
||
28 | |||
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Yellow. <br></td></tr> |
||
30 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46019a1f2c10603a54b6cbb19cbf3c21"></a><!-- doxytag: member="orbs::LIME" ref="g46019a1f2c10603a54b6cbb19cbf3c21" args="" --> |
||
31 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g46019a1f2c10603a54b6cbb19cbf3c21">LIME</a> 0x68</td></tr> |
||
32 | |||
33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Lime. <br></td></tr> |
||
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfbc006ea433ad708fdee3e82996e721"></a><!-- doxytag: member="orbs::GREEN" ref="gcfbc006ea433ad708fdee3e82996e721" args="" --> |
||
35 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcfbc006ea433ad708fdee3e82996e721">GREEN</a> 0x1C</td></tr> |
||
36 | |||
37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Green. <br></td></tr> |
||
38 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd243f93c16bc4c1d3e0a13b84421d760"></a><!-- doxytag: member="orbs::CYAN" ref="gd243f93c16bc4c1d3e0a13b84421d760" args="" --> |
||
39 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gd243f93c16bc4c1d3e0a13b84421d760">CYAN</a> 0x1F</td></tr> |
||
40 | |||
41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Cyan. <br></td></tr> |
||
42 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g79d10e672abb49ad63eeaa8aaef57c38"></a><!-- doxytag: member="orbs::BLUE" ref="g79d10e672abb49ad63eeaa8aaef57c38" args="" --> |
||
43 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g79d10e672abb49ad63eeaa8aaef57c38">BLUE</a> 0x03</td></tr> |
||
44 | |||
45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Blue. <br></td></tr> |
||
46 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gda419fe3b48fcf19daed7cc57ccf1174"></a><!-- doxytag: member="orbs::PINK" ref="gda419fe3b48fcf19daed7cc57ccf1174" args="" --> |
||
47 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gda419fe3b48fcf19daed7cc57ccf1174">PINK</a> 0xA6</td></tr> |
||
48 | |||
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Pink. <br></td></tr> |
||
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bb0b009e7a7390473ace4d98bd843c0"></a><!-- doxytag: member="orbs::PURPLE" ref="g0bb0b009e7a7390473ace4d98bd843c0" args="" --> |
||
51 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0bb0b009e7a7390473ace4d98bd843c0">PURPLE</a> 0x41</td></tr> |
||
52 | |||
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Purple. <br></td></tr> |
||
54 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f699060902f800f12aaae150f3a708e"></a><!-- doxytag: member="orbs::MAGENTA" ref="g6f699060902f800f12aaae150f3a708e" args="" --> |
||
55 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g6f699060902f800f12aaae150f3a708e">MAGENTA</a> 0xE3</td></tr> |
||
56 | |||
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Magenta. <br></td></tr> |
||
58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g87b537f5fa5c109d3c05c13d6b18f382"></a><!-- doxytag: member="orbs::WHITE" ref="g87b537f5fa5c109d3c05c13d6b18f382" args="" --> |
||
59 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g87b537f5fa5c109d3c05c13d6b18f382">WHITE</a> 0xFE</td></tr> |
||
60 | |||
61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">White. <br></td></tr> |
||
62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf2f6da92d895ef5e594223f1e39e4b1"></a><!-- doxytag: member="orbs::ORB_OFF" ref="gcf2f6da92d895ef5e594223f1e39e4b1" args="" --> |
||
63 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a> 0xFE</td></tr> |
||
64 | |||
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the orb off (White). <br></td></tr> |
||
66 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
67 | <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> |
||
68 | |||
69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the orbs. <a href="#g13069271f9d636674e9b4a8a355099b9"></a><br></td></tr> |
||
70 | <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> |
||
71 | |||
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="#ga75385bd1398949615ee1fe78a535cff"></a><br></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#g2df1397345a557295b12e50451f8592e">orb1_set</a> (unsigned char red_led, unsigned char green_led, unsigned char blue_led)</td></tr> |
||
74 | |||
75 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="#g2df1397345a557295b12e50451f8592e"></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#gb19679987f51d6ed35461d581ca8972b">orb2_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 orb2 to a specified color. <a href="#gb19679987f51d6ed35461d581ca8972b"></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#g123d2880d20bf6d0bb387024c8f6da81">orb_set_color</a> (int col)</td></tr> |
||
80 | |||
81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set both orbs to a specified color. <a href="#g123d2880d20bf6d0bb387024c8f6da81"></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#g131d9bf3e32cf5530f4cc671ea496609">orb1_set_color</a> (int col)</td></tr> |
||
83 | |||
84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb1 to a specified color. <a href="#g131d9bf3e32cf5530f4cc671ea496609"></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#g3125d9c661a33b3fdeb4eca75ca00cab">orb2_set_color</a> (int col)</td></tr> |
||
86 | |||
87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set orb2 to a specified color. <a href="#g3125d9c661a33b3fdeb4eca75ca00cab"></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#g1ea1b363a0592f80798f6a1e260a70e9">orb_disable</a> (void)</td></tr> |
||
89 | |||
90 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the orbs. <a href="#g1ea1b363a0592f80798f6a1e260a70e9"></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#g5911e3fa322de2e760a92a44d5a6a547">orb_enable</a> (void)</td></tr> |
||
92 | |||
93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the orbs. <a href="#g5911e3fa322de2e760a92a44d5a6a547"></a><br></td></tr> |
||
94 | </table>
|
||
95 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
96 | Functions for controlling the color of the orbs. |
||
97 | <p>
|
||
98 | Functions for controlling the color and lighting of the orbs. <hr><h2>Function Documentation</h2> |
||
99 | <a class="anchor" name="g2df1397345a557295b12e50451f8592e"></a><!-- doxytag: member="lights.c::orb1_set" ref="g2df1397345a557295b12e50451f8592e" args="(unsigned char red_led, unsigned char green_led, unsigned char blue_led)" --><p> |
||
100 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
101 | <tr>
|
||
102 | <td class="mdRow"> |
||
103 | <table cellpadding="0" cellspacing="0" border="0"> |
||
104 | <tr>
|
||
105 | <td class="md" nowrap valign="top">void orb1_set </td> |
||
106 | <td class="md" valign="top">( </td> |
||
107 | <td class="md" nowrap valign="top">unsigned char </td> |
||
108 | <td class="mdname" nowrap> <em>red_led</em>, </td> |
||
109 | </tr>
|
||
110 | <tr>
|
||
111 | <td class="md" nowrap align="right"></td> |
||
112 | <td class="md"></td> |
||
113 | <td class="md" nowrap>unsigned char </td> |
||
114 | <td class="mdname" nowrap> <em>green_led</em>, </td> |
||
115 | </tr>
|
||
116 | <tr>
|
||
117 | <td class="md" nowrap align="right"></td> |
||
118 | <td class="md"></td> |
||
119 | <td class="md" nowrap>unsigned char </td> |
||
120 | <td class="mdname" nowrap> <em>blue_led</em></td> |
||
121 | </tr>
|
||
122 | <tr>
|
||
123 | <td class="md"></td> |
||
124 | <td class="md">) </td> |
||
125 | <td class="md" colspan="2"></td> |
||
126 | </tr>
|
||
127 | </table>
|
||
128 | </td>
|
||
129 | </tr>
|
||
130 | </table>
|
||
131 | <table cellspacing="5" cellpadding="0" border="0"> |
||
132 | <tr>
|
||
133 | <td>
|
||
134 |
|
||
135 | </td>
|
||
136 | <td>
|
||
137 | |||
138 | <p>
|
||
139 | Set orb1 to a specified color. |
||
140 | <p>
|
||
141 | Set orb1 to the color specified. orb_init must be called before this function may be used.<p>
|
||
142 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
143 | <table border="0" cellspacing="2" cellpadding="0"> |
||
144 | <tr><td valign="top"></td><td valign="top"><em>red_led</em> </td><td>the red component of the color </td></tr> |
||
145 | <tr><td valign="top"></td><td valign="top"><em>green_led</em> </td><td>the green component of the color </td></tr> |
||
146 | <tr><td valign="top"></td><td valign="top"><em>blue_led</em> </td><td>the blue component of the color</td></tr> |
||
147 | </table>
|
||
148 | </dl>
|
||
149 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
150 | </td>
|
||
151 | </tr>
|
||
152 | </table>
|
||
153 | <a class="anchor" name="g131d9bf3e32cf5530f4cc671ea496609"></a><!-- doxytag: member="lights.c::orb1_set_color" ref="g131d9bf3e32cf5530f4cc671ea496609" args="(int col)" --><p> |
||
154 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
155 | <tr>
|
||
156 | <td class="mdRow"> |
||
157 | <table cellpadding="0" cellspacing="0" border="0"> |
||
158 | <tr>
|
||
159 | <td class="md" nowrap valign="top">void orb1_set_color </td> |
||
160 | <td class="md" valign="top">( </td> |
||
161 | <td class="md" nowrap valign="top">int </td> |
||
162 | <td class="mdname1" valign="top" nowrap> <em>col</em> </td> |
||
163 | <td class="md" valign="top"> ) </td> |
||
164 | <td class="md" nowrap></td> |
||
165 | </tr>
|
||
166 | </table>
|
||
167 | </td>
|
||
168 | </tr>
|
||
169 | </table>
|
||
170 | <table cellspacing="5" cellpadding="0" border="0"> |
||
171 | <tr>
|
||
172 | <td>
|
||
173 |
|
||
174 | </td>
|
||
175 | <td>
|
||
176 | |||
177 | <p>
|
||
178 | Set orb1 to a specified color. |
||
179 | <p>
|
||
180 | Set orb1 to the specified color. This function is intended to be used with the predefined colors. orb_init must be called before this function may be used.<p>
|
||
181 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
182 | <table border="0" cellspacing="2" cellpadding="0"> |
||
183 | <tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>the color to set the orbs to</td></tr> |
||
184 | </table>
|
||
185 | </dl>
|
||
186 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
187 | </td>
|
||
188 | </tr>
|
||
189 | </table>
|
||
190 | <a class="anchor" name="gb19679987f51d6ed35461d581ca8972b"></a><!-- doxytag: member="lights.c::orb2_set" ref="gb19679987f51d6ed35461d581ca8972b" args="(unsigned char red_led, unsigned char green_led, unsigned char blue_led)" --><p> |
||
191 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
192 | <tr>
|
||
193 | <td class="mdRow"> |
||
194 | <table cellpadding="0" cellspacing="0" border="0"> |
||
195 | <tr>
|
||
196 | <td class="md" nowrap valign="top">void orb2_set </td> |
||
197 | <td class="md" valign="top">( </td> |
||
198 | <td class="md" nowrap valign="top">unsigned char </td> |
||
199 | <td class="mdname" nowrap> <em>red_led</em>, </td> |
||
200 | </tr>
|
||
201 | <tr>
|
||
202 | <td class="md" nowrap align="right"></td> |
||
203 | <td class="md"></td> |
||
204 | <td class="md" nowrap>unsigned char </td> |
||
205 | <td class="mdname" nowrap> <em>green_led</em>, </td> |
||
206 | </tr>
|
||
207 | <tr>
|
||
208 | <td class="md" nowrap align="right"></td> |
||
209 | <td class="md"></td> |
||
210 | <td class="md" nowrap>unsigned char </td> |
||
211 | <td class="mdname" nowrap> <em>blue_led</em></td> |
||
212 | </tr>
|
||
213 | <tr>
|
||
214 | <td class="md"></td> |
||
215 | <td class="md">) </td> |
||
216 | <td class="md" colspan="2"></td> |
||
217 | </tr>
|
||
218 | </table>
|
||
219 | </td>
|
||
220 | </tr>
|
||
221 | </table>
|
||
222 | <table cellspacing="5" cellpadding="0" border="0"> |
||
223 | <tr>
|
||
224 | <td>
|
||
225 |
|
||
226 | </td>
|
||
227 | <td>
|
||
228 | |||
229 | <p>
|
||
230 | Set orb2 to a specified color. |
||
231 | <p>
|
||
232 | Set orb2 to the color specified. orb_init must be called before this function may be used.<p>
|
||
233 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
234 | <table border="0" cellspacing="2" cellpadding="0"> |
||
235 | <tr><td valign="top"></td><td valign="top"><em>red_led</em> </td><td>the red component of the color </td></tr> |
||
236 | <tr><td valign="top"></td><td valign="top"><em>green_led</em> </td><td>the green component of the color </td></tr> |
||
237 | <tr><td valign="top"></td><td valign="top"><em>blue_led</em> </td><td>the blue component of the color</td></tr> |
||
238 | </table>
|
||
239 | </dl>
|
||
240 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
241 | </td>
|
||
242 | </tr>
|
||
243 | </table>
|
||
244 | <a class="anchor" name="g3125d9c661a33b3fdeb4eca75ca00cab"></a><!-- doxytag: member="lights.c::orb2_set_color" ref="g3125d9c661a33b3fdeb4eca75ca00cab" args="(int col)" --><p> |
||
245 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
246 | <tr>
|
||
247 | <td class="mdRow"> |
||
248 | <table cellpadding="0" cellspacing="0" border="0"> |
||
249 | <tr>
|
||
250 | <td class="md" nowrap valign="top">void orb2_set_color </td> |
||
251 | <td class="md" valign="top">( </td> |
||
252 | <td class="md" nowrap valign="top">int </td> |
||
253 | <td class="mdname1" valign="top" nowrap> <em>col</em> </td> |
||
254 | <td class="md" valign="top"> ) </td> |
||
255 | <td class="md" nowrap></td> |
||
256 | </tr>
|
||
257 | </table>
|
||
258 | </td>
|
||
259 | </tr>
|
||
260 | </table>
|
||
261 | <table cellspacing="5" cellpadding="0" border="0"> |
||
262 | <tr>
|
||
263 | <td>
|
||
264 |
|
||
265 | </td>
|
||
266 | <td>
|
||
267 | |||
268 | <p>
|
||
269 | Set orb2 to a specified color. |
||
270 | <p>
|
||
271 | Set orb2 to the specified color. This function is intended to be used with the predefined colors. orb_init must be called before this function may be used.<p>
|
||
272 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
273 | <table border="0" cellspacing="2" cellpadding="0"> |
||
274 | <tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>the color to set the orbs to</td></tr> |
||
275 | </table>
|
||
276 | </dl>
|
||
277 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
278 | </td>
|
||
279 | </tr>
|
||
280 | </table>
|
||
281 | <a class="anchor" name="g1ea1b363a0592f80798f6a1e260a70e9"></a><!-- doxytag: member="lights.c::orb_disable" ref="g1ea1b363a0592f80798f6a1e260a70e9" args="(void)" --><p> |
||
282 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
283 | <tr>
|
||
284 | <td class="mdRow"> |
||
285 | <table cellpadding="0" cellspacing="0" border="0"> |
||
286 | <tr>
|
||
287 | <td class="md" nowrap valign="top">void orb_disable </td> |
||
288 | <td class="md" valign="top">( </td> |
||
289 | <td class="md" nowrap valign="top">void </td> |
||
290 | <td class="mdname1" valign="top" nowrap> </td> |
||
291 | <td class="md" valign="top"> ) </td> |
||
292 | <td class="md" nowrap></td> |
||
293 | </tr>
|
||
294 | </table>
|
||
295 | </td>
|
||
296 | </tr>
|
||
297 | </table>
|
||
298 | <table cellspacing="5" cellpadding="0" border="0"> |
||
299 | <tr>
|
||
300 | <td>
|
||
301 |
|
||
302 | </td>
|
||
303 | <td>
|
||
304 | |||
305 | <p>
|
||
306 | Disable the orbs. |
||
307 | <p>
|
||
308 | Disables the orb color fading capabilities by disabling the timer1 interrupt.<p>
|
||
309 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
310 | </td>
|
||
311 | </tr>
|
||
312 | </table>
|
||
313 | <a class="anchor" name="g5911e3fa322de2e760a92a44d5a6a547"></a><!-- doxytag: member="lights.c::orb_enable" ref="g5911e3fa322de2e760a92a44d5a6a547" args="(void)" --><p> |
||
314 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
315 | <tr>
|
||
316 | <td class="mdRow"> |
||
317 | <table cellpadding="0" cellspacing="0" border="0"> |
||
318 | <tr>
|
||
319 | <td class="md" nowrap valign="top">void orb_enable </td> |
||
320 | <td class="md" valign="top">( </td> |
||
321 | <td class="md" nowrap valign="top">void </td> |
||
322 | <td class="mdname1" valign="top" nowrap> </td> |
||
323 | <td class="md" valign="top"> ) </td> |
||
324 | <td class="md" nowrap></td> |
||
325 | </tr>
|
||
326 | </table>
|
||
327 | </td>
|
||
328 | </tr>
|
||
329 | </table>
|
||
330 | <table cellspacing="5" cellpadding="0" border="0"> |
||
331 | <tr>
|
||
332 | <td>
|
||
333 |
|
||
334 | </td>
|
||
335 | <td>
|
||
336 | |||
337 | <p>
|
||
338 | Enable the orbs. |
||
339 | <p>
|
||
340 | Enables the orb's color fading capabilities.<p>
|
||
341 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
342 | </td>
|
||
343 | </tr>
|
||
344 | </table>
|
||
345 | <a class="anchor" name="g13069271f9d636674e9b4a8a355099b9"></a><!-- doxytag: member="lights.c::orb_init" ref="g13069271f9d636674e9b4a8a355099b9" args="(void)" --><p> |
||
346 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
347 | <tr>
|
||
348 | <td class="mdRow"> |
||
349 | <table cellpadding="0" cellspacing="0" border="0"> |
||
350 | <tr>
|
||
351 | <td class="md" nowrap valign="top">void orb_init </td> |
||
352 | <td class="md" valign="top">( </td> |
||
353 | <td class="md" nowrap valign="top">void </td> |
||
354 | <td class="mdname1" valign="top" nowrap> </td> |
||
355 | <td class="md" valign="top"> ) </td> |
||
356 | <td class="md" nowrap></td> |
||
357 | </tr>
|
||
358 | </table>
|
||
359 | </td>
|
||
360 | </tr>
|
||
361 | </table>
|
||
362 | <table cellspacing="5" cellpadding="0" border="0"> |
||
363 | <tr>
|
||
364 | <td>
|
||
365 |
|
||
366 | </td>
|
||
367 | <td>
|
||
368 | |||
369 | <p>
|
||
370 | Enables the orbs. |
||
371 | <p>
|
||
372 | Initializes the PWM for Orb control. This must be called before the orbs are used for them to function. </td>
|
||
373 | </tr>
|
||
374 | </table>
|
||
375 | <a class="anchor" name="ga75385bd1398949615ee1fe78a535cff"></a><!-- doxytag: member="lights.c::orb_set" ref="ga75385bd1398949615ee1fe78a535cff" args="(unsigned char red_led, unsigned char green_led, unsigned char blue_led)" --><p> |
||
376 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
377 | <tr>
|
||
378 | <td class="mdRow"> |
||
379 | <table cellpadding="0" cellspacing="0" border="0"> |
||
380 | <tr>
|
||
381 | <td class="md" nowrap valign="top">void orb_set </td> |
||
382 | <td class="md" valign="top">( </td> |
||
383 | <td class="md" nowrap valign="top">unsigned char </td> |
||
384 | <td class="mdname" nowrap> <em>red_led</em>, </td> |
||
385 | </tr>
|
||
386 | <tr>
|
||
387 | <td class="md" nowrap align="right"></td> |
||
388 | <td class="md"></td> |
||
389 | <td class="md" nowrap>unsigned char </td> |
||
390 | <td class="mdname" nowrap> <em>green_led</em>, </td> |
||
391 | </tr>
|
||
392 | <tr>
|
||
393 | <td class="md" nowrap align="right"></td> |
||
394 | <td class="md"></td> |
||
395 | <td class="md" nowrap>unsigned char </td> |
||
396 | <td class="mdname" nowrap> <em>blue_led</em></td> |
||
397 | </tr>
|
||
398 | <tr>
|
||
399 | <td class="md"></td> |
||
400 | <td class="md">) </td> |
||
401 | <td class="md" colspan="2"></td> |
||
402 | </tr>
|
||
403 | </table>
|
||
404 | </td>
|
||
405 | </tr>
|
||
406 | </table>
|
||
407 | <table cellspacing="5" cellpadding="0" border="0"> |
||
408 | <tr>
|
||
409 | <td>
|
||
410 |
|
||
411 | </td>
|
||
412 | <td>
|
||
413 | |||
414 | <p>
|
||
415 | Set both orbs to a specified color. |
||
416 | <p>
|
||
417 | Set both orbs to the color specified. orb_init must be called before this function may be used.<p>
|
||
418 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
419 | <table border="0" cellspacing="2" cellpadding="0"> |
||
420 | <tr><td valign="top"></td><td valign="top"><em>red_led</em> </td><td>the red component of the color </td></tr> |
||
421 | <tr><td valign="top"></td><td valign="top"><em>green_led</em> </td><td>the green component of the color </td></tr> |
||
422 | <tr><td valign="top"></td><td valign="top"><em>blue_led</em> </td><td>the blue component of the color</td></tr> |
||
423 | </table>
|
||
424 | </dl>
|
||
425 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
426 | </td>
|
||
427 | </tr>
|
||
428 | </table>
|
||
429 | <a class="anchor" name="g123d2880d20bf6d0bb387024c8f6da81"></a><!-- doxytag: member="lights.c::orb_set_color" ref="g123d2880d20bf6d0bb387024c8f6da81" args="(int col)" --><p> |
||
430 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
431 | <tr>
|
||
432 | <td class="mdRow"> |
||
433 | <table cellpadding="0" cellspacing="0" border="0"> |
||
434 | <tr>
|
||
435 | <td class="md" nowrap valign="top">void orb_set_color </td> |
||
436 | <td class="md" valign="top">( </td> |
||
437 | <td class="md" nowrap valign="top">int </td> |
||
438 | <td class="mdname1" valign="top" nowrap> <em>col</em> </td> |
||
439 | <td class="md" valign="top"> ) </td> |
||
440 | <td class="md" nowrap></td> |
||
441 | </tr>
|
||
442 | </table>
|
||
443 | </td>
|
||
444 | </tr>
|
||
445 | </table>
|
||
446 | <table cellspacing="5" cellpadding="0" border="0"> |
||
447 | <tr>
|
||
448 | <td>
|
||
449 |
|
||
450 | </td>
|
||
451 | <td>
|
||
452 | |||
453 | <p>
|
||
454 | Set both orbs to a specified color. |
||
455 | <p>
|
||
456 | Set both orbs to the specified color. This function is intended to be used with the predefined colors. orb_init must be called before this function may be used.<p>
|
||
457 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
458 | <table border="0" cellspacing="2" cellpadding="0"> |
||
459 | <tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>the color to set the orbs to</td></tr> |
||
460 | </table>
|
||
461 | </dl>
|
||
462 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> </dd></dl> |
||
463 | </td>
|
||
464 | </tr>
|
||
465 | </table>
|
||
466 | <hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 15:36:18 2007 for libdragonfly by |
||
467 | <a href="http://www.doxygen.org/index.html"> |
||
468 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
||
469 | </body>
|
||
470 | </html> |