root / trunk / docs / libwireless / group__wireless.html @ 1380
History | View | Annotate | Download (30.8 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libwireless: Wireless</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 -->
|
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul>
|
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 13 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 14 |
<li><a href="files.html"><span>Files</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
</div>
|
| 18 |
<div class="contents"> |
| 19 |
<h1>Wireless</h1>Wireless definitions. |
| 20 |
<a href="#_details">More...</a> |
| 21 |
<p>
|
| 22 |
<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"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr> |
| 26 |
|
| 27 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 28 |
<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> |
| 29 |
|
| 30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the wireless library. <a href="#gedd4562415e273ce6537f9c1a0f2701b"></a><br></td></tr> |
| 31 |
<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> |
| 32 |
|
| 33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the wireless library. <a href="#g66075ff87a1c9f2c0d7938a26c7830f2"></a><br></td></tr> |
| 34 |
<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> |
| 35 |
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform wireless library functionality. <a href="#g5c1f1a0e20fc718e59edc29246afd703"></a><br></td></tr> |
| 37 |
<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> |
| 38 |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a packet group with the wireless library. <a href="#g183343ed0594ec1c2b79bb4085d57107"></a><br></td></tr> |
| 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gcdbedf6465798abc7af3bf5fea3d4dd7">wl_unregister_packet_group</a> (<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> *h)</td></tr> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a packet group with the wireless library. <a href="#gcdbedf6465798abc7af3bf5fea3d4dd7"></a><br></td></tr> |
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6e841a6ef0504538d8650a0a2f5fa869">wl_send_robot_to_robot_global_packet</a> (char group, char type, char *data, int len, int dest, char frame)</td></tr> |
| 44 |
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in any PAN. <a href="#g6e841a6ef0504538d8650a0a2f5fa869"></a><br></td></tr> |
| 46 |
<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> |
| 47 |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to a specific robot in our PAN. <a href="#gf8fbadf62eeb754b98b200328fb7a8be"></a><br></td></tr> |
| 49 |
<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> |
| 50 |
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots. <a href="#gda6b187ea58cee5aec18725bf7f24b9a"></a><br></td></tr> |
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g0a1a0e4d885f0e0dde87160a16daa0aa">wl_send_pan_packet</a> (char group, char type, char *data, int len, char frame)</td></tr> |
| 53 |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to all robots in our PAN. <a href="#g0a1a0e4d885f0e0dde87160a16daa0aa"></a><br></td></tr> |
| 55 |
<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> |
| 56 |
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN we are using. <a href="#g754445d2353a70963a489651cff554c1"></a><br></td></tr> |
| 58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7">wl_get_pan</a> (void)</td></tr> |
| 59 |
|
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the PAN we are using. <a href="#g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><br></td></tr> |
| 61 |
<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> |
| 62 |
|
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel we are using. <a href="#g51d3fe958d44fd92f0e0830ced13139d"></a><br></td></tr> |
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b">wl_get_channel</a> (void)</td></tr> |
| 65 |
|
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel we are using. <a href="#g2d65d3e35b193da4213755c4bf61ab6b"></a><br></td></tr> |
| 67 |
<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> |
| 68 |
|
| 69 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 16-bit address of the XBee module. <a href="#g6c75a84ff5f9a2bdc156aba522d2adf7"></a><br></td></tr> |
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g344dead0023100eb40f8670a92c9ce5c"></a><!-- doxytag: member="wireless::wl_set_com_port" ref="g344dead0023100eb40f8670a92c9ce5c" args="(char *port)" --> |
| 71 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g344dead0023100eb40f8670a92c9ce5c">wl_set_com_port</a> (char *port)</td></tr> |
| 72 |
|
| 73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
| 74 |
</table>
|
| 75 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 76 |
Wireless definitions. |
| 77 |
<p>
|
| 78 |
Contains functions and definitions for dealing with wireless functionality.<br>
|
| 79 |
<br>
|
| 80 |
<p>
|
| 81 |
The wireless library provides a modular method for dealing with wireless packets, by allowing packet groups to be registered. A packet group is a collection of packets which share a packet group code. Each packet in the group also has a type. A packet group code and type are sent with each packet. When a packet with a group code registered in the wireless library is received, the corresponding event handler is called. The event handler uses the packet type and other information stored in the packet to respond.<br>
|
| 82 |
<br>
|
| 83 |
<p>
|
| 84 |
This architecture allows different wireless functionality to be defined and handled separately, making it simpler and more efficient to take advantage of the XBee's wireless functionality. <hr><h2>Function Documentation</h2> |
| 85 |
<a class="anchor" name="g5c1f1a0e20fc718e59edc29246afd703"></a><!-- doxytag: member="wireless.h::wl_do" ref="g5c1f1a0e20fc718e59edc29246afd703" args="(void)" --> |
| 86 |
<div class="memitem"> |
| 87 |
<div class="memproto"> |
| 88 |
<table class="memname"> |
| 89 |
<tr>
|
| 90 |
<td class="memname">void wl_do </td> |
| 91 |
<td>(</td> |
| 92 |
<td class="paramtype">void </td> |
| 93 |
<td class="paramname"> </td> |
| 94 |
<td> ) </td> |
| 95 |
<td></td> |
| 96 |
</tr>
|
| 97 |
</table>
|
| 98 |
</div>
|
| 99 |
<div class="memdoc"> |
| 100 |
|
| 101 |
<p>
|
| 102 |
Perform wireless library functionality. |
| 103 |
<p>
|
| 104 |
Performs wireless library functionality. This function must be called frequently for wireless to perform effectively. This function will call timeout handlers, as well as received packet and transmit status handlers. |
| 105 |
<p>References <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="xbee_8c_source.html#l00725">xbee_get_packet()</a>, <a class="el" href="xbee_8h_source.html#l00074">XBEE_RX</a>, and <a class="el" href="xbee_8h_source.html#l00072">XBEE_TX_STATUS</a>.</p> |
| 106 |
|
| 107 |
</div>
|
| 108 |
</div><p> |
| 109 |
<a class="anchor" name="g2d65d3e35b193da4213755c4bf61ab6b"></a><!-- doxytag: member="wireless.h::wl_get_channel" ref="g2d65d3e35b193da4213755c4bf61ab6b" args="(void)" --> |
| 110 |
<div class="memitem"> |
| 111 |
<div class="memproto"> |
| 112 |
<table class="memname"> |
| 113 |
<tr>
|
| 114 |
<td class="memname">int wl_get_channel </td> |
| 115 |
<td>(</td> |
| 116 |
<td class="paramtype">void </td> |
| 117 |
<td class="paramname"> </td> |
| 118 |
<td> ) </td> |
| 119 |
<td></td> |
| 120 |
</tr>
|
| 121 |
</table>
|
| 122 |
</div>
|
| 123 |
<div class="memdoc"> |
| 124 |
|
| 125 |
<p>
|
| 126 |
Get the channel we are using. |
| 127 |
<p>
|
| 128 |
Get the channel the XBee is part of.<p>
|
| 129 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is part of</dd></dl> |
| 130 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g51d3fe958d44fd92f0e0830ced13139d" title="Set the channel we are using.">wl_set_channel</a> </dd></dl> |
| 131 |
|
| 132 |
<p>References <a class="el" href="xbee_8c_source.html#l00993">xbee_get_channel()</a>.</p> |
| 133 |
|
| 134 |
</div>
|
| 135 |
</div><p> |
| 136 |
<a class="anchor" name="g4e6b5c97d40a8e7557a1b4b90a7d34f7"></a><!-- doxytag: member="wireless.h::wl_get_pan" ref="g4e6b5c97d40a8e7557a1b4b90a7d34f7" args="(void)" --> |
| 137 |
<div class="memitem"> |
| 138 |
<div class="memproto"> |
| 139 |
<table class="memname"> |
| 140 |
<tr>
|
| 141 |
<td class="memname">int wl_get_pan </td> |
| 142 |
<td>(</td> |
| 143 |
<td class="paramtype">void </td> |
| 144 |
<td class="paramname"> </td> |
| 145 |
<td> ) </td> |
| 146 |
<td></td> |
| 147 |
</tr>
|
| 148 |
</table>
|
| 149 |
</div>
|
| 150 |
<div class="memdoc"> |
| 151 |
|
| 152 |
<p>
|
| 153 |
Get the PAN we are using. |
| 154 |
<p>
|
| 155 |
Get the PAN the XBee is currently part of.<p>
|
| 156 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the PAN of the XBee</dd></dl> |
| 157 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g754445d2353a70963a489651cff554c1" title="Set the PAN we are using.">wl_set_pan</a> </dd></dl> |
| 158 |
|
| 159 |
<p>References <a class="el" href="xbee_8c_source.html#l00955">xbee_get_pan_id()</a>.</p> |
| 160 |
|
| 161 |
</div>
|
| 162 |
</div><p> |
| 163 |
<a class="anchor" name="g6c75a84ff5f9a2bdc156aba522d2adf7"></a><!-- doxytag: member="wireless.h::wl_get_xbee_id" ref="g6c75a84ff5f9a2bdc156aba522d2adf7" args="(void)" --> |
| 164 |
<div class="memitem"> |
| 165 |
<div class="memproto"> |
| 166 |
<table class="memname"> |
| 167 |
<tr>
|
| 168 |
<td class="memname">int wl_get_xbee_id </td> |
| 169 |
<td>(</td> |
| 170 |
<td class="paramtype">void </td> |
| 171 |
<td class="paramname"> </td> |
| 172 |
<td> ) </td> |
| 173 |
<td></td> |
| 174 |
</tr>
|
| 175 |
</table>
|
| 176 |
</div>
|
| 177 |
<div class="memdoc"> |
| 178 |
|
| 179 |
<p>
|
| 180 |
Get the 16-bit address of the XBee module. |
| 181 |
<p>
|
| 182 |
Returns the 16-bit address of the XBee module.<p>
|
| 183 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee module. </dd></dl> |
| 184 |
|
| 185 |
<p>References <a class="el" href="xbee_8c_source.html#l01007">xbee_get_address()</a>.</p> |
| 186 |
|
| 187 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00367">wl_token_get_my_sensor_reading()</a>, <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p> |
| 188 |
|
| 189 |
</div>
|
| 190 |
</div><p> |
| 191 |
<a class="anchor" name="gedd4562415e273ce6537f9c1a0f2701b"></a><!-- doxytag: member="wireless.h::wl_init" ref="gedd4562415e273ce6537f9c1a0f2701b" args="(void)" --> |
| 192 |
<div class="memitem"> |
| 193 |
<div class="memproto"> |
| 194 |
<table class="memname"> |
| 195 |
<tr>
|
| 196 |
<td class="memname">int wl_init </td> |
| 197 |
<td>(</td> |
| 198 |
<td class="paramtype">void </td> |
| 199 |
<td class="paramname"> </td> |
| 200 |
<td> ) </td> |
| 201 |
<td></td> |
| 202 |
</tr>
|
| 203 |
</table>
|
| 204 |
</div>
|
| 205 |
<div class="memdoc"> |
| 206 |
|
| 207 |
<p>
|
| 208 |
Initialize the wireless library. |
| 209 |
<p>
|
| 210 |
Initializes the wireless library. Must be called before any other function.<p>
|
| 211 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 212 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 213 |
<tr><td valign="top"></td><td valign="top"><em>wl_port</em> </td><td>File descriptor for wireless port, or NULL for default. </td></tr> |
| 214 |
</table>
|
| 215 |
</dl>
|
| 216 |
|
| 217 |
<p>References <a class="el" href="wireless_8h_source.html#l00047">WL_MAX_PACKET_GROUPS</a>, and <a class="el" href="xbee_8c_source.html#l00206">xbee_lib_init()</a>.</p> |
| 218 |
|
| 219 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00021">wl_basic_init()</a>.</p> |
| 220 |
|
| 221 |
</div>
|
| 222 |
</div><p> |
| 223 |
<a class="anchor" name="g183343ed0594ec1c2b79bb4085d57107"></a><!-- doxytag: member="wireless.h::wl_register_packet_group" ref="g183343ed0594ec1c2b79bb4085d57107" args="(PacketGroupHandler *h)" --> |
| 224 |
<div class="memitem"> |
| 225 |
<div class="memproto"> |
| 226 |
<table class="memname"> |
| 227 |
<tr>
|
| 228 |
<td class="memname">void wl_register_packet_group </td> |
| 229 |
<td>(</td> |
| 230 |
<td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> * </td> |
| 231 |
<td class="paramname"> <em>h</em> </td> |
| 232 |
<td> ) </td> |
| 233 |
<td></td> |
| 234 |
</tr>
|
| 235 |
</table>
|
| 236 |
</div>
|
| 237 |
<div class="memdoc"> |
| 238 |
|
| 239 |
<p>
|
| 240 |
Register a packet group with the wireless library. |
| 241 |
<p>
|
| 242 |
Register a packet group with the wireless library. The event handlers in the packet group will be called whenever an event dealing with the packet group's group code occurs.<p>
|
| 243 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 244 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 245 |
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>the <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> to register </td></tr> |
| 246 |
</table>
|
| 247 |
</dl>
|
| 248 |
|
| 249 |
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, and <a class="el" href="wireless_8h_source.html#l00047">WL_MAX_PACKET_GROUPS</a>.</p> |
| 250 |
|
| 251 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, <a class="el" href="wl__error__group_8c_source.html#l00066">wl_error_register()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p> |
| 252 |
|
| 253 |
</div>
|
| 254 |
</div><p> |
| 255 |
<a class="anchor" name="gda6b187ea58cee5aec18725bf7f24b9a"></a><!-- doxytag: member="wireless.h::wl_send_global_packet" ref="gda6b187ea58cee5aec18725bf7f24b9a" args="(char group, char type, char *data, int len, char frame)" --> |
| 256 |
<div class="memitem"> |
| 257 |
<div class="memproto"> |
| 258 |
<table class="memname"> |
| 259 |
<tr>
|
| 260 |
<td class="memname">int wl_send_global_packet </td> |
| 261 |
<td>(</td> |
| 262 |
<td class="paramtype">char </td> |
| 263 |
<td class="paramname"> <em>group</em>, </td> |
| 264 |
</tr>
|
| 265 |
<tr>
|
| 266 |
<td class="paramkey"></td> |
| 267 |
<td></td> |
| 268 |
<td class="paramtype">char </td> |
| 269 |
<td class="paramname"> <em>type</em>, </td> |
| 270 |
</tr>
|
| 271 |
<tr>
|
| 272 |
<td class="paramkey"></td> |
| 273 |
<td></td> |
| 274 |
<td class="paramtype">char * </td> |
| 275 |
<td class="paramname"> <em>data</em>, </td> |
| 276 |
</tr>
|
| 277 |
<tr>
|
| 278 |
<td class="paramkey"></td> |
| 279 |
<td></td> |
| 280 |
<td class="paramtype">int </td> |
| 281 |
<td class="paramname"> <em>len</em>, </td> |
| 282 |
</tr>
|
| 283 |
<tr>
|
| 284 |
<td class="paramkey"></td> |
| 285 |
<td></td> |
| 286 |
<td class="paramtype">char </td> |
| 287 |
<td class="paramname"> <em>frame</em></td><td> </td> |
| 288 |
</tr>
|
| 289 |
<tr>
|
| 290 |
<td></td> |
| 291 |
<td>)</td> |
| 292 |
<td></td><td></td><td></td> |
| 293 |
</tr>
|
| 294 |
</table>
|
| 295 |
</div>
|
| 296 |
<div class="memdoc"> |
| 297 |
|
| 298 |
<p>
|
| 299 |
Send a packet to all robots. |
| 300 |
<p>
|
| 301 |
Send a packet to all XBees in all PANs.<p>
|
| 302 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 303 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 304 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
| 305 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
| 306 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
| 307 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
| 308 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
| 309 |
</table>
|
| 310 |
</dl>
|
| 311 |
|
| 312 |
<p>References <a class="el" href="xbee_8h_source.html#l00064">XBEE_BROADCAST</a>, and <a class="el" href="xbee_8h_source.html#l00070">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>.</p> |
| 313 |
|
| 314 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00063">wl_basic_send_global_packet()</a>, <a class="el" href="wl__error__group_8c_source.html#l00123">wl_error_send_string()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00141">wl_token_ring_join()</a>.</p> |
| 315 |
|
| 316 |
</div>
|
| 317 |
</div><p> |
| 318 |
<a class="anchor" name="g0a1a0e4d885f0e0dde87160a16daa0aa"></a><!-- doxytag: member="wireless.h::wl_send_pan_packet" ref="g0a1a0e4d885f0e0dde87160a16daa0aa" args="(char group, char type, char *data, int len, char frame)" --> |
| 319 |
<div class="memitem"> |
| 320 |
<div class="memproto"> |
| 321 |
<table class="memname"> |
| 322 |
<tr>
|
| 323 |
<td class="memname">void wl_send_pan_packet </td> |
| 324 |
<td>(</td> |
| 325 |
<td class="paramtype">char </td> |
| 326 |
<td class="paramname"> <em>group</em>, </td> |
| 327 |
</tr>
|
| 328 |
<tr>
|
| 329 |
<td class="paramkey"></td> |
| 330 |
<td></td> |
| 331 |
<td class="paramtype">char </td> |
| 332 |
<td class="paramname"> <em>type</em>, </td> |
| 333 |
</tr>
|
| 334 |
<tr>
|
| 335 |
<td class="paramkey"></td> |
| 336 |
<td></td> |
| 337 |
<td class="paramtype">char * </td> |
| 338 |
<td class="paramname"> <em>data</em>, </td> |
| 339 |
</tr>
|
| 340 |
<tr>
|
| 341 |
<td class="paramkey"></td> |
| 342 |
<td></td> |
| 343 |
<td class="paramtype">int </td> |
| 344 |
<td class="paramname"> <em>len</em>, </td> |
| 345 |
</tr>
|
| 346 |
<tr>
|
| 347 |
<td class="paramkey"></td> |
| 348 |
<td></td> |
| 349 |
<td class="paramtype">char </td> |
| 350 |
<td class="paramname"> <em>frame</em></td><td> </td> |
| 351 |
</tr>
|
| 352 |
<tr>
|
| 353 |
<td></td> |
| 354 |
<td>)</td> |
| 355 |
<td></td><td></td><td></td> |
| 356 |
</tr>
|
| 357 |
</table>
|
| 358 |
</div>
|
| 359 |
<div class="memdoc"> |
| 360 |
|
| 361 |
<p>
|
| 362 |
Send a packet to all robots in our PAN. |
| 363 |
<p>
|
| 364 |
Send a packet to all XBee's in the same PAN.<p>
|
| 365 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 366 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 367 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
| 368 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
| 369 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
| 370 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
| 371 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
| 372 |
</table>
|
| 373 |
</dl>
|
| 374 |
|
| 375 |
<p>References <a class="el" href="xbee_8h_source.html#l00064">XBEE_BROADCAST</a>, and <a class="el" href="xbee_8h_source.html#l00066">XBEE_OPTIONS_NONE</a>.</p> |
| 376 |
|
| 377 |
</div>
|
| 378 |
</div><p> |
| 379 |
<a class="anchor" name="g6e841a6ef0504538d8650a0a2f5fa869"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_global_packet" ref="g6e841a6ef0504538d8650a0a2f5fa869" args="(char group, char type, char *data, int len, int dest, char frame)" --> |
| 380 |
<div class="memitem"> |
| 381 |
<div class="memproto"> |
| 382 |
<table class="memname"> |
| 383 |
<tr>
|
| 384 |
<td class="memname">int wl_send_robot_to_robot_global_packet </td> |
| 385 |
<td>(</td> |
| 386 |
<td class="paramtype">char </td> |
| 387 |
<td class="paramname"> <em>group</em>, </td> |
| 388 |
</tr>
|
| 389 |
<tr>
|
| 390 |
<td class="paramkey"></td> |
| 391 |
<td></td> |
| 392 |
<td class="paramtype">char </td> |
| 393 |
<td class="paramname"> <em>type</em>, </td> |
| 394 |
</tr>
|
| 395 |
<tr>
|
| 396 |
<td class="paramkey"></td> |
| 397 |
<td></td> |
| 398 |
<td class="paramtype">char * </td> |
| 399 |
<td class="paramname"> <em>data</em>, </td> |
| 400 |
</tr>
|
| 401 |
<tr>
|
| 402 |
<td class="paramkey"></td> |
| 403 |
<td></td> |
| 404 |
<td class="paramtype">int </td> |
| 405 |
<td class="paramname"> <em>len</em>, </td> |
| 406 |
</tr>
|
| 407 |
<tr>
|
| 408 |
<td class="paramkey"></td> |
| 409 |
<td></td> |
| 410 |
<td class="paramtype">int </td> |
| 411 |
<td class="paramname"> <em>dest</em>, </td> |
| 412 |
</tr>
|
| 413 |
<tr>
|
| 414 |
<td class="paramkey"></td> |
| 415 |
<td></td> |
| 416 |
<td class="paramtype">char </td> |
| 417 |
<td class="paramname"> <em>frame</em></td><td> </td> |
| 418 |
</tr>
|
| 419 |
<tr>
|
| 420 |
<td></td> |
| 421 |
<td>)</td> |
| 422 |
<td></td><td></td><td></td> |
| 423 |
</tr>
|
| 424 |
</table>
|
| 425 |
</div>
|
| 426 |
<div class="memdoc"> |
| 427 |
|
| 428 |
<p>
|
| 429 |
Send a packet to a specific robot in any PAN. |
| 430 |
<p>
|
| 431 |
Send a packet to a specific XBee without specifying a PAN.<p>
|
| 432 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 433 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 434 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
| 435 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
| 436 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
| 437 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
| 438 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the 16-bit address of the XBee to send the packet to </td></tr> |
| 439 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
| 440 |
</table>
|
| 441 |
</dl>
|
| 442 |
|
| 443 |
<p>References <a class="el" href="xbee_8h_source.html#l00070">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>.</p> |
| 444 |
|
| 445 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00052">wl_basic_send_robot_packet()</a>.</p> |
| 446 |
|
| 447 |
</div>
|
| 448 |
</div><p> |
| 449 |
<a class="anchor" name="gf8fbadf62eeb754b98b200328fb7a8be"></a><!-- doxytag: member="wireless.h::wl_send_robot_to_robot_packet" ref="gf8fbadf62eeb754b98b200328fb7a8be" args="(char group, char type, char *data, int len, int dest, char frame)" --> |
| 450 |
<div class="memitem"> |
| 451 |
<div class="memproto"> |
| 452 |
<table class="memname"> |
| 453 |
<tr>
|
| 454 |
<td class="memname">int wl_send_robot_to_robot_packet </td> |
| 455 |
<td>(</td> |
| 456 |
<td class="paramtype">char </td> |
| 457 |
<td class="paramname"> <em>group</em>, </td> |
| 458 |
</tr>
|
| 459 |
<tr>
|
| 460 |
<td class="paramkey"></td> |
| 461 |
<td></td> |
| 462 |
<td class="paramtype">char </td> |
| 463 |
<td class="paramname"> <em>type</em>, </td> |
| 464 |
</tr>
|
| 465 |
<tr>
|
| 466 |
<td class="paramkey"></td> |
| 467 |
<td></td> |
| 468 |
<td class="paramtype">char * </td> |
| 469 |
<td class="paramname"> <em>data</em>, </td> |
| 470 |
</tr>
|
| 471 |
<tr>
|
| 472 |
<td class="paramkey"></td> |
| 473 |
<td></td> |
| 474 |
<td class="paramtype">int </td> |
| 475 |
<td class="paramname"> <em>len</em>, </td> |
| 476 |
</tr>
|
| 477 |
<tr>
|
| 478 |
<td class="paramkey"></td> |
| 479 |
<td></td> |
| 480 |
<td class="paramtype">int </td> |
| 481 |
<td class="paramname"> <em>dest</em>, </td> |
| 482 |
</tr>
|
| 483 |
<tr>
|
| 484 |
<td class="paramkey"></td> |
| 485 |
<td></td> |
| 486 |
<td class="paramtype">char </td> |
| 487 |
<td class="paramname"> <em>frame</em></td><td> </td> |
| 488 |
</tr>
|
| 489 |
<tr>
|
| 490 |
<td></td> |
| 491 |
<td>)</td> |
| 492 |
<td></td><td></td><td></td> |
| 493 |
</tr>
|
| 494 |
</table>
|
| 495 |
</div>
|
| 496 |
<div class="memdoc"> |
| 497 |
|
| 498 |
<p>
|
| 499 |
Send a packet to a specific robot in our PAN. |
| 500 |
<p>
|
| 501 |
Send a packet to a specific XBee in the same PAN.<p>
|
| 502 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 503 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 504 |
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>the packet group </td></tr> |
| 505 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
| 506 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the packet data </td></tr> |
| 507 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the packet length in bytes </td></tr> |
| 508 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the 16-bit address of the XBee to send the packet to </td></tr> |
| 509 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the frame number to see with a TX_STATUS response </td></tr> |
| 510 |
</table>
|
| 511 |
</dl>
|
| 512 |
|
| 513 |
<p>References <a class="el" href="xbee_8h_source.html#l00066">XBEE_OPTIONS_NONE</a>.</p> |
| 514 |
|
| 515 |
</div>
|
| 516 |
</div><p> |
| 517 |
<a class="anchor" name="g51d3fe958d44fd92f0e0830ced13139d"></a><!-- doxytag: member="wireless.h::wl_set_channel" ref="g51d3fe958d44fd92f0e0830ced13139d" args="(int channel)" --> |
| 518 |
<div class="memitem"> |
| 519 |
<div class="memproto"> |
| 520 |
<table class="memname"> |
| 521 |
<tr>
|
| 522 |
<td class="memname">int wl_set_channel </td> |
| 523 |
<td>(</td> |
| 524 |
<td class="paramtype">int </td> |
| 525 |
<td class="paramname"> <em>channel</em> </td> |
| 526 |
<td> ) </td> |
| 527 |
<td></td> |
| 528 |
</tr>
|
| 529 |
</table>
|
| 530 |
</div>
|
| 531 |
<div class="memdoc"> |
| 532 |
|
| 533 |
<p>
|
| 534 |
Set the channel we are using. |
| 535 |
<p>
|
| 536 |
Set the channel the XBee is listening to.<p>
|
| 537 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 538 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 539 |
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>the new channel to join</td></tr> |
| 540 |
</table>
|
| 541 |
</dl>
|
| 542 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g2d65d3e35b193da4213755c4bf61ab6b" title="Get the channel we are using.">wl_get_channel</a> </dd></dl> |
| 543 |
|
| 544 |
<p>References <a class="el" href="xbee_8c_source.html#l00968">xbee_set_channel()</a>.</p> |
| 545 |
|
| 546 |
</div>
|
| 547 |
</div><p> |
| 548 |
<a class="anchor" name="g754445d2353a70963a489651cff554c1"></a><!-- doxytag: member="wireless.h::wl_set_pan" ref="g754445d2353a70963a489651cff554c1" args="(int pan)" --> |
| 549 |
<div class="memitem"> |
| 550 |
<div class="memproto"> |
| 551 |
<table class="memname"> |
| 552 |
<tr>
|
| 553 |
<td class="memname">int wl_set_pan </td> |
| 554 |
<td>(</td> |
| 555 |
<td class="paramtype">int </td> |
| 556 |
<td class="paramname"> <em>pan</em> </td> |
| 557 |
<td> ) </td> |
| 558 |
<td></td> |
| 559 |
</tr>
|
| 560 |
</table>
|
| 561 |
</div>
|
| 562 |
<div class="memdoc"> |
| 563 |
|
| 564 |
<p>
|
| 565 |
Set the PAN we are using. |
| 566 |
<p>
|
| 567 |
Set the PAN for the XBee to join.<p>
|
| 568 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 569 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 570 |
<tr><td valign="top"></td><td valign="top"><em>pan</em> </td><td>the new PAN</td></tr> |
| 571 |
</table>
|
| 572 |
</dl>
|
| 573 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wireless.html#g4e6b5c97d40a8e7557a1b4b90a7d34f7" title="Get the PAN we are using.">wl_get_pan</a> </dd></dl> |
| 574 |
|
| 575 |
<p>References <a class="el" href="xbee_8c_source.html#l00937">xbee_set_pan_id()</a>.</p> |
| 576 |
|
| 577 |
</div>
|
| 578 |
</div><p> |
| 579 |
<a class="anchor" name="g66075ff87a1c9f2c0d7938a26c7830f2"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="g66075ff87a1c9f2c0d7938a26c7830f2" args="(void)" --> |
| 580 |
<div class="memitem"> |
| 581 |
<div class="memproto"> |
| 582 |
<table class="memname"> |
| 583 |
<tr>
|
| 584 |
<td class="memname">void wl_terminate </td> |
| 585 |
<td>(</td> |
| 586 |
<td class="paramtype">void </td> |
| 587 |
<td class="paramname"> </td> |
| 588 |
<td> ) </td> |
| 589 |
<td></td> |
| 590 |
</tr>
|
| 591 |
</table>
|
| 592 |
</div>
|
| 593 |
<div class="memdoc"> |
| 594 |
|
| 595 |
<p>
|
| 596 |
Uninitialize the wireless library. |
| 597 |
<p>
|
| 598 |
Uninitializes the wireless library. |
| 599 |
<p>References <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wireless_8h_source.html#l00047">WL_MAX_PACKET_GROUPS</a>, and <a class="el" href="xbee_8c_source.html#l00339">xbee_terminate()</a>.</p> |
| 600 |
|
| 601 |
</div>
|
| 602 |
</div><p> |
| 603 |
<a class="anchor" name="gcdbedf6465798abc7af3bf5fea3d4dd7"></a><!-- doxytag: member="wireless.h::wl_unregister_packet_group" ref="gcdbedf6465798abc7af3bf5fea3d4dd7" args="(PacketGroupHandler *h)" --> |
| 604 |
<div class="memitem"> |
| 605 |
<div class="memproto"> |
| 606 |
<table class="memname"> |
| 607 |
<tr>
|
| 608 |
<td class="memname">void wl_unregister_packet_group </td> |
| 609 |
<td>(</td> |
| 610 |
<td class="paramtype"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> * </td> |
| 611 |
<td class="paramname"> <em>h</em> </td> |
| 612 |
<td> ) </td> |
| 613 |
<td></td> |
| 614 |
</tr>
|
| 615 |
</table>
|
| 616 |
</div>
|
| 617 |
<div class="memdoc"> |
| 618 |
|
| 619 |
<p>
|
| 620 |
Unregister a packet group with the wireless library. |
| 621 |
<p>
|
| 622 |
Unregister a packet group from the wireless library.<p>
|
| 623 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 624 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 625 |
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>the packet group to remove </td></tr> |
| 626 |
</table>
|
| 627 |
</dl>
|
| 628 |
|
| 629 |
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, and <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>.</p> |
| 630 |
|
| 631 |
<p>Referenced by <a class="el" href="wl__error__group_8c_source.html#l00079">wl_error_unregister()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00196">wl_token_ring_unregister()</a>.</p> |
| 632 |
|
| 633 |
</div>
|
| 634 |
</div><p> |
| 635 |
</div>
|
| 636 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by |
| 637 |
<a href="http://www.doxygen.org/index.html"> |
| 638 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 639 |
</body>
|
| 640 |
</html>
|