ACKme / WiConnect

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@26:8067e3d463d3, 2014-10-23 (annotated)

Committer:
dan_ackme
Date:
Thu Oct 23 15:16:06 2014 -0700
Revision:
26:8067e3d463d3
Parent:
17:7268f365676b 
Added 'updateFirmware' and 'networkGetJoinResult' api methods

Various bug fixes

Updated documentation

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 13:2b51f5267c92 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 13:2b51f5267c92 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 13:2b51f5267c92 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 10:735194df0097 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 15 <script type="text/javascript">
dan_ackme 10:735194df0097 16 $(document).ready(initResizable);
dan_ackme 10:735194df0097 17 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 18 </script>
dan_ackme 11:ea484e1b7fc4 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 21 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 23 </script>
dan_ackme 10:735194df0097 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 25 </head>
dan_ackme 10:735194df0097 26 <body>
dan_ackme 10:735194df0097 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 13:2b51f5267c92 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 13:2b51f5267c92 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 13:2b51f5267c92 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 13:2b51f5267c92 32 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 13:2b51f5267c92 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 13:2b51f5267c92 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 13:2b51f5267c92 36 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 37 </tr>
dan_ackme 13:2b51f5267c92 38 <tr><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 39 </table>
dan_ackme 13:2b51f5267c92 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 11:ea484e1b7fc4 41 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 11:ea484e1b7fc4 43 </script>
dan_ackme 10:735194df0097 44 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 45 <ul class="tablist">
dan_ackme 13:2b51f5267c92 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 10:735194df0097 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 26:8067e3d463d3 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 11:ea484e1b7fc4 52 <li>
dan_ackme 11:ea484e1b7fc4 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 54 <span class="left">
dan_ackme 11:ea484e1b7fc4 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 58 alt=""/>
dan_ackme 11:ea484e1b7fc4 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 63 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 65 </span>
dan_ackme 11:ea484e1b7fc4 66 </div>
dan_ackme 11:ea484e1b7fc4 67 </li>
dan_ackme 10:735194df0097 68 </ul>
dan_ackme 10:735194df0097 69 </div>
dan_ackme 10:735194df0097 70 </div><!-- top -->
dan_ackme 10:735194df0097 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 72 <div id="nav-tree">
dan_ackme 10:735194df0097 73 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 74 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 75 </div>
dan_ackme 10:735194df0097 76 </div>
dan_ackme 10:735194df0097 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 78 class="ui-resizable-handle">
dan_ackme 10:735194df0097 79 </div>
dan_ackme 10:735194df0097 80 </div>
dan_ackme 10:735194df0097 81 <script type="text/javascript">
dan_ackme 10:735194df0097 82 $(document).ready(function(){initNavTree('group__api__core__misc.html','');});
dan_ackme 10:735194df0097 83 </script>
dan_ackme 10:735194df0097 84 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 85 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 86 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 90 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 11:ea484e1b7fc4 91
dan_ackme 11:ea484e1b7fc4 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 93 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 95 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 96 </iframe>
dan_ackme 11:ea484e1b7fc4 97 </div>
dan_ackme 11:ea484e1b7fc4 98
dan_ackme 10:735194df0097 99 <div class="header">
dan_ackme 10:735194df0097 100 <div class="summary">
dan_ackme 10:735194df0097 101 <a href="#func-members">Functions</a> </div>
dan_ackme 10:735194df0097 102 <div class="headertitle">
dan_ackme 13:2b51f5267c92 103 <div class="title">Miscellaneous Methods<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div> </div>
dan_ackme 10:735194df0097 104 </div><!--header-->
dan_ackme 10:735194df0097 105 <div class="contents">
dan_ackme 10:735194df0097 106
dan_ackme 13:2b51f5267c92 107 <p>Other core methods.
dan_ackme 10:735194df0097 108 <a href="#details">More...</a></p>
dan_ackme 10:735194df0097 109 <table class="memberdecls">
dan_ackme 10:735194df0097 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 10:735194df0097 111 Functions</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 112 <tr class="memitem:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">wiconnect::Wiconnect::getInstance</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 113 <tr class="memdesc:ga8dcd3ac87afd58b225abb068e835d06e"><td class="mdescLeft">&#160;</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>
dan_ackme 10:735194df0097 114 <tr class="separator:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 26:8067e3d463d3 115 <tr class="memitem:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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>
dan_ackme 26:8067e3d463d3 116 <tr class="memdesc:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize library and communication link with WiConnect WiFi module. <a href="#gae2e3add2e60543d0e3340ed7a9e034ad">More...</a><br /></td></tr>
dan_ackme 26:8067e3d463d3 117 <tr class="separator:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 118 <tr class="memitem:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9d6c981a54c6ab964b469e4f247142d6"></a>
dan_ackme 11:ea484e1b7fc4 119 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">wiconnect::Wiconnect::deinit</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 120 <tr class="memdesc:ga9d6c981a54c6ab964b469e4f247142d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize library. <br /></td></tr>
dan_ackme 10:735194df0097 121 <tr class="separator:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 122 <tr class="memitem:gab00c7110984f6d6187241d17a4a431ff"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">wiconnect::Wiconnect::isInitialized</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 123 <tr class="memdesc:gab00c7110984f6d6187241d17a4a431ff"><td class="mdescLeft">&#160;</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>
dan_ackme 10:735194df0097 124 <tr class="separator:gab00c7110984f6d6187241d17a4a431ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 125 <tr class="memitem:gabec1504eb7f486085dad82c4a94310e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">wiconnect::Wiconnect::reset</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 126 <tr class="memdesc:gabec1504eb7f486085dad82c4a94310e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Toggle the WiConnect WiFi module reset signal. <a href="#gabec1504eb7f486085dad82c4a94310e3">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 127 <tr class="separator:gabec1504eb7f486085dad82c4a94310e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 128 <tr class="memitem:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wiconnect::Wiconnect::wakeup</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 129 <tr class="memdesc:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Toggle the WiConnect WiFi moduel wakeup signal. <a href="#gad552c8f23dd0a0e8844ee1fc4d9358e5">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 130 <tr class="separator:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 131 <tr class="memitem:ga96ac50d85d8ab376755d7d5325de1713"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
dan_ackme 13:2b51f5267c92 132 <tr class="memdesc:ga96ac50d85d8ab376755d7d5325de1713"><td class="mdescLeft">&#160;</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>
dan_ackme 10:735194df0097 133 <tr class="separator:ga96ac50d85d8ab376755d7d5325de1713"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 134 <tr class="memitem:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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> &amp;completeCallback=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
dan_ackme 13:2b51f5267c92 135 <tr class="memdesc:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return current version of WiConnect WiFi module. <a href="#ga4fc195839bc6c6bd0091074cbdc94c4f">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 136 <tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 26:8067e3d463d3 137 <tr class="memitem:gad447fe3341539eb9b276d269645bb632"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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> &amp;completeCallback=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
dan_ackme 26:8067e3d463d3 138 <tr class="memdesc:gad447fe3341539eb9b276d269645bb632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the wifi module's internal firmware. <a href="#gad447fe3341539eb9b276d269645bb632">More...</a><br /></td></tr>
dan_ackme 26:8067e3d463d3 139 <tr class="separator:gad447fe3341539eb9b276d269645bb632"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 140 <tr class="memitem:gad8069679fabb52d44647d27703f1a09a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">wiconnect::Wiconnect::getLastCommandResponseCodeStr</a> ()</td></tr>
dan_ackme 13:2b51f5267c92 141 <tr class="memdesc:gad8069679fabb52d44647d27703f1a09a"><td class="mdescLeft">&#160;</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>
dan_ackme 10:735194df0097 142 <tr class="separator:gad8069679fabb52d44647d27703f1a09a"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 143 <tr class="memitem:ga600215de23210071c42996d04390071e"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">wiconnect::Wiconnect::getLastCommandResponseLength</a> ()</td></tr>
dan_ackme 13:2b51f5267c92 144 <tr class="memdesc:ga600215de23210071c42996d04390071e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the length in bytes of the previous response. <a href="#ga600215de23210071c42996d04390071e">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 145 <tr class="separator:ga600215de23210071c42996d04390071e"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 146 <tr class="memitem:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">wiconnect::Wiconnect::getResponseBuffer</a> ()</td></tr>
dan_ackme 13:2b51f5267c92 147 <tr class="memdesc:ga27b5d6b8207e4ef0f73875606d628da8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return pointer to internal response buffer. <a href="#ga27b5d6b8207e4ef0f73875606d628da8">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 148 <tr class="separator:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 149 <tr class="memitem:gac40b2964149e60245ff3cac6adbcd565"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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 13:2b51f5267c92 150 <tr class="memdesc:gac40b2964149e60245ff3cac6adbcd565"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper method to convert previous response to uint32. <a href="#gac40b2964149e60245ff3cac6adbcd565">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 151 <tr class="separator:gac40b2964149e60245ff3cac6adbcd565"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 152 <tr class="memitem:gada79343aece515e00f9be4045d3858a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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 13:2b51f5267c92 153 <tr class="memdesc:gada79343aece515e00f9be4045d3858a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper method to convert previous response to int32. <a href="#gada79343aece515e00f9be4045d3858a0">More...</a><br /></td></tr>
dan_ackme 10:735194df0097 154 <tr class="separator:gada79343aece515e00f9be4045d3858a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 155 </table>
dan_ackme 10:735194df0097 156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 13:2b51f5267c92 157 <p>Other core methods. </p>
dan_ackme 10:735194df0097 158 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 13:2b51f5267c92 159 <a class="anchor" id="ga96ac50d85d8ab376755d7d5325de1713"></a>
dan_ackme 13:2b51f5267c92 160 <div class="memitem">
dan_ackme 13:2b51f5267c92 161 <div class="memproto">
dan_ackme 13:2b51f5267c92 162 <table class="memname">
dan_ackme 13:2b51f5267c92 163 <tr>
dan_ackme 13:2b51f5267c92 164 <td class="memname">void wiconnect::Wiconnect::flush </td>
dan_ackme 13:2b51f5267c92 165 <td>(</td>
dan_ackme 13:2b51f5267c92 166 <td class="paramtype">int&#160;</td>
dan_ackme 13:2b51f5267c92 167 <td class="paramname"><em>delayMs</em> = <code>500</code></td><td>)</td>
dan_ackme 13:2b51f5267c92 168 <td></td>
dan_ackme 13:2b51f5267c92 169 </tr>
dan_ackme 13:2b51f5267c92 170 </table>
dan_ackme 13:2b51f5267c92 171 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 172
dan_ackme 13:2b51f5267c92 173 <p>Flush any received data in serial RX buffer and terminate any commands on WiConnect WiFi module. </p>
dan_ackme 13:2b51f5267c92 174 <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>
dan_ackme 13:2b51f5267c92 175 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 176 <table class="params">
dan_ackme 13:2b51f5267c92 177 <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>
dan_ackme 13:2b51f5267c92 178 </table>
dan_ackme 13:2b51f5267c92 179 </dd>
dan_ackme 13:2b51f5267c92 180 </dl>
dan_ackme 13:2b51f5267c92 181
dan_ackme 13:2b51f5267c92 182 </div>
dan_ackme 13:2b51f5267c92 183 </div>
dan_ackme 10:735194df0097 184 <a class="anchor" id="ga8dcd3ac87afd58b225abb068e835d06e"></a>
dan_ackme 10:735194df0097 185 <div class="memitem">
dan_ackme 10:735194df0097 186 <div class="memproto">
dan_ackme 10:735194df0097 187 <table class="mlabels">
dan_ackme 10:735194df0097 188 <tr>
dan_ackme 10:735194df0097 189 <td class="mlabels-left">
dan_ackme 10:735194df0097 190 <table class="memname">
dan_ackme 10:735194df0097 191 <tr>
dan_ackme 11:ea484e1b7fc4 192 <td class="memname">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a>* wiconnect::Wiconnect::getInstance </td>
dan_ackme 10:735194df0097 193 <td>(</td>
dan_ackme 10:735194df0097 194 <td class="paramname"></td><td>)</td>
dan_ackme 10:735194df0097 195 <td></td>
dan_ackme 10:735194df0097 196 </tr>
dan_ackme 10:735194df0097 197 </table>
dan_ackme 10:735194df0097 198 </td>
dan_ackme 10:735194df0097 199 <td class="mlabels-right">
dan_ackme 10:735194df0097 200 <span class="mlabels"><span class="mlabel">static</span></span> </td>
dan_ackme 10:735194df0097 201 </tr>
dan_ackme 10:735194df0097 202 </table>
dan_ackme 10:735194df0097 203 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 204
dan_ackme 11:ea484e1b7fc4 205 <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>
dan_ackme 10:735194df0097 206 <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 207
dan_ackme 10:735194df0097 208 </div>
dan_ackme 10:735194df0097 209 </div>
dan_ackme 13:2b51f5267c92 210 <a class="anchor" id="gad8069679fabb52d44647d27703f1a09a"></a>
dan_ackme 13:2b51f5267c92 211 <div class="memitem">
dan_ackme 13:2b51f5267c92 212 <div class="memproto">
dan_ackme 13:2b51f5267c92 213 <table class="memname">
dan_ackme 13:2b51f5267c92 214 <tr>
dan_ackme 13:2b51f5267c92 215 <td class="memname">const char* wiconnect::Wiconnect::getLastCommandResponseCodeStr </td>
dan_ackme 13:2b51f5267c92 216 <td>(</td>
dan_ackme 13:2b51f5267c92 217 <td class="paramname"></td><td>)</td>
dan_ackme 13:2b51f5267c92 218 <td></td>
dan_ackme 13:2b51f5267c92 219 </tr>
dan_ackme 13:2b51f5267c92 220 </table>
dan_ackme 13:2b51f5267c92 221 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 222
dan_ackme 13:2b51f5267c92 223 <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 13:2b51f5267c92 224 <dl class="section return"><dt>Returns</dt><dd>string representation of module response code </dd></dl>
dan_ackme 13:2b51f5267c92 225
dan_ackme 13:2b51f5267c92 226 </div>
dan_ackme 13:2b51f5267c92 227 </div>
dan_ackme 13:2b51f5267c92 228 <a class="anchor" id="ga600215de23210071c42996d04390071e"></a>
dan_ackme 13:2b51f5267c92 229 <div class="memitem">
dan_ackme 13:2b51f5267c92 230 <div class="memproto">
dan_ackme 13:2b51f5267c92 231 <table class="memname">
dan_ackme 13:2b51f5267c92 232 <tr>
dan_ackme 13:2b51f5267c92 233 <td class="memname">uint16_t wiconnect::Wiconnect::getLastCommandResponseLength </td>
dan_ackme 13:2b51f5267c92 234 <td>(</td>
dan_ackme 13:2b51f5267c92 235 <td class="paramname"></td><td>)</td>
dan_ackme 13:2b51f5267c92 236 <td></td>
dan_ackme 13:2b51f5267c92 237 </tr>
dan_ackme 13:2b51f5267c92 238 </table>
dan_ackme 13:2b51f5267c92 239 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 240
dan_ackme 13:2b51f5267c92 241 <p>Return the length in bytes of the previous response. </p>
dan_ackme 13:2b51f5267c92 242 <dl class="section return"><dt>Returns</dt><dd>length of previous response </dd></dl>
dan_ackme 13:2b51f5267c92 243
dan_ackme 13:2b51f5267c92 244 </div>
dan_ackme 13:2b51f5267c92 245 </div>
dan_ackme 13:2b51f5267c92 246 <a class="anchor" id="ga27b5d6b8207e4ef0f73875606d628da8"></a>
dan_ackme 13:2b51f5267c92 247 <div class="memitem">
dan_ackme 13:2b51f5267c92 248 <div class="memproto">
dan_ackme 13:2b51f5267c92 249 <table class="memname">
dan_ackme 13:2b51f5267c92 250 <tr>
dan_ackme 13:2b51f5267c92 251 <td class="memname">char* wiconnect::Wiconnect::getResponseBuffer </td>
dan_ackme 13:2b51f5267c92 252 <td>(</td>
dan_ackme 13:2b51f5267c92 253 <td class="paramname"></td><td>)</td>
dan_ackme 13:2b51f5267c92 254 <td></td>
dan_ackme 13:2b51f5267c92 255 </tr>
dan_ackme 13:2b51f5267c92 256 </table>
dan_ackme 13:2b51f5267c92 257 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 258
dan_ackme 13:2b51f5267c92 259 <p>Return pointer to internal response buffer. </p>
dan_ackme 13:2b51f5267c92 260 <dl class="section return"><dt>Returns</dt><dd>pointer to internal response buffer </dd></dl>
dan_ackme 13:2b51f5267c92 261
dan_ackme 13:2b51f5267c92 262 </div>
dan_ackme 13:2b51f5267c92 263 </div>
dan_ackme 13:2b51f5267c92 264 <a class="anchor" id="ga4fc195839bc6c6bd0091074cbdc94c4f"></a>
dan_ackme 13:2b51f5267c92 265 <div class="memitem">
dan_ackme 13:2b51f5267c92 266 <div class="memproto">
dan_ackme 13:2b51f5267c92 267 <table class="memname">
dan_ackme 13:2b51f5267c92 268 <tr>
dan_ackme 13:2b51f5267c92 269 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::getVersion </td>
dan_ackme 13:2b51f5267c92 270 <td>(</td>
dan_ackme 13:2b51f5267c92 271 <td class="paramtype">char *&#160;</td>
dan_ackme 13:2b51f5267c92 272 <td class="paramname"><em>versionBuffer</em> = <code>NULL</code>, </td>
dan_ackme 13:2b51f5267c92 273 </tr>
dan_ackme 13:2b51f5267c92 274 <tr>
dan_ackme 13:2b51f5267c92 275 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 276 <td></td>
dan_ackme 13:2b51f5267c92 277 <td class="paramtype">int&#160;</td>
dan_ackme 13:2b51f5267c92 278 <td class="paramname"><em>versionBufferSize</em> = <code>0</code>, </td>
dan_ackme 13:2b51f5267c92 279 </tr>
dan_ackme 13:2b51f5267c92 280 <tr>
dan_ackme 13:2b51f5267c92 281 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 282 <td></td>
dan_ackme 13:2b51f5267c92 283 <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;&#160;</td>
dan_ackme 13:2b51f5267c92 284 <td class="paramname"><em>completeCallback</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code>&#160;</td>
dan_ackme 13:2b51f5267c92 285 </tr>
dan_ackme 13:2b51f5267c92 286 <tr>
dan_ackme 13:2b51f5267c92 287 <td></td>
dan_ackme 13:2b51f5267c92 288 <td>)</td>
dan_ackme 13:2b51f5267c92 289 <td></td><td></td>
dan_ackme 13:2b51f5267c92 290 </tr>
dan_ackme 13:2b51f5267c92 291 </table>
dan_ackme 13:2b51f5267c92 292 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 293
dan_ackme 13:2b51f5267c92 294 <p>Return current version of WiConnect WiFi module. </p>
dan_ackme 13:2b51f5267c92 295 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 296 <table class="params">
dan_ackme 13:2b51f5267c92 297 <tr><td class="paramdir">[in]</td><td class="paramname">versionBuffer</td><td>Optional, Buffer to hold received version string </td></tr>
dan_ackme 13:2b51f5267c92 298 <tr><td class="paramdir">[in]</td><td class="paramname">versionBufferSize</td><td>Optional, required if versionBuffer specified. </td></tr>
dan_ackme 13:2b51f5267c92 299 <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>
dan_ackme 13:2b51f5267c92 300 </table>
dan_ackme 13:2b51f5267c92 301 </dd>
dan_ackme 13:2b51f5267c92 302 </dl>
dan_ackme 13:2b51f5267c92 303 <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>
dan_ackme 13:2b51f5267c92 304
dan_ackme 13:2b51f5267c92 305 </div>
dan_ackme 13:2b51f5267c92 306 </div>
dan_ackme 26:8067e3d463d3 307 <a class="anchor" id="gae2e3add2e60543d0e3340ed7a9e034ad"></a>
dan_ackme 10:735194df0097 308 <div class="memitem">
dan_ackme 10:735194df0097 309 <div class="memproto">
dan_ackme 10:735194df0097 310 <table class="memname">
dan_ackme 10:735194df0097 311 <tr>
dan_ackme 13:2b51f5267c92 312 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::init </td>
dan_ackme 10:735194df0097 313 <td>(</td>
dan_ackme 10:735194df0097 314 <td class="paramtype">bool&#160;</td>
dan_ackme 26:8067e3d463d3 315 <td class="paramname"><em>bringNetworkUp</em> = <code>false</code></td><td>)</td>
dan_ackme 10:735194df0097 316 <td></td>
dan_ackme 10:735194df0097 317 </tr>
dan_ackme 10:735194df0097 318 </table>
dan_ackme 10:735194df0097 319 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 320
dan_ackme 11:ea484e1b7fc4 321 <p>Initialize library and communication link with WiConnect WiFi module. </p>
dan_ackme 10:735194df0097 322 <dl class="section note"><dt>Note</dt><dd>This function is always blocking regardless of configured mode.</dd></dl>
dan_ackme 10:735194df0097 323 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 10:735194df0097 324 <table class="params">
dan_ackme 10:735194df0097 325 <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 326 </table>
dan_ackme 10:735194df0097 327 </dd>
dan_ackme 10:735194df0097 328 </dl>
dan_ackme 13:2b51f5267c92 329 <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>
dan_ackme 10:735194df0097 330
dan_ackme 10:735194df0097 331 </div>
dan_ackme 10:735194df0097 332 </div>
dan_ackme 10:735194df0097 333 <a class="anchor" id="gab00c7110984f6d6187241d17a4a431ff"></a>
dan_ackme 10:735194df0097 334 <div class="memitem">
dan_ackme 10:735194df0097 335 <div class="memproto">
dan_ackme 10:735194df0097 336 <table class="memname">
dan_ackme 10:735194df0097 337 <tr>
dan_ackme 10:735194df0097 338 <td class="memname">bool wiconnect::Wiconnect::isInitialized </td>
dan_ackme 10:735194df0097 339 <td>(</td>
dan_ackme 10:735194df0097 340 <td class="paramname"></td><td>)</td>
dan_ackme 10:735194df0097 341 <td></td>
dan_ackme 10:735194df0097 342 </tr>
dan_ackme 10:735194df0097 343 </table>
dan_ackme 10:735194df0097 344 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 345
dan_ackme 11:ea484e1b7fc4 346 <p>Return TRUE if library is able to communicated with WiConnect WiFi module. FALSE else. </p>
dan_ackme 10:735194df0097 347 <dl class="section return"><dt>Returns</dt><dd>TRUE if library can communicate with WiFi module, FALSE else. </dd></dl>
dan_ackme 10:735194df0097 348
dan_ackme 10:735194df0097 349 </div>
dan_ackme 10:735194df0097 350 </div>
dan_ackme 10:735194df0097 351 <a class="anchor" id="gabec1504eb7f486085dad82c4a94310e3"></a>
dan_ackme 10:735194df0097 352 <div class="memitem">
dan_ackme 10:735194df0097 353 <div class="memproto">
dan_ackme 10:735194df0097 354 <table class="memname">
dan_ackme 10:735194df0097 355 <tr>
dan_ackme 13:2b51f5267c92 356 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::reset </td>
dan_ackme 10:735194df0097 357 <td>(</td>
dan_ackme 10:735194df0097 358 <td class="paramname"></td><td>)</td>
dan_ackme 10:735194df0097 359 <td></td>
dan_ackme 10:735194df0097 360 </tr>
dan_ackme 10:735194df0097 361 </table>
dan_ackme 10:735194df0097 362 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 363
dan_ackme 11:ea484e1b7fc4 364 <p>Toggle the WiConnect WiFi module reset signal. </p>
dan_ackme 13:2b51f5267c92 365 <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" title="WiConnect class constructor. ">Wiconnect::Wiconnect</a> constructor. </dd>
dan_ackme 10:735194df0097 366 <dd>
dan_ackme 10:735194df0097 367 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 13:2b51f5267c92 368 <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>
dan_ackme 13:2b51f5267c92 369
dan_ackme 13:2b51f5267c92 370 </div>
dan_ackme 13:2b51f5267c92 371 </div>
dan_ackme 13:2b51f5267c92 372 <a class="anchor" id="gada79343aece515e00f9be4045d3858a0"></a>
dan_ackme 13:2b51f5267c92 373 <div class="memitem">
dan_ackme 13:2b51f5267c92 374 <div class="memproto">
dan_ackme 13:2b51f5267c92 375 <table class="memname">
dan_ackme 13:2b51f5267c92 376 <tr>
dan_ackme 13:2b51f5267c92 377 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::responseToInt32 </td>
dan_ackme 13:2b51f5267c92 378 <td>(</td>
dan_ackme 13:2b51f5267c92 379 <td class="paramtype">int32_t *&#160;</td>
dan_ackme 13:2b51f5267c92 380 <td class="paramname"><em>int32Ptr</em></td><td>)</td>
dan_ackme 13:2b51f5267c92 381 <td></td>
dan_ackme 13:2b51f5267c92 382 </tr>
dan_ackme 13:2b51f5267c92 383 </table>
dan_ackme 13:2b51f5267c92 384 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 385
dan_ackme 13:2b51f5267c92 386 <p>Helper method to convert previous response to int32. </p>
dan_ackme 13:2b51f5267c92 387 <dl class="section note"><dt>Note</dt><dd>This uses the internal response buffer.</dd></dl>
dan_ackme 13:2b51f5267c92 388 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 389 <table class="params">
dan_ackme 13:2b51f5267c92 390 <tr><td class="paramdir">[out]</td><td class="paramname">int32Ptr</td><td>Pointer to hold result of conversion. </td></tr>
dan_ackme 13:2b51f5267c92 391 </table>
dan_ackme 13:2b51f5267c92 392 </dd>
dan_ackme 13:2b51f5267c92 393 </dl>
dan_ackme 13:2b51f5267c92 394 <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>
dan_ackme 13:2b51f5267c92 395
dan_ackme 13:2b51f5267c92 396 </div>
dan_ackme 13:2b51f5267c92 397 </div>
dan_ackme 13:2b51f5267c92 398 <a class="anchor" id="gac40b2964149e60245ff3cac6adbcd565"></a>
dan_ackme 13:2b51f5267c92 399 <div class="memitem">
dan_ackme 13:2b51f5267c92 400 <div class="memproto">
dan_ackme 13:2b51f5267c92 401 <table class="memname">
dan_ackme 13:2b51f5267c92 402 <tr>
dan_ackme 13:2b51f5267c92 403 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::responseToUint32 </td>
dan_ackme 13:2b51f5267c92 404 <td>(</td>
dan_ackme 13:2b51f5267c92 405 <td class="paramtype">uint32_t *&#160;</td>
dan_ackme 13:2b51f5267c92 406 <td class="paramname"><em>uint32Ptr</em></td><td>)</td>
dan_ackme 13:2b51f5267c92 407 <td></td>
dan_ackme 13:2b51f5267c92 408 </tr>
dan_ackme 13:2b51f5267c92 409 </table>
dan_ackme 13:2b51f5267c92 410 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 411
dan_ackme 13:2b51f5267c92 412 <p>Helper method to convert previous response to uint32. </p>
dan_ackme 13:2b51f5267c92 413 <dl class="section note"><dt>Note</dt><dd>This uses the internal response buffer.</dd></dl>
dan_ackme 13:2b51f5267c92 414 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 415 <table class="params">
dan_ackme 13:2b51f5267c92 416 <tr><td class="paramdir">[out]</td><td class="paramname">uint32Ptr</td><td>Pointer to hold result of conversion. </td></tr>
dan_ackme 13:2b51f5267c92 417 </table>
dan_ackme 13:2b51f5267c92 418 </dd>
dan_ackme 13:2b51f5267c92 419 </dl>
dan_ackme 13:2b51f5267c92 420 <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>
dan_ackme 10:735194df0097 421
dan_ackme 10:735194df0097 422 </div>
dan_ackme 10:735194df0097 423 </div>
dan_ackme 26:8067e3d463d3 424 <a class="anchor" id="gad447fe3341539eb9b276d269645bb632"></a>
dan_ackme 26:8067e3d463d3 425 <div class="memitem">
dan_ackme 26:8067e3d463d3 426 <div class="memproto">
dan_ackme 26:8067e3d463d3 427 <table class="memname">
dan_ackme 26:8067e3d463d3 428 <tr>
dan_ackme 26:8067e3d463d3 429 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::updateFirmware </td>
dan_ackme 26:8067e3d463d3 430 <td>(</td>
dan_ackme 26:8067e3d463d3 431 <td class="paramtype">bool&#160;</td>
dan_ackme 26:8067e3d463d3 432 <td class="paramname"><em>forced</em> = <code>false</code>, </td>
dan_ackme 26:8067e3d463d3 433 </tr>
dan_ackme 26:8067e3d463d3 434 <tr>
dan_ackme 26:8067e3d463d3 435 <td class="paramkey"></td>
dan_ackme 26:8067e3d463d3 436 <td></td>
dan_ackme 26:8067e3d463d3 437 <td class="paramtype">const char *&#160;</td>
dan_ackme 26:8067e3d463d3 438 <td class="paramname"><em>versionStr</em> = <code>NULL</code>, </td>
dan_ackme 26:8067e3d463d3 439 </tr>
dan_ackme 26:8067e3d463d3 440 <tr>
dan_ackme 26:8067e3d463d3 441 <td class="paramkey"></td>
dan_ackme 26:8067e3d463d3 442 <td></td>
dan_ackme 26:8067e3d463d3 443 <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;&#160;</td>
dan_ackme 26:8067e3d463d3 444 <td class="paramname"><em>completeCallback</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code>&#160;</td>
dan_ackme 26:8067e3d463d3 445 </tr>
dan_ackme 26:8067e3d463d3 446 <tr>
dan_ackme 26:8067e3d463d3 447 <td></td>
dan_ackme 26:8067e3d463d3 448 <td>)</td>
dan_ackme 26:8067e3d463d3 449 <td></td><td></td>
dan_ackme 26:8067e3d463d3 450 </tr>
dan_ackme 26:8067e3d463d3 451 </table>
dan_ackme 26:8067e3d463d3 452 </div><div class="memdoc">
dan_ackme 26:8067e3d463d3 453
dan_ackme 26:8067e3d463d3 454 <p>Update the wifi module's internal firmware. </p>
dan_ackme 26:8067e3d463d3 455 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 26:8067e3d463d3 456 <table class="params">
dan_ackme 26:8067e3d463d3 457 <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>
dan_ackme 26:8067e3d463d3 458 <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>
dan_ackme 26:8067e3d463d3 459 <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>
dan_ackme 26:8067e3d463d3 460 </table>
dan_ackme 26:8067e3d463d3 461 </dd>
dan_ackme 26:8067e3d463d3 462 </dl>
dan_ackme 26:8067e3d463d3 463 <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>
dan_ackme 26:8067e3d463d3 464
dan_ackme 26:8067e3d463d3 465 </div>
dan_ackme 26:8067e3d463d3 466 </div>
dan_ackme 10:735194df0097 467 <a class="anchor" id="gad552c8f23dd0a0e8844ee1fc4d9358e5"></a>
dan_ackme 10:735194df0097 468 <div class="memitem">
dan_ackme 10:735194df0097 469 <div class="memproto">
dan_ackme 10:735194df0097 470 <table class="memname">
dan_ackme 10:735194df0097 471 <tr>
dan_ackme 13:2b51f5267c92 472 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::wakeup </td>
dan_ackme 10:735194df0097 473 <td>(</td>
dan_ackme 10:735194df0097 474 <td class="paramname"></td><td>)</td>
dan_ackme 10:735194df0097 475 <td></td>
dan_ackme 10:735194df0097 476 </tr>
dan_ackme 10:735194df0097 477 </table>
dan_ackme 10:735194df0097 478 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 479
dan_ackme 11:ea484e1b7fc4 480 <p>Toggle the WiConnect WiFi moduel wakeup signal. </p>
dan_ackme 13:2b51f5267c92 481 <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" title="WiConnect class constructor. ">Wiconnect::Wiconnect</a> constructor. </dd>
dan_ackme 10:735194df0097 482 <dd>
dan_ackme 10:735194df0097 483 This method is always blocking.</dd></dl>
dan_ackme 13:2b51f5267c92 484 <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>
dan_ackme 10:735194df0097 485
dan_ackme 10:735194df0097 486 </div>
dan_ackme 10:735194df0097 487 </div>
dan_ackme 10:735194df0097 488 </div><!-- contents -->
dan_ackme 10:735194df0097 489 </div><!-- doc-content -->
dan_ackme 10:735194df0097 490 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 491 <ul>
dan_ackme 13:2b51f5267c92 492 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 493 </ul>
dan_ackme 10:735194df0097 494 </div>
dan_ackme 10:735194df0097 495 </body>
dan_ackme 13:2b51f5267c92 496 </html>