Project

General

Profile

Statistics
| Revision:

root / branches / wireless / docs / libwireless / html / wireless_8h-source.html @ 1578

History | View | Annotate | Download (6.3 KB)

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>Colony: wireless.h Source File</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 -->
8 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="modules.html"><span>Modules</span></a></li>
13 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
14 
    </ul>
15 
  </div>
16 
  <div class="tabs">
17 
    <ul>
18 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19 
      <li><a href="globals.html"><span>Globals</span></a></li>
20 
    </ul>
21 
  </div>
22 
<h1>wireless.h</h1><a href="wireless_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
23 
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef WIRELESS_H</span>
24 
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define WIRELESS_H</span>
25 
<a name="l00038"></a>00038 <span class="preprocessor"></span>
26 
<a name="l00039"></a>00039 <span class="comment">// need this for C99 int types</span>
27 
<a name="l00040"></a>00040 <span class="preprocessor">#ifndef STDINT_H</span>
28 
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define STDINT_H</span>
29 
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#include &lt;stdint.h&gt;</span>
30 
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
31 
<a name="l00044"></a>00044 <span class="preprocessor"></span>
32 
<a name="l00045"></a>00045
33 
<a name="l00056"></a>00056 <span class="comment">// the init function</span>
34 
<a name="l00057"></a>00057
35 
<a name="l00059"></a>00059 int8_t <a class="code" href="group__wireless.html#g6a8d6179b1fe27f762937f0b47af2009" title="Initialize wireless.">wl_init</a>(<span class="keywordtype">void</span>);
36 
<a name="l00060"></a>00060
37 
<a name="l00062"></a>00062 int8_t <a class="code" href="group__wireless.html#g223f437c2bc8ab8a3ac2e0e06841120f" title="Terminate wireless.">wl_terminate</a>(<span class="keywordtype">void</span>);
38 
<a name="l00063"></a>00063
39 
<a name="l00064"></a>00064
40 
<a name="l00065"></a>00065 <span class="comment">// the send functions</span>
41 
<a name="l00066"></a>00066
42 
<a name="l00068"></a>00068 int8_t <a class="code" href="group__wireless.html#gaa4e0d7014a74d0d59c08f9fbbf40bd7" title="The core send function. This will take all possible arguments and send all types...">wl_send</a>(<span class="keywordtype">char</span> *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode);
43 
<a name="l00069"></a>00069
44 
<a name="l00071"></a>00071 int8_t <a class="code" href="group__wireless.html#gd92093466d82f3f0c732ffe8323228d2" title="Wrapper for core send function that will send a global packet across the current...">wl_send_global</a>(<span class="keywordtype">char</span> *data, uint8_t length, uint8_t group);
45 
<a name="l00072"></a>00072
46 
<a name="l00074"></a>00074 int8_t <a class="code" href="group__wireless.html#g7886c2a37b7350211699dcabe48ff076" title="Wrapper for core send function that will send a packet across the current channel...">wl_send_pan</a>(<span class="keywordtype">char</span> *data, uint8_t length, uint8_t group);
47 
<a name="l00075"></a>00075
48 
<a name="l00077"></a>00077 int8_t <a class="code" href="group__wireless.html#gbb08f7957bd0256c51f424fa770d3e60" title="Wrapper for core send function that will send a packet across the current channel...">wl_send_robot</a>(<span class="keywordtype">char</span> *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode);
49 
<a name="l00078"></a>00078
50 
<a name="l00080"></a>00080 int8_t <a class="code" href="group__wireless.html#ga8fb657e4d3bf7cb396f36e99fdd01a0" title="Default (i.e. basic) send wrapper.">wl_send_basic</a>(<span class="keywordtype">char</span> *data, uint8_t length);
51 
<a name="l00081"></a>00081
52 
<a name="l00082"></a>00082
53 
<a name="l00083"></a>00083 <span class="comment">// the ack function</span>
54 
<a name="l00084"></a>00084
55 
<a name="l00086"></a>00086 int8_t <a class="code" href="group__wireless.html#g11aeeac54834f0357794ae60a7513acf" title="Returns the number of acknowledgment errors, and resets number to zero.">wl_ack_error</a>(<span class="keywordtype">void</span>);
56 
<a name="l00087"></a>00087
57 
<a name="l00088"></a>00088
58 
<a name="l00089"></a>00089 <span class="comment">// the receive functions</span>
59 
<a name="l00090"></a>00090
60 
<a name="l00092"></a>00092 int8_t <a class="code" href="group__wireless.html#ga5a965e3443e4b2b60243225c50ecca7" title="The main receive function. Dispatches packets for registered handlers and returns...">wl_get</a>(<span class="keywordtype">char</span> *data, uint8_t length);
61 
<a name="l00093"></a>00093
62 
<a name="l00095"></a>00095 int8_t <a class="code" href="group__wireless.html#ge2509e2b6bc61faa26d87b1d87881817" title="Returns the next basic packet if available.">wl_get_basic</a>(<span class="keywordtype">char</span> *data, uint8_t length);
63 
<a name="l00096"></a>00096
64 
<a name="l00098"></a>00098 int8_t <a class="code" href="group__wireless.html#ge91c1e1940dfbbd063fdcfb86049c64a" title="Dispatches packets for registered handlers.">wl_dispatch</a>(<span class="keywordtype">void</span>);
65 
<a name="l00099"></a>00099
66 
<a name="l00100"></a>00100
67 
<a name="l00101"></a>00101 <span class="comment">// the group register function</span>
68 
<a name="l00102"></a>00102
69 
<a name="l00104"></a>00104 int8_t <a class="code" href="group__wireless.html#g8af34a6265a5d6af3a1525bb51e61d54" title="Function to register new packet handlers (for non-default groups only).">wl_register_handler</a>(uint8_t group, <span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>), uint8_t priority);
70 
<a name="l00105"></a>00105
71 
<a name="l00106"></a>00106  <span class="comment">//end defgroup</span>
72 
<a name="l00108"></a>00108
73 
<a name="l00109"></a>00109 <span class="preprocessor">#endif</span>
74 
</pre></div></div>
75 
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:16 2009 for Colony by&nbsp;
76 
<a href="http://www.doxygen.org/index.html">
77 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
78 
</body>
79 
</html>