Project

General

Profile

Revision 60

Added by Brian Coltin over 16 years ago

Updated wireless library to add different channels.

View differences:

group__xbee.html
19 19 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" -->
20 20 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>
21 21 

  		




  22
  
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not change the PAN. <br></td></tr>


  		




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


  		




  
  23
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" -->


  		




  
  24
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a>&nbsp;&nbsp;&nbsp;0</td></tr>


  		




  
  25
  
    

  		




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


  		




  23
  27
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" -->


  		




  24
  28
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>


  		




  25
  29
  
    

  		




  ......




  45
  49
  
    

  		




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


  		




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


  		




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


  		




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


  		




  49
  53
  
    

  		




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


  		




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


  		




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


  		




  52
  56
  
    

  		




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


  		




  ......




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


  		




  64
  68
  
    

  		




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


  		




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


  		




  
  71
  
    

  		




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


  		




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


  		




  
  74
  
    

  		




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


  		




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


  		




  67
  77
  
    

  		




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


  		




  ......




  103
  113
  
    
    </td>


  		




  104
  114
  
    
  </tr>


  		




  105
  115
  
    
</table>


  		




  
  116
  
    
<a class="anchor" name="g133706db81f69ba0a3c169b7a3f42d2a"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="g133706db81f69ba0a3c169b7a3f42d2a" args="(void)" --><p>


  		




  
  117
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  118
  
    
  <tr>


  		




  
  119
  
    
    <td class="mdRow">


  		




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


  		




  
  121
  
    
        <tr>


  		




  
  122
  
    
          <td class="md" nowrap valign="top">int xbee_get_channel           </td>


  		




  
  123
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  124
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  
  125
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  
  126
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  127
  
    
          <td class="md" nowrap></td>


  		




  
  128
  
    
        </tr>


  		




  
  129
  
    
      </table>


  		




  
  130
  
    
    </td>


  		




  
  131
  
    
  </tr>


  		




  
  132
  
    
</table>


  		




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


  		




  
  134
  
    
  <tr>


  		




  
  135
  
    
    <td>


  		




  
  136
  
    
      &nbsp;


  		




  
  137
  
    
    </td>


  		




  
  138
  
    
    <td>


  		




  
  139
  
    

  		




  
  140
  
    
<p>


  		




  
  141
  
    
Get the channel the XBee is currently using. 


  		




  
  142
  
    
<p>


  		




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


  		




  
  144
  
    
<dl compact><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl>


  		




  
  145
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g33f2b13a8f46ee08f14bce90160a5623">xbee_set_channel</a> </dd></dl>


  		




  
  146
  
    
    </td>


  		




  
  147
  
    
  </tr>


  		




  
  148
  
    
</table>


  		




  106
  149
  
    
<a class="anchor" name="g00fbdd9d849171588df736f8b608589d"></a><!-- doxytag: member="xbee.h::xbee_get_packet" ref="g00fbdd9d849171588df736f8b608589d" args="(unsigned char *packet)" --><p>


  		




  107
  150
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  108
  151
  
    
  <tr>


  		




  ......




  190
  233
  
    
    </td>


  		




  191
  234
  
    
  </tr>


  		




  192
  235
  
    
</table>


  		




  193
  
  
    
<a class="anchor" name="g2b86876f0e73bef20c4292810b15d4b9"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g2b86876f0e73bef20c4292810b15d4b9" args="(int pan_id)" --><p>


  		




  
  236
  
    
<a class="anchor" name="g334a723b79eccec83b17e25cde2e10f1"></a><!-- doxytag: member="xbee.h::xbee_lib_init" ref="g334a723b79eccec83b17e25cde2e10f1" args="(void)" --><p>


  		




  194
  237
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  195
  238
  
    
  <tr>


  		




  196
  239
  
    
    <td class="mdRow">


  		




  ......




  198
  241
  
    
        <tr>


  		




  199
  242
  
    
          <td class="md" nowrap valign="top">void xbee_lib_init           </td>


  		




  200
  243
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  201
  
  
    
          <td class="md" nowrap valign="top">int&nbsp;</td>


  		




  202
  
  
    
          <td class="mdname1" valign="top" nowrap> <em>pan_id</em>          </td>


  		




  
  244
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  
  245
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  203
  246
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  204
  247
  
    
          <td class="md" nowrap></td>


  		




  205
  248
  
    
        </tr>


  		




  ......




  293
  336
  
    
    </td>


  		




  294
  337
  
    
  </tr>


  		




  295
  338
  
    
</table>


  		




  
  339
  
    
<a class="anchor" name="g33f2b13a8f46ee08f14bce90160a5623"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="g33f2b13a8f46ee08f14bce90160a5623" args="(int channel)" --><p>


  		




  
  340
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  341
  
    
  <tr>


  		




  
  342
  
    
    <td class="mdRow">


  		




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


  		




  
  344
  
    
        <tr>


  		




  
  345
  
    
          <td class="md" nowrap valign="top">void xbee_set_channel           </td>


  		




  
  346
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  347
  
    
          <td class="md" nowrap valign="top">int&nbsp;</td>


  		




  
  348
  
    
          <td class="mdname1" valign="top" nowrap> <em>channel</em>          </td>


  		




  
  349
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  350
  
    
          <td class="md" nowrap></td>


  		




  
  351
  
    
        </tr>


  		




  
  352
  
    
      </table>


  		




  
  353
  
    
    </td>


  		




  
  354
  
    
  </tr>


  		




  
  355
  
    
</table>


  		




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


  		




  
  357
  
    
  <tr>


  		




  
  358
  
    
    <td>


  		




  
  359
  
    
      &nbsp;


  		




  
  360
  
    
    </td>


  		




  
  361
  
    
    <td>


  		




  
  362
  
    

  		




  
  363
  
    
<p>


  		




  
  364
  
    
Set the channel the XBee is currently using. 


  		




  
  365
  
    
<p>


  		




  
  366
  
    
Set the channel the XBee is using.<p>


  		




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


  		




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


  		




  
  369
  
    
    <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>the channel the XBee will not use, between 0x0B and 0x1A</td></tr>


  		




  
  370
  
    
  </table>


  		




  
  371
  
    
</dl>


  		




  
  372
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> </dd></dl>


  		




  
  373
  
    
    </td>


  		




  
  374
  
    
  </tr>


  		




  
  375
  
    
</table>


  		




  296
  376
  
    
<a class="anchor" name="g832f07915e1ffa8afefcd378deead1cd"></a><!-- doxytag: member="xbee.h::xbee_set_pan_id" ref="g832f07915e1ffa8afefcd378deead1cd" args="(int id)" --><p>


  		




  297
  377
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  298
  378
  
    
  <tr>


  		




  ......




  359
  439
  
    
Call when finished using the XBee library. This releases all sued resources.     </td>


  		




  360
  440
  
    
  </tr>


  		




  361
  441
  
    
</table>


  		




  362
  
  
    
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 21 12:57:06 2007 for libwireless by&nbsp;


  		




  
  442
  
    
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 24 14:12:31 2007 for libwireless by&nbsp;


  		




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


  		




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


  		




  365
  445
  
    
</body>


  		












Also available in:  Unified diff