Revision 1395
updated wireless docs
wl__basic_8h.html | ||
---|---|---|
30 | 30 |
<p> |
31 | 31 |
<a href="wl__basic_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
32 | 32 |
<tr><td></td></tr> |
33 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>PacketInfo</b></td></tr> |
|
35 |
|
|
33 | 36 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
34 | 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g366b705160e22c2a6c4ea2c3c22e3485"></a><!-- doxytag: member="wl_basic.h::WL_BASIC_GROUP" ref="g366b705160e22c2a6c4ea2c3c22e3485" args="" --> |
35 | 38 |
#define </td><td class="memItemRight" valign="bottom"><b>WL_BASIC_GROUP</b> 8</td></tr> |
... | ... | |
38 | 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </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> |
39 | 42 |
|
40 | 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr> |
44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic.h::wl_basic_init_default" ref="ge482937c7c29521030a33ecbc5d2dd9d" args="(void)" --> |
|
45 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ge482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> (void)</td></tr> |
|
46 |
|
|
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <br></td></tr> |
|
41 | 48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
42 | 49 |
|
43 | 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5"></a><br></td></tr> |
... | ... | |
47 | 54 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
48 | 55 |
|
49 | 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e"></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__wl__basic.html#g0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr> |
|
58 |
|
|
59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">default packet handler if none is specified on init <a href="group__wl__basic.html#g0ad976b2b61cca0081123606101c97cd"></a><br></td></tr> |
|
60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7">wl_basic_do</a> (void)</td></tr> |
|
61 |
|
|
62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer <a href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7"></a><br></td></tr> |
|
50 | 63 |
<tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
51 | 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic.h::wl_basic_group_handler" ref="gf0fa88111d706ef4e8b3bda5bc32596c" args="" --> |
52 | 65 |
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr> |
53 | 66 |
|
54 | 67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br></td></tr> |
68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6c9a887fb0b719948025f195efff1af9"></a><!-- doxytag: member="wl_basic.h::current_packet" ref="g6c9a887fb0b719948025f195efff1af9" args="" --> |
|
69 |
struct PacketInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g6c9a887fb0b719948025f195efff1af9">current_packet</a></td></tr> |
|
70 |
|
|
71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">current packet information, correct after <a class="el" href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7" title="wrapper for wl_do() to return packet data buffer">wl_basic_do()</a> <br></td></tr> |
|
55 | 72 |
</table> |
56 | 73 |
<hr><h2>Detailed Description</h2> |
57 | 74 |
High Level Wireless Packet Sending-Receiving Functions. |
... | ... | |
59 | 76 |
Abstracted wireless functionality for sending and receiving packets<p> |
60 | 77 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Christopher Mar, Colony Project, CMU Robotics Club </dd></dl> |
61 | 78 |
</div> |
62 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by
|
|
79 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
63 | 80 |
<a href="http://www.doxygen.org/index.html"> |
64 | 81 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
65 | 82 |
</body> |
Also available in: Unified diff