Colony

<p>

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

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

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

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

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

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

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

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

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

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

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

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

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

</table>

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

Interface with the XBee module. <hr><h2>Function Documentation</h2>

<div class="memitem">

<div class="memproto">

      <table class="memname">

        <tr>

          <td class="memname">unsigned int xbee_get_address           </td>

          <td>(</td>

          <td class="paramname">          </td>

          <td>&nbsp;)&nbsp;</td>

          <td></td>

<div class="memdoc">

<p>

Get the 16-bit address of the XBee. This is used to specify who to send messages to and who messages are from.<p>

<dl class="return" compact><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl>

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

<div class="memdoc">

<p>

Returns the channel which the XBee is currently using.<p>

<dl class="return" compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl>

<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl>

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

<div class="memdoc">

<p>

Reads a packet received from the XBee. This function is non-blocking. The resulting packet is stored in dest. Only returns transmission response packets and received packets. The returned packet does not include header information or the checksum. This method also handles special packets dealt with by the XBee library, and so should be called frequently while the XBee is in use.<br>

<br>

<p>

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

        <tr>

          <td class="memname">unsigned int xbee_get_pan_id           </td>

          <td>(</td>

          <td class="paramname">          </td>

          <td>&nbsp;)&nbsp;</td>

          <td></td>

<div class="memdoc">

<p>

Get the PAN ID for the XBee.<p>

<dl class="return" compact><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl>

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

        <tr>

          <td class="memname">int xbee_lib_init           </td>

          <td>(</td>

          <td class="paramname">          </td>

          <td>&nbsp;)&nbsp;</td>

          <td></td>

<div class="memdoc">

<p>

Initializes the XBee library so that other functions may be used. 

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

<div class="memdoc">

<p>

Send the specified packet.<p>

<dl compact><dt><b>Parameters:</b></dt><dd>

  <table border="0" cellspacing="2" cellpadding="0">

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

        <tr>

          <td class="memname">int xbee_set_channel           </td>

          <td>(</td>

          <td class="paramtype">int&nbsp;</td>

<div class="memdoc">

<p>

Set the channel the XBee is using.<p>

<dl compact><dt><b>Parameters:</b></dt><dd>

  <table border="0" cellspacing="2" cellpadding="0">

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

<div class="memdoc">

<p>

Sets the personal area network id.<p>

<dl compact><dt><b>Parameters:</b></dt><dd>

  <table border="0" cellspacing="2" cellpadding="0">

</div>

</div><p>

<div class="memitem">

<div class="memproto">

      <table class="memname">

        <tr>

          <td class="memname">void xbee_terminate           </td>

          <td>(</td>

          <td class="paramname">          </td>

          <td>&nbsp;)&nbsp;</td>

          <td></td>

<div class="memdoc">

<p>

Call when finished using the XBee library. This releases all sued resources. 

</div>

</div><p>

</div>

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

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

</body>