ACKme / WiConnect

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

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

doc/html/group__api__network__wlan.html@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3 
refactored library layout

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 10:735194df0097 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 10:735194df0097 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 10:735194df0097 3 <head>
dan_ackme 10:735194df0097 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 10:735194df0097 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 13:2b51f5267c92 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 13:2b51f5267c92 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 13:2b51f5267c92 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 10:735194df0097 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 15 <script type="text/javascript">
dan_ackme 10:735194df0097 16 $(document).ready(initResizable);
dan_ackme 10:735194df0097 17 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 18 </script>
dan_ackme 11:ea484e1b7fc4 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 21 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 23 </script>
dan_ackme 10:735194df0097 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 25 </head>
dan_ackme 10:735194df0097 26 <body>
dan_ackme 10:735194df0097 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 13:2b51f5267c92 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 13:2b51f5267c92 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 13:2b51f5267c92 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 13:2b51f5267c92 32 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 13:2b51f5267c92 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 13:2b51f5267c92 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 13:2b51f5267c92 36 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 37 </tr>
dan_ackme 13:2b51f5267c92 38 <tr><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 39 </table>
dan_ackme 13:2b51f5267c92 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 11:ea484e1b7fc4 41 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 11:ea484e1b7fc4 43 </script>
dan_ackme 10:735194df0097 44 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 45 <ul class="tablist">
dan_ackme 13:2b51f5267c92 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 10:735194df0097 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 26:8067e3d463d3 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 11:ea484e1b7fc4 52 <li>
dan_ackme 11:ea484e1b7fc4 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 54 <span class="left">
dan_ackme 11:ea484e1b7fc4 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 58 alt=""/>
dan_ackme 11:ea484e1b7fc4 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 63 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 65 </span>
dan_ackme 11:ea484e1b7fc4 66 </div>
dan_ackme 11:ea484e1b7fc4 67 </li>
dan_ackme 10:735194df0097 68 </ul>
dan_ackme 10:735194df0097 69 </div>
dan_ackme 10:735194df0097 70 </div><!-- top -->
dan_ackme 10:735194df0097 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 72 <div id="nav-tree">
dan_ackme 10:735194df0097 73 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 74 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 75 </div>
dan_ackme 10:735194df0097 76 </div>
dan_ackme 10:735194df0097 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 78 class="ui-resizable-handle">
dan_ackme 10:735194df0097 79 </div>
dan_ackme 10:735194df0097 80 </div>
dan_ackme 10:735194df0097 81 <script type="text/javascript">
dan_ackme 10:735194df0097 82 $(document).ready(function(){initNavTree('group__api__network__wlan.html','');});
dan_ackme 10:735194df0097 83 </script>
dan_ackme 10:735194df0097 84 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 85 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 86 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 90 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 11:ea484e1b7fc4 91
dan_ackme 11:ea484e1b7fc4 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 93 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 95 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 96 </iframe>
dan_ackme 11:ea484e1b7fc4 97 </div>
dan_ackme 11:ea484e1b7fc4 98
dan_ackme 10:735194df0097 99 <div class="header">
dan_ackme 11:ea484e1b7fc4 100 <div class="summary">
dan_ackme 11:ea484e1b7fc4 101 <a href="#func-members">Functions</a> </div>
dan_ackme 10:735194df0097 102 <div class="headertitle">
dan_ackme 13:2b51f5267c92 103 <div class="title">WLAN Methods<div class="ingroups"><a class="el" href="group__api__network.html">Network</a></div></div> </div>
dan_ackme 10:735194df0097 104 </div><!--header-->
dan_ackme 10:735194df0097 105 <div class="contents">
dan_ackme 10:735194df0097 106
dan_ackme 13:2b51f5267c92 107 <p>Methods for joining/leaving a WLAN.
dan_ackme 10:735194df0097 108 <a href="#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 109 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 11:ea484e1b7fc4 111 Functions</h2></td></tr>
dan_ackme 13:2b51f5267c92 112 <tr class="memitem:gac439d0af5a17da32d405e25dcba83d16"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</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 &amp;completeHandler=Callback())</td></tr>
dan_ackme 13:2b51f5267c92 113 <tr class="memdesc:gac439d0af5a17da32d405e25dcba83d16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join a WiFi network. <a href="#gac439d0af5a17da32d405e25dcba83d16">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 114 <tr class="separator:gac439d0af5a17da32d405e25dcba83d16"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 115 <tr class="memitem:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">wiconnect::NetworkInterface::leave</a> ()</td></tr>
dan_ackme 13:2b51f5267c92 116 <tr class="memdesc:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave a WiFi network. <a href="#ga14dc0f4fa58a7ebb25b77fae22052328">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 117 <tr class="separator:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 13:2b51f5267c92 118 <tr class="memitem:ga047ba9670f60406466391cec5bdd28e5"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">wiconnect::NetworkInterface::getNetworkStatus</a> (NetworkStatus *statusPtr)</td></tr>
dan_ackme 13:2b51f5267c92 119 <tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get connection status to WiFi network. <a href="#ga047ba9670f60406466391cec5bdd28e5">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 120 <tr class="separator:ga047ba9670f60406466391cec5bdd28e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 26:8067e3d463d3 121 <tr class="memitem:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">wiconnect::NetworkInterface::getNetworkJoinResult</a> (NetworkJoinResult *joinResultPtr)</td></tr>
dan_ackme 26:8067e3d463d3 122 <tr class="memdesc:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result of joining the network. <a href="#gafefe6e679d7b48a7127d3ed6371fe58b">More...</a><br /></td></tr>
dan_ackme 26:8067e3d463d3 123 <tr class="separator:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 124 <tr class="memitem:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba16b9918e55c08285cf5b8b50dbabea"></a>
dan_ackme 29:b6af04b77a56 125 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gaba16b9918e55c08285cf5b8b50dbabea">wiconnect::NetworkInterface::getSignalStrength</a> (NetworkSignalStrength *signalStrengthPtr)</td></tr>
dan_ackme 29:b6af04b77a56 126 <tr class="memdesc:gaba16b9918e55c08285cf5b8b50dbabea"><td class="mdescLeft">&#160;</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>
dan_ackme 29:b6af04b77a56 127 <tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 128 <tr class="memitem:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa9db3c463cf6b4f351c37671882dd3ee"></a>
dan_ackme 29:b6af04b77a56 129 WiconnectResult&#160;</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>
dan_ackme 29:b6af04b77a56 130 <tr class="memdesc:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RSSI in dBm of WiFi network. <br /></td></tr>
dan_ackme 29:b6af04b77a56 131 <tr class="separator:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 132 <tr class="memitem:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70991a2c5865c8f0b44b67de35f3b6b3"></a>
dan_ackme 29:b6af04b77a56 133 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga70991a2c5865c8f0b44b67de35f3b6b3">wiconnect::NetworkInterface::getMacAddress</a> (MacAddress *macAddress)</td></tr>
dan_ackme 29:b6af04b77a56 134 <tr class="memdesc:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get MAC address of the WiFi module. <br /></td></tr>
dan_ackme 29:b6af04b77a56 135 <tr class="separator:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 136 </table>
dan_ackme 11:ea484e1b7fc4 137 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 13:2b51f5267c92 138 <p>Methods for joining/leaving a WLAN. </p>
dan_ackme 13:2b51f5267c92 139 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 26:8067e3d463d3 140 <a class="anchor" id="gafefe6e679d7b48a7127d3ed6371fe58b"></a>
dan_ackme 26:8067e3d463d3 141 <div class="memitem">
dan_ackme 26:8067e3d463d3 142 <div class="memproto">
dan_ackme 26:8067e3d463d3 143 <table class="memname">
dan_ackme 26:8067e3d463d3 144 <tr>
dan_ackme 26:8067e3d463d3 145 <td class="memname">WiconnectResult wiconnect::NetworkInterface::getNetworkJoinResult </td>
dan_ackme 26:8067e3d463d3 146 <td>(</td>
dan_ackme 26:8067e3d463d3 147 <td class="paramtype"><a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> *&#160;</td>
dan_ackme 26:8067e3d463d3 148 <td class="paramname"><em>joinResultPtr</em></td><td>)</td>
dan_ackme 26:8067e3d463d3 149 <td></td>
dan_ackme 26:8067e3d463d3 150 </tr>
dan_ackme 26:8067e3d463d3 151 </table>
dan_ackme 26:8067e3d463d3 152 </div><div class="memdoc">
dan_ackme 26:8067e3d463d3 153
dan_ackme 26:8067e3d463d3 154 <p>Get the result of joining the network. </p>
dan_ackme 26:8067e3d463d3 155 <p>Refer to <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> for more info.</p>
dan_ackme 26:8067e3d463d3 156 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 26:8067e3d463d3 157 <table class="params">
dan_ackme 26:8067e3d463d3 158 <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>
dan_ackme 26:8067e3d463d3 159 </table>
dan_ackme 26:8067e3d463d3 160 </dd>
dan_ackme 26:8067e3d463d3 161 </dl>
dan_ackme 26:8067e3d463d3 162 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 26:8067e3d463d3 163
dan_ackme 26:8067e3d463d3 164 </div>
dan_ackme 26:8067e3d463d3 165 </div>
dan_ackme 13:2b51f5267c92 166 <a class="anchor" id="ga047ba9670f60406466391cec5bdd28e5"></a>
dan_ackme 13:2b51f5267c92 167 <div class="memitem">
dan_ackme 13:2b51f5267c92 168 <div class="memproto">
dan_ackme 13:2b51f5267c92 169 <table class="memname">
dan_ackme 13:2b51f5267c92 170 <tr>
dan_ackme 13:2b51f5267c92 171 <td class="memname">WiconnectResult wiconnect::NetworkInterface::getNetworkStatus </td>
dan_ackme 13:2b51f5267c92 172 <td>(</td>
dan_ackme 13:2b51f5267c92 173 <td class="paramtype"><a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> *&#160;</td>
dan_ackme 13:2b51f5267c92 174 <td class="paramname"><em>statusPtr</em></td><td>)</td>
dan_ackme 13:2b51f5267c92 175 <td></td>
dan_ackme 13:2b51f5267c92 176 </tr>
dan_ackme 13:2b51f5267c92 177 </table>
dan_ackme 13:2b51f5267c92 178 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 179
dan_ackme 13:2b51f5267c92 180 <p>Get connection status to WiFi network. </p>
dan_ackme 13:2b51f5267c92 181 <p>Refer to <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> for more info.</p>
dan_ackme 13:2b51f5267c92 182 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 183 <table class="params">
dan_ackme 13:2b51f5267c92 184 <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>
dan_ackme 13:2b51f5267c92 185 </table>
dan_ackme 13:2b51f5267c92 186 </dd>
dan_ackme 13:2b51f5267c92 187 </dl>
dan_ackme 13:2b51f5267c92 188 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 13:2b51f5267c92 189
dan_ackme 13:2b51f5267c92 190 </div>
dan_ackme 13:2b51f5267c92 191 </div>
dan_ackme 13:2b51f5267c92 192 <a class="anchor" id="gac439d0af5a17da32d405e25dcba83d16"></a>
dan_ackme 13:2b51f5267c92 193 <div class="memitem">
dan_ackme 13:2b51f5267c92 194 <div class="memproto">
dan_ackme 13:2b51f5267c92 195 <table class="memname">
dan_ackme 13:2b51f5267c92 196 <tr>
dan_ackme 13:2b51f5267c92 197 <td class="memname">WiconnectResult wiconnect::NetworkInterface::join </td>
dan_ackme 13:2b51f5267c92 198 <td>(</td>
dan_ackme 13:2b51f5267c92 199 <td class="paramtype">const char *&#160;</td>
dan_ackme 13:2b51f5267c92 200 <td class="paramname"><em>ssid</em> = <code>NULL</code>, </td>
dan_ackme 13:2b51f5267c92 201 </tr>
dan_ackme 13:2b51f5267c92 202 <tr>
dan_ackme 13:2b51f5267c92 203 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 204 <td></td>
dan_ackme 13:2b51f5267c92 205 <td class="paramtype">const char *&#160;</td>
dan_ackme 13:2b51f5267c92 206 <td class="paramname"><em>password</em> = <code>NULL</code>, </td>
dan_ackme 13:2b51f5267c92 207 </tr>
dan_ackme 13:2b51f5267c92 208 <tr>
dan_ackme 13:2b51f5267c92 209 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 210 <td></td>
dan_ackme 13:2b51f5267c92 211 <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;&#160;</td>
dan_ackme 13:2b51f5267c92 212 <td class="paramname"><em>completeHandler</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code>&#160;</td>
dan_ackme 13:2b51f5267c92 213 </tr>
dan_ackme 13:2b51f5267c92 214 <tr>
dan_ackme 13:2b51f5267c92 215 <td></td>
dan_ackme 13:2b51f5267c92 216 <td>)</td>
dan_ackme 13:2b51f5267c92 217 <td></td><td></td>
dan_ackme 13:2b51f5267c92 218 </tr>
dan_ackme 13:2b51f5267c92 219 </table>
dan_ackme 13:2b51f5267c92 220 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 221
dan_ackme 13:2b51f5267c92 222 <p>Join a WiFi network. </p>
dan_ackme 13:2b51f5267c92 223 <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>
dan_ackme 17:7268f365676b 224 <ul>
dan_ackme 17:7268f365676b 225 <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>
dan_ackme 17:7268f365676b 226 <li>If the completeHandler parameter IS specified: This command will return and use the background processing feature described above.</li>
dan_ackme 17:7268f365676b 227 </ul>
dan_ackme 13:2b51f5267c92 228 <dl class="section note"><dt>Note</dt><dd>only the 'result' parameter of the callback handler is valid.</dd></dl>
dan_ackme 13:2b51f5267c92 229 <p>Refer to <a class="el" href="index.html#setting_async_processing">Asynchronous Processing</a> for more info.</p>
dan_ackme 13:2b51f5267c92 230 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 231 <table class="params">
dan_ackme 13:2b51f5267c92 232 <tr><td class="paramdir">[in]</td><td class="paramname">ssid</td><td>Optional, optionally set the SSID of the network to join </td></tr>
dan_ackme 13:2b51f5267c92 233 <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>
dan_ackme 26:8067e3d463d3 234 <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>
dan_ackme 13:2b51f5267c92 235 </table>
dan_ackme 13:2b51f5267c92 236 </dd>
dan_ackme 13:2b51f5267c92 237 </dl>
dan_ackme 13:2b51f5267c92 238 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 13:2b51f5267c92 239
dan_ackme 13:2b51f5267c92 240 </div>
dan_ackme 13:2b51f5267c92 241 </div>
dan_ackme 13:2b51f5267c92 242 <a class="anchor" id="ga14dc0f4fa58a7ebb25b77fae22052328"></a>
dan_ackme 13:2b51f5267c92 243 <div class="memitem">
dan_ackme 13:2b51f5267c92 244 <div class="memproto">
dan_ackme 13:2b51f5267c92 245 <table class="memname">
dan_ackme 13:2b51f5267c92 246 <tr>
dan_ackme 13:2b51f5267c92 247 <td class="memname">WiconnectResult wiconnect::NetworkInterface::leave </td>
dan_ackme 13:2b51f5267c92 248 <td>(</td>
dan_ackme 13:2b51f5267c92 249 <td class="paramname"></td><td>)</td>
dan_ackme 13:2b51f5267c92 250 <td></td>
dan_ackme 13:2b51f5267c92 251 </tr>
dan_ackme 13:2b51f5267c92 252 </table>
dan_ackme 13:2b51f5267c92 253 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 254
dan_ackme 13:2b51f5267c92 255 <p>Leave a WiFi network. </p>
dan_ackme 13:2b51f5267c92 256 <p>This method may be called to either terminate a join sequence or leave a previously connected networked.</p>
dan_ackme 13:2b51f5267c92 257 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 13:2b51f5267c92 258
dan_ackme 13:2b51f5267c92 259 </div>
dan_ackme 13:2b51f5267c92 260 </div>
dan_ackme 10:735194df0097 261 </div><!-- contents -->
dan_ackme 10:735194df0097 262 </div><!-- doc-content -->
dan_ackme 10:735194df0097 263 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 264 <ul>
dan_ackme 13:2b51f5267c92 265 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 266 </ul>
dan_ackme 10:735194df0097 267 </div>
dan_ackme 10:735194df0097 268 </body>
dan_ackme 13:2b51f5267c92 269 </html>