Project

General

Profile

Revision 1823

Added by David Schultz almost 14 years ago

new doxygen for libwireless

View differences:

xbee_8h.html
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 File Reference</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 -->
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.3 -->
8 11 
<div class="navigation" id="top">
9 12 
  <div class="tabs">
10 13 
    <ul>
11 14 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 15 
      <li><a href="modules.html"><span>Modules</span></a></li>
16 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 17 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
14 18 
    </ul>
15 19 
  </div>
......
21 25 
  </div>
22 26 
</div>
23 27 
<div class="contents">
24 
<h1>xbee.h File Reference</h1>Contains definitions for using the XBee.
25 
<a href="#_details">More...</a>
26 
<p>
27 
<code>#include &lt;stdint.h&gt;</code><br>
28 
<h1>xbee.h File Reference</h1>
29 
<p>Contains definitions for using the XBee.
30 
<a href="#_details">More...</a></p>
31 
<code>#include &lt;stdint.h&gt;</code><br/>
32 

  		




  
  33
  
    
<p><a href="xbee_8h_source.html">Go to the source code of this file.</a></p>


  		




  28
  34
  
    
<table border="0" cellpadding="0" cellspacing="0">


  		




  29
  
  
    
<tr><td></td></tr>


  		




  30
  
  
    
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


  		




  31
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr>


  		




  32
  
  
    

  		




  33
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee library.  <a href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af"></a><br></td></tr>


  		




  34
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr>


  		




  35
  
  
    

  		




  36
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the XBee library.  <a href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr>


  		




  37
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr>


  		




  38
  
  
    

  		




  39
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a packet from the XBee.  <a href="group__xbee.html#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr>


  		




  40
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>


  		




  41
  
  
    

  		




  42
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to the XBee.  <a href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr>


  		




  43
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr>


  		




  44
  
  
    

  		




  45
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN ID for the XBee.  <a href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr>


  		




  46
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> (void)</td></tr>


  		




  47
  
  
    

  		




  48
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's PAN ID.  <a href="group__xbee.html#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr>


  		




  49
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr>


  		




  50
  
  
    

  		




  51
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel the XBee is currently using.  <a href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14"></a><br></td></tr>


  		




  52
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr>


  		




  53
  
  
    

  		




  54
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel the XBee is currently using.  <a href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr>


  		




  55
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee_get_address</a> (void)</td></tr>


  		




  56
  
  
    

  		




  57
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's 16-bit address.  <a href="group__xbee.html#g7c53e8a8492494a61ca306875d633309"></a><br></td></tr>


  		




  58
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee.h::xbee_set_com_port" ref="g1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" -->


  		




  59
  
  
    
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr>


  		




  60
  
  
    

  		




  61
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr>


  		




  62
  
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfcfccfa7323041108202275eba913be7"></a><!-- doxytag: member="xbee.h::xbee_reset" ref="gfcfccfa7323041108202275eba913be7" args="(void)" -->


  		




  63
  
  
    
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gfcfccfa7323041108202275eba913be7">xbee_reset</a> (void)</td></tr>


  		




  64
  
  
    

  		




  65
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset XBee. <br></td></tr>


  		




  
  35
  
    
<tr><td colspan="2"><h2>Defines</h2></td></tr>


  		




  
  36
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7125fc8f3df24a2db8e074983206b054"></a><!-- doxytag: member="xbee.h::XBEE_BAUD" ref="ga7125fc8f3df24a2db8e074983206b054" args="" -->


  		




  
  37
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ga7125fc8f3df24a2db8e074983206b054">XBEE_BAUD</a>&nbsp;&nbsp;&nbsp;9600</td></tr>


  		




  
  38
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The XBee baud rate. <br/></td></tr>


  		




  
  39
  
    
<tr><td colspan="2"><div class="groupHeader">xbee options</div></td></tr>


  		




  
  40
  
    
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp0014d6a1d613fbff74082710cdb428d7"></a> </p>


  		




  
  41
  
    
</div></td></tr>


  		




  
  42
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee.h::XBEE_PAN_DEFAULT" ref="gae6bb9bb274d6750f954762454807a5a7" args="" -->


  		




  
  43
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gae6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>


  		




  
  44
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset PAN, uses XBee default. <br/></td></tr>


  		




  
  45
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee.h::XBEE_CHANNEL_DEFAULT" ref="ga35f8b9d8e01e788f1e29928cba29f215" args="" -->


  		




  
  46
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ga35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a>&nbsp;&nbsp;&nbsp;0</td></tr>


  		




  
  47
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset channel, uses XBee default. <br/></td></tr>


  		




  
  48
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee.h::XBEE_BROADCAST" ref="ga93bbd21f7965e1697350f950cedff5c4" args="" -->


  		




  
  49
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ga93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>


  		




  
  50
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Broadcast to all robots in the PAN. <br/></td></tr>


  		




  
  51
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee.h::XBEE_OPTIONS_NONE" ref="gabca7356c2b8183fd41b5ca9a82dd962b" args="" -->


  		




  
  52
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gabca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>


  		




  
  53
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">No special options. <br/></td></tr>


  		




  
  54
  
    
<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="" -->


  		




  
  55
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gacf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>


  		




  
  56
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br/></td></tr>


  		




  
  57
  
    
<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="" -->


  		




  
  58
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ga57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>&nbsp;&nbsp;&nbsp;0x04</td></tr>


  		




  
  59
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the packet to all PANS. <br/></td></tr>


  		




  
  60
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee.h::XBEE_TX_STATUS" ref="ga7840d8b64c8bec12d8b8d32e845a638a" args="" -->


  		




  
  61
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ga7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a>&nbsp;&nbsp;&nbsp;0x89</td></tr>


  		




  
  62
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A transmit status packet. <br/></td></tr>


  		




  
  63
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee.h::XBEE_RX" ref="gac2b1262a3a1eb4a9f7ead366af71c32c" args="" -->


  		




  
  64
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gac2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a>&nbsp;&nbsp;&nbsp;0x81</td></tr>


  		




  
  65
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A packet received from another XBee. <br/></td></tr>


  		




  
  66
  
    
<tr><td colspan="2"><div class="groupHeader">xbee frame types</div></td></tr>


  		




  
  67
  
    
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp1ac6183ed989d02124dd9e6c432cc711"></a> </p>


  		




  
  68
  
    
</div></td></tr>


  		




  
  69
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_START" ref="ga72aa42b35714e06ac26df31b06a8bf39" args="" -->


  		




  
  70
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_START</b>&nbsp;&nbsp;&nbsp;0x7E</td></tr>


  		




  
  71
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_STATUS" ref="gae0fc9d7b1078703227c91e1352b708c5" args="" -->


  		




  
  72
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_STATUS</b>&nbsp;&nbsp;&nbsp;0x8A</td></tr>


  		




  
  73
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_AT_COMMAND" ref="ga106780ab66c38464e90af25ae3cc73de" args="" -->


  		




  
  74
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND</b>&nbsp;&nbsp;&nbsp;0x08</td></tr>


  		




  
  75
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="gaac9e8cc2d9fdda49b77aed7d9380bfde" args="" -->


  		




  
  76
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND_RESPONSE</b>&nbsp;&nbsp;&nbsp;0x88</td></tr>


  		




  
  77
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_TX_REQUEST_64" ref="ga31af21123fe9b33803cdf96626776d32" args="" -->


  		




  
  78
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_64</b>&nbsp;&nbsp;&nbsp;0x00</td></tr>


  		




  
  79
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_TX_REQUEST_16" ref="ga30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" -->


  		




  
  80
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_16</b>&nbsp;&nbsp;&nbsp;0x01</td></tr>


  		




  
  81
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_TX_STATUS" ref="ga301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" -->


  		




  
  82
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_STATUS</b>&nbsp;&nbsp;&nbsp;XBEE_TX_STATUS</td></tr>


  		




  
  83
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_RX_64" ref="gaba621d0a00f41acc7e059b5abf4802ad" args="" -->


  		




  
  84
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_64</b>&nbsp;&nbsp;&nbsp;0x80</td></tr>


  		




  
  85
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee.h::XBEE_FRAME_RX_16" ref="ga5b80e57bcad9ccaa20022e8d4968ec66" args="" -->


  		




  
  86
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_16</b>&nbsp;&nbsp;&nbsp;XBEE_RX</td></tr>


  		




  
  87
  
    
<tr><td colspan="2"><h2>Functions</h2></td></tr>


  		




  
  88
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga35f6f209aee59fad0490a961587e014a">xbee_init</a> (void)</td></tr>


  		




  
  89
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee library.  <a href="group__xbee__funcs.html#ga35f6f209aee59fad0490a961587e014a"></a><br/></td></tr>


  		




  
  90
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga0b4c25c76efbe397decacefced00e06c">xbee_terminate</a> (void)</td></tr>


  		




  
  91
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the XBee library.  <a href="group__xbee__funcs.html#ga0b4c25c76efbe397decacefced00e06c"></a><br/></td></tr>


  		




  
  92
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04">xbee_send</a> (uint8_t *buf, uint16_t size)</td></tr>


  		




  
  93
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send an array of bytes to the xbee in API mode.  <a href="group__xbee__funcs.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04"></a><br/></td></tr>


  		




  
  94
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#gae75ee9a54a5811b8bc302dc2d70f0215">xbee_sendc</a> (uint8_t byte)</td></tr>


  		




  
  95
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send byte to the xbee in API mode.  <a href="group__xbee__funcs.html#gae75ee9a54a5811b8bc302dc2d70f0215"></a><br/></td></tr>


  		




  
  96
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga2eb96c49811a1d9f2ccd1e1186915077">xbee_checksum_add</a> (uint8_t *buf, uint8_t len, uint8_t *sum)</td></tr>


  		




  
  97
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a buffer to the checksum value.  <a href="group__xbee__funcs.html#ga2eb96c49811a1d9f2ccd1e1186915077"></a><br/></td></tr>


  		




  
  98
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga2a39ffce83d65d22aeefb41dfce2112f">xbee_send_header</a> (uint16_t len)</td></tr>


  		




  
  99
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a frame header to the xbee.  <a href="group__xbee__funcs.html#ga2a39ffce83d65d22aeefb41dfce2112f"></a><br/></td></tr>


  		




  
  100
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#gaae54f7208cfa786cb56d4d78ab3ceffe">xbee_send_packet</a> (uint8_t *packet, uint8_t len, uint16_t dest, uint8_t options, uint8_t frame)</td></tr>


  		




  
  101
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to the XBee.  <a href="group__xbee__funcs.html#gaae54f7208cfa786cb56d4d78ab3ceffe"></a><br/></td></tr>


  		




  
  102
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#gadbcb9cc8cf6afa28e6de8defb33f8196">xbee_set_pan</a> (uint16_t id)</td></tr>


  		




  
  103
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN ID for the XBee.  <a href="group__xbee__funcs.html#gadbcb9cc8cf6afa28e6de8defb33f8196"></a><br/></td></tr>


  		




  
  104
  
    
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga76e60575b236342945b6a69bbe42df9f">xbee_get_pan</a> (void)</td></tr>


  		




  
  105
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's PAN ID.  <a href="group__xbee__funcs.html#ga76e60575b236342945b6a69bbe42df9f"></a><br/></td></tr>


  		




  
  106
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga4f67630ca81e5eae064bb58c3818d3fd">xbee_set_channel</a> (uint8_t channel)</td></tr>


  		




  
  107
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel the XBee is currently using.  <a href="group__xbee__funcs.html#ga4f67630ca81e5eae064bb58c3818d3fd"></a><br/></td></tr>


  		




  
  108
  
    
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga319d4bccd5e6b09d2f377d2170104817">xbee_get_channel</a> (void)</td></tr>


  		




  
  109
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel the XBee is currently using.  <a href="group__xbee__funcs.html#ga319d4bccd5e6b09d2f377d2170104817"></a><br/></td></tr>


  		




  
  110
  
    
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#ga24d751120f5cded06a70d156c29261fc">xbee_get_address</a> (void)</td></tr>


  		




  
  111
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's 16-bit address.  <a href="group__xbee__funcs.html#ga24d751120f5cded06a70d156c29261fc"></a><br/></td></tr>


  		




  
  112
  
    
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacf9354ba8b49419b6286e1318e87aa41"></a><!-- doxytag: member="xbee.h::xbee_reset" ref="gacf9354ba8b49419b6286e1318e87aa41" args="(void)" -->


  		




  
  113
  
    
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#gacf9354ba8b49419b6286e1318e87aa41">xbee_reset</a> (void)</td></tr>


  		




  
  114
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset XBee. <br/></td></tr>


  		




  66
  115
  
    
</table>


  		




  67
  
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  68
  
  
    
Copyright (c) 2009 Colony Project<p>


  		




  69
  
  
    
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>


  		




  70
  
  
    
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


  		




  71
  
  
    
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>


  		




  72
  
  
    
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>


  		




  73
  
  
    
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


  		




  
  116
  
    
<hr/><a name="_details"></a><h2>Detailed Description</h2>


  		




  
  117
  
    
<p>Contains definitions for using the XBee. </p>


  		




  
  118
  
    
<p>Copyright (c) 2009 Colony Project</p>


  		




  
  119
  
    
<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>


  		




  
  120
  
    
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>


  		




  
  121
  
    
<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>


  		




  
  122
  
    
<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>


  		




  
  123
  
    
<dl class="author"><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


  		




  74
  124
  
    
</div>


  		




  75
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;


  		




  
  125
  
    
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;


  		




  76
  126
  
    
<a href="http://www.doxygen.org/index.html">


  		




  77
  
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>


  		




  
  127
  
    
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>


  		




  78
  128
  
    
</body>


  		




  79
  129
  
    
</html>


  		












Also available in:  Unified diff