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

Committer:
dan_ackme
Date:
Mon Aug 11 21:59:00 2014 -0700
Revision:
10:735194df0097
Child:
11:ea484e1b7fc4
added doc files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 10:735194df0097 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 10:735194df0097 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 10:735194df0097 3 <head>
dan_ackme 10:735194df0097 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 10:735194df0097 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 10:735194df0097 6 <meta name="generator" content="Doxygen 1.8.7"/>
dan_ackme 10:735194df0097 7 <title>WiConnect Library: Member List</title>
dan_ackme 10:735194df0097 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 9 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 12 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript">
dan_ackme 10:735194df0097 15 $(document).ready(initResizable);
dan_ackme 10:735194df0097 16 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 17 </script>
dan_ackme 10:735194df0097 18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 19 </head>
dan_ackme 10:735194df0097 20 <body>
dan_ackme 10:735194df0097 21 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 10:735194df0097 22 <div id="titlearea">
dan_ackme 10:735194df0097 23 <table cellspacing="0" cellpadding="0">
dan_ackme 10:735194df0097 24 <tbody>
dan_ackme 10:735194df0097 25 <tr style="height: 56px;">
dan_ackme 10:735194df0097 26 <td style="padding-left: 0.5em;">
dan_ackme 10:735194df0097 27 <div id="projectname">WiConnect Library
dan_ackme 10:735194df0097 28 </div>
dan_ackme 10:735194df0097 29 </td>
dan_ackme 10:735194df0097 30 </tr>
dan_ackme 10:735194df0097 31 </tbody>
dan_ackme 10:735194df0097 32 </table>
dan_ackme 10:735194df0097 33 </div>
dan_ackme 10:735194df0097 34 <!-- end header part -->
dan_ackme 10:735194df0097 35 <!-- Generated by Doxygen 1.8.7 -->
dan_ackme 10:735194df0097 36 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 37 <ul class="tablist">
dan_ackme 10:735194df0097 38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
dan_ackme 10:735194df0097 39 <li><a href="modules.html"><span>Modules</span></a></li>
dan_ackme 10:735194df0097 40 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 10:735194df0097 41 <li><a href="files.html"><span>Files</span></a></li>
dan_ackme 10:735194df0097 42 </ul>
dan_ackme 10:735194df0097 43 </div>
dan_ackme 10:735194df0097 44 <div id="navrow2" class="tabs2">
dan_ackme 10:735194df0097 45 <ul class="tablist">
dan_ackme 10:735194df0097 46 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 10:735194df0097 47 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 10:735194df0097 48 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 10:735194df0097 49 </ul>
dan_ackme 10:735194df0097 50 </div>
dan_ackme 10:735194df0097 51 </div><!-- top -->
dan_ackme 10:735194df0097 52 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 53 <div id="nav-tree">
dan_ackme 10:735194df0097 54 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 55 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 56 </div>
dan_ackme 10:735194df0097 57 </div>
dan_ackme 10:735194df0097 58 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 59 class="ui-resizable-handle">
dan_ackme 10:735194df0097 60 </div>
dan_ackme 10:735194df0097 61 </div>
dan_ackme 10:735194df0097 62 <script type="text/javascript">
dan_ackme 10:735194df0097 63 $(document).ready(function(){initNavTree('classwiconnect_1_1_wiconnect.html','');});
dan_ackme 10:735194df0097 64 </script>
dan_ackme 10:735194df0097 65 <div id="doc-content">
dan_ackme 10:735194df0097 66 <div class="header">
dan_ackme 10:735194df0097 67 <div class="headertitle">
dan_ackme 10:735194df0097 68 <div class="title">wiconnect::Wiconnect Member List</div> </div>
dan_ackme 10:735194df0097 69 </div><!--header-->
dan_ackme 10:735194df0097 70 <div class="contents">
dan_ackme 10:735194df0097 71
dan_ackme 10:735194df0097 72 <p>This is the complete list of members for <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>, including all inherited members.</p>
dan_ackme 10:735194df0097 73 <table class="directory">
dan_ackme 10:735194df0097 74 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">checkCurrentCommand</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 75 <tr><td class="entry"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">deinit</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 76 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">flush</a>(int delayMs=500)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 77 <tr><td class="entry"><a class="el" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">getCommandDefaultTimeout</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 78 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">getInstance</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
dan_ackme 10:735194df0097 79 <tr><td class="entry"><a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">getLastCommandResponseCodeStr</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 80 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">getLastCommandResponseLength</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 81 <tr><td class="entry"><a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">getResponseBuffer</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 82 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">getVersion</a>(char *versionBuffer=NULL, int versionBufferSize=0, const Callback &amp;completeCallback=Callback())</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 83 <tr><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html#ac96e2d2fca60cba12e7429626f9186be">getWiconnectResultStr</a>(WiconnectResult wiconnectResult)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
dan_ackme 10:735194df0097 84 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">init</a>(bool bringNetworkUp)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 85 <tr><td class="entry"><a class="el" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">isInitialized</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 86 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 87 <tr><td class="entry"><a class="el" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">responseToInt32</a>(int32_t *int32Ptr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 88 <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">responseToUint32</a>(uint32_t *uint32Ptr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 89 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a>(const Callback &amp;completeCallback, char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &amp;reader, void *user, const char *cmd, va_list vaList)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 90 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gad23730a1f2f7714ef962f24a0f99f0f7">sendCommand</a>(char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &amp;reader, void *user, const char *cmd, va_list vaList)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 91 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#ga0e0591e923da9ab814bb3dd3afbda197">sendCommand</a>(char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &amp;reader, void *user, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 92 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gadd347dd3952ebab2fa27561c12858f65">sendCommand</a>(int timeoutMs, const ReaderFunc &amp;reader, void *user, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 93 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#gaca2f1b17d2cc98cbc6dac219ffcf9e84">sendCommand</a>(const ReaderFunc &amp;reader, void *user, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 94 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#ga3655750f929f8f4e966278193d0385a9">sendCommand</a>(char *responseBuffer, int responseBufferLen, int timeoutMs, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 95 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#gaf93db1b2730bb586287f7756f3cdf092">sendCommand</a>(const Callback &amp;completeCallback, char *responseBuffer, int responseBufferLen, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 96 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gaac75ca154bd5d5a21c714dd828a92363">sendCommand</a>(char *responseBuffer, int responseBufferLen, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 97 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#ga7eb983a196daa5de20a73fd234dc6f64">sendCommand</a>(const Callback &amp;completeCallback, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 98 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gadad1c5b3df07a24ab09492edf93dd1f4">sendCommand</a>(const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 99 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#gaa6d744ec08ba6c9abf451bdc2b0beb00">sendCommand</a>(const Callback &amp;completeCallback, int timeoutMs, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 100 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gace479d34633141ff1eefa0e98c4d2351">sendCommand</a>(int timeoutMs, const char *cmd,...)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 101 <tr><td class="entry"><a class="el" href="group__api__core__send__command.html#ga9d0ade0ec2866d7e0df5391bc69f5698">sendCommand</a>(const char *cmd, va_list vaList)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 102 <tr class="even"><td class="entry"><a class="el" href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">setAssertLogger</a>(LogFunc assertLogFunc)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 103 <tr><td class="entry"><a class="el" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">setCommandDefaultTimeout</a>(int timeoutMs)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 104 <tr class="even"><td class="entry"><a class="el" href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">setDebugLogger</a>(LogFunc logFunc)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 105 <tr><td class="entry"><a class="el" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">setPinToGpioMapper</a>(PinToGpioMapper mapper)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 106 <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#ga4a9bd29de1d5c496fbcc28ecfa51e7c0">stopCurrentCommand</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 107 <tr><td class="entry"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wakeup</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 108 <tr class="even"><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a>(const SerialConfig &amp;serialConfig, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 109 <tr><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html#ad39105b9aa5858c3b3bbf81b2cebcd30">Wiconnect</a>(const SerialConfig &amp;serialConfig, void *internalBuffer, int internalBufferSize, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
dan_ackme 10:735194df0097 110 </table></div><!-- contents -->
dan_ackme 10:735194df0097 111 </div><!-- doc-content -->
dan_ackme 10:735194df0097 112 <!-- start footer part -->
dan_ackme 10:735194df0097 113 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 114 <ul>
dan_ackme 10:735194df0097 115 <li class="footer">Generated on Mon Aug 11 2014 21:58:24 for WiConnect Library by
dan_ackme 10:735194df0097 116 <a href="http://www.doxygen.org/index.html">
dan_ackme 10:735194df0097 117 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 10:735194df0097 118 </ul>
dan_ackme 10:735194df0097 119 </div>
dan_ackme 10:735194df0097 120 </body>
dan_ackme 10:735194df0097 121 </html>