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: Class Members</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 class="current"><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 id="navrow3" class="tabs2">
dan_ackme 10:735194df0097 52 <ul class="tablist">
dan_ackme 10:735194df0097 53 <li class="current"><a href="functions.html"><span>All</span></a></li>
dan_ackme 10:735194df0097 54 <li><a href="functions_func.html"><span>Functions</span></a></li>
dan_ackme 10:735194df0097 55 </ul>
dan_ackme 10:735194df0097 56 </div>
dan_ackme 10:735194df0097 57 <div id="navrow4" class="tabs3">
dan_ackme 10:735194df0097 58 <ul class="tablist">
dan_ackme 10:735194df0097 59 <li><a href="#index_c"><span>c</span></a></li>
dan_ackme 10:735194df0097 60 <li><a href="#index_d"><span>d</span></a></li>
dan_ackme 10:735194df0097 61 <li><a href="#index_f"><span>f</span></a></li>
dan_ackme 10:735194df0097 62 <li><a href="#index_g"><span>g</span></a></li>
dan_ackme 10:735194df0097 63 <li><a href="#index_i"><span>i</span></a></li>
dan_ackme 10:735194df0097 64 <li><a href="#index_r"><span>r</span></a></li>
dan_ackme 10:735194df0097 65 <li><a href="#index_s"><span>s</span></a></li>
dan_ackme 10:735194df0097 66 <li class="current"><a href="#index_w"><span>w</span></a></li>
dan_ackme 10:735194df0097 67 </ul>
dan_ackme 10:735194df0097 68 </div>
dan_ackme 10:735194df0097 69 </div><!-- top -->
dan_ackme 10:735194df0097 70 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 71 <div id="nav-tree">
dan_ackme 10:735194df0097 72 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 73 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 74 </div>
dan_ackme 10:735194df0097 75 </div>
dan_ackme 10:735194df0097 76 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 77 class="ui-resizable-handle">
dan_ackme 10:735194df0097 78 </div>
dan_ackme 10:735194df0097 79 </div>
dan_ackme 10:735194df0097 80 <script type="text/javascript">
dan_ackme 10:735194df0097 81 $(document).ready(function(){initNavTree('functions.html','');});
dan_ackme 10:735194df0097 82 </script>
dan_ackme 10:735194df0097 83 <div id="doc-content">
dan_ackme 10:735194df0097 84 <div class="contents">
dan_ackme 10:735194df0097 85 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
dan_ackme 10:735194df0097 86
dan_ackme 10:735194df0097 87 <h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
dan_ackme 10:735194df0097 88 <li>checkCurrentCommand()
dan_ackme 10:735194df0097 89 : <a class="el" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 90 </li>
dan_ackme 10:735194df0097 91 </ul>
dan_ackme 10:735194df0097 92
dan_ackme 10:735194df0097 93
dan_ackme 10:735194df0097 94 <h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
dan_ackme 10:735194df0097 95 <li>deinit()
dan_ackme 10:735194df0097 96 : <a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 97 </li>
dan_ackme 10:735194df0097 98 </ul>
dan_ackme 10:735194df0097 99
dan_ackme 10:735194df0097 100
dan_ackme 10:735194df0097 101 <h3><a class="anchor" id="index_f"></a>- f -</h3><ul>
dan_ackme 10:735194df0097 102 <li>flush()
dan_ackme 10:735194df0097 103 : <a class="el" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 104 </li>
dan_ackme 10:735194df0097 105 </ul>
dan_ackme 10:735194df0097 106
dan_ackme 10:735194df0097 107
dan_ackme 10:735194df0097 108 <h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
dan_ackme 10:735194df0097 109 <li>getCommandDefaultTimeout()
dan_ackme 10:735194df0097 110 : <a class="el" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 111 </li>
dan_ackme 10:735194df0097 112 <li>getInstance()
dan_ackme 10:735194df0097 113 : <a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 114 </li>
dan_ackme 10:735194df0097 115 <li>getLastCommandResponseCodeStr()
dan_ackme 10:735194df0097 116 : <a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 117 </li>
dan_ackme 10:735194df0097 118 <li>getLastCommandResponseLength()
dan_ackme 10:735194df0097 119 : <a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 120 </li>
dan_ackme 10:735194df0097 121 <li>getResponseBuffer()
dan_ackme 10:735194df0097 122 : <a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 123 </li>
dan_ackme 10:735194df0097 124 <li>getVersion()
dan_ackme 10:735194df0097 125 : <a class="el" href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 126 </li>
dan_ackme 10:735194df0097 127 <li>getWiconnectResultStr()
dan_ackme 10:735194df0097 128 : <a class="el" href="classwiconnect_1_1_wiconnect.html#ac96e2d2fca60cba12e7429626f9186be">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 129 </li>
dan_ackme 10:735194df0097 130 </ul>
dan_ackme 10:735194df0097 131
dan_ackme 10:735194df0097 132
dan_ackme 10:735194df0097 133 <h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
dan_ackme 10:735194df0097 134 <li>init()
dan_ackme 10:735194df0097 135 : <a class="el" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 136 </li>
dan_ackme 10:735194df0097 137 <li>isInitialized()
dan_ackme 10:735194df0097 138 : <a class="el" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 139 </li>
dan_ackme 10:735194df0097 140 </ul>
dan_ackme 10:735194df0097 141
dan_ackme 10:735194df0097 142
dan_ackme 10:735194df0097 143 <h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
dan_ackme 10:735194df0097 144 <li>reset()
dan_ackme 10:735194df0097 145 : <a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 146 </li>
dan_ackme 10:735194df0097 147 <li>responseToInt32()
dan_ackme 10:735194df0097 148 : <a class="el" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 149 </li>
dan_ackme 10:735194df0097 150 <li>responseToUint32()
dan_ackme 10:735194df0097 151 : <a class="el" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 152 </li>
dan_ackme 10:735194df0097 153 </ul>
dan_ackme 10:735194df0097 154
dan_ackme 10:735194df0097 155
dan_ackme 10:735194df0097 156 <h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
dan_ackme 10:735194df0097 157 <li>sendCommand()
dan_ackme 10:735194df0097 158 : <a class="el" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 159 </li>
dan_ackme 10:735194df0097 160 <li>setAssertLogger()
dan_ackme 10:735194df0097 161 : <a class="el" href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 162 </li>
dan_ackme 10:735194df0097 163 <li>setCommandDefaultTimeout()
dan_ackme 10:735194df0097 164 : <a class="el" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 165 </li>
dan_ackme 10:735194df0097 166 <li>setDebugLogger()
dan_ackme 10:735194df0097 167 : <a class="el" href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 168 </li>
dan_ackme 10:735194df0097 169 <li>setPinToGpioMapper()
dan_ackme 10:735194df0097 170 : <a class="el" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 171 </li>
dan_ackme 10:735194df0097 172 <li>stopCurrentCommand()
dan_ackme 10:735194df0097 173 : <a class="el" href="group__api__core__send__command.html#ga4a9bd29de1d5c496fbcc28ecfa51e7c0">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 174 </li>
dan_ackme 10:735194df0097 175 </ul>
dan_ackme 10:735194df0097 176
dan_ackme 10:735194df0097 177
dan_ackme 10:735194df0097 178 <h3><a class="anchor" id="index_w"></a>- w -</h3><ul>
dan_ackme 10:735194df0097 179 <li>wakeup()
dan_ackme 10:735194df0097 180 : <a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 181 </li>
dan_ackme 10:735194df0097 182 <li>Wiconnect()
dan_ackme 10:735194df0097 183 : <a class="el" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">wiconnect::Wiconnect</a>
dan_ackme 10:735194df0097 184 </li>
dan_ackme 10:735194df0097 185 </ul>
dan_ackme 10:735194df0097 186 </div><!-- contents -->
dan_ackme 10:735194df0097 187 </div><!-- doc-content -->
dan_ackme 10:735194df0097 188 <!-- start footer part -->
dan_ackme 10:735194df0097 189 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 190 <ul>
dan_ackme 10:735194df0097 191 <li class="footer">Generated on Mon Aug 11 2014 21:58:25 for WiConnect Library by
dan_ackme 10:735194df0097 192 <a href="http://www.doxygen.org/index.html">
dan_ackme 10:735194df0097 193 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 10:735194df0097 194 </ul>
dan_ackme 10:735194df0097 195 </div>
dan_ackme 10:735194df0097 196 </body>
dan_ackme 10:735194df0097 197 </html>