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-11
- Revision:
- 10:735194df0097
File content as of revision 10:735194df0097:
<!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"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>WiConnect Library: C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/WiconnectInterface.h Source File</title>
<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="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">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">WiConnect Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></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">
<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="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span>wiconnect {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_wiconnect.html"> 53</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> : <span class="keyword">public</span> NetworkInterface,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">public</span> SocketInterface,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span> FileInterface</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a>(<span class="keyword">const</span> SerialConfig &serialConfig, Pin <a class="code" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a> = PIN_NC, Pin wake = PIN_NC, <span class="keywordtype">bool</span> nonBlocking = WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a>(<span class="keyword">const</span> SerialConfig &serialConfig, <span class="keywordtype">void</span> *internalBuffer, <span class="keywordtype">int</span> internalBufferSize, Pin <a class="code" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a> = PIN_NC, Pin wake = PIN_NC, <span class="keywordtype">bool</span> nonBlocking = WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  ~<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a>();</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</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="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  WiconnectResult <a class="code" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">init</a>(<span class="keywordtype">bool</span> bringNetworkUp);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">deinit</a>();</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">bool</span> <a class="code" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">isInitialized</a>();</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  WiconnectResult <a class="code" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>();</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  WiconnectResult <a class="code" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wakeup</a>();</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">flush</a>(<span class="keywordtype">int</span> delayMs = 500);</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  WiconnectResult <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> Callback &completeCallback = Callback());</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> Callback &completeCallback, <span class="keywordtype">char</span> *responseBuffer, <span class="keywordtype">int</span> responseBufferLen,</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> ReaderFunc &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="l00192"></a><span class="lineno"> 192</span>  WiconnectResult <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> ReaderFunc &reader,</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</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="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  WiconnectResult <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> ReaderFunc &reader,</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>( <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> ReaderFunc &reader, <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> ReaderFunc &reader, <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  WiconnectResult <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="l00239"></a><span class="lineno"> 239</span> </div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> Callback &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="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  WiconnectResult <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="l00261"></a><span class="lineno"> 261</span> </div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> Callback &completeCallback, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  WiconnectResult <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="l00283"></a><span class="lineno"> 283</span> </div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(<span class="keyword">const</span> Callback &completeCallback, <span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd, ...);</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> </div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  WiconnectResult <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="l00305"></a><span class="lineno"> 305</span> </div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  WiconnectResult <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="l00314"></a><span class="lineno"> 314</span> </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</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="l00323"></a><span class="lineno"> 323</span> </div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  uint16_t <a class="code" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">getLastCommandResponseLength</a>();</div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> </div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keywordtype">char</span>* <a class="code" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">getResponseBuffer</a>();</div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> </div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  WiconnectResult <a class="code" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">responseToUint32</a>(uint32_t *uint32Ptr);</div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> </div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  WiconnectResult <a class="code" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">responseToInt32</a>(int32_t *int32Ptr);</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> </div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  WiconnectResult <a class="code" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">checkCurrentCommand</a>();</div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> </div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</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="l00371"></a><span class="lineno"> 371</span> </div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</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="l00381"></a><span class="lineno"> 381</span> </div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  <span class="keywordtype">int</span> <a class="code" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">getCommandDefaultTimeout</a>();</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> </div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">setPinToGpioMapper</a>(PinToGpioMapper mapper);</div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> </div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">setDebugLogger</a>(LogFunc logFunc);</div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> </div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <span class="keywordtype">void</span> <a class="code" href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">setAssertLogger</a>(LogFunc assertLogFunc);</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> </div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> </div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  WiconnectResult enqueueCommand(QueuedCommand *command, <span class="keyword">const</span> Callback &commandCompleteHandler = Callback());</div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> </div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  <span class="keywordtype">void</span> setCommandProcessingPeriod(uint32_t periodMs);</div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> </div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> </div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classwiconnect_1_1_wiconnect.html#ac96e2d2fca60cba12e7429626f9186be">getWiconnectResultStr</a>(WiconnectResult wiconnectResult);</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> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> </div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="preprocessor">#ifdef WICONNECT_ENABLE_MALLOC</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  <span class="keywordtype">void</span>* (*_malloc)(size_t);</div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  void (*_free)(<span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  <span class="keyword">friend</span> <span class="keyword">class </span>QueuedCommand;</div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  <span class="keyword">friend</span> <span class="keyword">class </span>WiconnectSerial;</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  <span class="keyword">friend</span> <span class="keyword">class </span>ScanResult;</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  <span class="keyword">friend</span> <span class="keyword">class </span>ScanResultList;</div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="keyword">friend</span> <span class="keyword">class </span>Socket;</div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  <span class="keyword">friend</span> <span class="keyword">class </span>File;</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> </div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  wiconnect::WiconnectSerial serial;</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  wiconnect::Gpio resetGpio;</div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  wiconnect::Gpio wakeGpio;</div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> </div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> commandExecuting;</div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  <span class="keywordtype">bool</span> initialized;</div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  <span class="keywordtype">bool</span> nonBlocking;</div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> </div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  PinToGpioMapper pinToGpioMapper;</div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> </div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="keywordtype">char</span> *internalBuffer;</div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  <span class="keywordtype">int</span> internalBufferSize;</div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  <span class="keywordtype">bool</span> internalBufferAlloc;</div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  uint8_t internalProcessingState;</div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  <span class="keywordtype">void</span> *currentCommandId;</div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> </div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  wiconnect::TimeoutTimer timeoutTimer;</div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  <span class="keywordtype">int</span> defaultTimeoutMs;</div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> </div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  uint8_t commandHeaderBuffer[32];</div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  <span class="keywordtype">char</span> commandFormatBuffer[WICONNECT_MAX_CMD_SIZE];</div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  uint8_t commandContext[96];</div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> </div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</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="l00474"></a><span class="lineno"> 474</span>  WiconnectResult <span class="keyword">inline</span> receiveResponse();</div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  WiconnectResult <span class="keyword">inline</span> receivePacket();</div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  <span class="keywordtype">void</span> issueCommandCallback(WiconnectResult result);</div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> </div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  LogFunc debugLogger;</div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  LogFunc assertLogger;</div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="keywordtype">void</span> debugLog(<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, ...);</div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> </div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  wiconnect::PeriodicTimer commandProcessorTimer;</div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  uint32_t commandProcessingPeriod;</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  CommandQueue commandQueue;</div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  wiconnect::QueuedCommand *currentQueuedCommand;</div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> </div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  <span class="keywordtype">void</span> commandProcessingTimerHandler(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordtype">void</span> processNextQueuedCommand();</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="keywordtype">void</span> checkQueuedCommandTimeout();</div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> </div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  <span class="keyword">friend</span> <span class="keyword">class </span>NetworkInterface;</div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  <span class="keyword">friend</span> <span class="keyword">class </span>SocketInterface;</div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  <span class="keyword">friend</span> <span class="keyword">class </span>FileInterface;</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="l00498"></a><span class="lineno"> 498</span> }</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>
<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>
<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>
<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>
<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>
<div class="ttc" id="classwiconnect_1_1_wiconnect_html_ac96e2d2fca60cba12e7429626f9186be"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html#ac96e2d2fca60cba12e7429626f9186be">wiconnect::Wiconnect::getWiconnectResultStr</a></div><div class="ttdeci">static const char * getWiconnectResultStr(WiconnectResult wiconnectResult)</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 Refer to Sending Commands To WiFi Module for more info...</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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00053">WiconnectInterface.h:53</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>
<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>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2cefe8a608dd77002e2a359719ab297e.html">wiconnect</a></li><li class="navelem"><a class="el" href="dir_cd3afd97bddf83876771aca0b74624b0.html">Wiconnect</a></li><li class="navelem"><b>WiconnectInterface.h</b></li>
<li class="footer">Generated on Mon Aug 11 2014 21:58:23 for WiConnect Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </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