Project

General

Profile

Revision 1823

Added by David Schultz almost 14 years ago

new doxygen for libwireless

View differences:

wireless_8c.html
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>Colony: wireless.c File Reference</title>
4 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.8 -->
1 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 
<html xmlns="http://www.w3.org/1999/xhtml">
3 
<head>
4 
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 
<title>libwireless: wireless.c File Reference</title>
6 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8 
</head>
9 
<body>
10 
<!-- Generated by Doxygen 1.6.3 -->
8 11 
<div class="navigation" id="top">
9 12 
  <div class="tabs">
10 13 
    <ul>
11 14 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 15 
      <li><a href="modules.html"><span>Modules</span></a></li>
16 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 17 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
14 18 
    </ul>
15 19 
  </div>
......
21 25 
  </div>
22 26 
</div>
23 27 
<div class="contents">
24 
<h1>wireless.c File Reference</h1>Wireless library.
25 
<a href="#_details">More...</a>
26 
<p>
27 
<code>#include &quot;<a class="el" href="wl__defs_8h.html">wl_defs.h</a>&quot;</code><br>
28 
<code>#include &quot;<a class="el" href="wireless_8h.html">wireless.h</a>&quot;</code><br>
28 
<h1>wireless.c File Reference</h1>
29 
<p>Wireless library.
30 
<a href="#_details">More...</a></p>
31 
<code>#include &lt;string.h&gt;</code><br/>
32 
<code>#include &quot;<a class="el" href="wireless_8c.html">wl_defs.h</a>&quot;</code><br/>
33 
<code>#include &lt;stdint.h&gt;</code><br/>
34 
<code>#include &lt;serial.h&gt;</code><br/>
29 35 
<table border="0" cellpadding="0" cellspacing="0">
30 
<tr><td></td></tr>
31 
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
32 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
33 

  		




  34
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize wireless.  <a href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009"></a><br></td></tr>


  		




  35
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>


  		




  36
  
  
    

  		




  37
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminate wireless.  <a href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr>


  		




  38
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr>


  		




  39
  
  
    

  		




  40
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to register new packet handlers (for non-default groups only).  <a href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr>


  		




  
  36
  
    
<tr><td colspan="2"><h2>Functions</h2></td></tr>


  		




  
  37
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>


  		




  
  38
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize wireless.  <a href="group__wireless.html#ga6a8d6179b1fe27f762937f0b47af2009"></a><br/></td></tr>


  		




  
  39
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>


  		




  
  40
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminate wireless.  <a href="group__wireless.html#ga223f437c2bc8ab8a3ac2e0e06841120f"></a><br/></td></tr>


  		




  
  41
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga7aa57c04f65ff3c8fec591248ab82f86">wl_register_handler</a> (uint8_t group, FNPTR, uint8_t priority)</td></tr>


  		




  
  42
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to register new packet handlers (for non-default groups only).  <a href="group__wireless.html#ga7aa57c04f65ff3c8fec591248ab82f86"></a><br/></td></tr>


  		




  
  43
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga376508d5682b1b8c88ef8b5f911a3367">wl_unregister_handler</a> (uint8_t group)</td></tr>


  		




  
  44
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to unregister existing packet handlers (for non-default groups only).  <a href="group__wireless.html#ga376508d5682b1b8c88ef8b5f911a3367"></a><br/></td></tr>


  		




  
  45
  
    
<tr><td colspan="2"><h2>Variables</h2></td></tr>


  		




  
  46
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d7d108b90e0ae78984f920ec3b47366"></a><!-- doxytag: member="wireless.c::wl_packet_handlers" ref="a5d7d108b90e0ae78984f920ec3b47366" args="[MAX_PACKET_GROUPS]" -->


  		




  
  47
  
    
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>wl_packet_handlers</b> [MAX_PACKET_GROUPS]</td></tr>


  		




  41
  48
  
    
</table>


  		




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


  		




  43
  
  
    
Copyright (c) 2009 Colony Project<p>


  		




  44
  
  
    
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>


  		




  45
  
  
    
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


  		




  46
  
  
    
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>


  		




  47
  
  
    
Implementation of high level wireless communication.<p>


  		




  48
  
  
    
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


  		




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


  		




  
  50
  
    
<p>Wireless library. </p>


  		




  
  51
  
    
<p>Copyright (c) 2009 Colony Project</p>


  		




  
  52
  
    
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>


  		




  
  53
  
    
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>


  		




  
  54
  
    
<p>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>


  		




  
  55
  
    
<p>Implementation of high level wireless communication.</p>


  		




  
  56
  
    
<dl class="author"><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


  		




  49
  57
  
    
</div>


  		




  50
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;


  		




  
  58
  
    
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;


  		




  51
  59
  
    
<a href="http://www.doxygen.org/index.html">


  		




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


  		




  
  60
  
    
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>


  		




  53
  61
  
    
</body>


  		




  54
  62
  
    
</html>


  		












Also available in:  Unified diff