Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Committer:
dan_ackme
Date:
Wed Nov 26 23:46:00 2014 -0800
Revision:
34:2616445d0823
added support for out-dated wifi firmware

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 34:2616445d0823 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 34:2616445d0823 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 34:2616445d0823 3 <head>
dan_ackme 34:2616445d0823 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 34:2616445d0823 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 34:2616445d0823 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 34:2616445d0823 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 34:2616445d0823 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 34:2616445d0823 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 34:2616445d0823 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 34:2616445d0823 15 <script type="text/javascript">
dan_ackme 34:2616445d0823 16 $(document).ready(initResizable);
dan_ackme 34:2616445d0823 17 $(window).load(resizeHeight);
dan_ackme 34:2616445d0823 18 </script>
dan_ackme 34:2616445d0823 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 34:2616445d0823 21 <script type="text/javascript">
dan_ackme 34:2616445d0823 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 34:2616445d0823 23 </script>
dan_ackme 34:2616445d0823 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 34:2616445d0823 25 </head>
dan_ackme 34:2616445d0823 26 <body>
dan_ackme 34:2616445d0823 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 34:2616445d0823 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 34:2616445d0823 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 34:2616445d0823 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 34:2616445d0823 32 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 34:2616445d0823 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 34:2616445d0823 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 34:2616445d0823 36 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 37 </tr>
dan_ackme 34:2616445d0823 38 <tr><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 39 </table>
dan_ackme 34:2616445d0823 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 34:2616445d0823 41 <script type="text/javascript">
dan_ackme 34:2616445d0823 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 34:2616445d0823 43 </script>
dan_ackme 34:2616445d0823 44 <div id="navrow1" class="tabs">
dan_ackme 34:2616445d0823 45 <ul class="tablist">
dan_ackme 34:2616445d0823 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 34:2616445d0823 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 34:2616445d0823 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 34:2616445d0823 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 34:2616445d0823 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 34:2616445d0823 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 34:2616445d0823 52 <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
dan_ackme 34:2616445d0823 53 <li>
dan_ackme 34:2616445d0823 54 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 34:2616445d0823 55 <span class="left">
dan_ackme 34:2616445d0823 56 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 34:2616445d0823 57 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 58 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 59 alt=""/>
dan_ackme 34:2616445d0823 60 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 34:2616445d0823 61 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 34:2616445d0823 62 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 34:2616445d0823 63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 34:2616445d0823 64 </span><span class="right">
dan_ackme 34:2616445d0823 65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 34:2616445d0823 66 </span>
dan_ackme 34:2616445d0823 67 </div>
dan_ackme 34:2616445d0823 68 </li>
dan_ackme 34:2616445d0823 69 </ul>
dan_ackme 34:2616445d0823 70 </div>
dan_ackme 34:2616445d0823 71 </div><!-- top -->
dan_ackme 34:2616445d0823 72 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 73 <div id="nav-tree">
dan_ackme 34:2616445d0823 74 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 75 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 76 </div>
dan_ackme 34:2616445d0823 77 </div>
dan_ackme 34:2616445d0823 78 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 79 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 80 </div>
dan_ackme 34:2616445d0823 81 </div>
dan_ackme 34:2616445d0823 82 <script type="text/javascript">
dan_ackme 34:2616445d0823 83 $(document).ready(function(){initNavTree('_network_interface_8h_source.html','');});
dan_ackme 34:2616445d0823 84 </script>
dan_ackme 34:2616445d0823 85 <div id="doc-content">
dan_ackme 34:2616445d0823 86 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 87 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 88 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 89 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 90 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 91 <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 34:2616445d0823 92
dan_ackme 34:2616445d0823 93 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 94 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 95 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 96 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 97 </iframe>
dan_ackme 34:2616445d0823 98 </div>
dan_ackme 34:2616445d0823 99
dan_ackme 34:2616445d0823 100 <div class="header">
dan_ackme 34:2616445d0823 101 <div class="headertitle">
dan_ackme 34:2616445d0823 102 <div class="title">NetworkInterface.h</div> </div>
dan_ackme 34:2616445d0823 103 </div><!--header-->
dan_ackme 34:2616445d0823 104 <div class="contents">
dan_ackme 34:2616445d0823 105 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 34:2616445d0823 106 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 34:2616445d0823 107 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
dan_ackme 34:2616445d0823 108 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 34:2616445d0823 109 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
dan_ackme 34:2616445d0823 110 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;api/types/ScanResultList.h&quot;</span></div>
dan_ackme 34:2616445d0823 111 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
dan_ackme 34:2616445d0823 112 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
dan_ackme 34:2616445d0823 113 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span>wiconnect {</div>
dan_ackme 34:2616445d0823 114 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
dan_ackme 34:2616445d0823 115 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
dan_ackme 34:2616445d0823 116 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#ifdef WICONNECT_USE_DEFAULT_STRING_BUFFERS</span></div>
dan_ackme 34:2616445d0823 117 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define ALLOW_NULL_STRING_BUFFER = NULL</span></div>
dan_ackme 34:2616445d0823 118 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#else</span></div>
dan_ackme 34:2616445d0823 119 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define ALLOW_NULL_STRING_BUFFER</span></div>
dan_ackme 34:2616445d0823 120 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
dan_ackme 34:2616445d0823 121 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
dan_ackme 34:2616445d0823 122 <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_network_interface.html"> 55</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a></div>
dan_ackme 34:2616445d0823 123 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div>
dan_ackme 34:2616445d0823 124 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 34:2616445d0823 125 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">startWebSetup</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *ssid = NULL, <span class="keyword">const</span> <span class="keywordtype">char</span> *password = NULL, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &amp;completeHandler = <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>());</div>
dan_ackme 34:2616445d0823 126 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
dan_ackme 34:2616445d0823 127 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">stopWebSetup</a>();</div>
dan_ackme 34:2616445d0823 128 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
dan_ackme 34:2616445d0823 129 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">isWebSetupRunning</a>(<span class="keywordtype">bool</span> *isRunningPtr);</div>
dan_ackme 34:2616445d0823 130 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
dan_ackme 34:2616445d0823 131 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div>
dan_ackme 34:2616445d0823 132 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 133 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div>
dan_ackme 34:2616445d0823 134 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
dan_ackme 34:2616445d0823 135 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">join</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* ssid = NULL, <span class="keyword">const</span> <span class="keywordtype">char</span> *password = NULL, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &amp;completeHandler = <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>());</div>
dan_ackme 34:2616445d0823 136 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div>
dan_ackme 34:2616445d0823 137 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">leave</a>();</div>
dan_ackme 34:2616445d0823 138 <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div>
dan_ackme 34:2616445d0823 139 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">getNetworkStatus</a>(<a class="code" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> *statusPtr);</div>
dan_ackme 34:2616445d0823 140 <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;</div>
dan_ackme 34:2616445d0823 141 <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">getNetworkJoinResult</a>(<a class="code" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> *joinResultPtr);</div>
dan_ackme 34:2616445d0823 142 <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;</div>
dan_ackme 34:2616445d0823 143 <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#gaba16b9918e55c08285cf5b8b50dbabea">getSignalStrength</a>(<a class="code" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> *signalStrengthPtr);</div>
dan_ackme 34:2616445d0823 144 <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;</div>
dan_ackme 34:2616445d0823 145 <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#gaa9db3c463cf6b4f351c37671882dd3ee">getRssi</a>(int32_t *rssiPtr);</div>
dan_ackme 34:2616445d0823 146 <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;</div>
dan_ackme 34:2616445d0823 147 <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__wlan.html#ga70991a2c5865c8f0b44b67de35f3b6b3">getMacAddress</a>(<a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress);</div>
dan_ackme 34:2616445d0823 148 <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div>
dan_ackme 34:2616445d0823 149 <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;</div>
dan_ackme 34:2616445d0823 150 <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 151 <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;</div>
dan_ackme 34:2616445d0823 152 <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div>
dan_ackme 34:2616445d0823 153 <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="comment">// WiconnectResult startSoftAp(const char* ssid = NULL, const char *password = NULL, const Callback &amp;clientConnectedCallback = Callback());</span></div>
dan_ackme 34:2616445d0823 154 <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment">// WiconnectResult stopSoftAp();</span></div>
dan_ackme 34:2616445d0823 155 <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="comment">// WiconnectResult getSoftApClientList();</span></div>
dan_ackme 34:2616445d0823 156 <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;</div>
dan_ackme 34:2616445d0823 157 <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div>
dan_ackme 34:2616445d0823 158 <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 159 <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;</div>
dan_ackme 34:2616445d0823 160 <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;</div>
dan_ackme 34:2616445d0823 161 <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">scan</a>(<a class="code" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> &amp;resultList, <span class="keyword">const</span> uint8_t *channelList = NULL, <span class="keyword">const</span> <span class="keywordtype">char</span>* ssid = NULL);</div>
dan_ackme 34:2616445d0823 162 <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;</div>
dan_ackme 34:2616445d0823 163 <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">ping</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *domain = NULL, uint32_t *timeMsPtr = NULL);</div>
dan_ackme 34:2616445d0823 164 <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;</div>
dan_ackme 34:2616445d0823 165 <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">lookup</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *domain, uint32_t *ipAddressPtr);</div>
dan_ackme 34:2616445d0823 166 <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;</div>
dan_ackme 34:2616445d0823 167 <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;</div>
dan_ackme 34:2616445d0823 168 <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 169 <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;</div>
dan_ackme 34:2616445d0823 170 <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;</div>
dan_ackme 34:2616445d0823 171 <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">setDhcpEnabled</a>(<span class="keywordtype">bool</span> enabled);</div>
dan_ackme 34:2616445d0823 172 <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;</div>
dan_ackme 34:2616445d0823 173 <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">getDhcpEnabled</a>(<span class="keywordtype">bool</span> *enabledPtr);</div>
dan_ackme 34:2616445d0823 174 <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;</div>
dan_ackme 34:2616445d0823 175 <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">setIpSettings</a>(uint32_t ip, uint32_t netmask, uint32_t gateway);</div>
dan_ackme 34:2616445d0823 176 <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;</div>
dan_ackme 34:2616445d0823 177 <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">setIpSettings</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* ip, <span class="keyword">const</span> <span class="keywordtype">char</span>* netmask, <span class="keyword">const</span> <span class="keywordtype">char</span>* gateway);</div>
dan_ackme 34:2616445d0823 178 <div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;</div>
dan_ackme 34:2616445d0823 179 <div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga291aef702f1c10bf2970394e3458022b">getIpSettings</a>(uint32_t *ip, uint32_t *netmask, uint32_t *gateway);</div>
dan_ackme 34:2616445d0823 180 <div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;</div>
dan_ackme 34:2616445d0823 181 <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga258d8b80064c6ce311a433affe63a0e9">setDnsAddress</a>(uint32_t dnsAddress);</div>
dan_ackme 34:2616445d0823 182 <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;</div>
dan_ackme 34:2616445d0823 183 <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#ga585cb71d386ee61db3772f4b3218cb6e">getDnsAddress</a>(uint32_t *dnsAddress);</div>
dan_ackme 34:2616445d0823 184 <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;</div>
dan_ackme 34:2616445d0823 185 <div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">getIpAddress</a>(<span class="keywordtype">char</span> *buffer ALLOW_NULL_STRING_BUFFER);</div>
dan_ackme 34:2616445d0823 186 <div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160;</div>
dan_ackme 34:2616445d0823 187 <div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;</div>
dan_ackme 34:2616445d0823 188 <div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 189 <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;</div>
dan_ackme 34:2616445d0823 190 <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;</div>
dan_ackme 34:2616445d0823 191 <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="group__conversion__util.html#ga93bdb8669a70adaa61dc76073ce66591">strToIp</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, uint32_t *intPtr);</div>
dan_ackme 34:2616445d0823 192 <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;</div>
dan_ackme 34:2616445d0823 193 <div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gaff8b0af70f4d4be792b943ad3af27303">ipToStr</a>(uint32_t ip, <span class="keywordtype">char</span> *ipStrBuffer ALLOW_NULL_STRING_BUFFER);</div>
dan_ackme 34:2616445d0823 194 <div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;</div>
dan_ackme 34:2616445d0823 195 <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;</div>
dan_ackme 34:2616445d0823 196 <div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">networkStatusToStr</a>(<a class="code" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> status);</div>
dan_ackme 34:2616445d0823 197 <div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;</div>
dan_ackme 34:2616445d0823 198 <div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#ga5a682e671900b9b7f931137deb847fa6">networkJoinResultToStr</a>(<a class="code" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> joinResult);</div>
dan_ackme 34:2616445d0823 199 <div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;</div>
dan_ackme 34:2616445d0823 200 <div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">signalStrengthToStr</a>(<a class="code" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> signalStrenth);</div>
dan_ackme 34:2616445d0823 201 <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;</div>
dan_ackme 34:2616445d0823 202 <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; <span class="keyword">static</span> <a class="code" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> <a class="code" href="group__conversion__util.html#ga6216eed4cc05c37ce1ed13a0fbb6acd8">rssiToSignalStrength</a>(<span class="keywordtype">int</span> rssi);</div>
dan_ackme 34:2616445d0823 203 <div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;</div>
dan_ackme 34:2616445d0823 204 <div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; <span class="keyword">static</span> <a class="code" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> <a class="code" href="group__conversion__util.html#gad7d49be19f9ca91bc129668dd50d9e57">strToNetworkSecurity</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div>
dan_ackme 34:2616445d0823 205 <div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;</div>
dan_ackme 34:2616445d0823 206 <div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">networkSecurityToStr</a>(<a class="code" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> security);</div>
dan_ackme 34:2616445d0823 207 <div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;</div>
dan_ackme 34:2616445d0823 208 <div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="group__conversion__util.html#ga6a479a58591ead92dcf0586e11fcad17">strToSsid</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, <a class="code" href="structwiconnect_1_1_ssid.html">Ssid</a> *ssid);</div>
dan_ackme 34:2616445d0823 209 <div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160;</div>
dan_ackme 34:2616445d0823 210 <div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gafce7929a10e16cf9be7307a2f97bef3f">ssidToStr</a>(<span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_ssid.html">Ssid</a> *ssid, <span class="keywordtype">char</span> *ssidStrBuffer ALLOW_NULL_STRING_BUFFER);</div>
dan_ackme 34:2616445d0823 211 <div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;</div>
dan_ackme 34:2616445d0823 212 <div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="group__conversion__util.html#ga347f05073370d6872a5cdac74de39b1b">strToMacAddress</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, <a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress);</div>
dan_ackme 34:2616445d0823 213 <div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160;</div>
dan_ackme 34:2616445d0823 214 <div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#ga13ecaf390b4bf4a68b51a6b18e669134">macAddressToStr</a>(<span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress, <span class="keywordtype">char</span> *macStrBuffer ALLOW_NULL_STRING_BUFFER);</div>
dan_ackme 34:2616445d0823 215 <div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;</div>
dan_ackme 34:2616445d0823 216 <div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 34:2616445d0823 217 <div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; <a class="code" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a>(<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect);</div>
dan_ackme 34:2616445d0823 218 <div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160;</div>
dan_ackme 34:2616445d0823 219 <div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> processScanResults(<span class="keywordtype">char</span> *resultStr, <a class="code" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> &amp;resultList);</div>
dan_ackme 34:2616445d0823 220 <div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;</div>
dan_ackme 34:2616445d0823 221 <div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
dan_ackme 34:2616445d0823 222 <div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> completeHandler;</div>
dan_ackme 34:2616445d0823 223 <div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; PeriodicTimer monitorTimer;</div>
dan_ackme 34:2616445d0823 224 <div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;</div>
dan_ackme 34:2616445d0823 225 <div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; <span class="keywordtype">void</span> webSetupStatusMonitor();</div>
dan_ackme 34:2616445d0823 226 <div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; <span class="keywordtype">void</span> webSetupStatusCheckCallback(<a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result, <span class="keywordtype">void</span> *arg1, <span class="keywordtype">void</span> *arg2);</div>
dan_ackme 34:2616445d0823 227 <div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;</div>
dan_ackme 34:2616445d0823 228 <div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160; <span class="keywordtype">void</span> joinStatusMonitor();</div>
dan_ackme 34:2616445d0823 229 <div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; <span class="keywordtype">void</span> joinStatusCheckCallback(<a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result, <span class="keywordtype">void</span> *arg1, <span class="keywordtype">void</span> *arg2);</div>
dan_ackme 34:2616445d0823 230 <div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;</div>
dan_ackme 34:2616445d0823 231 <div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; <span class="comment">//void scanCompleteCallback(WiconnectResult result, void *arg1, void *arg2);</span></div>
dan_ackme 34:2616445d0823 232 <div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160;<span class="preprocessor">#endif</span></div>
dan_ackme 34:2616445d0823 233 <div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;</div>
dan_ackme 34:2616445d0823 234 <div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160;<span class="keyword">private</span>:</div>
dan_ackme 34:2616445d0823 235 <div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
dan_ackme 34:2616445d0823 236 <div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160;};</div>
dan_ackme 34:2616445d0823 237 <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160;</div>
dan_ackme 34:2616445d0823 238 <div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160;}</div>
dan_ackme 34:2616445d0823 239 <div class="ttc" id="group__api__network__settings_html_ga70ec796b88eb6f8e7990dbf3eb2f2eff"><div class="ttname"><a href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">wiconnect::NetworkInterface::getDhcpEnabled</a></div><div class="ttdeci">WiconnectResult getDhcpEnabled(bool *enabledPtr)</div><div class="ttdoc">Get if DHCP enabled. </div></div>
dan_ackme 34:2616445d0823 240 <div class="ttc" id="group__api__network__wlan_html_gaa9db3c463cf6b4f351c37671882dd3ee"><div class="ttname"><a href="group__api__network__wlan.html#gaa9db3c463cf6b4f351c37671882dd3ee">wiconnect::NetworkInterface::getRssi</a></div><div class="ttdeci">WiconnectResult getRssi(int32_t *rssiPtr)</div><div class="ttdoc">Get the RSSI in dBm of WiFi network. </div></div>
dan_ackme 34:2616445d0823 241 <div class="ttc" id="group__api__network__types_html_ga026bd11cd5df47b7022362243e2d553f"><div class="ttname"><a href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">wiconnect::NetworkSecurity</a></div><div class="ttdeci">NetworkSecurity</div><div class="ttdoc">Network security type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00282">WiconnectTypes.h:282</a></div></div>
dan_ackme 34:2616445d0823 242 <div class="ttc" id="classwiconnect_1_1_network_interface_html"><div class="ttname"><a href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></div><div class="ttdoc">The provides an interface for joining and/or creating a network. It provides other utilities such as ...</div><div class="ttdef"><b>Definition:</b> <a href="_network_interface_8h_source.html#l00055">NetworkInterface.h:55</a></div></div>
dan_ackme 34:2616445d0823 243 <div class="ttc" id="group__api__network__settings_html_ga291aef702f1c10bf2970394e3458022b"><div class="ttname"><a href="group__api__network__settings.html#ga291aef702f1c10bf2970394e3458022b">wiconnect::NetworkInterface::getIpSettings</a></div><div class="ttdeci">WiconnectResult getIpSettings(uint32_t *ip, uint32_t *netmask, uint32_t *gateway)</div><div class="ttdoc">Get network IP settings. </div></div>
dan_ackme 34:2616445d0823 244 <div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00166">WiconnectTypes.h:166</a></div></div>
dan_ackme 34:2616445d0823 245 <div class="ttc" id="classwiconnect_1_1_callback_html"><div class="ttname"><a href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></div><div class="ttdoc">Generic callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_callback_8h_source.html#l00049">Callback.h:49</a></div></div>
dan_ackme 34:2616445d0823 246 <div class="ttc" id="group__api__network__wlan_html_gaba16b9918e55c08285cf5b8b50dbabea"><div class="ttname"><a href="group__api__network__wlan.html#gaba16b9918e55c08285cf5b8b50dbabea">wiconnect::NetworkInterface::getSignalStrength</a></div><div class="ttdeci">WiconnectResult getSignalStrength(NetworkSignalStrength *signalStrengthPtr)</div><div class="ttdoc">Get NetworkSignalStrength of WiFi network module is connected. </div></div>
dan_ackme 34:2616445d0823 247 <div class="ttc" id="group__api__network__settings_html_ga2f7ec21084d3f2835d9c1c201915a9e0"><div class="ttname"><a href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">wiconnect::NetworkInterface::setIpSettings</a></div><div class="ttdeci">WiconnectResult setIpSettings(uint32_t ip, uint32_t netmask, uint32_t gateway)</div><div class="ttdoc">Set static IP settings. </div></div>
dan_ackme 34:2616445d0823 248 <div class="ttc" id="group__conversion__util_html_ga5a682e671900b9b7f931137deb847fa6"><div class="ttname"><a href="group__conversion__util.html#ga5a682e671900b9b7f931137deb847fa6">wiconnect::NetworkInterface::networkJoinResultToStr</a></div><div class="ttdeci">static const char * networkJoinResultToStr(NetworkJoinResult joinResult)</div><div class="ttdoc">Convert NetworkJoinResult to string. </div></div>
dan_ackme 34:2616445d0823 249 <div class="ttc" id="group__conversion__util_html_gae02c549079cfb0350117cd6343a3d66f"><div class="ttname"><a href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">wiconnect::NetworkInterface::networkSecurityToStr</a></div><div class="ttdeci">static const char * networkSecurityToStr(NetworkSecurity security)</div><div class="ttdoc">Convert NetworkSecurity to string. </div></div>
dan_ackme 34:2616445d0823 250 <div class="ttc" id="group__conversion__util_html_gad7d49be19f9ca91bc129668dd50d9e57"><div class="ttname"><a href="group__conversion__util.html#gad7d49be19f9ca91bc129668dd50d9e57">wiconnect::NetworkInterface::strToNetworkSecurity</a></div><div class="ttdeci">static NetworkSecurity strToNetworkSecurity(const char *str)</div><div class="ttdoc">Convert string to NetworkSecurity. </div></div>
dan_ackme 34:2616445d0823 251 <div class="ttc" id="structwiconnect_1_1_mac_address_html"><div class="ttname"><a href="structwiconnect_1_1_mac_address.html">wiconnect::MacAddress</a></div><div class="ttdoc">Network MAC Address type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00308">WiconnectTypes.h:308</a></div></div>
dan_ackme 34:2616445d0823 252 <div class="ttc" id="group__api__network__setup_html_gaea3e133f2ee8c95d8d108c15561f3847"><div class="ttname"><a href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">wiconnect::NetworkInterface::startWebSetup</a></div><div class="ttdeci">WiconnectResult startWebSetup(const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</div><div class="ttdoc">Start the WiConnect WiFi module &#39;web setup&#39; feature. </div></div>
dan_ackme 34:2616445d0823 253 <div class="ttc" id="group__api__network__settings_html_ga585cb71d386ee61db3772f4b3218cb6e"><div class="ttname"><a href="group__api__network__settings.html#ga585cb71d386ee61db3772f4b3218cb6e">wiconnect::NetworkInterface::getDnsAddress</a></div><div class="ttdeci">WiconnectResult getDnsAddress(uint32_t *dnsAddress)</div><div class="ttdoc">Get the static DNS address. </div></div>
dan_ackme 34:2616445d0823 254 <div class="ttc" id="group__api__network__util_html_ga1da909dadb6f0e90218927ed350f72bc"><div class="ttname"><a href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">wiconnect::NetworkInterface::ping</a></div><div class="ttdeci">WiconnectResult ping(const char *domain=NULL, uint32_t *timeMsPtr=NULL)</div><div class="ttdoc">Ping a WiFi network. </div></div>
dan_ackme 34:2616445d0823 255 <div class="ttc" id="group__conversion__util_html_ga93bdb8669a70adaa61dc76073ce66591"><div class="ttname"><a href="group__conversion__util.html#ga93bdb8669a70adaa61dc76073ce66591">wiconnect::NetworkInterface::strToIp</a></div><div class="ttdeci">static bool strToIp(const char *str, uint32_t *intPtr)</div><div class="ttdoc">Convert string to IP address. </div></div>
dan_ackme 34:2616445d0823 256 <div class="ttc" id="group__api__network__settings_html_ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><div class="ttname"><a href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">wiconnect::NetworkInterface::getIpAddress</a></div><div class="ttdeci">const char * getIpAddress(char *buffer=NULL)</div><div class="ttdoc">Return the current IP address of the module if possible, else return 0.0.0.0. </div></div>
dan_ackme 34:2616445d0823 257 <div class="ttc" id="group__conversion__util_html_gacff5a4927d79e8b4c0d5a3050f5950b0"><div class="ttname"><a href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">wiconnect::NetworkInterface::networkStatusToStr</a></div><div class="ttdeci">static const char * networkStatusToStr(NetworkStatus status)</div><div class="ttdoc">Convert NetworkStatus to string. </div></div>
dan_ackme 34:2616445d0823 258 <div class="ttc" id="group__api__network__setup_html_gab52d3a01427d0e8bd52460d992144f65"><div class="ttname"><a href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">wiconnect::NetworkInterface::isWebSetupRunning</a></div><div class="ttdeci">WiconnectResult isWebSetupRunning(bool *isRunningPtr)</div><div class="ttdoc">Return status of WiConnect WiFi module &#39;web setup&#39; feature. </div></div>
dan_ackme 34:2616445d0823 259 <div class="ttc" id="group__api__network__settings_html_ga65eb99f880ed739d0f3cd393e5b56eaf"><div class="ttname"><a href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">wiconnect::NetworkInterface::setDhcpEnabled</a></div><div class="ttdeci">WiconnectResult setDhcpEnabled(bool enabled)</div><div class="ttdoc">Set DHCP enabled. </div></div>
dan_ackme 34:2616445d0823 260 <div class="ttc" id="group__api__network__wlan_html_ga14dc0f4fa58a7ebb25b77fae22052328"><div class="ttname"><a href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">wiconnect::NetworkInterface::leave</a></div><div class="ttdeci">WiconnectResult leave()</div><div class="ttdoc">Leave a WiFi network. </div></div>
dan_ackme 34:2616445d0823 261 <div class="ttc" id="group__api__network__types_html_gac5aead2b4cca0122a60168e75ea41d36"><div class="ttname"><a href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></div><div class="ttdeci">NetworkSignalStrength</div><div class="ttdoc">Network RSSI signal level. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00268">WiconnectTypes.h:268</a></div></div>
dan_ackme 34:2616445d0823 262 <div class="ttc" id="group__conversion__util_html_ga347f05073370d6872a5cdac74de39b1b"><div class="ttname"><a href="group__conversion__util.html#ga347f05073370d6872a5cdac74de39b1b">wiconnect::NetworkInterface::strToMacAddress</a></div><div class="ttdeci">static bool strToMacAddress(const char *str, MacAddress *macAddress)</div><div class="ttdoc">Convert string MacAddress. </div></div>
dan_ackme 34:2616445d0823 263 <div class="ttc" id="group__api__network__util_html_gacdf014d8aca9de33dbc1563c6bb1f956"><div class="ttname"><a href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">wiconnect::NetworkInterface::scan</a></div><div class="ttdeci">WiconnectResult scan(ScanResultList &amp;resultList, const uint8_t *channelList=NULL, const char *ssid=NULL)</div><div class="ttdoc">Scan for available WiFi networks. </div></div>
dan_ackme 34:2616445d0823 264 <div class="ttc" id="structwiconnect_1_1_ssid_html"><div class="ttname"><a href="structwiconnect_1_1_ssid.html">wiconnect::Ssid</a></div><div class="ttdoc">Network SSID type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00298">WiconnectTypes.h:298</a></div></div>
dan_ackme 34:2616445d0823 265 <div class="ttc" id="group__api__network__types_html_ga5f6f5c916a5dd1676f98da7fa511451d"><div class="ttname"><a href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">wiconnect::NetworkJoinResult</a></div><div class="ttdeci">NetworkJoinResult</div><div class="ttdoc">Network connection status. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00251">WiconnectTypes.h:251</a></div></div>
dan_ackme 34:2616445d0823 266 <div class="ttc" id="group__api__network__wlan_html_gafefe6e679d7b48a7127d3ed6371fe58b"><div class="ttname"><a href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">wiconnect::NetworkInterface::getNetworkJoinResult</a></div><div class="ttdeci">WiconnectResult getNetworkJoinResult(NetworkJoinResult *joinResultPtr)</div><div class="ttdoc">Get the result of joining the network. </div></div>
dan_ackme 34:2616445d0823 267 <div class="ttc" id="group__conversion__util_html_ga13ecaf390b4bf4a68b51a6b18e669134"><div class="ttname"><a href="group__conversion__util.html#ga13ecaf390b4bf4a68b51a6b18e669134">wiconnect::NetworkInterface::macAddressToStr</a></div><div class="ttdeci">static const char * macAddressToStr(const MacAddress *macAddress, char *macStrBuffer=NULL)</div><div class="ttdoc">Convert MacAddress to string. </div></div>
dan_ackme 34:2616445d0823 268 <div class="ttc" id="classwiconnect_1_1_scan_result_list_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result_list.html">wiconnect::ScanResultList</a></div><div class="ttdoc">List of WiFi network scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_list_8h_source.html#l00046">ScanResultList.h:46</a></div></div>
dan_ackme 34:2616445d0823 269 <div class="ttc" id="group__api__network__settings_html_ga258d8b80064c6ce311a433affe63a0e9"><div class="ttname"><a href="group__api__network__settings.html#ga258d8b80064c6ce311a433affe63a0e9">wiconnect::NetworkInterface::setDnsAddress</a></div><div class="ttdeci">WiconnectResult setDnsAddress(uint32_t dnsAddress)</div><div class="ttdoc">Set static DNS Address. </div></div>
dan_ackme 34:2616445d0823 270 <div class="ttc" id="group__conversion__util_html_gad4661f859cfadbe193793898671043c9"><div class="ttname"><a href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">wiconnect::NetworkInterface::signalStrengthToStr</a></div><div class="ttdeci">static const char * signalStrengthToStr(NetworkSignalStrength signalStrenth)</div><div class="ttdoc">Convert NetworkSignalStrength to string. </div></div>
dan_ackme 34:2616445d0823 271 <div class="ttc" id="group__api__network__wlan_html_ga047ba9670f60406466391cec5bdd28e5"><div class="ttname"><a href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">wiconnect::NetworkInterface::getNetworkStatus</a></div><div class="ttdeci">WiconnectResult getNetworkStatus(NetworkStatus *statusPtr)</div><div class="ttdoc">Get connection status to WiFi network. </div></div>
dan_ackme 34:2616445d0823 272 <div class="ttc" id="group__conversion__util_html_ga6a479a58591ead92dcf0586e11fcad17"><div class="ttname"><a href="group__conversion__util.html#ga6a479a58591ead92dcf0586e11fcad17">wiconnect::NetworkInterface::strToSsid</a></div><div class="ttdeci">static bool strToSsid(const char *str, Ssid *ssid)</div><div class="ttdoc">Convert string Ssid. </div></div>
dan_ackme 34:2616445d0823 273 <div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00078">WiconnectInterface.h:78</a></div></div>
dan_ackme 34:2616445d0823 274 <div class="ttc" id="group__conversion__util_html_ga6216eed4cc05c37ce1ed13a0fbb6acd8"><div class="ttname"><a href="group__conversion__util.html#ga6216eed4cc05c37ce1ed13a0fbb6acd8">wiconnect::NetworkInterface::rssiToSignalStrength</a></div><div class="ttdeci">static NetworkSignalStrength rssiToSignalStrength(int rssi)</div><div class="ttdoc">Convert RSSI (in dBm) to NetworkSignalStrength. </div></div>
dan_ackme 34:2616445d0823 275 <div class="ttc" id="group__api__network__util_html_ga1770babfc2abc6da7c085ef92709ee89"><div class="ttname"><a href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">wiconnect::NetworkInterface::lookup</a></div><div class="ttdeci">WiconnectResult lookup(const char *domain, uint32_t *ipAddressPtr)</div><div class="ttdoc">Resolve domain name into IP address. </div></div>
dan_ackme 34:2616445d0823 276 <div class="ttc" id="group__conversion__util_html_gafce7929a10e16cf9be7307a2f97bef3f"><div class="ttname"><a href="group__conversion__util.html#gafce7929a10e16cf9be7307a2f97bef3f">wiconnect::NetworkInterface::ssidToStr</a></div><div class="ttdeci">static const char * ssidToStr(const Ssid *ssid, char *ssidStrBuffer=NULL)</div><div class="ttdoc">Convert Ssid to string. </div></div>
dan_ackme 34:2616445d0823 277 <div class="ttc" id="group__api__network__setup_html_gac5ca67b7bfa587935b5619e441dc8d8a"><div class="ttname"><a href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">wiconnect::NetworkInterface::stopWebSetup</a></div><div class="ttdeci">WiconnectResult stopWebSetup()</div><div class="ttdoc">Stop the WiConnect WiFi module &#39;web setup&#39; feature. </div></div>
dan_ackme 34:2616445d0823 278 <div class="ttc" id="group__api__network__types_html_gab448e57fc1a5e21cbba0283fd1a35d99"><div class="ttname"><a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></div><div class="ttdeci">NetworkStatus</div><div class="ttdoc">Network connection status. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00239">WiconnectTypes.h:239</a></div></div>
dan_ackme 34:2616445d0823 279 <div class="ttc" id="group__api__network__wlan_html_ga70991a2c5865c8f0b44b67de35f3b6b3"><div class="ttname"><a href="group__api__network__wlan.html#ga70991a2c5865c8f0b44b67de35f3b6b3">wiconnect::NetworkInterface::getMacAddress</a></div><div class="ttdeci">WiconnectResult getMacAddress(MacAddress *macAddress)</div><div class="ttdoc">Get MAC address of the WiFi module. </div></div>
dan_ackme 34:2616445d0823 280 <div class="ttc" id="group__api__network__wlan_html_gac439d0af5a17da32d405e25dcba83d16"><div class="ttname"><a href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">wiconnect::NetworkInterface::join</a></div><div class="ttdeci">WiconnectResult join(const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</div><div class="ttdoc">Join a WiFi network. </div></div>
dan_ackme 34:2616445d0823 281 <div class="ttc" id="group__conversion__util_html_gaff8b0af70f4d4be792b943ad3af27303"><div class="ttname"><a href="group__conversion__util.html#gaff8b0af70f4d4be792b943ad3af27303">wiconnect::NetworkInterface::ipToStr</a></div><div class="ttdeci">static const char * ipToStr(uint32_t ip, char *ipStrBuffer=NULL)</div><div class="ttdoc">Convert IP address to string. </div></div>
dan_ackme 34:2616445d0823 282 </div><!-- fragment --></div><!-- contents -->
dan_ackme 34:2616445d0823 283 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 284 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 285 <ul>
dan_ackme 34:2616445d0823 286 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 287 </ul>
dan_ackme 34:2616445d0823 288 </div>
dan_ackme 34:2616445d0823 289 </body>
dan_ackme 34:2616445d0823 290 </html>