root / trunk / docs / libwireless / xbee_8h.html @ 1425
History | View | Annotate | Download (12.1 KB)
| 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: xbee.h File 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><a href="annotated.html"><span>Data Structures</span></a></li> |
| 17 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 18 |
</ul>
|
| 19 |
</div>
|
| 20 |
<div class="tabs"> |
| 21 |
<ul>
|
| 22 |
<li><a href="files.html"><span>File List</span></a></li> |
| 23 |
<li><a href="globals.html"><span>Globals</span></a></li> |
| 24 |
</ul>
|
| 25 |
</div>
|
| 26 |
</div>
|
| 27 |
<div class="contents"> |
| 28 |
<h1>xbee.h File Reference</h1> |
| 29 |
<p>Contains definitions for using the XBee.
|
| 30 |
<a href="#_details">More...</a></p> |
| 31 |
|
| 32 |
<p><a href="xbee_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>Defines</h2></td></tr> |
| 35 |
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8h.html#afd0466c206d7e1f82ee407d114468e96">XBEE_PORT_DEFAULT</a> "/dev/ttyUSB1"</td></tr> |
| 36 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee.h::XBEE_PAN_DEFAULT" ref="gae6bb9bb274d6750f954762454807a5a7" args="" --> |
| 37 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gae6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset PAN, uses XBee default. <br/></td></tr> |
| 39 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee.h::XBEE_CHANNEL_DEFAULT" ref="ga35f8b9d8e01e788f1e29928cba29f215" args="" --> |
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr> |
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset channel, uses XBee default. <br/></td></tr> |
| 42 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee.h::XBEE_BROADCAST" ref="ga93bbd21f7965e1697350f950cedff5c4" args="" --> |
| 43 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr> |
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast to all robots in the PAN. <br/></td></tr> |
| 45 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_NONE" ref="gabca7356c2b8183fd41b5ca9a82dd962b" args="" --> |
| 46 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gabca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr> |
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">No special options. <br/></td></tr> |
| 48 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gacf9509013302590dca5ce3db63c64609" args="" --> |
| 49 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gacf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr> |
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br/></td></tr> |
| 51 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="ga57382f888360b5b19f0de3b6f1f7c5a3" args="" --> |
| 52 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr> |
| 53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet to all PANS. <br/></td></tr> |
| 54 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee.h::XBEE_TX_STATUS" ref="ga7840d8b64c8bec12d8b8d32e845a638a" args="" --> |
| 55 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr> |
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A transmit status packet. <br/></td></tr> |
| 57 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee.h::XBEE_RX" ref="gac2b1262a3a1eb4a9f7ead366af71c32c" args="" --> |
| 58 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gac2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr> |
| 59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br/></td></tr> |
| 60 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
| 61 |
<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> (void)</td></tr> |
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="group__xbee.html#ga3d5fbb6aae8dda99240ec38108a645af"></a><br/></td></tr> |
| 63 |
<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> (void)</td></tr> |
| 64 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="group__xbee.html#ga9334ac71dca1ddd697b1a35a361ade6a"></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__xbee.html#ga00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr> |
| 66 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="group__xbee.html#ga00fbdd9d849171588df736f8b608589d"></a><br/></td></tr> |
| 67 |
<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> |
| 68 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="group__xbee.html#ga7c44bc25fda954efde574ee8d735073c"></a><br/></td></tr> |
| 69 |
<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> |
| 70 |
<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> |
| 71 |
<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> (void)</td></tr> |
| 72 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="group__xbee.html#ga7755cd8db87703c9e9943153660b8052"></a><br/></td></tr> |
| 73 |
<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> |
| 74 |
<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> |
| 75 |
<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> |
| 76 |
<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> |
| 77 |
<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> (void)</td></tr> |
| 78 |
<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> |
| 79 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee.h::xbee_set_com_port" ref="ga1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" --> |
| 80 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr> |
| 81 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br/></td></tr> |
| 82 |
</table>
|
| 83 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
| 84 |
<p>Contains definitions for using the XBee. </p> |
| 85 |
<p>Copyright (c) 2007 Colony Project</p> |
| 86 |
<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> |
| 87 |
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> |
| 88 |
<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> |
| 89 |
<p>Contains definitions for interfacing with the XBee module, from either a robot or a computer. To use a robot, define ROBOT in <a class="el" href="wl__defs_8h.html" title="Definitions for Wireless.">wl_defs.h</a>, and to use a computer, don't define ROBOT.</p> |
| 90 |
<dl class="author"><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
| 91 |
<hr/><h2>Define Documentation</h2> |
| 92 |
<a class="anchor" id="afd0466c206d7e1f82ee407d114468e96"></a><!-- doxytag: member="xbee.h::XBEE_PORT_DEFAULT" ref="afd0466c206d7e1f82ee407d114468e96" args="" --> |
| 93 |
<div class="memitem"> |
| 94 |
<div class="memproto"> |
| 95 |
<table class="memname"> |
| 96 |
<tr>
|
| 97 |
<td class="memname">#define XBEE_PORT_DEFAULT "/dev/ttyUSB1"</td> |
| 98 |
</tr>
|
| 99 |
</table>
|
| 100 |
</div>
|
| 101 |
<div class="memdoc"> |
| 102 |
<p>The port to use the XBee from on the computer. Also, a backup port if the other is used. </p> |
| 103 |
|
| 104 |
</div>
|
| 105 |
</div>
|
| 106 |
</div>
|
| 107 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by |
| 108 |
<a href="http://www.doxygen.org/index.html"> |
| 109 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| 110 |
</body>
|
| 111 |
</html>
|