Project

General

Profile

Revision 1145

Added by Martin Herrmann about 15 years ago

Generated documentation for new orbs code

View differences:

lights_8h.html
4 4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.3 -->
8 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li><a href="annotated.html"><span>Data&nbsp;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&nbsp;Pages</span></a></li>
15 
  </ul>
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&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
16 18 
</div>
19 
<div class="contents">
17 20 
<h1>lights.h File Reference</h1>Contains declarations for managing the orbs. <a href="#_details">More...</a>
18 21 
<p>
19 22 

  		




  ......




  66
  69
  
    

  		




  67
  70
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">White. <br></td></tr>


  		




  68
  71
  
    
<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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a>&nbsp;&nbsp;&nbsp;0xFE</td></tr>


  		




  
  72
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gcf2f6da92d895ef5e594223f1e39e4b1">ORB_OFF</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>


  		




  70
  73
  
    

  		




  71
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the orb off (White). <br></td></tr>


  		




  
  74
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the orb off. <br></td></tr>


  		




  
  75
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc443bd65dba694ea9731f3ea455831a8"></a><!-- doxytag: member="lights.h::orb_mode_pwm" ref="gc443bd65dba694ea9731f3ea455831a8" args="" -->


  		




  
  76
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gc443bd65dba694ea9731f3ea455831a8">orb_mode_pwm</a>&nbsp;&nbsp;&nbsp;0</td></tr>


  		




  
  77
  
    

  		




  
  78
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PWM mode. <br></td></tr>


  		




  
  79
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf6cc675aa67ca9348717db3e53f18ae9"></a><!-- doxytag: member="lights.h::orb_mode_binary" ref="gf6cc675aa67ca9348717db3e53f18ae9" args="" -->


  		




  
  80
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gf6cc675aa67ca9348717db3e53f18ae9">orb_mode_binary</a>&nbsp;&nbsp;&nbsp;1</td></tr>


  		




  
  81
  
    

  		




  
  82
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Binary mode. <br></td></tr>


  		




  
  83
  
    
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>


  		




  
  84
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba7bc1797add20fe3efdf37ced1182c5"></a><!-- doxytag: member="lights.h::uint8_t" ref="ba7bc1797add20fe3efdf37ced1182c5" args="" -->


  		




  
  85
  
    
typedef unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>uint8_t</b></td></tr>


  		




  
  86
  
    

  		




  
  87
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ge1444a97f794787d7ffaa5ec12e2a1e2">orb_mode_t</a></td></tr>


  		




  
  88
  
    

  		




  72
  89
  
    
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


  		




  73
  90
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9">orb_init</a> (void)</td></tr>


  		




  74
  91
  
    

  		




  75
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  92
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables the orbs in default mode.  <a href="group__orbs.html#g13069271f9d636674e9b4a8a355099b9"></a><br></td></tr>


  		




  
  93
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g55a2b60caf9fe91346bed89c7bba73b7">orb_init_binary</a> (void)</td></tr>


  		




  77
  94
  
    

  		




  78
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  95
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables the orbs in binary mode.  <a href="group__orbs.html#g55a2b60caf9fe91346bed89c7bba73b7"></a><br></td></tr>


  		




  
  96
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gbb9bc432db2639616a7e8b3211544891">orb_init_pwm</a> (void)</td></tr>


  		




  80
  97
  
    

  		




  81
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  98
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables the orbs in PWM mode.  <a href="group__orbs.html#gbb9bc432db2639616a7e8b3211544891"></a><br></td></tr>


  		




  
  99
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1d0fbfe351097e16652a658af5c8955"></a><!-- doxytag: member="lights.h::orb_set_mode" ref="ga1d0fbfe351097e16652a658af5c8955" args="(orb_mode_t mode)" -->


  		




  
  100
  
    
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ga1d0fbfe351097e16652a658af5c8955">orb_set_mode</a> (<a class="el" href="group__orbs.html#ge1444a97f794787d7ffaa5ec12e2a1e2">orb_mode_t</a> mode)</td></tr>


  		




  83
  101
  
    

  		




  84
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g123d2880d20bf6d0bb387024c8f6da81">orb_set_color</a> (int col)</td></tr>


  		




  
  102
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Switches the orbs to the specified mode. <br></td></tr>


  		




  
  103
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#gf4effc092e3f85d937cea0ff72a003bf">orb_disable_timer</a> (void)</td></tr>


  		




  86
  104
  
    

  		




  87
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g131d9bf3e32cf5530f4cc671ea496609">orb1_set_color</a> (int col)</td></tr>


  		




  
  105
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disables the orb timer, but does not change the mode.  <a href="group__orbs.html#gf4effc092e3f85d937cea0ff72a003bf"></a><br></td></tr>


  		




  
  106
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ge626892624d9bd87fa7dcd0ebd6d19f3">orb_enable_timer</a> (void)</td></tr>


  		




  89
  107
  
    

  		




  90
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g3125d9c661a33b3fdeb4eca75ca00cab">orb2_set_color</a> (int col)</td></tr>


  		




  
  108
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables the orb timer, but does not change the mode.  <a href="group__orbs.html#ge626892624d9bd87fa7dcd0ebd6d19f3"></a><br></td></tr>


  		




  
  109
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#ge066e81a39023cf8a36efd432bb9a4ff">orb_n_set</a> (uint8_t num, uint8_t red, uint8_t green, uint8_t blue)</td></tr>


  		




  92
  110
  
    

  		




  93
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1ea1b363a0592f80798f6a1e260a70e9">orb_disable</a> (void)</td></tr>


  		




  
  111
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the specified orb to a specified color  <a href="group__orbs.html#ge066e81a39023cf8a36efd432bb9a4ff"></a><br></td></tr>


  		




  
  112
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g10dd6277826cd4c9305e48029c9011a4">orb_set</a> (uint8_t red, uint8_t green, uint8_t blue)</td></tr>


  		




  95
  113
  
    

  		




  96
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547">orb_enable</a> (void)</td></tr>


  		




  
  114
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set both orbs to a specified color.  <a href="group__orbs.html#g10dd6277826cd4c9305e48029c9011a4"></a><br></td></tr>


  		




  
  115
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g06c1b846b943bd327a2bc9f37b926497">orb1_set</a> (uint8_t red_led, uint8_t green_led, uint8_t blue_led)</td></tr>


  		




  98
  116
  
    

  		




  99
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable the orbs.  <a href="group__orbs.html#g5911e3fa322de2e760a92a44d5a6a547"></a><br></td></tr>


  		




  
  117
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set orb1 to a specified color.  <a href="group__orbs.html#g06c1b846b943bd327a2bc9f37b926497"></a><br></td></tr>


  		




  
  118
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g618af3d39cb8cd954248da295f7f234c">orb2_set</a> (uint8_t red_led, uint8_t green_led, uint8_t blue_led)</td></tr>


  		




  
  119
  
    

  		




  
  120
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set orb2 to a specified color.  <a href="group__orbs.html#g618af3d39cb8cd954248da295f7f234c"></a><br></td></tr>


  		




  
  121
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g5ebe8d5597e2519d82486ce0a88906cc">orbs_set</a> (uint8_t red1, uint8_t green1, uint8_t blue1, uint8_t red2, uint8_t green2, uint8_t blue2)</td></tr>


  		




  
  122
  
    

  		




  
  123
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g9bbced65e813e0937b7251a86853117f">orb_n_set_color</a> (uint8_t num, uint8_t col)</td></tr>


  		




  
  124
  
    

  		




  
  125
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the specified orb to the specified color  <a href="group__orbs.html#g9bbced65e813e0937b7251a86853117f"></a><br></td></tr>


  		




  
  126
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g0dede06855e46c8b8abdbce5779917ba">orb1_set_color</a> (uint8_t col)</td></tr>


  		




  
  127
  
    

  		




  
  128
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set orb1 to a specified color.  <a href="group__orbs.html#g0dede06855e46c8b8abdbce5779917ba"></a><br></td></tr>


  		




  
  129
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1eb5f3accec23e5a2ea137e95f5070d6">orb2_set_color</a> (uint8_t col)</td></tr>


  		




  
  130
  
    

  		




  
  131
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set orb2 to a specified color.  <a href="group__orbs.html#g1eb5f3accec23e5a2ea137e95f5070d6"></a><br></td></tr>


  		




  
  132
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g39224c46d5ed891d16e08239c959a8a8">orbs_set_color</a> (uint8_t col1, uint8_t col2)</td></tr>


  		




  
  133
  
    

  		




  
  134
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the orbs to specified colors  <a href="group__orbs.html#g39224c46d5ed891d16e08239c959a8a8"></a><br></td></tr>


  		




  
  135
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__orbs.html#g1710247e5331a3cb6076354a70e095e1">orb_set_color</a> (uint8_t col)</td></tr>


  		




  
  136
  
    

  		




  
  137
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set both orbs to a specified color.  <a href="group__orbs.html#g1710247e5331a3cb6076354a70e095e1"></a><br></td></tr>


  		




  100
  138
  
    
</table>


  		




  101
  139
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  102
  140
  
    
Contains declarations for managing the orbs. 


  		




  ......




  107
  145
  
    
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
  146
  
    
Contains declarations for using the orbs and PWM.<p>


  		




  109
  147
  
    
<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 Nov 5 19:59:42 2008 for libdragonfly by&nbsp;


  		




  
  148
  
    
</div>


  		




  
  149
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by&nbsp;


  		




  111
  150
  
    
<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>


  		




  
  151
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>


  		




  113
  152
  
    
</body>


  		




  114
  153
  
    
</html>


  		












Also available in:  Unified diff