| User | Revision | Line number | New contents of line |
|---|
| dan_ackme |
11:ea484e1b7fc4
|
1
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
| dan_ackme |
11:ea484e1b7fc4
|
2
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
| dan_ackme |
11:ea484e1b7fc4
|
3
|
<head>
|
| dan_ackme |
11:ea484e1b7fc4
|
4
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
5
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
6
|
<meta name="generator" content="Doxygen 1.8.7"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
7
|
<title>WiConnect Library: Core API</title>
|
| dan_ackme |
11:ea484e1b7fc4
|
8
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
9
|
<script type="text/javascript" src="jquery.js"></script>
|
| dan_ackme |
11:ea484e1b7fc4
|
10
|
<script type="text/javascript" src="dynsections.js"></script>
|
| dan_ackme |
11:ea484e1b7fc4
|
11
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
12
|
<script type="text/javascript" src="resize.js"></script>
|
| dan_ackme |
11:ea484e1b7fc4
|
13
|
<script type="text/javascript" src="navtree.js"></script>
|
| dan_ackme |
11:ea484e1b7fc4
|
14
|
<script type="text/javascript">
|
| dan_ackme |
11:ea484e1b7fc4
|
15
|
$(document).ready(initResizable);
|
| dan_ackme |
11:ea484e1b7fc4
|
16
|
$(window).load(resizeHeight);
|
| dan_ackme |
11:ea484e1b7fc4
|
17
|
</script>
|
| dan_ackme |
11:ea484e1b7fc4
|
18
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
19
|
<script type="text/javascript" src="search/search.js"></script>
|
| dan_ackme |
11:ea484e1b7fc4
|
20
|
<script type="text/javascript">
|
| dan_ackme |
11:ea484e1b7fc4
|
21
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
| dan_ackme |
11:ea484e1b7fc4
|
22
|
</script>
|
| dan_ackme |
11:ea484e1b7fc4
|
23
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
| dan_ackme |
11:ea484e1b7fc4
|
24
|
</head>
|
| dan_ackme |
11:ea484e1b7fc4
|
25
|
<body>
|
| dan_ackme |
11:ea484e1b7fc4
|
26
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
| dan_ackme |
11:ea484e1b7fc4
|
27
|
<div id="titlearea">
|
| dan_ackme |
11:ea484e1b7fc4
|
28
|
<table cellspacing="0" cellpadding="0">
|
| dan_ackme |
11:ea484e1b7fc4
|
29
|
<tbody>
|
| dan_ackme |
11:ea484e1b7fc4
|
30
|
<tr style="height: 56px;">
|
| dan_ackme |
11:ea484e1b7fc4
|
31
|
<td style="padding-left: 0.5em;">
|
| dan_ackme |
11:ea484e1b7fc4
|
32
|
<div id="projectname">WiConnect Library
|
| dan_ackme |
11:ea484e1b7fc4
|
33
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
34
|
</td>
|
| dan_ackme |
11:ea484e1b7fc4
|
35
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
36
|
</tbody>
|
| dan_ackme |
11:ea484e1b7fc4
|
37
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
38
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
39
|
<!-- end header part -->
|
| dan_ackme |
11:ea484e1b7fc4
|
40
|
<!-- Generated by Doxygen 1.8.7 -->
|
| dan_ackme |
11:ea484e1b7fc4
|
41
|
<script type="text/javascript">
|
| dan_ackme |
11:ea484e1b7fc4
|
42
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
| dan_ackme |
11:ea484e1b7fc4
|
43
|
</script>
|
| dan_ackme |
11:ea484e1b7fc4
|
44
|
<div id="navrow1" class="tabs">
|
| dan_ackme |
11:ea484e1b7fc4
|
45
|
<ul class="tablist">
|
| dan_ackme |
11:ea484e1b7fc4
|
46
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
47
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
48
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
49
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
| dan_ackme |
11:ea484e1b7fc4
|
50
|
<li>
|
| dan_ackme |
11:ea484e1b7fc4
|
51
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
| dan_ackme |
11:ea484e1b7fc4
|
52
|
<span class="left">
|
| dan_ackme |
11:ea484e1b7fc4
|
53
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
| dan_ackme |
11:ea484e1b7fc4
|
54
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
| dan_ackme |
11:ea484e1b7fc4
|
55
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
| dan_ackme |
11:ea484e1b7fc4
|
56
|
alt=""/>
|
| dan_ackme |
11:ea484e1b7fc4
|
57
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
| dan_ackme |
11:ea484e1b7fc4
|
58
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
| dan_ackme |
11:ea484e1b7fc4
|
59
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
| dan_ackme |
11:ea484e1b7fc4
|
60
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
| dan_ackme |
11:ea484e1b7fc4
|
61
|
</span><span class="right">
|
| dan_ackme |
11:ea484e1b7fc4
|
62
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
63
|
</span>
|
| dan_ackme |
11:ea484e1b7fc4
|
64
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
65
|
</li>
|
| dan_ackme |
11:ea484e1b7fc4
|
66
|
</ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
67
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
68
|
</div><!-- top -->
|
| dan_ackme |
11:ea484e1b7fc4
|
69
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
| dan_ackme |
11:ea484e1b7fc4
|
70
|
<div id="nav-tree">
|
| dan_ackme |
11:ea484e1b7fc4
|
71
|
<div id="nav-tree-contents">
|
| dan_ackme |
11:ea484e1b7fc4
|
72
|
<div id="nav-sync" class="sync"></div>
|
| dan_ackme |
11:ea484e1b7fc4
|
73
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
74
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
75
|
<div id="splitbar" style="-moz-user-select:none;"
|
| dan_ackme |
11:ea484e1b7fc4
|
76
|
class="ui-resizable-handle">
|
| dan_ackme |
11:ea484e1b7fc4
|
77
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
78
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
79
|
<script type="text/javascript">
|
| dan_ackme |
11:ea484e1b7fc4
|
80
|
$(document).ready(function(){initNavTree('group__types__core.html','');});
|
| dan_ackme |
11:ea484e1b7fc4
|
81
|
</script>
|
| dan_ackme |
11:ea484e1b7fc4
|
82
|
<div id="doc-content">
|
| dan_ackme |
11:ea484e1b7fc4
|
83
|
<!-- window showing the filter options -->
|
| dan_ackme |
11:ea484e1b7fc4
|
84
|
<div id="MSearchSelectWindow"
|
| dan_ackme |
11:ea484e1b7fc4
|
85
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
| dan_ackme |
11:ea484e1b7fc4
|
86
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
| dan_ackme |
11:ea484e1b7fc4
|
87
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
| dan_ackme |
11:ea484e1b7fc4
|
88
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
|
| dan_ackme |
11:ea484e1b7fc4
|
89
|
|
| dan_ackme |
11:ea484e1b7fc4
|
90
|
<!-- iframe showing the search results (closed by default) -->
|
| dan_ackme |
11:ea484e1b7fc4
|
91
|
<div id="MSearchResultsWindow">
|
| dan_ackme |
11:ea484e1b7fc4
|
92
|
<iframe src="javascript:void(0)" frameborder="0"
|
| dan_ackme |
11:ea484e1b7fc4
|
93
|
name="MSearchResults" id="MSearchResults">
|
| dan_ackme |
11:ea484e1b7fc4
|
94
|
</iframe>
|
| dan_ackme |
11:ea484e1b7fc4
|
95
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
96
|
|
| dan_ackme |
11:ea484e1b7fc4
|
97
|
<div class="header">
|
| dan_ackme |
11:ea484e1b7fc4
|
98
|
<div class="summary">
|
| dan_ackme |
11:ea484e1b7fc4
|
99
|
<a href="#nested-classes">Classes</a> |
|
| dan_ackme |
11:ea484e1b7fc4
|
100
|
<a href="#typedef-members">Typedefs</a> |
|
| dan_ackme |
11:ea484e1b7fc4
|
101
|
<a href="#enum-members">Enumerations</a> |
|
| dan_ackme |
11:ea484e1b7fc4
|
102
|
<a href="#func-members">Functions</a> </div>
|
| dan_ackme |
11:ea484e1b7fc4
|
103
|
<div class="headertitle">
|
| dan_ackme |
11:ea484e1b7fc4
|
104
|
<div class="title">Core API<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div>
|
| dan_ackme |
11:ea484e1b7fc4
|
105
|
</div><!--header-->
|
| dan_ackme |
11:ea484e1b7fc4
|
106
|
<div class="contents">
|
| dan_ackme |
11:ea484e1b7fc4
|
107
|
|
| dan_ackme |
11:ea484e1b7fc4
|
108
|
<p>Core API Types.
|
| dan_ackme |
11:ea484e1b7fc4
|
109
|
<a href="#details">More...</a></p>
|
| dan_ackme |
11:ea484e1b7fc4
|
110
|
<table class="memberdecls">
|
| dan_ackme |
11:ea484e1b7fc4
|
111
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
112
|
Classes</h2></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
113
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
114
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The root WiConnect library class. This class inheriets all WiConnect functionality. <a href="classwiconnect_1_1_wiconnect.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
115
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
116
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_buffer.html">wiconnect::Buffer</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
117
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic buffer type. <a href="structwiconnect_1_1_buffer.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
118
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
119
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
120
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic callback function. <a href="classwiconnect_1_1_callback.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
121
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
122
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_function_pointer.html">wiconnect::FunctionPointer</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
123
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic function pointer. <a href="classwiconnect_1_1_function_pointer.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
124
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
125
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_log_func.html">wiconnect::LogFunc</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
126
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Logging callback function. <a href="classwiconnect_1_1_log_func.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
127
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
128
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_queued_command.html">wiconnect::QueuedCommand</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
129
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class which contains command for asynchronous processing. <a href="classwiconnect_1_1_queued_command.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
130
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
131
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_reader_func.html">wiconnect::ReaderFunc</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
132
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic data reading callback function. <a href="classwiconnect_1_1_reader_func.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
133
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
134
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1___serial_config.html">wiconnect::_SerialConfig</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
135
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Host<-><a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. <a href="structwiconnect_1_1___serial_config.html#details">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
136
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
137
|
</table><table class="memberdecls">
|
| dan_ackme |
11:ea484e1b7fc4
|
138
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
139
|
Typedefs</h2></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
140
|
<tr class="memitem:gaadd4d5e6774e21f382c20b594a644470"><td class="memItemLeft" align="right" valign="top">typedef int8_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#gaadd4d5e6774e21f382c20b594a644470">wiconnect::PinToGpioMapper</a> )(Pin pin)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
141
|
<tr class="memdesc:gaadd4d5e6774e21f382c20b594a644470"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer for mapping from a host pin to a WiConnect Module GPIO. <a href="#gaadd4d5e6774e21f382c20b594a644470">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
142
|
<tr class="separator:gaadd4d5e6774e21f382c20b594a644470"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
143
|
<tr class="memitem:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1cf4dfa71da0b0dc3dc707dacf56cc9c"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
144
|
typedef PinName </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
145
|
<tr class="memdesc:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="mdescLeft"> </td><td class="mdescRight">Pin name on HOST. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
146
|
<tr class="separator:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
147
|
<tr class="memitem:gaef13192ccd0895903ea42e83427b13b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaef13192ccd0895903ea42e83427b13b4"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
148
|
typedef struct <br class="typebreak" />
|
| dan_ackme |
11:ea484e1b7fc4
|
149
|
<a class="el" href="structwiconnect_1_1___serial_config.html">wiconnect::_SerialConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">wiconnect::SerialConfig</a></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
150
|
<tr class="memdesc:gaef13192ccd0895903ea42e83427b13b4"><td class="mdescLeft"> </td><td class="mdescRight">Host<-><a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. <br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
151
|
<tr class="separator:gaef13192ccd0895903ea42e83427b13b4"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
152
|
</table><table class="memberdecls">
|
| dan_ackme |
11:ea484e1b7fc4
|
153
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
154
|
Enumerations</h2></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
155
|
<tr class="memitem:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a> { <br />
|
| dan_ackme |
11:ea484e1b7fc4
|
156
|
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789">wiconnect::WICONNECT_ABORTED</a> = 3,
|
| dan_ackme |
11:ea484e1b7fc4
|
157
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1">wiconnect::WICONNECT_IDLE</a> = 2,
|
| dan_ackme |
11:ea484e1b7fc4
|
158
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">wiconnect::WICONNECT_PROCESSING</a> = 1,
|
| dan_ackme |
11:ea484e1b7fc4
|
159
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a> = 0,
|
| dan_ackme |
11:ea484e1b7fc4
|
160
|
<br />
|
| dan_ackme |
11:ea484e1b7fc4
|
161
|
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6">wiconnect::WICONNECT_ERROR</a> = -1,
|
| dan_ackme |
11:ea484e1b7fc4
|
162
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff">wiconnect::WICONNECT_CMD_RESPONSE_ERROR</a> = -2,
|
| dan_ackme |
11:ea484e1b7fc4
|
163
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5">wiconnect::WICONNECT_NULL_BUFFER</a> = -3,
|
| dan_ackme |
11:ea484e1b7fc4
|
164
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43">wiconnect::WICONNECT_NOT_INITIALIZED</a> = -4,
|
| dan_ackme |
11:ea484e1b7fc4
|
165
|
<br />
|
| dan_ackme |
11:ea484e1b7fc4
|
166
|
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f">wiconnect::WICONNECT_OVERFLOW</a> = -5,
|
| dan_ackme |
11:ea484e1b7fc4
|
167
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac">wiconnect::WICONNECT_TIMEOUT</a> = -6,
|
| dan_ackme |
11:ea484e1b7fc4
|
168
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5">wiconnect::WICONNECT_RESPONSE_PARSE_ERROR</a> = -8,
|
| dan_ackme |
11:ea484e1b7fc4
|
169
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83">wiconnect::WICONNECT_ANOTHER_CMD_EXECUTING</a> = -9,
|
| dan_ackme |
11:ea484e1b7fc4
|
170
|
<br />
|
| dan_ackme |
11:ea484e1b7fc4
|
171
|
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa">wiconnect::WICONNECT_BAD_ARG</a> = -10,
|
| dan_ackme |
11:ea484e1b7fc4
|
172
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc">wiconnect::WICONNECT_UNSUPPORTED</a> = -11,
|
| dan_ackme |
11:ea484e1b7fc4
|
173
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff">wiconnect::WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL</a> = -12,
|
| dan_ackme |
11:ea484e1b7fc4
|
174
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">wiconnect::WICONNECT_DUPLICATE</a> = -13,
|
| dan_ackme |
11:ea484e1b7fc4
|
175
|
<br />
|
| dan_ackme |
11:ea484e1b7fc4
|
176
|
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">wiconnect::WICONNECT_NOT_FOUND</a> = -14,
|
| dan_ackme |
11:ea484e1b7fc4
|
177
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a">wiconnect::WICONNECT_PINNAME_TO_GPIO_NO_MAPPING</a> = -15,
|
| dan_ackme |
11:ea484e1b7fc4
|
178
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2">wiconnect::WICONNECT_NOT_CONNECTED</a> = -16,
|
| dan_ackme |
11:ea484e1b7fc4
|
179
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02">wiconnect::WICONNECT_UNDERFLOW</a> = -17,
|
| dan_ackme |
11:ea484e1b7fc4
|
180
|
<br />
|
| dan_ackme |
11:ea484e1b7fc4
|
181
|
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e">wiconnect::WICONNECT_MONITOR_NOT_AVAILABLE</a> = -18,
|
| dan_ackme |
11:ea484e1b7fc4
|
182
|
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2">wiconnect::WICONNECT_NOT_OPENED_FOR_READING</a> = -19
|
| dan_ackme |
11:ea484e1b7fc4
|
183
|
<br />
|
| dan_ackme |
11:ea484e1b7fc4
|
184
|
}</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
185
|
<tr class="memdesc:ga325637ed501728bd6c8c7a7982b9ce05"><td class="mdescLeft"> </td><td class="mdescRight">API Result code. <a href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
186
|
<tr class="separator:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
187
|
</table><table class="memberdecls">
|
| dan_ackme |
11:ea484e1b7fc4
|
188
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
189
|
Functions</h2></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
190
|
<tr class="memitem:ga285510a2cba5341db387101ac75a4389"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#ga285510a2cba5341db387101ac75a4389">wiconnect::Wiconnect::Wiconnect</a> (const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> &serialConfig, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> reset=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> wake=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, bool nonBlocking=<a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
191
|
<tr class="memdesc:ga285510a2cba5341db387101ac75a4389"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect class constructor. <a href="#ga285510a2cba5341db387101ac75a4389">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
192
|
<tr class="separator:ga285510a2cba5341db387101ac75a4389"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
193
|
<tr class="memitem:gad39105b9aa5858c3b3bbf81b2cebcd30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#gad39105b9aa5858c3b3bbf81b2cebcd30">wiconnect::Wiconnect::Wiconnect</a> (const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> &serialConfig, void *internalBuffer, int internalBufferSize, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> reset=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> wake=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, bool nonBlocking=<a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
194
|
<tr class="memdesc:gad39105b9aa5858c3b3bbf81b2cebcd30"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect class constructor. <a href="#gad39105b9aa5858c3b3bbf81b2cebcd30">More...</a><br /></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
195
|
<tr class="separator:gad39105b9aa5858c3b3bbf81b2cebcd30"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
196
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
197
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
| dan_ackme |
11:ea484e1b7fc4
|
198
|
<p>Core API Types. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
199
|
<h2 class="groupheader">Typedef Documentation</h2>
|
| dan_ackme |
11:ea484e1b7fc4
|
200
|
<a class="anchor" id="gaadd4d5e6774e21f382c20b594a644470"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
201
|
<div class="memitem">
|
| dan_ackme |
11:ea484e1b7fc4
|
202
|
<div class="memproto">
|
| dan_ackme |
11:ea484e1b7fc4
|
203
|
<table class="memname">
|
| dan_ackme |
11:ea484e1b7fc4
|
204
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
205
|
<td class="memname">typedef int8_t(* wiconnect::PinToGpioMapper)(Pin pin)</td>
|
| dan_ackme |
11:ea484e1b7fc4
|
206
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
207
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
208
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
209
|
|
| dan_ackme |
11:ea484e1b7fc4
|
210
|
<p>Function pointer for mapping from a host pin to a WiConnect Module GPIO. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
211
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
212
|
<table class="params">
|
| dan_ackme |
11:ea484e1b7fc4
|
213
|
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>A host pin </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
214
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
215
|
</dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
216
|
</dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
217
|
<dl class="section return"><dt>Returns</dt><dd>The corresponding WiConnect Module GPIO (which the given pin is physically connected). Return -1 if no mapping is available. </dd></dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
218
|
|
| dan_ackme |
11:ea484e1b7fc4
|
219
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
220
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
221
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
| dan_ackme |
11:ea484e1b7fc4
|
222
|
<a class="anchor" id="ga325637ed501728bd6c8c7a7982b9ce05"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
223
|
<div class="memitem">
|
| dan_ackme |
11:ea484e1b7fc4
|
224
|
<div class="memproto">
|
| dan_ackme |
11:ea484e1b7fc4
|
225
|
<table class="memname">
|
| dan_ackme |
11:ea484e1b7fc4
|
226
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
227
|
<td class="memname">enum <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
228
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
229
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
230
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
231
|
|
| dan_ackme |
11:ea484e1b7fc4
|
232
|
<p>API Result code. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
233
|
<table class="fieldtable">
|
| dan_ackme |
11:ea484e1b7fc4
|
234
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789"></a>WICONNECT_ABORTED </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
235
|
<p>Command was aborted. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
236
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
237
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1"></a>WICONNECT_IDLE </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
238
|
<p>Library not processing any commands. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
239
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
240
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0"></a>WICONNECT_PROCESSING </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
241
|
<p>Library processing current command. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
242
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
243
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"></a>WICONNECT_SUCCESS </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
244
|
<p>Command successfully completed. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
245
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
246
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6"></a>WICONNECT_ERROR </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
247
|
<p>Generic error. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
248
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
249
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff"></a>WICONNECT_CMD_RESPONSE_ERROR </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
250
|
<p>Module returned error code. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
251
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
252
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5"></a>WICONNECT_NULL_BUFFER </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
253
|
<p>Null buffer supplied. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
254
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
255
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43"></a>WICONNECT_NOT_INITIALIZED </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
256
|
<p>Library not initialed. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
257
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
258
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f"></a>WICONNECT_OVERFLOW </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
259
|
<p><a class="el" href="structwiconnect_1_1_buffer.html" title="Generic buffer type. ">Buffer</a> overflowed. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
260
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
261
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac"></a>WICONNECT_TIMEOUT </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
262
|
<p>Command timed out. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
263
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
264
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5"></a>WICONNECT_RESPONSE_PARSE_ERROR </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
265
|
<p>Failed to parse module response. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
266
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
267
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83"></a>WICONNECT_ANOTHER_CMD_EXECUTING </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
268
|
<p>Currently executing another command. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
269
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
270
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa"></a>WICONNECT_BAD_ARG </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
271
|
<p>Bad argument supplied. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
272
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
273
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc"></a>WICONNECT_UNSUPPORTED </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
274
|
<p>Command / parameter not supported. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
275
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
276
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff"></a>WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
277
|
<p>The pinToGpioMapper hasn't been set. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
278
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
279
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4"></a>WICONNECT_DUPLICATE </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
280
|
<p>Duplicate value. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
281
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
282
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195"></a>WICONNECT_NOT_FOUND </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
283
|
<p>Not found. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
284
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
285
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a"></a>WICONNECT_PINNAME_TO_GPIO_NO_MAPPING </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
286
|
<p>No mapping found for given pin. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
287
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
288
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2"></a>WICONNECT_NOT_CONNECTED </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
289
|
<p>Not connected. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
290
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
291
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02"></a>WICONNECT_UNDERFLOW </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
292
|
<p>Data underflow. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
293
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
294
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e"></a>WICONNECT_MONITOR_NOT_AVAILABLE </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
295
|
<p>Background processing monitor is not available (i.e in use) </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
296
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
297
|
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2"></a>WICONNECT_NOT_OPENED_FOR_READING </td><td class="fielddoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
298
|
<p>The file is not open for reading. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
299
|
</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
300
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
301
|
|
| dan_ackme |
11:ea484e1b7fc4
|
302
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
303
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
304
|
<h2 class="groupheader">Function Documentation</h2>
|
| dan_ackme |
11:ea484e1b7fc4
|
305
|
<a class="anchor" id="ga285510a2cba5341db387101ac75a4389"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
306
|
<div class="memitem">
|
| dan_ackme |
11:ea484e1b7fc4
|
307
|
<div class="memproto">
|
| dan_ackme |
11:ea484e1b7fc4
|
308
|
<table class="memname">
|
| dan_ackme |
11:ea484e1b7fc4
|
309
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
310
|
<td class="memname">wiconnect::Wiconnect::Wiconnect </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
311
|
<td>(</td>
|
| dan_ackme |
11:ea484e1b7fc4
|
312
|
<td class="paramtype">const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> & </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
313
|
<td class="paramname"><em>serialConfig</em>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
314
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
315
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
316
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
317
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
318
|
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
319
|
<td class="paramname"><em>reset</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
320
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
321
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
322
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
323
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
324
|
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
325
|
<td class="paramname"><em>wake</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
326
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
327
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
328
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
329
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
330
|
<td class="paramtype">bool </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
331
|
<td class="paramname"><em>nonBlocking</em> = <code><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS</code> </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
332
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
333
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
334
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
335
|
<td>)</td>
|
| dan_ackme |
11:ea484e1b7fc4
|
336
|
<td></td><td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
337
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
338
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
339
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
340
|
|
| dan_ackme |
11:ea484e1b7fc4
|
341
|
<p>WiConnect class constructor. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
342
|
<dl class="section note"><dt>Note</dt><dd>This should only be called once within a program as the WiConnect library is implemented as a singleton.</dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
343
|
<dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
344
|
If this constructor is used, then all commands must be supplied with an external response buffer. This means most the API functions will not work as they use the internal buffer. It's recommended to use the other constructor that supplies an internal buffer. See <a class="el" href="index.html#setting_alloc">Dynamic / Static Allocation</a></dd></dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
345
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
346
|
<table class="params">
|
| dan_ackme |
11:ea484e1b7fc4
|
347
|
<tr><td class="paramdir">[in]</td><td class="paramname">serialConfig</td><td>The serial (i.e. UART) configuration connected to a WiConnect module. </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
348
|
<tr><td class="paramdir">[in]</td><td class="paramname">reset</td><td>Optional, The pin connected to the WiConnect module reset signal. Default: No connection </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
349
|
<tr><td class="paramdir">[in]</td><td class="paramname">wake</td><td>Optional, The pin connected to the WiConnect module wake signal. Default: No connection </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
350
|
<tr><td class="paramdir">[in]</td><td class="paramname">nonBlocking</td><td>Optional, indicates if the API blocking mode. See <a class="el" href="index.html#setting_blocking_modes">Blocking / Non-blocking Modes</a> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
351
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
352
|
</dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
353
|
</dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
354
|
|
| dan_ackme |
11:ea484e1b7fc4
|
355
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
356
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
357
|
<a class="anchor" id="gad39105b9aa5858c3b3bbf81b2cebcd30"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
358
|
<div class="memitem">
|
| dan_ackme |
11:ea484e1b7fc4
|
359
|
<div class="memproto">
|
| dan_ackme |
11:ea484e1b7fc4
|
360
|
<table class="memname">
|
| dan_ackme |
11:ea484e1b7fc4
|
361
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
362
|
<td class="memname">wiconnect::Wiconnect::Wiconnect </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
363
|
<td>(</td>
|
| dan_ackme |
11:ea484e1b7fc4
|
364
|
<td class="paramtype">const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> & </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
365
|
<td class="paramname"><em>serialConfig</em>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
366
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
367
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
368
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
369
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
370
|
<td class="paramtype">void * </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
371
|
<td class="paramname"><em>internalBuffer</em>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
372
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
373
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
374
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
375
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
376
|
<td class="paramtype">int </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
377
|
<td class="paramname"><em>internalBufferSize</em>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
378
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
379
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
380
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
381
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
382
|
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
383
|
<td class="paramname"><em>reset</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
384
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
385
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
386
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
387
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
388
|
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
389
|
<td class="paramname"><em>wake</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
390
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
391
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
392
|
<td class="paramkey"></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
393
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
394
|
<td class="paramtype">bool </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
395
|
<td class="paramname"><em>nonBlocking</em> = <code><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS</code> </td>
|
| dan_ackme |
11:ea484e1b7fc4
|
396
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
397
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
398
|
<td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
399
|
<td>)</td>
|
| dan_ackme |
11:ea484e1b7fc4
|
400
|
<td></td><td></td>
|
| dan_ackme |
11:ea484e1b7fc4
|
401
|
</tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
402
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
403
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
404
|
|
| dan_ackme |
11:ea484e1b7fc4
|
405
|
<p>WiConnect class constructor. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
406
|
<dl class="section note"><dt>Note</dt><dd>This should only be called once within a program as the WiConnect library is implemented as a singleton.</dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
407
|
<dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
408
|
This is the recommended construstor as it supplies the WiConnect library with an internal buffer. Most API calls require the internal buffer.</dd></dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
409
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
410
|
<table class="params">
|
| dan_ackme |
11:ea484e1b7fc4
|
411
|
<tr><td class="paramdir">[in]</td><td class="paramname">serialConfig</td><td>The serial (i.e. UART) configuration connected to a WiConnect module. </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
412
|
<tr><td class="paramdir">[in]</td><td class="paramname">internalBuffer</td><td>Optional, a user allocated buffer. See <a class="el" href="index.html#setting_alloc">Dynamic / Static Allocation</a> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
413
|
<tr><td class="paramdir">[in]</td><td class="paramname">internalBufferSize</td><td>The size of the internal buffer. If internalBuffer is NULL, then this size will be dynamically allocated. See <a class="el" href="index.html#setting_alloc">Dynamic / Static Allocation</a> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
414
|
<tr><td class="paramdir">[in]</td><td class="paramname">reset</td><td>Optional, The pin connected to the WiConnect module reset signal. Default: No connection </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
415
|
<tr><td class="paramdir">[in]</td><td class="paramname">wake</td><td>Optional, The pin connected to the WiConnect module wake signal. Default: No connection </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
416
|
<tr><td class="paramdir">[in]</td><td class="paramname">nonBlocking</td><td>Optional, indicates if the API blocking mode. See <a class="el" href="index.html#setting_blocking_modes">Blocking / Non-blocking Modes</a> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
417
|
</table>
|
| dan_ackme |
11:ea484e1b7fc4
|
418
|
</dd>
|
| dan_ackme |
11:ea484e1b7fc4
|
419
|
</dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
420
|
|
| dan_ackme |
11:ea484e1b7fc4
|
421
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
422
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
423
|
</div><!-- contents -->
|
| dan_ackme |
11:ea484e1b7fc4
|
424
|
</div><!-- doc-content -->
|
| dan_ackme |
11:ea484e1b7fc4
|
425
|
<!-- start footer part -->
|
| dan_ackme |
11:ea484e1b7fc4
|
426
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
| dan_ackme |
11:ea484e1b7fc4
|
427
|
<ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
428
|
<li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by
|
| dan_ackme |
11:ea484e1b7fc4
|
429
|
<a href="http://www.doxygen.org/index.html">
|
| dan_ackme |
11:ea484e1b7fc4
|
430
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
|
| dan_ackme |
11:ea484e1b7fc4
|
431
|
</ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
432
|
</div>
|
| dan_ackme |
11:ea484e1b7fc4
|
433
|
</body>
|
| dan_ackme |
11:ea484e1b7fc4
|
434
|
</html>
|
ACKme
AMW006-A02