ACKme
Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/mbed/html/group__api__network__wlan.html
- Committer:
- dan_ackme
- Date:
- 2014-11-26
- Revision:
- 34:2616445d0823
File content as of revision 34:2616445d0823:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect Repository</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__api__network__wlan.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">WLAN Methods<div class="ingroups"><a class="el" href="group__api__network.html">Network</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Methods for joining/leaving a WLAN.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac439d0af5a17da32d405e25dcba83d16"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">wiconnect::NetworkInterface::join</a> (const char *ssid=NULL, const char *password=NULL, const Callback &completeHandler=Callback())</td></tr>
<tr class="memdesc:gac439d0af5a17da32d405e25dcba83d16"><td class="mdescLeft"> </td><td class="mdescRight">Join a WiFi network. <a href="#gac439d0af5a17da32d405e25dcba83d16">More...</a><br /></td></tr>
<tr class="separator:gac439d0af5a17da32d405e25dcba83d16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">wiconnect::NetworkInterface::leave</a> ()</td></tr>
<tr class="memdesc:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="mdescLeft"> </td><td class="mdescRight">Leave a WiFi network. <a href="#ga14dc0f4fa58a7ebb25b77fae22052328">More...</a><br /></td></tr>
<tr class="separator:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga047ba9670f60406466391cec5bdd28e5"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">wiconnect::NetworkInterface::getNetworkStatus</a> (NetworkStatus *statusPtr)</td></tr>
<tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5"><td class="mdescLeft"> </td><td class="mdescRight">Get connection status to WiFi network. <a href="#ga047ba9670f60406466391cec5bdd28e5">More...</a><br /></td></tr>
<tr class="separator:ga047ba9670f60406466391cec5bdd28e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">wiconnect::NetworkInterface::getNetworkJoinResult</a> (NetworkJoinResult *joinResultPtr)</td></tr>
<tr class="memdesc:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="mdescLeft"> </td><td class="mdescRight">Get the result of joining the network. <a href="#gafefe6e679d7b48a7127d3ed6371fe58b">More...</a><br /></td></tr>
<tr class="separator:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba16b9918e55c08285cf5b8b50dbabea"></a>
WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gaba16b9918e55c08285cf5b8b50dbabea">wiconnect::NetworkInterface::getSignalStrength</a> (NetworkSignalStrength *signalStrengthPtr)</td></tr>
<tr class="memdesc:gaba16b9918e55c08285cf5b8b50dbabea"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> of WiFi network module is connected. <br /></td></tr>
<tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa9db3c463cf6b4f351c37671882dd3ee"></a>
WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gaa9db3c463cf6b4f351c37671882dd3ee">wiconnect::NetworkInterface::getRssi</a> (int32_t *rssiPtr)</td></tr>
<tr class="memdesc:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="mdescLeft"> </td><td class="mdescRight">Get the RSSI in dBm of WiFi network. <br /></td></tr>
<tr class="separator:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70991a2c5865c8f0b44b67de35f3b6b3"></a>
WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga70991a2c5865c8f0b44b67de35f3b6b3">wiconnect::NetworkInterface::getMacAddress</a> (MacAddress *macAddress)</td></tr>
<tr class="memdesc:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="mdescLeft"> </td><td class="mdescRight">Get MAC address of the WiFi module. <br /></td></tr>
<tr class="separator:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Methods for joining/leaving a WLAN. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gafefe6e679d7b48a7127d3ed6371fe58b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WiconnectResult wiconnect::NetworkInterface::getNetworkJoinResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> * </td>
<td class="paramname"><em>joinResultPtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the result of joining the network. </p>
<p>Refer to <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> for more info.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">joinResultPtr</td><td>Point to a <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> which will hold the result of joining the network </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga047ba9670f60406466391cec5bdd28e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WiconnectResult wiconnect::NetworkInterface::getNetworkStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> * </td>
<td class="paramname"><em>statusPtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get connection status to WiFi network. </p>
<p>Refer to <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> for more info.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">statusPtr</td><td>Point to a <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> which will hold current network status of module </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac439d0af5a17da32d405e25dcba83d16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WiconnectResult wiconnect::NetworkInterface::join </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ssid</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td>
<td class="paramname"><em>completeHandler</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Join a WiFi network. </p>
<p>This command has an optional background processing feature. Background processing is enabled if the completeHandler parameter is specified. If enabled, the library will poll the module every second for the join status (essentially it'll call <a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5" title="Get connection status to WiFi network. ">getNetworkStatus()</a> every second in the background). When the module join sequence complete the callback will be executed. The background processing is disabled when <a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328" title="Leave a WiFi network. ">leave()</a> is called.</p>
<ul>
<li>If completeHandler parameter is NOT specified: This command will BLOCK/return WICONNECT_PROCESSING until the module has either successfully joined the network or failed.</li>
<li>If the completeHandler parameter IS specified: This command will return and use the background processing feature described above.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>only the 'result' parameter of the callback handler is valid.</dd></dl>
<p>Refer to <a class="el" href="index.html#setting_async_processing">Asynchronous Processing</a> for more info.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssid</td><td>Optional, optionally set the SSID of the network to join </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Optional, optionally set the passkey of the network to join Note: to join an OPEN network, set this parameter to a null string (i.e. "") </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">completeHandler</td><td>Optional, callback to be executed when the join sequence completes. The 'result' callback parameter contains the WiconnectResult of joining. The 'arg1' parameter is a <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> of joining. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga14dc0f4fa58a7ebb25b77fae22052328"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WiconnectResult wiconnect::NetworkInterface::leave </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Leave a WiFi network. </p>
<p>This method may be called to either terminate a join sequence or leave a previously connected networked.</p>
<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</li>
</ul>
</div>
</body>
</html>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02