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/group__api__core__misc.html@10:735194df0097, 2014-08-11 (annotated)
- 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?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| dan_ackme | 10:735194df0097 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| dan_ackme | 10:735194df0097 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| dan_ackme | 10:735194df0097 | 3 | <head> |
| dan_ackme | 10:735194df0097 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| dan_ackme | 10:735194df0097 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| dan_ackme | 10:735194df0097 | 6 | <meta name="generator" content="Doxygen 1.8.7"/> |
| dan_ackme | 10:735194df0097 | 7 | <title>WiConnect Library: Miscellaneous</title> |
| dan_ackme | 10:735194df0097 | 8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| dan_ackme | 10:735194df0097 | 9 | <script type="text/javascript" src="jquery.js"></script> |
| dan_ackme | 10:735194df0097 | 10 | <script type="text/javascript" src="dynsections.js"></script> |
| dan_ackme | 10:735194df0097 | 11 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| dan_ackme | 10:735194df0097 | 12 | <script type="text/javascript" src="resize.js"></script> |
| dan_ackme | 10:735194df0097 | 13 | <script type="text/javascript" src="navtree.js"></script> |
| dan_ackme | 10:735194df0097 | 14 | <script type="text/javascript"> |
| dan_ackme | 10:735194df0097 | 15 | $(document).ready(initResizable); |
| dan_ackme | 10:735194df0097 | 16 | $(window).load(resizeHeight); |
| dan_ackme | 10:735194df0097 | 17 | </script> |
| dan_ackme | 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 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><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><!-- top --> |
| dan_ackme | 10:735194df0097 | 45 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| dan_ackme | 10:735194df0097 | 46 | <div id="nav-tree"> |
| dan_ackme | 10:735194df0097 | 47 | <div id="nav-tree-contents"> |
| dan_ackme | 10:735194df0097 | 48 | <div id="nav-sync" class="sync"></div> |
| dan_ackme | 10:735194df0097 | 49 | </div> |
| dan_ackme | 10:735194df0097 | 50 | </div> |
| dan_ackme | 10:735194df0097 | 51 | <div id="splitbar" style="-moz-user-select:none;" |
| dan_ackme | 10:735194df0097 | 52 | class="ui-resizable-handle"> |
| dan_ackme | 10:735194df0097 | 53 | </div> |
| dan_ackme | 10:735194df0097 | 54 | </div> |
| dan_ackme | 10:735194df0097 | 55 | <script type="text/javascript"> |
| dan_ackme | 10:735194df0097 | 56 | $(document).ready(function(){initNavTree('group__api__core__misc.html','');}); |
| dan_ackme | 10:735194df0097 | 57 | </script> |
| dan_ackme | 10:735194df0097 | 58 | <div id="doc-content"> |
| dan_ackme | 10:735194df0097 | 59 | <div class="header"> |
| dan_ackme | 10:735194df0097 | 60 | <div class="summary"> |
| dan_ackme | 10:735194df0097 | 61 | <a href="#func-members">Functions</a> </div> |
| dan_ackme | 10:735194df0097 | 62 | <div class="headertitle"> |
| dan_ackme | 10:735194df0097 | 63 | <div class="title">Miscellaneous<div class="ingroups"><a class="el" href="group__api__core.html">Core API</a></div></div> </div> |
| dan_ackme | 10:735194df0097 | 64 | </div><!--header--> |
| dan_ackme | 10:735194df0097 | 65 | <div class="contents"> |
| dan_ackme | 10:735194df0097 | 66 | |
| dan_ackme | 10:735194df0097 | 67 | <p>Other core API methods. |
| dan_ackme | 10:735194df0097 | 68 | <a href="#details">More...</a></p> |
| dan_ackme | 10:735194df0097 | 69 | <table class="memberdecls"> |
| dan_ackme | 10:735194df0097 | 70 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| dan_ackme | 10:735194df0097 | 71 | Functions</h2></td></tr> |
| dan_ackme | 10:735194df0097 | 72 | <tr class="memitem:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memItemLeft" align="right" valign="top">static Wiconnect * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">wiconnect::Wiconnect::getInstance</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 73 | <tr class="separator:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 74 | <tr class="memitem:gad62e847c65166134a361d68b5c95e57c"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">wiconnect::Wiconnect::init</a> (bool bringNetworkUp)</td></tr> |
| dan_ackme | 10:735194df0097 | 75 | <tr class="separator:gad62e847c65166134a361d68b5c95e57c"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 76 | <tr class="memitem:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">wiconnect::Wiconnect::deinit</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 77 | <tr class="separator:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 78 | <tr class="memitem:gab00c7110984f6d6187241d17a4a431ff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">wiconnect::Wiconnect::isInitialized</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 79 | <tr class="separator:gab00c7110984f6d6187241d17a4a431ff"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 80 | <tr class="memitem:gabec1504eb7f486085dad82c4a94310e3"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">wiconnect::Wiconnect::reset</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 81 | <tr class="separator:gabec1504eb7f486085dad82c4a94310e3"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 82 | <tr class="memitem:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wiconnect::Wiconnect::wakeup</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 83 | <tr class="separator:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 84 | <tr class="memitem:ga96ac50d85d8ab376755d7d5325de1713"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">wiconnect::Wiconnect::flush</a> (int delayMs=500)</td></tr> |
| dan_ackme | 10:735194df0097 | 85 | <tr class="separator:ga96ac50d85d8ab376755d7d5325de1713"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 86 | <tr class="memitem:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">wiconnect::Wiconnect::getVersion</a> (char *versionBuffer=NULL, int versionBufferSize=0, const Callback &completeCallback=Callback())</td></tr> |
| dan_ackme | 10:735194df0097 | 87 | <tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 88 | <tr class="memitem:gad8069679fabb52d44647d27703f1a09a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">wiconnect::Wiconnect::getLastCommandResponseCodeStr</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 89 | <tr class="separator:gad8069679fabb52d44647d27703f1a09a"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 90 | <tr class="memitem:ga600215de23210071c42996d04390071e"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">wiconnect::Wiconnect::getLastCommandResponseLength</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 91 | <tr class="separator:ga600215de23210071c42996d04390071e"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 92 | <tr class="memitem:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">wiconnect::Wiconnect::getResponseBuffer</a> ()</td></tr> |
| dan_ackme | 10:735194df0097 | 93 | <tr class="separator:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 94 | <tr class="memitem:gac40b2964149e60245ff3cac6adbcd565"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">wiconnect::Wiconnect::responseToUint32</a> (uint32_t *uint32Ptr)</td></tr> |
| dan_ackme | 10:735194df0097 | 95 | <tr class="separator:gac40b2964149e60245ff3cac6adbcd565"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 96 | <tr class="memitem:gada79343aece515e00f9be4045d3858a0"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">wiconnect::Wiconnect::responseToInt32</a> (int32_t *int32Ptr)</td></tr> |
| dan_ackme | 10:735194df0097 | 97 | <tr class="separator:gada79343aece515e00f9be4045d3858a0"><td class="memSeparator" colspan="2"> </td></tr> |
| dan_ackme | 10:735194df0097 | 98 | </table> |
| dan_ackme | 10:735194df0097 | 99 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| dan_ackme | 10:735194df0097 | 100 | <p>Other core API methods. </p> |
| dan_ackme | 10:735194df0097 | 101 | <h2 class="groupheader">Function Documentation</h2> |
| dan_ackme | 10:735194df0097 | 102 | <a class="anchor" id="ga9d6c981a54c6ab964b469e4f247142d6"></a> |
| dan_ackme | 10:735194df0097 | 103 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 104 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 105 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 106 | <tr> |
| dan_ackme | 10:735194df0097 | 107 | <td class="memname">void wiconnect::Wiconnect::deinit </td> |
| dan_ackme | 10:735194df0097 | 108 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 109 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 110 | <td></td> |
| dan_ackme | 10:735194df0097 | 111 | </tr> |
| dan_ackme | 10:735194df0097 | 112 | </table> |
| dan_ackme | 10:735194df0097 | 113 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 114 | <p>De-initialize library. </p> |
| dan_ackme | 10:735194df0097 | 115 | |
| dan_ackme | 10:735194df0097 | 116 | </div> |
| dan_ackme | 10:735194df0097 | 117 | </div> |
| dan_ackme | 10:735194df0097 | 118 | <a class="anchor" id="ga96ac50d85d8ab376755d7d5325de1713"></a> |
| dan_ackme | 10:735194df0097 | 119 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 120 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 121 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 122 | <tr> |
| dan_ackme | 10:735194df0097 | 123 | <td class="memname">void wiconnect::Wiconnect::flush </td> |
| dan_ackme | 10:735194df0097 | 124 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 125 | <td class="paramtype">int </td> |
| dan_ackme | 10:735194df0097 | 126 | <td class="paramname"><em>delayMs</em> = <code>500</code></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 127 | <td></td> |
| dan_ackme | 10:735194df0097 | 128 | </tr> |
| dan_ackme | 10:735194df0097 | 129 | </table> |
| dan_ackme | 10:735194df0097 | 130 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 131 | <p>Flush any received data in serial RX buffer and terminate any commands on WiConnect WiFi module. </p> |
| dan_ackme | 10:735194df0097 | 132 | |
| dan_ackme | 10:735194df0097 | 133 | </div> |
| dan_ackme | 10:735194df0097 | 134 | </div> |
| dan_ackme | 10:735194df0097 | 135 | <a class="anchor" id="ga8dcd3ac87afd58b225abb068e835d06e"></a> |
| dan_ackme | 10:735194df0097 | 136 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 137 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 138 | <table class="mlabels"> |
| dan_ackme | 10:735194df0097 | 139 | <tr> |
| dan_ackme | 10:735194df0097 | 140 | <td class="mlabels-left"> |
| dan_ackme | 10:735194df0097 | 141 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 142 | <tr> |
| dan_ackme | 10:735194df0097 | 143 | <td class="memname">static Wiconnect* wiconnect::Wiconnect::getInstance </td> |
| dan_ackme | 10:735194df0097 | 144 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 145 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 146 | <td></td> |
| dan_ackme | 10:735194df0097 | 147 | </tr> |
| dan_ackme | 10:735194df0097 | 148 | </table> |
| dan_ackme | 10:735194df0097 | 149 | </td> |
| dan_ackme | 10:735194df0097 | 150 | <td class="mlabels-right"> |
| dan_ackme | 10:735194df0097 | 151 | <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| dan_ackme | 10:735194df0097 | 152 | </tr> |
| dan_ackme | 10:735194df0097 | 153 | </table> |
| dan_ackme | 10:735194df0097 | 154 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 155 | <p>Get instance of previously instantiated <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> Library</p> |
| dan_ackme | 10:735194df0097 | 156 | <dl class="section return"><dt>Returns</dt><dd>Pointer to instance of <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> Library. </dd></dl> |
| dan_ackme | 10:735194df0097 | 157 | |
| dan_ackme | 10:735194df0097 | 158 | </div> |
| dan_ackme | 10:735194df0097 | 159 | </div> |
| dan_ackme | 10:735194df0097 | 160 | <a class="anchor" id="gad8069679fabb52d44647d27703f1a09a"></a> |
| dan_ackme | 10:735194df0097 | 161 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 162 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 163 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 164 | <tr> |
| dan_ackme | 10:735194df0097 | 165 | <td class="memname">const char* wiconnect::Wiconnect::getLastCommandResponseCodeStr </td> |
| dan_ackme | 10:735194df0097 | 166 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 167 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 168 | <td></td> |
| dan_ackme | 10:735194df0097 | 169 | </tr> |
| dan_ackme | 10:735194df0097 | 170 | </table> |
| dan_ackme | 10:735194df0097 | 171 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 172 | <p>When the WiConnect WiFi module returns a response, it contains a response code in the header. This function converts the previous response code to a readable string. </p> |
| dan_ackme | 10:735194df0097 | 173 | |
| dan_ackme | 10:735194df0097 | 174 | </div> |
| dan_ackme | 10:735194df0097 | 175 | </div> |
| dan_ackme | 10:735194df0097 | 176 | <a class="anchor" id="ga600215de23210071c42996d04390071e"></a> |
| dan_ackme | 10:735194df0097 | 177 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 178 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 179 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 180 | <tr> |
| dan_ackme | 10:735194df0097 | 181 | <td class="memname">uint16_t wiconnect::Wiconnect::getLastCommandResponseLength </td> |
| dan_ackme | 10:735194df0097 | 182 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 183 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 184 | <td></td> |
| dan_ackme | 10:735194df0097 | 185 | </tr> |
| dan_ackme | 10:735194df0097 | 186 | </table> |
| dan_ackme | 10:735194df0097 | 187 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 188 | <p>Return the length in bytes of the previous response. </p> |
| dan_ackme | 10:735194df0097 | 189 | |
| dan_ackme | 10:735194df0097 | 190 | </div> |
| dan_ackme | 10:735194df0097 | 191 | </div> |
| dan_ackme | 10:735194df0097 | 192 | <a class="anchor" id="ga27b5d6b8207e4ef0f73875606d628da8"></a> |
| dan_ackme | 10:735194df0097 | 193 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 194 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 195 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 196 | <tr> |
| dan_ackme | 10:735194df0097 | 197 | <td class="memname">char* wiconnect::Wiconnect::getResponseBuffer </td> |
| dan_ackme | 10:735194df0097 | 198 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 199 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 200 | <td></td> |
| dan_ackme | 10:735194df0097 | 201 | </tr> |
| dan_ackme | 10:735194df0097 | 202 | </table> |
| dan_ackme | 10:735194df0097 | 203 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 204 | <p>Return pointer to internal response buffer. </p> |
| dan_ackme | 10:735194df0097 | 205 | |
| dan_ackme | 10:735194df0097 | 206 | </div> |
| dan_ackme | 10:735194df0097 | 207 | </div> |
| dan_ackme | 10:735194df0097 | 208 | <a class="anchor" id="ga4fc195839bc6c6bd0091074cbdc94c4f"></a> |
| dan_ackme | 10:735194df0097 | 209 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 210 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 211 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 212 | <tr> |
| dan_ackme | 10:735194df0097 | 213 | <td class="memname">WiconnectResult wiconnect::Wiconnect::getVersion </td> |
| dan_ackme | 10:735194df0097 | 214 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 215 | <td class="paramtype">char * </td> |
| dan_ackme | 10:735194df0097 | 216 | <td class="paramname"><em>versionBuffer</em> = <code>NULL</code>, </td> |
| dan_ackme | 10:735194df0097 | 217 | </tr> |
| dan_ackme | 10:735194df0097 | 218 | <tr> |
| dan_ackme | 10:735194df0097 | 219 | <td class="paramkey"></td> |
| dan_ackme | 10:735194df0097 | 220 | <td></td> |
| dan_ackme | 10:735194df0097 | 221 | <td class="paramtype">int </td> |
| dan_ackme | 10:735194df0097 | 222 | <td class="paramname"><em>versionBufferSize</em> = <code>0</code>, </td> |
| dan_ackme | 10:735194df0097 | 223 | </tr> |
| dan_ackme | 10:735194df0097 | 224 | <tr> |
| dan_ackme | 10:735194df0097 | 225 | <td class="paramkey"></td> |
| dan_ackme | 10:735194df0097 | 226 | <td></td> |
| dan_ackme | 10:735194df0097 | 227 | <td class="paramtype">const Callback & </td> |
| dan_ackme | 10:735194df0097 | 228 | <td class="paramname"><em>completeCallback</em> = <code>Callback()</code> </td> |
| dan_ackme | 10:735194df0097 | 229 | </tr> |
| dan_ackme | 10:735194df0097 | 230 | <tr> |
| dan_ackme | 10:735194df0097 | 231 | <td></td> |
| dan_ackme | 10:735194df0097 | 232 | <td>)</td> |
| dan_ackme | 10:735194df0097 | 233 | <td></td><td></td> |
| dan_ackme | 10:735194df0097 | 234 | </tr> |
| dan_ackme | 10:735194df0097 | 235 | </table> |
| dan_ackme | 10:735194df0097 | 236 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 237 | <p>Return current version of WiConnect WiFi module. </p> |
| dan_ackme | 10:735194df0097 | 238 | |
| dan_ackme | 10:735194df0097 | 239 | </div> |
| dan_ackme | 10:735194df0097 | 240 | </div> |
| dan_ackme | 10:735194df0097 | 241 | <a class="anchor" id="gad62e847c65166134a361d68b5c95e57c"></a> |
| dan_ackme | 10:735194df0097 | 242 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 243 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 244 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 245 | <tr> |
| dan_ackme | 10:735194df0097 | 246 | <td class="memname">WiconnectResult wiconnect::Wiconnect::init </td> |
| dan_ackme | 10:735194df0097 | 247 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 248 | <td class="paramtype">bool </td> |
| dan_ackme | 10:735194df0097 | 249 | <td class="paramname"><em>bringNetworkUp</em></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 250 | <td></td> |
| dan_ackme | 10:735194df0097 | 251 | </tr> |
| dan_ackme | 10:735194df0097 | 252 | </table> |
| dan_ackme | 10:735194df0097 | 253 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 254 | <p>Initialize library and communication link with WiConnect WiFi module.</p> |
| dan_ackme | 10:735194df0097 | 255 | <dl class="section note"><dt>Note</dt><dd>This function is always blocking regardless of configured mode.</dd></dl> |
| dan_ackme | 10:735194df0097 | 256 | <dl class="params"><dt>Parameters</dt><dd> |
| dan_ackme | 10:735194df0097 | 257 | <table class="params"> |
| dan_ackme | 10:735194df0097 | 258 | <tr><td class="paramdir">[in]</td><td class="paramname">bringNetworkUp</td><td>Flag indicating if the module should try to bring the network up upon initialization. </td></tr> |
| dan_ackme | 10:735194df0097 | 259 | </table> |
| dan_ackme | 10:735194df0097 | 260 | </dd> |
| dan_ackme | 10:735194df0097 | 261 | </dl> |
| dan_ackme | 10:735194df0097 | 262 | <dl class="section return"><dt>Returns</dt><dd>Result of initialization. See WiconnectResult </dd></dl> |
| dan_ackme | 10:735194df0097 | 263 | |
| dan_ackme | 10:735194df0097 | 264 | </div> |
| dan_ackme | 10:735194df0097 | 265 | </div> |
| dan_ackme | 10:735194df0097 | 266 | <a class="anchor" id="gab00c7110984f6d6187241d17a4a431ff"></a> |
| dan_ackme | 10:735194df0097 | 267 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 268 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 269 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 270 | <tr> |
| dan_ackme | 10:735194df0097 | 271 | <td class="memname">bool wiconnect::Wiconnect::isInitialized </td> |
| dan_ackme | 10:735194df0097 | 272 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 273 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 274 | <td></td> |
| dan_ackme | 10:735194df0097 | 275 | </tr> |
| dan_ackme | 10:735194df0097 | 276 | </table> |
| dan_ackme | 10:735194df0097 | 277 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 278 | <p>Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else.</p> |
| dan_ackme | 10:735194df0097 | 279 | <dl class="section return"><dt>Returns</dt><dd>TRUE if library can communicate with WiFi module, FALSE else. </dd></dl> |
| dan_ackme | 10:735194df0097 | 280 | |
| dan_ackme | 10:735194df0097 | 281 | </div> |
| dan_ackme | 10:735194df0097 | 282 | </div> |
| dan_ackme | 10:735194df0097 | 283 | <a class="anchor" id="gabec1504eb7f486085dad82c4a94310e3"></a> |
| dan_ackme | 10:735194df0097 | 284 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 285 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 286 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 287 | <tr> |
| dan_ackme | 10:735194df0097 | 288 | <td class="memname">WiconnectResult wiconnect::Wiconnect::reset </td> |
| dan_ackme | 10:735194df0097 | 289 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 290 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 291 | <td></td> |
| dan_ackme | 10:735194df0097 | 292 | </tr> |
| dan_ackme | 10:735194df0097 | 293 | </table> |
| dan_ackme | 10:735194df0097 | 294 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 295 | <p>Toggle the WiConnect WiFi module reset signal.</p> |
| dan_ackme | 10:735194df0097 | 296 | <dl class="section note"><dt>Note</dt><dd>This only resets the module if the library was instantiated with the 'reset' pin parameter in the <a class="el" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect::Wiconnect</a> constructor. </dd> |
| dan_ackme | 10:735194df0097 | 297 | <dd> |
| dan_ackme | 10:735194df0097 | 298 | This method is always blocking. A small (1s) delay is added to ensure the module has returned from reset and ready.</dd></dl> |
| dan_ackme | 10:735194df0097 | 299 | <dl class="section return"><dt>Returns</dt><dd>Result of method. See WiconnectResult </dd></dl> |
| dan_ackme | 10:735194df0097 | 300 | |
| dan_ackme | 10:735194df0097 | 301 | </div> |
| dan_ackme | 10:735194df0097 | 302 | </div> |
| dan_ackme | 10:735194df0097 | 303 | <a class="anchor" id="gada79343aece515e00f9be4045d3858a0"></a> |
| dan_ackme | 10:735194df0097 | 304 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 305 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 306 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 307 | <tr> |
| dan_ackme | 10:735194df0097 | 308 | <td class="memname">WiconnectResult wiconnect::Wiconnect::responseToInt32 </td> |
| dan_ackme | 10:735194df0097 | 309 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 310 | <td class="paramtype">int32_t * </td> |
| dan_ackme | 10:735194df0097 | 311 | <td class="paramname"><em>int32Ptr</em></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 312 | <td></td> |
| dan_ackme | 10:735194df0097 | 313 | </tr> |
| dan_ackme | 10:735194df0097 | 314 | </table> |
| dan_ackme | 10:735194df0097 | 315 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 316 | <p>Helper method to convert previous response to int32 </p> |
| dan_ackme | 10:735194df0097 | 317 | |
| dan_ackme | 10:735194df0097 | 318 | </div> |
| dan_ackme | 10:735194df0097 | 319 | </div> |
| dan_ackme | 10:735194df0097 | 320 | <a class="anchor" id="gac40b2964149e60245ff3cac6adbcd565"></a> |
| dan_ackme | 10:735194df0097 | 321 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 322 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 323 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 324 | <tr> |
| dan_ackme | 10:735194df0097 | 325 | <td class="memname">WiconnectResult wiconnect::Wiconnect::responseToUint32 </td> |
| dan_ackme | 10:735194df0097 | 326 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 327 | <td class="paramtype">uint32_t * </td> |
| dan_ackme | 10:735194df0097 | 328 | <td class="paramname"><em>uint32Ptr</em></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 329 | <td></td> |
| dan_ackme | 10:735194df0097 | 330 | </tr> |
| dan_ackme | 10:735194df0097 | 331 | </table> |
| dan_ackme | 10:735194df0097 | 332 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 333 | <p>Helper method to convert previous response to uint32 </p> |
| dan_ackme | 10:735194df0097 | 334 | |
| dan_ackme | 10:735194df0097 | 335 | </div> |
| dan_ackme | 10:735194df0097 | 336 | </div> |
| dan_ackme | 10:735194df0097 | 337 | <a class="anchor" id="gad552c8f23dd0a0e8844ee1fc4d9358e5"></a> |
| dan_ackme | 10:735194df0097 | 338 | <div class="memitem"> |
| dan_ackme | 10:735194df0097 | 339 | <div class="memproto"> |
| dan_ackme | 10:735194df0097 | 340 | <table class="memname"> |
| dan_ackme | 10:735194df0097 | 341 | <tr> |
| dan_ackme | 10:735194df0097 | 342 | <td class="memname">WiconnectResult wiconnect::Wiconnect::wakeup </td> |
| dan_ackme | 10:735194df0097 | 343 | <td>(</td> |
| dan_ackme | 10:735194df0097 | 344 | <td class="paramname"></td><td>)</td> |
| dan_ackme | 10:735194df0097 | 345 | <td></td> |
| dan_ackme | 10:735194df0097 | 346 | </tr> |
| dan_ackme | 10:735194df0097 | 347 | </table> |
| dan_ackme | 10:735194df0097 | 348 | </div><div class="memdoc"> |
| dan_ackme | 10:735194df0097 | 349 | <p>Toggle the WiConnect WiFi moduel wakeup signal.</p> |
| dan_ackme | 10:735194df0097 | 350 | <dl class="section note"><dt>Note</dt><dd>This only wakes the module if the library was instantiated with the 'wake' pin parameter in the <a class="el" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect::Wiconnect</a> constructor. </dd> |
| dan_ackme | 10:735194df0097 | 351 | <dd> |
| dan_ackme | 10:735194df0097 | 352 | This method is always blocking.</dd></dl> |
| dan_ackme | 10:735194df0097 | 353 | <dl class="section return"><dt>Returns</dt><dd>Result of method. See WiconnectResult </dd></dl> |
| dan_ackme | 10:735194df0097 | 354 | |
| dan_ackme | 10:735194df0097 | 355 | </div> |
| dan_ackme | 10:735194df0097 | 356 | </div> |
| dan_ackme | 10:735194df0097 | 357 | </div><!-- contents --> |
| dan_ackme | 10:735194df0097 | 358 | </div><!-- doc-content --> |
| dan_ackme | 10:735194df0097 | 359 | <!-- start footer part --> |
| dan_ackme | 10:735194df0097 | 360 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| dan_ackme | 10:735194df0097 | 361 | <ul> |
| dan_ackme | 10:735194df0097 | 362 | <li class="footer">Generated on Mon Aug 11 2014 21:58:24 for WiConnect Library by |
| dan_ackme | 10:735194df0097 | 363 | <a href="http://www.doxygen.org/index.html"> |
| dan_ackme | 10:735194df0097 | 364 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li> |
| dan_ackme | 10:735194df0097 | 365 | </ul> |
| dan_ackme | 10:735194df0097 | 366 | </div> |
| dan_ackme | 10:735194df0097 | 367 | </body> |
| dan_ackme | 10:735194df0097 | 368 | </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