Revision 737
Updated wireless documentation.
group__xbee.html | ||
---|---|---|
50 | 50 |
|
51 | 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br></td></tr> |
52 | 52 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g334a723b79eccec83b17e25cde2e10f1">xbee_lib_init</a> (void)</td></tr>
|
|
53 |
<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> (void)</td></tr>
|
|
54 | 54 |
|
55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="#g334a723b79eccec83b17e25cde2e10f1"></a><br></td></tr>
|
|
55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="#g3d5fbb6aae8dda99240ec38108a645af"></a><br></td></tr>
|
|
56 | 56 |
<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> (void)</td></tr> |
57 | 57 |
|
58 | 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr> |
59 | 59 |
<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 *packet)</td></tr> |
60 | 60 |
|
61 | 61 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
62 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3a3b8ce040002ab2b1a0923950b2f3c4">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr>
|
|
62 |
<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>
|
|
63 | 63 |
|
64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="#g3a3b8ce040002ab2b1a0923950b2f3c4"></a><br></td></tr>
|
|
65 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g832f07915e1ffa8afefcd378deead1cd">xbee_set_pan_id</a> (int id)</td></tr>
|
|
64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr>
|
|
65 |
<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>
|
|
66 | 66 |
|
67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="#g832f07915e1ffa8afefcd378deead1cd"></a><br></td></tr>
|
|
67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr>
|
|
68 | 68 |
<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> (void)</td></tr> |
69 | 69 |
|
70 | 70 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr> |
71 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623">xbee_set_channel</a> (int channel)</td></tr>
|
|
71 |
<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>
|
|
72 | 72 |
|
73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="#g33f2b13a8f46ee08f14bce90160a5623"></a><br></td></tr>
|
|
73 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="#gb93170c493c5cdfd43a7b640c6ed1d14"></a><br></td></tr>
|
|
74 | 74 |
<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> |
75 | 75 |
|
76 | 76 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr> |
... | ... | |
131 | 131 |
<p> |
132 | 132 |
Returns the channel which the XBee is currently using.<p> |
133 | 133 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl> |
134 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl>
|
|
134 |
<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 | 135 |
|
136 | 136 |
</div> |
137 | 137 |
</div><p> |
... | ... | |
206 | 206 |
|
207 | 207 |
</div> |
208 | 208 |
</div><p> |
209 |
<a class="anchor" name="g334a723b79eccec83b17e25cde2e10f1"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g334a723b79eccec83b17e25cde2e10f1" args="(void)" -->
|
|
209 |
<a class="anchor" name="g3d5fbb6aae8dda99240ec38108a645af"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g3d5fbb6aae8dda99240ec38108a645af" args="(void)" -->
|
|
210 | 210 |
<div class="memitem"> |
211 | 211 |
<div class="memproto"> |
212 | 212 |
<table class="memname"> |
213 | 213 |
<tr> |
214 |
<td class="memname">void xbee_lib_init </td>
|
|
214 |
<td class="memname">int xbee_lib_init </td>
|
|
215 | 215 |
<td>(</td> |
216 | 216 |
<td class="paramtype">void </td> |
217 | 217 |
<td class="paramname"> </td> |
... | ... | |
228 | 228 |
Initializes the XBee library so that other functions may be used. |
229 | 229 |
</div> |
230 | 230 |
</div><p> |
231 |
<a class="anchor" name="g3a3b8ce040002ab2b1a0923950b2f3c4"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="g3a3b8ce040002ab2b1a0923950b2f3c4" args="(char *packet, int len, int dest, char options, char frame)" -->
|
|
231 |
<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)" -->
|
|
232 | 232 |
<div class="memitem"> |
233 | 233 |
<div class="memproto"> |
234 | 234 |
<table class="memname"> |
235 | 235 |
<tr> |
236 |
<td class="memname">void xbee_send_packet </td>
|
|
236 |
<td class="memname">int xbee_send_packet </td>
|
|
237 | 237 |
<td>(</td> |
238 | 238 |
<td class="paramtype">char * </td> |
239 | 239 |
<td class="paramname"> <em>packet</em>, </td> |
... | ... | |
287 | 287 |
|
288 | 288 |
</div> |
289 | 289 |
</div><p> |
290 |
<a class="anchor" name="g33f2b13a8f46ee08f14bce90160a5623"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="g33f2b13a8f46ee08f14bce90160a5623" args="(int channel)" -->
|
|
290 |
<a class="anchor" name="gb93170c493c5cdfd43a7b640c6ed1d14"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="gb93170c493c5cdfd43a7b640c6ed1d14" args="(int channel)" -->
|
|
291 | 291 |
<div class="memitem"> |
292 | 292 |
<div class="memproto"> |
293 | 293 |
<table class="memname"> |
294 | 294 |
<tr> |
295 |
<td class="memname">void xbee_set_channel </td>
|
|
295 |
<td class="memname">int xbee_set_channel </td>
|
|
296 | 296 |
<td>(</td> |
297 | 297 |
<td class="paramtype">int </td> |
298 | 298 |
<td class="paramname"> <em>channel</em> </td> |
... | ... | |
316 | 316 |
|
317 | 317 |
</div> |
318 | 318 |
</div><p> |
319 |
<a class="anchor" name="g832f07915e1ffa8afefcd378deead1cd"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="g832f07915e1ffa8afefcd378deead1cd" args="(int id)" -->
|
|
319 |
<a class="anchor" name="gde50cbefd7ba8d7361ce2654a298748b"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="gde50cbefd7ba8d7361ce2654a298748b" args="(int id)" -->
|
|
320 | 320 |
<div class="memitem"> |
321 | 321 |
<div class="memproto"> |
322 | 322 |
<table class="memname"> |
323 | 323 |
<tr> |
324 |
<td class="memname">void xbee_set_pan_id </td>
|
|
324 |
<td class="memname">int xbee_set_pan_id </td>
|
|
325 | 325 |
<td>(</td> |
326 | 326 |
<td class="paramtype">int </td> |
327 | 327 |
<td class="paramname"> <em>id</em> </td> |
... | ... | |
366 | 366 |
Call when finished using the XBee library. This releases all sued resources. |
367 | 367 |
</div> |
368 | 368 |
</div><p> |
369 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by
|
|
369 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by
|
|
370 | 370 |
<a href="http://www.doxygen.org/index.html"> |
371 | 371 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
372 | 372 |
</body> |
Also available in: Unified diff