Project

General

Profile

Statistics
| Revision:

root / branches / wireless / docs / libwireless / html / xbee_8h-source.html @ 1578

History | View | Annotate | Download (5.26 KB)

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>Colony: xbee.h Source File</title>
4 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.8 -->
8 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="modules.html"><span>Modules</span></a></li>
13 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
14 
    </ul>
15 
  </div>
16 
  <div class="tabs">
17 
    <ul>
18 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19 
      <li><a href="globals.html"><span>Globals</span></a></li>
20 
    </ul>
21 
  </div>
22 
<h1>xbee.h</h1><a href="xbee_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
23 
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef XBEE_H</span>
24 
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_H</span>
25 
<a name="l00040"></a>00040 <span class="preprocessor"></span>
26 
<a name="l00041"></a>00041 <span class="comment">// need this for C99 int types</span>
27 
<a name="l00042"></a>00042 <span class="preprocessor">#ifndef STDINT_H</span>
28 
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define STDINT_H</span>
29 
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#include &lt;stdint.h&gt;</span>
30 
<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
31 
<a name="l00046"></a>00046 <span class="preprocessor"></span>
32 
<a name="l00047"></a>00047
33 
<a name="l00058"></a>00058 <span class="comment">// TODO: convert all int references to int16_t syntax (see stdint.h)</span>
34 
<a name="l00059"></a>00059
35 
<a name="l00061"></a>00061 <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>);
36 
<a name="l00063"></a>00063 <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>);
37 
<a name="l00065"></a>00065 <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);
38 
<a name="l00067"></a>00067 <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);
39 
<a name="l00069"></a>00069 <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>);
40 
<a name="l00071"></a>00071 <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>);
41 
<a name="l00073"></a>00073 <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);
42 
<a name="l00075"></a>00075 <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>);
43 
<a name="l00077"></a>00077 <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>);
44 
<a name="l00079"></a>00079 <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);
45 
<a name="l00081"></a>00081 <span class="keywordtype">int</span> <a class="code" href="group__xbee.html#gfcfccfa7323041108202275eba913be7" title="Reset XBee.">xbee_reset</a>(<span class="keywordtype">void</span>);
46 
<a name="l00082"></a>00082  <span class="comment">//end defgroup</span>
47 
<a name="l00084"></a>00084
48 
<a name="l00085"></a>00085 <span class="preprocessor">#endif</span>
49 
</pre></div></div>
50 
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by&nbsp;
51 
<a href="http://www.doxygen.org/index.html">
52 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
53 
</body>
54 
</html>