Revision 1380
fixed doxygen problems in wireless library, added new docs
| group__xbee.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 | 3 |
<title>libwireless: XBee</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 4 | 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.3 --> |
|
| 8 |
<div class="tabs"> |
|
| 9 |
<ul> |
|
| 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
| 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 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> |
|
| 15 | 17 |
</div> |
| 18 |
<div class="contents"> |
|
| 16 | 19 |
<h1>XBee</h1>Interface with the XBee module. |
| 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 20 |
<a href="#_details">More...</a> |
|
| 21 |
<p> |
|
| 22 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 18 | 23 |
<tr><td></td></tr> |
| 19 | 24 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 20 | 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" --> |
| ... | ... | |
| 83 | 88 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
| 84 | 89 |
</table> |
| 85 | 90 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 86 |
Interface with the XBee module. |
|
| 87 |
<p> |
|
| 88 | 91 |
Interface with the XBee module. <hr><h2>Function Documentation</h2> |
| 89 | 92 |
<a class="anchor" name="g7c53e8a8492494a61ca306875d633309"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="g7c53e8a8492494a61ca306875d633309" args="(void)" --> |
| 90 | 93 |
<div class="memitem"> |
| ... | ... | |
| 96 | 99 |
<td class="paramtype">void </td> |
| 97 | 100 |
<td class="paramname"> </td> |
| 98 | 101 |
<td> ) </td> |
| 99 |
<td width="100%"></td>
|
|
| 102 |
<td></td> |
|
| 100 | 103 |
</tr> |
| 101 | 104 |
</table> |
| 102 | 105 |
</div> |
| ... | ... | |
| 108 | 111 |
Get the 16-bit address of the XBee. This is used to specify who to send messages to and who messages are from.<p> |
| 109 | 112 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl> |
| 110 | 113 |
|
| 114 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>.</p> |
|
| 115 |
|
|
| 111 | 116 |
</div> |
| 112 | 117 |
</div><p> |
| 113 | 118 |
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" --> |
| ... | ... | |
| 120 | 125 |
<td class="paramtype">void </td> |
| 121 | 126 |
<td class="paramname"> </td> |
| 122 | 127 |
<td> ) </td> |
| 123 |
<td width="100%"></td>
|
|
| 128 |
<td></td> |
|
| 124 | 129 |
</tr> |
| 125 | 130 |
</table> |
| 126 | 131 |
</div> |
| ... | ... | |
| 133 | 138 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl> |
| 134 | 139 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl> |
| 135 | 140 |
|
| 141 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00223">wl_get_channel()</a>.</p> |
|
| 142 |
|
|
| 136 | 143 |
</div> |
| 137 | 144 |
</div><p> |
| 138 | 145 |
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" --> |
| ... | ... | |
| 145 | 152 |
<td class="paramtype">unsigned char * </td> |
| 146 | 153 |
<td class="paramname"> <em>dest</em> </td> |
| 147 | 154 |
<td> ) </td> |
| 148 |
<td width="100%"></td>
|
|
| 155 |
<td></td> |
|
| 149 | 156 |
</tr> |
| 150 | 157 |
</table> |
| 151 | 158 |
</div> |
| ... | ... | |
| 180 | 187 |
</dl> |
| 181 | 188 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the packet, or -1 if no packet is available </dd></dl> |
| 182 | 189 |
|
| 190 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>, and <a class="el" href="xbee_8c_source.html#l00206">xbee_lib_init()</a>.</p> |
|
| 191 |
|
|
| 183 | 192 |
</div> |
| 184 | 193 |
</div><p> |
| 185 | 194 |
<a class="anchor" name="g7755cd8db87703c9e9943153660b8052"></a><!-- doxytag: member="xbee.h::xbee_get_pan_id" ref="g7755cd8db87703c9e9943153660b8052" args="(void)" --> |
| ... | ... | |
| 192 | 201 |
<td class="paramtype">void </td> |
| 193 | 202 |
<td class="paramname"> </td> |
| 194 | 203 |
<td> ) </td> |
| 195 |
<td width="100%"></td>
|
|
| 204 |
<td></td> |
|
| 196 | 205 |
</tr> |
| 197 | 206 |
</table> |
| 198 | 207 |
</div> |
| ... | ... | |
| 204 | 213 |
Get the PAN ID for the XBee.<p> |
| 205 | 214 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl> |
| 206 | 215 |
|
| 216 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00195">wl_get_pan()</a>.</p> |
|
| 217 |
|
|
| 207 | 218 |
</div> |
| 208 | 219 |
</div><p> |
| 209 | 220 |
<a class="anchor" name="g3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g3d5fbb6aae8dda99240ec38108a645af" args="(void)" --> |
| ... | ... | |
| 216 | 227 |
<td class="paramtype">void </td> |
| 217 | 228 |
<td class="paramname"> </td> |
| 218 | 229 |
<td> ) </td> |
| 219 |
<td width="100%"></td>
|
|
| 230 |
<td></td> |
|
| 220 | 231 |
</tr> |
| 221 | 232 |
</table> |
| 222 | 233 |
</div> |
| ... | ... | |
| 226 | 237 |
Initialize the XBee library. |
| 227 | 238 |
<p> |
| 228 | 239 |
Initializes the XBee library so that other functions may be used. |
| 240 |
<p>References <a class="el" href="xbee_8c_source.html#l00725">xbee_get_packet()</a>.</p> |
|
| 241 |
|
|
| 242 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p> |
|
| 243 |
|
|
| 229 | 244 |
</div> |
| 230 | 245 |
</div><p> |
| 231 | 246 |
<a class="anchor" name="g7c44bc25fda954efde574ee8d735073c"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="g7c44bc25fda954efde574ee8d735073c" args="(char *packet, int len, int dest, char options, char frame)" --> |
| ... | ... | |
| 265 | 280 |
<tr> |
| 266 | 281 |
<td></td> |
| 267 | 282 |
<td>)</td> |
| 268 |
<td></td><td></td><td width="100%"></td>
|
|
| 283 |
<td></td><td></td><td></td> |
|
| 269 | 284 |
</tr> |
| 270 | 285 |
</table> |
| 271 | 286 |
</div> |
| ... | ... | |
| 297 | 312 |
<td class="paramtype">int </td> |
| 298 | 313 |
<td class="paramname"> <em>channel</em> </td> |
| 299 | 314 |
<td> ) </td> |
| 300 |
<td width="100%"></td>
|
|
| 315 |
<td></td> |
|
| 301 | 316 |
</tr> |
| 302 | 317 |
</table> |
| 303 | 318 |
</div> |
| ... | ... | |
| 314 | 329 |
</dl> |
| 315 | 330 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a> </dd></dl> |
| 316 | 331 |
|
| 332 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00209">wl_set_channel()</a>.</p> |
|
| 333 |
|
|
| 317 | 334 |
</div> |
| 318 | 335 |
</div><p> |
| 319 | 336 |
<a class="anchor" name="gde50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="gde50cbefd7ba8d7361ce2654a298748b" args="(int id)" --> |
| ... | ... | |
| 326 | 343 |
<td class="paramtype">int </td> |
| 327 | 344 |
<td class="paramname"> <em>id</em> </td> |
| 328 | 345 |
<td> ) </td> |
| 329 |
<td width="100%"></td>
|
|
| 346 |
<td></td> |
|
| 330 | 347 |
</tr> |
| 331 | 348 |
</table> |
| 332 | 349 |
</div> |
| ... | ... | |
| 342 | 359 |
</table> |
| 343 | 360 |
</dl> |
| 344 | 361 |
|
| 362 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00181">wl_set_pan()</a>.</p> |
|
| 363 |
|
|
| 345 | 364 |
</div> |
| 346 | 365 |
</div><p> |
| 347 | 366 |
<a class="anchor" name="g9334ac71dca1ddd697b1a35a361ade6a"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="g9334ac71dca1ddd697b1a35a361ade6a" args="(void)" --> |
| ... | ... | |
| 354 | 373 |
<td class="paramtype">void </td> |
| 355 | 374 |
<td class="paramname"> </td> |
| 356 | 375 |
<td> ) </td> |
| 357 |
<td width="100%"></td>
|
|
| 376 |
<td></td> |
|
| 358 | 377 |
</tr> |
| 359 | 378 |
</table> |
| 360 | 379 |
</div> |
| ... | ... | |
| 364 | 383 |
Uninitialize the XBee library. |
| 365 | 384 |
<p> |
| 366 | 385 |
Call when finished using the XBee library. This releases all sued resources. |
| 386 |
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>.</p> |
|
| 387 |
|
|
| 367 | 388 |
</div> |
| 368 | 389 |
</div><p> |
| 369 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by |
|
| 390 |
</div> |
|
| 391 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by |
|
| 370 | 392 |
<a href="http://www.doxygen.org/index.html"> |
| 371 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 393 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 372 | 394 |
</body> |
| 373 | 395 |
</html> |
Also available in: Unified diff