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

View differences:

group__wireless.html
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>Colony: Wireless</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.8 -->
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>libwireless: Wireless</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
</head>
9
<body>
10
<!-- Generated by Doxygen 1.6.3 -->
8 11
<div class="navigation" id="top">
9 12
  <div class="tabs">
10 13
    <ul>
11 14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 17
      <li><a href="files.html"><span>Files</span></a></li>
14 18
    </ul>
15 19
  </div>
16 20
</div>
17 21
<div class="contents">
18
<h1>Wireless</h1>Interface with the wireless library.  
19
<a href="#_details">More...</a>
20
<p>
22
<h1>Wireless</h1>
23
<p>Interface with the wireless library.  
24
<a href="#_details">More...</a></p>
21 25
<table border="0" cellpadding="0" cellspacing="0">
22
<tr><td></td></tr>
23
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html">Public Constants</a></td></tr>
25

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

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

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

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

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

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

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

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

  
49
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dispatches packets for registered handlers. <br></td></tr>
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gf0c80262c96d3410bf0f1266871ffe3e">wl_send</a> (char *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)</td></tr>
51

  
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g48e2d69b71010e23ca5c7b2de595ae4f">wl_send_global</a> (char *data, uint8_t length, uint8_t group)</td></tr>
53

  
54
<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="#g48e2d69b71010e23ca5c7b2de595ae4f"></a><br></td></tr>
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaef3438cea00f6f3d3de16d54ec33d51">wl_send_pan</a> (char *data, uint8_t length, uint8_t group)</td></tr>
56

  
57
<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="#gaef3438cea00f6f3d3de16d54ec33d51"></a><br></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g4a728d521deae8f12b9d40a62027600b">wl_send_robot</a> (char *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)</td></tr>
59

  
60
<tr><td class="memItemLeft" nowrap align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#g461b4558be666fefb9bf41edfd5ea500">wl_send_basic</a> (char *data, uint8_t length)</td></tr>
61

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

  
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of acknowledgment errors.  <a href="#g11aeeac54834f0357794ae60a7513acf"></a><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__wireless.html#ga364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr>
67

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

  
71
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets acknowledgement statistics back to zero.  <a href="#g62e126abfcd382ec02524dd2f45a8a7b"></a><br></td></tr>
26
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a></td></tr>
28
<tr><td colspan="2"><h2>Modules</h2></td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__defines.html">Public Constants</a></td></tr>
30
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__functions.html">Public API Functions</a></td></tr>
31
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__error.html">Error Codes</a></td></tr>
32
<tr><td colspan="2"><h2>Defines</h2></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab30af815d6e9494361629440f14e3716"></a><!-- doxytag: member="wireless::PACKET_BUFFER_SIZE" ref="gab30af815d6e9494361629440f14e3716" args="" -->
34
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>PACKET_BUFFER_SIZE</b>&nbsp;&nbsp;&nbsp;250</td></tr>
35
<tr><td colspan="2"><h2>Functions</h2></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga6a8d6179b1fe27f762937f0b47af2009">wl_init</a> (void)</td></tr>
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize wireless.  <a href="#ga6a8d6179b1fe27f762937f0b47af2009"></a><br/></td></tr>
38
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga223f437c2bc8ab8a3ac2e0e06841120f">wl_terminate</a> (void)</td></tr>
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminate wireless.  <a href="#ga223f437c2bc8ab8a3ac2e0e06841120f"></a><br/></td></tr>
40
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga7aa57c04f65ff3c8fec591248ab82f86">wl_register_handler</a> (uint8_t group, FNPTR, uint8_t priority)</td></tr>
41
<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>
42
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga376508d5682b1b8c88ef8b5f911a3367">wl_unregister_handler</a> (uint8_t group)</td></tr>
43
<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>
44
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaa5a965e3443e4b2b60243225c50ecca7">wl_get</a> (char *data, uint8_t length)</td></tr>
45
<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>
46
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gae2509e2b6bc61faa26d87b1d87881817">wl_get_basic</a> (char *data, uint8_t length)</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next basic packet if available.  <a href="#gae2509e2b6bc61faa26d87b1d87881817"></a><br/></td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae91c1e1940dfbbd063fdcfb86049c64a"></a><!-- doxytag: member="wireless::wl_dispatch" ref="gae91c1e1940dfbbd063fdcfb86049c64a" args="(void)" -->
49
int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gae91c1e1940dfbbd063fdcfb86049c64a">wl_dispatch</a> (void)</td></tr>
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dispatches packets for registered handlers. <br/></td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.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>
52
<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>
53
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gab0af7308304aed74eb281188b712e132">wl_send_global</a> (uint8_t *data, uint8_t length, uint8_t group)</td></tr>
54
<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>
55
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga85cd4090dd284a4747dc8a56c1b215ad">wl_send_pan</a> (uint8_t *data, uint8_t length, uint8_t group)</td></tr>
56
<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>
57
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga49160840045fda872a5e38432cc26988">wl_send_robot</a> (uint8_t *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)</td></tr>
58
<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>
59
<tr><td class="memItemLeft" align="right" valign="top">int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga226d89acb4f77a982a2167eb1773eff2">wl_send_basic</a> (uint8_t *data, uint8_t length)</td></tr>
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default (i.e. basic) send wrapper.  <a href="#ga226d89acb4f77a982a2167eb1773eff2"></a><br/></td></tr>
61
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga15c9a01839696beb05d1e4f161d968b7">wl_ack_error</a> (void)</td></tr>
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of acknowledgment errors.  <a href="#ga15c9a01839696beb05d1e4f161d968b7"></a><br/></td></tr>
63
<tr><td class="memItemLeft" align="right" valign="top">int8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#gaa364aa4d9cc8c789f05401e8adf44785">wl_ack_check</a> (uint8_t packet)</td></tr>
64
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks a specific packet for the acknowledgement status.  <a href="#gaa364aa4d9cc8c789f05401e8adf44785"></a><br/></td></tr>
65
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wireless.html#ga62e126abfcd382ec02524dd2f45a8a7b">wl_ack_reset</a> (void)</td></tr>
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets acknowledgement statistics back to zero.  <a href="#ga62e126abfcd382ec02524dd2f45a8a7b"></a><br/></td></tr>
72 67
</table>
73
<hr><a name="_details"></a><h2>Detailed Description</h2>
74
Interface with the wireless library. <hr><h2>Function Documentation</h2>
75
<a class="anchor" name="ga364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless_send.c::wl_ack_check" ref="ga364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" -->
68
<hr/><a name="_details"></a><h2>Detailed Description</h2>
69
<p>Interface with the wireless library. </p>
70
<hr/><h2>Function Documentation</h2>
71
<a class="anchor" id="gaa364aa4d9cc8c789f05401e8adf44785"></a><!-- doxytag: member="wireless_send.c::wl_ack_check" ref="gaa364aa4d9cc8c789f05401e8adf44785" args="(uint8_t packet)" -->
76 72
<div class="memitem">
77 73
<div class="memproto">
78 74
      <table class="memname">
79 75
        <tr>
80
          <td class="memname">int8_t wl_ack_check           </td>
76
          <td class="memname">int8_t wl_ack_check </td>
81 77
          <td>(</td>
82 78
          <td class="paramtype">uint8_t&nbsp;</td>
83
          <td class="paramname"> <em>packet</em>          </td>
79
          <td class="paramname"> <em>packet</em></td>
84 80
          <td>&nbsp;)&nbsp;</td>
85 81
          <td></td>
86 82
        </tr>
......
88 84
</div>
89 85
<div class="memdoc">
90 86

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

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

  
100 99
</div>
101
</div><p>
102
<a class="anchor" name="g11aeeac54834f0357794ae60a7513acf"></a><!-- doxytag: member="wireless_send.c::wl_ack_error" ref="g11aeeac54834f0357794ae60a7513acf" args="(void)" -->
100
</div>
101
<a class="anchor" id="ga15c9a01839696beb05d1e4f161d968b7"></a><!-- doxytag: member="wireless_send.c::wl_ack_error" ref="ga15c9a01839696beb05d1e4f161d968b7" args="(void)" -->
103 102
<div class="memitem">
104 103
<div class="memproto">
105 104
      <table class="memname">
106 105
        <tr>
107
          <td class="memname">int8_t wl_ack_error           </td>
106
          <td class="memname">uint8_t wl_ack_error </td>
108 107
          <td>(</td>
109 108
          <td class="paramtype">void&nbsp;</td>
110
          <td class="paramname">          </td>
109
          <td class="paramname"></td>
111 110
          <td>&nbsp;)&nbsp;</td>
112 111
          <td></td>
113 112
        </tr>
......
115 114
</div>
116 115
<div class="memdoc">
117 116

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

  
123 122
</div>
124
</div><p>
125
<a class="anchor" name="g62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless_send.c::wl_ack_reset" ref="g62e126abfcd382ec02524dd2f45a8a7b" args="(void)" -->
123
</div>
124
<a class="anchor" id="ga62e126abfcd382ec02524dd2f45a8a7b"></a><!-- doxytag: member="wireless_send.c::wl_ack_reset" ref="ga62e126abfcd382ec02524dd2f45a8a7b" args="(void)" -->
126 125
<div class="memitem">
127 126
<div class="memproto">
128 127
      <table class="memname">
129 128
        <tr>
130
          <td class="memname">void wl_ack_reset           </td>
129
          <td class="memname">void wl_ack_reset </td>
131 130
          <td>(</td>
132 131
          <td class="paramtype">void&nbsp;</td>
133
          <td class="paramname">          </td>
132
          <td class="paramname"></td>
134 133
          <td>&nbsp;)&nbsp;</td>
135 134
          <td></td>
136 135
        </tr>
......
138 137
</div>
139 138
<div class="memdoc">
140 139

  
141
<p>
142
acknowledgement reset reset the acknowledgement buffer 
140
<p>Resets acknowledgement statistics back to zero. </p>
141
<p>acknowledgement reset reset the acknowledgement buffer </p>
142

  
143 143
</div>
144
</div><p>
145
<a class="anchor" name="ga5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless_receive.c::wl_get" ref="ga5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" -->
144
</div>
145
<a class="anchor" id="gaa5a965e3443e4b2b60243225c50ecca7"></a><!-- doxytag: member="wireless_receive.c::wl_get" ref="gaa5a965e3443e4b2b60243225c50ecca7" args="(char *data, uint8_t length)" -->
146 146
<div class="memitem">
147 147
<div class="memproto">
148 148
      <table class="memname">
149 149
        <tr>
150
          <td class="memname">int8_t wl_get           </td>
150
          <td class="memname">int8_t wl_get </td>
151 151
          <td>(</td>
152 152
          <td class="paramtype">char *&nbsp;</td>
153 153
          <td class="paramname"> <em>data</em>, </td>
......
167 167
</div>
168 168
<div class="memdoc">
169 169

  
170
<p>
171
the main receive function (similar to wl_do)<p>
172
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>
173
<dl compact><dt><b>Parameters:</b></dt><dd>
170
<p>The main receive function. Dispatches packets for registered handlers and returns next basic packet if available. </p>
171
<p>the main receive function (similar to wl_do)</p>
172
<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>
173
<dl><dt><b>Parameters:</b></dt><dd>
174 174
  <table border="0" cellspacing="2" cellpadding="0">
175 175
    <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>
176 176
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the initialized data array</td></tr>
177 177
  </table>
178
  </dd>
178 179
</dl>
179
<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>
180
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (&lt;0) </dd></dl>
180 181

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

  
181 184
</div>
182
</div><p>
183
<a class="anchor" name="ge2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless_receive.c::wl_get_basic" ref="ge2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" -->
185
</div>
186
<a class="anchor" id="gae2509e2b6bc61faa26d87b1d87881817"></a><!-- doxytag: member="wireless_receive.c::wl_get_basic" ref="gae2509e2b6bc61faa26d87b1d87881817" args="(char *data, uint8_t length)" -->
184 187
<div class="memitem">
185 188
<div class="memproto">
186 189
      <table class="memname">
187 190
        <tr>
188
          <td class="memname">int8_t wl_get_basic           </td>
191
          <td class="memname">int8_t wl_get_basic </td>
189 192
          <td>(</td>
190 193
          <td class="paramtype">char *&nbsp;</td>
191 194
          <td class="paramname"> <em>data</em>, </td>
......
205 208
</div>
206 209
<div class="memdoc">
207 210

  
208
<p>
209
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>
210
<dl compact><dt><b>Parameters:</b></dt><dd>
211
<p>Returns the next basic packet if available. </p>
212
<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>
213
<dl><dt><b>Parameters:</b></dt><dd>
211 214
  <table border="0" cellspacing="2" cellpadding="0">
212 215
    <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>
213 216
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the initialized data array</td></tr>
214 217
  </table>
218
  </dd>
215 219
</dl>
216
<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>
220
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the used portion of data array or error (&lt;0) </dd></dl>
217 221

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

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

  
218 226
</div>
219
</div><p>
220
<a class="anchor" name="g6a8d6179b1fe27f762937f0b47af2009"></a><!-- doxytag: member="wireless.c::wl_init" ref="g6a8d6179b1fe27f762937f0b47af2009" args="(void)" -->
227
</div>
228
<a class="anchor" id="ga6a8d6179b1fe27f762937f0b47af2009"></a><!-- doxytag: member="wireless.c::wl_init" ref="ga6a8d6179b1fe27f762937f0b47af2009" args="(void)" -->
221 229
<div class="memitem">
222 230
<div class="memproto">
223 231
      <table class="memname">
224 232
        <tr>
225
          <td class="memname">int8_t wl_init           </td>
233
          <td class="memname">int8_t wl_init </td>
226 234
          <td>(</td>
227 235
          <td class="paramtype">void&nbsp;</td>
228
          <td class="paramname">          </td>
236
          <td class="paramname"></td>
229 237
          <td>&nbsp;)&nbsp;</td>
230 238
          <td></td>
231 239
        </tr>
......
233 241
</div>
234 242
<div class="memdoc">
235 243

  
236
<p>
237
initialization function: set up xbee communication and packet handler infrastructure<p>
238
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
244
<p>Initialize wireless. </p>
245
<p>initialization function: set up xbee communication and packet handler infrastructure</p>
246
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
239 247

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

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

  
273
<p>
274
function to register new packet handlers (for non-default groups only)<p>
275
<dl compact><dt><b>Parameters:</b></dt><dd>
283
<p>Function to register new packet handlers (for non-default groups only). </p>
284
<p>function to register new packet handlers (for non-default groups only)</p>
285
<dl><dt><b>Parameters:</b></dt><dd>
276 286
  <table border="0" cellspacing="2" cellpadding="0">
277 287
    <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>
278 288
    <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>
279 289
    <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>
280 290
  </table>
291
  </dd>
281 292
</dl>
282
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
293
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
283 294

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

  
284 297
</div>
285
</div><p>
286
<a class="anchor" name="gf0c80262c96d3410bf0f1266871ffe3e"></a><!-- doxytag: member="wireless_send.c::wl_send" ref="gf0c80262c96d3410bf0f1266871ffe3e" args="(char *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)" -->
298
</div>
299
<a class="anchor" id="gaf713b6ecbf2de78139990a40fe864d5e"></a><!-- doxytag: member="wireless_send.c::wl_send" ref="gaf713b6ecbf2de78139990a40fe864d5e" args="(uint8_t *data, uint8_t length, uint8_t group, uint8_t scope, uint16_t dest, uint8_t mode)" -->
287 300
<div class="memitem">
288 301
<div class="memproto">
289 302
      <table class="memname">
290 303
        <tr>
291
          <td class="memname">int16_t wl_send           </td>
304
          <td class="memname">int16_t wl_send </td>
292 305
          <td>(</td>
293
          <td class="paramtype">char *&nbsp;</td>
306
          <td class="paramtype">uint8_t *&nbsp;</td>
294 307
          <td class="paramname"> <em>data</em>, </td>
295 308
        </tr>
296 309
        <tr>
......
332 345
</div>
333 346
<div class="memdoc">
334 347

  
335
<p>
336
The core send function. This will take all possible arguments and send all types of packets.<p>
337
<dl compact><dt><b>Parameters:</b></dt><dd>
348
<p>The core send function. This will take all possible arguments and send all types of packets. </p>
349
<p>The core send function. This will take all possible arguments and send all types of packets.</p>
350
<dl><dt><b>Parameters:</b></dt><dd>
338 351
  <table border="0" cellspacing="2" cellpadding="0">
339 352
    <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>
340 353
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
......
343 356
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>robot ID (for robot to robot packet) </td></tr>
344 357
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>flag for using FAST or RELIABLE sending</td></tr>
345 358
  </table>
359
  </dd>
346 360
</dl>
347
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
361
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code </dd></dl>
348 362

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

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

  
349 367
</div>
350
</div><p>
351
<a class="anchor" name="g461b4558be666fefb9bf41edfd5ea500"></a><!-- doxytag: member="wireless_send.c::wl_send_basic" ref="g461b4558be666fefb9bf41edfd5ea500" args="(char *data, uint8_t length)" -->
368
</div>
369
<a class="anchor" id="ga226d89acb4f77a982a2167eb1773eff2"></a><!-- doxytag: member="wireless_send.c::wl_send_basic" ref="ga226d89acb4f77a982a2167eb1773eff2" args="(uint8_t *data, uint8_t length)" -->
352 370
<div class="memitem">
353 371
<div class="memproto">
354 372
      <table class="memname">
355 373
        <tr>
356
          <td class="memname">int16_t wl_send_basic           </td>
374
          <td class="memname">int16_t wl_send_basic </td>
357 375
          <td>(</td>
358
          <td class="paramtype">char *&nbsp;</td>
376
          <td class="paramtype">uint8_t *&nbsp;</td>
359 377
          <td class="paramname"> <em>data</em>, </td>
360 378
        </tr>
361 379
        <tr>
......
373 391
</div>
374 392
<div class="memdoc">
375 393

  
376
<p>
377
Default (i.e. basic) send wrapper.<p>
378
<dl compact><dt><b>Parameters:</b></dt><dd>
394
<p>Default (i.e. basic) send wrapper. </p>
395
<p>Default (i.e. basic) send wrapper.</p>
396
<dl><dt><b>Parameters:</b></dt><dd>
379 397
  <table border="0" cellspacing="2" cellpadding="0">
380 398
    <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>
381 399
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array</td></tr>
382 400
  </table>
401
  </dd>
383 402
</dl>
384
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
403
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
385 404

  
405
<p><p>Check if it needs to adjust according to data type. </p>
406
</p>
407

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

  
386 410
</div>
387
</div><p>
388
<a class="anchor" name="g48e2d69b71010e23ca5c7b2de595ae4f"></a><!-- doxytag: member="wireless_send.c::wl_send_global" ref="g48e2d69b71010e23ca5c7b2de595ae4f" args="(char *data, uint8_t length, uint8_t group)" -->
411
</div>
412
<a class="anchor" id="gab0af7308304aed74eb281188b712e132"></a><!-- doxytag: member="wireless_send.c::wl_send_global" ref="gab0af7308304aed74eb281188b712e132" args="(uint8_t *data, uint8_t length, uint8_t group)" -->
389 413
<div class="memitem">
390 414
<div class="memproto">
391 415
      <table class="memname">
392 416
        <tr>
393
          <td class="memname">int16_t wl_send_global           </td>
417
          <td class="memname">int16_t wl_send_global </td>
394 418
          <td>(</td>
395
          <td class="paramtype">char *&nbsp;</td>
419
          <td class="paramtype">uint8_t *&nbsp;</td>
396 420
          <td class="paramname"> <em>data</em>, </td>
397 421
        </tr>
398 422
        <tr>
......
416 440
</div>
417 441
<div class="memdoc">
418 442

  
419
<p>
420
Wrapper for core send function that will send a global packet across the current channel.<p>
421
<dl compact><dt><b>Parameters:</b></dt><dd>
443
<p>Wrapper for core send function that will send a global packet across the current channel. </p>
444
<p>Wrapper for core send function that will send a global packet across the current channel.</p>
445
<dl><dt><b>Parameters:</b></dt><dd>
422 446
  <table border="0" cellspacing="2" cellpadding="0">
423 447
    <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>
424 448
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
425 449
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group of the packet</td></tr>
426 450
  </table>
451
  </dd>
427 452
</dl>
428
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
453
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code </dd></dl>
429 454

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

  
430 457
</div>
431
</div><p>
432
<a class="anchor" name="gaef3438cea00f6f3d3de16d54ec33d51"></a><!-- doxytag: member="wireless_send.c::wl_send_pan" ref="gaef3438cea00f6f3d3de16d54ec33d51" args="(char *data, uint8_t length, uint8_t group)" -->
458
</div>
459
<a class="anchor" id="ga85cd4090dd284a4747dc8a56c1b215ad"></a><!-- doxytag: member="wireless_send.c::wl_send_pan" ref="ga85cd4090dd284a4747dc8a56c1b215ad" args="(uint8_t *data, uint8_t length, uint8_t group)" -->
433 460
<div class="memitem">
434 461
<div class="memproto">
435 462
      <table class="memname">
436 463
        <tr>
437
          <td class="memname">int16_t wl_send_pan           </td>
464
          <td class="memname">int16_t wl_send_pan </td>
438 465
          <td>(</td>
439
          <td class="paramtype">char *&nbsp;</td>
466
          <td class="paramtype">uint8_t *&nbsp;</td>
440 467
          <td class="paramname"> <em>data</em>, </td>
441 468
        </tr>
442 469
        <tr>
......
460 487
</div>
461 488
<div class="memdoc">
462 489

  
463
<p>
464
Wrapper for core send function that will send a packet across the current channel on the current pan.<p>
465
<dl compact><dt><b>Parameters:</b></dt><dd>
490
<p>Wrapper for core send function that will send a packet across the current channel on the current pan. </p>
491
<p>Wrapper for core send function that will send a packet across the current channel on the current pan.</p>
492
<dl><dt><b>Parameters:</b></dt><dd>
466 493
  <table border="0" cellspacing="2" cellpadding="0">
467 494
    <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>
468 495
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
469 496
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>the packet group of the packet</td></tr>
470 497
  </table>
498
  </dd>
471 499
</dl>
472
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
500
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
473 501

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

  
474 504
</div>
475
</div><p>
476
<a class="anchor" name="g4a728d521deae8f12b9d40a62027600b"></a><!-- doxytag: member="wireless_send.c::wl_send_robot" ref="g4a728d521deae8f12b9d40a62027600b" args="(char *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)" -->
505
</div>
506
<a class="anchor" id="ga49160840045fda872a5e38432cc26988"></a><!-- doxytag: member="wireless_send.c::wl_send_robot" ref="ga49160840045fda872a5e38432cc26988" args="(uint8_t *data, uint8_t length, uint8_t group, uint16_t dest, uint8_t mode)" -->
477 507
<div class="memitem">
478 508
<div class="memproto">
479 509
      <table class="memname">
480 510
        <tr>
481
          <td class="memname">int16_t wl_send_robot           </td>
511
          <td class="memname">int16_t wl_send_robot </td>
482 512
          <td>(</td>
483
          <td class="paramtype">char *&nbsp;</td>
513
          <td class="paramtype">uint8_t *&nbsp;</td>
484 514
          <td class="paramname"> <em>data</em>, </td>
485 515
        </tr>
486 516
        <tr>
......
516 546
</div>
517 547
<div class="memdoc">
518 548

  
519
<p>
520
Wrapper for core send function that will send a packet across the current channel to a specific robot.<p>
521
<dl compact><dt><b>Parameters:</b></dt><dd>
549
<p>Wrapper for core send function that will send a packet across the current channel to a specific robot. </p>
550
<p>Wrapper for core send function that will send a packet across the current channel to a specific robot.</p>
551
<dl><dt><b>Parameters:</b></dt><dd>
522 552
  <table border="0" cellspacing="2" cellpadding="0">
523 553
    <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>
524 554
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the data array </td></tr>
......
526 556
    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>robot ID (for robot to robot packet) </td></tr>
527 557
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>flag for using FAST or RELIABLE sending</td></tr>
528 558
  </table>
559
  </dd>
529 560
</dl>
530
<dl class="return" compact><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
561
<dl class="return"><dt><b>Returns:</b></dt><dd>positive packet number for tracking acks, or error code (TBD) </dd></dl>
531 562

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

  
532 565
</div>
533
</div><p>
534
<a class="anchor" name="g223f437c2bc8ab8a3ac2e0e06841120f"></a><!-- doxytag: member="wireless.c::wl_terminate" ref="g223f437c2bc8ab8a3ac2e0e06841120f" args="(void)" -->
566
</div>
567
<a class="anchor" id="ga223f437c2bc8ab8a3ac2e0e06841120f"></a><!-- doxytag: member="wireless.c::wl_terminate" ref="ga223f437c2bc8ab8a3ac2e0e06841120f" args="(void)" -->
535 568
<div class="memitem">
536 569
<div class="memproto">
537 570
      <table class="memname">
538 571
        <tr>
539
          <td class="memname">int8_t wl_terminate           </td>
572
          <td class="memname">int8_t wl_terminate </td>
540 573
          <td>(</td>
541 574
          <td class="paramtype">void&nbsp;</td>
542
          <td class="paramname">          </td>
575
          <td class="paramname"></td>
543 576
          <td>&nbsp;)&nbsp;</td>
544 577
          <td></td>
545 578
        </tr>
......
547 580
</div>
548 581
<div class="memdoc">
549 582

  
550
<p>
551
termination function: end xbee communication, deregister all handlers, etc<p>
552
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
583
<p>Terminate wireless. </p>
584
<p>termination function: end xbee communication, deregister all handlers, etc</p>
585
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
553 586

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

  
554 589
</div>
555
</div><p>
556 590
</div>
557
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Nov 24 12:45:55 2009 for Colony by&nbsp;
591
<a class="anchor" id="ga376508d5682b1b8c88ef8b5f911a3367"></a><!-- doxytag: member="wireless.c::wl_unregister_handler" ref="ga376508d5682b1b8c88ef8b5f911a3367" args="(uint8_t group)" -->
592
<div class="memitem">
593
<div class="memproto">
594
      <table class="memname">
595
        <tr>
596
          <td class="memname">int8_t wl_unregister_handler </td>
597
          <td>(</td>
598
          <td class="paramtype">uint8_t&nbsp;</td>
599
          <td class="paramname"> <em>group</em></td>
600
          <td>&nbsp;)&nbsp;</td>
601
          <td></td>
602
        </tr>
603
      </table>
604
</div>
605
<div class="memdoc">
606

  
607
<p>Function to unregister existing packet handlers (for non-default groups only). </p>
608
<p>function to unregister existing packet handlers (for non-default groups only)</p>
609
<dl><dt><b>Parameters:</b></dt><dd>
610
  <table border="0" cellspacing="2" cellpadding="0">
611
    <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>
612
  </table>
613
  </dd>
614
</dl>
615
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, or error code </dd></dl>
616

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

  
619
</div>
620
</div>
621
</div>
622
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu May 6 13:17:00 2010 for libwireless by&nbsp;
558 623
<a href="http://www.doxygen.org/index.html">
559
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
624
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
560 625
</body>
561 626
</html>

Also available in: Unified diff