Revision 737
Updated wireless documentation.
group__wireless.html | ||
---|---|---|
22 | 22 |
<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> |
23 | 23 |
|
24 | 24 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
25 |
<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 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b">wl_init</a> (void)</td></tr>
|
|
26 | 26 |
|
27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="#g629ceefdf83847af356d90e2df27041c"></a><br></td></tr>
|
|
27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="#gedd4562415e273ce6537f9c1a0f2701b"></a><br></td></tr>
|
|
28 | 28 |
<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> |
29 | 29 |
|
30 | 30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr> |
... | ... | |
37 | 37 |
<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> |
38 | 38 |
|
39 | 39 |
<tr><td class="mdescLeft"> </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 </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 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6e841a6ef0504538d8650a0a2f5fa869">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>
|
|
41 | 41 |
|
42 |
<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>
|
|
43 |
<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>
|
|
42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="#g6e841a6ef0504538d8650a0a2f5fa869"></a><br></td></tr>
|
|
43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gf8fbadf62eeb754b98b200328fb7a8be">wl_send_robot_to_robot_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr>
|
|
44 | 44 |
|
45 |
<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>
|
|
46 |
<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>
|
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="#gf8fbadf62eeb754b98b200328fb7a8be"></a><br></td></tr>
|
|
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gda6b187ea58cee5aec18725bf7f24b9a">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr>
|
|
47 | 47 |
|
48 |
<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="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="#gda6b187ea58cee5aec18725bf7f24b9a"></a><br></td></tr>
|
|
49 | 49 |
<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> |
50 | 50 |
|
51 | 51 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g211ccf907dce4493813573e20264e542">wl_set_pan</a> (int pan)</td></tr>
|
|
52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g754445d2353a70963a489651cff554c1">wl_set_pan</a> (int pan)</td></tr>
|
|
53 | 53 |
|
54 |
<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="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="#g754445d2353a70963a489651cff554c1"></a><br></td></tr>
|
|
55 | 55 |
<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> |
56 | 56 |
|
57 | 57 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g9aac809e57c9eb93a2905ed544c93aba">wl_set_channel</a> (int channel)</td></tr>
|
|
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d">wl_set_channel</a> (int channel)</td></tr>
|
|
59 | 59 |
|
60 |
<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="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="#g51d3fe958d44fd92f0e0830ced13139d"></a><br></td></tr>
|
|
61 | 61 |
<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> |
62 | 62 |
|
63 | 63 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g90cb41c855ac3da028e8f1278bd49f4f">wl_get_xbee_id</a> (void)</td></tr>
|
|
64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6c75a84ff5f9a2bdc156aba522d2adf7">wl_get_xbee_id</a> (void)</td></tr>
|
|
65 | 65 |
|
66 |
<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 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="#g6c75a84ff5f9a2bdc156aba522d2adf7"></a><br></td></tr>
|
|
67 | 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 | 68 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr> |
69 | 69 |
|
... | ... | |
122 | 122 |
<p> |
123 | 123 |
Get the channel the XBee is part of.<p> |
124 | 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>
|
|
125 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d" title="Set the channel we are using.">wl_set_channel</a> </dd></dl>
|
|
126 | 126 |
|
127 | 127 |
</div> |
128 | 128 |
</div><p> |
... | ... | |
147 | 147 |
<p> |
148 | 148 |
Get the PAN the XBee is currently part of.<p> |
149 | 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>
|
|
150 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g754445d2353a70963a489651cff554c1" title="Set the PAN we are using.">wl_set_pan</a> </dd></dl>
|
|
151 | 151 |
|
152 | 152 |
</div> |
153 | 153 |
</div><p> |
154 |
<a class="anchor" name="g90cb41c855ac3da028e8f1278bd49f4f"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="g90cb41c855ac3da028e8f1278bd49f4f" args="(void)" -->
|
|
154 |
<a class="anchor" name="g6c75a84ff5f9a2bdc156aba522d2adf7"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="g6c75a84ff5f9a2bdc156aba522d2adf7" args="(void)" -->
|
|
155 | 155 |
<div class="memitem"> |
156 | 156 |
<div class="memproto"> |
157 | 157 |
<table class="memname"> |
158 | 158 |
<tr> |
159 |
<td class="memname">unsigned int wl_get_xbee_id </td>
|
|
159 |
<td class="memname">int wl_get_xbee_id </td> |
|
160 | 160 |
<td>(</td> |
161 | 161 |
<td class="paramtype">void </td> |
162 | 162 |
<td class="paramname"> </td> |
... | ... | |
175 | 175 |
|
176 | 176 |
</div> |
177 | 177 |
</div><p> |
178 |
<a class="anchor" name="g629ceefdf83847af356d90e2df27041c"></a><!-- doxytag: member="wireless.h::wl_init" ref="g629ceefdf83847af356d90e2df27041c" args="(void)" -->
|
|
178 |
<a class="anchor" name="gedd4562415e273ce6537f9c1a0f2701b"></a><!-- doxytag: member="wireless.h::wl_init" ref="gedd4562415e273ce6537f9c1a0f2701b" args="(void)" -->
|
|
179 | 179 |
<div class="memitem"> |
180 | 180 |
<div class="memproto"> |
181 | 181 |
<table class="memname"> |
182 | 182 |
<tr> |
183 |
<td class="memname">void wl_init </td>
|
|
183 |
<td class="memname">int wl_init </td>
|
|
184 | 184 |
<td>(</td> |
185 | 185 |
<td class="paramtype">void </td> |
186 | 186 |
<td class="paramname"> </td> |
... | ... | |
194 | 194 |
<p> |
195 | 195 |
Initialize the wireless library. |
196 | 196 |
<p> |
197 |
Initializes the wireless library. Must be called before any other function. |
|
197 |
Initializes the wireless library. Must be called before any other function.<p> |
|
198 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
199 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
200 |
<tr><td valign="top"></td><td valign="top"><em>wl_port</em> </td><td>File descriptor for wireless port, or NULL for default. </td></tr> |
|
201 |
</table> |
|
202 |
</dl> |
|
203 |
|
|
198 | 204 |
</div> |
199 | 205 |
</div><p> |
200 | 206 |
<a class="anchor" name="g183343ed0594ec1c2b79bb4085d57107"></a><!-- doxytag: member="wireless.h::wl_register_packet_group" ref="g183343ed0594ec1c2b79bb4085d57107" args="(PacketGroupHandler *h)" --> |
... | ... | |
225 | 231 |
|
226 | 232 |
</div> |
227 | 233 |
</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)" -->
|
|
234 |
<a class="anchor" name="gda6b187ea58cee5aec18725bf7f24b9a"></a><!-- doxytag: member="wireless.h::wl_send_global_packet" ref="gda6b187ea58cee5aec18725bf7f24b9a" args="(char group, char type, char *data, int len, char frame)" -->
|
|
229 | 235 |
<div class="memitem"> |
230 | 236 |
<div class="memproto"> |
231 | 237 |
<table class="memname"> |
232 | 238 |
<tr> |
233 |
<td class="memname">void wl_send_global_packet </td>
|
|
239 |
<td class="memname">int wl_send_global_packet </td>
|
|
234 | 240 |
<td>(</td> |
235 | 241 |
<td class="paramtype">char </td> |
236 | 242 |
<td class="paramname"> <em>group</em>, </td> |
... | ... | |
343 | 349 |
|
344 | 350 |
</div> |
345 | 351 |
</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)" -->
|
|
352 |
<a class="anchor" name="g6e841a6ef0504538d8650a0a2f5fa869"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_global_packet" ref="g6e841a6ef0504538d8650a0a2f5fa869" args="(char group, char type, char *data, int len, int dest, char frame)" -->
|
|
347 | 353 |
<div class="memitem"> |
348 | 354 |
<div class="memproto"> |
349 | 355 |
<table class="memname"> |
350 | 356 |
<tr> |
351 |
<td class="memname">void wl_send_robot_to_robot_global_packet </td>
|
|
357 |
<td class="memname">int wl_send_robot_to_robot_global_packet </td>
|
|
352 | 358 |
<td>(</td> |
353 | 359 |
<td class="paramtype">char </td> |
354 | 360 |
<td class="paramname"> <em>group</em>, </td> |
... | ... | |
409 | 415 |
|
410 | 416 |
</div> |
411 | 417 |
</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)" -->
|
|
418 |
<a class="anchor" name="gf8fbadf62eeb754b98b200328fb7a8be"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_packet" ref="gf8fbadf62eeb754b98b200328fb7a8be" args="(char group, char type, char *data, int len, int dest, char frame)" -->
|
|
413 | 419 |
<div class="memitem"> |
414 | 420 |
<div class="memproto"> |
415 | 421 |
<table class="memname"> |
416 | 422 |
<tr> |
417 |
<td class="memname">void wl_send_robot_to_robot_packet </td>
|
|
423 |
<td class="memname">int wl_send_robot_to_robot_packet </td>
|
|
418 | 424 |
<td>(</td> |
419 | 425 |
<td class="paramtype">char </td> |
420 | 426 |
<td class="paramname"> <em>group</em>, </td> |
... | ... | |
475 | 481 |
|
476 | 482 |
</div> |
477 | 483 |
</div><p> |
478 |
<a class="anchor" name="g9aac809e57c9eb93a2905ed544c93aba"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="g9aac809e57c9eb93a2905ed544c93aba" args="(int channel)" -->
|
|
484 |
<a class="anchor" name="g51d3fe958d44fd92f0e0830ced13139d"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="g51d3fe958d44fd92f0e0830ced13139d" args="(int channel)" -->
|
|
479 | 485 |
<div class="memitem"> |
480 | 486 |
<div class="memproto"> |
481 | 487 |
<table class="memname"> |
482 | 488 |
<tr> |
483 |
<td class="memname">void wl_set_channel </td>
|
|
489 |
<td class="memname">int wl_set_channel </td>
|
|
484 | 490 |
<td>(</td> |
485 | 491 |
<td class="paramtype">int </td> |
486 | 492 |
<td class="paramname"> <em>channel</em> </td> |
... | ... | |
504 | 510 |
|
505 | 511 |
</div> |
506 | 512 |
</div><p> |
507 |
<a class="anchor" name="g211ccf907dce4493813573e20264e542"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="g211ccf907dce4493813573e20264e542" args="(int pan)" -->
|
|
513 |
<a class="anchor" name="g754445d2353a70963a489651cff554c1"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="g754445d2353a70963a489651cff554c1" args="(int pan)" -->
|
|
508 | 514 |
<div class="memitem"> |
509 | 515 |
<div class="memproto"> |
510 | 516 |
<table class="memname"> |
511 | 517 |
<tr> |
512 |
<td class="memname">void wl_set_pan </td>
|
|
518 |
<td class="memname">int wl_set_pan </td>
|
|
513 | 519 |
<td>(</td> |
514 | 520 |
<td class="paramtype">int </td> |
515 | 521 |
<td class="paramname"> <em>pan</em> </td> |
... | ... | |
583 | 589 |
|
584 | 590 |
</div> |
585 | 591 |
</div><p> |
586 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by
|
|
592 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by
|
|
587 | 593 |
<a href="http://www.doxygen.org/index.html"> |
588 | 594 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
589 | 595 |
</body> |
Also available in: Unified diff