Project

General

Profile

Revision 737

Updated wireless documentation.

View differences:

xbee_8h-source.html
18 18
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_H</span>
19 19
<a name="l00040"></a>00040 <span class="preprocessor"></span>
20 20
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef ROBOT</span>
21
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#ifndef XBEE_PORT</span>
22
<a name="l00047"></a><a class="code" href="xbee_8h.html#0ddad85671ebdb108b228835312d4f62">00047</a> <span class="preprocessor"></span><span class="preprocessor">#define XBEE_PORT "/dev/ttyUSB1"</span>
23
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
24
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_PORT2 "/dev/ttyUSB0"</span>
25
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
26
<a name="l00051"></a>00051 <span class="preprocessor"></span>
27
<a name="l00061"></a>00061 <span class="comment">/*Definitions*/</span>
28
<a name="l00063"></a><a class="code" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">00063</a> <span class="preprocessor">#define XBEE_PAN_DEFAULT 0xFFFF</span>
29
<a name="l00064"></a>00064 <span class="preprocessor"></span>
30
<a name="l00065"></a><a class="code" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">00065</a> <span class="preprocessor">#define XBEE_CHANNEL_DEFAULT 0</span>
31
<a name="l00066"></a>00066 <span class="preprocessor"></span>
32
<a name="l00067"></a><a class="code" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">00067</a> <span class="preprocessor">#define XBEE_BROADCAST 0xFFFF</span>
33
<a name="l00068"></a>00068 <span class="preprocessor"></span>
34
<a name="l00069"></a><a class="code" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">00069</a> <span class="preprocessor">#define XBEE_OPTIONS_NONE 0x00</span>
35
<a name="l00070"></a>00070 <span class="preprocessor"></span>
36
<a name="l00071"></a><a class="code" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">00071</a> <span class="preprocessor">#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01</span>
37
<a name="l00072"></a>00072 <span class="preprocessor"></span>
38
<a name="l00073"></a><a class="code" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">00073</a> <span class="preprocessor">#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04</span>
39
<a name="l00074"></a>00074 <span class="preprocessor"></span>
40
<a name="l00075"></a><a class="code" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">00075</a> <span class="preprocessor">#define XBEE_TX_STATUS 0x89</span>
41
<a name="l00076"></a>00076 <span class="preprocessor"></span>
42
<a name="l00077"></a><a class="code" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">00077</a> <span class="preprocessor">#define XBEE_RX 0x81</span>
43
<a name="l00078"></a>00078 <span class="preprocessor"></span>
44
<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g334a723b79eccec83b17e25cde2e10f1" title="Initialize the XBee library.">xbee_lib_init</a>(<span class="keywordtype">void</span>);
45
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a" title="Uninitialize the XBee library.">xbee_terminate</a>(<span class="keywordtype">void</span>);
46
<a name="l00084"></a>00084 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d" title="Get a packet from the XBee.">xbee_get_packet</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet);
47
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g3a3b8ce040002ab2b1a0923950b2f3c4" title="Send a packet to the XBee.">xbee_send_packet</a>(<span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest,
48
<a name="l00087"></a>00087         <span class="keywordtype">char</span> options, <span class="keywordtype">char</span> frame);
49
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g832f07915e1ffa8afefcd378deead1cd" title="Set the PAN ID for the XBee.">xbee_set_pan_id</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>);
50
<a name="l00091"></a>00091 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052" title="Get the XBee&amp;#39;s PAN ID.">xbee_get_pan_id</a>(<span class="keywordtype">void</span>);
51
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623" title="Set the channel the XBee is currently using.">xbee_set_channel</a>(<span class="keywordtype">int</span> channel);
52
<a name="l00095"></a>00095 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a>(<span class="keywordtype">void</span>);
53
<a name="l00097"></a>00097 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309" title="Get the XBee&amp;#39;s 16-bit address.">xbee_get_address</a>(<span class="keywordtype">void</span>);
54
<a name="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a" title="Set the com port on a computer, undefined on the robot.">xbee_set_com_port</a>(<span class="keywordtype">char</span>* port);
55
<a name="l00100"></a>00100  <span class="comment">//end defgroup</span>
56
<a name="l00102"></a>00102 
57
<a name="l00103"></a>00103 <span class="preprocessor">#endif</span>
58
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:22 2007 for libwireless by&nbsp;
21
<a name="l00046"></a><a class="code" href="xbee_8h.html#fd0466c206d7e1f82ee407d114468e96">00046</a> <span class="preprocessor"></span><span class="preprocessor">#define XBEE_PORT_DEFAULT "/dev/ttyUSB1"</span>
22
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
23
<a name="l00048"></a>00048 <span class="preprocessor"></span>
24
<a name="l00058"></a>00058 <span class="comment">/*Definitions*/</span>
25
<a name="l00060"></a><a class="code" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">00060</a> <span class="preprocessor">#define XBEE_PAN_DEFAULT 0xFFFF</span>
26
<a name="l00061"></a>00061 <span class="preprocessor"></span>
27
<a name="l00062"></a><a class="code" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">00062</a> <span class="preprocessor">#define XBEE_CHANNEL_DEFAULT 0</span>
28
<a name="l00063"></a>00063 <span class="preprocessor"></span>
29
<a name="l00064"></a><a class="code" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">00064</a> <span class="preprocessor">#define XBEE_BROADCAST 0xFFFF</span>
30
<a name="l00065"></a>00065 <span class="preprocessor"></span>
31
<a name="l00066"></a><a class="code" href="group__xbee.html#gbca7356c2b8183fd41b5ca9a82dd962b">00066</a> <span class="preprocessor">#define XBEE_OPTIONS_NONE 0x00</span>
32
<a name="l00067"></a>00067 <span class="preprocessor"></span>
33
<a name="l00068"></a><a class="code" href="group__xbee.html#gcf9509013302590dca5ce3db63c64609">00068</a> <span class="preprocessor">#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01</span>
34
<a name="l00069"></a>00069 <span class="preprocessor"></span>
35
<a name="l00070"></a><a class="code" href="group__xbee.html#g57382f888360b5b19f0de3b6f1f7c5a3">00070</a> <span class="preprocessor">#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04</span>
36
<a name="l00071"></a>00071 <span class="preprocessor"></span>
37
<a name="l00072"></a><a class="code" href="group__xbee.html#g7840d8b64c8bec12d8b8d32e845a638a">00072</a> <span class="preprocessor">#define XBEE_TX_STATUS 0x89</span>
38
<a name="l00073"></a>00073 <span class="preprocessor"></span>
39
<a name="l00074"></a><a class="code" href="group__xbee.html#gc2b1262a3a1eb4a9f7ead366af71c32c">00074</a> <span class="preprocessor">#define XBEE_RX 0x81</span>
40
<a name="l00075"></a>00075 <span class="preprocessor"></span>
41
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af" title="Initialize the XBee library.">xbee_lib_init</a>(<span class="keywordtype">void</span>);
42
<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a" title="Uninitialize the XBee library.">xbee_terminate</a>(<span class="keywordtype">void</span>);
43
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d" title="Get a packet from the XBee.">xbee_get_packet</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet);
44
<a name="l00083"></a>00083 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c" title="Send a packet to the XBee.">xbee_send_packet</a>(<span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest, <span class="keywordtype">char</span> options, <span class="keywordtype">char</span> frame);
45
<a name="l00085"></a>00085 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b" title="Set the PAN ID for the XBee.">xbee_set_pan_id</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>);
46
<a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052" title="Get the XBee&amp;#39;s PAN ID.">xbee_get_pan_id</a>(<span class="keywordtype">void</span>);
47
<a name="l00089"></a>00089 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a>(<span class="keywordtype">int</span> channel);
48
<a name="l00091"></a>00091 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a" title="Get the channel the XBee is currently using.">xbee_get_channel</a>(<span class="keywordtype">void</span>);
49
<a name="l00093"></a>00093 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309" title="Get the XBee&amp;#39;s 16-bit address.">xbee_get_address</a>(<span class="keywordtype">void</span>);
50
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a" title="Set the com port on a computer, undefined on the robot.">xbee_set_com_port</a>(<span class="keywordtype">char</span>* port);
51
<a name="l00096"></a>00096  <span class="comment">//end defgroup</span>
52
<a name="l00098"></a>00098 
53
<a name="l00099"></a>00099 <span class="preprocessor">#endif</span>
54
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
59 55
<a href="http://www.doxygen.org/index.html">
60 56
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
61 57
</body>

Also available in: Unified diff