Revision 1823
new doxygen for libwireless
branches/wireless/docs/libwireless/html/wireless_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: wireless.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 Page</span></a></li> |
|
15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
16 |
<li><a href="annotated.html"><span>Data 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 List</span></a></li> |
|
23 |
<li><a href="globals.html"><span>Globals</span></a></li> |
|
24 |
</ul> |
|
25 |
</div> |
|
26 |
<h1>wireless.h</h1><a href="wireless_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
|
27 |
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef WIRELESS_H</span> |
|
28 |
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define WIRELESS_H</span> |
|
29 |
<a name="l00038"></a>00038 <span class="preprocessor"></span> |
|
30 |
<a name="l00039"></a>00039 <span class="comment">// need this for C99 int types</span> |
|
31 |
<a name="l00040"></a>00040 <span class="preprocessor">#ifndef STDINT_H</span> |
|
32 |
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define STDINT_H</span> |
|
33 |
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#include <stdint.h></span> |
|
34 |
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span> |
|
35 |
<a name="l00044"></a>00044 <span class="preprocessor"></span> |
|
36 |
<a name="l00045"></a>00045 |
|
37 |
<a name="l00059"></a><a class="code" href="group__wl__defines.html#ga07b76b679f20134d56e04819f746fad6">00059</a> <span class="preprocessor">#define BASIC UINT8_C(0)</span> |
|
38 |
<a name="l00060"></a>00060 <span class="preprocessor"></span> |
|
39 |
<a name="l00062"></a><a class="code" href="group__wl__defines.html#ga3de33738fd3c7e77bffbcfaefc3e7645">00062</a> <span class="preprocessor">#define GLOBAL UINT8_C(0)</span> |
|
40 |
<a name="l00063"></a>00063 <span class="preprocessor"></span> |
|
41 |
<a name="l00065"></a><a class="code" href="group__wl__defines.html#ga11ed0d4e68673af6d575ed529ddf2130">00065</a> <span class="preprocessor">#define PAN UINT8_C(1)</span> |
|
42 |
<a name="l00066"></a>00066 <span class="preprocessor"></span> |
|
43 |
<a name="l00068"></a><a class="code" href="group__wl__defines.html#gac286e1243ab6be2c950c277e5e1377f9">00068</a> <span class="preprocessor">#define BROADCAST UINT16_C(0xFFFF)</span> |
|
44 |
<a name="l00069"></a>00069 <span class="preprocessor"></span> |
|
45 |
<a name="l00071"></a><a class="code" href="group__wl__defines.html#ga5bda06b0f5767eeca91b1383c0898c19">00071</a> <span class="preprocessor">#define RELIABLE UINT8_C(0)</span> |
|
46 |
<a name="l00072"></a>00072 <span class="preprocessor"></span> |
|
47 |
<a name="l00074"></a><a class="code" href="group__wl__defines.html#ga8091c2bcff55cbe0a4a145fd5fb7c22d">00074</a> <span class="preprocessor">#define FAST UINT8_C(1)</span> |
|
48 |
<a name="l00075"></a>00075 <span class="preprocessor"></span> |
|
49 |
<a name="l00077"></a><a class="code" href="group__wl__defines.html#gafd4a10e7cb5b56dd8e5ba8e2cff7ffc3">00077</a> <span class="preprocessor">#define NORMAL_PRIORITY UINT8_C(0)</span> |
|
50 |
<a name="l00078"></a>00078 <span class="preprocessor"></span> |
|
51 |
<a name="l00080"></a><a class="code" href="group__wl__defines.html#gaed801c122c559efe4677d351d07747b4">00080</a> <span class="preprocessor">#define HIGH_PRIORITY UINT8_C(1)</span> |
|
52 |
<a name="l00081"></a>00081 <span class="preprocessor"></span> |
|
53 |
<a name="l00083"></a><a class="code" href="group__wl__defines.html#gab6aaa08c0bfb6feb3e54a78d9211af56">00083</a> <span class="preprocessor">#define SENDING UINT8_C(0)</span> |
|
54 |
<a name="l00084"></a>00084 <span class="preprocessor"></span> |
|
55 |
<a name="l00086"></a><a class="code" href="group__wl__defines.html#ga4dc7574681861c30957f3ffc1fe84f41">00086</a> <span class="preprocessor">#define ACK_OK UINT8_C(1)</span> |
|
56 |
<a name="l00087"></a>00087 <span class="preprocessor"></span> |
|
57 |
<a name="l00089"></a><a class="code" href="group__wl__defines.html#gab10c348780c46ce9fdd85ff4c8a2ff82">00089</a> <span class="preprocessor">#define ACK_FAILURE UINT8_C(2)</span> |
|
58 |
<a name="l00090"></a>00090 <span class="preprocessor"></span> |
|
59 |
<a name="l00092"></a><a class="code" href="group__wl__defines.html#gab3a749bdf48c98c7d307775cfe0210e1">00092</a> <span class="preprocessor">#define CCA_FAILURE UINT8_C(3)</span> |
|
60 |
<a name="l00093"></a>00093 <span class="preprocessor"></span> |
|
61 |
<a name="l00095"></a><a class="code" href="group__wl__defines.html#ga587e21dda1f72be700a6206023ad681b">00095</a> <span class="preprocessor">#define FUNC func</span> |
|
62 |
<a name="l00096"></a>00096 <span class="preprocessor"></span> |
|
63 |
<a name="l00098"></a><a class="code" href="group__wl__defines.html#ga8b522c0ddd1f87732ac08225fcc89b58">00098</a> <span class="preprocessor">#define FNPTR void (*FUNC)(uint8_t* data,uint8_t length,uint8_t source)</span> |
|
64 |
<a name="l00099"></a>00099 <span class="preprocessor"></span> |
|
65 |
<a name="l00100"></a>00100 <span class="comment">// TODO: this max may be too big b/c the packet handler array stores 3*MAX_PACKET_GROUPS bytes </span> |
|
66 |
<a name="l00102"></a><a class="code" href="group__wl__defines.html#ga78906957fa456cdea5f330c8a7b119da">00102</a> <span class="comment"></span><span class="preprocessor">#define MAX_PACKET_GROUPS UINT8_C(16)</span> |
|
67 |
<a name="l00103"></a>00103 <span class="preprocessor"></span> |
|
68 |
<a name="l00105"></a><a class="code" href="group__wl__defines.html#ga8b043ee766380d099be83d92dc145878">00105</a> <span class="preprocessor">#define INIT_NO UINT8_C(0)</span> |
|
69 |
<a name="l00106"></a>00106 <span class="preprocessor"></span> |
|
70 |
<a name="l00108"></a><a class="code" href="group__wl__defines.html#ga0c8854a00a3ee4fb44960b651ffc62b3">00108</a> <span class="preprocessor">#define INIT_YES UINT8_C(1)</span> |
|
71 |
<a name="l00109"></a>00109 <span class="preprocessor"></span> |
|
72 |
<a name="l00111"></a><a class="code" href="group__wl__defines.html#ga17d416bf86e0b1b9adcdb92450abca63">00111</a> <span class="preprocessor">#define NUM_RETRIES UINT8_C(3)</span> |
|
73 |
<a name="l00112"></a>00112 <span class="preprocessor"></span> <span class="comment">// end defines group</span> |
|
74 |
<a name="l00114"></a>00114 |
|
75 |
<a name="l00122"></a><a class="code" href="structPacketGroupHandler.html">00122</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ |
|
76 |
<a name="l00123"></a>00123 |
|
77 |
<a name="l00124"></a>00124 <span class="comment">// function pointer of handler for this packet group</span> |
|
78 |
<a name="l00125"></a>00125 <a class="code" href="group__wl__defines.html#ga8b522c0ddd1f87732ac08225fcc89b58" title="packet handler function pointer type">FNPTR</a>; |
|
79 |
<a name="l00126"></a>00126 |
|
80 |
<a name="l00127"></a>00127 <span class="comment">// priority for this packet group</span> |
|
81 |
<a name="l00128"></a>00128 uint8_t priority; |
|
82 |
<a name="l00129"></a>00129 |
|
83 |
<a name="l00130"></a>00130 } <a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a>; |
|
84 |
<a name="l00131"></a>00131 |
|
85 |
<a name="l00132"></a>00132 |
|
86 |
<a name="l00136"></a>00136 <span class="comment">// the init function</span> |
|
87 |
<a name="l00137"></a>00137 |
|
88 |
<a name="l00139"></a>00139 int8_t <a class="code" href="group__wireless.html#ga6a8d6179b1fe27f762937f0b47af2009" title="Initialize wireless.">wl_init</a>(<span class="keywordtype">void</span>); |
|
89 |
<a name="l00140"></a>00140 |
|
90 |
<a name="l00142"></a>00142 int8_t <a class="code" href="group__wireless.html#ga223f437c2bc8ab8a3ac2e0e06841120f" title="Terminate wireless.">wl_terminate</a>(<span class="keywordtype">void</span>); |
|
91 |
<a name="l00143"></a>00143 |
|
92 |
<a name="l00144"></a>00144 |
|
93 |
<a name="l00145"></a>00145 <span class="comment">// the send functions</span> |
|
94 |
<a name="l00146"></a>00146 |
|
95 |
<a name="l00148"></a>00148 int16_t <a class="code" href="group__wl__functions.html#gaf713b6ecbf2de78139990a40fe864d5e" title="The core send function. This will take all possible arguments and send all types...">wl_send</a>(uint8_t *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode); |
|
96 |
<a name="l00149"></a>00149 |
|
97 |
<a name="l00151"></a>00151 int16_t <a class="code" href="group__wl__functions.html#gab0af7308304aed74eb281188b712e132" title="Wrapper for core send function that will send a global packet across the current...">wl_send_global</a>(uint8_t *data, uint8_t length, uint8_t group); |
|
98 |
<a name="l00152"></a>00152 |
|
99 |
<a name="l00154"></a>00154 int16_t <a class="code" href="group__wl__functions.html#ga85cd4090dd284a4747dc8a56c1b215ad" title="Wrapper for core send function that will send a packet across the current channel...">wl_send_pan</a>(uint8_t *data, uint8_t length, uint8_t group); |
|
100 |
<a name="l00155"></a>00155 |
|
101 |
<a name="l00157"></a>00157 int16_t <a class="code" href="group__wl__functions.html#ga49160840045fda872a5e38432cc26988" title="Wrapper for core send function that will send a packet across the current channel...">wl_send_robot</a>(uint8_t *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode); |
|
102 |
<a name="l00158"></a>00158 |
|
103 |
<a name="l00160"></a>00160 int16_t <a class="code" href="group__wl__functions.html#ga226d89acb4f77a982a2167eb1773eff2" title="Default (i.e. basic) send wrapper.">wl_send_basic</a>(uint8_t *data, uint8_t length); |
|
104 |
<a name="l00161"></a>00161 |
|
105 |
<a name="l00162"></a>00162 |
|
106 |
<a name="l00163"></a>00163 <span class="comment">// the ack function</span> |
|
107 |
<a name="l00164"></a>00164 |
|
108 |
<a name="l00166"></a>00166 uint8_t <a class="code" href="group__wl__functions.html#ga15c9a01839696beb05d1e4f161d968b7" title="Returns the number of acknowledgment errors.">wl_ack_error</a>(<span class="keywordtype">void</span>); |
|
109 |
<a name="l00167"></a>00167 |
|
110 |
<a name="l00169"></a>00169 int8_t <a class="code" href="group__wl__functions.html#gaa364aa4d9cc8c789f05401e8adf44785" title="Checks a specific packet for the acknowledgement status.">wl_ack_check</a>(uint8_t packet); |
|
111 |
<a name="l00170"></a>00170 |
|
112 |
<a name="l00172"></a>00172 <span class="keywordtype">void</span> <a class="code" href="group__wl__functions.html#ga62e126abfcd382ec02524dd2f45a8a7b" title="Resets acknowledgement statistics back to zero.">wl_ack_reset</a>(<span class="keywordtype">void</span>); |
|
113 |
<a name="l00173"></a>00173 |
|
114 |
<a name="l00174"></a>00174 |
|
115 |
<a name="l00175"></a>00175 <span class="comment">// the receive functions</span> |
|
116 |
<a name="l00176"></a>00176 |
|
117 |
<a name="l00178"></a>00178 int8_t <a class="code" href="group__wl__functions.html#gaa5a965e3443e4b2b60243225c50ecca7" title="The main receive function. Dispatches packets for registered handlers and returns...">wl_get</a>(<span class="keywordtype">char</span> *data, uint8_t length); |
|
118 |
<a name="l00179"></a>00179 |
|
119 |
<a name="l00181"></a>00181 int8_t <a class="code" href="group__wl__functions.html#gae2509e2b6bc61faa26d87b1d87881817" title="Returns the next basic packet if available.">wl_get_basic</a>(<span class="keywordtype">char</span> *data, uint8_t length); |
|
120 |
<a name="l00182"></a>00182 |
|
121 |
<a name="l00184"></a>00184 int8_t <a class="code" href="group__wl__functions.html#gae91c1e1940dfbbd063fdcfb86049c64a" title="Dispatches packets for registered handlers.">wl_dispatch</a>(<span class="keywordtype">void</span>); |
|
122 |
<a name="l00185"></a>00185 |
|
123 |
<a name="l00186"></a>00186 |
|
124 |
<a name="l00187"></a>00187 <span class="comment">// the group register function</span> |
|
125 |
<a name="l00188"></a>00188 |
|
126 |
<a name="l00190"></a>00190 int8_t <a class="code" href="group__wireless.html#ga7aa57c04f65ff3c8fec591248ab82f86" title="Function to register new packet handlers (for non-default groups only).">wl_register_handler</a>(uint8_t group, <a class="code" href="group__wl__defines.html#ga8b522c0ddd1f87732ac08225fcc89b58" title="packet handler function pointer type">FNPTR</a>, uint8_t priority); |
|
127 |
<a name="l00191"></a>00191 |
|
128 |
<a name="l00193"></a>00193 int8_t <a class="code" href="group__wireless.html#ga376508d5682b1b8c88ef8b5f911a3367" title="Function to unregister existing packet handlers (for non-default groups only).">wl_unregister_handler</a>(uint8_t group); |
|
129 |
<a name="l00194"></a>00194 <span class="comment">//end functions group</span> |
|
130 |
<a name="l00196"></a>00196 <span class="comment">//end wireless group</span> |
|
131 |
<a name="l00198"></a>00198 |
|
132 |
<a name="l00199"></a>00199 <span class="preprocessor">#endif</span> |
|
133 |
</pre></div></div> |
|
134 |
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by |
|
135 |
<a href="http://www.doxygen.org/index.html"> |
|
136 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> |
|
137 |
</body> |
|
138 |
</html> |
|
0 | 139 |
branches/wireless/docs/libwireless/html/xbee_8c.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.c File Reference</title> |
|
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
|
6 |
</head><body> |
|
7 |
<!-- Generated by Doxygen 1.5.8 --> |
|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 |
<head> |
|
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 |
<title>libwireless: xbee.c File Reference</title> |
|
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 |
</head> |
|
9 |
<body> |
|
10 |
<!-- Generated by Doxygen 1.6.3 --> |
|
8 | 11 |
<div class="navigation" id="top"> |
9 | 12 |
<div class="tabs"> |
10 | 13 |
<ul> |
11 | 14 |
<li><a href="index.html"><span>Main Page</span></a></li> |
12 | 15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
16 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
13 | 17 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
14 | 18 |
</ul> |
15 | 19 |
</div> |
... | ... | |
21 | 25 |
</div> |
22 | 26 |
</div> |
23 | 27 |
<div class="contents"> |
24 |
<h1>xbee.c File Reference</h1>XBee Interface. |
|
25 |
<a href="#_details">More...</a> |
|
26 |
<p> |
|
27 |
<code>#include "<a class="el" href="xbee_8h.html">xbee.h</a>"</code><br> |
|
28 |
<code>#include "<a class="el" href="wl__defs_8h.html">wl_defs.h</a>"</code><br> |
|
29 |
<code>#include <time.h></code><br> |
|
30 |
<code>#include <fcntl.h></code><br> |
|
31 |
<code>#include <unistd.h></code><br> |
|
32 |
<code>#include <pthread.h></code><br> |
|
33 |
<code>#include <errno.h></code><br> |
|
34 |
<code>#include <termios.h></code><br> |
|
35 |
<code>#include <stdio.h></code><br> |
|
36 |
<code>#include <stdlib.h></code><br> |
|
37 |
<code>#include <string.h></code><br> |
|
28 |
<h1>xbee.c File Reference</h1> |
|
29 |
<p>XBee Interface. |
|
30 |
<a href="#_details">More...</a></p> |
|
31 |
<code>#include <lights.h></code><br/> |
|
32 |
<code>#include <string.h></code><br/> |
|
33 |
<code>#include <avr/io.h></code><br/> |
|
34 |
<code>#include <avr/interrupt.h></code><br/> |
|
35 |
<code>#include <time.h></code><br/> |
|
36 |
<code>#include <<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>></code><br/> |
|
37 |
<code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code><br/> |
|
38 |
<code>#include <eeprom.h></code><br/> |
|
39 |
<code>#include "<a class="el" href="xbee_8h_source.html">xbee.h</a>"</code><br/> |
|
38 | 40 |
<table border="0" cellpadding="0" cellspacing="0"> |
39 |
<tr><td></td></tr> |
|
40 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfd0466c206d7e1f82ee407d114468e96"></a><!-- doxytag: member="xbee.c::XBEE_PORT_DEFAULT" ref="gfd0466c206d7e1f82ee407d114468e96" args="" --> |
|
42 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gfd0466c206d7e1f82ee407d114468e96">XBEE_PORT_DEFAULT</a> "/dev/ttyUSB1"</td></tr> |
|
41 |
<tr><td colspan="2"><h2>Defines</h2></td></tr> |
|
42 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18c660886e331ecfbfba5c5ce86e356a"></a><!-- doxytag: member="xbee.c::NUM_LAST_PACKETS" ref="a18c660886e331ecfbfba5c5ce86e356a" args="" --> |
|
43 |
#define </td><td class="memItemRight" valign="bottom"><b>NUM_LAST_PACKETS</b> 10</td></tr> |
|
44 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cd9b23acdf4ae51a7f0aa91bf0673b6"></a><!-- doxytag: member="xbee.c::XBEE_API_OFF" ref="a0cd9b23acdf4ae51a7f0aa91bf0673b6" args="" --> |
|
45 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_API_OFF</b> 0x00</td></tr> |
|
46 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b840e5f5eeb4c61bc364d567dc583fe"></a><!-- doxytag: member="xbee.c::XBEE_API_ON" ref="a1b840e5f5eeb4c61bc364d567dc583fe" args="" --> |
|
47 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_API_ON</b> 0x10</td></tr> |
|
48 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabe1d60ad71cd3a9135ab8ee66aafe2f"></a><!-- doxytag: member="xbee.c::XBEE_API_ESCAPE" ref="aabe1d60ad71cd3a9135ab8ee66aafe2f" args="" --> |
|
49 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_API_ESCAPE</b> 0x20</td></tr> |
|
50 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80baa30bed665f697031f0d664b47b8f"></a><!-- doxytag: member="xbee.c::XBEE_API_MASK" ref="a80baa30bed665f697031f0d664b47b8f" args="" --> |
|
51 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_API_MASK</b> 0x30</td></tr> |
|
52 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a571366b409acc3cf88b11f4517b5035d"></a><!-- doxytag: member="xbee.c::XBEE_COMMAND_WAIT" ref="a571366b409acc3cf88b11f4517b5035d" args="" --> |
|
53 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_COMMAND_WAIT</b> 0x80</td></tr> |
|
54 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac18872e6011029aaee5086907d68d5f6"></a><!-- doxytag: member="xbee.c::XBEE_COMMAND_RESPONSE" ref="ac18872e6011029aaee5086907d68d5f6" args="" --> |
|
55 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_COMMAND_RESPONSE</b> 0xC0</td></tr> |
|
56 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63b294491a5ccb1dc043846c94598bf8"></a><!-- doxytag: member="xbee.c::XBEE_COMMAND_NONE" ref="a63b294491a5ccb1dc043846c94598bf8" args="" --> |
|
57 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_COMMAND_NONE</b> 0x00</td></tr> |
|
58 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05c1d6c59ecaa5429bf5274f02537598"></a><!-- doxytag: member="xbee.c::XBEE_COMMAND_MASK" ref="a05c1d6c59ecaa5429bf5274f02537598" args="" --> |
|
59 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_COMMAND_MASK</b> 0xC0</td></tr> |
|
60 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a771f7792d83c2b783abadf05c92850a7"></a><!-- doxytag: member="xbee.c::XBEE_NOT_INITD" ref="a771f7792d83c2b783abadf05c92850a7" args="" --> |
|
61 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_NOT_INITD</b> 0xF0</td></tr> |
|
62 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e3174b3441c7b675c371c708443a42a"></a><!-- doxytag: member="xbee.c::LAST_PACKET_MASK" ref="a4e3174b3441c7b675c371c708443a42a" args="" --> |
|
63 |
#define </td><td class="memItemRight" valign="bottom"><b>LAST_PACKET_MASK</b> 0x0F</td></tr> |
|
64 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a584031babb534b94a63848b43bf88ee5"></a><!-- doxytag: member="xbee.c::ESCAPE_MARKER" ref="a584031babb534b94a63848b43bf88ee5" args="" --> |
|
65 |
#define </td><td class="memItemRight" valign="bottom"><b>ESCAPE_MARKER</b> 0x7D</td></tr> |
|
66 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f51719fbf2274af9266c15543b26eca"></a><!-- doxytag: member="xbee.c::ESCAPE_XOR" ref="a7f51719fbf2274af9266c15543b26eca" args="" --> |
|
67 |
#define </td><td class="memItemRight" valign="bottom"><b>ESCAPE_XOR</b> 0x20</td></tr> |
|
68 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab854bf5a3cd6698b70ba613576046e47"></a><!-- doxytag: member="xbee.c::ESCAPE1" ref="ab854bf5a3cd6698b70ba613576046e47" args="" --> |
|
69 |
#define </td><td class="memItemRight" valign="bottom"><b>ESCAPE1</b> 0x7E</td></tr> |
|
70 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02c370da64328420e0f878ad074959d5"></a><!-- doxytag: member="xbee.c::ESCAPE2" ref="a02c370da64328420e0f878ad074959d5" args="" --> |
|
71 |
#define </td><td class="memItemRight" valign="bottom"><b>ESCAPE2</b> 0x7D</td></tr> |
|
72 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6650a1844aa3fc6292f7c06d9b69634f"></a><!-- doxytag: member="xbee.c::ESCAPE3" ref="a6650a1844aa3fc6292f7c06d9b69634f" args="" --> |
|
73 |
#define </td><td class="memItemRight" valign="bottom"><b>ESCAPE3</b> 0x11</td></tr> |
|
74 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade56248d1f61075bfd7cccb45fe00dec"></a><!-- doxytag: member="xbee.c::ESCAPE4" ref="ade56248d1f61075bfd7cccb45fe00dec" args="" --> |
|
75 |
#define </td><td class="memItemRight" valign="bottom"><b>ESCAPE4</b> 0x13</td></tr> |
|
76 |
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga614217d263be1fb1a5f76e2ff7be19a2">PORT</a> UDR1</td></tr> |
|
77 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf8bfae90c5d6853fcfb487e05b9f50c8"></a><!-- doxytag: member="xbee.c::FLAG" ref="gaf8bfae90c5d6853fcfb487e05b9f50c8" args="" --> |
|
78 |
#define </td><td class="memItemRight" valign="bottom"><b>FLAG</b> (UCSR1A & (1<<RXC1))</td></tr> |
|
79 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
80 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gaf29617dd4988f4b056f9476004ae5cbf">xbee_putc</a> (uint8_t c)</td></tr> |
|
81 |
<tr><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga409ff62ddd9e22eaf745a50f688263fd">xbee_getc</a> (void)</td></tr> |
|
82 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gae564a6f5453934b0234a054fbc238fd3">xbee_getc_nb</a> (uint8_t *c)</td></tr> |
|
83 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga2694f3530e4cf256ff9e96600aea753c">xbee_send_read_at_command</a> (uint8_t *command)</td></tr> |
|
84 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafe6b2efc8b84d41b224b65fe9a9b0f70"></a><!-- doxytag: member="xbee.c::xbee_basic_buf_add" ref="gafe6b2efc8b84d41b224b65fe9a9b0f70" args="(uint8_t *ptr, uint8_t byte)" --> |
|
85 |
int8_t </td><td class="memItemRight" valign="bottom"><b>xbee_basic_buf_add</b> (uint8_t *ptr, uint8_t byte)</td></tr> |
|
86 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3aa01c87cec1f5836297de808c82a405"></a><!-- doxytag: member="xbee.c::xbee_basic_buf_get" ref="ga3aa01c87cec1f5836297de808c82a405" args="(uint8_t *ptr)" --> |
|
87 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>xbee_basic_buf_get</b> (uint8_t *ptr)</td></tr> |
|
88 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga344c1c7c8bbd9bdb4903d3e9443edbbd"></a><!-- doxytag: member="xbee.c::xbee_other_buf_add" ref="ga344c1c7c8bbd9bdb4903d3e9443edbbd" args="(uint8_t *ptr, uint8_t byte)" --> |
|
89 |
int8_t </td><td class="memItemRight" valign="bottom"><b>xbee_other_buf_add</b> (uint8_t *ptr, uint8_t byte)</td></tr> |
|
90 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga335b40b15f89a8a0d26db9226812914e">check_last_receive</a> (uint16_t source, uint8_t framenum)</td></tr> |
|
91 |
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga8a4c7ae8201a7ca230fdb47bfa13d044">getStatus</a> (uint8_t mask)</td></tr> |
|
92 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff39fc829e5307a35a062bcc6fac616f"></a><!-- doxytag: member="xbee.c::setStatus" ref="gaff39fc829e5307a35a062bcc6fac616f" args="(uint8_t mask, uint8_t value)" --> |
|
93 |
void </td><td class="memItemRight" valign="bottom"><b>setStatus</b> (uint8_t mask, uint8_t value)</td></tr> |
|
94 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22c53350028fb65a39b098fa56f3d5e4"></a><!-- doxytag: member="xbee.c::ackhandle" ref="a22c53350028fb65a39b098fa56f3d5e4" args="(uint8_t num, uint8_t val)" --> |
|
95 |
void </td><td class="memItemRight" valign="bottom"><b>ackhandle</b> (uint8_t num, uint8_t val)</td></tr> |
|
96 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae6e8a8009a9ae0c59f25a496d1cf5a84"></a><!-- doxytag: member="xbee.c::ISR" ref="gae6e8a8009a9ae0c59f25a496d1cf5a84" args="(USART1_RX_vect)" --> |
|
97 |
</td><td class="memItemRight" valign="bottom"><b>ISR</b> (USART1_RX_vect)</td></tr> |
|
98 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac4c5f6ba46371313200945e6456a9942"></a><!-- doxytag: member="xbee.c::xbee_other_buf_get" ref="gac4c5f6ba46371313200945e6456a9942" args="(uint8_t *ptr)" --> |
|
99 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>xbee_other_buf_get</b> (uint8_t *ptr)</td></tr> |
|
100 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga31a4df97d6865a40123337045109b9f1">xbee_init</a> ()</td></tr> |
|
101 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="group__xbee.html#ga31a4df97d6865a40123337045109b9f1"></a><br/></td></tr> |
|
102 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga3fe446135ba896e6438a4fcd67154119">xbee_terminate</a> ()</td></tr> |
|
103 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="group__xbee.html#ga3fe446135ba896e6438a4fcd67154119"></a><br/></td></tr> |
|
104 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gae75ee9a54a5811b8bc302dc2d70f0215">xbee_sendc</a> (uint8_t byte)</td></tr> |
|
105 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send byte to the xbee in API mode. <a href="group__xbee.html#gae75ee9a54a5811b8bc302dc2d70f0215"></a><br/></td></tr> |
|
106 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04">xbee_send</a> (uint8_t *buf, uint16_t size)</td></tr> |
|
107 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send an array of bytes to the xbee in API mode. <a href="group__xbee.html#ga5805e267e3b6f4b7bdad7aa6dc65ee04"></a><br/></td></tr> |
|
108 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga2eb96c49811a1d9f2ccd1e1186915077">xbee_checksum_add</a> (uint8_t *buf, uint8_t len, uint8_t *sum)</td></tr> |
|
109 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a buffer to the checksum value. <a href="group__xbee.html#ga2eb96c49811a1d9f2ccd1e1186915077"></a><br/></td></tr> |
|
110 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga2a39ffce83d65d22aeefb41dfce2112f">xbee_send_header</a> (uint16_t len)</td></tr> |
|
111 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a frame header to the xbee. <a href="group__xbee.html#ga2a39ffce83d65d22aeefb41dfce2112f"></a><br/></td></tr> |
|
112 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gaae54f7208cfa786cb56d4d78ab3ceffe">xbee_send_packet</a> (uint8_t *packet, uint8_t len, uint16_t dest, uint8_t options, uint8_t frame)</td></tr> |
|
113 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="group__xbee.html#gaae54f7208cfa786cb56d4d78ab3ceffe"></a><br/></td></tr> |
|
114 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gadbcb9cc8cf6afa28e6de8defb33f8196">xbee_set_pan</a> (uint16_t id)</td></tr> |
|
115 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="group__xbee.html#gadbcb9cc8cf6afa28e6de8defb33f8196"></a><br/></td></tr> |
|
116 |
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gaa740c59073c6db9e00a2a2de10a95091">xbee_get_pan</a> ()</td></tr> |
|
117 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="group__xbee.html#gaa740c59073c6db9e00a2a2de10a95091"></a><br/></td></tr> |
|
118 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga4f67630ca81e5eae064bb58c3818d3fd">xbee_set_channel</a> (uint8_t channel)</td></tr> |
|
119 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="group__xbee.html#ga4f67630ca81e5eae064bb58c3818d3fd"></a><br/></td></tr> |
|
120 |
<tr><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga319d4bccd5e6b09d2f377d2170104817">xbee_get_channel</a> (void)</td></tr> |
|
121 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="group__xbee.html#ga319d4bccd5e6b09d2f377d2170104817"></a><br/></td></tr> |
|
122 |
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#ga24d751120f5cded06a70d156c29261fc">xbee_get_address</a> (void)</td></tr> |
|
123 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's 16-bit address. <a href="group__xbee.html#ga24d751120f5cded06a70d156c29261fc"></a><br/></td></tr> |
|
124 |
<tr><td colspan="2"><h2>Variables</h2></td></tr> |
|
125 |
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="xbee_8c.html#a94652d65b245bd874ff76bac4e0a2b23">xbee_basic_buf</a> [PACKET_BUFFER_SIZE]</td></tr> |
|
126 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4162f367889b477c35cdefdd72d67c1b"></a><!-- doxytag: member="xbee.c::basic_buf_first" ref="a4162f367889b477c35cdefdd72d67c1b" args="" --> |
|
127 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>basic_buf_first</b> = (PACKET_BUFFER_SIZE-1)</td></tr> |
|
128 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a645b109e07dad69b8314f773e0978399"></a><!-- doxytag: member="xbee.c::basic_buf_last" ref="a645b109e07dad69b8314f773e0978399" args="" --> |
|
129 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>basic_buf_last</b> = 0</td></tr> |
|
130 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44888b88606af1d1c22c73f65d880313"></a><!-- doxytag: member="xbee.c::xbee_other_buf" ref="a44888b88606af1d1c22c73f65d880313" args="[PACKET_BUFFER_SIZE]" --> |
|
131 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>xbee_other_buf</b> [PACKET_BUFFER_SIZE]</td></tr> |
|
132 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab75ab53d4df1cb0af09e6d2e4e7cd75b"></a><!-- doxytag: member="xbee.c::other_buf_first" ref="ab75ab53d4df1cb0af09e6d2e4e7cd75b" args="" --> |
|
133 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>other_buf_first</b> = (PACKET_BUFFER_SIZE-1)</td></tr> |
|
134 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bf335c9fa259e2e3531ea37370d3801"></a><!-- doxytag: member="xbee.c::other_buf_last" ref="a6bf335c9fa259e2e3531ea37370d3801" args="" --> |
|
135 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>other_buf_last</b> = 0</td></tr> |
|
136 |
<tr><td class="memItemLeft" ><a class="anchor" id="a18ed68029e795b2c38b97f6f1be1ab78"></a><!-- doxytag: member="xbee.c::lastPacket" ref="a18ed68029e795b2c38b97f6f1be1ab78" args="[NUM_LAST_PACKETS]" --> |
|
137 |
struct {</td></tr> |
|
138 |
<tr><td class="memItemLeft" > uint16_t <b>source</b></td></tr> |
|
139 |
<tr><td class="memItemLeft" > uint8_t <b>framenum</b></td></tr> |
|
140 |
<tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>lastPacket</b> [NUM_LAST_PACKETS]</td></tr> |
|
141 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35a1327ee0fb8fabee9d7e4ddac1eccd"></a><!-- doxytag: member="xbee.c::xbee_status" ref="a35a1327ee0fb8fabee9d7e4ddac1eccd" args="" --> |
|
142 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>xbee_status</b> = XBEE_NOT_INITD</td></tr> |
|
143 |
</table> |
|
144 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
145 |
<p>XBee Interface. </p> |
|
146 |
<p>Copyright (c) 2009 Colony Project</p> |
|
147 |
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> |
|
148 |
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> |
|
149 |
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> |
|
150 |
<p>Implementation of low level communication with the XBee in API mode.</p> |
|
151 |
<dl class="author"><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
|
152 |
<hr/><h2>Variable Documentation</h2> |
|
153 |
<a class="anchor" id="a94652d65b245bd874ff76bac4e0a2b23"></a><!-- doxytag: member="xbee.c::xbee_basic_buf" ref="a94652d65b245bd874ff76bac4e0a2b23" args="[PACKET_BUFFER_SIZE]" --> |
|
154 |
<div class="memitem"> |
|
155 |
<div class="memproto"> |
|
156 |
<table class="memname"> |
|
157 |
<tr> |
|
158 |
<td class="memname">uint8_t <a class="el" href="xbee_8c.html#a94652d65b245bd874ff76bac4e0a2b23">xbee_basic_buf</a>[PACKET_BUFFER_SIZE]</td> |
|
159 |
</tr> |
|
160 |
</table> |
|
161 |
</div> |
|
162 |
<div class="memdoc"> |
|
163 |
<p>Definition for wireless library receive packet structure</p> |
|
164 |
<p>Basic Buffer Packet: byte 1: length of source+data bytes 2-3: source bytes 4-n: data</p> |
|
165 |
<p>Other Buffer Packet: byte 1: length of group+source+data byte 2: group number bytes 3-4: source bytes 5-n: data </p> |
|
43 | 166 |
|
44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The port to use the XBee from on the computer. <br></td></tr> |
|
45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g63d0ecb125d464ea34524e090648f70f"></a><!-- doxytag: member="xbee.c::XBEE_BUFFER_SIZE" ref="g63d0ecb125d464ea34524e090648f70f" args="" --> |
|
46 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_BUFFER_SIZE</b> 128</td></tr> |
|
167 |
<p>Referenced by <a class="el" href="wireless__receive_8c_source.html#l00100">wl_get_basic()</a>, and <a class="el" href="xbee_8c_source.html#l00729">xbee_init()</a>.</p> |
|
47 | 168 |
|
48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="xbee.c::PACKET_BUFFER_SIZE" ref="gb30af815d6e9494361629440f14e3716" args="" --> |
|
49 |
#define </td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b> 108</td></tr> |
|
50 |
|
|
51 |
<tr><td colspan="2"><div class="groupHeader">xbee options</div></td></tr> |
|
52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6bb9bb274d6750f954762454807a5a7"></a><!-- doxytag: member="xbee.c::XBEE_PAN_DEFAULT" ref="ge6bb9bb274d6750f954762454807a5a7" args="" --> |
|
53 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#ge6bb9bb274d6750f954762454807a5a7">XBEE_PAN_DEFAULT</a> 0xFFFF</td></tr> |
|
54 |
|
|
55 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset PAN, uses XBee default. <br></td></tr> |
|
56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g35f8b9d8e01e788f1e29928cba29f215"></a><!-- doxytag: member="xbee.c::XBEE_CHANNEL_DEFAULT" ref="g35f8b9d8e01e788f1e29928cba29f215" args="" --> |
|
57 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g35f8b9d8e01e788f1e29928cba29f215">XBEE_CHANNEL_DEFAULT</a> 0</td></tr> |
|
58 |
|
|
59 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unset channel, uses XBee default. <br></td></tr> |
|
60 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93bbd21f7965e1697350f950cedff5c4"></a><!-- doxytag: member="xbee.c::XBEE_BROADCAST" ref="g93bbd21f7965e1697350f950cedff5c4" args="" --> |
|
61 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g93bbd21f7965e1697350f950cedff5c4">XBEE_BROADCAST</a> 0xFFFF</td></tr> |
|
62 |
|
|
63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast to all robots in the PAN. <br></td></tr> |
|
64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbca7356c2b8183fd41b5ca9a82dd962b"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_NONE" ref="gbca7356c2b8183fd41b5ca9a82dd962b" args="" --> |
|
65 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gbca7356c2b8183fd41b5ca9a82dd962b">XBEE_OPTIONS_NONE</a> 0x00</td></tr> |
|
66 |
|
|
67 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">No special options. <br></td></tr> |
|
68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcf9509013302590dca5ce3db63c64609"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_DISABLE_RESPONSE" ref="gcf9509013302590dca5ce3db63c64609" args="" --> |
|
69 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gcf9509013302590dca5ce3db63c64609">XBEE_OPTIONS_DISABLE_RESPONSE</a> 0x01</td></tr> |
|
70 |
|
|
71 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do not receive a TX_STATUS message from this packet. <br></td></tr> |
|
72 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g57382f888360b5b19f0de3b6f1f7c5a3"></a><!-- doxytag: member="xbee.c::XBEE_OPTIONS_BROADCAST_ALL_PANS" ref="g57382f888360b5b19f0de3b6f1f7c5a3" args="" --> |
|
73 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g57382f888360b5b19f0de3b6f1f7c5a3">XBEE_OPTIONS_BROADCAST_ALL_PANS</a> 0x04</td></tr> |
|
74 |
|
|
75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the packet to all PANS. <br></td></tr> |
|
76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7840d8b64c8bec12d8b8d32e845a638a"></a><!-- doxytag: member="xbee.c::XBEE_TX_STATUS" ref="g7840d8b64c8bec12d8b8d32e845a638a" args="" --> |
|
77 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#g7840d8b64c8bec12d8b8d32e845a638a">XBEE_TX_STATUS</a> 0x89</td></tr> |
|
78 |
|
|
79 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A transmit status packet. <br></td></tr> |
|
80 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc2b1262a3a1eb4a9f7ead366af71c32c"></a><!-- doxytag: member="xbee.c::XBEE_RX" ref="gc2b1262a3a1eb4a9f7ead366af71c32c" args="" --> |
|
81 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee__const.html#gc2b1262a3a1eb4a9f7ead366af71c32c">XBEE_RX</a> 0x81</td></tr> |
|
82 |
|
|
83 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">A packet received from another XBee. <br></td></tr> |
|
84 |
<tr><td colspan="2"><div class="groupHeader">xbee frame types</div></td></tr> |
|
85 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g72aa42b35714e06ac26df31b06a8bf39"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_START" ref="g72aa42b35714e06ac26df31b06a8bf39" args="" --> |
|
86 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_START</b> 0x7E</td></tr> |
|
87 |
|
|
88 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbe7468473089e3cdd2ed85cac2244d49"></a><!-- doxytag: member="xbee.c::XBEE_GET_PACKET_TIMEOUT" ref="gbe7468473089e3cdd2ed85cac2244d49" args="" --> |
|
89 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_GET_PACKET_TIMEOUT</b> 1000</td></tr> |
|
90 |
|
|
91 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge0fc9d7b1078703227c91e1352b708c5"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_STATUS" ref="ge0fc9d7b1078703227c91e1352b708c5" args="" --> |
|
92 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_STATUS</b> 0x8A</td></tr> |
|
93 |
|
|
94 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g106780ab66c38464e90af25ae3cc73de"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND" ref="g106780ab66c38464e90af25ae3cc73de" args="" --> |
|
95 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND</b> 0x08</td></tr> |
|
96 |
|
|
97 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gac9e8cc2d9fdda49b77aed7d9380bfde"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_AT_COMMAND_RESPONSE" ref="gac9e8cc2d9fdda49b77aed7d9380bfde" args="" --> |
|
98 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_AT_COMMAND_RESPONSE</b> 0x88</td></tr> |
|
99 |
|
|
100 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g31af21123fe9b33803cdf96626776d32"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_64" ref="g31af21123fe9b33803cdf96626776d32" args="" --> |
|
101 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_64</b> 0x00</td></tr> |
|
102 |
|
|
103 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g30aa14f9ad880c0bdcd15d7b6dfe4e84"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_REQUEST_16" ref="g30aa14f9ad880c0bdcd15d7b6dfe4e84" args="" --> |
|
104 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_REQUEST_16</b> 0x01</td></tr> |
|
105 |
|
|
106 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g301ee4ce1fc94e5c6ccd160a0bfa83a7"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_TX_STATUS" ref="g301ee4ce1fc94e5c6ccd160a0bfa83a7" args="" --> |
|
107 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_TX_STATUS</b> XBEE_TX_STATUS</td></tr> |
|
108 |
|
|
109 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gba621d0a00f41acc7e059b5abf4802ad"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_64" ref="gba621d0a00f41acc7e059b5abf4802ad" args="" --> |
|
110 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_64</b> 0x80</td></tr> |
|
111 |
|
|
112 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5b80e57bcad9ccaa20022e8d4968ec66"></a><!-- doxytag: member="xbee.c::XBEE_FRAME_RX_16" ref="g5b80e57bcad9ccaa20022e8d4968ec66" args="" --> |
|
113 |
#define </td><td class="memItemRight" valign="bottom"><b>XBEE_FRAME_RX_16</b> XBEE_RX</td></tr> |
|
114 |
|
|
115 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
116 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g2fbd69862a11b6bcc5cfdb9f182bcdb9">xbee_send_read_at_command</a> (char *command)</td></tr> |
|
117 |
|
|
118 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af">xbee_lib_init</a> (void)</td></tr> |
|
119 |
|
|
120 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the XBee library. <a href="group__xbee.html#g3d5fbb6aae8dda99240ec38108a645af"></a><br></td></tr> |
|
121 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a">xbee_terminate</a> (void)</td></tr> |
|
122 |
|
|
123 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialize the XBee library. <a href="group__xbee.html#g9334ac71dca1ddd697b1a35a361ade6a"></a><br></td></tr> |
|
124 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c">xbee_send_packet</a> (char *packet, int len, int dest, char options, char frame)</td></tr> |
|
125 |
|
|
126 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a packet to the XBee. <a href="group__xbee.html#g7c44bc25fda954efde574ee8d735073c"></a><br></td></tr> |
|
127 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g00fbdd9d849171588df736f8b608589d">xbee_get_packet</a> (unsigned char *packet)</td></tr> |
|
128 |
|
|
129 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a packet from the XBee. <a href="group__xbee.html#g00fbdd9d849171588df736f8b608589d"></a><br></td></tr> |
|
130 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b">xbee_set_pan_id</a> (int id)</td></tr> |
|
131 |
|
|
132 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PAN ID for the XBee. <a href="group__xbee.html#gde50cbefd7ba8d7361ce2654a298748b"></a><br></td></tr> |
|
133 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7755cd8db87703c9e9943153660b8052">xbee_get_pan_id</a> (void)</td></tr> |
|
134 |
|
|
135 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's PAN ID. <a href="group__xbee.html#g7755cd8db87703c9e9943153660b8052"></a><br></td></tr> |
|
136 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14">xbee_set_channel</a> (int channel)</td></tr> |
|
137 |
|
|
138 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the channel the XBee is currently using. <a href="group__xbee.html#gb93170c493c5cdfd43a7b640c6ed1d14"></a><br></td></tr> |
|
139 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a">xbee_get_channel</a> (void)</td></tr> |
|
140 |
|
|
141 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the channel the XBee is currently using. <a href="group__xbee.html#g133706db81f69ba0a3c169b7a3f42d2a"></a><br></td></tr> |
|
142 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g7c53e8a8492494a61ca306875d633309">xbee_get_address</a> (void)</td></tr> |
|
143 |
|
|
144 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the XBee's 16-bit address. <a href="group__xbee.html#g7c53e8a8492494a61ca306875d633309"></a><br></td></tr> |
|
145 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e9e3c2abf0ff683ca8e591c3851cf0a"></a><!-- doxytag: member="xbee.c::xbee_set_com_port" ref="g1e9e3c2abf0ff683ca8e591c3851cf0a" args="(char *port)" --> |
|
146 |
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xbee.html#g1e9e3c2abf0ff683ca8e591c3851cf0a">xbee_set_com_port</a> (char *port)</td></tr> |
|
147 |
|
|
148 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the com port on a computer, undefined on the robot. <br></td></tr> |
|
149 |
<tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
|
150 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g65685824a9cbbc9da05be520d0d80d12"></a><!-- doxytag: member="xbee.c::arrival_buf" ref="g65685824a9cbbc9da05be520d0d80d12" args="[XBEE_BUFFER_SIZE]" --> |
|
151 |
char </td><td class="memItemRight" valign="bottom"><b>arrival_buf</b> [XBEE_BUFFER_SIZE]</td></tr> |
|
152 |
|
|
153 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb7ae7d59f0f2dabc258c678996b59b22"></a><!-- doxytag: member="xbee.c::buffer_last" ref="gb7ae7d59f0f2dabc258c678996b59b22" args="" --> |
|
154 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_last</b> = 0</td></tr> |
|
155 |
|
|
156 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga38080e2a4d6f0497f3c2faf487a0952"></a><!-- doxytag: member="xbee.c::buffer_first" ref="ga38080e2a4d6f0497f3c2faf487a0952" args="" --> |
|
157 |
volatile int </td><td class="memItemRight" valign="bottom"><b>buffer_first</b> = 0</td></tr> |
|
158 |
|
|
159 |
</table> |
|
160 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
|
161 |
Copyright (c) 2009 Colony Project<p> |
|
162 |
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> |
|
163 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> |
|
164 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p> |
|
165 |
Implementation of low level communication with the XBee in API mode.<p> |
|
166 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
|
167 | 169 |
</div> |
168 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by |
|
170 |
</div> |
|
171 |
</div> |
|
172 |
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by |
|
169 | 173 |
<a href="http://www.doxygen.org/index.html"> |
170 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
|
|
174 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
|
|
171 | 175 |
</body> |
172 | 176 |
</html> |
branches/wireless/docs/libwireless/html/tabs.css | ||
---|---|---|
57 | 57 |
white-space : nowrap; |
58 | 58 |
} |
59 | 59 |
|
60 |
DIV.tabs INPUT
|
|
60 |
DIV.tabs #MSearchBox
|
|
61 | 61 |
{ |
62 | 62 |
float : right; |
63 | 63 |
display : inline; |
branches/wireless/docs/libwireless/html/globals_defs.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 Page</span></a></li> |
12 | 15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
16 |
<li><a href="annotated.html"><span>Data 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><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 class="current"><a href="globals_defs.html"><span>Defines</span></a></li> |
27 | 32 |
</ul> |
28 | 33 |
</div> |
34 |
<div class="tabs"> |
|
35 |
<ul> |
|
36 |
<li><a href="#index_a"><span>a</span></a></li> |
|
37 |
<li><a href="#index_b"><span>b</span></a></li> |
|
38 |
<li><a href="#index_c"><span>c</span></a></li> |
|
39 |
<li><a href="#index_f"><span>f</span></a></li> |
|
40 |
<li><a href="#index_g"><span>g</span></a></li> |
|
41 |
<li><a href="#index_h"><span>h</span></a></li> |
|
42 |
<li><a href="#index_i"><span>i</span></a></li> |
|
43 |
<li><a href="#index_m"><span>m</span></a></li> |
|
44 |
<li><a href="#index_n"><span>n</span></a></li> |
|
45 |
<li><a href="#index_p"><span>p</span></a></li> |
|
46 |
<li><a href="#index_r"><span>r</span></a></li> |
|
47 |
<li><a href="#index_s"><span>s</span></a></li> |
|
48 |
<li><a href="#index_w"><span>w</span></a></li> |
|
49 |
<li><a href="#index_x"><span>x</span></a></li> |
|
50 |
</ul> |
|
51 |
</div> |
|
29 | 52 |
</div> |
30 | 53 |
<div class="contents"> |
31 | 54 |
|
32 |
<p> |
|
33 |
<ul> |
|
55 |
|
|
56 |
<h3><a class="anchor" id="index_a">- a -</a></h3><ul> |
|
57 |
<li>ACK_FAILURE |
|
58 |
: <a class="el" href="group__wl__defines.html#gab10c348780c46ce9fdd85ff4c8a2ff82">wireless.h</a> |
|
59 |
</li> |
|
60 |
<li>ACK_OK |
|
61 |
: <a class="el" href="group__wl__defines.html#ga4dc7574681861c30957f3ffc1fe84f41">wireless.h</a> |
|
62 |
</li> |
|
63 |
</ul> |
|
64 |
|
|
65 |
|
|
66 |
<h3><a class="anchor" id="index_b">- b -</a></h3><ul> |
|
67 |
<li>BASIC |
|
68 |
: <a class="el" href="group__wl__defines.html#ga07b76b679f20134d56e04819f746fad6">wireless.h</a> |
|
69 |
</li> |
|
34 | 70 |
<li>BROADCAST |
35 |
: <a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">wireless.h</a> |
|
71 |
: <a class="el" href="group__wl__defines.html#gac286e1243ab6be2c950c277e5e1377f9">wireless.h</a> |
|
72 |
</li> |
|
73 |
</ul> |
|
74 |
|
|
75 |
|
|
76 |
<h3><a class="anchor" id="index_c">- c -</a></h3><ul> |
|
77 |
<li>CCA_FAILURE |
|
78 |
: <a class="el" href="group__wl__defines.html#gab3a749bdf48c98c7d307775cfe0210e1">wireless.h</a> |
|
79 |
</li> |
|
80 |
</ul> |
|
81 |
|
|
82 |
|
|
83 |
<h3><a class="anchor" id="index_f">- f -</a></h3><ul> |
|
36 | 84 |
<li>FAST |
37 |
: <a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">wireless.h</a> |
|
85 |
: <a class="el" href="group__wl__defines.html#ga8091c2bcff55cbe0a4a145fd5fb7c22d">wireless.h</a> |
|
86 |
</li> |
|
87 |
<li>FNPTR |
|
88 |
: <a class="el" href="group__wl__defines.html#ga8b522c0ddd1f87732ac08225fcc89b58">wireless.h</a> |
|
89 |
</li> |
|
90 |
<li>FUNC |
|
91 |
: <a class="el" href="group__wl__defines.html#ga587e21dda1f72be700a6206023ad681b">wireless.h</a> |
|
92 |
</li> |
|
93 |
</ul> |
|
94 |
|
|
95 |
|
|
96 |
<h3><a class="anchor" id="index_g">- g -</a></h3><ul> |
|
38 | 97 |
<li>GLOBAL |
39 |
: <a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">wireless.h</a> |
|
98 |
: <a class="el" href="group__wl__defines.html#ga3de33738fd3c7e77bffbcfaefc3e7645">wireless.h</a> |
|
99 |
</li> |
|
100 |
</ul> |
|
101 |
|
|
102 |
|
|
103 |
<h3><a class="anchor" id="index_h">- h -</a></h3><ul> |
|
40 | 104 |
<li>HIGH_PRIORITY |
41 |
: <a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">wireless.h</a> |
|
105 |
: <a class="el" href="group__wl__defines.html#gaed801c122c559efe4677d351d07747b4">wireless.h</a> |
|
106 |
</li> |
|
107 |
</ul> |
|
108 |
|
|
109 |
|
|
110 |
<h3><a class="anchor" id="index_i">- i -</a></h3><ul> |
|
111 |
<li>INIT_NO |
|
112 |
: <a class="el" href="group__wl__defines.html#ga8b043ee766380d099be83d92dc145878">wireless.h</a> |
|
113 |
</li> |
|
114 |
<li>INIT_YES |
|
115 |
: <a class="el" href="group__wl__defines.html#ga0c8854a00a3ee4fb44960b651ffc62b3">wireless.h</a> |
|
116 |
</li> |
|
117 |
</ul> |
|
118 |
|
|
119 |
|
|
120 |
<h3><a class="anchor" id="index_m">- m -</a></h3><ul> |
|
121 |
<li>MAX_PACKET_GROUPS |
|
122 |
: <a class="el" href="group__wl__defines.html#ga78906957fa456cdea5f330c8a7b119da">wireless.h</a> |
|
123 |
</li> |
|
124 |
</ul> |
|
125 |
|
|
126 |
|
|
127 |
<h3><a class="anchor" id="index_n">- n -</a></h3><ul> |
|
42 | 128 |
<li>NORMAL_PRIORITY |
43 |
: <a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">wireless.h</a> |
|
129 |
: <a class="el" href="group__wl__defines.html#gafd4a10e7cb5b56dd8e5ba8e2cff7ffc3">wireless.h</a> |
|
130 |
</li> |
|
131 |
<li>NUM_RETRIES |
|
132 |
: <a class="el" href="group__wl__defines.html#ga17d416bf86e0b1b9adcdb92450abca63">wireless.h</a> |
|
133 |
</li> |
|
134 |
</ul> |
|
135 |
|
|
136 |
|
|
137 |
<h3><a class="anchor" id="index_p">- p -</a></h3><ul> |
|
44 | 138 |
<li>PAN |
45 |
: <a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">wireless.h</a> |
|
139 |
: <a class="el" href="group__wl__defines.html#ga11ed0d4e68673af6d575ed529ddf2130">wireless.h</a> |
|
140 |
</li> |
|
141 |
<li>PORT |
|
142 |
: <a class="el" href="group__xbee.html#ga614217d263be1fb1a5f76e2ff7be19a2">xbee.c</a> |
|
143 |
</li> |
|
144 |
</ul> |
|
145 |
|
|
146 |
|
|
147 |
<h3><a class="anchor" id="index_r">- r -</a></h3><ul> |
|
46 | 148 |
<li>RELIABLE |
47 |
: <a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">wireless.h</a> |
|
149 |
: <a class="el" href="group__wl__defines.html#ga5bda06b0f5767eeca91b1383c0898c19">wireless.h</a> |
|
150 |
</li> |
|
151 |
</ul> |
|
152 |
|
|
153 |
|
|
154 |
<h3><a class="anchor" id="index_s">- s -</a></h3><ul> |
|
155 |
<li>SENDING |
|
156 |
: <a class="el" href="group__wl__defines.html#gab6aaa08c0bfb6feb3e54a78d9211af56">wireless.h</a> |
|
157 |
</li> |
|
158 |
</ul> |
|
159 |
|
|
160 |
|
|
161 |
<h3><a class="anchor" id="index_w">- w -</a></h3><ul> |
|
48 | 162 |
<li>WL_ERROR_ADDRESS |
49 |
: <a class="el" href="group__wl__error.html#g9c528907279e6ace3aae7a7b19ad7687">wl_defs.h</a> |
|
163 |
: <a class="el" href="group__wl__error.html#ga9c528907279e6ace3aae7a7b19ad7687">wl_defs.h</a> |
|
164 |
</li> |
|
50 | 165 |
<li>WL_ERROR_ARGUMENT |
51 |
: <a class="el" href="group__wl__error.html#g43f851eae7eed2576351d336001c21d2">wl_defs.h</a> |
|
166 |
: <a class="el" href="group__wl__error.html#ga43f851eae7eed2576351d336001c21d2">wl_defs.h</a> |
|
167 |
</li> |
|
52 | 168 |
<li>WL_ERROR_BAD_GROUP |
53 |
: <a class="el" href="group__wl__error.html#g4bffaed18853133c76af57b89771b234">wl_defs.h</a> |
|
169 |
: <a class="el" href="group__wl__error.html#ga4bffaed18853133c76af57b89771b234">wl_defs.h</a> |
|
170 |
</li> |
|
171 |
<li>WL_ERROR_BAUD |
|
172 |
: <a class="el" href="group__wl__error.html#ga35522d85bcb3ce7e1f0649ed8880a47a">wl_defs.h</a> |
|
173 |
</li> |
|
54 | 174 |
<li>WL_ERROR_FAILED_REGISTRATION |
55 |
: <a class="el" href="group__wl__error.html#g11477a5a024fd6898e4449bf08761207">wl_defs.h</a> |
|
175 |
: <a class="el" href="group__wl__error.html#ga11477a5a024fd6898e4449bf08761207">wl_defs.h</a> |
|
176 |
</li> |
|
177 |
<li>WL_ERROR_FAILED_UNREGISTRATION |
|
178 |
: <a class="el" href="group__wl__error.html#ga2b221412880d805da1f9eb735ce7869f">wl_defs.h</a> |
|
179 |
</li> |
|
56 | 180 |
<li>WL_ERROR_INIT_ALREADY_INITD |
57 |
: <a class="el" href="group__wl__error.html#g63e64a790913362ecf505e1a7e8347b8">wl_defs.h</a> |
|
181 |
: <a class="el" href="group__wl__error.html#ga63e64a790913362ecf505e1a7e8347b8">wl_defs.h</a> |
|
182 |
</li> |
|
58 | 183 |
<li>WL_ERROR_INIT_FAILED |
59 |
: <a class="el" href="group__wl__error.html#g798466231ef137f248b55dbfbce36fd7">wl_defs.h</a> |
|
184 |
: <a class="el" href="group__wl__error.html#ga798466231ef137f248b55dbfbce36fd7">wl_defs.h</a> |
|
185 |
</li> |
|
60 | 186 |
<li>WL_ERROR_LIBRARY_NOT_INITD |
61 |
: <a class="el" href="group__wl__error.html#g099f03f9edae294ce4989433f73c141e">wl_defs.h</a> |
|
187 |
: <a class="el" href="group__wl__error.html#ga099f03f9edae294ce4989433f73c141e">wl_defs.h</a> |
|
188 |
</li> |
|
62 | 189 |
<li>WL_ERROR_MODE |
63 |
: <a class="el" href="group__wl__error.html#g33881dd2ec8ad0c2f67e40491a2f7c1a">wl_defs.h</a> |
|
190 |
: <a class="el" href="group__wl__error.html#ga33881dd2ec8ad0c2f67e40491a2f7c1a">wl_defs.h</a> |
|
191 |
</li> |
|
64 | 192 |
<li>WL_ERROR_SCOPE |
65 |
: <a class="el" href="group__wl__error.html#g76d08a0e32732a63dc93d2cdf95c8fd0">wl_defs.h</a> |
|
193 |
: <a class="el" href="group__wl__error.html#ga76d08a0e32732a63dc93d2cdf95c8fd0">wl_defs.h</a> |
|
194 |
</li> |
|
66 | 195 |
<li>WL_ERROR_SEND |
67 |
: <a class="el" href="group__wl__error.html#g2a775d59e55e9435505b4a908c522a0a">wl_defs.h</a> |
|
196 |
: <a class="el" href="group__wl__error.html#ga2a775d59e55e9435505b4a908c522a0a">wl_defs.h</a> |
|
197 |
</li> |
|
198 |
<li>WL_ERROR_SENDING_BUFFER_FULL |
|
199 |
: <a class="el" href="group__wl__error.html#ga39b25b343987ddbabbf378525ed17e8f">wl_defs.h</a> |
|
200 |
</li> |
|
68 | 201 |
<li>WL_ERROR_TERMINATION_FAILED |
69 |
: <a class="el" href="group__wl__error.html#g54de37a8427bf7372cfefa925cd0acf6">wl_defs.h</a> |
|
202 |
: <a class="el" href="group__wl__error.html#ga54de37a8427bf7372cfefa925cd0acf6">wl_defs.h</a> |
|
203 |
</li> |
|
204 |
<li>WL_ERROR_TOO_SMALL |
|
205 |
: <a class="el" href="group__wl__error.html#gacad84a598557eaf3ae400f7fdb4cf6c0">wl_defs.h</a> |
|
206 |
</li> |
|
207 |
<li>WL_ERROR_XBEE_COMMAND |
|
208 |
: <a class="el" href="group__wl__error.html#ga95320a2338e465077c708a7b50b20c9a">wl_defs.h</a> |
|
209 |
</li> |
|
210 |
<li>WL_ERROR_XBEE_COMMAND_16BIT |
|
211 |
: <a class="el" href="group__wl__error.html#ga029f22a1c6b7308a7a9db2ee7490a4f0">wl_defs.h</a> |
|
212 |
</li> |
|
70 | 213 |
<li>WL_SUCCESS |
71 |
: <a class="el" href="group__wl__error.html#g2b8a799ce85bb21788e58e1c23c16fc0">wl_defs.h</a> |
|
214 |
: <a class="el" href="group__wl__error.html#ga2b8a799ce85bb21788e58e1c23c16fc0">wl_defs.h</a> |
|
215 |
</li> |
|
216 |
</ul> |
|
217 |
|
|
218 |
|
|
219 |
<h3><a class="anchor" id="index_x">- x -</a></h3><ul> |
|
220 |
<li>XBEE_BAUD |
|
221 |
: <a class="el" href="group__xbee__const.html#ga7125fc8f3df24a2db8e074983206b054">xbee.h</a> |
|
222 |
</li> |
|
72 | 223 |
<li>XBEE_BROADCAST |
73 |
: <a class="el" href="group__xbee__const.html#g93bbd21f7965e1697350f950cedff5c4">xbee.c</a> |
|
224 |
: <a class="el" href="group__xbee__const.html#ga93bbd21f7965e1697350f950cedff5c4">xbee.h</a> |
|
225 |
</li> |
|
74 | 226 |
<li>XBEE_CHANNEL_DEFAULT |
75 |
: <a class="el" href="group__xbee__const.html#g35f8b9d8e01e788f1e29928cba29f215">xbee.c</a> |
|
227 |
: <a class="el" href="group__xbee__const.html#ga35f8b9d8e01e788f1e29928cba29f215">xbee.h</a> |
|
228 |
</li> |
|
76 | 229 |
<li>XBEE_OPTIONS_BROADCAST_ALL_PANS |
77 |
: <a class="el" href="group__xbee__const.html#g57382f888360b5b19f0de3b6f1f7c5a3">xbee.c</a> |
|
230 |
: <a class="el" href="group__xbee__const.html#ga57382f888360b5b19f0de3b6f1f7c5a3">xbee.h</a> |
|
231 |
</li> |
|
78 | 232 |
<li>XBEE_OPTIONS_DISABLE_RESPONSE |
79 |
: <a class="el" href="group__xbee__const.html#gcf9509013302590dca5ce3db63c64609">xbee.c</a> |
|
233 |
: <a class="el" href="group__xbee__const.html#gacf9509013302590dca5ce3db63c64609">xbee.h</a> |
|
234 |
</li> |
|
80 | 235 |
<li>XBEE_OPTIONS_NONE |
81 |
: <a class="el" href="group__xbee__const.html#gbca7356c2b8183fd41b5ca9a82dd962b">xbee.c</a> |
|
236 |
: <a class="el" href="group__xbee__const.html#gabca7356c2b8183fd41b5ca9a82dd962b">xbee.h</a> |
|
237 |
</li> |
|
82 | 238 |
<li>XBEE_PAN_DEFAULT |
83 |
: <a class="el" href="group__xbee__const.html#ge6bb9bb274d6750f954762454807a5a7">xbee.c</a> |
|
84 |
<li>XBEE_PORT_DEFAULT |
|
85 |
: <a class="el" href="group__xbee__const.html#gfd0466c206d7e1f82ee407d114468e96">xbee.c</a> |
|
239 |
: <a class="el" href="group__xbee__const.html#gae6bb9bb274d6750f954762454807a5a7">xbee.h</a> |
|
240 |
</li> |
|
86 | 241 |
<li>XBEE_RX |
87 |
: <a class="el" href="group__xbee__const.html#gc2b1262a3a1eb4a9f7ead366af71c32c">xbee.c</a> |
|
242 |
: <a class="el" href="group__xbee__const.html#gac2b1262a3a1eb4a9f7ead366af71c32c">xbee.h</a> |
|
243 |
</li> |
|
88 | 244 |
<li>XBEE_TX_STATUS |
89 |
: <a class="el" href="group__xbee__const.html#g7840d8b64c8bec12d8b8d32e845a638a">xbee.c</a> |
|
245 |
: <a class="el" href="group__xbee__const.html#ga7840d8b64c8bec12d8b8d32e845a638a">xbee.h</a> |
|
246 |
</li> |
|
90 | 247 |
</ul> |
91 | 248 |
</div> |
92 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by
|
|
249 |
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by
|
|
93 | 250 |
<a href="http://www.doxygen.org/index.html"> |
94 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
|
|
251 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
|
|
95 | 252 |
</body> |
96 | 253 |
</html> |
branches/wireless/docs/libwireless/html/structPacketGroupHandler.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: PacketGroupHandler Struct Reference</title> |
|
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 |
</head> |
|
9 |
<body> |
|
10 |
<!-- Generated by Doxygen 1.6.3 --> |
|
11 |
<div class="navigation" id="top"> |
|
12 |
<div class="tabs"> |
|
13 |
<ul> |
|
14 |
<li><a href="index.html"><span>Main 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 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 Structures</span></a></li> |
|
23 |
</ul> |
|
24 |
</div> |
|
25 |
</div> |
|
26 |
<div class="contents"> |
|
27 |
<h1>PacketGroupHandler Struct Reference<br/> |
|
28 |
<small> |
|
29 |
[<a class="el" href="group__wireless.html">Wireless</a>]</small> |
|
30 |
</h1><!-- doxytag: class="PacketGroupHandler" --> |
|
31 |
<p><code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code></p> |
|
32 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
33 |
<tr><td colspan="2"><h2>Data Fields</h2></td></tr> |
|
34 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a607fe92945cd627d27b750bc392d5286"></a><!-- doxytag: member="PacketGroupHandler::FNPTR" ref="a607fe92945cd627d27b750bc392d5286" args="" --> |
|
35 |
</td><td class="memItemRight" valign="bottom"><b>FNPTR</b></td></tr> |
|
36 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5452330b94495c1b97a9f24ab8c5cf5"></a><!-- doxytag: member="PacketGroupHandler::priority" ref="af5452330b94495c1b97a9f24ab8c5cf5" args="" --> |
|
37 |
uint8_t </td><td class="memItemRight" valign="bottom"><b>priority</b></td></tr> |
|
38 |
</table> |
|
39 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
40 |
<p>A <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> represents a packet group, and is used to register a packet group with the wireless library. It contains a function pointer to the packet handler function and the priority of the packet group. </p> |
|
41 |
<hr/>The documentation for this struct was generated from the following file:<ul> |
|
42 |
<li><a class="el" href="wireless_8h_source.html">wireless.h</a></li> |
|
43 |
</ul> |
|
44 |
</div> |
|
45 |
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by |
|
46 |
<a href="http://www.doxygen.org/index.html"> |
|
47 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> |
|
48 |
</body> |
|
49 |
</html> |
|
0 | 50 |
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 Page</span></a></li> |
12 | 15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
16 |
<li><a href="annotated.html"><span>Data 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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a> UINT8_C(0)</td></tr> |
|
26 |
|
|
27 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g11ed0d4e68673af6d575ed529ddf2130">PAN</a> UINT8_C(1)</td></tr> |
|
30 |
|
|
31 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gc286e1243ab6be2c950c277e5e1377f9">BROADCAST</a> UINT16_C(0xFFFF)</td></tr> |
|
34 |
|
|
35 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g5bda06b0f5767eeca91b1383c0898c19">RELIABLE</a> UINT8_C(0)</td></tr> |
|
38 |
|
|
39 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g8091c2bcff55cbe0a4a145fd5fb7c22d">FAST</a> UINT8_C(1)</td></tr> |
|
42 |
|
|
43 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gfd4a10e7cb5b56dd8e5ba8e2cff7ffc3">NORMAL_PRIORITY</a> UINT8_C(0)</td></tr> |
|
46 |
|
|
47 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ged801c122c559efe4677d351d07747b4">HIGH_PRIORITY</a> UINT8_C(1)</td></tr> |
|
50 |
|
|
51 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga07b76b679f20134d56e04819f746fad6">BASIC</a> UINT8_C(0)</td></tr> |
|
29 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a> UINT8_C(0)</td></tr> |
|
32 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga11ed0d4e68673af6d575ed529ddf2130">PAN</a> UINT8_C(1)</td></tr> |
|
35 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gac286e1243ab6be2c950c277e5e1377f9">BROADCAST</a> UINT16_C(0xFFFF)</td></tr> |
|
38 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga5bda06b0f5767eeca91b1383c0898c19">RELIABLE</a> UINT8_C(0)</td></tr> |
|
41 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga8091c2bcff55cbe0a4a145fd5fb7c22d">FAST</a> UINT8_C(1)</td></tr> |
|
44 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gafd4a10e7cb5b56dd8e5ba8e2cff7ffc3">NORMAL_PRIORITY</a> UINT8_C(0)</td></tr> |
|
47 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gaed801c122c559efe4677d351d07747b4">HIGH_PRIORITY</a> UINT8_C(1)</td></tr> |
|
50 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gab6aaa08c0bfb6feb3e54a78d9211af56">SENDING</a> UINT8_C(0)</td></tr> |
|
53 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga4dc7574681861c30957f3ffc1fe84f41">ACK_OK</a> UINT8_C(1)</td></tr> |
|
56 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gab10c348780c46ce9fdd85ff4c8a2ff82">ACK_FAILURE</a> UINT8_C(2)</td></tr> |
|
59 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#gab3a749bdf48c98c7d307775cfe0210e1">CCA_FAILURE</a> UINT8_C(3)</td></tr> |
|
62 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga587e21dda1f72be700a6206023ad681b">FUNC</a> func</td></tr> |
|
65 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga8b522c0ddd1f87732ac08225fcc89b58">FNPTR</a> void (*FUNC)(uint8_t* data,uint8_t length,uint8_t source)</td></tr> |
|
68 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga78906957fa456cdea5f330c8a7b119da">MAX_PACKET_GROUPS</a> UINT8_C(16)</td></tr> |
|
71 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga8b043ee766380d099be83d92dc145878">INIT_NO</a> UINT8_C(0)</td></tr> |
|
74 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga0c8854a00a3ee4fb44960b651ffc62b3">INIT_YES</a> UINT8_C(1)</td></tr> |
|
77 |
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#ga17d416bf86e0b1b9adcdb92450abca63">NUM_RETRIES</a> UINT8_C(3)</td></tr> |
|
80 |
<tr><td class="mdescLeft"> </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
|
|
83 |
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by
|
|
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 Page</span></a></li> |
|
15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
16 |
<li><a href="annotated.html"><span>Data 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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 * </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 </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 * </td> |
|
81 |
<td class="paramname"> <em>sum</em></td><td> </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> </td><td>a byte buffer to add to the checksum </td></tr> |
|
97 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the length of the buffer </td></tr> |
|
98 |
<tr><td valign="top"></td><td valign="top"><em>sum</em> </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 </td> |
|
118 |
<td class="paramname"></td> |
|
119 |
<td> ) </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 </td> |
|
144 |
<td class="paramname"></td> |
|
145 |
<td> ) </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 </td> |
|
169 |
<td class="paramname"></td> |
|
170 |
<td> ) </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 </td> |
|
193 |
<td class="paramname"></td> |
|
194 |
<td> ) </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 * </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 </td> |
|
224 |
<td class="paramname"> <em>size</em></td><td> </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> </td><td>the buffer of data to send </td></tr> |
|
240 |
<tr><td valign="top"></td><td valign="top"><em>size</em> </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 </td> |
|
259 |
<td class="paramname"> <em>len</em></td> |
|
260 |
<td> ) </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> </td><td>the packet type </td></tr> |
|
272 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </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 * </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 </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 </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 </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 </td> |
|
315 |
<td class="paramname"> <em>frame</em></td><td> </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> </td><td>the packet data to send </td></tr> |
|
331 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the number of bytes in the packet</td></tr> |
|
332 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </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> </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> </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 </td> |
|
351 |
<td class="paramname"> <em>byte</em></td> |
|
352 |
<td> ) </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> </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 </td> |
|
382 |
<td class="paramname"> <em>channel</em></td> |
|
383 |
<td> ) </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> </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 </td> |
|
412 |
<td class="paramname"> <em>id</em></td> |
|
413 |
<td> ) </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> </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 </td> |
|
443 |
<td class="paramname"></td> |
|
444 |
<td> ) </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 |
|
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/wireless_8h.html | ||
---|---|---|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
|
3 |
<title>Colony: wireless.h File Reference</title> |
|
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
|
6 |
</head><body> |
|
7 |
<!-- Generated by Doxygen 1.5.8 --> |
|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 |
<head> |
|
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 |
<title>libwireless: wireless.h File Reference</title> |
|
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 |
</head> |
|
9 |
<body> |
|
10 |
<!-- Generated by Doxygen 1.6.3 --> |
|
8 | 11 |
<div class="navigation" id="top"> |
9 | 12 |
<div class="tabs"> |
10 | 13 |
<ul> |
11 | 14 |
<li><a href="index.html"><span>Main Page</span></a></li> |
12 | 15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
16 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
13 | 17 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
14 | 18 |
</ul> |
15 | 19 |
</div> |
... | ... | |
21 | 25 |
</div> |
22 | 26 |
</div> |
23 | 27 |
<div class="contents"> |
24 |
<h1>wireless.h File Reference</h1>Contains definitions for using the wireless library. |
|
25 |
<a href="#_details">More...</a> |
|
26 |
<p> |
|
27 |
<code>#include <stdint.h></code><br> |
|
28 |
<h1>wireless.h File Reference</h1> |
|
29 |
<p>Contains definitions for using the wireless library. |
|
30 |
<a href="#_details">More...</a></p> |
|
31 |
<code>#include <stdint.h></code><br/> |
|
32 |
|
|
33 |
<p><a href="wireless_8h_source.html">Go to the source code of this file.</a></p> |
|
28 | 34 |
<table border="0" cellpadding="0" cellspacing="0"> |
29 |
<tr><td></td></tr> |
|
30 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
|
31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3de33738fd3c7e77bffbcfaefc3e7645"></a><!-- doxytag: member="wireless.h::GLOBAL" ref="g3de33738fd3c7e77bffbcfaefc3e7645" args="" --> |
|
32 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html#g3de33738fd3c7e77bffbcfaefc3e7645">GLOBAL</a> UINT8_C(0)</td></tr> |
Also available in: Unified diff