root / trunk / docs / libwireless / group__wireless.html @ 60
History | View | Annotate | Download (30.8 KB)
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
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.4.6 -->
|
8 |
<div class="tabs"> |
9 |
<ul>
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
13 |
<li><a href="files.html"><span>Files</span></a></li> |
14 |
</ul></div> |
15 |
<h1>Wireless</h1>Wireless definitions. |
16 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
17 |
<tr><td></td></tr> |
18 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
19 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr> |
20 |
|
21 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr> |
22 |
|
23 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g629ceefdf83847af356d90e2df27041c">wl_init</a> (void)</td></tr> |
25 |
|
26 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="#g629ceefdf83847af356d90e2df27041c"></a><br></td></tr> |
27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a> (void)</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr> |
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703">wl_do</a> (void)</td></tr> |
31 |
|
32 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr> |
33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
34 |
|
35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a packet group with the wireless library. <a href="#g183343ed0594ec1c2b79bb4085d57107"></a><br></td></tr> |
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
37 |
|
38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a packet group with the wireless library. <a href="#gcdbedf6465798abc7af3bf5fea3d4dd7"></a><br></td></tr> |
39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
40 |
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="#ga7175b13dbfc0b11b341fbe0ad7c637c"></a><br></td></tr> |
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
43 |
|
44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="#gafaca74445d215cef2b2e0ae1a1c72ba"></a><br></td></tr> |
45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
46 |
|
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="#gdd534c99c49d5207fe09f02af304c1ad"></a><br></td></tr> |
48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
49 |
|
50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots in our PAN. <a href="#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr> |
51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542">wl_set_pan</a> (int pan)</td></tr> |
52 |
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="#g211ccf907dce4493813573e20264e542"></a><br></td></tr> |
54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr> |
55 |
|
56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr> |
57 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba">wl_set_channel</a> (int channel)</td></tr> |
58 |
|
59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="#g9aac809e57c9eb93a2905ed544c93aba"></a><br></td></tr> |
60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr> |
61 |
|
62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr> |
63 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f">wl_get_xbee_id</a> (void)</td></tr> |
64 |
|
65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="#g90cb41c855ac3da028e8f1278bd49f4f"></a><br></td></tr> |
66 |
</table>
|
67 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
68 |
Wireless definitions. |
69 |
<p>
|
70 |
Contains functions and definitions for dealing with wireless functionality.<br>
|
71 |
<br>
|
72 |
<p>
|
73 |
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>
|
74 |
<br>
|
75 |
<p>
|
76 |
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> |
77 |
<a class="anchor" name="g5c1f1a0e20fc718e59edc29246afd703"></a><!-- doxytag: member="wireless.h::wl_do" ref="g5c1f1a0e20fc718e59edc29246afd703" args="(void)" --><p> |
78 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
79 |
<tr>
|
80 |
<td class="mdRow"> |
81 |
<table cellpadding="0" cellspacing="0" border="0"> |
82 |
<tr>
|
83 |
<td class="md" nowrap valign="top">void wl_do </td> |
84 |
<td class="md" valign="top">( </td> |
85 |
<td class="md" nowrap valign="top">void </td> |
86 |
<td class="mdname1" valign="top" nowrap> </td> |
87 |
<td class="md" valign="top"> ) </td> |
88 |
<td class="md" nowrap></td> |
89 |
</tr>
|
90 |
</table>
|
91 |
</td>
|
92 |
</tr>
|
93 |
</table>
|
94 |
<table cellspacing="5" cellpadding="0" border="0"> |
95 |
<tr>
|
96 |
<td>
|
97 |
|
98 |
</td>
|
99 |
<td>
|
100 |
|
101 |
<p>
|
102 |
Perform wireless library functionality. |
103 |
<p>
|
104 |
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. </td>
|
105 |
</tr>
|
106 |
</table>
|
107 |
<a class="anchor" name="g2d65d3e35b193da4213755c4bf61ab6b"></a><!-- doxytag: member="wireless.h::wl_get_channel" ref="g2d65d3e35b193da4213755c4bf61ab6b" args="(void)" --><p> |
108 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
109 |
<tr>
|
110 |
<td class="mdRow"> |
111 |
<table cellpadding="0" cellspacing="0" border="0"> |
112 |
<tr>
|
113 |
<td class="md" nowrap valign="top">int wl_get_channel </td> |
114 |
<td class="md" valign="top">( </td> |
115 |
<td class="md" nowrap valign="top">void </td> |
116 |
<td class="mdname1" valign="top" nowrap> </td> |
117 |
<td class="md" valign="top"> ) </td> |
118 |
<td class="md" nowrap></td> |
119 |
</tr>
|
120 |
</table>
|
121 |
</td>
|
122 |
</tr>
|
123 |
</table>
|
124 |
<table cellspacing="5" cellpadding="0" border="0"> |
125 |
<tr>
|
126 |
<td>
|
127 |
|
128 |
</td>
|
129 |
<td>
|
130 |
|
131 |
<p>
|
132 |
Get the channel we are using. |
133 |
<p>
|
134 |
Get the channel the XBee is part of.<p>
|
135 |
<dl compact><dt><b>Returns:</b></dt><dd>the channel the XBee is part of</dd></dl> |
136 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba">wl_set_channel</a> </dd></dl> |
137 |
</td>
|
138 |
</tr>
|
139 |
</table>
|
140 |
<a class="anchor" name="g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><!-- doxytag: member="wireless.h::wl_get_pan" ref="g4e6b5c97d40a8e7557a1b4b90a7d34f7" args="(void)" --><p> |
141 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
142 |
<tr>
|
143 |
<td class="mdRow"> |
144 |
<table cellpadding="0" cellspacing="0" border="0"> |
145 |
<tr>
|
146 |
<td class="md" nowrap valign="top">int wl_get_pan </td> |
147 |
<td class="md" valign="top">( </td> |
148 |
<td class="md" nowrap valign="top">void </td> |
149 |
<td class="mdname1" valign="top" nowrap> </td> |
150 |
<td class="md" valign="top"> ) </td> |
151 |
<td class="md" nowrap></td> |
152 |
</tr>
|
153 |
</table>
|
154 |
</td>
|
155 |
</tr>
|
156 |
</table>
|
157 |
<table cellspacing="5" cellpadding="0" border="0"> |
158 |
<tr>
|
159 |
<td>
|
160 |
|
161 |
</td>
|
162 |
<td>
|
163 |
|
164 |
<p>
|
165 |
Get the PAN we are using. |
166 |
<p>
|
167 |
Get the PAN the XBee is currently part of.<p>
|
168 |
<dl compact><dt><b>Returns:</b></dt><dd>the PAN of the XBee</dd></dl> |
169 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542">wl_set_pan</a> </dd></dl> |
170 |
</td>
|
171 |
</tr>
|
172 |
</table>
|
173 |
<a class="anchor" name="g90cb41c855ac3da028e8f1278bd49f4f"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="g90cb41c855ac3da028e8f1278bd49f4f" args="(void)" --><p> |
174 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
175 |
<tr>
|
176 |
<td class="mdRow"> |
177 |
<table cellpadding="0" cellspacing="0" border="0"> |
178 |
<tr>
|
179 |
<td class="md" nowrap valign="top">unsigned int wl_get_xbee_id </td> |
180 |
<td class="md" valign="top">( </td> |
181 |
<td class="md" nowrap valign="top">void </td> |
182 |
<td class="mdname1" valign="top" nowrap> </td> |
183 |
<td class="md" valign="top"> ) </td> |
184 |
<td class="md" nowrap></td> |
185 |
</tr>
|
186 |
</table>
|
187 |
</td>
|
188 |
</tr>
|
189 |
</table>
|
190 |
<table cellspacing="5" cellpadding="0" border="0"> |
191 |
<tr>
|
192 |
<td>
|
193 |
|
194 |
</td>
|
195 |
<td>
|
196 |
|
197 |
<p>
|
198 |
Get the 16-bit address of the XBee module. |
199 |
<p>
|
200 |
Returns the 16-bit address of the XBee module.<p>
|
201 |
<dl compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee module. </dd></dl> |
202 |
</td>
|
203 |
</tr>
|
204 |
</table>
|
205 |
<a class="anchor" name="g629ceefdf83847af356d90e2df27041c"></a><!-- doxytag: member="wireless.h::wl_init" ref="g629ceefdf83847af356d90e2df27041c" args="(void)" --><p> |
206 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
207 |
<tr>
|
208 |
<td class="mdRow"> |
209 |
<table cellpadding="0" cellspacing="0" border="0"> |
210 |
<tr>
|
211 |
<td class="md" nowrap valign="top">void wl_init </td> |
212 |
<td class="md" valign="top">( </td> |
213 |
<td class="md" nowrap valign="top">void </td> |
214 |
<td class="mdname1" valign="top" nowrap> </td> |
215 |
<td class="md" valign="top"> ) </td> |
216 |
<td class="md" nowrap></td> |
217 |
</tr>
|
218 |
</table>
|
219 |
</td>
|
220 |
</tr>
|
221 |
</table>
|
222 |
<table cellspacing="5" cellpadding="0" border="0"> |
223 |
<tr>
|
224 |
<td>
|
225 |
|
226 |
</td>
|
227 |
<td>
|
228 |
|
229 |
<p>
|
230 |
Initialize the wireless library. |
231 |
<p>
|
232 |
Initializes the wireless library. Must be called before any other function. </td>
|
233 |
</tr>
|
234 |
</table>
|
235 |
<a class="anchor" name="g183343ed0594ec1c2b79bb4085d57107"></a><!-- doxytag: member="wireless.h::wl_register_packet_group" ref="g183343ed0594ec1c2b79bb4085d57107" args="(PacketGroupHandler *h)" --><p> |
236 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
237 |
<tr>
|
238 |
<td class="mdRow"> |
239 |
<table cellpadding="0" cellspacing="0" border="0"> |
240 |
<tr>
|
241 |
<td class="md" nowrap valign="top">void wl_register_packet_group </td> |
242 |
<td class="md" valign="top">( </td> |
243 |
<td class="md" nowrap valign="top"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> * </td> |
244 |
<td class="mdname1" valign="top" nowrap> <em>h</em> </td> |
245 |
<td class="md" valign="top"> ) </td> |
246 |
<td class="md" nowrap></td> |
247 |
</tr>
|
248 |
</table>
|
249 |
</td>
|
250 |
</tr>
|
251 |
</table>
|
252 |
<table cellspacing="5" cellpadding="0" border="0"> |
253 |
<tr>
|
254 |
<td>
|
255 |
|
256 |
</td>
|
257 |
<td>
|
258 |
|
259 |
<p>
|
260 |
Register a packet group with the wireless library. |
261 |
<p>
|
262 |
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>
|
263 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
264 |
<table border="0" cellspacing="2" cellpadding="0"> |
265 |
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>the <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> to register </td></tr> |
266 |
</table>
|
267 |
</dl>
|
268 |
</td>
|
269 |
</tr>
|
270 |
</table>
|
271 |
<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)" --><p> |
272 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
273 |
<tr>
|
274 |
<td class="mdRow"> |
275 |
<table cellpadding="0" cellspacing="0" border="0"> |
276 |
<tr>
|
277 |
<td class="md" nowrap valign="top">void wl_send_global_packet </td> |
278 |
<td class="md" valign="top">( </td> |
279 |
<td class="md" nowrap valign="top">char </td> |
280 |
<td class="mdname" nowrap> <em>group</em>, </td> |
281 |
</tr>
|
282 |
<tr>
|
283 |
<td class="md" nowrap align="right"></td> |
284 |
<td class="md"></td> |
285 |
<td class="md" nowrap>char </td> |
286 |
<td class="mdname" nowrap> <em>type</em>, </td> |
287 |
</tr>
|
288 |
<tr>
|
289 |
<td class="md" nowrap align="right"></td> |
290 |
<td class="md"></td> |
291 |
<td class="md" nowrap>char * </td> |
292 |
<td class="mdname" nowrap> <em>data</em>, </td> |
293 |
</tr>
|
294 |
<tr>
|
295 |
<td class="md" nowrap align="right"></td> |
296 |
<td class="md"></td> |
297 |
<td class="md" nowrap>int </td> |
298 |
<td class="mdname" nowrap> <em>len</em>, </td> |
299 |
</tr>
|
300 |
<tr>
|
301 |
<td class="md" nowrap align="right"></td> |
302 |
<td class="md"></td> |
303 |
<td class="md" nowrap>char </td> |
304 |
<td class="mdname" nowrap> <em>frame</em></td> |
305 |
</tr>
|
306 |
<tr>
|
307 |
<td class="md"></td> |
308 |
<td class="md">) </td> |
309 |
<td class="md" colspan="2"></td> |
310 |
</tr>
|
311 |
</table>
|
312 |
</td>
|
313 |
</tr>
|
314 |
</table>
|
315 |
<table cellspacing="5" cellpadding="0" border="0"> |
316 |
<tr>
|
317 |
<td>
|
318 |
|
319 |
</td>
|
320 |
<td>
|
321 |
|
322 |
<p>
|
323 |
Send a packet to all robots. |
324 |
<p>
|
325 |
Send a packet to all XBees in all PANs.<p>
|
326 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
327 |
<table border="0" cellspacing="2" cellpadding="0"> |
328 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
329 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
330 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
331 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
332 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
333 |
</table>
|
334 |
</dl>
|
335 |
</td>
|
336 |
</tr>
|
337 |
</table>
|
338 |
<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)" --><p> |
339 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
340 |
<tr>
|
341 |
<td class="mdRow"> |
342 |
<table cellpadding="0" cellspacing="0" border="0"> |
343 |
<tr>
|
344 |
<td class="md" nowrap valign="top">void wl_send_pan_packet </td> |
345 |
<td class="md" valign="top">( </td> |
346 |
<td class="md" nowrap valign="top">char </td> |
347 |
<td class="mdname" nowrap> <em>group</em>, </td> |
348 |
</tr>
|
349 |
<tr>
|
350 |
<td class="md" nowrap align="right"></td> |
351 |
<td class="md"></td> |
352 |
<td class="md" nowrap>char </td> |
353 |
<td class="mdname" nowrap> <em>type</em>, </td> |
354 |
</tr>
|
355 |
<tr>
|
356 |
<td class="md" nowrap align="right"></td> |
357 |
<td class="md"></td> |
358 |
<td class="md" nowrap>char * </td> |
359 |
<td class="mdname" nowrap> <em>data</em>, </td> |
360 |
</tr>
|
361 |
<tr>
|
362 |
<td class="md" nowrap align="right"></td> |
363 |
<td class="md"></td> |
364 |
<td class="md" nowrap>int </td> |
365 |
<td class="mdname" nowrap> <em>len</em>, </td> |
366 |
</tr>
|
367 |
<tr>
|
368 |
<td class="md" nowrap align="right"></td> |
369 |
<td class="md"></td> |
370 |
<td class="md" nowrap>char </td> |
371 |
<td class="mdname" nowrap> <em>frame</em></td> |
372 |
</tr>
|
373 |
<tr>
|
374 |
<td class="md"></td> |
375 |
<td class="md">) </td> |
376 |
<td class="md" colspan="2"></td> |
377 |
</tr>
|
378 |
</table>
|
379 |
</td>
|
380 |
</tr>
|
381 |
</table>
|
382 |
<table cellspacing="5" cellpadding="0" border="0"> |
383 |
<tr>
|
384 |
<td>
|
385 |
|
386 |
</td>
|
387 |
<td>
|
388 |
|
389 |
<p>
|
390 |
Send a packet to all robots in our PAN. |
391 |
<p>
|
392 |
Send a packet to all XBee's in the same PAN.<p>
|
393 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
394 |
<table border="0" cellspacing="2" cellpadding="0"> |
395 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
396 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
397 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
398 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
399 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
400 |
</table>
|
401 |
</dl>
|
402 |
</td>
|
403 |
</tr>
|
404 |
</table>
|
405 |
<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)" --><p> |
406 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
407 |
<tr>
|
408 |
<td class="mdRow"> |
409 |
<table cellpadding="0" cellspacing="0" border="0"> |
410 |
<tr>
|
411 |
<td class="md" nowrap valign="top">void wl_send_robot_to_robot_global_packet </td> |
412 |
<td class="md" valign="top">( </td> |
413 |
<td class="md" nowrap valign="top">char </td> |
414 |
<td class="mdname" nowrap> <em>group</em>, </td> |
415 |
</tr>
|
416 |
<tr>
|
417 |
<td class="md" nowrap align="right"></td> |
418 |
<td class="md"></td> |
419 |
<td class="md" nowrap>char </td> |
420 |
<td class="mdname" nowrap> <em>type</em>, </td> |
421 |
</tr>
|
422 |
<tr>
|
423 |
<td class="md" nowrap align="right"></td> |
424 |
<td class="md"></td> |
425 |
<td class="md" nowrap>char * </td> |
426 |
<td class="mdname" nowrap> <em>data</em>, </td> |
427 |
</tr>
|
428 |
<tr>
|
429 |
<td class="md" nowrap align="right"></td> |
430 |
<td class="md"></td> |
431 |
<td class="md" nowrap>int </td> |
432 |
<td class="mdname" nowrap> <em>len</em>, </td> |
433 |
</tr>
|
434 |
<tr>
|
435 |
<td class="md" nowrap align="right"></td> |
436 |
<td class="md"></td> |
437 |
<td class="md" nowrap>int </td> |
438 |
<td class="mdname" nowrap> <em>dest</em>, </td> |
439 |
</tr>
|
440 |
<tr>
|
441 |
<td class="md" nowrap align="right"></td> |
442 |
<td class="md"></td> |
443 |
<td class="md" nowrap>char </td> |
444 |
<td class="mdname" nowrap> <em>frame</em></td> |
445 |
</tr>
|
446 |
<tr>
|
447 |
<td class="md"></td> |
448 |
<td class="md">) </td> |
449 |
<td class="md" colspan="2"></td> |
450 |
</tr>
|
451 |
</table>
|
452 |
</td>
|
453 |
</tr>
|
454 |
</table>
|
455 |
<table cellspacing="5" cellpadding="0" border="0"> |
456 |
<tr>
|
457 |
<td>
|
458 |
|
459 |
</td>
|
460 |
<td>
|
461 |
|
462 |
<p>
|
463 |
Send a packet to a specific robot in any PAN. |
464 |
<p>
|
465 |
Send a packet to a specific XBee without specifying a PAN.<p>
|
466 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
467 |
<table border="0" cellspacing="2" cellpadding="0"> |
468 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
469 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
470 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
471 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
472 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the 16-bit address of the XBee to send the packet to </td></tr> |
473 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
474 |
</table>
|
475 |
</dl>
|
476 |
</td>
|
477 |
</tr>
|
478 |
</table>
|
479 |
<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)" --><p> |
480 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
481 |
<tr>
|
482 |
<td class="mdRow"> |
483 |
<table cellpadding="0" cellspacing="0" border="0"> |
484 |
<tr>
|
485 |
<td class="md" nowrap valign="top">void wl_send_robot_to_robot_packet </td> |
486 |
<td class="md" valign="top">( </td> |
487 |
<td class="md" nowrap valign="top">char </td> |
488 |
<td class="mdname" nowrap> <em>group</em>, </td> |
489 |
</tr>
|
490 |
<tr>
|
491 |
<td class="md" nowrap align="right"></td> |
492 |
<td class="md"></td> |
493 |
<td class="md" nowrap>char </td> |
494 |
<td class="mdname" nowrap> <em>type</em>, </td> |
495 |
</tr>
|
496 |
<tr>
|
497 |
<td class="md" nowrap align="right"></td> |
498 |
<td class="md"></td> |
499 |
<td class="md" nowrap>char * </td> |
500 |
<td class="mdname" nowrap> <em>data</em>, </td> |
501 |
</tr>
|
502 |
<tr>
|
503 |
<td class="md" nowrap align="right"></td> |
504 |
<td class="md"></td> |
505 |
<td class="md" nowrap>int </td> |
506 |
<td class="mdname" nowrap> <em>len</em>, </td> |
507 |
</tr>
|
508 |
<tr>
|
509 |
<td class="md" nowrap align="right"></td> |
510 |
<td class="md"></td> |
511 |
<td class="md" nowrap>int </td> |
512 |
<td class="mdname" nowrap> <em>dest</em>, </td> |
513 |
</tr>
|
514 |
<tr>
|
515 |
<td class="md" nowrap align="right"></td> |
516 |
<td class="md"></td> |
517 |
<td class="md" nowrap>char </td> |
518 |
<td class="mdname" nowrap> <em>frame</em></td> |
519 |
</tr>
|
520 |
<tr>
|
521 |
<td class="md"></td> |
522 |
<td class="md">) </td> |
523 |
<td class="md" colspan="2"></td> |
524 |
</tr>
|
525 |
</table>
|
526 |
</td>
|
527 |
</tr>
|
528 |
</table>
|
529 |
<table cellspacing="5" cellpadding="0" border="0"> |
530 |
<tr>
|
531 |
<td>
|
532 |
|
533 |
</td>
|
534 |
<td>
|
535 |
|
536 |
<p>
|
537 |
Send a packet to a specific robot in our PAN. |
538 |
<p>
|
539 |
Send a packet to a specific XBee in the same PAN.<p>
|
540 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
541 |
<table border="0" cellspacing="2" cellpadding="0"> |
542 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
543 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
544 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
545 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
546 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the 16-bit address of the XBee to send the packet to </td></tr> |
547 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
548 |
</table>
|
549 |
</dl>
|
550 |
</td>
|
551 |
</tr>
|
552 |
</table>
|
553 |
<a class="anchor" name="g9aac809e57c9eb93a2905ed544c93aba"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="g9aac809e57c9eb93a2905ed544c93aba" args="(int channel)" --><p> |
554 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
555 |
<tr>
|
556 |
<td class="mdRow"> |
557 |
<table cellpadding="0" cellspacing="0" border="0"> |
558 |
<tr>
|
559 |
<td class="md" nowrap valign="top">void wl_set_channel </td> |
560 |
<td class="md" valign="top">( </td> |
561 |
<td class="md" nowrap valign="top">int </td> |
562 |
<td class="mdname1" valign="top" nowrap> <em>channel</em> </td> |
563 |
<td class="md" valign="top"> ) </td> |
564 |
<td class="md" nowrap></td> |
565 |
</tr>
|
566 |
</table>
|
567 |
</td>
|
568 |
</tr>
|
569 |
</table>
|
570 |
<table cellspacing="5" cellpadding="0" border="0"> |
571 |
<tr>
|
572 |
<td>
|
573 |
|
574 |
</td>
|
575 |
<td>
|
576 |
|
577 |
<p>
|
578 |
Set the channel we are using. |
579 |
<p>
|
580 |
Set the channel the XBee is listening to.<p>
|
581 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
582 |
<table border="0" cellspacing="2" cellpadding="0"> |
583 |
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>the new channel to join</td></tr> |
584 |
</table>
|
585 |
</dl>
|
586 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> </dd></dl> |
587 |
</td>
|
588 |
</tr>
|
589 |
</table>
|
590 |
<a class="anchor" name="g211ccf907dce4493813573e20264e542"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="g211ccf907dce4493813573e20264e542" args="(int pan)" --><p> |
591 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
592 |
<tr>
|
593 |
<td class="mdRow"> |
594 |
<table cellpadding="0" cellspacing="0" border="0"> |
595 |
<tr>
|
596 |
<td class="md" nowrap valign="top">void wl_set_pan </td> |
597 |
<td class="md" valign="top">( </td> |
598 |
<td class="md" nowrap valign="top">int </td> |
599 |
<td class="mdname1" valign="top" nowrap> <em>pan</em> </td> |
600 |
<td class="md" valign="top"> ) </td> |
601 |
<td class="md" nowrap></td> |
602 |
</tr>
|
603 |
</table>
|
604 |
</td>
|
605 |
</tr>
|
606 |
</table>
|
607 |
<table cellspacing="5" cellpadding="0" border="0"> |
608 |
<tr>
|
609 |
<td>
|
610 |
|
611 |
</td>
|
612 |
<td>
|
613 |
|
614 |
<p>
|
615 |
Set the PAN we are using. |
616 |
<p>
|
617 |
Set the PAN for the XBee to join.<p>
|
618 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
619 |
<table border="0" cellspacing="2" cellpadding="0"> |
620 |
<tr><td valign="top"></td><td valign="top"><em>pan</em> </td><td>the new PAN</td></tr> |
621 |
</table>
|
622 |
</dl>
|
623 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> </dd></dl> |
624 |
</td>
|
625 |
</tr>
|
626 |
</table>
|
627 |
<a class="anchor" name="g66075ff87a1c9f2c0d7938a26c7830f2"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="g66075ff87a1c9f2c0d7938a26c7830f2" args="(void)" --><p> |
628 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
629 |
<tr>
|
630 |
<td class="mdRow"> |
631 |
<table cellpadding="0" cellspacing="0" border="0"> |
632 |
<tr>
|
633 |
<td class="md" nowrap valign="top">void wl_terminate </td> |
634 |
<td class="md" valign="top">( </td> |
635 |
<td class="md" nowrap valign="top">void </td> |
636 |
<td class="mdname1" valign="top" nowrap> </td> |
637 |
<td class="md" valign="top"> ) </td> |
638 |
<td class="md" nowrap></td> |
639 |
</tr>
|
640 |
</table>
|
641 |
</td>
|
642 |
</tr>
|
643 |
</table>
|
644 |
<table cellspacing="5" cellpadding="0" border="0"> |
645 |
<tr>
|
646 |
<td>
|
647 |
|
648 |
</td>
|
649 |
<td>
|
650 |
|
651 |
<p>
|
652 |
Uninitialize the wireless library. |
653 |
<p>
|
654 |
Uninitializes the wireless library. </td>
|
655 |
</tr>
|
656 |
</table>
|
657 |
<a class="anchor" name="gcdbedf6465798abc7af3bf5fea3d4dd7"></a><!-- doxytag: member="wireless.h::wl_unregister_packet_group" ref="gcdbedf6465798abc7af3bf5fea3d4dd7" args="(PacketGroupHandler *h)" --><p> |
658 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
659 |
<tr>
|
660 |
<td class="mdRow"> |
661 |
<table cellpadding="0" cellspacing="0" border="0"> |
662 |
<tr>
|
663 |
<td class="md" nowrap valign="top">void wl_unregister_packet_group </td> |
664 |
<td class="md" valign="top">( </td> |
665 |
<td class="md" nowrap valign="top"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> * </td> |
666 |
<td class="mdname1" valign="top" nowrap> <em>h</em> </td> |
667 |
<td class="md" valign="top"> ) </td> |
668 |
<td class="md" nowrap></td> |
669 |
</tr>
|
670 |
</table>
|
671 |
</td>
|
672 |
</tr>
|
673 |
</table>
|
674 |
<table cellspacing="5" cellpadding="0" border="0"> |
675 |
<tr>
|
676 |
<td>
|
677 |
|
678 |
</td>
|
679 |
<td>
|
680 |
|
681 |
<p>
|
682 |
Unregister a packet group with the wireless library. |
683 |
<p>
|
684 |
Unregister a packet group from the wireless library.<p>
|
685 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
686 |
<table border="0" cellspacing="2" cellpadding="0"> |
687 |
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>the packet group to remove </td></tr> |
688 |
</table>
|
689 |
</dl>
|
690 |
</td>
|
691 |
</tr>
|
692 |
</table>
|
693 |
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 24 14:12:31 2007 for libwireless by |
694 |
<a href="http://www.doxygen.org/index.html"> |
695 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
696 |
</body>
|
697 |
</html>
|