ACKme
Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/html/_wiconnect_interface_8h_source.html
- Committer:
- dan_ackme
- Date:
- 2014-08-13
- Revision:
- 14:85a2ed029f37
- Child:
- 16:7f1d6d359787
File content as of revision 14:85a2ed029f37:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_wiconnect_interface_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">WiconnectInterface.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2014, ACKme Networks</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * written permission of ACKme Networks.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "WiconnectTypes.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "types/LogFunc.h"</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "types/ReaderFunc.h"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "types/Callback.h"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "types/QueuedCommand.h"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "types/CommandQueue.h"</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "types/TimeoutTimer.h"</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "types/PeriodicTimer.h"</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "types/Gpio.h"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "types/WiconnectSerial.h"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "NetworkInterface.h"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "SocketInterface.h"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "FileInterface.h"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef WICONNECT_ENABLE_MALLOC</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define WICONNECT_MALLOC_ARGS , void* (*malloc_)(size_t) = WICONNECT_DEFAULT_MALLOC, void (*free_)(void*) = WICONNECT_DEFAULT_FREE</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define WICONNECT_MALLOC_ARGS</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">namespace </span>wiconnect {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_wiconnect.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> : <span class="keyword">public</span> <a class="code" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a>,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span> <a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a>,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">public</span> <a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> &serialConfig, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> <a class="code" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a> = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> wake = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <span class="keywordtype">bool</span> nonBlocking = <a class="code" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> &serialConfig, <span class="keywordtype">int</span> internalBufferSize, <span class="keywordtype">void</span> *internalBuffer = NULL, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> <a class="code" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a> = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> wake = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <span class="keywordtype">bool</span> nonBlocking = <a class="code" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  ~<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a>();</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">static</span> <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a>* <a class="code" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">getInstance</a>();</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">init</a>(<span class="keywordtype">bool</span> bringNetworkUp);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">deinit</a>();</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">bool</span> <a class="code" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">isInitialized</a>();</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>();</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wakeup</a>();</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">flush</a>(<span class="keywordtype">int</span> <a class="code" href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3">delayMs</a> = 500);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">getVersion</a>(<span class="keywordtype">char</span> *versionBuffer = NULL, <span class="keywordtype">int</span> versionBufferSize = 0, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback = <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>());</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, <span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen,</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, va_list vaList);</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen, <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader,</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, va_list vaList);</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen, <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader,</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> </div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>( <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> </div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> </div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen, <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, <span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> </div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> </div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> </div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> </div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> </div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> </div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, va_list vaList);</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> </div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">checkCurrentCommand</a>();</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> </div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__send__command.html#ga4a9bd29de1d5c496fbcc28ecfa51e7c0">stopCurrentCommand</a>();</div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> </div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> </div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> </div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> </div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> </div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">getLastCommandResponseCodeStr</a>();</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> </div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  uint16_t <a class="code" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">getLastCommandResponseLength</a>();</div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> </div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  <span class="keywordtype">char</span>* <a class="code" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">getResponseBuffer</a>();</div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> </div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">responseToUint32</a>(uint32_t *uint32Ptr);</div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> </div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">responseToInt32</a>(int32_t *int32Ptr);</div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> </div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> </div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> </div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> </div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">setCommandDefaultTimeout</a>(<span class="keywordtype">int</span> timeoutMs);</div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> </div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  <span class="keywordtype">int</span> <a class="code" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">getCommandDefaultTimeout</a>();</div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> </div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">setPinToGpioMapper</a>(<a class="code" href="namespacewiconnect.html#aadd4d5e6774e21f382c20b594a644470">PinToGpioMapper</a> mapper);</div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> </div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">setDebugLogger</a>(<a class="code" href="classwiconnect_1_1_log_func.html">LogFunc</a> logFunc);</div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> </div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">setAssertLogger</a>(<a class="code" href="classwiconnect_1_1_log_func.html">LogFunc</a> assertLogFunc);</div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> </div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> </div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> </div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> </div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> </div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> enqueueCommand(<a class="code" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a> *command, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &commandCompleteHandler = <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>());</div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> </div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  <span class="keywordtype">void</span> setCommandProcessingPeriod(uint32_t periodMs);</div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> </div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span> </div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gac96e2d2fca60cba12e7429626f9186be">getWiconnectResultStr</a>(<a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnectResult);</div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> </div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> </div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="preprocessor">#ifdef WICONNECT_ENABLE_MALLOC</span></div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  <span class="keywordtype">void</span>* (*_malloc)(size_t);</div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span>  void (*_free)(<span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a>;</div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  <span class="keyword">friend</span> <span class="keyword">class </span>WiconnectSerial;</div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>;</div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a>;</div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_socket.html">Socket</a>;</div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file.html">File</a>;</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> </div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span>  wiconnect::WiconnectSerial serial;</div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>  wiconnect::Gpio resetGpio;</div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span>  wiconnect::Gpio wakeGpio;</div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> </div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> commandExecuting;</div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span>  <span class="keywordtype">bool</span> initialized;</div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>  <span class="keywordtype">bool</span> nonBlocking;</div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> </div>
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span>  <a class="code" href="namespacewiconnect.html#aadd4d5e6774e21f382c20b594a644470">PinToGpioMapper</a> pinToGpioMapper;</div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> </div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span>  <span class="keywordtype">char</span> *internalBuffer;</div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>  <span class="keywordtype">int</span> internalBufferSize;</div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  <span class="keywordtype">bool</span> internalBufferAlloc;</div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  uint8_t internalProcessingState;</div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span>  <span class="keywordtype">void</span> *currentCommandId;</div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> </div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span>  wiconnect::TimeoutTimer timeoutTimer;</div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span>  <span class="keywordtype">int</span> defaultTimeoutMs;</div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> </div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span>  uint8_t commandHeaderBuffer[32];</div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span>  <span class="keywordtype">char</span> commandFormatBuffer[<a class="code" href="group__api__core__macro.html#ga2aa16118029ab13ab41514cb8eb93ba7">WICONNECT_MAX_CMD_SIZE</a>];</div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span>  uint8_t commandContext[96];</div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> </div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span>  <span class="keywordtype">void</span> prepare(<span class="keywordtype">void</span> *internalBuffer, <span class="keywordtype">int</span> internalBufferSize, <span class="keywordtype">bool</span> nonBlocking);</div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <span class="keyword">inline</span> receiveResponse();</div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <span class="keyword">inline</span> receivePacket();</div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>  <span class="keywordtype">void</span> issueCommandCallback(<a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result);</div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> </div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  <a class="code" href="classwiconnect_1_1_log_func.html">LogFunc</a> debugLogger;</div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  <a class="code" href="classwiconnect_1_1_log_func.html">LogFunc</a> assertLogger;</div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>  <span class="keywordtype">void</span> debugLog(<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, ...);</div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> </div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>  wiconnect::PeriodicTimer commandProcessorTimer;</div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span>  uint32_t commandProcessingPeriod;</div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span>  CommandQueue commandQueue;</div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span>  <a class="code" href="classwiconnect_1_1_queued_command.html">wiconnect::QueuedCommand</a> *currentQueuedCommand;</div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> </div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span>  <span class="keywordtype">void</span> commandProcessingTimerHandler(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  <span class="keywordtype">void</span> processNextQueuedCommand();</div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>  <span class="keywordtype">void</span> checkQueuedCommandTimeout();</div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> </div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a>;</div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a>;</div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a>;</div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> };</div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> </div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> }</div>
<div class="ttc" id="group__conversion__util_html_gac96e2d2fca60cba12e7429626f9186be"><div class="ttname"><a href="group__conversion__util.html#gac96e2d2fca60cba12e7429626f9186be">wiconnect::Wiconnect::getWiconnectResultStr</a></div><div class="ttdeci">static const char * getWiconnectResultStr(WiconnectResult wiconnectResult)</div><div class="ttdoc">Converts a WiconnectResult to string representation. </div></div>
<div class="ttc" id="group__api__core__settings_html_ga273f67fede26be4a3d5d909c5cf8c7e0"><div class="ttname"><a href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">wiconnect::Wiconnect::setAssertLogger</a></div><div class="ttdeci">void setAssertLogger(LogFunc assertLogFunc)</div><div class="ttdoc">Sets callback used when Wiconnect Library hits and internal assertion. </div></div>
<div class="ttc" id="classwiconnect_1_1_file_html"><div class="ttname"><a href="classwiconnect_1_1_file.html">wiconnect::File</a></div><div class="ttdoc">WiConnect WiFi module file object. </div><div class="ttdef"><b>Definition:</b> <a href="_file_8h_source.html#l00026">File.h:26</a></div></div>
<div class="ttc" id="group__api__core__misc_html_gad8069679fabb52d44647d27703f1a09a"><div class="ttname"><a href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">wiconnect::Wiconnect::getLastCommandResponseCodeStr</a></div><div class="ttdeci">const char * getLastCommandResponseCodeStr()</div><div class="ttdoc">When the WiConnect WiFi module returns a response, it contains a response code in the header...</div></div>
<div class="ttc" id="namespacewiconnect_html_aadd4d5e6774e21f382c20b594a644470"><div class="ttname"><a href="namespacewiconnect.html#aadd4d5e6774e21f382c20b594a644470">wiconnect::PinToGpioMapper</a></div><div class="ttdeci">int8_t(* PinToGpioMapper)(Pin pin)</div><div class="ttdoc">Function pointer for mapping from a host pin to a WiConnect Module GPIO. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00166">WiconnectTypes.h:166</a></div></div>
<div class="ttc" id="classwiconnect_1_1_network_interface_html"><div class="ttname"><a href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></div><div class="ttdoc">The provides an interface for joining and/or creating a network. It provides other utilities such as ...</div><div class="ttdef"><b>Definition:</b> <a href="_network_interface_8h_source.html#l00031">NetworkInterface.h:31</a></div></div>
<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00127">WiconnectTypes.h:127</a></div></div>
<div class="ttc" id="group__api__core__misc_html_gabec1504eb7f486085dad82c4a94310e3"><div class="ttname"><a href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">wiconnect::Wiconnect::reset</a></div><div class="ttdeci">WiconnectResult reset()</div><div class="ttdoc">Toggle the WiConnect WiFi module reset signal. </div></div>
<div class="ttc" id="group__api__core__misc_html_ga96ac50d85d8ab376755d7d5325de1713"><div class="ttname"><a href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">wiconnect::Wiconnect::flush</a></div><div class="ttdeci">void flush(int delayMs=500)</div><div class="ttdoc">Flush any received data in serial RX buffer and terminate any commands on WiConnect WiFi module...</div></div>
<div class="ttc" id="classwiconnect_1_1_callback_html"><div class="ttname"><a href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></div><div class="ttdoc">Generic callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_callback_8h_source.html#l00031">Callback.h:31</a></div></div>
<div class="ttc" id="group__api__core__misc_html_gad552c8f23dd0a0e8844ee1fc4d9358e5"><div class="ttname"><a href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wiconnect::Wiconnect::wakeup</a></div><div class="ttdeci">WiconnectResult wakeup()</div><div class="ttdoc">Toggle the WiConnect WiFi moduel wakeup signal. </div></div>
<div class="ttc" id="classwiconnect_1_1_serial_config_html"><div class="ttname"><a href="classwiconnect_1_1_serial_config.html">wiconnect::SerialConfig</a></div><div class="ttdoc">Host<->Wiconnect Module serial configuration. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00108">sdk.h:108</a></div></div>
<div class="ttc" id="group__api__core__send__command_html_ga3a2637e5ce300a03c448edf1eff13c2c"><div class="ttname"><a href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">wiconnect::Wiconnect::sendCommand</a></div><div class="ttdeci">WiconnectResult sendCommand(const Callback &completeCallback, char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList)</div><div class="ttdoc">Send command to WiConnect WiFi module. </div></div>
<div class="ttc" id="group__api__core__settings_html_ga75fb083451ee530a1c19e6a4c1be185e"><div class="ttname"><a href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">wiconnect::Wiconnect::setDebugLogger</a></div><div class="ttdeci">void setDebugLogger(LogFunc logFunc)</div><div class="ttdoc">Sets callback function used to debug WiConnect WiFi module RX/TX serial data. </div></div>
<div class="ttc" id="group__api__core__misc_html_ga8dcd3ac87afd58b225abb068e835d06e"><div class="ttname"><a href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">wiconnect::Wiconnect::getInstance</a></div><div class="ttdeci">static Wiconnect * getInstance()</div><div class="ttdoc">Get instance of previously instantiated Wiconnect Library. </div></div>
<div class="ttc" id="group__api__core__send__command_html_gaf48c1ec0b92af2619ab846baaaa471cd"><div class="ttname"><a href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">wiconnect::Wiconnect::checkCurrentCommand</a></div><div class="ttdeci">WiconnectResult checkCurrentCommand()</div><div class="ttdoc">Check the status of the currently executing command. </div></div>
<div class="ttc" id="group__api__core__misc_html_gac40b2964149e60245ff3cac6adbcd565"><div class="ttname"><a href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">wiconnect::Wiconnect::responseToUint32</a></div><div class="ttdeci">WiconnectResult responseToUint32(uint32_t *uint32Ptr)</div><div class="ttdoc">Helper method to convert previous response to uint32. </div></div>
<div class="ttc" id="classwiconnect_1_1_reader_func_html"><div class="ttname"><a href="classwiconnect_1_1_reader_func.html">wiconnect::ReaderFunc</a></div><div class="ttdoc">Generic data reading callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_reader_func_8h_source.html#l00027">ReaderFunc.h:27</a></div></div>
<div class="ttc" id="group__api__core__misc_html_ga9d6c981a54c6ab964b469e4f247142d6"><div class="ttname"><a href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">wiconnect::Wiconnect::deinit</a></div><div class="ttdeci">void deinit()</div><div class="ttdoc">De-initialize library. </div></div>
<div class="ttc" id="group__api__core__misc_html_ga27b5d6b8207e4ef0f73875606d628da8"><div class="ttname"><a href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">wiconnect::Wiconnect::getResponseBuffer</a></div><div class="ttdeci">char * getResponseBuffer()</div><div class="ttdoc">Return pointer to internal response buffer. </div></div>
<div class="ttc" id="group__api__core__settings_html_gaaaf8be221699870053ad98911b066a32"><div class="ttname"><a href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">wiconnect::Wiconnect::setCommandDefaultTimeout</a></div><div class="ttdeci">void setCommandDefaultTimeout(int timeoutMs)</div><div class="ttdoc">Sets the default maximum time an API method may execute before terminating and return a timeout error...</div></div>
<div class="ttc" id="classwiconnect_1_1_queued_command_html"><div class="ttname"><a href="classwiconnect_1_1_queued_command.html">wiconnect::QueuedCommand</a></div><div class="ttdoc">Class which contains command for asynchronous processing. </div><div class="ttdef"><b>Definition:</b> <a href="_queued_command_8h_source.html#l00025">QueuedCommand.h:25</a></div></div>
<div class="ttc" id="group__api__core__types_html_ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><div class="ttname"><a href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></div><div class="ttdeci">PinName Pin</div><div class="ttdoc">Pin name on HOST. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00102">sdk.h:102</a></div></div>
<div class="ttc" id="group__api__core__misc_html_gad62e847c65166134a361d68b5c95e57c"><div class="ttname"><a href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">wiconnect::Wiconnect::init</a></div><div class="ttdeci">WiconnectResult init(bool bringNetworkUp)</div><div class="ttdoc">Initialize library and communication link with WiConnect WiFi module. </div></div>
<div class="ttc" id="group__api__core__settings_html_ga180b043ec83c53b5bf6b9ef2b187d08d"><div class="ttname"><a href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">wiconnect::Wiconnect::setPinToGpioMapper</a></div><div class="ttdeci">void setPinToGpioMapper(PinToGpioMapper mapper)</div><div class="ttdoc">Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO. </div></div>
<div class="ttc" id="classwiconnect_1_1_log_func_html"><div class="ttname"><a href="classwiconnect_1_1_log_func.html">wiconnect::LogFunc</a></div><div class="ttdoc">Logging callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_log_func_8h_source.html#l00027">LogFunc.h:27</a></div></div>
<div class="ttc" id="group__api__core__send__command_html_ga4a9bd29de1d5c496fbcc28ecfa51e7c0"><div class="ttname"><a href="group__api__core__send__command.html#ga4a9bd29de1d5c496fbcc28ecfa51e7c0">wiconnect::Wiconnect::stopCurrentCommand</a></div><div class="ttdeci">void stopCurrentCommand()</div><div class="ttdoc">Stop the currently executing command. </div></div>
<div class="ttc" id="group__api__core__misc_html_gada79343aece515e00f9be4045d3858a0"><div class="ttname"><a href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">wiconnect::Wiconnect::responseToInt32</a></div><div class="ttdeci">WiconnectResult responseToInt32(int32_t *int32Ptr)</div><div class="ttdoc">Helper method to convert previous response to int32. </div></div>
<div class="ttc" id="classwiconnect_1_1_wiconnect_html_a285510a2cba5341db387101ac75a4389"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">wiconnect::Wiconnect::Wiconnect</a></div><div class="ttdeci">Wiconnect(const SerialConfig &serialConfig, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</div><div class="ttdoc">WiConnect class constructor. </div></div>
<div class="ttc" id="group__api__core__misc_html_ga600215de23210071c42996d04390071e"><div class="ttname"><a href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">wiconnect::Wiconnect::getLastCommandResponseLength</a></div><div class="ttdeci">uint16_t getLastCommandResponseLength()</div><div class="ttdoc">Return the length in bytes of the previous response. </div></div>
<div class="ttc" id="classwiconnect_1_1_socket_html"><div class="ttname"><a href="classwiconnect_1_1_socket.html">wiconnect::Socket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_socket_8h_source.html#l00025">Socket.h:25</a></div></div>
<div class="ttc" id="classwiconnect_1_1_scan_result_list_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result_list.html">wiconnect::ScanResultList</a></div><div class="ttdoc">List of WiFi network scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_list_8h_source.html#l00028">ScanResultList.h:28</a></div></div>
<div class="ttc" id="classwiconnect_1_1_socket_interface_html"><div class="ttname"><a href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></div><div class="ttdoc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a...</div><div class="ttdef"><b>Definition:</b> <a href="_socket_interface_8h_source.html#l00033">SocketInterface.h:33</a></div></div>
<div class="ttc" id="group__api__core__settings_html_gad5d31980a7b1e143f00b0117468c1a7e"><div class="ttname"><a href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">wiconnect::Wiconnect::getCommandDefaultTimeout</a></div><div class="ttdeci">int getCommandDefaultTimeout()</div><div class="ttdoc">Returns the current default maximum API execution time. </div></div>
<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00056">WiconnectInterface.h:56</a></div></div>
<div class="ttc" id="classwiconnect_1_1_file_interface_html"><div class="ttname"><a href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></div><div class="ttdoc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a...</div><div class="ttdef"><b>Definition:</b> <a href="_file_interface_8h_source.html#l00051">FileInterface.h:51</a></div></div>
<div class="ttc" id="group__api__core__macro_html_ga347d0e1228e8174563c6bcf48de18401"><div class="ttname"><a href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a></div><div class="ttdeci">#define WICONNECT_DEFAULT_NONBLOCKING</div><div class="ttdoc">The default blocking mode of the Library. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00078">sdk.h:78</a></div></div>
<div class="ttc" id="group__api__core__macro_html_ga596d1da2fb23f4e748c83d64a47e10b3"><div class="ttname"><a href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3">delayMs</a></div><div class="ttdeci">#define delayMs(ms)</div><div class="ttdoc">Function to stop processor for specified number of milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00159">sdk.h:159</a></div></div>
<div class="ttc" id="group__api__core__macro_html_ga2aa16118029ab13ab41514cb8eb93ba7"><div class="ttname"><a href="group__api__core__macro.html#ga2aa16118029ab13ab41514cb8eb93ba7">WICONNECT_MAX_CMD_SIZE</a></div><div class="ttdeci">#define WICONNECT_MAX_CMD_SIZE</div><div class="ttdoc">The maximum command size that may be sent to the WiConnect WiFi module. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00087">WiconnectTypes.h:87</a></div></div>
<div class="ttc" id="group__api__core__macro_html_gaa1dbeca66111f3a22d0ee6b122d69270"><div class="ttname"><a href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></div><div class="ttdeci">#define PIN_NC</div><div class="ttdoc">Default value for a pin, Not connected. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00096">sdk.h:96</a></div></div>
<div class="ttc" id="group__api__core__misc_html_ga4fc195839bc6c6bd0091074cbdc94c4f"><div class="ttname"><a href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">wiconnect::Wiconnect::getVersion</a></div><div class="ttdeci">WiconnectResult getVersion(char *versionBuffer=NULL, int versionBufferSize=0, const Callback &completeCallback=Callback())</div><div class="ttdoc">Return current version of WiConnect WiFi module. </div></div>
<div class="ttc" id="group__api__core__misc_html_gab00c7110984f6d6187241d17a4a431ff"><div class="ttname"><a href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">wiconnect::Wiconnect::isInitialized</a></div><div class="ttdeci">bool isInitialized()</div><div class="ttdoc">Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else. </div></div>
<div class="ttc" id="classwiconnect_1_1_scan_result_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result.html">wiconnect::ScanResult</a></div><div class="ttdoc">Contains single entry from WiFi scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_8h_source.html#l00028">ScanResult.h:28</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</li>
</ul>
</div>
</body>
</html>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02