Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / group__wireless.html @ 241

History | View | Annotate | Download (27.3 KB)

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>libwireless: Wireless</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.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>
15
</div>
16
<h1>Wireless</h1>Wireless definitions.  
17
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
18
<tr><td></td></tr>
19
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
20
<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>
21

    
22
<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>
23

    
24
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
25
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g629ceefdf83847af356d90e2df27041c">wl_init</a> (void)</td></tr>
26

    
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the wireless library.  <a href="#g629ceefdf83847af356d90e2df27041c"></a><br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a> (void)</td></tr>
29

    
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the wireless library.  <a href="#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr>
31
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703">wl_do</a> (void)</td></tr>
32

    
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform wireless library functionality.  <a href="#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr>
35

    
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a packet group with the wireless library.  <a href="#g183343ed0594ec1c2b79bb4085d57107"></a><br></td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr>
38

    
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister a packet group with the wireless library.  <a href="#gcdbedf6465798abc7af3bf5fea3d4dd7"></a><br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga7175b13dbfc0b11b341fbe0ad7c637c">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>
41

    
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to a specific robot in any PAN.  <a href="#ga7175b13dbfc0b11b341fbe0ad7c637c"></a><br></td></tr>
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gafaca74445d215cef2b2e0ae1a1c72ba">wl_send_robot_to_robot_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>
44

    
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to a specific robot in our PAN.  <a href="#gafaca74445d215cef2b2e0ae1a1c72ba"></a><br></td></tr>
46
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gdd534c99c49d5207fe09f02af304c1ad">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>
47

    
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to all robots.  <a href="#gdd534c99c49d5207fe09f02af304c1ad"></a><br></td></tr>
49
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>
50

    
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to all robots in our PAN.  <a href="#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr>
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542">wl_set_pan</a> (int pan)</td></tr>
53

    
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN we are using.  <a href="#g211ccf907dce4493813573e20264e542"></a><br></td></tr>
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr>
56

    
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the PAN we are using.  <a href="#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba">wl_set_channel</a> (int channel)</td></tr>
59

    
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel we are using.  <a href="#g9aac809e57c9eb93a2905ed544c93aba"></a><br></td></tr>
61
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr>
62

    
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel we are using.  <a href="#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr>
64
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f">wl_get_xbee_id</a> (void)</td></tr>
65

    
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the 16-bit address of the XBee module.  <a href="#g90cb41c855ac3da028e8f1278bd49f4f"></a><br></td></tr>
67
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless::wl_set_com_port" ref="g344dead0023100eb40f8670a92c9ce5c" args="(char *port)" -->
68
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr>
69

    
70
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr>
71
</table>
72
<hr><a name="_details"></a><h2>Detailed Description</h2>
73
Wireless definitions. 
74
<p>
75
Contains functions and definitions for dealing with wireless functionality.<br>
76
<br>
77
<p>
78
The wireless library provides a modular method for dealing with wireless packets, by allowing packet groups to be registered. A packet group is a collection of packets which share a packet group code. Each packet in the group also has a type. A packet group code and type are sent with each packet. When a packet with a group code registered in the wireless library is received, the corresponding event handler is called. The event handler uses the packet type and other information stored in the packet to respond.<br>
79
<br>
80
<p>
81
This architecture allows different wireless functionality to be defined and handled separately, making it simpler and more efficient to take advantage of the XBee's wireless functionality. <hr><h2>Function Documentation</h2>
82
<a class="anchor" name="g5c1f1a0e20fc718e59edc29246afd703"></a><!-- doxytag: member="wireless.h::wl_do" ref="g5c1f1a0e20fc718e59edc29246afd703" args="(void)" -->
83
<div class="memitem">
84
<div class="memproto">
85
      <table class="memname">
86
        <tr>
87
          <td class="memname">void wl_do           </td>
88
          <td>(</td>
89
          <td class="paramtype">void&nbsp;</td>
90
          <td class="paramname">          </td>
91
          <td>&nbsp;)&nbsp;</td>
92
          <td width="100%"></td>
93
        </tr>
94
      </table>
95
</div>
96
<div class="memdoc">
97

    
98
<p>
99
Perform wireless library functionality. 
100
<p>
101
Performs wireless library functionality. This function must be called frequently for wireless to perform effectively. This function will call timeout handlers, as well as received packet and transmit status handlers. 
102
</div>
103
</div><p>
104
<a class="anchor" name="g2d65d3e35b193da4213755c4bf61ab6b"></a><!-- doxytag: member="wireless.h::wl_get_channel" ref="g2d65d3e35b193da4213755c4bf61ab6b" args="(void)" -->
105
<div class="memitem">
106
<div class="memproto">
107
      <table class="memname">
108
        <tr>
109
          <td class="memname">int wl_get_channel           </td>
110
          <td>(</td>
111
          <td class="paramtype">void&nbsp;</td>
112
          <td class="paramname">          </td>
113
          <td>&nbsp;)&nbsp;</td>
114
          <td width="100%"></td>
115
        </tr>
116
      </table>
117
</div>
118
<div class="memdoc">
119

    
120
<p>
121
Get the channel we are using. 
122
<p>
123
Get the channel the XBee is part of.<p>
124
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is part of</dd></dl>
125
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba" title="Set the channel we are using.">wl_set_channel</a> </dd></dl>
126

    
127
</div>
128
</div><p>
129
<a class="anchor" name="g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><!-- doxytag: member="wireless.h::wl_get_pan" ref="g4e6b5c97d40a8e7557a1b4b90a7d34f7" args="(void)" -->
130
<div class="memitem">
131
<div class="memproto">
132
      <table class="memname">
133
        <tr>
134
          <td class="memname">int wl_get_pan           </td>
135
          <td>(</td>
136
          <td class="paramtype">void&nbsp;</td>
137
          <td class="paramname">          </td>
138
          <td>&nbsp;)&nbsp;</td>
139
          <td width="100%"></td>
140
        </tr>
141
      </table>
142
</div>
143
<div class="memdoc">
144

    
145
<p>
146
Get the PAN we are using. 
147
<p>
148
Get the PAN the XBee is currently part of.<p>
149
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the PAN of the XBee</dd></dl>
150
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542" title="Set the PAN we are using.">wl_set_pan</a> </dd></dl>
151

    
152
</div>
153
</div><p>
154
<a class="anchor" name="g90cb41c855ac3da028e8f1278bd49f4f"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="g90cb41c855ac3da028e8f1278bd49f4f" args="(void)" -->
155
<div class="memitem">
156
<div class="memproto">
157
      <table class="memname">
158
        <tr>
159
          <td class="memname">unsigned int wl_get_xbee_id           </td>
160
          <td>(</td>
161
          <td class="paramtype">void&nbsp;</td>
162
          <td class="paramname">          </td>
163
          <td>&nbsp;)&nbsp;</td>
164
          <td width="100%"></td>
165
        </tr>
166
      </table>
167
</div>
168
<div class="memdoc">
169

    
170
<p>
171
Get the 16-bit address of the XBee module. 
172
<p>
173
Returns the 16-bit address of the XBee module.<p>
174
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee module. </dd></dl>
175

    
176
</div>
177
</div><p>
178
<a class="anchor" name="g629ceefdf83847af356d90e2df27041c"></a><!-- doxytag: member="wireless.h::wl_init" ref="g629ceefdf83847af356d90e2df27041c" args="(void)" -->
179
<div class="memitem">
180
<div class="memproto">
181
      <table class="memname">
182
        <tr>
183
          <td class="memname">void wl_init           </td>
184
          <td>(</td>
185
          <td class="paramtype">void&nbsp;</td>
186
          <td class="paramname">          </td>
187
          <td>&nbsp;)&nbsp;</td>
188
          <td width="100%"></td>
189
        </tr>
190
      </table>
191
</div>
192
<div class="memdoc">
193

    
194
<p>
195
Initialize the wireless library. 
196
<p>
197
Initializes the wireless library. Must be called before any other function. 
198
</div>
199
</div><p>
200
<a class="anchor" name="g183343ed0594ec1c2b79bb4085d57107"></a><!-- doxytag: member="wireless.h::wl_register_packet_group" ref="g183343ed0594ec1c2b79bb4085d57107" args="(PacketGroupHandler *h)" -->
201
<div class="memitem">
202
<div class="memproto">
203
      <table class="memname">
204
        <tr>
205
          <td class="memname">void wl_register_packet_group           </td>
206
          <td>(</td>
207
          <td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *&nbsp;</td>
208
          <td class="paramname"> <em>h</em>          </td>
209
          <td>&nbsp;)&nbsp;</td>
210
          <td width="100%"></td>
211
        </tr>
212
      </table>
213
</div>
214
<div class="memdoc">
215

    
216
<p>
217
Register a packet group with the wireless library. 
218
<p>
219
Register a packet group with the wireless library. The event handlers in the packet group will be called whenever an event dealing with the packet group's group code occurs.<p>
220
<dl compact><dt><b>Parameters:</b></dt><dd>
221
  <table border="0" cellspacing="2" cellpadding="0">
222
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>the <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> to register </td></tr>
223
  </table>
224
</dl>
225

    
226
</div>
227
</div><p>
228
<a class="anchor" name="gdd534c99c49d5207fe09f02af304c1ad"></a><!-- doxytag: member="wireless.h::wl_send_global_packet" ref="gdd534c99c49d5207fe09f02af304c1ad" args="(char group, char type, char *data, int len, char frame)" -->
229
<div class="memitem">
230
<div class="memproto">
231
      <table class="memname">
232
        <tr>
233
          <td class="memname">void wl_send_global_packet           </td>
234
          <td>(</td>
235
          <td class="paramtype">char&nbsp;</td>
236
          <td class="paramname"> <em>group</em>, </td>
237
        </tr>
238
        <tr>
239
          <td class="paramkey"></td>
240
          <td></td>
241
          <td class="paramtype">char&nbsp;</td>
242
          <td class="paramname"> <em>type</em>, </td>
243
        </tr>
244
        <tr>
245
          <td class="paramkey"></td>
246
          <td></td>
247
          <td class="paramtype">char *&nbsp;</td>
248
          <td class="paramname"> <em>data</em>, </td>
249
        </tr>
250
        <tr>
251
          <td class="paramkey"></td>
252
          <td></td>
253
          <td class="paramtype">int&nbsp;</td>
254
          <td class="paramname"> <em>len</em>, </td>
255
        </tr>
256
        <tr>
257
          <td class="paramkey"></td>
258
          <td></td>
259
          <td class="paramtype">char&nbsp;</td>
260
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
261
        </tr>
262
        <tr>
263
          <td></td>
264
          <td>)</td>
265
          <td></td><td></td><td width="100%"></td>
266
        </tr>
267
      </table>
268
</div>
269
<div class="memdoc">
270

    
271
<p>
272
Send a packet to all robots. 
273
<p>
274
Send a packet to all XBees in all PANs.<p>
275
<dl compact><dt><b>Parameters:</b></dt><dd>
276
  <table border="0" cellspacing="2" cellpadding="0">
277
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
278
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
279
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
280
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
281
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
282
  </table>
283
</dl>
284

    
285
</div>
286
</div><p>
287
<a class="anchor" name="g0a1a0e4d885f0e0dde87160a16daa0aa"></a><!-- doxytag: member="wireless.h::wl_send_pan_packet" ref="g0a1a0e4d885f0e0dde87160a16daa0aa" args="(char group, char type, char *data, int len, char frame)" -->
288
<div class="memitem">
289
<div class="memproto">
290
      <table class="memname">
291
        <tr>
292
          <td class="memname">void wl_send_pan_packet           </td>
293
          <td>(</td>
294
          <td class="paramtype">char&nbsp;</td>
295
          <td class="paramname"> <em>group</em>, </td>
296
        </tr>
297
        <tr>
298
          <td class="paramkey"></td>
299
          <td></td>
300
          <td class="paramtype">char&nbsp;</td>
301
          <td class="paramname"> <em>type</em>, </td>
302
        </tr>
303
        <tr>
304
          <td class="paramkey"></td>
305
          <td></td>
306
          <td class="paramtype">char *&nbsp;</td>
307
          <td class="paramname"> <em>data</em>, </td>
308
        </tr>
309
        <tr>
310
          <td class="paramkey"></td>
311
          <td></td>
312
          <td class="paramtype">int&nbsp;</td>
313
          <td class="paramname"> <em>len</em>, </td>
314
        </tr>
315
        <tr>
316
          <td class="paramkey"></td>
317
          <td></td>
318
          <td class="paramtype">char&nbsp;</td>
319
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
320
        </tr>
321
        <tr>
322
          <td></td>
323
          <td>)</td>
324
          <td></td><td></td><td width="100%"></td>
325
        </tr>
326
      </table>
327
</div>
328
<div class="memdoc">
329

    
330
<p>
331
Send a packet to all robots in our PAN. 
332
<p>
333
Send a packet to all XBee's in the same PAN.<p>
334
<dl compact><dt><b>Parameters:</b></dt><dd>
335
  <table border="0" cellspacing="2" cellpadding="0">
336
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
337
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
338
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
339
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
340
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
341
  </table>
342
</dl>
343

    
344
</div>
345
</div><p>
346
<a class="anchor" name="ga7175b13dbfc0b11b341fbe0ad7c637c"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_global_packet" ref="ga7175b13dbfc0b11b341fbe0ad7c637c" args="(char group, char type, char *data, int len, int dest, char frame)" -->
347
<div class="memitem">
348
<div class="memproto">
349
      <table class="memname">
350
        <tr>
351
          <td class="memname">void wl_send_robot_to_robot_global_packet           </td>
352
          <td>(</td>
353
          <td class="paramtype">char&nbsp;</td>
354
          <td class="paramname"> <em>group</em>, </td>
355
        </tr>
356
        <tr>
357
          <td class="paramkey"></td>
358
          <td></td>
359
          <td class="paramtype">char&nbsp;</td>
360
          <td class="paramname"> <em>type</em>, </td>
361
        </tr>
362
        <tr>
363
          <td class="paramkey"></td>
364
          <td></td>
365
          <td class="paramtype">char *&nbsp;</td>
366
          <td class="paramname"> <em>data</em>, </td>
367
        </tr>
368
        <tr>
369
          <td class="paramkey"></td>
370
          <td></td>
371
          <td class="paramtype">int&nbsp;</td>
372
          <td class="paramname"> <em>len</em>, </td>
373
        </tr>
374
        <tr>
375
          <td class="paramkey"></td>
376
          <td></td>
377
          <td class="paramtype">int&nbsp;</td>
378
          <td class="paramname"> <em>dest</em>, </td>
379
        </tr>
380
        <tr>
381
          <td class="paramkey"></td>
382
          <td></td>
383
          <td class="paramtype">char&nbsp;</td>
384
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
385
        </tr>
386
        <tr>
387
          <td></td>
388
          <td>)</td>
389
          <td></td><td></td><td width="100%"></td>
390
        </tr>
391
      </table>
392
</div>
393
<div class="memdoc">
394

    
395
<p>
396
Send a packet to a specific robot in any PAN. 
397
<p>
398
Send a packet to a specific XBee without specifying a PAN.<p>
399
<dl compact><dt><b>Parameters:</b></dt><dd>
400
  <table border="0" cellspacing="2" cellpadding="0">
401
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
402
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
403
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
404
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
405
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>the 16-bit address of the XBee to send the packet to </td></tr>
406
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
407
  </table>
408
</dl>
409

    
410
</div>
411
</div><p>
412
<a class="anchor" name="gafaca74445d215cef2b2e0ae1a1c72ba"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_packet" ref="gafaca74445d215cef2b2e0ae1a1c72ba" args="(char group, char type, char *data, int len, int dest, char frame)" -->
413
<div class="memitem">
414
<div class="memproto">
415
      <table class="memname">
416
        <tr>
417
          <td class="memname">void wl_send_robot_to_robot_packet           </td>
418
          <td>(</td>
419
          <td class="paramtype">char&nbsp;</td>
420
          <td class="paramname"> <em>group</em>, </td>
421
        </tr>
422
        <tr>
423
          <td class="paramkey"></td>
424
          <td></td>
425
          <td class="paramtype">char&nbsp;</td>
426
          <td class="paramname"> <em>type</em>, </td>
427
        </tr>
428
        <tr>
429
          <td class="paramkey"></td>
430
          <td></td>
431
          <td class="paramtype">char *&nbsp;</td>
432
          <td class="paramname"> <em>data</em>, </td>
433
        </tr>
434
        <tr>
435
          <td class="paramkey"></td>
436
          <td></td>
437
          <td class="paramtype">int&nbsp;</td>
438
          <td class="paramname"> <em>len</em>, </td>
439
        </tr>
440
        <tr>
441
          <td class="paramkey"></td>
442
          <td></td>
443
          <td class="paramtype">int&nbsp;</td>
444
          <td class="paramname"> <em>dest</em>, </td>
445
        </tr>
446
        <tr>
447
          <td class="paramkey"></td>
448
          <td></td>
449
          <td class="paramtype">char&nbsp;</td>
450
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
451
        </tr>
452
        <tr>
453
          <td></td>
454
          <td>)</td>
455
          <td></td><td></td><td width="100%"></td>
456
        </tr>
457
      </table>
458
</div>
459
<div class="memdoc">
460

    
461
<p>
462
Send a packet to a specific robot in our PAN. 
463
<p>
464
Send a packet to a specific XBee in the same PAN.<p>
465
<dl compact><dt><b>Parameters:</b></dt><dd>
466
  <table border="0" cellspacing="2" cellpadding="0">
467
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group </td></tr>
468
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
469
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the packet data </td></tr>
470
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the packet length in bytes </td></tr>
471
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>the 16-bit address of the XBee to send the packet to </td></tr>
472
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to see with a TX_STATUS response </td></tr>
473
  </table>
474
</dl>
475

    
476
</div>
477
</div><p>
478
<a class="anchor" name="g9aac809e57c9eb93a2905ed544c93aba"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="g9aac809e57c9eb93a2905ed544c93aba" args="(int channel)" -->
479
<div class="memitem">
480
<div class="memproto">
481
      <table class="memname">
482
        <tr>
483
          <td class="memname">void wl_set_channel           </td>
484
          <td>(</td>
485
          <td class="paramtype">int&nbsp;</td>
486
          <td class="paramname"> <em>channel</em>          </td>
487
          <td>&nbsp;)&nbsp;</td>
488
          <td width="100%"></td>
489
        </tr>
490
      </table>
491
</div>
492
<div class="memdoc">
493

    
494
<p>
495
Set the channel we are using. 
496
<p>
497
Set the channel the XBee is listening to.<p>
498
<dl compact><dt><b>Parameters:</b></dt><dd>
499
  <table border="0" cellspacing="2" cellpadding="0">
500
    <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>the new channel to join</td></tr>
501
  </table>
502
</dl>
503
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a> </dd></dl>
504

    
505
</div>
506
</div><p>
507
<a class="anchor" name="g211ccf907dce4493813573e20264e542"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="g211ccf907dce4493813573e20264e542" args="(int pan)" -->
508
<div class="memitem">
509
<div class="memproto">
510
      <table class="memname">
511
        <tr>
512
          <td class="memname">void wl_set_pan           </td>
513
          <td>(</td>
514
          <td class="paramtype">int&nbsp;</td>
515
          <td class="paramname"> <em>pan</em>          </td>
516
          <td>&nbsp;)&nbsp;</td>
517
          <td width="100%"></td>
518
        </tr>
519
      </table>
520
</div>
521
<div class="memdoc">
522

    
523
<p>
524
Set the PAN we are using. 
525
<p>
526
Set the PAN for the XBee to join.<p>
527
<dl compact><dt><b>Parameters:</b></dt><dd>
528
  <table border="0" cellspacing="2" cellpadding="0">
529
    <tr><td valign="top"></td><td valign="top"><em>pan</em>&nbsp;</td><td>the new PAN</td></tr>
530
  </table>
531
</dl>
532
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a> </dd></dl>
533

    
534
</div>
535
</div><p>
536
<a class="anchor" name="g66075ff87a1c9f2c0d7938a26c7830f2"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="g66075ff87a1c9f2c0d7938a26c7830f2" args="(void)" -->
537
<div class="memitem">
538
<div class="memproto">
539
      <table class="memname">
540
        <tr>
541
          <td class="memname">void wl_terminate           </td>
542
          <td>(</td>
543
          <td class="paramtype">void&nbsp;</td>
544
          <td class="paramname">          </td>
545
          <td>&nbsp;)&nbsp;</td>
546
          <td width="100%"></td>
547
        </tr>
548
      </table>
549
</div>
550
<div class="memdoc">
551

    
552
<p>
553
Uninitialize the wireless library. 
554
<p>
555
Uninitializes the wireless library. 
556
</div>
557
</div><p>
558
<a class="anchor" name="gcdbedf6465798abc7af3bf5fea3d4dd7"></a><!-- doxytag: member="wireless.h::wl_unregister_packet_group" ref="gcdbedf6465798abc7af3bf5fea3d4dd7" args="(PacketGroupHandler *h)" -->
559
<div class="memitem">
560
<div class="memproto">
561
      <table class="memname">
562
        <tr>
563
          <td class="memname">void wl_unregister_packet_group           </td>
564
          <td>(</td>
565
          <td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *&nbsp;</td>
566
          <td class="paramname"> <em>h</em>          </td>
567
          <td>&nbsp;)&nbsp;</td>
568
          <td width="100%"></td>
569
        </tr>
570
      </table>
571
</div>
572
<div class="memdoc">
573

    
574
<p>
575
Unregister a packet group with the wireless library. 
576
<p>
577
Unregister a packet group from the wireless library.<p>
578
<dl compact><dt><b>Parameters:</b></dt><dd>
579
  <table border="0" cellspacing="2" cellpadding="0">
580
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>the packet group to remove </td></tr>
581
  </table>
582
</dl>
583

    
584
</div>
585
</div><p>
586
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 22:16:24 2007 for libwireless by&nbsp;
587
<a href="http://www.doxygen.org/index.html">
588
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
589
</body>
590
</html>