Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / wireless_8h.html @ 1395

History | View | Annotate | Download (10.7 KB)

1 19 bcoltin 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 241 bcoltin 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 19 bcoltin 
<title>libwireless: wireless.h File Reference</title>
4 1380 cmar 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 19 bcoltin 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 1380 cmar 
<!-- Generated by Doxygen 1.5.9 -->
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="modules.html"><span>Modules</span></a></li>
13 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
15 
    </ul>
16 
  </div>
17 
  <div class="tabs">
18 
    <ul>
19 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20 
      <li><a href="globals.html"><span>Globals</span></a></li>
21 
    </ul>
22 
  </div>
23 241 bcoltin 
</div>
24 1380 cmar 
<div class="contents">
25 
<h1>wireless.h File Reference</h1>Contains definitions for the wireless library.
26 
<a href="#_details">More...</a>
27 19 bcoltin 
<p>
28 

      

      

        29
        
        
        
        
        
<p>


      

      

        30
        
            1380
        
        
            cmar
        
        
<a href="wireless_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">


      

      

        31
        
            19
        
        
            bcoltin
        
        
<tr><td></td></tr>


      

      

        32
        
        
        
        
        
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>


      

      

        33
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr>


      

      

        34
        
        
        
        
        

      

      

        35
        
        
        
        
        
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


      

      

        36
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="wireless_8h.html#f083cc95511287866eeb4337fdc75eeb">WL_MAX_PACKET_GROUPS</a>&nbsp;&nbsp;&nbsp;16</td></tr>


      

      

        37
        
        
        
        
        

      

      

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


      

      

        39
        
            737
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b">wl_init</a> (void)</td></tr>


      

      

        40
        
            19
        
        
            bcoltin
        
        

      

      

        41
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the wireless library.  <a href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b"></a><br></td></tr>


      

      

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


      

      

        43
        
        
        
        
        

      

      

        44
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the wireless library.  <a href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr>


      

      

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


      

      

        46
        
        
        
        
        

      

      

        47
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform wireless library functionality.  <a href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr>


      

      

        48
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr>


      

      

        49
        
        
        
        
        

      

      

        50
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a packet group with the wireless library.  <a href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107"></a><br></td></tr>


      

      

        51
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr>


      

      

        52
        
        
        
        
        

      

      

        53
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister a packet group with the wireless library.  <a href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7"></a><br></td></tr>


      

      

        54
        
            737
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6e841a6ef0504538d8650a0a2f5fa869">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>


      

      

        55
        
            19
        
        
            bcoltin
        
        

      

      

        56
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to a specific robot in any PAN.  <a href="group__wireless.html#g6e841a6ef0504538d8650a0a2f5fa869"></a><br></td></tr>


      

      

        57
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gf8fbadf62eeb754b98b200328fb7a8be">wl_send_robot_to_robot_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>


      

      

        58
        
            19
        
        
            bcoltin
        
        

      

      

        59
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to a specific robot in our PAN.  <a href="group__wireless.html#gf8fbadf62eeb754b98b200328fb7a8be"></a><br></td></tr>


      

      

        60
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gda6b187ea58cee5aec18725bf7f24b9a">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>


      

      

        61
        
            19
        
        
            bcoltin
        
        

      

      

        62
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to all robots.  <a href="group__wireless.html#gda6b187ea58cee5aec18725bf7f24b9a"></a><br></td></tr>


      

      

        63
        
            19
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>


      

      

        64
        
        
        
        
        

      

      

        65
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to all robots in our PAN.  <a href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr>


      

      

        66
        
            737
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g754445d2353a70963a489651cff554c1">wl_set_pan</a> (int pan)</td></tr>


      

      

        67
        
            60
        
        
            bcoltin
        
        

      

      

        68
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN we are using.  <a href="group__wireless.html#g754445d2353a70963a489651cff554c1"></a><br></td></tr>


      

      

        69
        
            60
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr>


      

      

        70
        
        
        
        
        

      

      

        71
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the PAN we are using.  <a href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr>


      

      

        72
        
            737
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d">wl_set_channel</a> (int channel)</td></tr>


      

      

        73
        
            60
        
        
            bcoltin
        
        

      

      

        74
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel we are using.  <a href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d"></a><br></td></tr>


      

      

        75
        
            60
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr>


      

      

        76
        
        
        
        
        

      

      

        77
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel we are using.  <a href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr>


      

      

        78
        
            737
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6c75a84ff5f9a2bdc156aba522d2adf7">wl_get_xbee_id</a> (void)</td></tr>


      

      

        79
        
            19
        
        
            bcoltin
        
        

      

      

        80
        
            737
        
        
            bcoltin
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the 16-bit address of the XBee module.  <a href="group__wireless.html#g6c75a84ff5f9a2bdc156aba522d2adf7"></a><br></td></tr>


      

      

        81
        
            241
        
        
            bcoltin
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless.h::wl_set_com_port" ref="g344dead0023100eb40f8670a92c9ce5c" args="(char *port)" -->


      

      

        82
        
        
        
        
        
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr>


      

      

        83
        
        
        
        
        

      

      

        84
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr>


      

      

        85
        
            19
        
        
            bcoltin
        
        
</table>


      

      

        86
        
            1380
        
        
            cmar
        
        
<hr><h2>Detailed Description</h2>


      

      

        87
        
            19
        
        
            bcoltin
        
        
Contains definitions for the wireless library.


      

      

        88
        
        
        
        
        
<p>


      

      

        89
        
            242
        
        
            bcoltin
        
        
Copyright (c) 2007 Colony Project<p>


      

      

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


      

      

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


      

      

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


      

      

        93
        
            19
        
        
            bcoltin
        
        
Contains functions for the wireless library.<p>


      

      

        94
        
            241
        
        
            bcoltin
        
        
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl>


      

      

        95
        
            19
        
        
            bcoltin
        
        
<hr><h2>Define Documentation</h2>


      

      

        96
        
            241
        
        
            bcoltin
        
        
<a class="anchor" name="f083cc95511287866eeb4337fdc75eeb"></a><!-- doxytag: member="wireless.h::WL_MAX_PACKET_GROUPS" ref="f083cc95511287866eeb4337fdc75eeb" args="" -->


      

      

        97
        
        
        
        
        
<div class="memitem">


      

      

        98
        
        
        
        
        
<div class="memproto">


      

      

        99
        
        
        
        
        
      <table class="memname">


      

      

        100
        
            19
        
        
            bcoltin
        
        
        <tr>


      

      

        101
        
            241
        
        
            bcoltin
        
        
          <td class="memname">#define WL_MAX_PACKET_GROUPS&nbsp;&nbsp;&nbsp;16          </td>


      

      

        102
        
            19
        
        
            bcoltin
        
        
        </tr>


      

      

        103
        
        
        
        
        
      </table>


      

      

        104
        
            241
        
        
            bcoltin
        
        
</div>


      

      

        105
        
        
        
        
        
<div class="memdoc">


      

      

        106
        
            19
        
        
            bcoltin
        
        

      

      

        107
        
        
        
        
        
<p>


      

      

        108
        
            241
        
        
            bcoltin
        
        
The maximum number of packet groups.


      

      

        109
        
            1380
        
        
            cmar
        
        
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>, <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>, and <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>.</p>


      

      

        110
        
        
        
        
        

      

      

        111
        
            241
        
        
            bcoltin
        
        
</div>


      

      

        112
        
        
        
        
        
</div><p>


      

      

        113
        
            1380
        
        
            cmar
        
        
</div>


      

      

        114
        
            1395
        
        
            cmar
        
        
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;


      

      

        115
        
            19
        
        
            bcoltin
        
        
<a href="http://www.doxygen.org/index.html">


      

      

        116
        
            1380
        
        
            cmar
        
        
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


      

      

        117
        
            19
        
        
            bcoltin
        
        
</body>


      

      

        118
        
        
        
        
        
</html>