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