root / trunk / docs / libwireless / xbee_8h.html @ 192
History | View | Annotate | Download (10.9 KB)
1 | 19 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>libwireless: xbee.h File Reference</title> |
||
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
||
5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
||
6 | </head><body> |
||
7 | <!-- Generated by Doxygen 1.4.6 -->
|
||
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 id="current"><a href="files.html"><span>Files</span></a></li> |
||
14 | </ul></div> |
||
15 | <div class="tabs"> |
||
16 | <ul>
|
||
17 | <li><a href="files.html"><span>File List</span></a></li> |
||
18 | <li><a href="globals.html"><span>Globals</span></a></li> |
||
19 | </ul></div> |
||
20 | <h1>xbee.h File Reference</h1>Contains definitions for using the XBee. <a href="#_details">More...</a> |
||
21 | <p>
|
||
22 | |||
23 | <p>
|
||
24 | <a href="xbee_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
25 | <tr><td></td></tr> |
||
26 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
27 | 192 | bcoltin | <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8h.html#0ddad85671ebdb108b228835312d4f62">XBEE_PORT</a> "/dev/ttyUSB1"</td></tr> |
28 | |||
29 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17f967dcf991de0b7a380e505613df01"></a><!-- doxytag: member="xbee.h::XBEE_PORT2" ref="17f967dcf991de0b7a380e505613df01" args="" --> |
||
30 | #define </td><td class="memItemRight" valign="bottom"><b>XBEE_PORT2</b> "/dev/ttyUSB0"</td></tr> |
||
31 | |||
32 | 19 | bcoltin | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee.h::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" --> |
33 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
||
34 | |||
35 | 60 | bcoltin | <tr><td class="mdescLeft"> </td><td class="mdescRight">Unset PAN, uses XBee default. <br></td></tr> |
36 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee.h::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" --> |
||
37 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr> |
||
38 | |||
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Unset channel, uses XBee default. <br></td></tr> |
||
40 | 19 | bcoltin | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee.h::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" --> |
41 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr> |
||
42 | |||
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast to all robots in the PAN. <br></td></tr> |
||
44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_NONE" ref="gbca7356c2b8183fd41b5ca9a82dd962b" args="" --> |
||
45 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr> |
||
46 | |||
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">No special options. <br></td></tr> |
||
48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gcf9509013302590dca5ce3db63c64609" args="" --> |
||
49 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr> |
||
50 | |||
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br></td></tr> |
||
52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="g57382f888360b5b19f0de3b6f1f7c5a3" args="" --> |
||
53 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr> |
||
54 | |||
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet to all PANS. <br></td></tr> |
||
56 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee.h::XBEE_TX_STATUS" ref="g7840d8b64c8bec12d8b8d32e845a638a" args="" --> |
||
57 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr> |
||
58 | |||
59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A transmit status packet. <br></td></tr> |
||
60 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee.h::XBEE_RX" ref="gc2b1262a3a1eb4a9f7ead366af71c32c" args="" --> |
||
61 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr> |
||
62 | |||
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br></td></tr> |
||
64 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
65 | 60 | bcoltin | <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> |
66 | 19 | bcoltin | |
67 | 60 | bcoltin | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="group__xbee.html#g334a723b79eccec83b17e25cde2e10f1"></a><br></td></tr> |
68 | 19 | bcoltin | <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> |
69 | |||
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></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#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr> |
||
72 | |||
73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="group__xbee.html#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
||
74 | <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> |
||
75 | |||
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="group__xbee.html#g3a3b8ce040002ab2b1a0923950b2f3c4"></a><br></td></tr> |
||
77 | <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> |
||
78 | |||
79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="group__xbee.html#g832f07915e1ffa8afefcd378deead1cd"></a><br></td></tr> |
||
80 | <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> |
||
81 | |||
82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="group__xbee.html#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr> |
||
83 | 60 | bcoltin | <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> |
84 | |||
85 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623"></a><br></td></tr> |
||
86 | <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> |
||
87 | |||
88 | <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> |
||
89 | 19 | bcoltin | <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> (void)</td></tr> |
90 | |||
91 | <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> |
||
92 | </table>
|
||
93 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
94 | Contains definitions for using the XBee. |
||
95 | <p>
|
||
96 | 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-source.html">wl_defs.h</a>, and to use a computer, don't define ROBOT.<p> |
||
97 | <dl compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
||
98 | 192 | bcoltin | <hr><h2>Define Documentation</h2> |
99 | <a class="anchor" name="0ddad85671ebdb108b228835312d4f62"></a><!-- doxytag: member="xbee.h::XBEE_PORT" ref="0ddad85671ebdb108b228835312d4f62" args="" --><p> |
||
100 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
101 | <tr>
|
||
102 | <td class="mdRow"> |
||
103 | <table cellpadding="0" cellspacing="0" border="0"> |
||
104 | <tr>
|
||
105 | <td class="md" nowrap valign="top">#define XBEE_PORT "/dev/ttyUSB1" </td> |
||
106 | </tr>
|
||
107 | </table>
|
||
108 | </td>
|
||
109 | </tr>
|
||
110 | </table>
|
||
111 | <table cellspacing="5" cellpadding="0" border="0"> |
||
112 | <tr>
|
||
113 | <td>
|
||
114 |
|
||
115 | </td>
|
||
116 | <td>
|
||
117 | |||
118 | <p>
|
||
119 | The port to use the XBee from on the computer. Also, a backup port if the other is used. </td>
|
||
120 | </tr>
|
||
121 | </table>
|
||
122 | <hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by |
||
123 | 19 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
124 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
||
125 | </body>
|
||
126 | </html> |