Revision 1425
updated wireless basic library code and docs
| 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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 26 | 29 |
<a name="l00037"></a>00037 <span class="preprocessor"></span> |
| 27 | 30 |
<a name="l00038"></a>00038 <span class="comment">//Note: If this is raised above 16, we will need to do</span> |
| 28 | 31 |
<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>
|
|
| 32 |
<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 | 33 |
<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>
|
|
| 34 |
<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 | 35 |
<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> |
|
| 36 |
<a name="l00047"></a><a class="code" href="wireless_8h.html#af083cc95511287866eeb4337fdc75eeb">00047</a> <span class="preprocessor">#define WL_MAX_PACKET_GROUPS 16</span>
|
|
| 34 | 37 |
<a name="l00048"></a>00048 <span class="preprocessor"></span> |
| 35 | 38 |
<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 | 39 |
<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 | 40 |
<a name="l00081"></a>00081 <span class="comment">// Thus, pointers should be first, followed by int, followed by char.</span> |
| 38 | 41 |
<a name="l00082"></a><a class="code" href="structPacketGroupHandler.html">00082</a> <span class="keyword">typedef</span> <span class="keyword">struct</span> |
| 39 | 42 |
<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>
|
|
| 43 |
<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 | 44 |
<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; |
|
| 45 |
<a name="l00091"></a><a class="code" href="structPacketGroupHandler.html#af0849c643f1b1e257ccfe96110109950">00091</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> groupCode;
|
|
| 43 | 46 |
<a name="l00092"></a>00092 |
| 44 | 47 |
<a name="l00097"></a>00097 void (*timeout_handler) (void); |
| 45 | 48 |
<a name="l00098"></a>00098 |
| ... | ... | |
| 51 | 54 |
<a name="l00125"></a>00125 |
| 52 | 55 |
<a name="l00126"></a>00126 } <a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>; |
| 53 | 56 |
<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); |
|
| 57 |
<a name="l00129"></a>00129 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#gaedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init</a>(<span class="keywordtype">void</span>);
|
|
| 58 |
<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga66075ff87a1c9f2c0d7938a26c7830f2" title="Uninitialize the wireless library.">wl_terminate</a>(<span class="keywordtype">void</span>);
|
|
| 59 |
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do</a>(<span class="keywordtype">void</span>);
|
|
| 60 |
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga183343ed0594ec1c2b79bb4085d57107" title="Register a packet group with the wireless library.">wl_register_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
|
|
| 61 |
<a name="l00137"></a>00137 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#gacdbedf6465798abc7af3bf5fea3d4dd7" title="Unregister a packet group with the wireless library.">wl_unregister_packet_group</a>(<a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>* h);
|
|
| 59 | 62 |
<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); |
|
| 63 |
<a name="l00140"></a>00140 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#ga6e841a6ef0504538d8650a0a2f5fa869" 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);
|
|
| 64 |
<a name="l00142"></a>00142 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#gaf8fbadf62eeb754b98b200328fb7a8be" 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);
|
|
| 65 |
<a name="l00144"></a>00144 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#gada6b187ea58cee5aec18725bf7f24b9a" 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);
|
|
| 66 |
<a name="l00146"></a>00146 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga0a1a0e4d885f0e0dde87160a16daa0aa" 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 | 67 |
<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); |
|
| 68 |
<a name="l00149"></a>00149 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#ga754445d2353a70963a489651cff554c1" title="Set the PAN we are using.">wl_set_pan</a>(<span class="keywordtype">int</span> pan);
|
|
| 69 |
<a name="l00151"></a>00151 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#ga4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a>(<span class="keywordtype">void</span>);
|
|
| 70 |
<a name="l00153"></a>00153 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#ga51d3fe958d44fd92f0e0830ced13139d" title="Set the channel we are using.">wl_set_channel</a>(<span class="keywordtype">int</span> channel);
|
|
| 71 |
<a name="l00155"></a>00155 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#ga2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a>(<span class="keywordtype">void</span>);
|
|
| 72 |
<a name="l00157"></a>00157 <span class="keywordtype">int</span> <a class="code" href="group__wireless.html#ga6c75a84ff5f9a2bdc156aba522d2adf7" title="Get the 16-bit address of the XBee module.">wl_get_xbee_id</a>(<span class="keywordtype">void</span>);
|
|
| 73 |
<a name="l00159"></a>00159 <span class="keywordtype">void</span> <a class="code" href="group__wireless.html#ga344dead0023100eb40f8670a92c9ce5c" title="Set the com port on a computer, undefined on the robot.">wl_set_com_port</a>(<span class="keywordtype">char</span>* port);
|
|
| 71 | 74 |
<a name="l00160"></a>00160 <span class="comment">// end defgroup</span> |
| 72 | 75 |
<a name="l00162"></a>00162 |
| 73 | 76 |
<a name="l00163"></a>00163 <span class="preprocessor">#endif</span> |
| 74 | 77 |
<a name="l00164"></a>00164 <span class="preprocessor"></span> |
| 75 | 78 |
</pre></div></div> |
| 76 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
| 79 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by
|
|
| 77 | 80 |
<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>
|
|
| 81 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 79 | 82 |
</body> |
| 80 | 83 |
</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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 22 | 25 |
</div> |
| 23 | 26 |
</div> |
| 24 | 27 |
<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 <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code><br> |
|
| 29 |
<code>#include "<a class="el" href="wl__basic_8h_source.html">wl_basic.h</a>"</code><br> |
|
| 28 |
<h1>wl_basic.c File Reference</h1> |
|
| 29 |
<p>High Level Wireless Packet Sending-Receiving Functions.
|
|
| 30 |
<a href="#_details">More...</a></p>
|
|
| 31 |
<code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code><br/>
|
|
| 32 |
<code>#include "<a class="el" href="wl__basic_8h_source.html">wl_basic.h</a>"</code><br/>
|
|
| 30 | 33 |
<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 </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"> </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"><a class="anchor" name="ge482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic.c::wl_basic_init_default" ref="ge482937c7c29521030a33ecbc5d2dd9d" args="()" --> |
|
| 37 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ge482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> ()</td></tr> |
|
| 38 |
|
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <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__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
|
| 41 |
|
|
| 42 |
<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> |
|
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
|
| 44 |
|
|
| 45 |
<tr><td class="mdescLeft"> </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> |
|
| 46 |
<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> |
|
| 47 |
|
|
| 48 |
<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> |
|
| 49 |
<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> |
|
| 50 |
|
|
| 51 |
<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> |
|
| 52 |
<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> |
|
| 53 |
|
|
| 54 |
<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> |
|
| 34 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="group__wl__basic.html#gaae4a8ae98cc33955ee20b6e481d47adf"></a><br/></td></tr> |
|
| 37 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> ()</td></tr> |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <a href="group__wl__basic.html#gae482937c7c29521030a33ecbc5d2dd9d"></a><br/></td></tr> |
|
| 39 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="group__wl__basic.html#gaebc714e1bf382a98ac7a43762bf905c5"></a><br/></td></tr> |
|
| 41 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gad5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr> |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to a single robot in Basic Group <a href="group__wl__basic.html#gad5d7334484e49cc3cb9ebe2cfc323115"></a><br/></td></tr> |
|
| 43 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr> |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="group__wl__basic.html#ga72d4f604603ef2541b5f4d3ae467938e"></a><br/></td></tr> |
|
| 45 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr> |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal default packet handler if none is specified on init <a href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd"></a><br/></td></tr> |
|
| 47 |
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gad10a8456bc3d30d22fe1dbd40b6e0dbb">wl_basic_do_default</a> (void)</td></tr> |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer <a href="group__wl__basic.html#gad10a8456bc3d30d22fe1dbd40b6e0dbb"></a><br/></td></tr> |
|
| 55 | 49 |
</table> |
| 56 |
<hr><h2>Detailed Description</h2> |
|
| 57 |
High Level Wireless Packet Sending-Receiving Functions. |
|
| 58 |
<p> |
|
| 59 |
Abstracted wireless functionality for sending and receiving packets<p> |
|
| 60 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Christopher Mar, Colony Project, CMU Robotics Club </dd></dl> |
|
| 50 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
| 51 |
<p>High Level Wireless Packet Sending-Receiving Functions. </p> |
|
| 52 |
<p>Abstracted wireless functionality for sending and receiving packets</p> |
|
| 53 |
<dl class="author"><dt><b>Author:</b></dt><dd>Christopher Mar, Colony Project, CMU Robotics Club </dd></dl> |
|
| 61 | 54 |
</div> |
| 62 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
| 55 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by
|
|
| 63 | 56 |
<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>
|
|
| 57 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 65 | 58 |
</body> |
| 66 | 59 |
</html> |
| trunk/docs/libwireless/tabs.css | ||
|---|---|---|
| 57 | 57 |
white-space : nowrap; |
| 58 | 58 |
} |
| 59 | 59 |
|
| 60 |
DIV.tabs INPUT
|
|
| 60 |
DIV.tabs #MSearchBox
|
|
| 61 | 61 |
{
|
| 62 | 62 |
float : right; |
| 63 | 63 |
display : inline; |
| 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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 22 | 25 |
</div> |
| 23 | 26 |
</div> |
| 24 | 27 |
<div class="contents"> |
| 25 |
<h1>xbee.c File Reference</h1>XBee Interface.
|
|
| 26 |
<a href="#_details">More...</a>
|
|
| 27 |
<p> |
|
| 28 |
<code>#include "<a class="el" href="xbee_8h_source.html">xbee.h</a>"</code><br> |
|
| 29 |
<code>#include "<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>"</code><br> |
|
| 30 |
<code>#include <fcntl.h></code><br> |
|
| 31 |
<code>#include <unistd.h></code><br> |
|
| 32 |
<code>#include <pthread.h></code><br> |
|
| 33 |
<code>#include <errno.h></code><br> |
|
| 34 |
<code>#include <termios.h></code><br> |
|
| 35 |
<code>#include <stdio.h></code><br> |
|
| 36 |
<code>#include <stdlib.h></code><br> |
|
| 37 |
<code>#include <string.h></code><br> |
|
| 28 |
<h1>xbee.c File Reference</h1> |
|
| 29 |
<p>XBee Interface.
|
|
| 30 |
<a href="#_details">More...</a></p>
|
|
| 31 |
<code>#include "<a class="el" href="xbee_8h_source.html">xbee.h</a>"</code><br/>
|
|
| 32 |
<code>#include "<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>"</code><br/>
|
|
| 33 |
<code>#include <fcntl.h></code><br/>
|
|
| 34 |
<code>#include <unistd.h></code><br/>
|
|
| 35 |
<code>#include <pthread.h></code><br/>
|
|
| 36 |
<code>#include <errno.h></code><br/>
|
|
| 37 |
<code>#include <termios.h></code><br/>
|
|
| 38 |
<code>#include <stdio.h></code><br/>
|
|
| 39 |
<code>#include <stdlib.h></code><br/>
|
|
| 40 |
<code>#include <string.h></code><br/>
|
|
| 38 | 41 |
<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 |
<tr><td colspan="2"><h2>Defines</h2></td></tr> |
|
| 43 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_START" ref="a72aa42b35714e06ac26df31b06a8bf39" args="" --> |
|
| 42 | 44 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_START</b> 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 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe7468473089e3cdd2ed85cac2244d49"></a><!-- doxytag: member="xbee.c::XBEE_GET_PACKET_TIMEOUT" ref="abe7468473089e3cdd2ed85cac2244d49" args="" --> |
|
| 45 | 46 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_GET_PACKET_TIMEOUT</b> 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="" --> |
|
| 47 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_STATUS" ref="ae0fc9d7b1078703227c91e1352b708c5" args="" --> |
|
| 48 | 48 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_STATUS</b> 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="" --> |
|
| 49 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND" ref="a106780ab66c38464e90af25ae3cc73de" args="" --> |
|
| 51 | 50 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND</b> 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="" --> |
|
| 51 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="aac9e8cc2d9fdda49b77aed7d9380bfde" args="" --> |
|
| 54 | 52 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND_RESPONSE</b> 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="" --> |
|
| 53 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_64" ref="a31af21123fe9b33803cdf96626776d32" args="" --> |
|
| 57 | 54 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_64</b> 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="" --> |
|
| 55 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_16" ref="a30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" --> |
|
| 60 | 56 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_16</b> 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="" --> |
|
| 57 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_STATUS" ref="a301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" --> |
|
| 63 | 58 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_STATUS</b> 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="" --> |
|
| 59 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_64" ref="aba621d0a00f41acc7e059b5abf4802ad" args="" --> |
|
| 66 | 60 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_64</b> 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="" --> |
|
| 61 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_16" ref="a5b80e57bcad9ccaa20022e8d4968ec66" args="" --> |
|
| 69 | 62 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_16</b> 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="" --> |
|
| 63 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63d0ecb125d464ea34524e090648f70f"></a><!-- doxytag: member="xbee.c::XBEE_BUFFER_SIZE" ref="a63d0ecb125d464ea34524e090648f70f" args="" --> |
|
| 72 | 64 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_BUFFER_SIZE</b> 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="" --> |
|
| 65 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="xbee.c::PACKET_BUFFER_SIZE" ref="ab30af815d6e9494361629440f14e3716" args="" --> |
|
| 75 | 66 |
#define </td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b> 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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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]" --> |
|
| 67 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
| 68 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> ()</td></tr> |
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="group__xbee.html#ga3d5fbb6aae8dda99240ec38108a645af"></a><br/></td></tr> |
|
| 70 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> ()</td></tr> |
|
| 71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="group__xbee.html#ga9334ac71dca1ddd697b1a35a361ade6a"></a><br/></td></tr> |
|
| 72 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
|
| 73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="group__xbee.html#ga7c44bc25fda954efde574ee8d735073c"></a><br/></td></tr> |
|
| 74 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *dest)</td></tr> |
|
| 75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="group__xbee.html#ga00fbdd9d849171588df736f8b608589d"></a><br/></td></tr> |
|
| 76 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gade50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr> |
|
| 77 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="group__xbee.html#gade50cbefd7ba8d7361ce2654a298748b"></a><br/></td></tr> |
|
| 78 |
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> ()</td></tr> |
|
| 79 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="group__xbee.html#ga7755cd8db87703c9e9943153660b8052"></a><br/></td></tr> |
|
| 80 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gab93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr> |
|
| 81 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="group__xbee.html#gab93170c493c5cdfd43a7b640c6ed1d14"></a><br/></td></tr> |
|
| 82 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr> |
|
| 83 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="group__xbee.html#ga133706db81f69ba0a3c169b7a3f42d2a"></a><br/></td></tr> |
|
| 84 |
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7c53e8a8492494a61ca306875d633309">xbee_get_address</a> ()</td></tr> |
|
| 85 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's 16-bit address. <a href="group__xbee.html#ga7c53e8a8492494a61ca306875d633309"></a><br/></td></tr> |
|
| 86 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee.c::xbee_set_com_port" ref="ga1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" --> |
|
| 87 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr> |
|
| 88 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br/></td></tr> |
|
| 89 |
<tr><td colspan="2"><h2>Variables</h2></td></tr> |
|
| 90 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65685824a9cbbc9da05be520d0d80d12"></a><!-- doxytag: member="xbee.c::arrival_buf" ref="a65685824a9cbbc9da05be520d0d80d12" args="[XBEE_BUFFER_SIZE]" --> |
|
| 111 | 91 |
char </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="" --> |
|
| 92 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7ae7d59f0f2dabc258c678996b59b22"></a><!-- doxytag: member="xbee.c::buffer_last" ref="ab7ae7d59f0f2dabc258c678996b59b22" args="" --> |
|
| 114 | 93 |
volatile int </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="" --> |
|
| 94 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa38080e2a4d6f0497f3c2faf487a0952"></a><!-- doxytag: member="xbee.c::buffer_first" ref="aa38080e2a4d6f0497f3c2faf487a0952" args="" --> |
|
| 117 | 95 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_first</b> = 0</td></tr> |
| 118 |
|
|
| 119 | 96 |
</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> |
|
| 97 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
| 98 |
<p>XBee Interface. </p> |
|
| 99 |
<p>Copyright (c) 2007 Colony Project</p> |
|
| 100 |
<p>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> |
|
| 101 |
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> |
|
| 102 |
<p>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> |
|
| 103 |
<p>Implementation of low level communication with the XBee in API mode.</p> |
|
| 104 |
<dl class="author"><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
|
| 129 | 105 |
</div> |
| 130 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
| 106 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by
|
|
| 131 | 107 |
<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>
|
|
| 108 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 133 | 109 |
</body> |
| 134 | 110 |
</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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 24 | 27 |
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef WL_TOKEN_RING_H</span> |
| 25 | 28 |
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define WL_TOKEN_RING_H</span> |
| 26 | 29 |
<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="l00050"></a>00050 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#ga00fb5cca21a50d39aa1e82fdc679ca44" title="Register the token ring group with the wireless library.">wl_token_ring_register</a>(<span class="keywordtype">void</span>);
|
|
| 31 |
<a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#gade3dd682b6a757bab6ce4cbc9c518f8e" title="Unregister the token ring group with the wirelss library.">wl_token_ring_unregister</a>(<span class="keywordtype">void</span>);
|
|
| 32 |
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#ga0c407d5c215a97d58c67006bcc6e53ce" 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 | 33 |
<a name="l00055"></a>00055 <span class="keywordtype">int</span> (*max_bom_function) (<span class="keywordtype">void</span>)); |
| 31 | 34 |
<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>); |
|
| 35 |
<a name="l00058"></a>00058 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gae1012b6d6c1c46b26a6c6da7e4ec7c88" title="Join the token ring.">wl_token_ring_join</a>(<span class="keywordtype">void</span>);
|
|
| 36 |
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#ga6c2dd8742e100f63d4fb002707d1e85a" title="Leave the token ring.">wl_token_ring_leave</a>(<span class="keywordtype">void</span>);
|
|
| 34 | 37 |
<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); |
|
| 38 |
<a name="l00063"></a>00063 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#ga0c61bb8892aa5513706e00cd8ce5ca8b" title="Return the number of robots in the token ring.">wl_token_get_robots_in_ring</a>(<span class="keywordtype">void</span>);
|
|
| 39 |
<a name="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#ga14e005f0b9582eca7e3585f247c4cd72" 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 | 40 |
<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="l00068"></a>00068 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#ga37ab9fb00e9eef273b4d0fcda81a2620" title="Begin iterating through robots in the token ring.">wl_token_iterator_begin</a>(<span class="keywordtype">void</span>);
|
|
| 42 |
<a name="l00070"></a>00070 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gabd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a>(<span class="keywordtype">void</span>);
|
|
| 43 |
<a name="l00072"></a>00072 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gad9196324178877770d8ffc91d40893c3" title="Returns the ID of the next robot in the token ring.">wl_token_iterator_next</a>(<span class="keywordtype">void</span>);
|
|
| 41 | 44 |
<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>); |
|
| 45 |
<a name="l00075"></a>00075 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gab4afd4b8e034d22d415f3c4a42a652fc" 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);
|
|
| 46 |
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#ga1938c1d79dd9438dcd413d6d26372877" title="Return the latest BOM reading between us and another robot.">wl_token_get_my_sensor_reading</a>(<span class="keywordtype">int</span> dest);
|
|
| 47 |
<a name="l00079"></a>00079 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gaf0d311d4feae71afc8bcb0b8c8e6ba57" title="Return the number of robots in the sensor matrix.">wl_token_get_num_robots</a>(<span class="keywordtype">void</span>);
|
|
| 48 |
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#ga5fe1508968d450a970b0d5417a06431d" title="Return the number of non-null elements in the sensor matrix.">wl_token_get_matrix_size</a>(<span class="keywordtype">void</span>);
|
|
| 46 | 49 |
<a name="l00082"></a>00082 <span class="comment">//end token ring group</span> |
| 47 | 50 |
<a name="l00084"></a>00084 |
| 48 | 51 |
<a name="l00085"></a>00085 <span class="preprocessor">#endif</span> |
| 49 | 52 |
</pre></div></div> |
| 50 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
| 53 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by
|
|
| 51 | 54 |
<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>
|
|
| 55 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 53 | 56 |
</body> |
| 54 | 57 |
</html> |
| trunk/docs/libwireless/globals_defs.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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<title>libwireless: Data Fields</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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 30 | 33 |
</div> |
| 31 | 34 |
</div> |
| 32 | 35 |
<div class="contents"> |
| 33 |
|
|
| 34 |
<p> |
|
| 35 |
<ul> |
|
| 36 |
<ul> |
|
| 37 |
<li>WL_BASIC_GROUP |
|
| 38 |
: <a class="el" href="group__wl__basic.html#ga366b705160e22c2a6c4ea2c3c22e3485">wl_basic.h</a> |
|
| 39 |
</li> |
|
| 36 | 40 |
<li>WL_MAX_PACKET_GROUPS |
| 37 |
: <a class="el" href="wireless_8h.html#f083cc95511287866eeb4337fdc75eeb">wireless.h</a> |
|
| 41 |
: <a class="el" href="wireless_8h.html#af083cc95511287866eeb4337fdc75eeb">wireless.h</a> |
|
| 42 |
</li> |
|
| 38 | 43 |
<li>XBEE_BROADCAST |
| 39 |
: <a class="el" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">xbee.h</a> |
|
| 44 |
: <a class="el" href="group__xbee.html#ga93bbd21f7965e1697350f950cedff5c4">xbee.h</a> |
|
| 45 |
</li> |
|
| 40 | 46 |
<li>XBEE_CHANNEL_DEFAULT |
| 41 |
: <a class="el" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">xbee.h</a> |
|
| 47 |
: <a class="el" href="group__xbee.html#ga35f8b9d8e01e788f1e29928cba29f215">xbee.h</a> |
|
| 48 |
</li> |
|
| 42 | 49 |
<li>XBEE_OPTIONS_BROADCAST_ALL_PANS |
| 43 |
: <a class="el" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">xbee.h</a> |
|
| 50 |
: <a class="el" href="group__xbee.html#ga57382f888360b5b19f0de3b6f1f7c5a3">xbee.h</a> |
|
| 51 |
</li> |
|
| 44 | 52 |
<li>XBEE_OPTIONS_DISABLE_RESPONSE |
| 45 |
: <a class="el" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">xbee.h</a> |
|
| 53 |
: <a class="el" href="group__xbee.html#gacf9509013302590dca5ce3db63c64609">xbee.h</a> |
|
| 54 |
</li> |
|
| 46 | 55 |
<li>XBEE_OPTIONS_NONE |
| 47 |
: <a class="el" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">xbee.h</a> |
|
| 56 |
: <a class="el" href="group__xbee.html#gabca7356c2b8183fd41b5ca9a82dd962b">xbee.h</a> |
|
| 57 |
</li> |
|
| 48 | 58 |
<li>XBEE_PAN_DEFAULT |
| 49 |
: <a class="el" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">xbee.h</a> |
|
| 59 |
: <a class="el" href="group__xbee.html#gae6bb9bb274d6750f954762454807a5a7">xbee.h</a> |
|
| 60 |
</li> |
|
| 50 | 61 |
<li>XBEE_PORT_DEFAULT |
| 51 |
: <a class="el" href="xbee_8h.html#fd0466c206d7e1f82ee407d114468e96">xbee.h</a> |
|
| 62 |
: <a class="el" href="xbee_8h.html#afd0466c206d7e1f82ee407d114468e96">xbee.h</a> |
|
| 63 |
</li> |
|
| 52 | 64 |
<li>XBEE_RX |
| 53 |
: <a class="el" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">xbee.h</a> |
|
| 65 |
: <a class="el" href="group__xbee.html#gac2b1262a3a1eb4a9f7ead366af71c32c">xbee.h</a> |
|
| 66 |
</li> |
|
| 54 | 67 |
<li>XBEE_TX_STATUS |
| 55 |
: <a class="el" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">xbee.h</a> |
|
| 68 |
: <a class="el" href="group__xbee.html#ga7840d8b64c8bec12d8b8d32e845a638a">xbee.h</a> |
|
| 69 |
</li> |
|
| 56 | 70 |
</ul> |
| 57 | 71 |
</div> |
| 58 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
| 72 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by
|
|
| 59 | 73 |
<a href="http://www.doxygen.org/index.html"> |
| 60 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 74 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 61 | 75 |
</body> |
| 62 | 76 |
</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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 22 | 25 |
</div> |
| 23 | 26 |
</div> |
| 24 | 27 |
<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 <stdlib.h></code><br> |
|
| 29 |
<code>#include <stdio.h></code><br> |
|
| 30 |
<code>#include <<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>></code><br> |
|
| 31 |
<code>#include "<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>"</code><br> |
|
| 28 |
<h1>sensor_matrix.c File Reference</h1> |
|
| 29 |
<p>Sensor Matrix implementation.
|
|
| 30 |
<a href="#_details">More...</a></p>
|
|
| 31 |
<code>#include <stdlib.h></code><br/>
|
|
| 32 |
<code>#include <stdio.h></code><br/>
|
|
| 33 |
<code>#include <<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>></code><br/>
|
|
| 34 |
<code>#include "<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>"</code><br/>
|
|
| 32 | 35 |
<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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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="" --> |
|
| 36 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
| 37 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga09523e52546e7929288795e1e5f0f9a8">sensor_matrix_create</a> ()</td></tr> |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a sensor matrix. <a href="group__sensormatrix.html#ga09523e52546e7929288795e1e5f0f9a8"></a><br/></td></tr> |
|
| 39 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaf251d97aeb23af9156c0527692819da7">sensor_matrix_set_reading</a> (int observer, int robot, int reading)</td></tr> |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a reading in a sensor matrix. <a href="group__sensormatrix.html#gaf251d97aeb23af9156c0527692819da7"></a><br/></td></tr> |
|
| 41 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga031d5a4d15603e57379aad22da36e300">sensor_matrix_get_reading</a> (int observer, int robot)</td></tr> |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a reading in a sensor matrix. <a href="group__sensormatrix.html#ga031d5a4d15603e57379aad22da36e300"></a><br/></td></tr> |
|
| 43 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaea879c1d5f8a8a079066d8df005f3549">sensor_matrix_set_in_ring</a> (int robot, int in)</td></tr> |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the robot is in the token ring. <a href="group__sensormatrix.html#gaea879c1d5f8a8a079066d8df005f3549"></a><br/></td></tr> |
|
| 45 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gac668dfe28e56b5a314789d395eda3b27">sensor_matrix_get_in_ring</a> (int robot)</td></tr> |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get whether the robot is in the sensor ring. <a href="group__sensormatrix.html#gac668dfe28e56b5a314789d395eda3b27"></a><br/></td></tr> |
|
| 47 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga3545800eec0adba2fc63604206b8fb24">sensor_matrix_get_joined</a> (void)</td></tr> |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of robots which have joined the token ring. <a href="group__sensormatrix.html#ga3545800eec0adba2fc63604206b8fb24"></a><br/></td></tr> |
|
| 49 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaa22a0851d1886ca29fc32e0692502f2d">sensor_matrix_get_size</a> (void)</td></tr> |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum size of the sensor matrix. <a href="group__sensormatrix.html#gaa22a0851d1886ca29fc32e0692502f2d"></a><br/></td></tr> |
|
| 51 |
<tr><td colspan="2"><h2>Variables</h2></td></tr> |
|
| 52 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac091168317c73360daa8b5d366e5ae0f"></a><!-- doxytag: member="sensor_matrix.c::m" ref="ac091168317c73360daa8b5d366e5ae0f" args="" --> |
|
| 58 | 53 |
<a class="el" href="structSensorMatrix.html">SensorMatrix</a> </td><td class="memItemRight" valign="bottom"><b>m</b></td></tr> |
| 59 |
|
|
| 60 | 54 |
</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> |
|
| 55 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
| 56 |
<p>Sensor Matrix implementation. </p> |
|
| 57 |
<p>Copyright (c) 2007 Colony Project</p> |
|
| 58 |
<p>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> |
|
| 59 |
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> |
|
| 60 |
<p>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> |
|
| 61 |
<p>Implementation of a sensor matrix for storing localization implementation.</p> |
|
| 62 |
<dl class="author"><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
|
| 70 | 63 |
</div> |
| 71 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by
|
|
| 64 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by
|
|
| 72 | 65 |
<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>
|
|
| 66 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 74 | 67 |
</body> |
| 75 | 68 |
</html> |
| trunk/docs/libwireless/structPacketGroupHandler.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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<title>libwireless: PacketGroupHandler Struct 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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 22 | 25 |
</div> |
| 23 | 26 |
</div> |
| 24 | 27 |
<div class="contents"> |
| 25 |
<h1>PacketGroupHandler Struct Reference<br> |
|
| 28 |
<h1>PacketGroupHandler Struct Reference<br/>
|
|
| 26 | 29 |
<small> |
| 27 | 30 |
[<a class="el" href="group__wireless.html">Wireless</a>]</small> |
| 28 |
</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code>
|
|
| 29 |
<p> |
|
| 31 |
</h1><!-- doxytag: class="PacketGroupHandler" --> |
|
| 32 |
<p><code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code></p>
|
|
| 30 | 33 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 31 |
<tr><td></td></tr> |
|
| 32 |
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> |
|
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">groupCode</a></td></tr> |
|
| 34 |
|
|
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">timeout_handler</a> )(void)</td></tr> |
|
| 36 |
|
|
| 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">handle_response</a> )(int frame, int received)</td></tr> |
|
| 38 |
|
|
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">handle_receive</a> )(char type, int source, unsigned char *packet, int length)</td></tr> |
|
| 40 |
|
|
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">unregister</a> )(void)</td></tr> |
|
| 42 |
|
|
| 34 |
<tr><td colspan="2"><h2>Data Fields</h2></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#af0849c643f1b1e257ccfe96110109950">groupCode</a></td></tr> |
|
| 36 |
<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#a952b4b63982db13f55c02e17c55ab5ac">timeout_handler</a> )(void)</td></tr> |
|
| 37 |
<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">handle_response</a> )(int frame, int received)</td></tr> |
|
| 38 |
<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#a5c01636d72de2ddafc734ab754d93104">handle_receive</a> )(char type, int source, unsigned char *packet, int length)</td></tr> |
|
| 39 |
<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">unregister</a> )(void)</td></tr> |
|
| 43 | 40 |
</table> |
| 44 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
| 45 |
A <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> represents a packet group, and is used to register a packet group with the wireless library. It contains handlers for various events which can occur related to a packet group. <hr><h2>Field Documentation</h2> |
|
| 46 |
<a class="anchor" name="f0849c643f1b1e257ccfe96110109950"></a><!-- doxytag: member="PacketGroupHandler::groupCode" ref="f0849c643f1b1e257ccfe96110109950" args="" --> |
|
| 41 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
| 42 |
<p>A <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> represents a packet group, and is used to register a packet group with the wireless library. It contains handlers for various events which can occur related to a packet group. </p> |
|
| 43 |
<hr/><h2>Field Documentation</h2> |
|
| 44 |
<a class="anchor" id="af0849c643f1b1e257ccfe96110109950"></a><!-- doxytag: member="PacketGroupHandler::groupCode" ref="af0849c643f1b1e257ccfe96110109950" args="" --> |
|
| 47 | 45 |
<div class="memitem"> |
| 48 | 46 |
<div class="memproto"> |
| 49 | 47 |
<table class="memname"> |
| 50 | 48 |
<tr> |
| 51 |
<td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a> </td>
|
|
| 49 |
<td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#af0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a></td>
|
|
| 52 | 50 |
</tr> |
| 53 | 51 |
</table> |
| 54 | 52 |
</div> |
| 55 | 53 |
<div class="memdoc"> |
| 54 |
<p>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. </p> |
|
| 56 | 55 |
|
| 57 |
<p> |
|
| 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 | 56 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">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 | 57 |
|
| 61 | 58 |
</div> |
| 62 |
</div><p>
|
|
| 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 |
</div> |
|
| 60 |
<a class="anchor" id="a5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="a5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" -->
|
|
| 64 | 61 |
<div class="memitem"> |
| 65 | 62 |
<div class="memproto"> |
| 66 | 63 |
<table class="memname"> |
| 67 | 64 |
<tr> |
| 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>
|
|
| 65 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>)(char type, int source, unsigned char *packet, int length)</td>
|
|
| 69 | 66 |
</tr> |
| 70 | 67 |
</table> |
| 71 | 68 |
</div> |
| 72 | 69 |
<div class="memdoc"> |
| 73 |
|
|
| 74 |
<p> |
|
| 75 |
Called when we receive a packet from this group.<p> |
|
| 76 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 70 |
<p>Called when we receive a packet from this group.</p> |
|
| 71 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 77 | 72 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 78 | 73 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
| 79 | 74 |
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the 16-bit address of the XBee this packet was sent from </td></tr> |
| 80 | 75 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>the packet received </td></tr> |
| 81 | 76 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the packet </td></tr> |
| 82 | 77 |
</table> |
| 78 |
</dd> |
|
| 83 | 79 |
</dl> |
| 84 | 80 |
|
| 85 | 81 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p> |
| 86 | 82 |
|
| 87 | 83 |
</div> |
| 88 |
</div><p>
|
|
| 89 |
<a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->
|
|
| 84 |
</div> |
|
| 85 |
<a class="anchor" id="a045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="a045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->
|
|
| 90 | 86 |
<div class="memitem"> |
| 91 | 87 |
<div class="memproto"> |
| 92 | 88 |
<table class="memname"> |
| 93 | 89 |
<tr> |
| 94 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received) </td>
|
|
| 90 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received)</td>
|
|
| 95 | 91 |
</tr> |
| 96 | 92 |
</table> |
| 97 | 93 |
</div> |
| 98 | 94 |
<div class="memdoc"> |
| 99 |
|
|
| 100 |
<p> |
|
| 101 |
Called when a transmit status packet is received from the XBee where the first four bits of the frame are the group code.<p> |
|
| 102 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 95 |
<p>Called when a transmit status packet is received from the XBee where the first four bits of the frame are the group code.</p> |
|
| 96 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 103 | 97 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 104 | 98 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the last four bits of the frame </td></tr> |
| 105 | 99 |
<tr><td valign="top"></td><td valign="top"><em>received</em> </td><td>is true if we received an ack, 0 if we did not. </td></tr> |
| 106 | 100 |
</table> |
| 101 |
</dd> |
|
| 107 | 102 |
</dl> |
| 108 | 103 |
|
| 109 | 104 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p> |
| 110 | 105 |
|
| 111 | 106 |
</div> |
| 112 |
</div><p>
|
|
| 113 |
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->
|
|
| 107 |
</div> |
|
| 108 |
<a class="anchor" id="a952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="a952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->
|
|
| 114 | 109 |
<div class="memitem"> |
| 115 | 110 |
<div class="memproto"> |
| 116 | 111 |
<table class="memname"> |
| 117 | 112 |
<tr> |
| 118 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void) </td>
|
|
| 113 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)</td>
|
|
| 119 | 114 |
</tr> |
| 120 | 115 |
</table> |
| 121 | 116 |
</div> |
| 122 | 117 |
<div class="memdoc"> |
| 118 |
<p>Called every half second (not in interrupt, but in wl_do). </p> |
|
| 123 | 119 |
|
| 124 |
<p> |
|
| 125 |
Called every half second (not in interrupt, but in wl_do). |
|
| 126 | 120 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>.</p> |
| 127 | 121 |
|
| 128 | 122 |
</div> |
| 129 |
</div><p>
|
|
| 130 |
<a class="anchor" name="c03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="c03247d5c07e97e35b1f557c0937b0eb" args=")(void)" -->
|
|
| 123 |
</div> |
|
| 124 |
<a class="anchor" id="ac03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="ac03247d5c07e97e35b1f557c0937b0eb" args=")(void)" -->
|
|
| 131 | 125 |
<div class="memitem"> |
| 132 | 126 |
<div class="memproto"> |
| 133 | 127 |
<table class="memname"> |
| 134 | 128 |
<tr> |
| 135 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void) </td>
|
|
| 129 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void)</td>
|
|
| 136 | 130 |
</tr> |
| 137 | 131 |
</table> |
| 138 | 132 |
</div> |
| 139 | 133 |
<div class="memdoc"> |
| 134 |
<p>Called for any cleanup when the network is turned off. </p> |
|
| 140 | 135 |
|
| 141 |
<p> |
|
| 142 |
Called for any cleanup when the network is turned off. |
|
| 143 | 136 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">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 | 137 |
|
| 145 | 138 |
</div> |
| 146 |
</div><p> |
|
| 147 |
<hr>The documentation for this struct was generated from the following file:<ul> |
|
| 148 |
<li><a class="el" href="wireless_8h_source.html">wireless.h</a></ul> |
|
| 149 | 139 |
</div> |
| 150 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
|
| 140 |
<hr/>The documentation for this struct was generated from the following file:<ul> |
|
| 141 |
<li><a class="el" href="wireless_8h_source.html">wireless.h</a></li> |
|
| 142 |
</ul> |
|
| 143 |
</div> |
|
| 144 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by |
|
| 151 | 145 |
<a href="http://www.doxygen.org/index.html"> |
| 152 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 146 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 153 | 147 |
</body> |
| 154 | 148 |
</html> |
| trunk/docs/libwireless/structPacketInfo.html | ||
|---|---|---|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 5 |
<title>libwireless: PacketInfo Struct Reference</title> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 11 |
<div class="navigation" id="top"> |
|
| 12 |
<div class="tabs"> |
|
| 13 |
<ul> |
|
| 14 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
| 15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
| 16 |
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 17 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 18 |
</ul> |
|
| 19 |
</div> |
|
| 20 |
<div class="tabs"> |
|
| 21 |
<ul> |
|
| 22 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 23 |
<li><a href="functions.html"><span>Data Fields</span></a></li> |
|
| 24 |
</ul> |
|
| 25 |
</div> |
|
| 26 |
</div> |
|
| 27 |
<div class="contents"> |
|
| 28 |
<h1>PacketInfo Struct Reference<br/> |
|
| 29 |
<small> |
|
| 30 |
[<a class="el" href="group__wl__basic.html">Wireless Basic</a>]</small> |
|
| 31 |
</h1><!-- doxytag: class="PacketInfo" --> |
|
| 32 |
<p>struct that contains relevant packet information |
|
| 33 |
<a href="#_details">More...</a></p> |
|
| 34 |
|
|
| 35 |
<p><code>#include <<a class="el" href="wl__basic_8h_source.html">wl_basic.h</a>></code></p> |
|
| 36 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 37 |
<tr><td colspan="2"><h2>Data Fields</h2></td></tr> |
|
| 38 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cb118e967bc10ed15b1d1dbb74a756e"></a><!-- doxytag: member="PacketInfo::new_flag" ref="a9cb118e967bc10ed15b1d1dbb74a756e" args="" --> |
|
| 39 |
char </td><td class="memItemRight" valign="bottom"><b>new_flag</b></td></tr> |
|
| 40 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ac0cc0c121b307fa63255440d929a21"></a><!-- doxytag: member="PacketInfo::type" ref="a6ac0cc0c121b307fa63255440d929a21" args="" --> |
|
| 41 |
char </td><td class="memItemRight" valign="bottom"><b>type</b></td></tr> |
|
| 42 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac70f098910997e6c16598b8303d016df"></a><!-- doxytag: member="PacketInfo::source" ref="ac70f098910997e6c16598b8303d016df" args="" --> |
|
| 43 |
int </td><td class="memItemRight" valign="bottom"><b>source</b></td></tr> |
|
| 44 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad133b278d7825df4a9d56868e26caadb"></a><!-- doxytag: member="PacketInfo::data" ref="ad133b278d7825df4a9d56868e26caadb" args="" --> |
|
| 45 |
unsigned char * </td><td class="memItemRight" valign="bottom"><b>data</b></td></tr> |
|
| 46 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad01cc93fdca09fcfe4e271ce635bd043"></a><!-- doxytag: member="PacketInfo::length" ref="ad01cc93fdca09fcfe4e271ce635bd043" args="" --> |
|
| 47 |
int </td><td class="memItemRight" valign="bottom"><b>length</b></td></tr> |
|
| 48 |
</table> |
|
| 49 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
| 50 |
<p>struct that contains relevant packet information </p> |
|
| 51 |
<hr/>The documentation for this struct was generated from the following file:<ul> |
|
| 52 |
<li><a class="el" href="wl__basic_8h_source.html">wl_basic.h</a></li> |
|
| 53 |
</ul> |
|
| 54 |
</div> |
|
| 55 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by |
|
| 56 |
<a href="http://www.doxygen.org/index.html"> |
|
| 57 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
|
| 58 |
</body> |
|
| 59 |
</html> |
|
| trunk/docs/libwireless/wireless_8h.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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<title>libwireless: wireless.h 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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 22 | 25 |
</div> |
| 23 | 26 |
</div> |
| 24 | 27 |
<div class="contents"> |
| 25 |
<h1>wireless.h File Reference</h1>Contains definitions for the wireless library.
|
|
| 26 |
<a href="#_details">More...</a>
|
|
| 27 |
<p> |
|
| 28 |
<h1>wireless.h File Reference</h1> |
|
| 29 |
<p>Contains definitions for the wireless library.
|
|
| 30 |
<a href="#_details">More...</a></p>
|
|
| 28 | 31 |
|
| 29 |
<p> |
|
| 30 |
<a href="wireless_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 31 |
<tr><td></td></tr> |
|
| 32 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
|
| 33 |
<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> |
|
| 34 |
|
|
| 35 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="wireless_8h.html#f083cc95511287866eeb4337fdc75eeb">WL_MAX_PACKET_GROUPS</a> 16</td></tr> |
|
| 37 |
|
|
| 38 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
| 39 |
<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> |
|
| 40 |
|
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b"></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#g66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a> (void)</td></tr> |
|
| 43 |
|
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="group__wireless.html#g66075ff87a1c9f2c0d7938a26c7830f2"></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#g5c1f1a0e20fc718e59edc29246afd703">wl_do</a> (void)</td></tr> |
|
| 46 |
|
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703"></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#g183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
|
| 49 |
|
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a packet group with the wireless library. <a href="group__wireless.html#g183343ed0594ec1c2b79bb4085d57107"></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#gcdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
|
| 52 |
|
|
| 53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a packet group with the wireless library. <a href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7"></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#g6e841a6ef0504538d8650a0a2f5fa869">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr> |
|
| 55 |
|
|
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="group__wireless.html#g6e841a6ef0504538d8650a0a2f5fa869"></a><br></td></tr> |
|
| 57 |
<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> |
|
| 58 |
|
|
| 59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="group__wireless.html#gf8fbadf62eeb754b98b200328fb7a8be"></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#gda6b187ea58cee5aec18725bf7f24b9a">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr> |
|
| 61 |
|
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="group__wireless.html#gda6b187ea58cee5aec18725bf7f24b9a"></a><br></td></tr> |
|
| 63 |
<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> |
|
| 64 |
|
|
| 65 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots in our PAN. <a href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr> |
|
| 66 |
<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> |
|
| 67 |
|
|
| 68 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="group__wireless.html#g754445d2353a70963a489651cff554c1"></a><br></td></tr> |
|
| 69 |
<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> |
|
| 70 |
|
|
| 71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr> |
|
| 72 |
<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> |
|
| 73 |
|
|
| 74 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d"></a><br></td></tr> |
|
| 75 |
<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> |
|
| 76 |
|
|
| 77 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr> |
|
| 78 |
<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> |
|
| 79 |
|
|
| 80 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="group__wireless.html#g6c75a84ff5f9a2bdc156aba522d2adf7"></a><br></td></tr> |
|
| 81 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless.h::wl_set_com_port" ref="g344dead0023100eb40f8670a92c9ce5c" args="(char *port)" --> |
|
| 82 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr> |
|
| 83 |
|
|
| 84 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
|
| 32 |
<p><a href="wireless_8h_source.html">Go to the source code of this file.</a></p> |
|
| 33 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 34 |
<tr><td colspan="2"><h2>Data Structures</h2></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr> |
|
| 36 |
<tr><td colspan="2"><h2>Defines</h2></td></tr> |
|
| 37 |
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="wireless_8h.html#af083cc95511287866eeb4337fdc75eeb">WL_MAX_PACKET_GROUPS</a> 16</td></tr> |
|
| 38 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
| 39 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaedd4562415e273ce6537f9c1a0f2701b">wl_init</a> (void)</td></tr> |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="group__wireless.html#gaedd4562415e273ce6537f9c1a0f2701b"></a><br/></td></tr> |
|
| 41 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga66075ff87a1c9f2c0d7938a26c7830f2">wl_terminate</a> (void)</td></tr> |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="group__wireless.html#ga66075ff87a1c9f2c0d7938a26c7830f2"></a><br/></td></tr> |
|
| 43 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703">wl_do</a> (void)</td></tr> |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703"></a><br/></td></tr> |
|
| 45 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga183343ed0594ec1c2b79bb4085d57107">wl_register_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a packet group with the wireless library. <a href="group__wireless.html#ga183343ed0594ec1c2b79bb4085d57107"></a><br/></td></tr> |
|
| 47 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gacdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a packet group with the wireless library. <a href="group__wireless.html#gacdbedf6465798abc7af3bf5fea3d4dd7"></a><br/></td></tr> |
|
| 49 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga6e841a6ef0504538d8650a0a2f5fa869">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr> |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="group__wireless.html#ga6e841a6ef0504538d8650a0a2f5fa869"></a><br/></td></tr> |
|
| 51 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaf8fbadf62eeb754b98b200328fb7a8be">wl_send_robot_to_robot_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr> |
|
| 52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="group__wireless.html#gaf8fbadf62eeb754b98b200328fb7a8be"></a><br/></td></tr> |
|
| 53 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gada6b187ea58cee5aec18725bf7f24b9a">wl_send_global_packet</a> (char group, char type, char *data, int len, char frame)</td></tr> |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="group__wireless.html#gada6b187ea58cee5aec18725bf7f24b9a"></a><br/></td></tr> |
|
| 55 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a> (char group, char type, char *data, int len, char frame)</td></tr> |
|
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots in our PAN. <a href="group__wireless.html#ga0a1a0e4d885f0e0dde87160a16daa0aa"></a><br/></td></tr> |
|
| 57 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga754445d2353a70963a489651cff554c1">wl_set_pan</a> (int pan)</td></tr> |
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="group__wireless.html#ga754445d2353a70963a489651cff554c1"></a><br/></td></tr> |
|
| 59 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr> |
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="group__wireless.html#ga4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br/></td></tr> |
|
| 61 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga51d3fe958d44fd92f0e0830ced13139d">wl_set_channel</a> (int channel)</td></tr> |
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="group__wireless.html#ga51d3fe958d44fd92f0e0830ced13139d"></a><br/></td></tr> |
|
| 63 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr> |
|
| 64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="group__wireless.html#ga2d65d3e35b193da4213755c4bf61ab6b"></a><br/></td></tr> |
|
| 65 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga6c75a84ff5f9a2bdc156aba522d2adf7">wl_get_xbee_id</a> (void)</td></tr> |
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="group__wireless.html#ga6c75a84ff5f9a2bdc156aba522d2adf7"></a><br/></td></tr> |
|
| 67 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless.h::wl_set_com_port" ref="ga344dead0023100eb40f8670a92c9ce5c" args="(char *port)" --> |
|
| 68 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr> |
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br/></td></tr> |
|
| 85 | 70 |
</table> |
| 86 |
<hr><h2>Detailed Description</h2> |
|
| 87 |
Contains definitions for the wireless library. |
|
| 88 |
<p> |
|
| 89 |
Copyright (c) 2007 Colony Project<p> |
|
| 90 |
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> |
|
| 91 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
|
| 92 |
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> |
|
| 93 |
Contains functions for the wireless library.<p> |
|
| 94 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
|
| 95 |
<hr><h2>Define Documentation</h2> |
|
| 96 |
<a class="anchor" name="f083cc95511287866eeb4337fdc75eeb"></a><!-- doxytag: member="wireless.h::WL_MAX_PACKET_GROUPS" ref="f083cc95511287866eeb4337fdc75eeb" args="" --> |
|
| 71 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
| 72 |
<p>Contains definitions for the wireless library. </p> |
|
| 73 |
<p>Copyright (c) 2007 Colony Project</p> |
|
| 74 |
<p>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> |
|
| 75 |
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> |
|
| 76 |
<p>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> |
|
| 77 |
<p>Contains functions for the wireless library.</p> |
|
| 78 |
<dl class="author"><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
|
| 79 |
<hr/><h2>Define Documentation</h2> |
|
| 80 |
<a class="anchor" id="af083cc95511287866eeb4337fdc75eeb"></a><!-- doxytag: member="wireless.h::WL_MAX_PACKET_GROUPS" ref="af083cc95511287866eeb4337fdc75eeb" args="" --> |
|
| 97 | 81 |
<div class="memitem"> |
| 98 | 82 |
<div class="memproto"> |
| 99 | 83 |
<table class="memname"> |
| 100 | 84 |
<tr> |
| 101 |
<td class="memname">#define WL_MAX_PACKET_GROUPS 16 </td>
|
|
| 85 |
<td class="memname">#define WL_MAX_PACKET_GROUPS 16</td> |
|
| 102 | 86 |
</tr> |
| 103 | 87 |
</table> |
| 104 | 88 |
</div> |
| 105 | 89 |
<div class="memdoc"> |
| 90 |
<p>The maximum number of packet groups. </p> |
|
| 106 | 91 |
|
| 107 |
<p> |
|
| 108 |
The maximum number of packet groups. |
|
| 109 | 92 |
<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 | 93 |
|
| 111 | 94 |
</div> |
| 112 |
</div><p> |
|
| 113 | 95 |
</div> |
| 114 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
|
| 96 |
</div> |
|
| 97 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by |
|
| 115 | 98 |
<a href="http://www.doxygen.org/index.html"> |
| 116 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 99 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 117 | 100 |
</body> |
| 118 | 101 |
</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"> |
|
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
| 3 |
<head> |
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
| 3 | 5 |
<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 --> |
|
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
| 8 |
</head> |
|
| 9 |
<body> |
|
| 10 |
<!-- Generated by Doxygen 1.6.1 --> |
|
| 8 | 11 |
<div class="navigation" id="top"> |
| 9 | 12 |
<div class="tabs"> |
| 10 | 13 |
<ul> |
| ... | ... | |
| 16 | 19 |
</div> |
| 17 | 20 |
</div> |
| 18 | 21 |
<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 |
<h1>Wireless Basic</h1> |
|
| 23 |
<p>Wireless abstraction for easily sending and receing packets.
|
|
| 24 |
<a href="#_details">More...</a></p>
|
|
| 22 | 25 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 23 |
<tr><td></td></tr> |
|
| 24 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
|
| 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>PacketInfo</b></td></tr> |
|
| 26 |
|
|
| 27 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
| 28 |
<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="" --> |
|
| 29 |
#define </td><td class="memItemRight" valign="bottom"><b>WL_BASIC_GROUP</b> 8</td></tr> |
|
| 30 |
|
|
| 31 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
| 32 |
<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> |
|
| 33 |
|
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr> |
|
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic::wl_basic_init_default" ref="ge482937c7c29521030a33ecbc5d2dd9d" args="(void)" --> |
|
| 36 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ge482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> (void)</td></tr> |
|
| 37 |
|
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <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__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
|
| 40 |
|
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="#gebc714e1bf382a98ac7a43762bf905c5"></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__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr> |
|
| 43 |
|
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to a single robot in Basic Group <a href="#gd5d7334484e49cc3cb9ebe2cfc323115"></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__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr> |
|
| 46 |
|
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="#g72d4f604603ef2541b5f4d3ae467938e"></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__wl__basic.html#g0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr> |
|
| 49 |
|
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">default packet handler if none is specified on init <a href="#g0ad976b2b61cca0081123606101c97cd"></a><br></td></tr> |
|
| 51 |
<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> |
|
| 52 |
|
|
| 53 |
<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="#gae39ab95ba4a1b2ba2736f844c03cee7"></a><br></td></tr> |
|
| 54 |
<tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
|
| 55 |
<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="" --> |
|
| 56 |
<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> |
|
| 57 |
|
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br></td></tr> |
|
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6c9a887fb0b719948025f195efff1af9"></a><!-- doxytag: member="wl_basic::current_packet" ref="g6c9a887fb0b719948025f195efff1af9" args="" --> |
|
| 60 |
struct PacketInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g6c9a887fb0b719948025f195efff1af9">current_packet</a></td></tr> |
|
| 61 |
|
|
| 62 |
<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> |
|
| 26 |
<tr><td colspan="2"><h2>Data Structures</h2></td></tr> |
|
| 27 |
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketInfo.html">PacketInfo</a></td></tr> |
|
| 28 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">struct that contains relevant packet information <a href="structPacketInfo.html#_details">More...</a><br/></td></tr> |
|
| 29 |
<tr><td colspan="2"><h2>Defines</h2></td></tr> |
|
| 30 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga366b705160e22c2a6c4ea2c3c22e3485"></a><!-- doxytag: member="wl_basic::WL_BASIC_GROUP" ref="ga366b705160e22c2a6c4ea2c3c22e3485" args="" --> |
|
| 31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga366b705160e22c2a6c4ea2c3c22e3485">WL_BASIC_GROUP</a> 8</td></tr> |
|
| 32 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">default wireless group for basic sending and receiving packets <br/></td></tr> |
|
| 33 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
| 34 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="#gaae4a8ae98cc33955ee20b6e481d47adf"></a><br/></td></tr> |
|
| 36 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> (void)</td></tr> |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <a href="#gae482937c7c29521030a33ecbc5d2dd9d"></a><br/></td></tr> |
|
| 38 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="#gaebc714e1bf382a98ac7a43762bf905c5"></a><br/></td></tr> |
|
| 40 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gad5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr> |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to a single robot in Basic Group <a href="#gad5d7334484e49cc3cb9ebe2cfc323115"></a><br/></td></tr> |
|
| 42 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr> |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="#ga72d4f604603ef2541b5f4d3ae467938e"></a><br/></td></tr> |
|
| 44 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr> |
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal default packet handler if none is specified on init <a href="#ga0ad976b2b61cca0081123606101c97cd"></a><br/></td></tr> |
|
| 46 |
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gad10a8456bc3d30d22fe1dbd40b6e0dbb">wl_basic_do_default</a> (void)</td></tr> |
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer <a href="#gad10a8456bc3d30d22fe1dbd40b6e0dbb"></a><br/></td></tr> |
|
| 48 |
<tr><td colspan="2"><h2>Variables</h2></td></tr> |
|
| 49 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic::wl_basic_group_handler" ref="gaf0fa88111d706ef4e8b3bda5bc32596c" args="" --> |
|
| 50 |
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr> |
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br/></td></tr> |
|
| 52 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6c9a887fb0b719948025f195efff1af9"></a><!-- doxytag: member="wl_basic::current_packet" ref="ga6c9a887fb0b719948025f195efff1af9" args="" --> |
|
| 53 |
struct <a class="el" href="structPacketInfo.html">PacketInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga6c9a887fb0b719948025f195efff1af9">current_packet</a></td></tr> |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">current packet information, correct after wl_basic_do() <br/></td></tr> |
|
| 63 | 55 |
</table> |
| 64 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
| 65 |
Wireless abstraction for easily sending and receing packets.
|
|
| 66 |
<p> |
|
| 67 |
A high level abstraction of the wireless library.<p>
|
|
| 68 |
This will allow you to easily send and receive packets. <hr><h2>Function Documentation</h2>
|
|
| 69 |
<a class="anchor" name="gae39ab95ba4a1b2ba2736f844c03cee7"></a><!-- doxytag: member="wl_basic.h::wl_basic_do" ref="gae39ab95ba4a1b2ba2736f844c03cee7" args="(void)" -->
|
|
| 56 |
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
| 57 |
<p>Wireless abstraction for easily sending and receing packets. </p>
|
|
| 58 |
<p>A high level abstraction of the wireless library.</p>
|
|
| 59 |
<p>This will allow you to easily send and receive packets. </p>
|
|
| 60 |
<hr/><h2>Function Documentation</h2>
|
|
| 61 |
<a class="anchor" id="gad10a8456bc3d30d22fe1dbd40b6e0dbb"></a><!-- doxytag: member="wl_basic.h::wl_basic_do_default" ref="gad10a8456bc3d30d22fe1dbd40b6e0dbb" args="(void)" -->
|
|
| 70 | 62 |
<div class="memitem"> |
| 71 | 63 |
<div class="memproto"> |
| 72 | 64 |
<table class="memname"> |
| 73 | 65 |
<tr> |
| 74 |
<td class="memname">unsigned char* wl_basic_do </td>
|
|
| 66 |
<td class="memname">unsigned char* wl_basic_do_default </td>
|
|
| 75 | 67 |
<td>(</td> |
| 76 | 68 |
<td class="paramtype">void </td> |
| 77 |
<td class="paramname"> </td>
|
|
| 69 |
<td class="paramname"></td> |
|
| 78 | 70 |
<td> ) </td> |
| 79 | 71 |
<td></td> |
| 80 | 72 |
</tr> |
| ... | ... | |
| 82 | 74 |
</div> |
| 83 | 75 |
<div class="memdoc"> |
| 84 | 76 |
|
| 85 |
<p> |
|
| 86 |
wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer |
|
| 87 |
<p> |
|
| 88 |
Wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a><p> |
|
| 89 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the data of the packet just received </dd></dl> |
|
| 77 |
<p>wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer </p> |
|
| 78 |
<p>Wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> for use with the Basic Wireless group. Can only be called if wl_basic_init_default and your packets are handled with the default packet handler. To access packet information, use <a class="el" href="structPacketInfo.html" title="struct that contains relevant packet information">PacketInfo</a> current_packet.</p> |
|
| 79 |
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the data of the packet just received, 0 if no new packet </dd></dl> |
|
| 90 | 80 |
|
| 91 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>
|
|
| 81 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00046">current_packet</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>
|
|
| 92 | 82 |
|
| 93 | 83 |
</div> |
| 94 |
</div><p>
|
|
| 95 |
<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))" -->
|
|
| 84 |
</div> |
|
| 85 |
<a class="anchor" id="gaae4a8ae98cc33955ee20b6e481d47adf"></a><!-- doxytag: member="wl_basic.h::wl_basic_init" ref="gaae4a8ae98cc33955ee20b6e481d47adf" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" -->
|
|
| 96 | 86 |
<div class="memitem"> |
| 97 | 87 |
<div class="memproto"> |
| 98 | 88 |
<table class="memname"> |
| 99 | 89 |
<tr> |
| 100 |
<td class="memname">int wl_basic_init </td>
|
|
| 90 |
<td class="memname">int wl_basic_init </td> |
|
| 101 | 91 |
<td>(</td> |
| 102 | 92 |
<td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length) </td> |
| 103 |
<td class="paramname"> <em>handle_receive</em> </td>
|
|
| 93 |
<td class="paramname"> <em>handle_receive</em></td> |
|
| 104 | 94 |
<td> ) </td> |
| 105 | 95 |
<td></td> |
| 106 | 96 |
</tr> |
| ... | ... | |
| 108 | 98 |
</div> |
| 109 | 99 |
<div class="memdoc"> |
| 110 | 100 |
|
| 111 |
<p> |
|
| 112 |
init wireless for Basic Group |
|
| 113 |
<p> |
|
| 114 |
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> |
|
| 115 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 101 |
<p>init wireless for Basic Group </p> |
|
| 102 |
<p>Wrapper for <a class="el" href="group__wireless.html#gaedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init()</a>. Initializes wireless and registers a packet handler function for Basic Group.</p> |
|
| 103 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 116 | 104 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 117 | 105 |
<tr><td valign="top"></td><td valign="top"><em>handle_receive</em> </td><td>function pointer to handler function for Basic Group </td></tr> |
| 118 | 106 |
</table> |
| 107 |
</dd> |
|
| 119 | 108 |
</dl> |
| 120 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl>
|
|
| 109 |
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl> |
|
| 121 | 110 |
|
| 122 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>, <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>
|
|
| 111 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00046">current_packet</a>, <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p>
|
|
| 123 | 112 |
|
| 124 | 113 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_init_default()</a>.</p> |
| 125 | 114 |
|
| 126 | 115 |
</div> |
| 127 |
</div><p>
|
|
| 128 |
<a class="anchor" name="g0ad976b2b61cca0081123606101c97cd"></a><!-- doxytag: member="wl_basic.h::wl_basic_packet_receive_handler" ref="g0ad976b2b61cca0081123606101c97cd" args="(char type, int source, unsigned char *packet, int length)" -->
|
|
| 116 |
</div> |
|
| 117 |
<a class="anchor" id="gae482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic.h::wl_basic_init_default" ref="gae482937c7c29521030a33ecbc5d2dd9d" args="(void)" -->
|
|
| 129 | 118 |
<div class="memitem"> |
| 130 | 119 |
<div class="memproto"> |
| 131 | 120 |
<table class="memname"> |
| 132 | 121 |
<tr> |
| 133 |
<td class="memname">void wl_basic_packet_receive_handler </td>
|
|
| 122 |
<td class="memname">int wl_basic_init_default </td>
|
|
| 134 | 123 |
<td>(</td> |
| 124 |
<td class="paramtype">void </td> |
|
| 125 |
<td class="paramname"></td> |
|
| 126 |
<td> ) </td> |
|
| 127 |
<td></td> |
|
| 128 |
</tr> |
|
| 129 |
</table> |
|
| 130 |
</div> |
|
| 131 |
<div class="memdoc"> |
|
| 132 |
|
|
| 133 |
<p>init wireless for Basic Group with default packet handling </p> |
|
| 134 |
<p>Wrapper for <a class="el" href="group__wireless.html#gaedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init()</a>. Initializes wireless and registers the default packet handler for Basig Group. </p> |
|
| 135 |
|
|
| 136 |
<p>References <a class="el" href="wl__basic_8c_source.html#l00020">wl_basic_init()</a>, and <a class="el" href="wl__basic_8c_source.html#l00085">wl_basic_packet_receive_handler()</a>.</p> |
|
| 137 |
|
|
| 138 |
</div> |
|
| 139 |
</div> |
|
| 140 |
<a class="anchor" id="ga0ad976b2b61cca0081123606101c97cd"></a><!-- doxytag: member="wl_basic.h::wl_basic_packet_receive_handler" ref="ga0ad976b2b61cca0081123606101c97cd" args="(char type, int source, unsigned char *packet, int length)" --> |
|
| 141 |
<div class="memitem"> |
|
| 142 |
<div class="memproto"> |
|
| 143 |
<table class="memname"> |
|
| 144 |
<tr> |
|
| 145 |
<td class="memname">void wl_basic_packet_receive_handler </td> |
|
| 146 |
<td>(</td> |
|
| 135 | 147 |
<td class="paramtype">char </td> |
| 136 | 148 |
<td class="paramname"> <em>type</em>, </td> |
| 137 | 149 |
</tr> |
| ... | ... | |
| 162 | 174 |
</div> |
| 163 | 175 |
<div class="memdoc"> |
| 164 | 176 |
|
| 165 |
<p> |
|
| 166 |
default packet handler if none is specified on init |
|
| 167 |
<p> |
|
| 168 |
Default packet handler used if none is specified on init<p> |
|
| 169 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 177 |
<p>internal default packet handler if none is specified on init </p> |
|
| 178 |
<p>Default packet handler used if none is specified on init. This should not be called directly by any user program.</p> |
|
| 179 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 170 | 180 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 171 | 181 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Packet type </td></tr> |
| 172 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Packet buffer, data you received </td></tr> |
|
| 182 |
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the robot ID of the sending robot </td></tr> |
|
| 183 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>Packet buffer, data you received </td></tr> |
|
| 173 | 184 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>Length of the data buffer in bytes </td></tr> |
| 174 | 185 |
</table> |
| 186 |
</dd> |
|
| 175 | 187 |
</dl> |
| 176 | 188 |
|
| 177 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>.</p>
|
|
| 189 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00046">current_packet</a>.</p>
|
|
| 178 | 190 |
|
| 179 | 191 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_init_default()</a>.</p> |
| 180 | 192 |
|
| 181 | 193 |
</div> |
| 182 |
</div><p>
|
|
| 183 |
<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))" -->
|
|
| 194 |
</div> |
|
| 195 |
<a class="anchor" id="gaebc714e1bf382a98ac7a43762bf905c5"></a><!-- doxytag: member="wl_basic.h::wl_basic_register_handler" ref="gaebc714e1bf382a98ac7a43762bf905c5" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" -->
|
|
| 184 | 196 |
<div class="memitem"> |
| 185 | 197 |
<div class="memproto"> |
| 186 | 198 |
<table class="memname"> |
| 187 | 199 |
<tr> |
| 188 |
<td class="memname">void wl_basic_register_handler </td>
|
|
| 200 |
<td class="memname">void wl_basic_register_handler </td> |
|
| 189 | 201 |
<td>(</td> |
| 190 | 202 |
<td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length) </td> |
| 191 |
<td class="paramname"> <em>handle_receive</em> </td>
|
|
| 203 |
<td class="paramname"> <em>handle_receive</em></td> |
|
| 192 | 204 |
<td> ) </td> |
| 193 | 205 |
<td></td> |
| 194 | 206 |
</tr> |
| ... | ... | |
| 196 | 208 |
</div> |
| 197 | 209 |
<div class="memdoc"> |
| 198 | 210 |
|
| 199 |
<p> |
|
| 200 |
internal function to register a packet handler function |
|
| 201 |
<p> |
|
| 202 |
Internal function to register a packet group handler for Basic Group<p> |
|
| 203 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 211 |
<p>internal function to register a packet handler function </p> |
|
| 212 |
<p>Internal function to register a packet group handler for Basic Group.</p> |
|
| 213 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 204 | 214 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 205 | 215 |
<tr><td valign="top"></td><td valign="top"><em>handle_receive</em> </td><td>function pointer to handler function for Basic Group </td></tr> |
| 206 | 216 |
</table> |
| 217 |
</dd> |
|
| 207 | 218 |
</dl> |
| 208 | 219 |
|
| 209 |
<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#l00044">wl_basic_group_handler</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>
|
|
| 220 |
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, <a class="el" href="structPacketGroupHandler.html#a5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>, <a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>, <a class="el" href="structPacketGroupHandler.html#a952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>, <a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wl__basic_8h_source.html#l00027">WL_BASIC_GROUP</a>, <a class="el" href="wl__basic_8h_source.html#l00030">wl_basic_group_handler</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>
|
|
| 210 | 221 |
|
| 211 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00021">wl_basic_init()</a>.</p>
|
|
| 222 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00020">wl_basic_init()</a>.</p>
|
|
| 212 | 223 |
|
| 213 | 224 |
</div> |
| 214 |
</div><p>
|
|
| 215 |
<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)" -->
|
|
| 225 |
</div> |
|
| 226 |
<a class="anchor" id="ga72d4f604603ef2541b5f4d3ae467938e"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_global_packet" ref="ga72d4f604603ef2541b5f4d3ae467938e" args="(char type, char *data, int len)" -->
|
|
| 216 | 227 |
<div class="memitem"> |
| 217 | 228 |
<div class="memproto"> |
| 218 | 229 |
<table class="memname"> |
| 219 | 230 |
<tr> |
| 220 |
<td class="memname">void wl_basic_send_global_packet </td>
|
|
| 231 |
<td class="memname">void wl_basic_send_global_packet </td> |
|
| 221 | 232 |
<td>(</td> |
| 222 | 233 |
<td class="paramtype">char </td> |
| 223 | 234 |
<td class="paramname"> <em>type</em>, </td> |
| ... | ... | |
| 243 | 254 |
</div> |
| 244 | 255 |
<div class="memdoc"> |
| 245 | 256 |
|
| 246 |
<p> |
|
| 247 |
send a packet to all robots in Basic Group |
|
| 248 |
<p> |
|
| 249 |
Send a packet to all robots in Basic Group<p> |
|
| 250 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 257 |
<p>send a packet to all robots in Basic Group </p> |
|
| 258 |
<p>Send a packet to all robots in Basic Group.</p> |
|
| 259 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 251 | 260 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 252 | 261 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Packet type </td></tr> |
| 253 | 262 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Packet buffer, data you want to send </td></tr> |
| 254 | 263 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data buffer in bytes </td></tr> |
| 255 | 264 |
</table> |
| 265 |
</dd> |
|
| 256 | 266 |
</dl> |
| 257 | 267 |
|
| 258 |
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p> |
|
| 268 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00027">WL_BASIC_GROUP</a>, and <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p>
|
|
| 259 | 269 |
|
| 260 | 270 |
</div> |
| 261 |
</div><p>
|
|
| 262 |
<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)" -->
|
|
| 271 |
</div> |
|
| 272 |
<a class="anchor" id="gad5d7334484e49cc3cb9ebe2cfc323115"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_robot_packet" ref="gad5d7334484e49cc3cb9ebe2cfc323115" args="(char type, char *data, int len, int dest)" -->
|
|
| 263 | 273 |
<div class="memitem"> |
| 264 | 274 |
<div class="memproto"> |
| 265 | 275 |
<table class="memname"> |
| 266 | 276 |
<tr> |
| 267 |
<td class="memname">void wl_basic_send_robot_packet </td>
|
|
| 277 |
<td class="memname">void wl_basic_send_robot_packet </td> |
|
| 268 | 278 |
<td>(</td> |
| 269 | 279 |
<td class="paramtype">char </td> |
| 270 | 280 |
<td class="paramname"> <em>type</em>, </td> |
| ... | ... | |
| 296 | 306 |
</div> |
| 297 | 307 |
<div class="memdoc"> |
| 298 | 308 |
|
| 299 |
<p> |
|
| 300 |
send a packet to a single robot in Basic Group |
|
| 301 |
<p> |
|
| 302 |
Send a packet to a single robot in Basic Group<p> |
|
| 303 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 309 |
<p>send a packet to a single robot in Basic Group </p> |
|
| 310 |
<p>Send a packet to a single robot in Basic Group.</p> |
|
| 311 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
| 304 | 312 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 305 | 313 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Packet type </td></tr> |
| 306 | 314 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Packet buffer, data you want to send </td></tr> |
| 307 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data buffer in bytes Robot ID of the destination robot </td></tr> |
|
| 315 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data buffer in bytes </td></tr> |
|
| 316 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Robot ID of the destination robot </td></tr> |
|
| 308 | 317 |
</table> |
| 318 |
</dd> |
|
| 309 | 319 |
</dl> |
| 310 | 320 |
|
| 311 |
<p>References <a class="el" href="wireless_8c_source.html#l00252">wl_send_robot_to_robot_global_packet()</a>.</p> |
|
| 321 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00027">WL_BASIC_GROUP</a>, and <a class="el" href="wireless_8c_source.html#l00252">wl_send_robot_to_robot_global_packet()</a>.</p>
|
|
| 312 | 322 |
|
| 313 | 323 |
</div> |
| 314 |
</div><p> |
|
| 315 | 324 |
</div> |
| 316 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
|
| 325 |
</div> |
|
| 326 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by |
|
| 317 | 327 |
<a href="http://www.doxygen.org/index.html"> |
| 318 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 328 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
| 319 | 329 |
</body> |
Also available in: Unified diff