Project

General

Profile

Revision 1380

Added by Chris Mar over 14 years ago

fixed doxygen problems in wireless library, added new docs

View differences:

trunk/docs/libwireless/wireless_8h_source.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>libwireless: wireless.h Source File</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.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
<h1>wireless.h</h1><a href="wireless_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
24
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef WIRELESS_H</span>
25
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define WIRELESS_H</span>
26
<a name="l00037"></a>00037 <span class="preprocessor"></span>
27
<a name="l00038"></a>00038 <span class="comment">//Note: If this is raised above 16, we will need to do</span>
28
<a name="l00039"></a>00039 <span class="comment">//something about frame numbers for TX Status packets.</span>
29
<a name="l00043"></a>00043 <span class="comment"></span><span class="comment">//TODO: a PacketGroupHandler is at least 10 bytes (I don't know if function pointers are 2 bytes</span>
30
<a name="l00044"></a>00044 <span class="comment">// or 4 bytes).  That means that in the c file, your array of packet groups is at least 160 bytes.</span>
31
<a name="l00045"></a>00045 <span class="comment">// Normally that might be fine (the robot's avr chips have 4k SRAM), but austin's chip only has</span>
32
<a name="l00046"></a>00046 <span class="comment">// 1k SRAM, so if this number can be reduced or if the size of the struct could be reduced, that would be a plus.</span>
33
<a name="l00047"></a><a class="code" href="wireless_8h.html#f083cc95511287866eeb4337fdc75eeb">00047</a> <span class="preprocessor">#define WL_MAX_PACKET_GROUPS 16</span>
34
<a name="l00048"></a>00048 <span class="preprocessor"></span>
35
<a name="l00079"></a>00079 <span class="comment">//TODO: the order of member variables in this struct should be changed in case the compile packs the struct</span>
36
<a name="l00080"></a>00080 <span class="comment">// In order to achieve the best packing, the variables should be listed in order of decreasing memory size.</span>
37
<a name="l00081"></a>00081 <span class="comment">// Thus, pointers should be first, followed by int, followed by char.</span>
38
<a name="l00082"></a><a class="code" href="structPacketGroupHandler.html">00082</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
39
<a name="l00083"></a>00083 {
40
<a name="l00089"></a>00089   <span class="comment">//TODO: if this number must be less than or equal to WL_MAX_PACKET_GROUPS, don't you only need</span>
41
<a name="l00090"></a>00090   <span class="comment">// one byte for it and it can be made an unsigned char?</span>
42
<a name="l00091"></a><a class="code" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">00091</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> groupCode;
43
<a name="l00092"></a>00092 
44
<a name="l00097"></a>00097         void (*timeout_handler) (void);
45
<a name="l00098"></a>00098 
46
<a name="l00108"></a>00108         void (*handle_response) (<span class="keywordtype">int</span> frame, <span class="keywordtype">int</span> received);
47
<a name="l00109"></a>00109 
48
<a name="l00119"></a>00119         void (*handle_receive) (<span class="keywordtype">char</span> type, <span class="keywordtype">int</span> source, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length);
49
<a name="l00120"></a>00120 
50
<a name="l00124"></a>00124         void (*unregister) (void);
51
<a name="l00125"></a>00125 
52
<a name="l00126"></a>00126 } <a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>;
53
<a name="l00127"></a>00127 
54
<a name="l00129"></a>00129 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init</a>(<span class="keywordtype">void</span>);
55
<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2" title="Uninitialize the wireless library.">wl_terminate</a>(<span class="keywordtype">void</span>);
56
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do</a>(<span class="keywordtype">void</span>);
57
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107" title="Register a packet group with the wireless library.">wl_register_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
58
<a name="l00137"></a>00137 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7" title="Unregister a packet group with the wireless library.">wl_unregister_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
59
<a name="l00138"></a>00138 
60
<a name="l00140"></a>00140 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g6e841a6ef0504538d8650a0a2f5fa869" title="Send a packet to a specific robot in any PAN.">wl_send_robot_to_robot_global_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type, <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, <span class="keywordtype">char</span> frame);
61
<a name="l00142"></a>00142 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#gf8fbadf62eeb754b98b200328fb7a8be" title="Send a packet to a specific robot in our PAN.">wl_send_robot_to_robot_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type, <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, <span class="keywordtype">char</span> frame);
62
<a name="l00144"></a>00144 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#gda6b187ea58cee5aec18725bf7f24b9a" title="Send a packet to all robots.">wl_send_global_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type, <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">char</span> frame);
63
<a name="l00146"></a>00146 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa" title="Send a packet to all robots in our PAN.">wl_send_pan_packet</a>(<span class="keywordtype">char</span> group, <span class="keywordtype">char</span> type, <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">char</span> frame);
64
<a name="l00147"></a>00147 
65
<a name="l00149"></a>00149 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g754445d2353a70963a489651cff554c1" title="Set the PAN we are using.">wl_set_pan</a>(<span class="keywordtype">int</span> pan);
66
<a name="l00151"></a>00151 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a>(<span class="keywordtype">void</span>);
67
<a name="l00153"></a>00153 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d" title="Set the channel we are using.">wl_set_channel</a>(<span class="keywordtype">int</span> channel);
68
<a name="l00155"></a>00155 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a>(<span class="keywordtype">void</span>);
69
<a name="l00157"></a>00157 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#g6c75a84ff5f9a2bdc156aba522d2adf7" title="Get the 16-bit address of the XBee module.">wl_get_xbee_id</a>(<span class="keywordtype">void</span>);
70
<a name="l00159"></a>00159 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c" title="Set the com port on a computer, undefined on the robot.">wl_set_com_port</a>(<span class="keywordtype">char</span>* port);
71
<a name="l00160"></a>00160  <span class="comment">// end defgroup</span>
72
<a name="l00162"></a>00162 
73
<a name="l00163"></a>00163 <span class="preprocessor">#endif</span>
74
<a name="l00164"></a>00164 <span class="preprocessor"></span>
75
</pre></div></div>
76
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
77
<a href="http://www.doxygen.org/index.html">
78
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
79
</body>
80
</html>
trunk/docs/libwireless/wl__basic_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>libwireless: wl_basic.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.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
</div>
24
<div class="contents">
25
<h1>wl_basic.c File Reference</h1>High Level Wireless Packet Sending-Receiving Functions.  
26
<a href="#_details">More...</a>
27
<p>
28
<code>#include &lt;<a class="el" href="wireless_8h_source.html">wireless.h</a>&gt;</code><br>
29
<code>#include &quot;<a class="el" href="wl__basic_8h_source.html">wl_basic.h</a>&quot;</code><br>
30
<table border="0" cellpadding="0" cellspacing="0">
31
<tr><td></td></tr>
32
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
33
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr>
34

  
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init wireless for Basic Group  <a href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr>
36
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr>
37

  
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal function to register a packet handler function  <a href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5"></a><br></td></tr>
39
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr>
40

  
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to a single robot in Basic Group  <a href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115"></a><br></td></tr>
42
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr>
43

  
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to all robots in Basic Group  <a href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e"></a><br></td></tr>
45
</table>
46
<hr><h2>Detailed Description</h2>
47
High Level Wireless Packet Sending-Receiving Functions. 
48
<p>
49
Abstracted wireless functionality for sending and receiving packets<p>
50
<dl class="author" compact><dt><b>Author:</b></dt><dd>Christopher Mar, Colony Project, CMU Robotics Club </dd></dl>
51
</div>
52
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
53
<a href="http://www.doxygen.org/index.html">
54
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
55
</body>
56
</html>
trunk/docs/libwireless/tabs.css
32 32
   float            : left;
33 33
   background       : url("tab_r.gif") no-repeat right top;
34 34
   border-bottom    : 1px solid #84B0C7;
35
   font-size        : x-small;
35
   font-size        : 80%;
36 36
   font-weight      : bold;
37 37
   text-decoration  : none;
38 38
}
......
66 66

  
67 67
DIV.tabs TD
68 68
{
69
   font-size        : x-small;
69
   font-size        : 80%;
70 70
   font-weight      : bold;
71 71
   text-decoration  : none;
72 72
}
......
94 94
   padding-bottom   : 6px;
95 95
}
96 96

  
97
DIV.nav
97
DIV.navpath
98 98
{
99 99
   background       : none;
100 100
   border           : none;
101 101
   border-bottom    : 1px solid #84B0C7;
102
   text-align       : center;
103
   margin           : 2px;
104
   padding          : 2px;
102 105
}
trunk/docs/libwireless/xbee_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>libwireless: xbee.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.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
</div>
24
<div class="contents">
25
<h1>xbee.c File Reference</h1>XBee Interface.  
26
<a href="#_details">More...</a>
27
<p>
28
<code>#include &quot;<a class="el" href="xbee_8h_source.html">xbee.h</a>&quot;</code><br>
29
<code>#include &quot;<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>&quot;</code><br>
30
<code>#include &lt;fcntl.h&gt;</code><br>
31
<code>#include &lt;unistd.h&gt;</code><br>
32
<code>#include &lt;pthread.h&gt;</code><br>
33
<code>#include &lt;errno.h&gt;</code><br>
34
<code>#include &lt;termios.h&gt;</code><br>
35
<code>#include &lt;stdio.h&gt;</code><br>
36
<code>#include &lt;stdlib.h&gt;</code><br>
37
<code>#include &lt;string.h&gt;</code><br>
38
<table border="0" cellpadding="0" cellspacing="0">
39
<tr><td></td></tr>
40
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
41
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_START" ref="72aa42b35714e06ac26df31b06a8bf39" args="" -->
42
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_START</b>&nbsp;&nbsp;&nbsp;0x7E</td></tr>
43

  
44
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be7468473089e3cdd2ed85cac2244d49"></a><!-- doxytag: member="xbee.c::XBEE_GET_PACKET_TIMEOUT" ref="be7468473089e3cdd2ed85cac2244d49" args="" -->
45
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_GET_PACKET_TIMEOUT</b>&nbsp;&nbsp;&nbsp;1000</td></tr>
46

  
47
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_STATUS" ref="e0fc9d7b1078703227c91e1352b708c5" args="" -->
48
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_STATUS</b>&nbsp;&nbsp;&nbsp;0x8A</td></tr>
49

  
50
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND" ref="106780ab66c38464e90af25ae3cc73de" args="" -->
51
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND</b>&nbsp;&nbsp;&nbsp;0x08</td></tr>
52

  
53
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="ac9e8cc2d9fdda49b77aed7d9380bfde" args="" -->
54
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND_RESPONSE</b>&nbsp;&nbsp;&nbsp;0x88</td></tr>
55

  
56
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_64" ref="31af21123fe9b33803cdf96626776d32" args="" -->
57
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_64</b>&nbsp;&nbsp;&nbsp;0x00</td></tr>
58

  
59
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_16" ref="30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" -->
60
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_16</b>&nbsp;&nbsp;&nbsp;0x01</td></tr>
61

  
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_STATUS" ref="301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" -->
63
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_STATUS</b>&nbsp;&nbsp;&nbsp;XBEE_TX_STATUS</td></tr>
64

  
65
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_64" ref="ba621d0a00f41acc7e059b5abf4802ad" args="" -->
66
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_64</b>&nbsp;&nbsp;&nbsp;0x80</td></tr>
67

  
68
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_16" ref="5b80e57bcad9ccaa20022e8d4968ec66" args="" -->
69
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_16</b>&nbsp;&nbsp;&nbsp;XBEE_RX</td></tr>
70

  
71
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63d0ecb125d464ea34524e090648f70f"></a><!-- doxytag: member="xbee.c::XBEE_BUFFER_SIZE" ref="63d0ecb125d464ea34524e090648f70f" args="" -->
72
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_BUFFER_SIZE</b>&nbsp;&nbsp;&nbsp;128</td></tr>
73

  
74
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="xbee.c::PACKET_BUFFER_SIZE" ref="b30af815d6e9494361629440f14e3716" args="" -->
75
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b>&nbsp;&nbsp;&nbsp;108</td></tr>
76

  
77
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
78
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> ()</td></tr>
79

  
80
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee library.  <a href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af"></a><br></td></tr>
81
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> ()</td></tr>
82

  
83
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the XBee library.  <a href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr>
84
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr>
85

  
86
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to the XBee.  <a href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr>
87
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *dest)</td></tr>
88

  
89
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a packet from the XBee.  <a href="group__xbee.html#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr>
90
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr>
91

  
92
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN ID for the XBee.  <a href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr>
93
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> ()</td></tr>
94

  
95
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's PAN ID.  <a href="group__xbee.html#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr>
96
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr>
97

  
98
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel the XBee is currently using.  <a href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14"></a><br></td></tr>
99
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr>
100

  
101
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel the XBee is currently using.  <a href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr>
102
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee_get_address</a> ()</td></tr>
103

  
104
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's 16-bit address.  <a href="group__xbee.html#g7c53e8a8492494a61ca306875d633309"></a><br></td></tr>
105
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee.c::xbee_set_com_port" ref="g1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" -->
106
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr>
107

  
108
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr>
109
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
110
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65685824a9cbbc9da05be520d0d80d12"></a><!-- doxytag: member="xbee.c::arrival_buf" ref="65685824a9cbbc9da05be520d0d80d12" args="[XBEE_BUFFER_SIZE]" -->
111
char&nbsp;</td><td class="memItemRight" valign="bottom"><b>arrival_buf</b> [XBEE_BUFFER_SIZE]</td></tr>
112

  
113
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7ae7d59f0f2dabc258c678996b59b22"></a><!-- doxytag: member="xbee.c::buffer_last" ref="b7ae7d59f0f2dabc258c678996b59b22" args="" -->
114
volatile int&nbsp;</td><td class="memItemRight" valign="bottom"><b>buffer_last</b> = 0</td></tr>
115

  
116
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a38080e2a4d6f0497f3c2faf487a0952"></a><!-- doxytag: member="xbee.c::buffer_first" ref="a38080e2a4d6f0497f3c2faf487a0952" args="" -->
117
volatile int&nbsp;</td><td class="memItemRight" valign="bottom"><b>buffer_first</b> = 0</td></tr>
118

  
119
</table>
120
<hr><h2>Detailed Description</h2>
121
XBee Interface. 
122
<p>
123
Copyright (c) 2007 Colony Project<p>
124
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>
125
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
126
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>
127
Implementation of low level communication with the XBee in API mode.<p>
128
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl>
129
</div>
130
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
131
<a href="http://www.doxygen.org/index.html">
132
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
133
</body>
134
</html>
trunk/docs/libwireless/wl__token__ring_8h_source.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>libwireless: wl_token_ring.h Source File</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.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
<h1>wl_token_ring.h</h1><a href="wl__token__ring_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
24
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef WL_TOKEN_RING_H</span>
25
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define WL_TOKEN_RING_H</span>
26
<a name="l00037"></a>00037 <span class="preprocessor"></span>
27
<a name="l00050"></a>00050 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44" title="Register the token ring group with the wireless library.">wl_token_ring_register</a>(<span class="keywordtype">void</span>);
28
<a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e" title="Unregister the token ring group with the wirelss library.">wl_token_ring_unregister</a>(<span class="keywordtype">void</span>);
29
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce" title="Set the functions called to turn the bom on and off.">wl_token_ring_set_bom_functions</a>(<span class="keywordtype">void</span> (*on_function) (<span class="keywordtype">void</span>), <span class="keywordtype">void</span> (*off_function) (<span class="keywordtype">void</span>),
30
<a name="l00055"></a>00055   <span class="keywordtype">int</span> (*max_bom_function) (<span class="keywordtype">void</span>));
31
<a name="l00056"></a>00056 
32
<a name="l00058"></a>00058 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#ge1012b6d6c1c46b26a6c6da7e4ec7c88" title="Join the token ring.">wl_token_ring_join</a>(<span class="keywordtype">void</span>);
33
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a" title="Leave the token ring.">wl_token_ring_leave</a>(<span class="keywordtype">void</span>);
34
<a name="l00061"></a>00061 
35
<a name="l00063"></a>00063 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b" title="Return the number of robots in the token ring.">wl_token_get_robots_in_ring</a>(<span class="keywordtype">void</span>);
36
<a name="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72" title="Return whether a given robot is in the token ring.">wl_token_is_robot_in_ring</a>(<span class="keywordtype">int</span> robot);
37
<a name="l00066"></a>00066 
38
<a name="l00068"></a>00068 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620" title="Begin iterating through robots in the token ring.">wl_token_iterator_begin</a>(<span class="keywordtype">void</span>);
39
<a name="l00070"></a>00070 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a>(<span class="keywordtype">void</span>);
40
<a name="l00072"></a>00072 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3" title="Returns the ID of the next robot in the token ring.">wl_token_iterator_next</a>(<span class="keywordtype">void</span>);
41
<a name="l00073"></a>00073 
42
<a name="l00075"></a>00075 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc" title="Return the latest BOM reading between two robots.">wl_token_get_sensor_reading</a>(<span class="keywordtype">int</span> source, <span class="keywordtype">int</span> dest);
43
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877" title="Return the latest BOM reading between us and another robot.">wl_token_get_my_sensor_reading</a>(<span class="keywordtype">int</span> dest);
44
<a name="l00079"></a>00079 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57" title="Return the number of robots in the sensor matrix.">wl_token_get_num_robots</a>(<span class="keywordtype">void</span>);
45
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d" title="Return the number of non-null elements in the sensor matrix.">wl_token_get_matrix_size</a>(<span class="keywordtype">void</span>);
46
<a name="l00082"></a>00082  <span class="comment">//end token ring group</span>
47
<a name="l00084"></a>00084 
48
<a name="l00085"></a>00085 <span class="preprocessor">#endif</span>
49
</pre></div></div>
50
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
51
<a href="http://www.doxygen.org/index.html">
52
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
53
</body>
54
</html>
trunk/docs/libwireless/globals_defs.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: Data Fields</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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
  </ul>
7
<!-- 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 class="current"><a href="globals.html"><span>Globals</span></a></li>
21
    </ul>
22
  </div>
23
  <div class="tabs">
24
    <ul>
25
      <li><a href="globals.html"><span>All</span></a></li>
26
      <li><a href="globals_func.html"><span>Functions</span></a></li>
27
      <li><a href="globals_vars.html"><span>Variables</span></a></li>
28
      <li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
29
    </ul>
30
  </div>
15 31
</div>
16
<div class="tabs">
17
  <ul>
18
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19
    <li class="current"><a href="globals.html"><span>Globals</span></a></li>
20
  </ul>
21
</div>
22
<div class="tabs">
23
  <ul>
24
    <li><a href="globals.html"><span>All</span></a></li>
25
    <li><a href="globals_func.html"><span>Functions</span></a></li>
26
    <li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
27
  </ul>
28
</div>
32
<div class="contents">
29 33
&nbsp;
30 34
<p>
31 35
<ul>
......
50 54
<li>XBEE_TX_STATUS
51 55
: <a class="el" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">xbee.h</a>
52 56
</ul>
53
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
57
</div>
58
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:46 2009 for libwireless by&nbsp;
54 59
<a href="http://www.doxygen.org/index.html">
55
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
60
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
56 61
</body>
57 62
</html>
trunk/docs/libwireless/sensor__matrix_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>libwireless: sensor_matrix.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.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
</div>
24
<div class="contents">
25
<h1>sensor_matrix.c File Reference</h1>Sensor Matrix implementation.  
26
<a href="#_details">More...</a>
27
<p>
28
<code>#include &lt;stdlib.h&gt;</code><br>
29
<code>#include &lt;stdio.h&gt;</code><br>
30
<code>#include &lt;<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>&gt;</code><br>
31
<code>#include &quot;<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>&quot;</code><br>
32
<table border="0" cellpadding="0" cellspacing="0">
33
<tr><td></td></tr>
34
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
35
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g09523e52546e7929288795e1e5f0f9a8">sensor_matrix_create</a> ()</td></tr>
36

  
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a sensor matrix.  <a href="group__sensormatrix.html#g09523e52546e7929288795e1e5f0f9a8"></a><br></td></tr>
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gf251d97aeb23af9156c0527692819da7">sensor_matrix_set_reading</a> (int observer, int robot, int reading)</td></tr>
39

  
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a reading in a sensor matrix.  <a href="group__sensormatrix.html#gf251d97aeb23af9156c0527692819da7"></a><br></td></tr>
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g031d5a4d15603e57379aad22da36e300">sensor_matrix_get_reading</a> (int observer, int robot)</td></tr>
42

  
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a reading in a sensor matrix.  <a href="group__sensormatrix.html#g031d5a4d15603e57379aad22da36e300"></a><br></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gea879c1d5f8a8a079066d8df005f3549">sensor_matrix_set_in_ring</a> (int robot, int in)</td></tr>
45

  
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set whether the robot is in the token ring.  <a href="group__sensormatrix.html#gea879c1d5f8a8a079066d8df005f3549"></a><br></td></tr>
47
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gc668dfe28e56b5a314789d395eda3b27">sensor_matrix_get_in_ring</a> (int robot)</td></tr>
48

  
49
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get whether the robot is in the sensor ring.  <a href="group__sensormatrix.html#gc668dfe28e56b5a314789d395eda3b27"></a><br></td></tr>
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g3545800eec0adba2fc63604206b8fb24">sensor_matrix_get_joined</a> (void)</td></tr>
51

  
52
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of robots which have joined the token ring.  <a href="group__sensormatrix.html#g3545800eec0adba2fc63604206b8fb24"></a><br></td></tr>
53
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga22a0851d1886ca29fc32e0692502f2d">sensor_matrix_get_size</a> (void)</td></tr>
54

  
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum size of the sensor matrix.  <a href="group__sensormatrix.html#ga22a0851d1886ca29fc32e0692502f2d"></a><br></td></tr>
56
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
57
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c091168317c73360daa8b5d366e5ae0f"></a><!-- doxytag: member="sensor_matrix.c::m" ref="c091168317c73360daa8b5d366e5ae0f" args="" -->
58
<a class="el" href="structSensorMatrix.html">SensorMatrix</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>m</b></td></tr>
59

  
60
</table>
61
<hr><h2>Detailed Description</h2>
62
Sensor Matrix implementation. 
63
<p>
64
Copyright (c) 2007 Colony Project<p>
65
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>
66
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
67
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>
68
Implementation of a sensor matrix for storing localization implementation.<p>
69
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl>
70
</div>
71
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
72
<a href="http://www.doxygen.org/index.html">
73
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
74
</body>
75
</html>
trunk/docs/libwireless/structPacketGroupHandler.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: PacketGroupHandler Struct Reference</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
    <li><a href="files.html"><span>Files</span></a></li>
14
  </ul>
7
<!-- 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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14
      <li><a href="files.html"><span>Files</span></a></li>
15
    </ul>
16
  </div>
17
  <div class="tabs">
18
    <ul>
19
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
20
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
21
    </ul>
22
  </div>
15 23
</div>
16
<div class="tabs">
17
  <ul>
18
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
19
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
20
  </ul>
21
</div>
24
<div class="contents">
22 25
<h1>PacketGroupHandler Struct Reference<br>
23 26
<small>
24
[<a class="el" href="group__wireless.html">Wireless</a>,&nbsp;<a class="el" href="group__wireless.html">Wireless</a>]</small>
25
</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include &lt;<a class="el" href="wireless_8h-source.html">wireless.h</a>&gt;</code>
27
[<a class="el" href="group__wireless.html">Wireless</a>]</small>
28
</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include &lt;<a class="el" href="wireless_8h_source.html">wireless.h</a>&gt;</code>
26 29
<p>
27 30
<table border="0" cellpadding="0" cellspacing="0">
28 31
<tr><td></td></tr>
......
53 56

  
54 57
<p>
55 58
The group code for this packet group. This number must be unique. The maximum number of packet groups is defined by WL_MAX_PACKET_GROUPS. 
59
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>, and <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p>
60

  
56 61
</div>
57 62
</div><p>
58
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->
63
<a class="anchor" name="5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" -->
59 64
<div class="memitem">
60 65
<div class="memproto">
61 66
      <table class="memname">
62 67
        <tr>
63
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)          </td>
68
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>)(char type, int source, unsigned char *packet, int length)          </td>
64 69
        </tr>
65 70
      </table>
66 71
</div>
67 72
<div class="memdoc">
68 73

  
69 74
<p>
70
Called every half second (not in interrupt, but in wl_do). 
75
Called when we receive a packet from this group.<p>
76
<dl compact><dt><b>Parameters:</b></dt><dd>
77
  <table border="0" cellspacing="2" cellpadding="0">
78
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
79
    <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>the 16-bit address of the XBee this packet was sent from </td></tr>
80
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet received </td></tr>
81
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the packet </td></tr>
82
  </table>
83
</dl>
84

  
85
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>
86

  
71 87
</div>
72 88
</div><p>
73 89
<a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->
......
90 106
  </table>
91 107
</dl>
92 108

  
109
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>
110

  
93 111
</div>
94 112
</div><p>
95
<a class="anchor" name="5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" -->
113
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->
96 114
<div class="memitem">
97 115
<div class="memproto">
98 116
      <table class="memname">
99 117
        <tr>
100
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>)(char type, int source, unsigned char *packet, int length)          </td>
118
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)          </td>
101 119
        </tr>
102 120
      </table>
103 121
</div>
104 122
<div class="memdoc">
105 123

  
106 124
<p>
107
Called when we receive a packet from this group.<p>
108
<dl compact><dt><b>Parameters:</b></dt><dd>
109
  <table border="0" cellspacing="2" cellpadding="0">
110
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
111
    <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>the 16-bit address of the XBee this packet was sent from </td></tr>
112
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet received </td></tr>
113
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the packet </td></tr>
114
  </table>
115
</dl>
125
Called every half second (not in interrupt, but in wl_do). 
126
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>.</p>
116 127

  
117 128
</div>
118 129
</div><p>
......
129 140

  
130 141
<p>
131 142
Called for any cleanup when the network is turned off. 
143
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>, and <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p>
144

  
132 145
</div>
133 146
</div><p>
134 147
<hr>The documentation for this struct was generated from the following file:<ul>
135
<li><a class="el" href="wireless_8h-source.html">wireless.h</a></ul>
136
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
148
<li><a class="el" href="wireless_8h_source.html">wireless.h</a></ul>
149
</div>
150
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
137 151
<a href="http://www.doxygen.org/index.html">
138
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
152
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
139 153
</body>
140 154
</html>
trunk/docs/libwireless/wireless_8h.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: wireless.h File Reference</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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
  </ul>
7
<!-- 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>
15 23
</div>
16
<h1>wireless.h File Reference</h1>Contains definitions for the wireless library. <a href="#_details">More...</a>
24
<div class="contents">
25
<h1>wireless.h File Reference</h1>Contains definitions for the wireless library.  
26
<a href="#_details">More...</a>
17 27
<p>
18 28

  
19 29
<p>
20
<a href="wireless_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
30
<a href="wireless_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
21 31
<tr><td></td></tr>
22 32
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
23 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>
......
73 83

  
74 84
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr>
75 85
</table>
76
<hr><a name="_details"></a><h2>Detailed Description</h2>
86
<hr><h2>Detailed Description</h2>
77 87
Contains definitions for the wireless library. 
78 88
<p>
79 89
Copyright (c) 2007 Colony Project<p>
......
96 106

  
97 107
<p>
98 108
The maximum number of packet groups. 
109
<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

  
99 111
</div>
100 112
</div><p>
101
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
113
</div>
114
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
102 115
<a href="http://www.doxygen.org/index.html">
103
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
116
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
104 117
</body>
105 118
</html>
trunk/docs/libwireless/group__wl__basic.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>libwireless: Wireless Basic</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.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><a href="files.html"><span>Files</span></a></li>
15
    </ul>
16
  </div>
17
</div>
18
<div class="contents">
19
<h1>Wireless Basic</h1>Wireless abstraction for easily sending and receing packets.  
20
<a href="#_details">More...</a>
21
<p>
22
<table border="0" cellpadding="0" cellspacing="0">
23
<tr><td></td></tr>
24
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
25
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g366b705160e22c2a6c4ea2c3c22e3485"></a><!-- doxytag: member="wl_basic::WL_BASIC_GROUP" ref="g366b705160e22c2a6c4ea2c3c22e3485" args="" -->
26
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_BASIC_GROUP</b>&nbsp;&nbsp;&nbsp;8</td></tr>
27

  
28
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
29
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr>
30

  
31
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init wireless for Basic Group  <a href="#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr>
32
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr>
33

  
34
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal function to register a packet handler function  <a href="#gebc714e1bf382a98ac7a43762bf905c5"></a><br></td></tr>
35
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr>
36

  
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to a single robot in Basic Group  <a href="#gd5d7334484e49cc3cb9ebe2cfc323115"></a><br></td></tr>
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr>
39

  
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a packet to all robots in Basic Group  <a href="#g72d4f604603ef2541b5f4d3ae467938e"></a><br></td></tr>
41
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
42
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic::wl_basic_group_handler" ref="gf0fa88111d706ef4e8b3bda5bc32596c" args="" -->
43
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr>
44

  
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br></td></tr>
46
</table>
47
<hr><a name="_details"></a><h2>Detailed Description</h2>
48
Wireless abstraction for easily sending and receing packets. 
49
<p>
50
A high level abstraction of the wireless library.<p>
51
This will allow you to easily send and receive packets. <hr><h2>Function Documentation</h2>
52
<a class="anchor" name="gae4a8ae98cc33955ee20b6e481d47adf"></a><!-- doxytag: member="wl_basic.h::wl_basic_init" ref="gae4a8ae98cc33955ee20b6e481d47adf" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" -->
53
<div class="memitem">
54
<div class="memproto">
55
      <table class="memname">
56
        <tr>
57
          <td class="memname">int wl_basic_init           </td>
58
          <td>(</td>
59
          <td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length)&nbsp;</td>
60
          <td class="paramname"> <em>handle_receive</em>          </td>
61
          <td>&nbsp;)&nbsp;</td>
62
          <td></td>
63
        </tr>
64
      </table>
65
</div>
66
<div class="memdoc">
67

  
68
<p>
69
init wireless for Basic Group 
70
<p>
71
Wrapper for <a class="el" href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init()</a>. Initializes wireless and registers a packet handler function for Basic Group.<p>
72
<dl compact><dt><b>Parameters:</b></dt><dd>
73
  <table border="0" cellspacing="2" cellpadding="0">
74
    <tr><td valign="top"></td><td valign="top"><em>handle_receive</em>&nbsp;</td><td>function pointer to handler function for Basic Group </td></tr>
75
  </table>
76
</dl>
77
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl>
78

  
79
<p>References <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>
80

  
81
</div>
82
</div><p>
83
<a class="anchor" name="gebc714e1bf382a98ac7a43762bf905c5"></a><!-- doxytag: member="wl_basic.h::wl_basic_register_handler" ref="gebc714e1bf382a98ac7a43762bf905c5" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" -->
84
<div class="memitem">
85
<div class="memproto">
86
      <table class="memname">
87
        <tr>
88
          <td class="memname">void wl_basic_register_handler           </td>
89
          <td>(</td>
90
          <td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length)&nbsp;</td>
91
          <td class="paramname"> <em>handle_receive</em>          </td>
92
          <td>&nbsp;)&nbsp;</td>
93
          <td></td>
94
        </tr>
95
      </table>
96
</div>
97
<div class="memdoc">
98

  
99
<p>
100
internal function to register a packet handler function 
101
<p>
102
Internal function to register a packet group handler for Basic Group<p>
103
<dl compact><dt><b>Parameters:</b></dt><dd>
104
  <table border="0" cellspacing="2" cellpadding="0">
105
    <tr><td valign="top"></td><td valign="top"><em>handle_receive</em>&nbsp;</td><td>function pointer to handler function for Basic Group </td></tr>
106
  </table>
107
</dl>
108

  
109
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>, <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>, <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>, <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wl__basic_8h_source.html#l00038">wl_basic_group_handler</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>
110

  
111
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00021">wl_basic_init()</a>.</p>
112

  
113
</div>
114
</div><p>
115
<a class="anchor" name="g72d4f604603ef2541b5f4d3ae467938e"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_global_packet" ref="g72d4f604603ef2541b5f4d3ae467938e" args="(char type, char *data, int len)" -->
116
<div class="memitem">
117
<div class="memproto">
118
      <table class="memname">
119
        <tr>
120
          <td class="memname">void wl_basic_send_global_packet           </td>
121
          <td>(</td>
122
          <td class="paramtype">char&nbsp;</td>
123
          <td class="paramname"> <em>type</em>, </td>
124
        </tr>
125
        <tr>
126
          <td class="paramkey"></td>
127
          <td></td>
128
          <td class="paramtype">char *&nbsp;</td>
129
          <td class="paramname"> <em>data</em>, </td>
130
        </tr>
131
        <tr>
132
          <td class="paramkey"></td>
133
          <td></td>
134
          <td class="paramtype">int&nbsp;</td>
135
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
136
        </tr>
137
        <tr>
138
          <td></td>
139
          <td>)</td>
140
          <td></td><td></td><td></td>
141
        </tr>
142
      </table>
143
</div>
144
<div class="memdoc">
145

  
146
<p>
147
send a packet to all robots in Basic Group 
148
<p>
149
Send a packet to all robots in Basic Group<p>
150
<dl compact><dt><b>Parameters:</b></dt><dd>
151
  <table border="0" cellspacing="2" cellpadding="0">
152
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Packet type </td></tr>
153
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Packet buffer, data you want to send </td></tr>
154
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Length of the data buffer in bytes </td></tr>
155
  </table>
156
</dl>
157

  
158
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p>
159

  
160
</div>
161
</div><p>
162
<a class="anchor" name="gd5d7334484e49cc3cb9ebe2cfc323115"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_robot_packet" ref="gd5d7334484e49cc3cb9ebe2cfc323115" args="(char type, char *data, int len, int dest)" -->
163
<div class="memitem">
164
<div class="memproto">
165
      <table class="memname">
166
        <tr>
167
          <td class="memname">void wl_basic_send_robot_packet           </td>
168
          <td>(</td>
169
          <td class="paramtype">char&nbsp;</td>
170
          <td class="paramname"> <em>type</em>, </td>
171
        </tr>
172
        <tr>
173
          <td class="paramkey"></td>
174
          <td></td>
175
          <td class="paramtype">char *&nbsp;</td>
176
          <td class="paramname"> <em>data</em>, </td>
177
        </tr>
178
        <tr>
179
          <td class="paramkey"></td>
180
          <td></td>
181
          <td class="paramtype">int&nbsp;</td>
182
          <td class="paramname"> <em>len</em>, </td>
183
        </tr>
184
        <tr>
185
          <td class="paramkey"></td>
186
          <td></td>
187
          <td class="paramtype">int&nbsp;</td>
188
          <td class="paramname"> <em>dest</em></td><td>&nbsp;</td>
189
        </tr>
190
        <tr>
191
          <td></td>
192
          <td>)</td>
193
          <td></td><td></td><td></td>
194
        </tr>
195
      </table>
196
</div>
197
<div class="memdoc">
198

  
199
<p>
200
send a packet to a single robot in Basic Group 
201
<p>
202
Send a packet to a single robot in Basic Group<p>
203
<dl compact><dt><b>Parameters:</b></dt><dd>
204
  <table border="0" cellspacing="2" cellpadding="0">
205
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Packet type </td></tr>
206
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Packet buffer, data you want to send </td></tr>
207
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Length of the data buffer in bytes  Robot ID of the destination robot </td></tr>
208
  </table>
209
</dl>
210

  
211
<p>References <a class="el" href="wireless_8c_source.html#l00252">wl_send_robot_to_robot_global_packet()</a>.</p>
212

  
213
</div>
214
</div><p>
215
</div>
216
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
217
<a href="http://www.doxygen.org/index.html">
218
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
219
</body>
220
</html>
trunk/docs/libwireless/wl__token__ring_8h.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: wl_token_ring.h File Reference</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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
  </ul>
7
<!-- 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>
15 23
</div>
16
<h1>wl_token_ring.h File Reference</h1>Declarations for the token ring packet group. <a href="#_details">More...</a>
24
<div class="contents">
25
<h1>wl_token_ring.h File Reference</h1>Declarations for the token ring packet group.  
26
<a href="#_details">More...</a>
17 27
<p>
18 28

  
19 29
<p>
20
<a href="wl__token__ring_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
30
<a href="wl__token__ring_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
21 31
<tr><td></td></tr>
22 32
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
23 33
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44">wl_token_ring_register</a> (void)</td></tr>
......
63 73

  
64 74
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of non-null elements in the sensor matrix.  <a href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d"></a><br></td></tr>
65 75
</table>
66
<hr><a name="_details"></a><h2>Detailed Description</h2>
76
<hr><h2>Detailed Description</h2>
67 77
Declarations for the token ring packet group. 
68 78
<p>
69 79
Copyright (c) 2007 Colony Project<p>
......
72 82
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>
73 83
Contains declarations for the token ring packet group.<p>
74 84
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl>
75
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
85
</div>
86
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
76 87
<a href="http://www.doxygen.org/index.html">
77
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
88
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
78 89
</body>
79 90
</html>
trunk/docs/libwireless/group__xbee.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: XBee</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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><a href="files.html"><span>Files</span></a></li>
14
  </ul>
7
<!-- 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><a href="files.html"><span>Files</span></a></li>
15
    </ul>
16
  </div>
15 17
</div>
18
<div class="contents">
16 19
<h1>XBee</h1>Interface with the XBee module.  
17
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
20
<a href="#_details">More...</a>
21
<p>
22
<table border="0" cellpadding="0" cellspacing="0">
18 23
<tr><td></td></tr>
19 24
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
20 25
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" -->
......
83 88
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr>
84 89
</table>
85 90
<hr><a name="_details"></a><h2>Detailed Description</h2>
86
Interface with the XBee module. 
87
<p>
88 91
Interface with the XBee module. <hr><h2>Function Documentation</h2>
89 92
<a class="anchor" name="g7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="g7c53e8a8492494a61ca306875d633309" args="(void)" -->
90 93
<div class="memitem">
......
96 99
          <td class="paramtype">void&nbsp;</td>
97 100
          <td class="paramname">          </td>
98 101
          <td>&nbsp;)&nbsp;</td>
99
          <td width="100%"></td>
102
          <td></td>
100 103
        </tr>
101 104
      </table>
102 105
</div>
......
108 111
Get the 16-bit address of the XBee. This is used to specify who to send messages to and who messages are from.<p>
109 112
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl>
110 113

  
114
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>.</p>
115

  
111 116
</div>
112 117
</div><p>
113 118
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" -->
......
120 125
          <td class="paramtype">void&nbsp;</td>
121 126
          <td class="paramname">          </td>
122 127
          <td>&nbsp;)&nbsp;</td>
123
          <td width="100%"></td>
128
          <td></td>
124 129
        </tr>
125 130
      </table>
126 131
</div>
......
133 138
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl>
134 139
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl>
135 140

  
141
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00223">wl_get_channel()</a>.</p>
142

  
136 143
</div>
137 144
</div><p>
138 145
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" -->
......
145 152
          <td class="paramtype">unsigned char *&nbsp;</td>
146 153
          <td class="paramname"> <em>dest</em>          </td>
147 154
          <td>&nbsp;)&nbsp;</td>
148
          <td width="100%"></td>
155
          <td></td>
149 156
        </tr>
150 157
      </table>
151 158
</div>
......
180 187
</dl>
181 188
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the packet, or -1 if no packet is available </dd></dl>
182 189

  
190
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>, and <a class="el" href="xbee_8c_source.html#l00206">xbee_lib_init()</a>.</p>
191

  
183 192
</div>
184 193
</div><p>
185 194
<a class="anchor" name="g7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.h::xbee_get_pan_id" ref="g7755cd8db87703c9e9943153660b8052" args="(void)" -->
......
192 201
          <td class="paramtype">void&nbsp;</td>
193 202
          <td class="paramname">          </td>
194 203
          <td>&nbsp;)&nbsp;</td>
195
          <td width="100%"></td>
204
          <td></td>
196 205
        </tr>
197 206
      </table>
198 207
</div>
......
204 213
Get the PAN ID for the XBee.<p>
205 214
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl>
206 215

  
216
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00195">wl_get_pan()</a>.</p>
217

  
207 218
</div>
208 219
</div><p>
209 220
<a class="anchor" name="g3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g3d5fbb6aae8dda99240ec38108a645af" args="(void)" -->
......
216 227
          <td class="paramtype">void&nbsp;</td>
217 228
          <td class="paramname">          </td>
218 229
          <td>&nbsp;)&nbsp;</td>
219
          <td width="100%"></td>
230
          <td></td>
220 231
        </tr>
221 232
      </table>
222 233
</div>
......
226 237
Initialize the XBee library. 
227 238
<p>
228 239
Initializes the XBee library so that other functions may be used. 
240
<p>References <a class="el" href="xbee_8c_source.html#l00725">xbee_get_packet()</a>.</p>
241

  
242
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>
243

  
229 244
</div>
230 245
</div><p>
231 246
<a class="anchor" name="g7c44bc25fda954efde574ee8d735073c"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="g7c44bc25fda954efde574ee8d735073c" args="(char *packet, int len, int dest, char options, char frame)" -->
......
265 280
        <tr>
266 281
          <td></td>
267 282
          <td>)</td>
268
          <td></td><td></td><td width="100%"></td>
283
          <td></td><td></td><td></td>
269 284
        </tr>
270 285
      </table>
271 286
</div>
......
297 312
          <td class="paramtype">int&nbsp;</td>
298 313
          <td class="paramname"> <em>channel</em>          </td>
299 314
          <td>&nbsp;)&nbsp;</td>
300
          <td width="100%"></td>
315
          <td></td>
301 316
        </tr>
302 317
      </table>
303 318
</div>
......
314 329
</dl>
315 330
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a> </dd></dl>
316 331

  
332
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00209">wl_set_channel()</a>.</p>
333

  
317 334
</div>
318 335
</div><p>
319 336
<a class="anchor" name="gde50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="gde50cbefd7ba8d7361ce2654a298748b" args="(int id)" -->
......
326 343
          <td class="paramtype">int&nbsp;</td>
327 344
          <td class="paramname"> <em>id</em>          </td>
328 345
          <td>&nbsp;)&nbsp;</td>
329
          <td width="100%"></td>
346
          <td></td>
330 347
        </tr>
331 348
      </table>
332 349
</div>
......
342 359
  </table>
343 360
</dl>
344 361

  
362
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00181">wl_set_pan()</a>.</p>
363

  
345 364
</div>
346 365
</div><p>
347 366
<a class="anchor" name="g9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="g9334ac71dca1ddd697b1a35a361ade6a" args="(void)" -->
......
354 373
          <td class="paramtype">void&nbsp;</td>
355 374
          <td class="paramname">          </td>
356 375
          <td>&nbsp;)&nbsp;</td>
357
          <td width="100%"></td>
376
          <td></td>
358 377
        </tr>
359 378
      </table>
360 379
</div>
......
364 383
Uninitialize the XBee library. 
365 384
<p>
366 385
Call when finished using the XBee library. This releases all sued resources. 
386
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>.</p>
387

  
367 388
</div>
368 389
</div><p>
369
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
390
</div>
391
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
370 392
<a href="http://www.doxygen.org/index.html">
371
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
393
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
372 394
</body>
373 395
</html>
trunk/docs/libwireless/globals_func.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: Data Fields</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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
  </ul>
7
<!-- 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 class="current"><a href="globals.html"><span>Globals</span></a></li>
21
    </ul>
22
  </div>
23
  <div class="tabs">
24
    <ul>
25
      <li><a href="globals.html"><span>All</span></a></li>
26
      <li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
27
      <li><a href="globals_vars.html"><span>Variables</span></a></li>
28
      <li><a href="globals_defs.html"><span>Defines</span></a></li>
29
    </ul>
30
  </div>
31
  <div class="tabs">
32
    <ul>
33
      <li><a href="#index_s"><span>s</span></a></li>
34
      <li><a href="#index_w"><span>w</span></a></li>
35
      <li><a href="#index_x"><span>x</span></a></li>
36
    </ul>
37
  </div>
15 38
</div>
16
<div class="tabs">
17
  <ul>
18
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19
    <li class="current"><a href="globals.html"><span>Globals</span></a></li>
20
  </ul>
21
</div>
22
<div class="tabs">
23
  <ul>
24
    <li><a href="globals.html"><span>All</span></a></li>
25
    <li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
26
    <li><a href="globals_defs.html"><span>Defines</span></a></li>
27
  </ul>
28
</div>
29
<div class="tabs">
30
  <ul>
31
    <li><a href="#index_s"><span>s</span></a></li>
32
    <li><a href="#index_w"><span>w</span></a></li>
33
    <li><a href="#index_x"><span>x</span></a></li>
34
  </ul>
35
</div>
36

  
37
<p>
39
<div class="contents">
38 40
&nbsp;
39 41
<p>
40 42
<h3><a class="anchor" name="index_s">- s -</a></h3><ul>
......
61 63
, <a class="el" href="group__sensormatrix.html#gf251d97aeb23af9156c0527692819da7">sensor_matrix.c</a>
62 64
</ul>
63 65
<h3><a class="anchor" name="index_w">- w -</a></h3><ul>
66
<li>wl_basic_init()
67
: <a class="el" href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf">wl_basic.c</a>
68
, <a class="el" href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf">wl_basic.h</a>
69
<li>wl_basic_register_handler()
70
: <a class="el" href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic.h</a>
71
, <a class="el" href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic.c</a>
72
<li>wl_basic_send_global_packet()
73
: <a class="el" href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic.c</a>
74
, <a class="el" href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic.h</a>
75
<li>wl_basic_send_robot_packet()
76
: <a class="el" href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic.h</a>
77
, <a class="el" href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic.c</a>
64 78
<li>wl_do()
65 79
: <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703">wireless.c</a>
66 80
, <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703">wireless.h</a>
......
107 121
: <a class="el" href="group__wireless.html#g754445d2353a70963a489651cff554c1">wireless.c</a>
108 122
, <a class="el" href="group__wireless.html#g754445d2353a70963a489651cff554c1">wireless.h</a>
109 123
<li>wl_terminate()
110
: <a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wireless.c</a>
111
, <a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wireless.h</a>
124
: <a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wireless.h</a>
125
, <a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wireless.c</a>
112 126
<li>wl_token_get_matrix_size()
113 127
: <a class="el" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_ring.c</a>
114 128
, <a class="el" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_ring.h</a>
......
131 145
: <a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_ring.h</a>
132 146
, <a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_ring.c</a>
133 147
<li>wl_token_iterator_has_next()
134
: <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_ring.c</a>
135
, <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_ring.h</a>
148
: <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_ring.h</a>
149
, <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_ring.c</a>
136 150
<li>wl_token_iterator_next()
137 151
: <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_ring.c</a>
138 152
, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_ring.h</a>
......
146 160
: <a class="el" href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44">wl_token_ring.c</a>
147 161
, <a class="el" href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44">wl_token_ring.h</a>
148 162
<li>wl_token_ring_set_bom_functions()
149
: <a class="el" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring.h</a>
150
, <a class="el" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring.c</a>
163
: <a class="el" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring.c</a>
164
, <a class="el" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring.h</a>
151 165
<li>wl_token_ring_unregister()
152 166
: <a class="el" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring.c</a>
153 167
, <a class="el" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring.h</a>
154 168
<li>wl_unregister_packet_group()
155
: <a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wireless.h</a>
156
, <a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wireless.c</a>
169
: <a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wireless.c</a>
170
, <a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wireless.h</a>
157 171
</ul>
158 172
<h3><a class="anchor" name="index_x">- x -</a></h3><ul>
159 173
<li>xbee_get_address()
......
187 201
: <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.h</a>
188 202
, <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.c</a>
189 203
</ul>
190
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
204
</div>
205
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:46 2009 for libwireless by&nbsp;
191 206
<a href="http://www.doxygen.org/index.html">
192
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
207
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
193 208
</body>
194 209
</html>
trunk/docs/libwireless/xbee_8h_source.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>libwireless: xbee.h Source File</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.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
<h1>xbee.h</h1><a href="xbee_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
24
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef XBEE_H</span>
25
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_H</span>
26
<a name="l00040"></a>00040 <span class="preprocessor"></span>
27
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef ROBOT</span>
28
<a name="l00046"></a><a class="code" href="xbee_8h.html#fd0466c206d7e1f82ee407d114468e96">00046</a> <span class="preprocessor"></span><span class="preprocessor">#define XBEE_PORT_DEFAULT "/dev/ttyUSB1"</span>
29
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
30
<a name="l00048"></a>00048 <span class="preprocessor"></span>
31
<a name="l00058"></a>00058 <span class="comment">/*Definitions*/</span>
32
<a name="l00060"></a><a class="code" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">00060</a> <span class="preprocessor">#define XBEE_PAN_DEFAULT 0xFFFF</span>
33
<a name="l00061"></a>00061 <span class="preprocessor"></span>
34
<a name="l00062"></a><a class="code" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">00062</a> <span class="preprocessor">#define XBEE_CHANNEL_DEFAULT 0</span>
35
<a name="l00063"></a>00063 <span class="preprocessor"></span>
36
<a name="l00064"></a><a class="code" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">00064</a> <span class="preprocessor">#define XBEE_BROADCAST 0xFFFF</span>
37
<a name="l00065"></a>00065 <span class="preprocessor"></span>
38
<a name="l00066"></a><a class="code" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">00066</a> <span class="preprocessor">#define XBEE_OPTIONS_NONE 0x00</span>
39
<a name="l00067"></a>00067 <span class="preprocessor"></span>
40
<a name="l00068"></a><a class="code" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">00068</a> <span class="preprocessor">#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01</span>
41
<a name="l00069"></a>00069 <span class="preprocessor"></span>
42
<a name="l00070"></a><a class="code" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">00070</a> <span class="preprocessor">#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04</span>
43
<a name="l00071"></a>00071 <span class="preprocessor"></span>
44
<a name="l00072"></a><a class="code" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">00072</a> <span class="preprocessor">#define XBEE_TX_STATUS 0x89</span>
45
<a name="l00073"></a>00073 <span class="preprocessor"></span>
46
<a name="l00074"></a><a class="code" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">00074</a> <span class="preprocessor">#define XBEE_RX 0x81</span>
47
<a name="l00075"></a>00075 <span class="preprocessor"></span>
48
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af" title="Initialize the XBee library.">xbee_lib_init</a>(<span class="keywordtype">void</span>);
49
<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a" title="Uninitialize the XBee library.">xbee_terminate</a>(<span class="keywordtype">void</span>);
50
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d" title="Get a packet from the XBee.">xbee_get_packet</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet);
51
<a name="l00083"></a>00083 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c" title="Send a packet to the XBee.">xbee_send_packet</a>(<span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, <span class="keywordtype">char</span> options, <span class="keywordtype">char</span> frame);
52
<a name="l00085"></a>00085 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b" title="Set the PAN ID for the XBee.">xbee_set_pan_id</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>);
53
<a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052" title="Get the XBee&amp;#39;s PAN ID.">xbee_get_pan_id</a>(<span class="keywordtype">void</span>);
54
<a name="l00089"></a>00089 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a>(<span class="keywordtype">int</span> channel);
55
<a name="l00091"></a>00091 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a>(<span class="keywordtype">void</span>);
56
<a name="l00093"></a>00093 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309" title="Get the XBee&amp;#39;s 16-bit address.">xbee_get_address</a>(<span class="keywordtype">void</span>);
57
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a" title="Set the com port on a computer, undefined on the robot.">xbee_set_com_port</a>(<span class="keywordtype">char</span>* port);
58
<a name="l00096"></a>00096  <span class="comment">//end defgroup</span>
59
<a name="l00098"></a>00098 
60
<a name="l00099"></a>00099 <span class="preprocessor">#endif</span>
61
</pre></div></div>
62
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
63
<a href="http://www.doxygen.org/index.html">
64
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
65
</body>
66
</html>
trunk/docs/libwireless/structSensorMatrix.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: SensorMatrix Struct Reference</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff