ACKme
Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/html/_network_interface_8h_source.html
- Committer:
- dan_ackme
- Date:
- 2014-10-23
- Revision:
- 26:8067e3d463d3
- Parent:
- 21:17bb3eddcbae
- Child:
- 29:b6af04b77a56
File content as of revision 26:8067e3d463d3:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li>
<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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="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> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "WiconnectTypes.h"</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "types/ScanResultList.h"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>wiconnect {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_network_interface.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <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> &completeHandler = <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>());</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <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="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <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="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <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> &completeHandler = <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>());</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <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="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <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="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <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>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">// WiconnectResult startSoftAp(const char* ssid = NULL, const char *password = NULL, const Callback &clientConnectedCallback = Callback());</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">// WiconnectResult stopSoftAp();</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">// WiconnectResult getSoftApClientList();</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <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> &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="l00204"></a><span class="lineno"> 204</span> </div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <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="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <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="l00230"></a><span class="lineno"> 230</span> </div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <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="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <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="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <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="l00257"></a><span class="lineno"> 257</span> </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <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="l00264"></a><span class="lineno"> 264</span> </div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <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="l00271"></a><span class="lineno"> 271</span> </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <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="l00278"></a><span class="lineno"> 278</span> </div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <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 = NULL);</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> </div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> </div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <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="l00302"></a><span class="lineno"> 302</span> </div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <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="l00309"></a><span class="lineno"> 309</span> </div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <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="l00316"></a><span class="lineno"> 316</span> </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <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>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  <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="l00330"></a><span class="lineno"> 330</span> </div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <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="l00337"></a><span class="lineno"> 337</span> </div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  <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="l00344"></a><span class="lineno"> 344</span> </div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  <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="l00351"></a><span class="lineno"> 351</span> </div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <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="l00358"></a><span class="lineno"> 358</span> </div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <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="l00365"></a><span class="lineno"> 365</span> </div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <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="l00372"></a><span class="lineno"> 372</span> </div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <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="l00379"></a><span class="lineno"> 379</span> </div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <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="l00382"></a><span class="lineno"> 382</span> </div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <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> &resultList);</div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> </div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="preprocessor">#ifdef WICONNECT_ASYNC_TIMER_ENABLED</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> completeHandler;</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  PeriodicTimer monitorTimer;</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> </div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  <span class="keywordtype">void</span> webSetupStatusMonitor();</div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  <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="l00391"></a><span class="lineno"> 391</span> </div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="keywordtype">void</span> joinStatusMonitor();</div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <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="l00394"></a><span class="lineno"> 394</span> </div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  <span class="comment">//void scanCompleteCallback(WiconnectResult result, void *arg1, void *arg2);</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> </div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> };</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> </div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> }</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#l00267">WiconnectTypes.h:267</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#l00049">NetworkInterface.h:49</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#l00159">WiconnectTypes.h:159</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#l00049">Callback.h:49</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_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>
<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#l00293">WiconnectTypes.h:293</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 &completeHandler=Callback())</div><div class="ttdoc">Start the WiConnect WiFi module 'web setup' 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__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>
<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 'web setup' 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#l00253">WiconnectTypes.h:253</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 &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#l00283">WiconnectTypes.h:283</a></div></div>
<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#l00236">WiconnectTypes.h:236</a></div></div>
<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>
<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#l00046">ScanResultList.h:46</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#l00074">WiconnectInterface.h:74</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 'web setup' 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#l00224">WiconnectTypes.h:224</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 &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">© ACKme Networks 2014</li>
</ul>
</div>
</body>
</html>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02