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
Diff: doc/html/group__api__core__misc.html
- Revision:
- 11:ea484e1b7fc4
- Parent:
- 10:735194df0097
- Child:
- 13:2b51f5267c92
--- a/doc/html/group__api__core__misc.html Mon Aug 11 21:59:00 2014 -0700 +++ b/doc/html/group__api__core__misc.html Tue Aug 12 02:34:46 2014 -0700 @@ -15,6 +15,11 @@ $(document).ready(initResizable); $(window).load(resizeHeight); </script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -33,12 +38,31 @@ </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.7 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> </ul> </div> </div><!-- top --> @@ -56,6 +80,20 @@ $(document).ready(function(){initNavTree('group__api__core__misc.html','');}); </script> <div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> @@ -69,69 +107,57 @@ <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<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> +<tr class="memitem:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">wiconnect::Wiconnect::getInstance</a> ()</td></tr> +<tr class="memdesc:ga8dcd3ac87afd58b225abb068e835d06e"><td class="mdescLeft"> </td><td class="mdescRight">Get instance of previously instantiated <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library. <a href="#ga8dcd3ac87afd58b225abb068e835d06e">More...</a><br /></td></tr> <tr class="separator:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:gad62e847c65166134a361d68b5c95e57c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">wiconnect::Wiconnect::init</a> (bool bringNetworkUp)</td></tr> +<tr class="memdesc:gad62e847c65166134a361d68b5c95e57c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize library and communication link with WiConnect WiFi module. <a href="#gad62e847c65166134a361d68b5c95e57c">More...</a><br /></td></tr> <tr class="separator:gad62e847c65166134a361d68b5c95e57c"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9d6c981a54c6ab964b469e4f247142d6"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">wiconnect::Wiconnect::deinit</a> ()</td></tr> +<tr class="memdesc:ga9d6c981a54c6ab964b469e4f247142d6"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize library. <br /></td></tr> <tr class="separator:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memSeparator" colspan="2"> </td></tr> <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> +<tr class="memdesc:gab00c7110984f6d6187241d17a4a431ff"><td class="mdescLeft"> </td><td class="mdescRight">Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else. <a href="#gab00c7110984f6d6187241d17a4a431ff">More...</a><br /></td></tr> <tr class="separator:gab00c7110984f6d6187241d17a4a431ff"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:gabec1504eb7f486085dad82c4a94310e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">wiconnect::Wiconnect::reset</a> ()</td></tr> +<tr class="memdesc:gabec1504eb7f486085dad82c4a94310e3"><td class="mdescLeft"> </td><td class="mdescRight">Toggle the WiConnect WiFi module reset signal. <a href="#gabec1504eb7f486085dad82c4a94310e3">More...</a><br /></td></tr> <tr class="separator:gabec1504eb7f486085dad82c4a94310e3"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wiconnect::Wiconnect::wakeup</a> ()</td></tr> +<tr class="memdesc:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="mdescLeft"> </td><td class="mdescRight">Toggle the WiConnect WiFi moduel wakeup signal. <a href="#gad552c8f23dd0a0e8844ee1fc4d9358e5">More...</a><br /></td></tr> <tr class="separator:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:ga96ac50d85d8ab376755d7d5325de1713"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga96ac50d85d8ab376755d7d5325de1713"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">wiconnect::Wiconnect::flush</a> (int <a class="el" href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3">delayMs</a>=500)</td></tr> +<tr class="memdesc:ga96ac50d85d8ab376755d7d5325de1713"><td class="mdescLeft"> </td><td class="mdescRight">Flush any received data in serial RX buffer and terminate any commands on WiConnect WiFi module. <br /></td></tr> <tr class="separator:ga96ac50d85d8ab376755d7d5325de1713"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4fc195839bc6c6bd0091074cbdc94c4f"></a> +<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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 <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr> +<tr class="memdesc:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="mdescLeft"> </td><td class="mdescRight">Return current version of WiConnect WiFi module. <br /></td></tr> <tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:gad8069679fabb52d44647d27703f1a09a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad8069679fabb52d44647d27703f1a09a"></a> +const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">wiconnect::Wiconnect::getLastCommandResponseCodeStr</a> ()</td></tr> +<tr class="memdesc:gad8069679fabb52d44647d27703f1a09a"><td class="mdescLeft"> </td><td class="mdescRight">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. <br /></td></tr> <tr class="separator:gad8069679fabb52d44647d27703f1a09a"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:ga600215de23210071c42996d04390071e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga600215de23210071c42996d04390071e"></a> +uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">wiconnect::Wiconnect::getLastCommandResponseLength</a> ()</td></tr> +<tr class="memdesc:ga600215de23210071c42996d04390071e"><td class="mdescLeft"> </td><td class="mdescRight">Return the length in bytes of the previous response. <br /></td></tr> <tr class="separator:ga600215de23210071c42996d04390071e"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga27b5d6b8207e4ef0f73875606d628da8"></a> +char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">wiconnect::Wiconnect::getResponseBuffer</a> ()</td></tr> +<tr class="memdesc:ga27b5d6b8207e4ef0f73875606d628da8"><td class="mdescLeft"> </td><td class="mdescRight">Return pointer to internal response buffer. <br /></td></tr> <tr class="separator:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:gac40b2964149e60245ff3cac6adbcd565"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac40b2964149e60245ff3cac6adbcd565"></a> +<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> +<tr class="memdesc:gac40b2964149e60245ff3cac6adbcd565"><td class="mdescLeft"> </td><td class="mdescRight">Helper method to convert previous response to uint32. <br /></td></tr> <tr class="separator:gac40b2964149e60245ff3cac6adbcd565"><td class="memSeparator" colspan="2"> </td></tr> -<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> +<tr class="memitem:gada79343aece515e00f9be4045d3858a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gada79343aece515e00f9be4045d3858a0"></a> +<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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> +<tr class="memdesc:gada79343aece515e00f9be4045d3858a0"><td class="mdescLeft"> </td><td class="mdescRight">Helper method to convert previous response to int32. <br /></td></tr> <tr class="separator:gada79343aece515e00f9be4045d3858a0"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Other core API methods. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga9d6c981a54c6ab964b469e4f247142d6"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void wiconnect::Wiconnect::deinit </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>De-initialize library. </p> - -</div> -</div> -<a class="anchor" id="ga96ac50d85d8ab376755d7d5325de1713"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void wiconnect::Wiconnect::flush </td> - <td>(</td> - <td class="paramtype">int </td> - <td class="paramname"><em>delayMs</em> = <code>500</code></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Flush any received data in serial RX buffer and terminate any commands on WiConnect WiFi module. </p> - -</div> -</div> <a class="anchor" id="ga8dcd3ac87afd58b225abb068e835d06e"></a> <div class="memitem"> <div class="memproto"> @@ -140,7 +166,7 @@ <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">static Wiconnect* wiconnect::Wiconnect::getInstance </td> + <td class="memname">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a>* wiconnect::Wiconnect::getInstance </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> @@ -152,98 +178,18 @@ </tr> </table> </div><div class="memdoc"> -<p>Get instance of previously instantiated <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> Library</p> + +<p>Get instance of previously instantiated <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library. </p> <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> </div> </div> -<a class="anchor" id="gad8069679fabb52d44647d27703f1a09a"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const char* wiconnect::Wiconnect::getLastCommandResponseCodeStr </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<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> - -</div> -</div> -<a class="anchor" id="ga600215de23210071c42996d04390071e"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">uint16_t wiconnect::Wiconnect::getLastCommandResponseLength </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Return the length in bytes of the previous response. </p> - -</div> -</div> -<a class="anchor" id="ga27b5d6b8207e4ef0f73875606d628da8"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">char* wiconnect::Wiconnect::getResponseBuffer </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Return pointer to internal response buffer. </p> - -</div> -</div> -<a class="anchor" id="ga4fc195839bc6c6bd0091074cbdc94c4f"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">WiconnectResult wiconnect::Wiconnect::getVersion </td> - <td>(</td> - <td class="paramtype">char * </td> - <td class="paramname"><em>versionBuffer</em> = <code>NULL</code>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>versionBufferSize</em> = <code>0</code>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const Callback & </td> - <td class="paramname"><em>completeCallback</em> = <code>Callback()</code> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Return current version of WiConnect WiFi module. </p> - -</div> -</div> <a class="anchor" id="gad62e847c65166134a361d68b5c95e57c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">WiconnectResult wiconnect::Wiconnect::init </td> + <td class="memname"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::init </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>bringNetworkUp</em></td><td>)</td> @@ -251,7 +197,8 @@ </tr> </table> </div><div class="memdoc"> -<p>Initialize library and communication link with WiConnect WiFi module.</p> + +<p>Initialize library and communication link with WiConnect WiFi module. </p> <dl class="section note"><dt>Note</dt><dd>This function is always blocking regardless of configured mode.</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> @@ -259,7 +206,7 @@ </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>Result of initialization. See WiconnectResult </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>Result of initialization. See <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> </div> </div> @@ -275,7 +222,8 @@ </tr> </table> </div><div class="memdoc"> -<p>Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else.</p> + +<p>Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else. </p> <dl class="section return"><dt>Returns</dt><dd>TRUE if library can communicate with WiFi module, FALSE else. </dd></dl> </div> @@ -285,52 +233,19 @@ <div class="memproto"> <table class="memname"> <tr> - <td class="memname">WiconnectResult wiconnect::Wiconnect::reset </td> + <td class="memname"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::reset </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Toggle the WiConnect WiFi module reset signal.</p> -<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> + +<p>Toggle the WiConnect WiFi module reset signal. </p> +<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="group__types__core.html#ga285510a2cba5341db387101ac75a4389" title="WiConnect class constructor. ">Wiconnect::Wiconnect</a> constructor. </dd> <dd> This method is always blocking. A small (1s) delay is added to ensure the module has returned from reset and ready.</dd></dl> -<dl class="section return"><dt>Returns</dt><dd>Result of method. See WiconnectResult </dd></dl> - -</div> -</div> -<a class="anchor" id="gada79343aece515e00f9be4045d3858a0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">WiconnectResult wiconnect::Wiconnect::responseToInt32 </td> - <td>(</td> - <td class="paramtype">int32_t * </td> - <td class="paramname"><em>int32Ptr</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Helper method to convert previous response to int32 </p> - -</div> -</div> -<a class="anchor" id="gac40b2964149e60245ff3cac6adbcd565"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">WiconnectResult wiconnect::Wiconnect::responseToUint32 </td> - <td>(</td> - <td class="paramtype">uint32_t * </td> - <td class="paramname"><em>uint32Ptr</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Helper method to convert previous response to uint32 </p> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> </div> </div> @@ -339,18 +254,19 @@ <div class="memproto"> <table class="memname"> <tr> - <td class="memname">WiconnectResult wiconnect::Wiconnect::wakeup </td> + <td class="memname"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::wakeup </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Toggle the WiConnect WiFi moduel wakeup signal.</p> -<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> + +<p>Toggle the WiConnect WiFi moduel wakeup signal. </p> +<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="group__types__core.html#ga285510a2cba5341db387101ac75a4389" title="WiConnect class constructor. ">Wiconnect::Wiconnect</a> constructor. </dd> <dd> This method is always blocking.</dd></dl> -<dl class="section return"><dt>Returns</dt><dd>Result of method. See WiconnectResult </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> </div> </div> @@ -359,7 +275,7 @@ <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Mon Aug 11 2014 21:58:24 for WiConnect Library by + <li class="footer">Generated on Tue Aug 12 2014 02:15:21 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>