Revision 1823 branches/wireless/docs/libwireless/html/group__wl__functions.html

View differences:

group__wl__functions.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 API Functions</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 API 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 -->
8 11
<div class="navigation" id="top">
9 12
  <div class="tabs">
10 13
    <ul>
11 14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 17
      <li><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>Public API Functions<br>
22
<h1>Public API Functions<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>Functions</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
25

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

  
29
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminate wireless.  <a href="#g223f437c2bc8ab8a3ac2e0e06841120f"></a><br></td></tr>
30
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaa4e0d7014a74d0d59c08f9fbbf40bd7"></a><!-- doxytag: member="wl_functions::wl_send" ref="gaa4e0d7014a74d0d59c08f9fbbf40bd7" args="(char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)" -->
31
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode)</td></tr>
32

  
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets. <br></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gd92093466d82f3f0c732ffe8323228d2">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr>
35

  
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel.  <a href="#gd92093466d82f3f0c732ffe8323228d2"></a><br></td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g7886c2a37b7350211699dcabe48ff076">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr>
38

  
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan.  <a href="#g7886c2a37b7350211699dcabe48ff076"></a><br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbb08f7957bd0256c51f424fa770d3e60"></a><!-- doxytag: member="wl_functions::wl_send_robot" ref="gbb08f7957bd0256c51f424fa770d3e60" args="(char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)" -->
41
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gbb08f7957bd0256c51f424fa770d3e60">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode)</td></tr>
42

  
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot. <br></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0">wl_send_basic</a> (char *data, uint8_t length)</td></tr>
45

  
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default (i.e. basic) send wrapper.  <a href="#ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><br></td></tr>
47
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g11aeeac54834f0357794ae60a7513acf">wl_ack_error</a> (void)</td></tr>
48

  
49
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of acknowledgment errors.  <a href="#g11aeeac54834f0357794ae60a7513acf"></a><br></td></tr>
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr>
51

  
52
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks a specific packet for the acknowledgement status.  <a href="#ga364aa4d9cc8c789f05401e8adf44785"></a><br></td></tr>
53
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr>
54

  
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets acknowledgement statistics back to zero.  <a href="#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr>
56
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr>
57

  
58
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available.  <a href="#ga5a965e3443e4b2b60243225c50ecca7"></a><br></td></tr>
59
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ge2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr>
60

  
61
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next basic packet if available.  <a href="#ge2509e2b6bc61faa26d87b1d87881817"></a><br></td></tr>
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="wl_functions::wl_dispatch" ref="ge91c1e1940dfbbd063fdcfb86049c64a" args="(void)" -->
63
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ge91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr>
64

  
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr>
66
<tr><td class="memItemLeft" nowrap align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#g8af34a6265a5d6af3a1525bb51e61d54">wl_register_handler</a> (uint8_t group, void(*func)(void), uint8_t priority)</td></tr>
67

  
68
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to register new packet handlers (for non-default groups only).  <a href="#g8af34a6265a5d6af3a1525bb51e61d54"></a><br></td></tr>
26
<tr><td colspan="2"><h2>Functions</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
28
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize wireless.  <a href="#ga6a8d6179b1fe27f762937f0b47af2009"></a><br/></td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminate wireless.  <a href="#ga223f437c2bc8ab8a3ac2e0e06841120f"></a><br/></td></tr>
31
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gaf713b6ecbf2de78139990a40fe864d5e">wl_send</a> (uint8_t *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)</td></tr>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The core send function. This will take all possible arguments and send all types of packets.  <a href="#gaf713b6ecbf2de78139990a40fe864d5e"></a><br/></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gab0af7308304aed74eb281188b712e132">wl_send_global</a> (uint8_t *data, uint8_t length, uint8_t group)</td></tr>
34
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wrapper for core send function that will send a global packet across the current channel.  <a href="#gab0af7308304aed74eb281188b712e132"></a><br/></td></tr>
35
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga85cd4090dd284a4747dc8a56c1b215ad">wl_send_pan</a> (uint8_t *data, uint8_t length, uint8_t group)</td></tr>
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel on the current pan.  <a href="#ga85cd4090dd284a4747dc8a56c1b215ad"></a><br/></td></tr>
37
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga49160840045fda872a5e38432cc26988">wl_send_robot</a> (uint8_t *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)</td></tr>
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wrapper for core send function that will send a packet across the current channel to a specific robot.  <a href="#ga49160840045fda872a5e38432cc26988"></a><br/></td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga226d89acb4f77a982a2167eb1773eff2">wl_send_basic</a> (uint8_t *data, uint8_t length)</td></tr>
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default (i.e. basic) send wrapper.  <a href="#ga226d89acb4f77a982a2167eb1773eff2"></a><br/></td></tr>
41
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga15c9a01839696beb05d1e4f161d968b7">wl_ack_error</a> (void)</td></tr>
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of acknowledgment errors.  <a href="#ga15c9a01839696beb05d1e4f161d968b7"></a><br/></td></tr>
43
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gaa364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr>
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks a specific packet for the acknowledgement status.  <a href="#gaa364aa4d9cc8c789f05401e8adf44785"></a><br/></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr>
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets acknowledgement statistics back to zero.  <a href="#ga62e126abfcd382ec02524dd2f45a8a7b"></a><br/></td></tr>
47
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gaa5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr>
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The main receive function. Dispatches packets for registered handlers and returns next basic packet if available.  <a href="#gaa5a965e3443e4b2b60243225c50ecca7"></a><br/></td></tr>
49
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gae2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next basic packet if available.  <a href="#gae2509e2b6bc61faa26d87b1d87881817"></a><br/></td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="wl_functions::wl_dispatch" ref="gae91c1e1940dfbbd063fdcfb86049c64a" args="(void)" -->
52
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#gae91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr>
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dispatches packets for registered handlers. <br/></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga7aa57c04f65ff3c8fec591248ab82f86">wl_register_handler</a> (uint8_t group, FNPTR, uint8_t priority)</td></tr>
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to register new packet handlers (for non-default groups only).  <a href="#ga7aa57c04f65ff3c8fec591248ab82f86"></a><br/></td></tr>
56
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html#ga376508d5682b1b8c88ef8b5f911a3367">wl_unregister_handler</a> (uint8_t group)</td></tr>
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to unregister existing packet handlers (for non-default groups only).  <a href="#ga376508d5682b1b8c88ef8b5f911a3367"></a><br/></td></tr>
69 58
</table>
70
<hr><h2>Function Documentation</h2>
71
<a class="anchor" name="ga364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless.h::wl_ack_check" ref="ga364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" -->
59
<hr/><h2>Function Documentation</h2>
60
<a class="anchor" id="gaa364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless.h::wl_ack_check" ref="gaa364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" -->
72 61
<div class="memitem">
73 62
<div class="memproto">
74 63
      <table class="memname">
75 64
        <tr>
76
          <td class="memname">int8_t wl_ack_check           </td>
65
          <td class="memname">int8_t wl_ack_check </td>
77 66
          <td>(</td>
78 67
          <td class="paramtype">uint8_t&nbsp;</td>
79
          <td class="paramname"> <em>packet</em>          </td>
68
          <td class="paramname"> <em>packet</em></td>
80 69
          <td>&nbsp;)&nbsp;</td>
81 70
          <td></td>
82 71
        </tr>
......
84 73
</div>
85 74
<div class="memdoc">
86 75

  
87
<p>
88
acknowledgement error check check if a specific packet has been lost note: buffer will overflow ever 255 packets<p>
89
<dl compact><dt><b>Parameters:</b></dt><dd>
76
<p>Checks a specific packet for the acknowledgement status. </p>
77
<p>acknowledgement error check check if a specific packet has been lost note: buffer will overflow every 255 packets</p>
78
<dl><dt><b>Parameters:</b></dt><dd>
90 79
  <table border="0" cellspacing="2" cellpadding="0">
91
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>number</td></tr>
80
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>packet number</td></tr>
92 81
  </table>
82
  </dd>
93 83
</dl>
94
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0=still sending,1=ack received,-1=ack failure </dd></dl>
84
<dl class="return"><dt><b>Returns:</b></dt><dd>{SENDING,ACK_OK,ACK_FAILURE,CCA_FAILURE} </dd></dl>
95 85

  
86
<p>References <a class="el" href="wl__defs_8h_source.html#l00090">WL_ERROR_ARGUMENT</a>.</p>
87

  
96 88
</div>
97
</div><p>
98
<a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless.h::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" -->
89
</div>
90
<a class="anchor" id="ga15c9a01839696beb05d1e4f161d968b7"></a><!-- doxytag: member="wireless.h::wl_ack_error" ref="ga15c9a01839696beb05d1e4f161d968b7" args="(void)" -->
99 91
<div class="memitem">
100 92
<div class="memproto">
101 93
      <table class="memname">
102 94
        <tr>
103
          <td class="memname">int8_t wl_ack_error           </td>
95
          <td class="memname">uint8_t wl_ack_error </td>
104 96
          <td>(</td>
105 97
          <td class="paramtype">void&nbsp;</td>
106
          <td class="paramname">          </td>
98
          <td class="paramname"></td>
107 99
          <td>&nbsp;)&nbsp;</td>
108 100
          <td></td>
109 101
        </tr>
......
111 103
</div>
112 104
<div class="memdoc">
113 105

  
114
<p>
115
acknowledgment error check if any of the packets you have sent have been lost.<p>
116
note that all other error checking will be handled by library, so your user behavior won't have to worry about it<p>
117
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the # of packets lost (up to 255) </dd></dl>
106
<p>Returns the number of acknowledgment errors. </p>
107
<p>acknowledgment error check if any of the packets you have sent have been lost.</p>
108
<p>note that all other error checking will be handled by library, so your user behavior won't have to worry about it</p>
109
<dl class="return"><dt><b>Returns:</b></dt><dd>the # of packets lost (up to 255) </dd></dl>
118 110

  
119 111
</div>
120
</div><p>
121
<a class="anchor" name="g62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless.h::wl_ack_reset" ref="g62e126abfcd382ec02524dd2f45a8a7b" args="(void)" -->
112
</div>
113
<a class="anchor" id="ga62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless.h::wl_ack_reset" ref="ga62e126abfcd382ec02524dd2f45a8a7b" args="(void)" -->
122 114
<div class="memitem">
123 115
<div class="memproto">
124 116
      <table class="memname">
125 117
        <tr>
126
          <td class="memname">void wl_ack_reset           </td>
118
          <td class="memname">void wl_ack_reset </td>
127 119
          <td>(</td>
128 120
          <td class="paramtype">void&nbsp;</td>
129
          <td class="paramname">          </td>
121
          <td class="paramname"></td>
130 122
          <td>&nbsp;)&nbsp;</td>
131 123
          <td></td>
132 124
        </tr>
......
134 126
</div>
135 127
<div class="memdoc">
136 128

  
137
<p>
138
acknowledgement reset reset the acknowledgement buffer 
129
<p>Resets acknowledgement statistics back to zero. </p>
130
<p>acknowledgement reset reset the acknowledgement buffer </p>
131

  
139 132
</div>
140
</div><p>
141
<a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless.h::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" -->
133
</div>
134
<a class="anchor" id="gaa5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless.h::wl_get" ref="gaa5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" -->
142 135
<div class="memitem">
143 136
<div class="memproto">
144 137
      <table class="memname">
145 138
        <tr>
146
          <td class="memname">int8_t wl_get           </td>
139
          <td class="memname">int8_t wl_get </td>
147 140
          <td>(</td>
148 141
          <td class="paramtype">char *&nbsp;</td>
149 142
          <td class="paramname"> <em>data</em>, </td>
......
163 156
</div>
164 157
<div class="memdoc">
165 158

  
166
<p>
167
the main receive function (similar to wl_do)<p>
168
when called, this function will receive the next packet on the default packet group it will also dispatch registered packet handler functions for any other packet groups it has received<p>
169
<dl compact><dt><b>Parameters:</b></dt><dd>
159
<p>The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. </p>
160
<p>the main receive function (similar to wl_do)</p>
161
<p>when called, this function will receive the next packet on the default packet group it will also dispatch registered packet handler functions for any other packet groups it has received</p>
162
<dl><dt><b>Parameters:</b></dt><dd>
170 163
  <table border="0" cellspacing="2" cellpadding="0">
171 164
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>an already-initialized array to store the default group packet data in </td></tr>
172 165
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the initialized data array</td></tr>
173 166
  </table>
167
  </dd>
174 168
</dl>
175
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (&lt;0) </dd></dl>
169
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (&lt;0) </dd></dl>
176 170

  
171
<p>References <a class="el" href="wireless__receive_8c_source.html#l00164">wl_dispatch()</a>, and <a class="el" href="wireless__receive_8c_source.html#l00100">wl_get_basic()</a>.</p>
172

  
177 173
</div>
178
</div><p>
179
<a class="anchor" name="ge2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless.h::wl_get_basic" ref="ge2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" -->
174
</div>
175
<a class="anchor" id="gae2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless.h::wl_get_basic" ref="gae2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" -->
180 176
<div class="memitem">
181 177
<div class="memproto">
182 178
      <table class="memname">
183 179
        <tr>
184
          <td class="memname">int8_t wl_get_basic           </td>
180
          <td class="memname">int8_t wl_get_basic </td>
185 181
          <td>(</td>
186 182
          <td class="paramtype">char *&nbsp;</td>
187 183
          <td class="paramname"> <em>data</em>, </td>
......
201 197
</div>
202 198
<div class="memdoc">
203 199

  
204
<p>
205
function to receive only packets on the default group this function is only meant to receive packets sent using <a class="el" href="group__wl__functions.html#ga8fb657e4d3bf7cb396f36e99fdd01a0" title="Default (i.e. basic) send wrapper.">wl_send_basic()</a><p>
206
<dl compact><dt><b>Parameters:</b></dt><dd>
200
<p>Returns the next basic packet if available. </p>
201
<p>function to receive only packets on the default group this function is only meant to receive packets sent using <a class="el" href="group__wl__functions.html#ga226d89acb4f77a982a2167eb1773eff2" title="Default (i.e. basic) send wrapper.">wl_send_basic()</a></p>
202
<dl><dt><b>Parameters:</b></dt><dd>
207 203
  <table border="0" cellspacing="2" cellpadding="0">
208 204
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>an already-initialized array to store the default group packet data in </td></tr>
209 205
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the initialized data array</td></tr>
210 206
  </table>
207
  </dd>
211 208
</dl>
212
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (&lt;0) </dd></dl>
209
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (&lt;0) </dd></dl>
213 210

  
211
<p>References <a class="el" href="wl__defs_8h_source.html#l00108">WL_ERROR_TOO_SMALL</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, and <a class="el" href="xbee_8c_source.html#l00087">xbee_basic_buf</a>.</p>
212

  
213
<p>Referenced by <a class="el" href="wireless__receive_8c_source.html#l00084">wl_get()</a>.</p>
214

  
214 215
</div>
215
</div><p>
216
<a class="anchor" name="g6a8d6179b1fe27f762937f0b47af2009"></a><!-- doxytag: member="wireless.h::wl_init" ref="g6a8d6179b1fe27f762937f0b47af2009" args="(void)" -->
216
</div>
217
<a class="anchor" id="ga6a8d6179b1fe27f762937f0b47af2009"></a><!-- doxytag: member="wireless.h::wl_init" ref="ga6a8d6179b1fe27f762937f0b47af2009" args="(void)" -->
217 218
<div class="memitem">
218 219
<div class="memproto">
219 220
      <table class="memname">
220 221
        <tr>
221
          <td class="memname">int8_t wl_init           </td>
222
          <td class="memname">int8_t wl_init </td>
222 223
          <td>(</td>
223 224
          <td class="paramtype">void&nbsp;</td>
224
          <td class="paramname">          </td>
225
          <td class="paramname"></td>
225 226
          <td>&nbsp;)&nbsp;</td>
226 227
          <td></td>
227 228
        </tr>
......
229 230
</div>
230 231
<div class="memdoc">
231 232

  
232
<p>
233
initialization function: set up xbee communication and packet handler infrastructure<p>
234
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
233
<p>Initialize wireless. </p>
234
<p>initialization function: set up xbee communication and packet handler infrastructure</p>
235
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
235 236

  
237
<p>References <a class="el" href="wireless_8h_source.html#l00108">INIT_YES</a>, <a class="el" href="wireless_8h_source.html#l00102">MAX_PACKET_GROUPS</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#l00072">WL_ERROR_INIT_FAILED</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, and <a class="el" href="xbee_8c_source.html#l00729">xbee_init()</a>.</p>
238

  
236 239
</div>
237
</div><p>
238
<a class="anchor" name="g8af34a6265a5d6af3a1525bb51e61d54"></a><!-- doxytag: member="wireless.h::wl_register_handler" ref="g8af34a6265a5d6af3a1525bb51e61d54" args="(uint8_t group, void(*func)(void), uint8_t priority)" -->
240
</div>
241
<a class="anchor" id="ga7aa57c04f65ff3c8fec591248ab82f86"></a><!-- doxytag: member="wireless.h::wl_register_handler" ref="ga7aa57c04f65ff3c8fec591248ab82f86" args="(uint8_t group, FNPTR, uint8_t priority)" -->
239 242
<div class="memitem">
240 243
<div class="memproto">
241 244
      <table class="memname">
242 245
        <tr>
243
          <td class="memname">int8_t wl_register_handler           </td>
246
          <td class="memname">int8_t wl_register_handler </td>
244 247
          <td>(</td>
245 248
          <td class="paramtype">uint8_t&nbsp;</td>
246 249
          <td class="paramname"> <em>group</em>, </td>
......
248 251
        <tr>
249 252
          <td class="paramkey"></td>
250 253
          <td></td>
251
          <td class="paramtype">void(*)(void)&nbsp;</td>
252
          <td class="paramname"> <em>func</em>, </td>
254
          <td class="paramtype">FNPTR&nbsp;</td>
255
          <td class="paramname">, </td>
253 256
        </tr>
254 257
        <tr>
255 258
          <td class="paramkey"></td>
......
266 269
</div>
267 270
<div class="memdoc">
268 271

  
269
<p>
270
function to register new packet handlers (for non-default groups only)<p>
271
<dl compact><dt><b>Parameters:</b></dt><dd>
272
<p>Function to register new packet handlers (for non-default groups only). </p>
273
<p>function to register new packet handlers (for non-default groups only)</p>
274
<dl><dt><b>Parameters:</b></dt><dd>
272 275
  <table border="0" cellspacing="2" cellpadding="0">
273 276
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group number of the packets to handle with this function </td></tr>
274 277
    <tr><td valign="top"></td><td valign="top"><em>func</em>&nbsp;</td><td>the function pointer to the user-specified packet handler </td></tr>
275 278
    <tr><td valign="top"></td><td valign="top"><em>priority</em>&nbsp;</td><td>flag to set the priority of the function handler</td></tr>
276 279
  </table>
280
  </dd>
277 281
</dl>
278
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
282
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
279 283

  
284
<p>References <a class="el" href="wireless_8h_source.html#l00095">FUNC</a>, <a class="el" href="wireless_8h_source.html#l00105">INIT_NO</a>, <a class="el" href="wireless_8h_source.html#l00102">MAX_PACKET_GROUPS</a>, <a class="el" href="wl__defs_8h_source.html#l00084">WL_ERROR_FAILED_REGISTRATION</a>, <a class="el" href="wl__defs_8h_source.html#l00078">WL_ERROR_LIBRARY_NOT_INITD</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
285

  
280 286
</div>
281
</div><p>
282
<a class="anchor" name="ga8fb657e4d3bf7cb396f36e99fdd01a0"></a><!-- doxytag: member="wireless.h::wl_send_basic" ref="ga8fb657e4d3bf7cb396f36e99fdd01a0" args="(char *data, uint8_t length)" -->
287
</div>
288
<a class="anchor" id="gaf713b6ecbf2de78139990a40fe864d5e"></a><!-- doxytag: member="wireless.h::wl_send" ref="gaf713b6ecbf2de78139990a40fe864d5e" args="(uint8_t *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)" -->
283 289
<div class="memitem">
284 290
<div class="memproto">
285 291
      <table class="memname">
286 292
        <tr>
287
          <td class="memname">int8_t wl_send_basic           </td>
293
          <td class="memname">int16_t wl_send </td>
288 294
          <td>(</td>
289
          <td class="paramtype">char *&nbsp;</td>
295
          <td class="paramtype">uint8_t *&nbsp;</td>
290 296
          <td class="paramname"> <em>data</em>, </td>
291 297
        </tr>
292 298
        <tr>
293 299
          <td class="paramkey"></td>
294 300
          <td></td>
295 301
          <td class="paramtype">uint8_t&nbsp;</td>
302
          <td class="paramname"> <em>length</em>, </td>
303
        </tr>
304
        <tr>
305
          <td class="paramkey"></td>
306
          <td></td>
307
          <td class="paramtype">uint8_t&nbsp;</td>
308
          <td class="paramname"> <em>group</em>, </td>
309
        </tr>
310
        <tr>
311
          <td class="paramkey"></td>
312
          <td></td>
313
          <td class="paramtype">uint8_t&nbsp;</td>
314
          <td class="paramname"> <em>scope</em>, </td>
315
        </tr>
316
        <tr>
317
          <td class="paramkey"></td>
318
          <td></td>
319
          <td class="paramtype">uint16_t&nbsp;</td>
320
          <td class="paramname"> <em>dest</em>, </td>
321
        </tr>
322
        <tr>
323
          <td class="paramkey"></td>
324
          <td></td>
325
          <td class="paramtype">uint8_t&nbsp;</td>
326
          <td class="paramname"> <em>mode</em></td><td>&nbsp;</td>
327
        </tr>
328
        <tr>
329
          <td></td>
330
          <td>)</td>
331
          <td></td><td></td><td></td>
332
        </tr>
333
      </table>
334
</div>
335
<div class="memdoc">
336

  
337
<p>The core send function. This will take all possible arguments and send all types of packets. </p>
338
<p>The core send function. This will take all possible arguments and send all types of packets.</p>
339
<dl><dt><b>Parameters:</b></dt><dd>
340
  <table border="0" cellspacing="2" cellpadding="0">
341
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to the byte array of data to be included in the packet </td></tr>
342
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
343
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group of the packet </td></tr>
344
    <tr><td valign="top"></td><td valign="top"><em>scope</em>&nbsp;</td><td>flag for sending global packet or your current PAN </td></tr>
345
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>robot ID (for robot to robot packet) </td></tr>
346
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>flag for using FAST or RELIABLE sending</td></tr>
347
  </table>
348
  </dd>
349
</dl>
350
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code </dd></dl>
351

  
352
<p>References <a class="el" href="wireless_8h_source.html#l00086">ACK_OK</a>, <a class="el" href="wireless_8h_source.html#l00068">BROADCAST</a>, <a class="el" href="wireless_8h_source.html#l00074">FAST</a>, <a class="el" href="wireless_8h_source.html#l00062">GLOBAL</a>, <a class="el" href="wireless__send_8c_source.html#l00058">nextframe</a>, <a class="el" href="wireless_8h_source.html#l00065">PAN</a>, <a class="el" href="wireless_8h_source.html#l00071">RELIABLE</a>, <a class="el" href="wireless_8h_source.html#l00083">SENDING</a>, <a class="el" href="wl__defs_8h_source.html#l00105">WL_ERROR_MODE</a>, <a class="el" href="wl__defs_8h_source.html#l00099">WL_ERROR_SCOPE</a>, <a class="el" href="wl__defs_8h_source.html#l00093">WL_ERROR_SEND</a>, <a class="el" href="wl__defs_8h_source.html#l00111">WL_ERROR_SENDING_BUFFER_FULL</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, <a class="el" href="xbee_8c_source.html#l01313">xbee_checksum_add()</a>, <a class="el" href="xbee_8h_source.html#l00080">XBEE_OPTIONS_BROADCAST_ALL_PANS</a>, <a class="el" href="xbee_8h_source.html#l00078">XBEE_OPTIONS_DISABLE_RESPONSE</a>, <a class="el" href="xbee_8h_source.html#l00076">XBEE_OPTIONS_NONE</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#l01015">xbee_sendc()</a>.</p>
353

  
354
<p>Referenced by <a class="el" href="wireless__send_8c_source.html#l00240">wl_send_basic()</a>, <a class="el" href="wireless__send_8c_source.html#l00200">wl_send_global()</a>, <a class="el" href="wireless__send_8c_source.html#l00213">wl_send_pan()</a>, and <a class="el" href="wireless__send_8c_source.html#l00228">wl_send_robot()</a>.</p>
355

  
356
</div>
357
</div>
358
<a class="anchor" id="ga226d89acb4f77a982a2167eb1773eff2"></a><!-- doxytag: member="wireless.h::wl_send_basic" ref="ga226d89acb4f77a982a2167eb1773eff2" args="(uint8_t *data, uint8_t length)" -->
359
<div class="memitem">
360
<div class="memproto">
361
      <table class="memname">
362
        <tr>
363
          <td class="memname">int16_t wl_send_basic </td>
364
          <td>(</td>
365
          <td class="paramtype">uint8_t *&nbsp;</td>
366
          <td class="paramname"> <em>data</em>, </td>
367
        </tr>
368
        <tr>
369
          <td class="paramkey"></td>
370
          <td></td>
371
          <td class="paramtype">uint8_t&nbsp;</td>
296 372
          <td class="paramname"> <em>length</em></td><td>&nbsp;</td>
297 373
        </tr>
298 374
        <tr>
......
304 380
</div>
305 381
<div class="memdoc">
306 382

  
307
<p>
308
Default (i.e. basic) send wrapper.<p>
309
<dl compact><dt><b>Parameters:</b></dt><dd>
383
<p>Default (i.e. basic) send wrapper. </p>
384
<p>Default (i.e. basic) send wrapper.</p>
385
<dl><dt><b>Parameters:</b></dt><dd>
310 386
  <table border="0" cellspacing="2" cellpadding="0">
311 387
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to the byte array of data to be included in the packet </td></tr>
312 388
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array</td></tr>
313 389
  </table>
390
  </dd>
314 391
</dl>
315
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
392
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
316 393

  
394
<p><p>Check if it needs to adjust according to data type. </p>
395
</p>
396

  
397
<p>References <a class="el" href="wireless_8h_source.html#l00059">BASIC</a>, <a class="el" href="wireless_8h_source.html#l00068">BROADCAST</a>, <a class="el" href="wireless_8h_source.html#l00062">GLOBAL</a>, <a class="el" href="wireless_8h_source.html#l00071">RELIABLE</a>, and <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>.</p>
398

  
317 399
</div>
318
</div><p>
319
<a class="anchor" name="gd92093466d82f3f0c732ffe8323228d2"></a><!-- doxytag: member="wireless.h::wl_send_global" ref="gd92093466d82f3f0c732ffe8323228d2" args="(char *data, uint8_t length, uint8_t group)" -->
400
</div>
401
<a class="anchor" id="gab0af7308304aed74eb281188b712e132"></a><!-- doxytag: member="wireless.h::wl_send_global" ref="gab0af7308304aed74eb281188b712e132" args="(uint8_t *data, uint8_t length, uint8_t group)" -->
320 402
<div class="memitem">
321 403
<div class="memproto">
322 404
      <table class="memname">
323 405
        <tr>
324
          <td class="memname">int8_t wl_send_global           </td>
406
          <td class="memname">int16_t wl_send_global </td>
325 407
          <td>(</td>
326
          <td class="paramtype">char *&nbsp;</td>
408
          <td class="paramtype">uint8_t *&nbsp;</td>
327 409
          <td class="paramname"> <em>data</em>, </td>
328 410
        </tr>
329 411
        <tr>
......
347 429
</div>
348 430
<div class="memdoc">
349 431

  
350
<p>
351
Wrapper for core send function that will send a global packet across the current channel.<p>
352
<dl compact><dt><b>Parameters:</b></dt><dd>
432
<p>Wrapper for core send function that will send a global packet across the current channel. </p>
433
<p>Wrapper for core send function that will send a global packet across the current channel.</p>
434
<dl><dt><b>Parameters:</b></dt><dd>
353 435
  <table border="0" cellspacing="2" cellpadding="0">
354 436
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to the byte array of data to be included in the packet </td></tr>
355 437
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
356 438
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group of the packet</td></tr>
357 439
  </table>
440
  </dd>
358 441
</dl>
359
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
442
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code </dd></dl>
360 443

  
444
<p>References <a class="el" href="wireless_8h_source.html#l00068">BROADCAST</a>, <a class="el" href="wireless_8h_source.html#l00062">GLOBAL</a>, <a class="el" href="wireless_8h_source.html#l00071">RELIABLE</a>, and <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>.</p>
445

  
361 446
</div>
362
</div><p>
363
<a class="anchor" name="g7886c2a37b7350211699dcabe48ff076"></a><!-- doxytag: member="wireless.h::wl_send_pan" ref="g7886c2a37b7350211699dcabe48ff076" args="(char *data, uint8_t length, uint8_t group)" -->
447
</div>
448
<a class="anchor" id="ga85cd4090dd284a4747dc8a56c1b215ad"></a><!-- doxytag: member="wireless.h::wl_send_pan" ref="ga85cd4090dd284a4747dc8a56c1b215ad" args="(uint8_t *data, uint8_t length, uint8_t group)" -->
364 449
<div class="memitem">
365 450
<div class="memproto">
366 451
      <table class="memname">
367 452
        <tr>
368
          <td class="memname">int8_t wl_send_pan           </td>
453
          <td class="memname">int16_t wl_send_pan </td>
369 454
          <td>(</td>
370
          <td class="paramtype">char *&nbsp;</td>
455
          <td class="paramtype">uint8_t *&nbsp;</td>
371 456
          <td class="paramname"> <em>data</em>, </td>
372 457
        </tr>
373 458
        <tr>
......
391 476
</div>
392 477
<div class="memdoc">
393 478

  
394
<p>
395
Wrapper for core send function that will send a packet across the current channel on the current pan.<p>
396
<dl compact><dt><b>Parameters:</b></dt><dd>
479
<p>Wrapper for core send function that will send a packet across the current channel on the current pan. </p>
480
<p>Wrapper for core send function that will send a packet across the current channel on the current pan.</p>
481
<dl><dt><b>Parameters:</b></dt><dd>
397 482
  <table border="0" cellspacing="2" cellpadding="0">
398 483
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to the byte array of data to be included in the packet </td></tr>
399 484
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
400 485
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group of the packet</td></tr>
401 486
  </table>
487
  </dd>
402 488
</dl>
403
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
489
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
404 490

  
491
<p>References <a class="el" href="wireless_8h_source.html#l00068">BROADCAST</a>, <a class="el" href="wireless_8h_source.html#l00065">PAN</a>, <a class="el" href="wireless_8h_source.html#l00071">RELIABLE</a>, and <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>.</p>
492

  
405 493
</div>
406
</div><p>
407
<a class="anchor" name="g223f437c2bc8ab8a3ac2e0e06841120f"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="g223f437c2bc8ab8a3ac2e0e06841120f" args="(void)" -->
494
</div>
495
<a class="anchor" id="ga49160840045fda872a5e38432cc26988"></a><!-- doxytag: member="wireless.h::wl_send_robot" ref="ga49160840045fda872a5e38432cc26988" args="(uint8_t *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)" -->
408 496
<div class="memitem">
409 497
<div class="memproto">
410 498
      <table class="memname">
411 499
        <tr>
412
          <td class="memname">int8_t wl_terminate           </td>
500
          <td class="memname">int16_t wl_send_robot </td>
413 501
          <td>(</td>
502
          <td class="paramtype">uint8_t *&nbsp;</td>
503
          <td class="paramname"> <em>data</em>, </td>
504
        </tr>
505
        <tr>
506
          <td class="paramkey"></td>
507
          <td></td>
508
          <td class="paramtype">uint8_t&nbsp;</td>
509
          <td class="paramname"> <em>length</em>, </td>
510
        </tr>
511
        <tr>
512
          <td class="paramkey"></td>
513
          <td></td>
514
          <td class="paramtype">uint8_t&nbsp;</td>
515
          <td class="paramname"> <em>group</em>, </td>
516
        </tr>
517
        <tr>
518
          <td class="paramkey"></td>
519
          <td></td>
520
          <td class="paramtype">uint16_t&nbsp;</td>
521
          <td class="paramname"> <em>dest</em>, </td>
522
        </tr>
523
        <tr>
524
          <td class="paramkey"></td>
525
          <td></td>
526
          <td class="paramtype">uint8_t&nbsp;</td>
527
          <td class="paramname"> <em>mode</em></td><td>&nbsp;</td>
528
        </tr>
529
        <tr>
530
          <td></td>
531
          <td>)</td>
532
          <td></td><td></td><td></td>
533
        </tr>
534
      </table>
535
</div>
536
<div class="memdoc">
537

  
538
<p>Wrapper for core send function that will send a packet across the current channel to a specific robot. </p>
539
<p>Wrapper for core send function that will send a packet across the current channel to a specific robot.</p>
540
<dl><dt><b>Parameters:</b></dt><dd>
541
  <table border="0" cellspacing="2" cellpadding="0">
542
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to the byte array of data to be included in the packet </td></tr>
543
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
544
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group of the packet </td></tr>
545
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>robot ID (for robot to robot packet) </td></tr>
546
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>flag for using FAST or RELIABLE sending</td></tr>
547
  </table>
548
  </dd>
549
</dl>
550
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
551

  
552
<p>References <a class="el" href="wireless_8h_source.html#l00062">GLOBAL</a>, and <a class="el" href="wireless__send_8c_source.html#l00091">wl_send()</a>.</p>
553

  
554
</div>
555
</div>
556
<a class="anchor" id="ga223f437c2bc8ab8a3ac2e0e06841120f"></a><!-- doxytag: member="wireless.h::wl_terminate" ref="ga223f437c2bc8ab8a3ac2e0e06841120f" args="(void)" -->
557
<div class="memitem">
558
<div class="memproto">
559
      <table class="memname">
560
        <tr>
561
          <td class="memname">int8_t wl_terminate </td>
562
          <td>(</td>
414 563
          <td class="paramtype">void&nbsp;</td>
415
          <td class="paramname">          </td>
564
          <td class="paramname"></td>
416 565
          <td>&nbsp;)&nbsp;</td>
417 566
          <td></td>
418 567
        </tr>
......
420 569
</div>
421 570
<div class="memdoc">
422 571

  
423
<p>
424
termination function: end xbee communication, deregister all handlers, etc<p>
425
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
572
<p>Terminate wireless. </p>
573
<p>termination function: end xbee communication, deregister all handlers, etc</p>
574
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
426 575

  
576
<p>References <a class="el" href="wireless_8h_source.html#l00105">INIT_NO</a>, <a class="el" href="wireless_8h_source.html#l00102">MAX_PACKET_GROUPS</a>, <a class="el" href="wl__defs_8h_source.html#l00078">WL_ERROR_LIBRARY_NOT_INITD</a>, <a class="el" href="wl__defs_8h_source.html#l00081">WL_ERROR_TERMINATION_FAILED</a>, <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>, and <a class="el" href="xbee_8c_source.html#l00918">xbee_terminate()</a>.</p>
577

  
427 578
</div>
428
</div><p>
429 579
</div>
430
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
580
<a class="anchor" id="ga376508d5682b1b8c88ef8b5f911a3367"></a><!-- doxytag: member="wireless.h::wl_unregister_handler" ref="ga376508d5682b1b8c88ef8b5f911a3367" args="(uint8_t group)" -->
581
<div class="memitem">
582
<div class="memproto">
583
      <table class="memname">
584
        <tr>
585
          <td class="memname">int8_t wl_unregister_handler </td>
586
          <td>(</td>
587
          <td class="paramtype">uint8_t&nbsp;</td>
588
          <td class="paramname"> <em>group</em></td>
589
          <td>&nbsp;)&nbsp;</td>
590
          <td></td>
591
        </tr>
592
      </table>
593
</div>
594
<div class="memdoc">
595

  
596
<p>Function to unregister existing packet handlers (for non-default groups only). </p>
597
<p>function to unregister existing packet handlers (for non-default groups only)</p>
598
<dl><dt><b>Parameters:</b></dt><dd>
599
  <table border="0" cellspacing="2" cellpadding="0">
600
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group number of the handler to unregister</td></tr>
601
  </table>
602
  </dd>
603
</dl>
604
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
605

  
606
<p>References <a class="el" href="wireless_8h_source.html#l00095">FUNC</a>, <a class="el" href="wireless_8h_source.html#l00105">INIT_NO</a>, <a class="el" href="wireless_8h_source.html#l00102">MAX_PACKET_GROUPS</a>, <a class="el" href="wireless_8h_source.html#l00077">NORMAL_PRIORITY</a>, <a class="el" href="wl__defs_8h_source.html#l00087">WL_ERROR_FAILED_UNREGISTRATION</a>, <a class="el" href="wl__defs_8h_source.html#l00078">WL_ERROR_LIBRARY_NOT_INITD</a>, and <a class="el" href="wl__defs_8h_source.html#l00069">WL_SUCCESS</a>.</p>
607

  
608
</div>
609
</div>
610
</div>
611
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
431 612
<a href="http://www.doxygen.org/index.html">
432
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
613
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
433 614
</body>
434 615
</html>

Also available in: Unified diff