root / trunk / docs / libdragonfly / group__orbs.html @ 862
History | View | Annotate | Download (22.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.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><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
</div>
|
| 19 |
<div class="contents"> |
| 20 |
<h1>Orbs</h1>Functions for controlling the color of the orbs. |
| 21 |
<a href="#_details">More...</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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="orbs::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="#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="#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="#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="#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="#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="#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="#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="#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="#g5911e3fa322de2e760a92a44d5a6a547"></a><br></td></tr> |
| 100 |
</table>
|
| 101 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 102 |
Functions for controlling the color of the orbs. |
| 103 |
<p>
|
| 104 |
Functions for controlling the color and lighting of the orbs. <hr><h2>Function Documentation</h2> |
| 105 |
<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)" --> |
| 106 |
<div class="memitem"> |
| 107 |
<div class="memproto"> |
| 108 |
<table class="memname"> |
| 109 |
<tr>
|
| 110 |
<td class="memname">void orb1_set </td> |
| 111 |
<td>(</td> |
| 112 |
<td class="paramtype">unsigned char </td> |
| 113 |
<td class="paramname"> <em>red_led</em>, </td> |
| 114 |
</tr>
|
| 115 |
<tr>
|
| 116 |
<td class="paramkey"></td> |
| 117 |
<td></td> |
| 118 |
<td class="paramtype">unsigned char </td> |
| 119 |
<td class="paramname"> <em>green_led</em>, </td> |
| 120 |
</tr>
|
| 121 |
<tr>
|
| 122 |
<td class="paramkey"></td> |
| 123 |
<td></td> |
| 124 |
<td class="paramtype">unsigned char </td> |
| 125 |
<td class="paramname"> <em>blue_led</em></td><td> </td> |
| 126 |
</tr>
|
| 127 |
<tr>
|
| 128 |
<td></td> |
| 129 |
<td>)</td> |
| 130 |
<td></td><td></td><td width="100%"></td> |
| 131 |
</tr>
|
| 132 |
</table>
|
| 133 |
</div>
|
| 134 |
<div class="memdoc"> |
| 135 |
|
| 136 |
<p>
|
| 137 |
Set orb1 to a specified color. |
| 138 |
<p>
|
| 139 |
Set orb1 to the color specified. orb_init must be called before this function may be used.<p>
|
| 140 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 141 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 142 |
<tr><td valign="top"></td><td valign="top"><em>red_led</em> </td><td>the red component of the color </td></tr> |
| 143 |
<tr><td valign="top"></td><td valign="top"><em>green_led</em> </td><td>the green component of the color </td></tr> |
| 144 |
<tr><td valign="top"></td><td valign="top"><em>blue_led</em> </td><td>the blue component of the color</td></tr> |
| 145 |
</table>
|
| 146 |
</dl>
|
| 147 |
<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> |
| 148 |
|
| 149 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00347">orb1_set_color()</a>, and <a class="el" href="lights_8c-source.html#l00278">orb_set()</a>.</p> |
| 150 |
|
| 151 |
</div>
|
| 152 |
</div><p> |
| 153 |
<a class="anchor" name="g131d9bf3e32cf5530f4cc671ea496609"></a><!-- doxytag: member="lights.c::orb1_set_color" ref="g131d9bf3e32cf5530f4cc671ea496609" args="(int col)" --> |
| 154 |
<div class="memitem"> |
| 155 |
<div class="memproto"> |
| 156 |
<table class="memname"> |
| 157 |
<tr>
|
| 158 |
<td class="memname">void orb1_set_color </td> |
| 159 |
<td>(</td> |
| 160 |
<td class="paramtype">int </td> |
| 161 |
<td class="paramname"> <em>col</em> </td> |
| 162 |
<td> ) </td> |
| 163 |
<td width="100%"></td> |
| 164 |
</tr>
|
| 165 |
</table>
|
| 166 |
</div>
|
| 167 |
<div class="memdoc"> |
| 168 |
|
| 169 |
<p>
|
| 170 |
Set orb1 to a specified color. |
| 171 |
<p>
|
| 172 |
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>
|
| 173 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 174 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 175 |
<tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>the color to set the orbs to</td></tr> |
| 176 |
</table>
|
| 177 |
</dl>
|
| 178 |
<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> |
| 179 |
|
| 180 |
<p>References <a class="el" href="lights_8c-source.html#l00294">orb1_set()</a>.</p> |
| 181 |
|
| 182 |
</div>
|
| 183 |
</div><p> |
| 184 |
<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)" --> |
| 185 |
<div class="memitem"> |
| 186 |
<div class="memproto"> |
| 187 |
<table class="memname"> |
| 188 |
<tr>
|
| 189 |
<td class="memname">void orb2_set </td> |
| 190 |
<td>(</td> |
| 191 |
<td class="paramtype">unsigned char </td> |
| 192 |
<td class="paramname"> <em>red_led</em>, </td> |
| 193 |
</tr>
|
| 194 |
<tr>
|
| 195 |
<td class="paramkey"></td> |
| 196 |
<td></td> |
| 197 |
<td class="paramtype">unsigned char </td> |
| 198 |
<td class="paramname"> <em>green_led</em>, </td> |
| 199 |
</tr>
|
| 200 |
<tr>
|
| 201 |
<td class="paramkey"></td> |
| 202 |
<td></td> |
| 203 |
<td class="paramtype">unsigned char </td> |
| 204 |
<td class="paramname"> <em>blue_led</em></td><td> </td> |
| 205 |
</tr>
|
| 206 |
<tr>
|
| 207 |
<td></td> |
| 208 |
<td>)</td> |
| 209 |
<td></td><td></td><td width="100%"></td> |
| 210 |
</tr>
|
| 211 |
</table>
|
| 212 |
</div>
|
| 213 |
<div class="memdoc"> |
| 214 |
|
| 215 |
<p>
|
| 216 |
Set orb2 to a specified color. |
| 217 |
<p>
|
| 218 |
Set orb2 to the color specified. orb_init must be called before this function may be used.<p>
|
| 219 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 220 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 221 |
<tr><td valign="top"></td><td valign="top"><em>red_led</em> </td><td>the red component of the color </td></tr> |
| 222 |
<tr><td valign="top"></td><td valign="top"><em>green_led</em> </td><td>the green component of the color </td></tr> |
| 223 |
<tr><td valign="top"></td><td valign="top"><em>blue_led</em> </td><td>the blue component of the color</td></tr> |
| 224 |
</table>
|
| 225 |
</dl>
|
| 226 |
<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> |
| 227 |
|
| 228 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00368">orb2_set_color()</a>, and <a class="el" href="lights_8c-source.html#l00278">orb_set()</a>.</p> |
| 229 |
|
| 230 |
</div>
|
| 231 |
</div><p> |
| 232 |
<a class="anchor" name="g3125d9c661a33b3fdeb4eca75ca00cab"></a><!-- doxytag: member="lights.c::orb2_set_color" ref="g3125d9c661a33b3fdeb4eca75ca00cab" args="(int col)" --> |
| 233 |
<div class="memitem"> |
| 234 |
<div class="memproto"> |
| 235 |
<table class="memname"> |
| 236 |
<tr>
|
| 237 |
<td class="memname">void orb2_set_color </td> |
| 238 |
<td>(</td> |
| 239 |
<td class="paramtype">int </td> |
| 240 |
<td class="paramname"> <em>col</em> </td> |
| 241 |
<td> ) </td> |
| 242 |
<td width="100%"></td> |
| 243 |
</tr>
|
| 244 |
</table>
|
| 245 |
</div>
|
| 246 |
<div class="memdoc"> |
| 247 |
|
| 248 |
<p>
|
| 249 |
Set orb2 to a specified color. |
| 250 |
<p>
|
| 251 |
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>
|
| 252 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 253 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 254 |
<tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>the color to set the orbs to</td></tr> |
| 255 |
</table>
|
| 256 |
</dl>
|
| 257 |
<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> |
| 258 |
|
| 259 |
<p>References <a class="el" href="lights_8c-source.html#l00310">orb2_set()</a>.</p> |
| 260 |
|
| 261 |
</div>
|
| 262 |
</div><p> |
| 263 |
<a class="anchor" name="g1ea1b363a0592f80798f6a1e260a70e9"></a><!-- doxytag: member="lights.c::orb_disable" ref="g1ea1b363a0592f80798f6a1e260a70e9" args="(void)" --> |
| 264 |
<div class="memitem"> |
| 265 |
<div class="memproto"> |
| 266 |
<table class="memname"> |
| 267 |
<tr>
|
| 268 |
<td class="memname">void orb_disable </td> |
| 269 |
<td>(</td> |
| 270 |
<td class="paramname"> </td> |
| 271 |
<td> ) </td> |
| 272 |
<td width="100%"></td> |
| 273 |
</tr>
|
| 274 |
</table>
|
| 275 |
</div>
|
| 276 |
<div class="memdoc"> |
| 277 |
|
| 278 |
<p>
|
| 279 |
Disable the orbs. |
| 280 |
<p>
|
| 281 |
Disables the orb color fading capabilities by disabling the timer1 interrupt.<p>
|
| 282 |
<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> |
| 283 |
|
| 284 |
</div>
|
| 285 |
</div><p> |
| 286 |
<a class="anchor" name="g5911e3fa322de2e760a92a44d5a6a547"></a><!-- doxytag: member="lights.c::orb_enable" ref="g5911e3fa322de2e760a92a44d5a6a547" args="(void)" --> |
| 287 |
<div class="memitem"> |
| 288 |
<div class="memproto"> |
| 289 |
<table class="memname"> |
| 290 |
<tr>
|
| 291 |
<td class="memname">void orb_enable </td> |
| 292 |
<td>(</td> |
| 293 |
<td class="paramname"> </td> |
| 294 |
<td> ) </td> |
| 295 |
<td width="100%"></td> |
| 296 |
</tr>
|
| 297 |
</table>
|
| 298 |
</div>
|
| 299 |
<div class="memdoc"> |
| 300 |
|
| 301 |
<p>
|
| 302 |
Enable the orbs. |
| 303 |
<p>
|
| 304 |
Enables the orb's color fading capabilities.<p>
|
| 305 |
<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> |
| 306 |
|
| 307 |
</div>
|
| 308 |
</div><p> |
| 309 |
<a class="anchor" name="g13069271f9d636674e9b4a8a355099b9"></a><!-- doxytag: member="lights.c::orb_init" ref="g13069271f9d636674e9b4a8a355099b9" args="(void)" --> |
| 310 |
<div class="memitem"> |
| 311 |
<div class="memproto"> |
| 312 |
<table class="memname"> |
| 313 |
<tr>
|
| 314 |
<td class="memname">void orb_init </td> |
| 315 |
<td>(</td> |
| 316 |
<td class="paramname"> </td> |
| 317 |
<td> ) </td> |
| 318 |
<td width="100%"></td> |
| 319 |
</tr>
|
| 320 |
</table>
|
| 321 |
</div>
|
| 322 |
<div class="memdoc"> |
| 323 |
|
| 324 |
<p>
|
| 325 |
Enables the orbs. |
| 326 |
<p>
|
| 327 |
Initializes the PWM for Orb control. This must be called before the orbs are used for them to function. |
| 328 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00071">dragonfly_init()</a>.</p> |
| 329 |
|
| 330 |
</div>
|
| 331 |
</div><p> |
| 332 |
<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)" --> |
| 333 |
<div class="memitem"> |
| 334 |
<div class="memproto"> |
| 335 |
<table class="memname"> |
| 336 |
<tr>
|
| 337 |
<td class="memname">void orb_set </td> |
| 338 |
<td>(</td> |
| 339 |
<td class="paramtype">unsigned char </td> |
| 340 |
<td class="paramname"> <em>red_led</em>, </td> |
| 341 |
</tr>
|
| 342 |
<tr>
|
| 343 |
<td class="paramkey"></td> |
| 344 |
<td></td> |
| 345 |
<td class="paramtype">unsigned char </td> |
| 346 |
<td class="paramname"> <em>green_led</em>, </td> |
| 347 |
</tr>
|
| 348 |
<tr>
|
| 349 |
<td class="paramkey"></td> |
| 350 |
<td></td> |
| 351 |
<td class="paramtype">unsigned char </td> |
| 352 |
<td class="paramname"> <em>blue_led</em></td><td> </td> |
| 353 |
</tr>
|
| 354 |
<tr>
|
| 355 |
<td></td> |
| 356 |
<td>)</td> |
| 357 |
<td></td><td></td><td width="100%"></td> |
| 358 |
</tr>
|
| 359 |
</table>
|
| 360 |
</div>
|
| 361 |
<div class="memdoc"> |
| 362 |
|
| 363 |
<p>
|
| 364 |
Set both orbs to a specified color. |
| 365 |
<p>
|
| 366 |
Set both orbs to the color specified. orb_init must be called before this function may be used.<p>
|
| 367 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 368 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 369 |
<tr><td valign="top"></td><td valign="top"><em>red_led</em> </td><td>the red component of the color </td></tr> |
| 370 |
<tr><td valign="top"></td><td valign="top"><em>green_led</em> </td><td>the green component of the color </td></tr> |
| 371 |
<tr><td valign="top"></td><td valign="top"><em>blue_led</em> </td><td>the blue component of the color</td></tr> |
| 372 |
</table>
|
| 373 |
</dl>
|
| 374 |
<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> |
| 375 |
|
| 376 |
<p>References <a class="el" href="lights_8c-source.html#l00294">orb1_set()</a>, and <a class="el" href="lights_8c-source.html#l00310">orb2_set()</a>.</p> |
| 377 |
|
| 378 |
<p>Referenced by <a class="el" href="lights_8c-source.html#l00326">orb_set_color()</a>.</p> |
| 379 |
|
| 380 |
</div>
|
| 381 |
</div><p> |
| 382 |
<a class="anchor" name="g123d2880d20bf6d0bb387024c8f6da81"></a><!-- doxytag: member="lights.c::orb_set_color" ref="g123d2880d20bf6d0bb387024c8f6da81" args="(int col)" --> |
| 383 |
<div class="memitem"> |
| 384 |
<div class="memproto"> |
| 385 |
<table class="memname"> |
| 386 |
<tr>
|
| 387 |
<td class="memname">void orb_set_color </td> |
| 388 |
<td>(</td> |
| 389 |
<td class="paramtype">int </td> |
| 390 |
<td class="paramname"> <em>col</em> </td> |
| 391 |
<td> ) </td> |
| 392 |
<td width="100%"></td> |
| 393 |
</tr>
|
| 394 |
</table>
|
| 395 |
</div>
|
| 396 |
<div class="memdoc"> |
| 397 |
|
| 398 |
<p>
|
| 399 |
Set both orbs to a specified color. |
| 400 |
<p>
|
| 401 |
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>
|
| 402 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 403 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 404 |
<tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>the color to set the orbs to</td></tr> |
| 405 |
</table>
|
| 406 |
</dl>
|
| 407 |
<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> |
| 408 |
|
| 409 |
<p>References <a class="el" href="lights_8c-source.html#l00278">orb_set()</a>.</p> |
| 410 |
|
| 411 |
</div>
|
| 412 |
</div><p> |
| 413 |
</div>
|
| 414 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by |
| 415 |
<a href="http://www.doxygen.org/index.html"> |
| 416 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
| 417 |
</body>
|
| 418 |
</html>
|