Revision 1823

View differences:

branches/wireless/docs/libwireless/html/group__wl__defines.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: Public Constants</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: Public Constants</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><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>Public Constants<br>
22
<h1>Public Constants<br/>
19 23
<small>
20 24
[<a class="el" href="group__wireless.html">Wireless</a>]</small>
21 25
</h1><table border="0" cellpadding="0" cellspacing="0">
22
<tr><td></td></tr>
23
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3de33738fd3c7e77bffbcfaefc3e7645"></a><!-- doxytag: member="wl_defines::GLOBAL" ref="g3de33738fd3c7e77bffbcfaefc3e7645" args="" -->
25
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
26

  
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">global scope <br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g11ed0d4e68673af6d575ed529ddf2130"></a><!-- doxytag: member="wl_defines::PAN" ref="g11ed0d4e68673af6d575ed529ddf2130" args="" -->
29
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">PAN</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
30

  
31
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">local pan scope <br></td></tr>
32
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc286e1243ab6be2c950c277e5e1377f9"></a><!-- doxytag: member="wl_defines::BROADCAST" ref="gc286e1243ab6be2c950c277e5e1377f9" args="" -->
33
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">BROADCAST</a>&nbsp;&nbsp;&nbsp;UINT16_C(0xFFFF)</td></tr>
34

  
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">broadcast address <br></td></tr>
36
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5bda06b0f5767eeca91b1383c0898c19"></a><!-- doxytag: member="wl_defines::RELIABLE" ref="g5bda06b0f5767eeca91b1383c0898c19" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">RELIABLE</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
38

  
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reliable (TCP) mode <br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8091c2bcff55cbe0a4a145fd5fb7c22d"></a><!-- doxytag: member="wl_defines::FAST" ref="g8091c2bcff55cbe0a4a145fd5fb7c22d" args="" -->
41
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">FAST</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
42

  
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">fast (UDP) mode <br></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3"></a><!-- doxytag: member="wl_defines::NORMAL_PRIORITY" ref="gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3" args="" -->
45
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">NORMAL_PRIORITY</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
46

  
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">standard priority <br></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ged801c122c559efe4677d351d07747b4"></a><!-- doxytag: member="wl_defines::HIGH_PRIORITY" ref="ged801c122c559efe4677d351d07747b4" args="" -->
49
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">HIGH_PRIORITY</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
50

  
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">high priority, handle immediately <br></td></tr>
26
<tr><td colspan="2"><h2>Defines</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga07b76b679f20134d56e04819f746fad6"></a><!-- doxytag: member="wl_defines::BASIC" ref="ga07b76b679f20134d56e04819f746fad6" args="" -->
28
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga07b76b679f20134d56e04819f746fad6">BASIC</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
29
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">basic group code <br/></td></tr>
30
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3de33738fd3c7e77bffbcfaefc3e7645"></a><!-- doxytag: member="wl_defines::GLOBAL" ref="ga3de33738fd3c7e77bffbcfaefc3e7645" args="" -->
31
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">global scope <br/></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga11ed0d4e68673af6d575ed529ddf2130"></a><!-- doxytag: member="wl_defines::PAN" ref="ga11ed0d4e68673af6d575ed529ddf2130" args="" -->
34
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga11ed0d4e68673af6d575ed529ddf2130">PAN</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">local pan scope <br/></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac286e1243ab6be2c950c277e5e1377f9"></a><!-- doxytag: member="wl_defines::BROADCAST" ref="gac286e1243ab6be2c950c277e5e1377f9" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gac286e1243ab6be2c950c277e5e1377f9">BROADCAST</a>&nbsp;&nbsp;&nbsp;UINT16_C(0xFFFF)</td></tr>
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">broadcast address <br/></td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5bda06b0f5767eeca91b1383c0898c19"></a><!-- doxytag: member="wl_defines::RELIABLE" ref="ga5bda06b0f5767eeca91b1383c0898c19" args="" -->
40
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga5bda06b0f5767eeca91b1383c0898c19">RELIABLE</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reliable (TCP) mode <br/></td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8091c2bcff55cbe0a4a145fd5fb7c22d"></a><!-- doxytag: member="wl_defines::FAST" ref="ga8091c2bcff55cbe0a4a145fd5fb7c22d" args="" -->
43
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga8091c2bcff55cbe0a4a145fd5fb7c22d">FAST</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">fast (UDP) mode <br/></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafd4a10e7cb5b56dd8e5ba8e2cff7ffc3"></a><!-- doxytag: member="wl_defines::NORMAL_PRIORITY" ref="gafd4a10e7cb5b56dd8e5ba8e2cff7ffc3" args="" -->
46
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gafd4a10e7cb5b56dd8e5ba8e2cff7ffc3">NORMAL_PRIORITY</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">standard priority <br/></td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaed801c122c559efe4677d351d07747b4"></a><!-- doxytag: member="wl_defines::HIGH_PRIORITY" ref="gaed801c122c559efe4677d351d07747b4" args="" -->
49
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gaed801c122c559efe4677d351d07747b4">HIGH_PRIORITY</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">high priority, handle immediately <br/></td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab6aaa08c0bfb6feb3e54a78d9211af56"></a><!-- doxytag: member="wl_defines::SENDING" ref="gab6aaa08c0bfb6feb3e54a78d9211af56" args="" -->
52
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gab6aaa08c0bfb6feb3e54a78d9211af56">SENDING</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">packet still in sending phase <br/></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4dc7574681861c30957f3ffc1fe84f41"></a><!-- doxytag: member="wl_defines::ACK_OK" ref="ga4dc7574681861c30957f3ffc1fe84f41" args="" -->
55
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga4dc7574681861c30957f3ffc1fe84f41">ACK_OK</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">packet was send successfully <br/></td></tr>
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab10c348780c46ce9fdd85ff4c8a2ff82"></a><!-- doxytag: member="wl_defines::ACK_FAILURE" ref="gab10c348780c46ce9fdd85ff4c8a2ff82" args="" -->
58
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gab10c348780c46ce9fdd85ff4c8a2ff82">ACK_FAILURE</a>&nbsp;&nbsp;&nbsp;UINT8_C(2)</td></tr>
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">packet failure - no acknowledgment <br/></td></tr>
60
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab3a749bdf48c98c7d307775cfe0210e1"></a><!-- doxytag: member="wl_defines::CCA_FAILURE" ref="gab3a749bdf48c98c7d307775cfe0210e1" args="" -->
61
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gab3a749bdf48c98c7d307775cfe0210e1">CCA_FAILURE</a>&nbsp;&nbsp;&nbsp;UINT8_C(3)</td></tr>
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">packet failure - network too busy <br/></td></tr>
63
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga587e21dda1f72be700a6206023ad681b"></a><!-- doxytag: member="wl_defines::FUNC" ref="ga587e21dda1f72be700a6206023ad681b" args="" -->
64
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga587e21dda1f72be700a6206023ad681b">FUNC</a>&nbsp;&nbsp;&nbsp;func</td></tr>
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">packet handler function pointer type <br/></td></tr>
66
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b522c0ddd1f87732ac08225fcc89b58"></a><!-- doxytag: member="wl_defines::FNPTR" ref="ga8b522c0ddd1f87732ac08225fcc89b58" args="" -->
67
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga8b522c0ddd1f87732ac08225fcc89b58">FNPTR</a>&nbsp;&nbsp;&nbsp;void (*FUNC)(uint8_t* data,uint8_t length,uint8_t source)</td></tr>
68
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">packet handler function pointer type <br/></td></tr>
69
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga78906957fa456cdea5f330c8a7b119da"></a><!-- doxytag: member="wl_defines::MAX_PACKET_GROUPS" ref="ga78906957fa456cdea5f330c8a7b119da" args="" -->
70
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga78906957fa456cdea5f330c8a7b119da">MAX_PACKET_GROUPS</a>&nbsp;&nbsp;&nbsp;UINT8_C(16)</td></tr>
71
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">maximum number of packet groups, size of handler array <br/></td></tr>
72
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b043ee766380d099be83d92dc145878"></a><!-- doxytag: member="wl_defines::INIT_NO" ref="ga8b043ee766380d099be83d92dc145878" args="" -->
73
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga8b043ee766380d099be83d92dc145878">INIT_NO</a>&nbsp;&nbsp;&nbsp;UINT8_C(0)</td></tr>
74
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init_flag when library has not been initialized <br/></td></tr>
75
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0c8854a00a3ee4fb44960b651ffc62b3"></a><!-- doxytag: member="wl_defines::INIT_YES" ref="ga0c8854a00a3ee4fb44960b651ffc62b3" args="" -->
76
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga0c8854a00a3ee4fb44960b651ffc62b3">INIT_YES</a>&nbsp;&nbsp;&nbsp;UINT8_C(1)</td></tr>
77
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init_flag when library has been initialized <br/></td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga17d416bf86e0b1b9adcdb92450abca63"></a><!-- doxytag: member="wl_defines::NUM_RETRIES" ref="ga17d416bf86e0b1b9adcdb92450abca63" args="" -->
79
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga17d416bf86e0b1b9adcdb92450abca63">NUM_RETRIES</a>&nbsp;&nbsp;&nbsp;UINT8_C(3)</td></tr>
80
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">numer of reliable sending retries <br/></td></tr>
52 81
</table>
53 82
</div>
54
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
83
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
55 84
<a href="http://www.doxygen.org/index.html">
56
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
85
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
57 86
</body>
58 87
</html>
branches/wireless/docs/libwireless/html/group__xbee__funcs.html
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 Functions</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 -->
11
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20
</div>
21
<div class="contents">
22
<h1>Xbee Functions<br/>
23
<small>
24
[<a class="el" href="group__xbee.html">XBee</a>]</small>
25
</h1>
26
<p>These are the public xbee functions.  
27
<a href="#_details">More...</a></p>
28
<table border="0" cellpadding="0" cellspacing="0">
29
<tr><td colspan="2"><h2>Functions</h2></td></tr>
30
<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>
31
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the XBee library.  <a href="#ga35f6f209aee59fad0490a961587e014a"></a><br/></td></tr>
32
<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>
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Uninitialize the XBee library.  <a href="#ga0b4c25c76efbe397decacefced00e06c"></a><br/></td></tr>
34
<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>
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send an array of bytes to the xbee in API mode.  <a href="#ga5805e267e3b6f4b7bdad7aa6dc65ee04"></a><br/></td></tr>
36
<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>
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send byte to the xbee in API mode.  <a href="#gae75ee9a54a5811b8bc302dc2d70f0215"></a><br/></td></tr>
38
<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>
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a buffer to the checksum value.  <a href="#ga2eb96c49811a1d9f2ccd1e1186915077"></a><br/></td></tr>
40
<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>
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a frame header to the xbee.  <a href="#ga2a39ffce83d65d22aeefb41dfce2112f"></a><br/></td></tr>
42
<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>
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a packet to the XBee.  <a href="#gaae54f7208cfa786cb56d4d78ab3ceffe"></a><br/></td></tr>
44
<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>
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the PAN ID for the XBee.  <a href="#gadbcb9cc8cf6afa28e6de8defb33f8196"></a><br/></td></tr>
46
<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>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's PAN ID.  <a href="#ga76e60575b236342945b6a69bbe42df9f"></a><br/></td></tr>
48
<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>
49
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the channel the XBee is currently using.  <a href="#ga4f67630ca81e5eae064bb58c3818d3fd"></a><br/></td></tr>
50
<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>
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the channel the XBee is currently using.  <a href="#ga319d4bccd5e6b09d2f377d2170104817"></a><br/></td></tr>
52
<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>
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the XBee's 16-bit address.  <a href="#ga24d751120f5cded06a70d156c29261fc"></a><br/></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacf9354ba8b49419b6286e1318e87aa41"></a><!-- doxytag: member="xbee_funcs::xbee_reset" ref="gacf9354ba8b49419b6286e1318e87aa41" args="(void)" -->
55
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__funcs.html#gacf9354ba8b49419b6286e1318e87aa41">xbee_reset</a> (void)</td></tr>
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset XBee. <br/></td></tr>
57
</table>
58
<hr/><a name="_details"></a><h2>Detailed Description</h2>
59
<p>These are the public xbee functions. </p>
60
<hr/><h2>Function Documentation</h2>
61
<a class="anchor" id="ga2eb96c49811a1d9f2ccd1e1186915077"></a><!-- doxytag: member="xbee.h::xbee_checksum_add" ref="ga2eb96c49811a1d9f2ccd1e1186915077" args="(uint8_t *buf, uint8_t len, uint8_t *sum)" -->
62
<div class="memitem">
63
<div class="memproto">
64
      <table class="memname">
65
        <tr>
66
          <td class="memname">int8_t xbee_checksum_add </td>
67
          <td>(</td>
68
          <td class="paramtype">uint8_t *&nbsp;</td>
69
          <td class="paramname"> <em>buf</em>, </td>
70
        </tr>
71
        <tr>
72
          <td class="paramkey"></td>
73
          <td></td>
74
          <td class="paramtype">uint8_t&nbsp;</td>
75
          <td class="paramname"> <em>len</em>, </td>
76
        </tr>
77
        <tr>
78
          <td class="paramkey"></td>
79
          <td></td>
80
          <td class="paramtype">uint8_t *&nbsp;</td>
81
          <td class="paramname"> <em>sum</em></td><td>&nbsp;</td>
82
        </tr>
83
        <tr>
84
          <td></td>
85
          <td>)</td>
86
          <td></td><td></td><td></td>
87
        </tr>
88
      </table>
89
</div>
90
<div class="memdoc">
91

  
92
<p>Add a buffer to the checksum value. </p>
93
<p>Adds buf to the previous checksum total</p>
94
<dl><dt><b>Parameters:</b></dt><dd>
95
  <table border="0" cellspacing="2" cellpadding="0">
96
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>a byte buffer to add to the checksum </td></tr>
97
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the length of the buffer </td></tr>
98
    <tr><td valign="top"></td><td valign="top"><em>sum</em>&nbsp;</td><td>the previous sum</td></tr>
99
  </table>
100
  </dd>
101
</dl>
102
<dl class="return"><dt><b>Returns:</b></dt><dd>error code </dd></dl>
103

  
104
<p>References <a class="el" href="wl__defs_8h_source.html#l00090">WL_ERROR_ARGUMENT</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
105

  
106
<p>Referenced by <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>.</p>
107

  
108
</div>
109
</div>
110
<a class="anchor" id="ga24d751120f5cded06a70d156c29261fc"></a><!-- doxytag: member="xbee.h::xbee_get_address" ref="ga24d751120f5cded06a70d156c29261fc" args="(void)" -->
111
<div class="memitem">
112
<div class="memproto">
113
      <table class="memname">
114
        <tr>
115
          <td class="memname">uint16_t xbee_get_address </td>
116
          <td>(</td>
117
          <td class="paramtype">void&nbsp;</td>
118
          <td class="paramname"></td>
119
          <td>&nbsp;)&nbsp;</td>
120
          <td></td>
121
        </tr>
122
      </table>
123
</div>
124
<div class="memdoc">
125

  
126
<p>Get the XBee's 16-bit address. </p>
127
<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>
128
<dl class="return"><dt><b>Returns:</b></dt><dd>the 16-bit address of the XBee. </dd></dl>
129

  
130
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, <a class="el" href="wl__defs_8h_source.html#l00117">WL_ERROR_XBEE_COMMAND_16BIT</a>, and <a class="el" href="xbee_8c_source.html#l01380">xbee_send_read_at_command()</a>.</p>
131

  
132
<p>Referenced by <a class="el" href="xbee_8c_source.html#l00729">xbee_init()</a>.</p>
133

  
134
</div>
135
</div>
136
<a class="anchor" id="ga319d4bccd5e6b09d2f377d2170104817"></a><!-- doxytag: member="xbee.h::xbee_get_channel" ref="ga319d4bccd5e6b09d2f377d2170104817" args="(void)" -->
137
<div class="memitem">
138
<div class="memproto">
139
      <table class="memname">
140
        <tr>
141
          <td class="memname">int8_t xbee_get_channel </td>
142
          <td>(</td>
143
          <td class="paramtype">void&nbsp;</td>
144
          <td class="paramname"></td>
145
          <td>&nbsp;)&nbsp;</td>
146
          <td></td>
147
        </tr>
148
      </table>
149
</div>
150
<div class="memdoc">
151

  
152
<p>Get the channel the XBee is currently using. </p>
153
<p>Returns the channel which the XBee is currently using.</p>
154
<dl class="return"><dt><b>Returns:</b></dt><dd>the channel the XBee is using</dd></dl>
155
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee__funcs.html#ga4f67630ca81e5eae064bb58c3818d3fd" title="Set the channel the XBee is currently using.">xbee_set_channel</a> </dd></dl>
156

  
157
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, <a class="el" href="wl__defs_8h_source.html#l00114">WL_ERROR_XBEE_COMMAND</a>, and <a class="el" href="xbee_8c_source.html#l01380">xbee_send_read_at_command()</a>.</p>
158

  
159
</div>
160
</div>
161
<a class="anchor" id="ga76e60575b236342945b6a69bbe42df9f"></a><!-- doxytag: member="xbee.h::xbee_get_pan" ref="ga76e60575b236342945b6a69bbe42df9f" args="(void)" -->
162
<div class="memitem">
163
<div class="memproto">
164
      <table class="memname">
165
        <tr>
166
          <td class="memname">uint16_t xbee_get_pan </td>
167
          <td>(</td>
168
          <td class="paramtype">void&nbsp;</td>
169
          <td class="paramname"></td>
170
          <td>&nbsp;)&nbsp;</td>
171
          <td></td>
172
        </tr>
173
      </table>
174
</div>
175
<div class="memdoc">
176

  
177
<p>Get the XBee's PAN ID. </p>
178
<p>Get the PAN ID for the XBee.</p>
179
<dl class="return"><dt><b>Returns:</b></dt><dd>the personal area network id, or XBEE_PAN_DEFAULT if it has not yet been set. </dd></dl>
180

  
181
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, <a class="el" href="wl__defs_8h_source.html#l00117">WL_ERROR_XBEE_COMMAND_16BIT</a>, and <a class="el" href="xbee_8c_source.html#l01380">xbee_send_read_at_command()</a>.</p>
182

  
183
</div>
184
</div>
185
<a class="anchor" id="ga35f6f209aee59fad0490a961587e014a"></a><!-- doxytag: member="xbee.h::xbee_init" ref="ga35f6f209aee59fad0490a961587e014a" args="(void)" -->
186
<div class="memitem">
187
<div class="memproto">
188
      <table class="memname">
189
        <tr>
190
          <td class="memname">int8_t xbee_init </td>
191
          <td>(</td>
192
          <td class="paramtype">void&nbsp;</td>
193
          <td class="paramname"></td>
194
          <td>&nbsp;)&nbsp;</td>
195
          <td></td>
196
        </tr>
197
      </table>
198
</div>
199
<div class="memdoc">
200

  
201
<p>Initialize the XBee library. </p>
202
<p>Initializes the XBee library so that other functions may be used. </p>
203

  
204
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, <a class="el" href="wl__defs_8h_source.html#l00120">WL_ERROR_BAUD</a>, <a class="el" href="wl__defs_8h_source.html#l00075">WL_ERROR_INIT_ALREADY_INITD</a>, <a class="el" href="wl__defs_8h_source.html#l00117">WL_ERROR_XBEE_COMMAND_16BIT</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, <a class="el" href="xbee_8c_source.html#l00087">xbee_basic_buf</a>, <a class="el" href="xbee_8c_source.html#l01725">xbee_get_address()</a>, and <a class="el" href="xbee_8c_source.html#l01586">xbee_set_pan()</a>.</p>
205

  
206
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00057">wl_init()</a>.</p>
207

  
208
</div>
209
</div>
210
<a class="anchor" id="ga5805e267e3b6f4b7bdad7aa6dc65ee04"></a><!-- doxytag: member="xbee.h::xbee_send" ref="ga5805e267e3b6f4b7bdad7aa6dc65ee04" args="(uint8_t *buf, uint16_t size)" -->
211
<div class="memitem">
212
<div class="memproto">
213
      <table class="memname">
214
        <tr>
215
          <td class="memname">int8_t xbee_send </td>
216
          <td>(</td>
217
          <td class="paramtype">uint8_t *&nbsp;</td>
218
          <td class="paramname"> <em>buf</em>, </td>
219
        </tr>
220
        <tr>
221
          <td class="paramkey"></td>
222
          <td></td>
223
          <td class="paramtype">uint16_t&nbsp;</td>
224
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
225
        </tr>
226
        <tr>
227
          <td></td>
228
          <td>)</td>
229
          <td></td><td></td><td></td>
230
        </tr>
231
      </table>
232
</div>
233
<div class="memdoc">
234

  
235
<p>Send an array of bytes to the xbee in API mode. </p>
236
<p>Send a buffer buf of size bytes to the XBee in API mode</p>
237
<dl><dt><b>Parameters:</b></dt><dd>
238
  <table border="0" cellspacing="2" cellpadding="0">
239
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>the buffer of data to send </td></tr>
240
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>the number of bytes to send </td></tr>
241
  </table>
242
  </dd>
243
</dl>
244

  
245
<p>References <a class="el" href="wl__defs_8h_source.html#l00093">WL_ERROR_SEND</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, and <a class="el" href="xbee_8c_source.html#l01015">xbee_sendc()</a>.</p>
246

  
247
<p>Referenced by <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>, and <a class="el" href="xbee_8c_source.html#l01432">xbee_send_packet()</a>.</p>
248

  
249
</div>
250
</div>
251
<a class="anchor" id="ga2a39ffce83d65d22aeefb41dfce2112f"></a><!-- doxytag: member="xbee.h::xbee_send_header" ref="ga2a39ffce83d65d22aeefb41dfce2112f" args="(uint16_t len)" -->
252
<div class="memitem">
253
<div class="memproto">
254
      <table class="memname">
255
        <tr>
256
          <td class="memname">int8_t xbee_send_header </td>
257
          <td>(</td>
258
          <td class="paramtype">uint16_t&nbsp;</td>
259
          <td class="paramname"> <em>len</em></td>
260
          <td>&nbsp;)&nbsp;</td>
261
          <td></td>
262
        </tr>
263
      </table>
264
</div>
265
<div class="memdoc">
266

  
267
<p>Send a frame header to the xbee. </p>
268
<p>Sends header information. Header information includes XBEE_FRAME_START and the packet length, as two bytes.</p>
269
<dl><dt><b>Parameters:</b></dt><dd>
270
  <table border="0" cellspacing="2" cellpadding="0">
271
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
272
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the size in bytes of the packet data </td></tr>
273
  </table>
274
  </dd>
275
</dl>
276

  
277
<p>References <a class="el" href="wl__defs_8h_source.html#l00093">WL_ERROR_SEND</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, <a class="el" href="xbee_8c_source.html#l00945">xbee_putc()</a>, and <a class="el" href="xbee_8c_source.html#l01015">xbee_sendc()</a>.</p>
278

  
279
<p>Referenced by <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>.</p>
280

  
281
</div>
282
</div>
283
<a class="anchor" id="gaae54f7208cfa786cb56d4d78ab3ceffe"></a><!-- doxytag: member="xbee.h::xbee_send_packet" ref="gaae54f7208cfa786cb56d4d78ab3ceffe" args="(uint8_t *packet, uint8_t len, uint16_t dest, uint8_t options, uint8_t frame)" -->
284
<div class="memitem">
285
<div class="memproto">
286
      <table class="memname">
287
        <tr>
288
          <td class="memname">int8_t xbee_send_packet </td>
289
          <td>(</td>
290
          <td class="paramtype">uint8_t *&nbsp;</td>
291
          <td class="paramname"> <em>packet</em>, </td>
292
        </tr>
293
        <tr>
294
          <td class="paramkey"></td>
295
          <td></td>
296
          <td class="paramtype">uint8_t&nbsp;</td>
297
          <td class="paramname"> <em>len</em>, </td>
298
        </tr>
299
        <tr>
300
          <td class="paramkey"></td>
301
          <td></td>
302
          <td class="paramtype">uint16_t&nbsp;</td>
303
          <td class="paramname"> <em>dest</em>, </td>
304
        </tr>
305
        <tr>
306
          <td class="paramkey"></td>
307
          <td></td>
308
          <td class="paramtype">uint8_t&nbsp;</td>
309
          <td class="paramname"> <em>options</em>, </td>
310
        </tr>
311
        <tr>
312
          <td class="paramkey"></td>
313
          <td></td>
314
          <td class="paramtype">uint8_t&nbsp;</td>
315
          <td class="paramname"> <em>frame</em></td><td>&nbsp;</td>
316
        </tr>
317
        <tr>
318
          <td></td>
319
          <td>)</td>
320
          <td></td><td></td><td></td>
321
        </tr>
322
      </table>
323
</div>
324
<div class="memdoc">
325

  
326
<p>Send a packet to the XBee. </p>
327
<p>Send the specified packet.</p>
328
<dl><dt><b>Parameters:</b></dt><dd>
329
  <table border="0" cellspacing="2" cellpadding="0">
330
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet data to send </td></tr>
331
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the number of bytes in the packet</td></tr>
332
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>the ID of the XBee to send the packet to, or XBEE_BROADCAST to send the message to all robots in the PAN.</td></tr>
333
    <tr><td valign="top"></td><td valign="top"><em>options</em>&nbsp;</td><td>a combination of the flags XBEE_OPTIONS_NONE, XBEE_OPTIONS_DISABLE_RESPONSE and XBEE_OPTIONS_BROADCAST_ALL_PANS</td></tr>
334
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the frame number to associate this packet with. This will be used to identify the response when the XBee alerts us as to whether or not our message was received. </td></tr>
335
  </table>
336
  </dd>
337
</dl>
338

  
339
<p>References <a class="el" href="wl__defs_8h_source.html#l00090">WL_ERROR_ARGUMENT</a>, <a class="el" href="wl__defs_8h_source.html#l00093">WL_ERROR_SEND</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, <a class="el" href="xbee_8c_source.html#l00945">xbee_putc()</a>, <a class="el" href="xbee_8c_source.html#l01038">xbee_send()</a>, and <a class="el" href="xbee_8c_source.html#l01015">xbee_sendc()</a>.</p>
340

  
341
</div>
342
</div>
343
<a class="anchor" id="gae75ee9a54a5811b8bc302dc2d70f0215"></a><!-- doxytag: member="xbee.h::xbee_sendc" ref="gae75ee9a54a5811b8bc302dc2d70f0215" args="(uint8_t byte)" -->
344
<div class="memitem">
345
<div class="memproto">
346
      <table class="memname">
347
        <tr>
348
          <td class="memname">int8_t xbee_sendc </td>
349
          <td>(</td>
350
          <td class="paramtype">uint8_t&nbsp;</td>
351
          <td class="paramname"> <em>byte</em></td>
352
          <td>&nbsp;)&nbsp;</td>
353
          <td></td>
354
        </tr>
355
      </table>
356
</div>
357
<div class="memdoc">
358

  
359
<p>Send byte to the xbee in API mode. </p>
360
<p>Send byte to the xbee in API mode.</p>
361
<dl><dt><b>Parameters:</b></dt><dd>
362
  <table border="0" cellspacing="2" cellpadding="0">
363
    <tr><td valign="top"></td><td valign="top"><em>byte</em>&nbsp;</td><td>the byte to be sent </td></tr>
364
  </table>
365
  </dd>
366
</dl>
367

  
368
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
369

  
370
<p>Referenced by <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>, <a class="el" href="xbee_8c_source.html#l01038">xbee_send()</a>, <a class="el" href="xbee_8c_source.html#l01332">xbee_send_header()</a>, and <a class="el" href="xbee_8c_source.html#l01432">xbee_send_packet()</a>.</p>
371

  
372
</div>
373
</div>
374
<a class="anchor" id="ga4f67630ca81e5eae064bb58c3818d3fd"></a><!-- doxytag: member="xbee.h::xbee_set_channel" ref="ga4f67630ca81e5eae064bb58c3818d3fd" args="(uint8_t channel)" -->
375
<div class="memitem">
376
<div class="memproto">
377
      <table class="memname">
378
        <tr>
379
          <td class="memname">int8_t xbee_set_channel </td>
380
          <td>(</td>
381
          <td class="paramtype">uint8_t&nbsp;</td>
382
          <td class="paramname"> <em>channel</em></td>
383
          <td>&nbsp;)&nbsp;</td>
384
          <td></td>
385
        </tr>
386
      </table>
387
</div>
388
<div class="memdoc">
389

  
390
<p>Set the channel the XBee is currently using. </p>
391
<p>Set the channel the XBee is using.</p>
392
<dl><dt><b>Parameters:</b></dt><dd>
393
  <table border="0" cellspacing="2" cellpadding="0">
394
    <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>
395
  </table>
396
  </dd>
397
</dl>
398
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__xbee__funcs.html#ga319d4bccd5e6b09d2f377d2170104817" title="Get the channel the XBee is currently using.">xbee_get_channel</a> </dd></dl>
399

  
400
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, <a class="el" href="wl__defs_8h_source.html#l00090">WL_ERROR_ARGUMENT</a>, <a class="el" href="wl__defs_8h_source.html#l00114">WL_ERROR_XBEE_COMMAND</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
401

  
402
</div>
403
</div>
404
<a class="anchor" id="gadbcb9cc8cf6afa28e6de8defb33f8196"></a><!-- doxytag: member="xbee.h::xbee_set_pan" ref="gadbcb9cc8cf6afa28e6de8defb33f8196" args="(uint16_t id)" -->
405
<div class="memitem">
406
<div class="memproto">
407
      <table class="memname">
408
        <tr>
409
          <td class="memname">int8_t xbee_set_pan </td>
410
          <td>(</td>
411
          <td class="paramtype">uint16_t&nbsp;</td>
412
          <td class="paramname"> <em>id</em></td>
413
          <td>&nbsp;)&nbsp;</td>
414
          <td></td>
415
        </tr>
416
      </table>
417
</div>
418
<div class="memdoc">
419

  
420
<p>Set the PAN ID for the XBee. </p>
421
<p>Sets the personal area network id.</p>
422
<dl><dt><b>Parameters:</b></dt><dd>
423
  <table border="0" cellspacing="2" cellpadding="0">
424
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>the new personal area network (PAN) id </td></tr>
425
  </table>
426
  </dd>
427
</dl>
428

  
429
<p>References <a class="el" href="xbee_8c_source.html#l00722">getStatus()</a>, <a class="el" href="wl__defs_8h_source.html#l00114">WL_ERROR_XBEE_COMMAND</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
430

  
431
<p>Referenced by <a class="el" href="xbee_8c_source.html#l00729">xbee_init()</a>.</p>
432

  
433
</div>
434
</div>
435
<a class="anchor" id="ga0b4c25c76efbe397decacefced00e06c"></a><!-- doxytag: member="xbee.h::xbee_terminate" ref="ga0b4c25c76efbe397decacefced00e06c" args="(void)" -->
436
<div class="memitem">
437
<div class="memproto">
438
      <table class="memname">
439
        <tr>
440
          <td class="memname">int8_t xbee_terminate </td>
441
          <td>(</td>
442
          <td class="paramtype">void&nbsp;</td>
443
          <td class="paramname"></td>
444
          <td>&nbsp;)&nbsp;</td>
445
          <td></td>
446
        </tr>
447
      </table>
448
</div>
449
<div class="memdoc">
450

  
451
<p>Uninitialize the XBee library. </p>
452
<p>Call when finished using the XBee library. </p>
453

  
454
<p>References <a class="el" href="wl__defs_8h_source.html#l00081">WL_ERROR_TERMINATION_FAILED</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
455

  
456
<p>Referenced by <a class="el" href="wireless_8c_source.html#l00087">wl_terminate()</a>.</p>
457

  
458
</div>
459
</div>
460
</div>
461
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
462
<a href="http://www.doxygen.org/index.html">
463
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
464
</body>
465
</html>
0 466

  
branches/wireless/docs/libwireless/html/classes.html
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: Alphabetical List</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 -->
11
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20
  <div class="tabs">
21
    <ul>
22
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
23
    </ul>
24
  </div>
25
</div>
26
<div class="contents">
27
<h1>Data Structure Index</h1><div class="qindex"><a class="qindex" href="#letter_P">P</a></div>
28
<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
29
<tr><td><a name="letter_P"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;P&nbsp;&nbsp;</div></td></tr></table>
30
</td><td><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a>&nbsp;&nbsp;&nbsp;</td></tr></table><div class="qindex"><a class="qindex" href="#letter_P">P</a></div>
31
</div>
32
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
33
<a href="http://www.doxygen.org/index.html">
34
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
35
</body>
36
</html>
0 37

  
branches/wireless/docs/libwireless/html/globals_func.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: Data Fields</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: Data Fields</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>
......
23 27
    <ul>
24 28
      <li><a href="globals.html"><span>All</span></a></li>
25 29
      <li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
30
      <li><a href="globals_vars.html"><span>Variables</span></a></li>
26 31
      <li><a href="globals_defs.html"><span>Defines</span></a></li>
27 32
    </ul>
28 33
  </div>
29 34
  <div class="tabs">
30 35
    <ul>
36
      <li><a href="#index_c"><span>c</span></a></li>
37
      <li><a href="#index_g"><span>g</span></a></li>
31 38
      <li><a href="#index_w"><span>w</span></a></li>
32 39
      <li><a href="#index_x"><span>x</span></a></li>
33 40
    </ul>
......
35 42
</div>
36 43
<div class="contents">
37 44
&nbsp;
38
<p>
39
<h3><a class="anchor" name="index_w">- w -</a></h3><ul>
45

  
46
<h3><a class="anchor" id="index_c">- c -</a></h3><ul>
47
<li>check_last_receive()
48
: <a class="el" href="group__xbee.html#ga335b40b15f89a8a0d26db9226812914e">xbee.c</a>
49
</li>
50
</ul>
51

  
52

  
53
<h3><a class="anchor" id="index_g">- g -</a></h3><ul>
54
<li>getStatus()
55
: <a class="el" href="group__xbee.html#ga8a4c7ae8201a7ca230fdb47bfa13d044">xbee.c</a>
56
</li>
57
</ul>
58

  
59

  
60
<h3><a class="anchor" id="index_w">- w -</a></h3><ul>
40 61
<li>wl_ack_check()
41
: <a class="el" href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wireless.h</a>
42
, <a class="el" href="group__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wireless_send.c</a>
62
: <a class="el" href="group__wl__functions.html#gaa364aa4d9cc8c789f05401e8adf44785">wireless.h</a>
63
, <a class="el" href="group__wireless.html#gaa364aa4d9cc8c789f05401e8adf44785">wireless_send.c</a>
64
</li>
43 65
<li>wl_ack_error()
44
: <a class="el" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf">wireless_send.c</a>
45
, <a class="el" href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf">wireless.h</a>
66
: <a class="el" href="group__wireless.html#ga15c9a01839696beb05d1e4f161d968b7">wireless_send.c</a>
67
, <a class="el" href="group__wl__functions.html#ga15c9a01839696beb05d1e4f161d968b7">wireless.h</a>
68
</li>
46 69
<li>wl_ack_reset()
47
: <a class="el" href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wireless.h</a>
48
, <a class="el" href="group__wireless.html#g62e126abfcd382ec02524dd2f45a8a7b">wireless_send.c</a>
70
: <a class="el" href="group__wl__functions.html#ga62e126abfcd382ec02524dd2f45a8a7b">wireless.h</a>
71
, <a class="el" href="group__wireless.html#ga62e126abfcd382ec02524dd2f45a8a7b">wireless_send.c</a>
72
</li>
49 73
<li>wl_dispatch()
50
: <a class="el" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless_receive.c</a>
51
, <a class="el" href="group__wl__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wireless.h</a>
74
: <a class="el" href="group__wireless.html#gae91c1e1940dfbbd063fdcfb86049c64a">wireless_receive.c</a>
75
, <a class="el" href="group__wl__functions.html#gae91c1e1940dfbbd063fdcfb86049c64a">wireless.h</a>
76
</li>
52 77
<li>wl_get()
53
: <a class="el" href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wireless.h</a>
54
, <a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wireless_receive.c</a>
78
: <a class="el" href="group__wl__functions.html#gaa5a965e3443e4b2b60243225c50ecca7">wireless.h</a>
79
, <a class="el" href="group__wireless.html#gaa5a965e3443e4b2b60243225c50ecca7">wireless_receive.c</a>
80
</li>
55 81
<li>wl_get_basic()
56
: <a class="el" href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wireless.h</a>
57
, <a class="el" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817">wireless_receive.c</a>
82
: <a class="el" href="group__wl__functions.html#gae2509e2b6bc61faa26d87b1d87881817">wireless.h</a>
83
, <a class="el" href="group__wireless.html#gae2509e2b6bc61faa26d87b1d87881817">wireless_receive.c</a>
84
</li>
58 85
<li>wl_init()
59
: <a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wireless.c</a>
60
, <a class="el" href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wireless.h</a>
86
: <a class="el" href="group__wireless.html#ga6a8d6179b1fe27f762937f0b47af2009">wireless.c</a>
87
, <a class="el" href="group__wl__functions.html#ga6a8d6179b1fe27f762937f0b47af2009">wireless.h</a>
88
</li>
61 89
<li>wl_register_handler()
62
: <a class="el" href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.h</a>
63
, <a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wireless.c</a>
90
: <a class="el" href="group__wl__functions.html#ga7aa57c04f65ff3c8fec591248ab82f86">wireless.h</a>
91
, <a class="el" href="group__wireless.html#ga7aa57c04f65ff3c8fec591248ab82f86">wireless.c</a>
92
</li>
64 93
<li>wl_send()
65
: <a class="el" href="group__wl__functions.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wireless.h</a>
66
, <a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wireless_send.c</a>
94
: <a class="el" href="group__wl__functions.html#gaf713b6ecbf2de78139990a40fe864d5e">wireless.h</a>
95
, <a class="el" href="group__wireless.html#gaf713b6ecbf2de78139990a40fe864d5e">wireless_send.c</a>
96
</li>
67 97
<li>wl_send_basic()
68
: <a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wireless.h</a>
69
, <a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wireless_send.c</a>
98
: <a class="el" href="group__wireless.html#ga226d89acb4f77a982a2167eb1773eff2">wireless_send.c</a>
99
, <a class="el" href="group__wl__functions.html#ga226d89acb4f77a982a2167eb1773eff2">wireless.h</a>
100
</li>
70 101
<li>wl_send_global()
71
: <a class="el" href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2">wireless.h</a>
72
, <a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wireless_send.c</a>
102
: <a class="el" href="group__wl__functions.html#gab0af7308304aed74eb281188b712e132">wireless.h</a>
103
, <a class="el" href="group__wireless.html#gab0af7308304aed74eb281188b712e132">wireless_send.c</a>
104
</li>
73 105
<li>wl_send_pan()
74
: <a class="el" href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076">wireless.h</a>
75
, <a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wireless_send.c</a>
106
: <a class="el" href="group__wl__functions.html#ga85cd4090dd284a4747dc8a56c1b215ad">wireless.h</a>
107
, <a class="el" href="group__wireless.html#ga85cd4090dd284a4747dc8a56c1b215ad">wireless_send.c</a>
108
</li>
76 109
<li>wl_send_robot()
77
: <a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wireless_send.c</a>
78
, <a class="el" href="group__wl__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wireless.h</a>
110
: <a class="el" href="group__wl__functions.html#ga49160840045fda872a5e38432cc26988">wireless.h</a>
111
, <a class="el" href="group__wireless.html#ga49160840045fda872a5e38432cc26988">wireless_send.c</a>
112
</li>
79 113
<li>wl_terminate()
80
: <a class="el" href="group__wl__functions.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.h</a>
81
, <a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wireless.c</a>
114
: <a class="el" href="group__wl__functions.html#ga223f437c2bc8ab8a3ac2e0e06841120f">wireless.h</a>
115
, <a class="el" href="group__wireless.html#ga223f437c2bc8ab8a3ac2e0e06841120f">wireless.c</a>
116
</li>
117
<li>wl_unregister_handler()
118
: <a class="el" href="group__wireless.html#ga376508d5682b1b8c88ef8b5f911a3367">wireless.c</a>
119
, <a class="el" href="group__wl__functions.html#ga376508d5682b1b8c88ef8b5f911a3367">wireless.h</a>
120
</li>
82 121
</ul>
83
<h3><a class="anchor" name="index_x">- x -</a></h3><ul>
122

  
123

  
124
<h3><a class="anchor" id="index_x">- x -</a></h3><ul>
125
<li>xbee_checksum_add()
126
: <a class="el" href="group__xbee.html#ga2eb96c49811a1d9f2ccd1e1186915077">xbee.c</a>
127
, <a class="el" href="group__xbee__funcs.html#ga2eb96c49811a1d9f2ccd1e1186915077">xbee.h</a>
128
</li>
84 129
<li>xbee_get_address()
85
: <a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee.c</a>
130
: <a class="el" href="group__xbee__funcs.html#ga24d751120f5cded06a70d156c29261fc">xbee.h</a>
131
, <a class="el" href="group__xbee.html#ga24d751120f5cded06a70d156c29261fc">xbee.c</a>
132
</li>
86 133
<li>xbee_get_channel()
87
: <a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee.c</a>
88
<li>xbee_get_packet()
89
: <a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee.c</a>
90
<li>xbee_get_pan_id()
91
: <a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee.c</a>
92
<li>xbee_lib_init()
93
: <a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee.c</a>
134
: <a class="el" href="group__xbee.html#ga319d4bccd5e6b09d2f377d2170104817">xbee.c</a>
135
, <a class="el" href="group__xbee__funcs.html#ga319d4bccd5e6b09d2f377d2170104817">xbee.h</a>
136
</li>
137
<li>xbee_get_pan()
138
: <a class="el" href="group__xbee__funcs.html#ga76e60575b236342945b6a69bbe42df9f">xbee.h</a>
139
, <a class="el" href="group__xbee.html#gaa740c59073c6db9e00a2a2de10a95091">xbee.c</a>
140
</li>
141
<li>xbee_getc()
142
: <a class="el" href="group__xbee.html#ga409ff62ddd9e22eaf745a50f688263fd">xbee.c</a>
143
</li>
144
<li>xbee_getc_nb()
145
: <a class="el" href="group__xbee.html#gae564a6f5453934b0234a054fbc238fd3">xbee.c</a>
146
</li>
147
<li>xbee_init()
148
: <a class="el" href="group__xbee.html#ga31a4df97d6865a40123337045109b9f1">xbee.c</a>
149
, <a class="el" href="group__xbee__funcs.html#ga35f6f209aee59fad0490a961587e014a">xbee.h</a>
150
</li>
151
<li>xbee_putc()
152
: <a class="el" href="group__xbee.html#gaf29617dd4988f4b056f9476004ae5cbf">xbee.c</a>
153
</li>
94 154
<li>xbee_reset()
95
: <a class="el" href="group__xbee.html#gfcfccfa7323041108202275eba913be7">xbee.h</a>
155
: <a class="el" href="group__xbee__funcs.html#gacf9354ba8b49419b6286e1318e87aa41">xbee.h</a>
156
</li>
157
<li>xbee_send()
158
: <a class="el" href="group__xbee__funcs.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04">xbee.h</a>
159
, <a class="el" href="group__xbee.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04">xbee.c</a>
160
</li>
161
<li>xbee_send_header()
162
: <a class="el" href="group__xbee.html#ga2a39ffce83d65d22aeefb41dfce2112f">xbee.c</a>
163
, <a class="el" href="group__xbee__funcs.html#ga2a39ffce83d65d22aeefb41dfce2112f">xbee.h</a>
164
</li>
96 165
<li>xbee_send_packet()
97
: <a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee.c</a>
166
: <a class="el" href="group__xbee__funcs.html#gaae54f7208cfa786cb56d4d78ab3ceffe">xbee.h</a>
167
, <a class="el" href="group__xbee.html#gaae54f7208cfa786cb56d4d78ab3ceffe">xbee.c</a>
168
</li>
98 169
<li>xbee_send_read_at_command()
99
: <a class="el" href="group__xbee.html#g2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee.c</a>
170
: <a class="el" href="group__xbee.html#ga2694f3530e4cf256ff9e96600aea753c">xbee.c</a>
171
</li>
172
<li>xbee_sendc()
173
: <a class="el" href="group__xbee.html#gae75ee9a54a5811b8bc302dc2d70f0215">xbee.c</a>
174
, <a class="el" href="group__xbee__funcs.html#gae75ee9a54a5811b8bc302dc2d70f0215">xbee.h</a>
175
</li>
100 176
<li>xbee_set_channel()
101
: <a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee.c</a>
102
<li>xbee_set_com_port()
103
: <a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee.c</a>
104
<li>xbee_set_pan_id()
105
: <a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee.c</a>
177
: <a class="el" href="group__xbee__funcs.html#ga4f67630ca81e5eae064bb58c3818d3fd">xbee.h</a>
178
, <a class="el" href="group__xbee.html#ga4f67630ca81e5eae064bb58c3818d3fd">xbee.c</a>
179
</li>
180
<li>xbee_set_pan()
181
: <a class="el" href="group__xbee.html#gadbcb9cc8cf6afa28e6de8defb33f8196">xbee.c</a>
182
, <a class="el" href="group__xbee__funcs.html#gadbcb9cc8cf6afa28e6de8defb33f8196">xbee.h</a>
183
</li>
106 184
<li>xbee_terminate()
107
: <a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee.c</a>
185
: <a class="el" href="group__xbee.html#ga3fe446135ba896e6438a4fcd67154119">xbee.c</a>
186
, <a class="el" href="group__xbee__funcs.html#ga0b4c25c76efbe397decacefced00e06c">xbee.h</a>
187
</li>
108 188
</ul>
109 189
</div>
110
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
190
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
111 191
<a href="http://www.doxygen.org/index.html">
112
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
192
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
113 193
</body>
114 194
</html>
branches/wireless/docs/libwireless/html/files.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: File Index</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: File Index</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>
......
23 27
<div class="contents">
24 28
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table>
25 29
  <tr><td class="indexkey"><a class="el" href="wireless_8c.html">wireless.c</a></td><td class="indexvalue">Wireless library </td></tr>
26
  <tr><td class="indexkey"><a class="el" href="wireless_8h.html">wireless.h</a></td><td class="indexvalue">Contains definitions for using the wireless library </td></tr>
30
  <tr><td class="indexkey"><a class="el" href="wireless_8h.html">wireless.h</a> <a href="wireless_8h_source.html">[code]</a></td><td class="indexvalue">Contains definitions for using the wireless library </td></tr>
27 31
  <tr><td class="indexkey"><a class="el" href="wireless__receive_8c.html">wireless_receive.c</a></td><td class="indexvalue">Wireless library receive functions </td></tr>
28 32
  <tr><td class="indexkey"><a class="el" href="wireless__send_8c.html">wireless_send.c</a></td><td class="indexvalue">Wireless library send functions </td></tr>
29
  <tr><td class="indexkey"><a class="el" href="wl__defs_8h.html">wl_defs.h</a></td><td class="indexvalue">Definitions for Wireless </td></tr>
33
  <tr><td class="indexkey"><a class="el" href="wl__defs_8h.html">wl_defs.h</a> <a href="wl__defs_8h_source.html">[code]</a></td><td class="indexvalue">Definitions for Wireless </td></tr>
30 34
  <tr><td class="indexkey"><a class="el" href="xbee_8c.html">xbee.c</a></td><td class="indexvalue">XBee Interface </td></tr>
31
  <tr><td class="indexkey"><a class="el" href="xbee_8h.html">xbee.h</a></td><td class="indexvalue">Contains definitions for using the XBee </td></tr>
35
  <tr><td class="indexkey"><a class="el" href="xbee_8h.html">xbee.h</a> <a href="xbee_8h_source.html">[code]</a></td><td class="indexvalue">Contains definitions for using the XBee </td></tr>
32 36
</table>
33 37
</div>
34
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
38
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
35 39
<a href="http://www.doxygen.org/index.html">
36
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
40
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
37 41
</body>
38 42
</html>
branches/wireless/docs/libwireless/html/xbee_8h_source.html
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 Source File</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 -->
11
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li class="current"><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20
  <div class="tabs">
21
    <ul>
22
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
23
      <li><a href="globals.html"><span>Globals</span></a></li>
24
    </ul>
25
  </div>
26
<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 
27
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef XBEE_H</span>
28
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_H</span>
29
<a name="l00040"></a>00040 <span class="preprocessor"></span>
30
<a name="l00041"></a>00041 <span class="comment">// need this for C99 int types</span>
31
<a name="l00042"></a>00042 <span class="preprocessor">#ifndef STDINT_H</span>
32
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define STDINT_H</span>
33
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#include &lt;stdint.h&gt;</span>
34
<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
35
<a name="l00046"></a>00046 <span class="preprocessor"></span>
36
<a name="l00047"></a>00047 
37
<a name="l00061"></a>00061 <span class="preprocessor">#ifndef XBEE_BAUD</span>
38
<a name="l00062"></a>00062 <span class="preprocessor"></span>
39
<a name="l00063"></a><a class="code" href="group__xbee__const.html#ga7125fc8f3df24a2db8e074983206b054">00063</a> <span class="preprocessor">#define XBEE_BAUD 9600 //115200</span>
40
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
41
<a name="l00065"></a>00065 <span class="preprocessor"></span> 
42
<a name="l00070"></a><a class="code" href="group__xbee__const.html#gae6bb9bb274d6750f954762454807a5a7">00070</a> <span class="preprocessor">#define XBEE_PAN_DEFAULT 0xFFFF</span>
43
<a name="l00071"></a>00071 <span class="preprocessor"></span>
44
<a name="l00072"></a><a class="code" href="group__xbee__const.html#ga35f8b9d8e01e788f1e29928cba29f215">00072</a> <span class="preprocessor">#define XBEE_CHANNEL_DEFAULT 0</span>
45
<a name="l00073"></a>00073 <span class="preprocessor"></span>
46
<a name="l00074"></a><a class="code" href="group__xbee__const.html#ga93bbd21f7965e1697350f950cedff5c4">00074</a> <span class="preprocessor">#define XBEE_BROADCAST 0xFFFF</span>
47
<a name="l00075"></a>00075 <span class="preprocessor"></span>
48
<a name="l00076"></a><a class="code" href="group__xbee__const.html#gabca7356c2b8183fd41b5ca9a82dd962b">00076</a> <span class="preprocessor">#define XBEE_OPTIONS_NONE 0x00</span>
49
<a name="l00077"></a>00077 <span class="preprocessor"></span>
50
<a name="l00078"></a><a class="code" href="group__xbee__const.html#gacf9509013302590dca5ce3db63c64609">00078</a> <span class="preprocessor">#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01</span>
51
<a name="l00079"></a>00079 <span class="preprocessor"></span>
52
<a name="l00080"></a><a class="code" href="group__xbee__const.html#ga57382f888360b5b19f0de3b6f1f7c5a3">00080</a> <span class="preprocessor">#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04</span>
53
<a name="l00081"></a>00081 <span class="preprocessor"></span>
54
<a name="l00082"></a><a class="code" href="group__xbee__const.html#ga7840d8b64c8bec12d8b8d32e845a638a">00082</a> <span class="preprocessor">#define XBEE_TX_STATUS 0x89</span>
55
<a name="l00083"></a>00083 <span class="preprocessor"></span>
56
<a name="l00084"></a><a class="code" href="group__xbee__const.html#gac2b1262a3a1eb4a9f7ead366af71c32c">00084</a> <span class="preprocessor">#define XBEE_RX 0x81</span>
57
<a name="l00085"></a>00085 <span class="preprocessor"></span>
58
<a name="l00090"></a>00090 <span class="comment">// TODO: add comments for all of these definitions</span>
59
<a name="l00091"></a>00091 
60
<a name="l00092"></a>00092 <span class="comment">/*Frame Types*/</span>
61
<a name="l00093"></a>00093 <span class="preprocessor">#define XBEE_FRAME_START 0x7E</span>
62
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_STATUS 0x8A</span>
63
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_AT_COMMAND 0x08</span>
64
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_AT_COMMAND_RESPONSE 0x88</span>
65
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_TX_REQUEST_64 0x00</span>
66
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_TX_REQUEST_16 0x01</span>
67
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_TX_STATUS XBEE_TX_STATUS</span>
68
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_RX_64 0x80</span>
69
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#define XBEE_FRAME_RX_16 XBEE_RX</span>
70
<a name="l00102"></a>00102 <span class="preprocessor"></span> <span class="comment">// end const group</span>
71
<a name="l00106"></a>00106  
72
<a name="l00114"></a>00114 int8_t <a class="code" href="group__xbee.html#ga31a4df97d6865a40123337045109b9f1" title="Initialize the XBee library.">xbee_init</a>(<span class="keywordtype">void</span>);
73
<a name="l00116"></a>00116 int8_t <a class="code" href="group__xbee.html#ga3fe446135ba896e6438a4fcd67154119" title="Uninitialize the XBee library.">xbee_terminate</a>(<span class="keywordtype">void</span>);
74
<a name="l00118"></a>00118 int8_t <a class="code" href="group__xbee.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04" title="Send an array of bytes to the xbee in API mode.">xbee_send</a>(uint8_t* buf, uint16_t size);
75
<a name="l00120"></a>00120 int8_t <a class="code" href="group__xbee.html#gae75ee9a54a5811b8bc302dc2d70f0215" title="Send byte to the xbee in API mode.">xbee_sendc</a>(uint8_t byte);
76
<a name="l00122"></a>00122 int8_t <a class="code" href="group__xbee.html#ga2eb96c49811a1d9f2ccd1e1186915077" title="Add a buffer to the checksum value.">xbee_checksum_add</a>(uint8_t *buf, uint8_t len, uint8_t* sum);
77
<a name="l00124"></a>00124 int8_t <a class="code" href="group__xbee.html#ga2a39ffce83d65d22aeefb41dfce2112f" title="Send a frame header to the xbee.">xbee_send_header</a>(uint16_t len);
78
<a name="l00126"></a>00126 int8_t <a class="code" href="group__xbee.html#gaae54f7208cfa786cb56d4d78ab3ceffe" title="Send a packet to the XBee.">xbee_send_packet</a>(uint8_t* packet, uint8_t len, uint16_t dest, uint8_t options, uint8_t frame);
79
<a name="l00128"></a>00128 int8_t <a class="code" href="group__xbee.html#gadbcb9cc8cf6afa28e6de8defb33f8196" title="Set the PAN ID for the XBee.">xbee_set_pan</a>(uint16_t <span class="keywordtype">id</span>);
80
<a name="l00130"></a>00130 uint16_t <a class="code" href="group__xbee.html#gaa740c59073c6db9e00a2a2de10a95091" title="Get the XBee&amp;#39;s PAN ID.">xbee_get_pan</a>(<span class="keywordtype">void</span>);
81
<a name="l00132"></a>00132 int8_t <a class="code" href="group__xbee.html#ga4f67630ca81e5eae064bb58c3818d3fd" title="Set the channel the XBee is currently using.">xbee_set_channel</a>(uint8_t channel);
82
<a name="l00134"></a>00134 int8_t <a class="code" href="group__xbee.html#ga319d4bccd5e6b09d2f377d2170104817" title="Get the channel the XBee is currently using.">xbee_get_channel</a>(<span class="keywordtype">void</span>);
83
<a name="l00136"></a>00136 uint16_t <a class="code" href="group__xbee.html#ga24d751120f5cded06a70d156c29261fc" title="Get the XBee&amp;#39;s 16-bit address.">xbee_get_address</a>(<span class="keywordtype">void</span>);
84
<a name="l00138"></a>00138 int8_t <a class="code" href="group__xbee__funcs.html#gacf9354ba8b49419b6286e1318e87aa41" title="Reset XBee.">xbee_reset</a>(<span class="keywordtype">void</span>); <span class="comment">// TODO: implement this function</span>
85
<a name="l00139"></a>00139  <span class="comment">//end xbee_funcs group</span>
86
<a name="l00141"></a>00141  <span class="comment">//end defgroup</span>
87
<a name="l00143"></a>00143 
88
<a name="l00144"></a>00144 <span class="preprocessor">#endif</span>
89
</pre></div></div>
90
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
91
<a href="http://www.doxygen.org/index.html">
92
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
93
</body>
94
</html>
0 95

  
branches/wireless/docs/libwireless/html/group__xbee__const.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 constants</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 constants</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><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>xbee constants<br>
22
<h1>xbee constants<br/>
19 23
<small>
20 24
[<a class="el" href="group__xbee.html">XBee</a>]</small>
21
</h1><table border="0" cellpadding="0" cellspacing="0">
22
<tr><td></td></tr>
23
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd0466c206d7e1f82ee407d114468e96"></a><!-- doxytag: member="xbee_const::XBEE_PORT_DEFAULT" ref="gfd0466c206d7e1f82ee407d114468e96" args="" -->
25
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gfd0466c206d7e1f82ee407d114468e96">XBEE_PORT_DEFAULT</a>&nbsp;&nbsp;&nbsp;&quot;/dev/ttyUSB1&quot;</td></tr>
26

  
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The port to use the XBee from on the computer. <br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g63d0ecb125d464ea34524e090648f70f"></a><!-- doxytag: member="xbee_const::XBEE_BUFFER_SIZE" ref="g63d0ecb125d464ea34524e090648f70f" args="" -->
29
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_BUFFER_SIZE</b>&nbsp;&nbsp;&nbsp;128</td></tr>
30

  
31
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="xbee_const::PACKET_BUFFER_SIZE" ref="gb30af815d6e9494361629440f14e3716" args="" -->
32
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b>&nbsp;&nbsp;&nbsp;108</td></tr>
33

  
34
<tr><td colspan="2"><br><h2>xbee options</h2></td></tr>
35
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee_const::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" -->
36
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>
37

  
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset PAN, uses XBee default. <br></td></tr>
39
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee_const::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" -->
40
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a>&nbsp;&nbsp;&nbsp;0</td></tr>
41

  
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset channel, uses XBee default. <br></td></tr>
43
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee_const::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" -->
44
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a>&nbsp;&nbsp;&nbsp;0xFFFF</td></tr>
45

  
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Broadcast to all robots in the PAN. <br></td></tr>
47
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee_const::XBEE_OPTIONS_NONE" ref="gbca7356c2b8183fd41b5ca9a82dd962b" args="" -->
48
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gbca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>
49

  
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">No special options. <br></td></tr>
51
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee_const::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gcf9509013302590dca5ce3db63c64609" args="" -->
52
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gcf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>
53

  
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br></td></tr>
55
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee_const::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="g57382f888360b5b19f0de3b6f1f7c5a3" args="" -->
56
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>&nbsp;&nbsp;&nbsp;0x04</td></tr>
57

  
58
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the packet to all PANS. <br></td></tr>
59
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee_const::XBEE_TX_STATUS" ref="g7840d8b64c8bec12d8b8d32e845a638a" args="" -->
60
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a>&nbsp;&nbsp;&nbsp;0x89</td></tr>
61

  
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A transmit status packet. <br></td></tr>
63
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee_const::XBEE_RX" ref="gc2b1262a3a1eb4a9f7ead366af71c32c" args="" -->
64
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gc2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a>&nbsp;&nbsp;&nbsp;0x81</td></tr>
65

  
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A packet received from another XBee. <br></td></tr>
67
<tr><td colspan="2"><br><h2>xbee frame types</h2></td></tr>
68
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_START" ref="g72aa42b35714e06ac26df31b06a8bf39" args="" -->
25
</h1>
26
<p>These are constants used for the xbee module.  
27
<a href="#_details">More...</a></p>
28
<table border="0" cellpadding="0" cellspacing="0">
29
<tr><td colspan="2"><h2>Defines</h2></td></tr>
30
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7125fc8f3df24a2db8e074983206b054"></a><!-- doxytag: member="xbee_const::XBEE_BAUD" ref="ga7125fc8f3df24a2db8e074983206b054" args="" -->
31
#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>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The XBee baud rate. <br/></td></tr>
33
<tr><td colspan="2"><h2>xbee options</h2></td></tr>
34
<tr><td colspan="2"><p><a class="anchor" id="amgrp0014d6a1d613fbff74082710cdb428d7"></a> </p>
35
<br/><br/></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee_const::XBEE_PAN_DEFAULT" ref="gae6bb9bb274d6750f954762454807a5a7" args="" -->
37
#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>
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset PAN, uses XBee default. <br/></td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee_const::XBEE_CHANNEL_DEFAULT" ref="ga35f8b9d8e01e788f1e29928cba29f215" args="" -->
40
#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>
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unset channel, uses XBee default. <br/></td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee_const::XBEE_BROADCAST" ref="ga93bbd21f7965e1697350f950cedff5c4" args="" -->
43
#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>
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Broadcast to all robots in the PAN. <br/></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee_const::XBEE_OPTIONS_NONE" ref="gabca7356c2b8183fd41b5ca9a82dd962b" args="" -->
46
#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>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">No special options. <br/></td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee_const::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gacf9509013302590dca5ce3db63c64609" args="" -->
49
#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>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br/></td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee_const::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="ga57382f888360b5b19f0de3b6f1f7c5a3" args="" -->
52
#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>
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the packet to all PANS. <br/></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee_const::XBEE_TX_STATUS" ref="ga7840d8b64c8bec12d8b8d32e845a638a" args="" -->
55
#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>
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A transmit status packet. <br/></td></tr>
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee_const::XBEE_RX" ref="gac2b1262a3a1eb4a9f7ead366af71c32c" args="" -->
58
#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>
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A packet received from another XBee. <br/></td></tr>
60
<tr><td colspan="2"><h2>xbee frame types</h2></td></tr>
61
<tr><td colspan="2"><p><a class="anchor" id="amgrp1ac6183ed989d02124dd9e6c432cc711"></a> </p>
62
<br/><br/></td></tr>
63
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_START" ref="ga72aa42b35714e06ac26df31b06a8bf39" args="" -->
69 64
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_START</b>&nbsp;&nbsp;&nbsp;0x7E</td></tr>
70

  
71
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbe7468473089e3cdd2ed85cac2244d49"></a><!-- doxytag: member="xbee_const::XBEE_GET_PACKET_TIMEOUT" ref="gbe7468473089e3cdd2ed85cac2244d49" args="" -->
72
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_GET_PACKET_TIMEOUT</b>&nbsp;&nbsp;&nbsp;1000</td></tr>
73

  
74
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_STATUS" ref="ge0fc9d7b1078703227c91e1352b708c5" args="" -->
65
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_STATUS" ref="gae0fc9d7b1078703227c91e1352b708c5" args="" -->
75 66
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_STATUS</b>&nbsp;&nbsp;&nbsp;0x8A</td></tr>
76

  
77
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_AT_COMMAND" ref="g106780ab66c38464e90af25ae3cc73de" args="" -->
67
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_AT_COMMAND" ref="ga106780ab66c38464e90af25ae3cc73de" args="" -->
78 68
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND</b>&nbsp;&nbsp;&nbsp;0x08</td></tr>
79

  
80
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="gac9e8cc2d9fdda49b77aed7d9380bfde" args="" -->
69
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="gaac9e8cc2d9fdda49b77aed7d9380bfde" args="" -->
81 70
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND_RESPONSE</b>&nbsp;&nbsp;&nbsp;0x88</td></tr>
82

  
83
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_TX_REQUEST_64" ref="g31af21123fe9b33803cdf96626776d32" args="" -->
71
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_TX_REQUEST_64" ref="ga31af21123fe9b33803cdf96626776d32" args="" -->
84 72
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_64</b>&nbsp;&nbsp;&nbsp;0x00</td></tr>
85

  
86
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_TX_REQUEST_16" ref="g30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" -->
73
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_TX_REQUEST_16" ref="ga30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" -->
87 74
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_16</b>&nbsp;&nbsp;&nbsp;0x01</td></tr>
88

  
89
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_TX_STATUS" ref="g301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" -->
75
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_TX_STATUS" ref="ga301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" -->
90 76
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_STATUS</b>&nbsp;&nbsp;&nbsp;XBEE_TX_STATUS</td></tr>
91

  
92
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_RX_64" ref="gba621d0a00f41acc7e059b5abf4802ad" args="" -->
77
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_RX_64" ref="gaba621d0a00f41acc7e059b5abf4802ad" args="" -->
93 78
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_64</b>&nbsp;&nbsp;&nbsp;0x80</td></tr>
94

  
95
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_RX_16" ref="g5b80e57bcad9ccaa20022e8d4968ec66" args="" -->
79
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee_const::XBEE_FRAME_RX_16" ref="ga5b80e57bcad9ccaa20022e8d4968ec66" args="" -->
96 80
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_16</b>&nbsp;&nbsp;&nbsp;XBEE_RX</td></tr>
97

  
98 81
</table>
82
<hr/><a name="_details"></a><h2>Detailed Description</h2>
83
<p>These are constants used for the xbee module. </p>
99 84
</div>
100
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
85
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
101 86
<a href="http://www.doxygen.org/index.html">
102
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
87
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
103 88
</body>
104 89
</html>
branches/wireless/docs/libwireless/html/group__wl__error.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: Error Codes</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: Error Codes</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><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>Error Codes<br>
22
<h1>Error Codes<br/>
19 23
<small>
20 24
[<a class="el" href="group__wireless.html">Wireless</a>]</small>
21 25
</h1><table border="0" cellpadding="0" cellspacing="0">
22
<tr><td></td></tr>
23
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2b8a799ce85bb21788e58e1c23c16fc0"></a><!-- doxytag: member="wl_error::WL_SUCCESS" ref="g2b8a799ce85bb21788e58e1c23c16fc0" args="" -->
25
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g2b8a799ce85bb21788e58e1c23c16fc0">WL_SUCCESS</a>&nbsp;&nbsp;&nbsp;INT8_C(0)</td></tr>
26

  
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Success. <br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g798466231ef137f248b55dbfbce36fd7"></a><!-- doxytag: member="wl_error::WL_ERROR_INIT_FAILED" ref="g798466231ef137f248b55dbfbce36fd7" args="" -->
29
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g798466231ef137f248b55dbfbce36fd7">WL_ERROR_INIT_FAILED</a>&nbsp;&nbsp;&nbsp;INT8_C(-1)</td></tr>
30

  
31
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for init failure. <br></td></tr>
32
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g63e64a790913362ecf505e1a7e8347b8"></a><!-- doxytag: member="wl_error::WL_ERROR_INIT_ALREADY_INITD" ref="g63e64a790913362ecf505e1a7e8347b8" args="" -->
33
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g63e64a790913362ecf505e1a7e8347b8">WL_ERROR_INIT_ALREADY_INITD</a>&nbsp;&nbsp;&nbsp;INT8_C(-2)</td></tr>
34

  
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for duplicate init calls. <br></td></tr>
36
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g099f03f9edae294ce4989433f73c141e"></a><!-- doxytag: member="wl_error::WL_ERROR_LIBRARY_NOT_INITD" ref="g099f03f9edae294ce4989433f73c141e" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g099f03f9edae294ce4989433f73c141e">WL_ERROR_LIBRARY_NOT_INITD</a>&nbsp;&nbsp;&nbsp;INT8_C(-3)</td></tr>
38

  
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for not calling init. <br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g54de37a8427bf7372cfefa925cd0acf6"></a><!-- doxytag: member="wl_error::WL_ERROR_TERMINATION_FAILED" ref="g54de37a8427bf7372cfefa925cd0acf6" args="" -->
41
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g54de37a8427bf7372cfefa925cd0acf6">WL_ERROR_TERMINATION_FAILED</a>&nbsp;&nbsp;&nbsp;INT8_C(-4)</td></tr>
42

  
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed termination. <br></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g11477a5a024fd6898e4449bf08761207"></a><!-- doxytag: member="wl_error::WL_ERROR_FAILED_REGISTRATION" ref="g11477a5a024fd6898e4449bf08761207" args="" -->
45
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g11477a5a024fd6898e4449bf08761207">WL_ERROR_FAILED_REGISTRATION</a>&nbsp;&nbsp;&nbsp;INT8_C(-5)</td></tr>
46

  
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed packet group registration. <br></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g43f851eae7eed2576351d336001c21d2"></a><!-- doxytag: member="wl_error::WL_ERROR_ARGUMENT" ref="g43f851eae7eed2576351d336001c21d2" args="" -->
49
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g43f851eae7eed2576351d336001c21d2">WL_ERROR_ARGUMENT</a>&nbsp;&nbsp;&nbsp;INT8_C(-6)</td></tr>
50

  
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error in arguments. <br></td></tr>
52
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g2a775d59e55e9435505b4a908c522a0a"></a><!-- doxytag: member="wl_error::WL_ERROR_SEND" ref="g2a775d59e55e9435505b4a908c522a0a" args="" -->
53
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g2a775d59e55e9435505b4a908c522a0a">WL_ERROR_SEND</a>&nbsp;&nbsp;&nbsp;INT8_C(-10)</td></tr>
54

  
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for send failure. <br></td></tr>
56
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4bffaed18853133c76af57b89771b234"></a><!-- doxytag: member="wl_error::WL_ERROR_BAD_GROUP" ref="g4bffaed18853133c76af57b89771b234" args="" -->
57
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g4bffaed18853133c76af57b89771b234">WL_ERROR_BAD_GROUP</a>&nbsp;&nbsp;&nbsp;INT8_C(-11)</td></tr>
58

  
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad group number. <br></td></tr>
60
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g76d08a0e32732a63dc93d2cdf95c8fd0"></a><!-- doxytag: member="wl_error::WL_ERROR_SCOPE" ref="g76d08a0e32732a63dc93d2cdf95c8fd0" args="" -->
61
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g76d08a0e32732a63dc93d2cdf95c8fd0">WL_ERROR_SCOPE</a>&nbsp;&nbsp;&nbsp;INIT8_C(-12)</td></tr>
62

  
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad scope. <br></td></tr>
64
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9c528907279e6ace3aae7a7b19ad7687"></a><!-- doxytag: member="wl_error::WL_ERROR_ADDRESS" ref="g9c528907279e6ace3aae7a7b19ad7687" args="" -->
65
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g9c528907279e6ace3aae7a7b19ad7687">WL_ERROR_ADDRESS</a>&nbsp;&nbsp;&nbsp;INIT8_C(-13)</td></tr>
66

  
67
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad robot address. <br></td></tr>
68
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g33881dd2ec8ad0c2f67e40491a2f7c1a"></a><!-- doxytag: member="wl_error::WL_ERROR_MODE" ref="g33881dd2ec8ad0c2f67e40491a2f7c1a" args="" -->
69
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#g33881dd2ec8ad0c2f67e40491a2f7c1a">WL_ERROR_MODE</a>&nbsp;&nbsp;&nbsp;INIT8_C(-14)</td></tr>
70

  
71
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad mode. <br></td></tr>
26
<tr><td colspan="2"><h2>Defines</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b8a799ce85bb21788e58e1c23c16fc0"></a><!-- doxytag: member="wl_error::WL_SUCCESS" ref="ga2b8a799ce85bb21788e58e1c23c16fc0" args="" -->
28
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga2b8a799ce85bb21788e58e1c23c16fc0">WL_SUCCESS</a>&nbsp;&nbsp;&nbsp;INT8_C(0)</td></tr>
29
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Success. <br/></td></tr>
30
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga798466231ef137f248b55dbfbce36fd7"></a><!-- doxytag: member="wl_error::WL_ERROR_INIT_FAILED" ref="ga798466231ef137f248b55dbfbce36fd7" args="" -->
31
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga798466231ef137f248b55dbfbce36fd7">WL_ERROR_INIT_FAILED</a>&nbsp;&nbsp;&nbsp;INT8_C(-1)</td></tr>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for init failure. <br/></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga63e64a790913362ecf505e1a7e8347b8"></a><!-- doxytag: member="wl_error::WL_ERROR_INIT_ALREADY_INITD" ref="ga63e64a790913362ecf505e1a7e8347b8" args="" -->
34
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga63e64a790913362ecf505e1a7e8347b8">WL_ERROR_INIT_ALREADY_INITD</a>&nbsp;&nbsp;&nbsp;INT8_C(-2)</td></tr>
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for duplicate init calls. <br/></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga099f03f9edae294ce4989433f73c141e"></a><!-- doxytag: member="wl_error::WL_ERROR_LIBRARY_NOT_INITD" ref="ga099f03f9edae294ce4989433f73c141e" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga099f03f9edae294ce4989433f73c141e">WL_ERROR_LIBRARY_NOT_INITD</a>&nbsp;&nbsp;&nbsp;INT8_C(-3)</td></tr>
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for not calling init. <br/></td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga54de37a8427bf7372cfefa925cd0acf6"></a><!-- doxytag: member="wl_error::WL_ERROR_TERMINATION_FAILED" ref="ga54de37a8427bf7372cfefa925cd0acf6" args="" -->
40
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga54de37a8427bf7372cfefa925cd0acf6">WL_ERROR_TERMINATION_FAILED</a>&nbsp;&nbsp;&nbsp;INT8_C(-4)</td></tr>
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed termination. <br/></td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga11477a5a024fd6898e4449bf08761207"></a><!-- doxytag: member="wl_error::WL_ERROR_FAILED_REGISTRATION" ref="ga11477a5a024fd6898e4449bf08761207" args="" -->
43
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga11477a5a024fd6898e4449bf08761207">WL_ERROR_FAILED_REGISTRATION</a>&nbsp;&nbsp;&nbsp;INT8_C(-5)</td></tr>
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed packet group registration. <br/></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b221412880d805da1f9eb735ce7869f"></a><!-- doxytag: member="wl_error::WL_ERROR_FAILED_UNREGISTRATION" ref="ga2b221412880d805da1f9eb735ce7869f" args="" -->
46
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga2b221412880d805da1f9eb735ce7869f">WL_ERROR_FAILED_UNREGISTRATION</a>&nbsp;&nbsp;&nbsp;INT8_C(-6)</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed packet group registration. <br/></td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga43f851eae7eed2576351d336001c21d2"></a><!-- doxytag: member="wl_error::WL_ERROR_ARGUMENT" ref="ga43f851eae7eed2576351d336001c21d2" args="" -->
49
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga43f851eae7eed2576351d336001c21d2">WL_ERROR_ARGUMENT</a>&nbsp;&nbsp;&nbsp;INT8_C(-7)</td></tr>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error in arguments. <br/></td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2a775d59e55e9435505b4a908c522a0a"></a><!-- doxytag: member="wl_error::WL_ERROR_SEND" ref="ga2a775d59e55e9435505b4a908c522a0a" args="" -->
52
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga2a775d59e55e9435505b4a908c522a0a">WL_ERROR_SEND</a>&nbsp;&nbsp;&nbsp;INT8_C(-10)</td></tr>
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for send failure. <br/></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4bffaed18853133c76af57b89771b234"></a><!-- doxytag: member="wl_error::WL_ERROR_BAD_GROUP" ref="ga4bffaed18853133c76af57b89771b234" args="" -->
55
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga4bffaed18853133c76af57b89771b234">WL_ERROR_BAD_GROUP</a>&nbsp;&nbsp;&nbsp;INT8_C(-11)</td></tr>
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad group number. <br/></td></tr>
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga76d08a0e32732a63dc93d2cdf95c8fd0"></a><!-- doxytag: member="wl_error::WL_ERROR_SCOPE" ref="ga76d08a0e32732a63dc93d2cdf95c8fd0" args="" -->
58
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga76d08a0e32732a63dc93d2cdf95c8fd0">WL_ERROR_SCOPE</a>&nbsp;&nbsp;&nbsp;INT8_C(-12)</td></tr>
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad scope. <br/></td></tr>
60
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9c528907279e6ace3aae7a7b19ad7687"></a><!-- doxytag: member="wl_error::WL_ERROR_ADDRESS" ref="ga9c528907279e6ace3aae7a7b19ad7687" args="" -->
61
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga9c528907279e6ace3aae7a7b19ad7687">WL_ERROR_ADDRESS</a>&nbsp;&nbsp;&nbsp;INT8_C(-13)</td></tr>
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad robot address. <br/></td></tr>
63
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga33881dd2ec8ad0c2f67e40491a2f7c1a"></a><!-- doxytag: member="wl_error::WL_ERROR_MODE" ref="ga33881dd2ec8ad0c2f67e40491a2f7c1a" args="" -->
64
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga33881dd2ec8ad0c2f67e40491a2f7c1a">WL_ERROR_MODE</a>&nbsp;&nbsp;&nbsp;INT8_C(-14)</td></tr>
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for a bad mode. <br/></td></tr>
66
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacad84a598557eaf3ae400f7fdb4cf6c0"></a><!-- doxytag: member="wl_error::WL_ERROR_TOO_SMALL" ref="gacad84a598557eaf3ae400f7fdb4cf6c0" args="" -->
67
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#gacad84a598557eaf3ae400f7fdb4cf6c0">WL_ERROR_TOO_SMALL</a>&nbsp;&nbsp;&nbsp;INT8_C(-15)</td></tr>
68
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for received paacket destination too small for received packet. <br/></td></tr>
69
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga39b25b343987ddbabbf378525ed17e8f"></a><!-- doxytag: member="wl_error::WL_ERROR_SENDING_BUFFER_FULL" ref="ga39b25b343987ddbabbf378525ed17e8f" args="" -->
70
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga39b25b343987ddbabbf378525ed17e8f">WL_ERROR_SENDING_BUFFER_FULL</a>&nbsp;&nbsp;&nbsp;INT8_C(-16)</td></tr>
71
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for sending buffer full (the packet was sent, but no retries will be made). <br/></td></tr>
72
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga95320a2338e465077c708a7b50b20c9a"></a><!-- doxytag: member="wl_error::WL_ERROR_XBEE_COMMAND" ref="ga95320a2338e465077c708a7b50b20c9a" args="" -->
73
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga95320a2338e465077c708a7b50b20c9a">WL_ERROR_XBEE_COMMAND</a>&nbsp;&nbsp;&nbsp;INT8_C(-17)</td></tr>
74
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed xbee command. <br/></td></tr>
75
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga029f22a1c6b7308a7a9db2ee7490a4f0"></a><!-- doxytag: member="wl_error::WL_ERROR_XBEE_COMMAND_16BIT" ref="ga029f22a1c6b7308a7a9db2ee7490a4f0" args="" -->
76
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga029f22a1c6b7308a7a9db2ee7490a4f0">WL_ERROR_XBEE_COMMAND_16BIT</a>&nbsp;&nbsp;&nbsp;0xFEFE</td></tr>
77
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for failed 16bit xbee command. <br/></td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga35522d85bcb3ce7e1f0649ed8880a47a"></a><!-- doxytag: member="wl_error::WL_ERROR_BAUD" ref="ga35522d85bcb3ce7e1f0649ed8880a47a" args="" -->
79
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html#ga35522d85bcb3ce7e1f0649ed8880a47a">WL_ERROR_BAUD</a>&nbsp;&nbsp;&nbsp;INT8_C(-18)</td></tr>
80
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error code for bad baud rate. <br/></td></tr>
72 81
</table>
73 82
</div>
74
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
83
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
75 84
<a href="http://www.doxygen.org/index.html">
76
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
85
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
77 86
</body>
78 87
</html>
branches/wireless/docs/libwireless/html/index.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: The Wireless Library</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: The Wireless Library</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 class="current"><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><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>The Wireless Library</h1>
19
<p>
20
<h3 align="center">1577 </h3>This is the documentation for the Colony wireless library.<br>
21
<br>
22
 Xbee documentation can be found under <a class="el" href="group__xbee.html">XBee</a> <br>
23
 Higher level wireless documentation can be found under <a class="el" href="group__wireless.html">Wireless</a> <br>
24
 </div>
25
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
22
<h1>The Wireless Library </h1><h3 class="version">2.0a1 </h3><p>This is the documentation for the Colony wireless library.<br/>
23
<br/>
24
 Xbee documentation can be found under <a class="el" href="group__xbee.html">XBee</a> <br/>
25
 Higher level wireless documentation can be found under <a class="el" href="group__wireless.html">Wireless</a> <br/>
26
 </p>
27
</div>
28
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
26 29
<a href="http://www.doxygen.org/index.html">
27
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
30
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
28 31
</body>
29 32
</html>
branches/wireless/docs/libwireless/html/group__wireless.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: Wireless</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: Wireless</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><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>Wireless</h1>Interface with the wireless library.  
19
<a href="#_details">More...</a>
20
<p>
22
<h1>Wireless</h1>
23
<p>Interface with the wireless library.  
24
<a href="#_details">More...</a></p>
21 25
<table border="0" cellpadding="0" cellspacing="0">
22
<tr><td></td></tr>
23
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html">Public Constants</a></td></tr>
25

  
26
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html">Public API Functions</a></td></tr>
27

  
28
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html">Error Codes</a></td></tr>
29

  
30
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
31
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
32

  
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize wireless.  <a href="#g6a8d6179b1fe27f762937f0b47af2009"></a><br></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>
35

  
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminate wireless.  <a href="#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr>
38

  
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to register new packet handlers (for non-default groups only).  <a href="#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr>
41

  
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available.  <a href="#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr>
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff