| User | Revision | Line number | New contents of line |
|---|
| dan_ackme |
10:735194df0097
|
1
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
| dan_ackme |
10:735194df0097
|
2
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
| dan_ackme |
10:735194df0097
|
3
|
<head>
|
| dan_ackme |
10:735194df0097
|
4
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
| dan_ackme |
10:735194df0097
|
5
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
| dan_ackme |
10:735194df0097
|
6
|
<meta name="generator" content="Doxygen 1.8.7"/>
|
| dan_ackme |
10:735194df0097
|
7
|
<title>WiConnect Library: Miscellaneous</title>
|
| dan_ackme |
10:735194df0097
|
8
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
| dan_ackme |
10:735194df0097
|
9
|
<script type="text/javascript" src="jquery.js"></script>
|
| dan_ackme |
10:735194df0097
|
10
|
<script type="text/javascript" src="dynsections.js"></script>
|
| dan_ackme |
10:735194df0097
|
11
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
| dan_ackme |
10:735194df0097
|
12
|
<script type="text/javascript" src="resize.js"></script>
|
| dan_ackme |
10:735194df0097
|
13
|
<script type="text/javascript" src="navtree.js"></script>
|
| dan_ackme |
10:735194df0097
|
14
|
<script type="text/javascript">
|
| dan_ackme |
10:735194df0097
|
15
|
$(document).ready(initResizable);
|
| dan_ackme |
10:735194df0097
|
16
|
$(window).load(resizeHeight);
|
| dan_ackme |
10:735194df0097
|
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 |
10:735194df0097
|
23
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
| dan_ackme |
10:735194df0097
|
24
|
</head>
|
| dan_ackme |
10:735194df0097
|
25
|
<body>
|
| dan_ackme |
10:735194df0097
|
26
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
| dan_ackme |
10:735194df0097
|
27
|
<div id="titlearea">
|
| dan_ackme |
10:735194df0097
|
28
|
<table cellspacing="0" cellpadding="0">
|
| dan_ackme |
10:735194df0097
|
29
|
<tbody>
|
| dan_ackme |
10:735194df0097
|
30
|
<tr style="height: 56px;">
|
| dan_ackme |
10:735194df0097
|
31
|
<td style="padding-left: 0.5em;">
|
| dan_ackme |
10:735194df0097
|
32
|
<div id="projectname">WiConnect Library
|
| dan_ackme |
10:735194df0097
|
33
|
</div>
|
| dan_ackme |
10:735194df0097
|
34
|
</td>
|
| dan_ackme |
10:735194df0097
|
35
|
</tr>
|
| dan_ackme |
10:735194df0097
|
36
|
</tbody>
|
| dan_ackme |
10:735194df0097
|
37
|
</table>
|
| dan_ackme |
10:735194df0097
|
38
|
</div>
|
| dan_ackme |
10:735194df0097
|
39
|
<!-- end header part -->
|
| dan_ackme |
10:735194df0097
|
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 |
10:735194df0097
|
44
|
<div id="navrow1" class="tabs">
|
| dan_ackme |
10:735194df0097
|
45
|
<ul class="tablist">
|
| dan_ackme |
10:735194df0097
|
46
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
| dan_ackme |
10:735194df0097
|
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 |
10:735194df0097
|
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 |
10:735194df0097
|
66
|
</ul>
|
| dan_ackme |
10:735194df0097
|
67
|
</div>
|
| dan_ackme |
10:735194df0097
|
68
|
</div><!-- top -->
|
| dan_ackme |
10:735194df0097
|
69
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
| dan_ackme |
10:735194df0097
|
70
|
<div id="nav-tree">
|
| dan_ackme |
10:735194df0097
|
71
|
<div id="nav-tree-contents">
|
| dan_ackme |
10:735194df0097
|
72
|
<div id="nav-sync" class="sync"></div>
|
| dan_ackme |
10:735194df0097
|
73
|
</div>
|
| dan_ackme |
10:735194df0097
|
74
|
</div>
|
| dan_ackme |
10:735194df0097
|
75
|
<div id="splitbar" style="-moz-user-select:none;"
|
| dan_ackme |
10:735194df0097
|
76
|
class="ui-resizable-handle">
|
| dan_ackme |
10:735194df0097
|
77
|
</div>
|
| dan_ackme |
10:735194df0097
|
78
|
</div>
|
| dan_ackme |
10:735194df0097
|
79
|
<script type="text/javascript">
|
| dan_ackme |
10:735194df0097
|
80
|
$(document).ready(function(){initNavTree('group__api__core__misc.html','');});
|
| dan_ackme |
10:735194df0097
|
81
|
</script>
|
| dan_ackme |
10:735194df0097
|
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 |
10:735194df0097
|
97
|
<div class="header">
|
| dan_ackme |
10:735194df0097
|
98
|
<div class="summary">
|
| dan_ackme |
10:735194df0097
|
99
|
<a href="#func-members">Functions</a> </div>
|
| dan_ackme |
10:735194df0097
|
100
|
<div class="headertitle">
|
| dan_ackme |
10:735194df0097
|
101
|
<div class="title">Miscellaneous<div class="ingroups"><a class="el" href="group__api__core.html">Core API</a></div></div> </div>
|
| dan_ackme |
10:735194df0097
|
102
|
</div><!--header-->
|
| dan_ackme |
10:735194df0097
|
103
|
<div class="contents">
|
| dan_ackme |
10:735194df0097
|
104
|
|
| dan_ackme |
10:735194df0097
|
105
|
<p>Other core API methods.
|
| dan_ackme |
10:735194df0097
|
106
|
<a href="#details">More...</a></p>
|
| dan_ackme |
10:735194df0097
|
107
|
<table class="memberdecls">
|
| dan_ackme |
10:735194df0097
|
108
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
| dan_ackme |
10:735194df0097
|
109
|
Functions</h2></td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
110
|
<tr class="memitem:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">wiconnect::Wiconnect::getInstance</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
111
|
<tr class="memdesc:ga8dcd3ac87afd58b225abb068e835d06e"><td class="mdescLeft"> </td><td class="mdescRight">Get instance of previously instantiated <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library. <a href="#ga8dcd3ac87afd58b225abb068e835d06e">More...</a><br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
112
|
<tr class="separator:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
113
|
<tr class="memitem:gad62e847c65166134a361d68b5c95e57c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">wiconnect::Wiconnect::init</a> (bool bringNetworkUp)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
114
|
<tr class="memdesc:gad62e847c65166134a361d68b5c95e57c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize library and communication link with WiConnect WiFi module. <a href="#gad62e847c65166134a361d68b5c95e57c">More...</a><br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
115
|
<tr class="separator:gad62e847c65166134a361d68b5c95e57c"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
116
|
<tr class="memitem:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9d6c981a54c6ab964b469e4f247142d6"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
117
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">wiconnect::Wiconnect::deinit</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
118
|
<tr class="memdesc:ga9d6c981a54c6ab964b469e4f247142d6"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize library. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
119
|
<tr class="separator:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
10:735194df0097
|
120
|
<tr class="memitem:gab00c7110984f6d6187241d17a4a431ff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">wiconnect::Wiconnect::isInitialized</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
121
|
<tr class="memdesc:gab00c7110984f6d6187241d17a4a431ff"><td class="mdescLeft"> </td><td class="mdescRight">Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else. <a href="#gab00c7110984f6d6187241d17a4a431ff">More...</a><br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
122
|
<tr class="separator:gab00c7110984f6d6187241d17a4a431ff"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
123
|
<tr class="memitem:gabec1504eb7f486085dad82c4a94310e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">wiconnect::Wiconnect::reset</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
124
|
<tr class="memdesc:gabec1504eb7f486085dad82c4a94310e3"><td class="mdescLeft"> </td><td class="mdescRight">Toggle the WiConnect WiFi module reset signal. <a href="#gabec1504eb7f486085dad82c4a94310e3">More...</a><br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
125
|
<tr class="separator:gabec1504eb7f486085dad82c4a94310e3"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
126
|
<tr class="memitem:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wiconnect::Wiconnect::wakeup</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
127
|
<tr class="memdesc:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="mdescLeft"> </td><td class="mdescRight">Toggle the WiConnect WiFi moduel wakeup signal. <a href="#gad552c8f23dd0a0e8844ee1fc4d9358e5">More...</a><br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
128
|
<tr class="separator:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
129
|
<tr class="memitem:ga96ac50d85d8ab376755d7d5325de1713"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga96ac50d85d8ab376755d7d5325de1713"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
130
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">wiconnect::Wiconnect::flush</a> (int <a class="el" href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3">delayMs</a>=500)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
131
|
<tr class="memdesc:ga96ac50d85d8ab376755d7d5325de1713"><td class="mdescLeft"> </td><td class="mdescRight">Flush any received data in serial RX buffer and terminate any commands on WiConnect WiFi module. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
132
|
<tr class="separator:ga96ac50d85d8ab376755d7d5325de1713"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
133
|
<tr class="memitem:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4fc195839bc6c6bd0091074cbdc94c4f"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
134
|
<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">wiconnect::Wiconnect::getVersion</a> (char *versionBuffer=NULL, int versionBufferSize=0, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
135
|
<tr class="memdesc:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="mdescLeft"> </td><td class="mdescRight">Return current version of WiConnect WiFi module. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
136
|
<tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
137
|
<tr class="memitem:gad8069679fabb52d44647d27703f1a09a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad8069679fabb52d44647d27703f1a09a"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
138
|
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">wiconnect::Wiconnect::getLastCommandResponseCodeStr</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
139
|
<tr class="memdesc:gad8069679fabb52d44647d27703f1a09a"><td class="mdescLeft"> </td><td class="mdescRight">When the WiConnect WiFi module returns a response, it contains a response code in the header. This function converts the previous response code to a readable string. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
140
|
<tr class="separator:gad8069679fabb52d44647d27703f1a09a"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
141
|
<tr class="memitem:ga600215de23210071c42996d04390071e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga600215de23210071c42996d04390071e"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
142
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">wiconnect::Wiconnect::getLastCommandResponseLength</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
143
|
<tr class="memdesc:ga600215de23210071c42996d04390071e"><td class="mdescLeft"> </td><td class="mdescRight">Return the length in bytes of the previous response. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
144
|
<tr class="separator:ga600215de23210071c42996d04390071e"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
145
|
<tr class="memitem:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga27b5d6b8207e4ef0f73875606d628da8"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
146
|
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">wiconnect::Wiconnect::getResponseBuffer</a> ()</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
147
|
<tr class="memdesc:ga27b5d6b8207e4ef0f73875606d628da8"><td class="mdescLeft"> </td><td class="mdescRight">Return pointer to internal response buffer. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
148
|
<tr class="separator:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
149
|
<tr class="memitem:gac40b2964149e60245ff3cac6adbcd565"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac40b2964149e60245ff3cac6adbcd565"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
150
|
<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">wiconnect::Wiconnect::responseToUint32</a> (uint32_t *uint32Ptr)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
151
|
<tr class="memdesc:gac40b2964149e60245ff3cac6adbcd565"><td class="mdescLeft"> </td><td class="mdescRight">Helper method to convert previous response to uint32. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
152
|
<tr class="separator:gac40b2964149e60245ff3cac6adbcd565"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
153
|
<tr class="memitem:gada79343aece515e00f9be4045d3858a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gada79343aece515e00f9be4045d3858a0"></a>
|
| dan_ackme |
11:ea484e1b7fc4
|
154
|
<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">wiconnect::Wiconnect::responseToInt32</a> (int32_t *int32Ptr)</td></tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
155
|
<tr class="memdesc:gada79343aece515e00f9be4045d3858a0"><td class="mdescLeft"> </td><td class="mdescRight">Helper method to convert previous response to int32. <br /></td></tr>
|
| dan_ackme |
10:735194df0097
|
156
|
<tr class="separator:gada79343aece515e00f9be4045d3858a0"><td class="memSeparator" colspan="2"> </td></tr>
|
| dan_ackme |
10:735194df0097
|
157
|
</table>
|
| dan_ackme |
10:735194df0097
|
158
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
| dan_ackme |
10:735194df0097
|
159
|
<p>Other core API methods. </p>
|
| dan_ackme |
10:735194df0097
|
160
|
<h2 class="groupheader">Function Documentation</h2>
|
| dan_ackme |
10:735194df0097
|
161
|
<a class="anchor" id="ga8dcd3ac87afd58b225abb068e835d06e"></a>
|
| dan_ackme |
10:735194df0097
|
162
|
<div class="memitem">
|
| dan_ackme |
10:735194df0097
|
163
|
<div class="memproto">
|
| dan_ackme |
10:735194df0097
|
164
|
<table class="mlabels">
|
| dan_ackme |
10:735194df0097
|
165
|
<tr>
|
| dan_ackme |
10:735194df0097
|
166
|
<td class="mlabels-left">
|
| dan_ackme |
10:735194df0097
|
167
|
<table class="memname">
|
| dan_ackme |
10:735194df0097
|
168
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
169
|
<td class="memname">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a>* wiconnect::Wiconnect::getInstance </td>
|
| dan_ackme |
10:735194df0097
|
170
|
<td>(</td>
|
| dan_ackme |
10:735194df0097
|
171
|
<td class="paramname"></td><td>)</td>
|
| dan_ackme |
10:735194df0097
|
172
|
<td></td>
|
| dan_ackme |
10:735194df0097
|
173
|
</tr>
|
| dan_ackme |
10:735194df0097
|
174
|
</table>
|
| dan_ackme |
10:735194df0097
|
175
|
</td>
|
| dan_ackme |
10:735194df0097
|
176
|
<td class="mlabels-right">
|
| dan_ackme |
10:735194df0097
|
177
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
| dan_ackme |
10:735194df0097
|
178
|
</tr>
|
| dan_ackme |
10:735194df0097
|
179
|
</table>
|
| dan_ackme |
10:735194df0097
|
180
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
181
|
|
| dan_ackme |
11:ea484e1b7fc4
|
182
|
<p>Get instance of previously instantiated <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library. </p>
|
| dan_ackme |
10:735194df0097
|
183
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to instance of <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> Library. </dd></dl>
|
| dan_ackme |
10:735194df0097
|
184
|
|
| dan_ackme |
10:735194df0097
|
185
|
</div>
|
| dan_ackme |
10:735194df0097
|
186
|
</div>
|
| dan_ackme |
10:735194df0097
|
187
|
<a class="anchor" id="gad62e847c65166134a361d68b5c95e57c"></a>
|
| dan_ackme |
10:735194df0097
|
188
|
<div class="memitem">
|
| dan_ackme |
10:735194df0097
|
189
|
<div class="memproto">
|
| dan_ackme |
10:735194df0097
|
190
|
<table class="memname">
|
| dan_ackme |
10:735194df0097
|
191
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
192
|
<td class="memname"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::init </td>
|
| dan_ackme |
10:735194df0097
|
193
|
<td>(</td>
|
| dan_ackme |
10:735194df0097
|
194
|
<td class="paramtype">bool </td>
|
| dan_ackme |
10:735194df0097
|
195
|
<td class="paramname"><em>bringNetworkUp</em></td><td>)</td>
|
| dan_ackme |
10:735194df0097
|
196
|
<td></td>
|
| dan_ackme |
10:735194df0097
|
197
|
</tr>
|
| dan_ackme |
10:735194df0097
|
198
|
</table>
|
| dan_ackme |
10:735194df0097
|
199
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
200
|
|
| dan_ackme |
11:ea484e1b7fc4
|
201
|
<p>Initialize library and communication link with WiConnect WiFi module. </p>
|
| dan_ackme |
10:735194df0097
|
202
|
<dl class="section note"><dt>Note</dt><dd>This function is always blocking regardless of configured mode.</dd></dl>
|
| dan_ackme |
10:735194df0097
|
203
|
<dl class="params"><dt>Parameters</dt><dd>
|
| dan_ackme |
10:735194df0097
|
204
|
<table class="params">
|
| dan_ackme |
10:735194df0097
|
205
|
<tr><td class="paramdir">[in]</td><td class="paramname">bringNetworkUp</td><td>Flag indicating if the module should try to bring the network up upon initialization. </td></tr>
|
| dan_ackme |
10:735194df0097
|
206
|
</table>
|
| dan_ackme |
10:735194df0097
|
207
|
</dd>
|
| dan_ackme |
10:735194df0097
|
208
|
</dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
209
|
<dl class="section return"><dt>Returns</dt><dd>Result of initialization. See <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
|
| dan_ackme |
10:735194df0097
|
210
|
|
| dan_ackme |
10:735194df0097
|
211
|
</div>
|
| dan_ackme |
10:735194df0097
|
212
|
</div>
|
| dan_ackme |
10:735194df0097
|
213
|
<a class="anchor" id="gab00c7110984f6d6187241d17a4a431ff"></a>
|
| dan_ackme |
10:735194df0097
|
214
|
<div class="memitem">
|
| dan_ackme |
10:735194df0097
|
215
|
<div class="memproto">
|
| dan_ackme |
10:735194df0097
|
216
|
<table class="memname">
|
| dan_ackme |
10:735194df0097
|
217
|
<tr>
|
| dan_ackme |
10:735194df0097
|
218
|
<td class="memname">bool wiconnect::Wiconnect::isInitialized </td>
|
| dan_ackme |
10:735194df0097
|
219
|
<td>(</td>
|
| dan_ackme |
10:735194df0097
|
220
|
<td class="paramname"></td><td>)</td>
|
| dan_ackme |
10:735194df0097
|
221
|
<td></td>
|
| dan_ackme |
10:735194df0097
|
222
|
</tr>
|
| dan_ackme |
10:735194df0097
|
223
|
</table>
|
| dan_ackme |
10:735194df0097
|
224
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
225
|
|
| dan_ackme |
11:ea484e1b7fc4
|
226
|
<p>Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else. </p>
|
| dan_ackme |
10:735194df0097
|
227
|
<dl class="section return"><dt>Returns</dt><dd>TRUE if library can communicate with WiFi module, FALSE else. </dd></dl>
|
| dan_ackme |
10:735194df0097
|
228
|
|
| dan_ackme |
10:735194df0097
|
229
|
</div>
|
| dan_ackme |
10:735194df0097
|
230
|
</div>
|
| dan_ackme |
10:735194df0097
|
231
|
<a class="anchor" id="gabec1504eb7f486085dad82c4a94310e3"></a>
|
| dan_ackme |
10:735194df0097
|
232
|
<div class="memitem">
|
| dan_ackme |
10:735194df0097
|
233
|
<div class="memproto">
|
| dan_ackme |
10:735194df0097
|
234
|
<table class="memname">
|
| dan_ackme |
10:735194df0097
|
235
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
236
|
<td class="memname"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::reset </td>
|
| dan_ackme |
10:735194df0097
|
237
|
<td>(</td>
|
| dan_ackme |
10:735194df0097
|
238
|
<td class="paramname"></td><td>)</td>
|
| dan_ackme |
10:735194df0097
|
239
|
<td></td>
|
| dan_ackme |
10:735194df0097
|
240
|
</tr>
|
| dan_ackme |
10:735194df0097
|
241
|
</table>
|
| dan_ackme |
10:735194df0097
|
242
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
243
|
|
| dan_ackme |
11:ea484e1b7fc4
|
244
|
<p>Toggle the WiConnect WiFi module reset signal. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
245
|
<dl class="section note"><dt>Note</dt><dd>This only resets the module if the library was instantiated with the 'reset' pin parameter in the <a class="el" href="group__types__core.html#ga285510a2cba5341db387101ac75a4389" title="WiConnect class constructor. ">Wiconnect::Wiconnect</a> constructor. </dd>
|
| dan_ackme |
10:735194df0097
|
246
|
<dd>
|
| dan_ackme |
10:735194df0097
|
247
|
This method is always blocking. A small (1s) delay is added to ensure the module has returned from reset and ready.</dd></dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
248
|
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
|
| dan_ackme |
10:735194df0097
|
249
|
|
| dan_ackme |
10:735194df0097
|
250
|
</div>
|
| dan_ackme |
10:735194df0097
|
251
|
</div>
|
| dan_ackme |
10:735194df0097
|
252
|
<a class="anchor" id="gad552c8f23dd0a0e8844ee1fc4d9358e5"></a>
|
| dan_ackme |
10:735194df0097
|
253
|
<div class="memitem">
|
| dan_ackme |
10:735194df0097
|
254
|
<div class="memproto">
|
| dan_ackme |
10:735194df0097
|
255
|
<table class="memname">
|
| dan_ackme |
10:735194df0097
|
256
|
<tr>
|
| dan_ackme |
11:ea484e1b7fc4
|
257
|
<td class="memname"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::wakeup </td>
|
| dan_ackme |
10:735194df0097
|
258
|
<td>(</td>
|
| dan_ackme |
10:735194df0097
|
259
|
<td class="paramname"></td><td>)</td>
|
| dan_ackme |
10:735194df0097
|
260
|
<td></td>
|
| dan_ackme |
10:735194df0097
|
261
|
</tr>
|
| dan_ackme |
10:735194df0097
|
262
|
</table>
|
| dan_ackme |
10:735194df0097
|
263
|
</div><div class="memdoc">
|
| dan_ackme |
11:ea484e1b7fc4
|
264
|
|
| dan_ackme |
11:ea484e1b7fc4
|
265
|
<p>Toggle the WiConnect WiFi moduel wakeup signal. </p>
|
| dan_ackme |
11:ea484e1b7fc4
|
266
|
<dl class="section note"><dt>Note</dt><dd>This only wakes the module if the library was instantiated with the 'wake' pin parameter in the <a class="el" href="group__types__core.html#ga285510a2cba5341db387101ac75a4389" title="WiConnect class constructor. ">Wiconnect::Wiconnect</a> constructor. </dd>
|
| dan_ackme |
10:735194df0097
|
267
|
<dd>
|
| dan_ackme |
10:735194df0097
|
268
|
This method is always blocking.</dd></dl>
|
| dan_ackme |
11:ea484e1b7fc4
|
269
|
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
|
| dan_ackme |
10:735194df0097
|
270
|
|
| dan_ackme |
10:735194df0097
|
271
|
</div>
|
| dan_ackme |
10:735194df0097
|
272
|
</div>
|
| dan_ackme |
10:735194df0097
|
273
|
</div><!-- contents -->
|
| dan_ackme |
10:735194df0097
|
274
|
</div><!-- doc-content -->
|
| dan_ackme |
10:735194df0097
|
275
|
<!-- start footer part -->
|
| dan_ackme |
10:735194df0097
|
276
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
| dan_ackme |
10:735194df0097
|
277
|
<ul>
|
| dan_ackme |
11:ea484e1b7fc4
|
278
|
<li class="footer">Generated on Tue Aug 12 2014 02:15:21 for WiConnect Library by
|
| dan_ackme |
10:735194df0097
|
279
|
<a href="http://www.doxygen.org/index.html">
|
| dan_ackme |
10:735194df0097
|
280
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
|
| dan_ackme |
10:735194df0097
|
281
|
</ul>
|
| dan_ackme |
10:735194df0097
|
282
|
</div>
|
| dan_ackme |
10:735194df0097
|
283
|
</body>
|
| dan_ackme |
10:735194df0097
|
284
|
</html>
|
ACKme
AMW006-A02