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

Diff: doc/html/_network_interface_8h_source.html

Revision:
14:85a2ed029f37
Child:
16:7f1d6d359787
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/_network_interface_8h_source.html	Wed Aug 13 03:14:43 2014 -0700
@@ -0,0 +1,268 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<title>ACKme WiConnect Host Library</title>
+<link rel="icon" href="favicon.ico" type="image/x-icon">
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+  $(document).ready(initResizable);
+  $(window).load(resizeHeight);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea" style="font-family:verdana;">
+    <table border='0' cellpadding='0' cellspacing='0' width="98%">
+      <tr style="height:20px"><td>&nbsp;</td></tr>
+      <tr style="border-collapse: collapse; padding: 0;">
+        <td style="width:20px"></td>
+        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
+        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
+        WiConnect Host Library- API Reference Guide</td>
+        <td style="width:20px"></td>
+      </tr>
+      <tr><td>&nbsp;</td></tr>
+    </table>
+</div><!-- Generated by Doxygen 1.8.7 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+  <div id="navrow1" class="tabs">
+    <ul class="tablist">
+      <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
+      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
+      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <img id="MSearchSelect" src="search/mag_sel.png"
+               onmouseover="return searchBox.OnSearchSelectShow()"
+               onmouseout="return searchBox.OnSearchSelectHide()"
+               alt=""/>
+          <input type="text" id="MSearchField" value="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+          </span>
+        </div>
+      </li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('_network_interface_8h_source.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#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>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle">
+<div class="title">NetworkInterface.h</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
+<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
+<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
+<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
+<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
+<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
+<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
+<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * written permission of ACKme Networks.</span></div>
+<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> */</span></div>
+<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
+<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#pragma once</span></div>
+<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
+<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
+<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
+<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &quot;types/ScanResultList.h&quot;</span></div>
+<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
+<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
+<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">namespace </span>wiconnect {</div>
+<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div>
+<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
+<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_network_interface.html">   31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a></div>
+<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;{</div>
+<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">public</span>:</div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</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>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
+<div class="line"><a name="l00070"></a><span class="lineno">   70</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>
+<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
+<div class="line"><a name="l00082"></a><span class="lineno">   82</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>
+<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
+<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
+<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    <span class="comment">// ------------------------------------------------------------------------</span></div>
+<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
+<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
+<div class="line"><a name="l00114"></a><span class="lineno">  114</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>
+<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div>
+<div class="line"><a name="l00126"></a><span class="lineno">  126</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>
+<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div>
+<div class="line"><a name="l00138"></a><span class="lineno">  138</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>
+<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;</div>
+<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    <span class="comment">// ------------------------------------------------------------------------</span></div>
+<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;</div>
+<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;</div>
+<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">//    WiconnectResult startSoftAp(const char* ssid = NULL, const char *password = NULL, const Callback &amp;clientConnectedCallback = Callback());</span></div>
+<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">//    WiconnectResult stopSoftAp();</span></div>
+<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">//    WiconnectResult getSoftApClientList();</span></div>
+<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;</div>
+<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;</div>
+<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    <span class="comment">// ------------------------------------------------------------------------</span></div>
+<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>
+<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;</div>
+<div class="line"><a name="l00169"></a><span class="lineno">  169</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>
+<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;</div>
+<div class="line"><a name="l00184"></a><span class="lineno">  184</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>
+<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div>
+<div class="line"><a name="l00195"></a><span class="lineno">  195</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>
+<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;</div>
+<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;</div>
+<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    <span class="comment">// ------------------------------------------------------------------------</span></div>
+<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;</div>
+<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;</div>
+<div class="line"><a name="l00208"></a><span class="lineno">  208</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>
+<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;</div>
+<div class="line"><a name="l00215"></a><span class="lineno">  215</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>
+<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;</div>
+<div class="line"><a name="l00222"></a><span class="lineno">  222</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>
+<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;</div>
+<div class="line"><a name="l00229"></a><span class="lineno">  229</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>
+<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;</div>
+<div class="line"><a name="l00236"></a><span class="lineno">  236</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>
+<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;</div>
+<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__network__settings.html#gaba16b9918e55c08285cf5b8b50dbabea">getSignalStrength</a>(<a class="code" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> *signalStrengthPtr);</div>
+<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;</div>
+<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;</div>
+<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;    <span class="comment">// ------------------------------------------------------------------------</span></div>
+<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;</div>
+<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;</div>
+<div class="line"><a name="l00254"></a><span class="lineno">  254</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>
+<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;</div>
+<div class="line"><a name="l00261"></a><span class="lineno">  261</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 = NULL);</div>
+<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;</div>
+<div class="line"><a name="l00268"></a><span class="lineno">  268</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>
+<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;</div>
+<div class="line"><a name="l00275"></a><span class="lineno">  275</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>
+<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;</div>
+<div class="line"><a name="l00282"></a><span class="lineno">  282</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>
+<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;</div>
+<div class="line"><a name="l00289"></a><span class="lineno">  289</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>
+<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;</div>
+<div class="line"><a name="l00296"></a><span class="lineno">  296</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>
+<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;</div>
+<div class="line"><a name="l00303"></a><span class="lineno">  303</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>
+<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;</div>
+<div class="line"><a name="l00310"></a><span class="lineno">  310</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 = NULL);</div>
+<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;</div>
+<div class="line"><a name="l00317"></a><span class="lineno">  317</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>
+<div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;</div>
+<div class="line"><a name="l00324"></a><span class="lineno">  324</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 = NULL);</div>
+<div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;</div>
+<div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;<span class="keyword">protected</span>:</div>
+<div class="line"><a name="l00327"></a><span class="lineno">  327</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>
+<div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;</div>
+<div class="line"><a name="l00329"></a><span class="lineno">  329</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>
+<div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;</div>
+<div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;<span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
+<div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;    <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> completeHandler;</div>
+<div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;    PeriodicTimer monitorTimer;</div>
+<div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;</div>
+<div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;    <span class="keywordtype">void</span> webSetupStatusMonitor();</div>
+<div class="line"><a name="l00336"></a><span class="lineno">  336</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>
+<div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;</div>
+<div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;    <span class="keywordtype">void</span> joinStatusMonitor();</div>
+<div class="line"><a name="l00339"></a><span class="lineno">  339</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>
+<div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;</div>
+<div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160;    <span class="comment">//void scanCompleteCallback(WiconnectResult result, void *arg1, void *arg2);</span></div>
+<div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;</div>
+<div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;<span class="keyword">private</span>:</div>
+<div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;    <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
+<div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;};</div>
+<div class="line"><a name="l00347"></a><span class="lineno">  347</span>&#160;</div>
+<div class="line"><a name="l00348"></a><span class="lineno">  348</span>&#160;}</div>
+<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>
+<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#l00217">WiconnectTypes.h:217</a></div></div>
+<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#l00031">NetworkInterface.h:31</a></div></div>
+<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>
+<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#l00127">WiconnectTypes.h:127</a></div></div>
+<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#l00031">Callback.h:31</a></div></div>
+<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>
+<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>
+<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>
+<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#l00243">WiconnectTypes.h:243</a></div></div>
+<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>
+<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>
+<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>
+<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>
+<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>
+<div class="ttc" id="group__api__network__settings_html_gaba16b9918e55c08285cf5b8b50dbabea"><div class="ttname"><a href="group__api__network__settings.html#gaba16b9918e55c08285cf5b8b50dbabea">wiconnect::NetworkInterface::getSignalStrength</a></div><div class="ttdeci">WiconnectResult getSignalStrength(NetworkSignalStrength *signalStrengthPtr)</div><div class="ttdoc">Get signal strength to WiFi network. </div></div>
+<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>
+<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>
+<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#l00203">WiconnectTypes.h:203</a></div></div>
+<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>
+<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>
+<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#l00233">WiconnectTypes.h:233</a></div></div>
+<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>
+<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#l00028">ScanResultList.h:28</a></div></div>
+<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>
+<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>
+<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>
+<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#l00056">WiconnectInterface.h:56</a></div></div>
+<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>
+<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>
+<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>
+<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>
+<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#l00191">WiconnectTypes.h:191</a></div></div>
+<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>
+<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>
+</div><!-- fragment --></div><!-- contents -->
+</div><!-- doc-content -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">&copy; ACKme Networks 2014</li>
+  </ul>
+</div>
+</body>
+</html>
\ No newline at end of file