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/mbed/html/group__api__core__misc.html
- Committer:
- dan_ackme
- Date:
- 2014-11-26
- Revision:
- 34:2616445d0823
File content as of revision 34:2616445d0823:
<!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"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<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="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>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- 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>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect Repository</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 -->
<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('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>
<div class="headertitle">
<div class="title">Miscellaneous Methods<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Other core methods.
<a href="#details">More...</a></p>
<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 <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:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gae2e3add2e60543d0e3340ed7a9e034ad">wiconnect::Wiconnect::init</a> (bool bringNetworkUp=false)</td></tr>
<tr class="memdesc:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="mdescLeft"> </td><td class="mdescRight">Initialize library and communication link with WiConnect WiFi module. <a href="#gae2e3add2e60543d0e3340ed7a9e034ad">More...</a><br /></td></tr>
<tr class="separator:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="memSeparator" colspan="2"> </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:gaa4fbf58d622cf370f5445ddd15536170"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gaa4fbf58d622cf370f5445ddd15536170">wiconnect::Wiconnect::updateRequired</a> ()</td></tr>
<tr class="memdesc:gaa4fbf58d622cf370f5445ddd15536170"><td class="mdescLeft"> </td><td class="mdescRight">Return TRUE if the WiFi module's firmware supports the SDK version, FALSE if the WiFi module's firmware needs to be updated. See <a class="el" href="group__api__core__misc.html#gad447fe3341539eb9b276d269645bb632">updateFirmware()</a> to update the module's firmware. <a href="#gaa4fbf58d622cf370f5445ddd15536170">More...</a><br /></td></tr>
<tr class="separator:gaa4fbf58d622cf370f5445ddd15536170"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabec1504eb7f486085dad82c4a94310e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.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"><a class="el" href="group__api__core__types.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 <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. <a href="#ga96ac50d85d8ab376755d7d5325de1713">More...</a><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"><a class="el" href="group__api__core__types.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. <a href="#ga4fc195839bc6c6bd0091074cbdc94c4f">More...</a><br /></td></tr>
<tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad447fe3341539eb9b276d269645bb632"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad447fe3341539eb9b276d269645bb632">wiconnect::Wiconnect::updateFirmware</a> (bool forced=false, const char *versionStr=NULL, 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:gad447fe3341539eb9b276d269645bb632"><td class="mdescLeft"> </td><td class="mdescRight">Update the wifi module's internal firmware. <a href="#gad447fe3341539eb9b276d269645bb632">More...</a><br /></td></tr>
<tr class="separator:gad447fe3341539eb9b276d269645bb632"><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="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. <a href="#gad8069679fabb52d44647d27703f1a09a">More...</a><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="memdesc:ga600215de23210071c42996d04390071e"><td class="mdescLeft"> </td><td class="mdescRight">Return the length in bytes of the previous response. <a href="#ga600215de23210071c42996d04390071e">More...</a><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="memdesc:ga27b5d6b8207e4ef0f73875606d628da8"><td class="mdescLeft"> </td><td class="mdescRight">Return pointer to internal response buffer. <a href="#ga27b5d6b8207e4ef0f73875606d628da8">More...</a><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"><a class="el" href="group__api__core__types.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. <a href="#gac40b2964149e60245ff3cac6adbcd565">More...</a><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"><a class="el" href="group__api__core__types.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. <a href="#gada79343aece515e00f9be4045d3858a0">More...</a><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 methods. </p>
<h2 class="groupheader">Function Documentation</h2>
<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>
<p>The delayMs parameter is used as the delay between terminating commands on the module and flushing the serial RX buffer. This is needed because after terminating commands on the module, the module will returns a response. These responses are invalid at this point and should be flushed from the serial RX buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delayMs</td><td>Optional, if not specificed this only flushes the serial RX buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8dcd3ac87afd58b225abb068e835d06e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<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>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>
<dl class="section return"><dt>Returns</dt><dd>string representation of module response code </dd></dl>
</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>
<dl class="section return"><dt>Returns</dt><dd>length of previous response </dd></dl>
</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>
<dl class="section return"><dt>Returns</dt><dd>pointer to internal response buffer </dd></dl>
</div>
</div>
<a class="anchor" id="ga4fc195839bc6c6bd0091074cbdc94c4f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> 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 <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td>
<td class="paramname"><em>completeCallback</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">versionBuffer</td><td>Optional, Buffer to hold received version string </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">versionBufferSize</td><td>Optional, required if versionBuffer specified. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">completeCallback</td><td>Optional, callback when version is received. arg1 of callback contains version buffer pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae2e3add2e60543d0e3340ed7a9e034ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::init </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bringNetworkUp</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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">
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of initialization. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab00c7110984f6d6187241d17a4a431ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wiconnect::Wiconnect::isInitialized </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
<a class="anchor" id="gabec1504eb7f486085dad82c4a94310e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.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#ace00de05bc1ae1e56a6b708eb58f172e" 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 <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gada79343aece515e00f9be4045d3858a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> 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>
<dl class="section note"><dt>Note</dt><dd>This uses the internal response buffer.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">int32Ptr</td><td>Pointer to hold result of conversion. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of conversion. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac40b2964149e60245ff3cac6adbcd565"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> 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 note"><dt>Note</dt><dd>This uses the internal response buffer.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">uint32Ptr</td><td>Pointer to hold result of conversion. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of conversion. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad447fe3341539eb9b276d269645bb632"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::updateFirmware </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>forced</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>versionStr</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td>
<td class="paramname"><em>completeCallback</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the wifi module's internal firmware. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">forced</td><td>Optional, If true, force update of all firmware files to latest version, else only update out-dated files. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">versionStr</td><td>Optional, If specified, update to specific firmware version, else update to latest version. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">completeCallback</td><td>Optional, callback when update is complete. 'result' callback argument contains result of update.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa4fbf58d622cf370f5445ddd15536170"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wiconnect::Wiconnect::updateRequired </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return TRUE if the WiFi module's firmware supports the SDK version, FALSE if the WiFi module's firmware needs to be updated. See <a class="el" href="group__api__core__misc.html#gad447fe3341539eb9b276d269645bb632">updateFirmware()</a> to update the module's firmware. </p>
<dl class="section return"><dt>Returns</dt><dd>TRUE WiFi firmware version is supported, FALSE else </dd></dl>
</div>
</div>
<a class="anchor" id="gad552c8f23dd0a0e8844ee1fc4d9358e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.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#ace00de05bc1ae1e56a6b708eb58f172e" 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 <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</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