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/group__api__network__wlan.html

Revision:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
17:7268f365676b
--- a/doc/html/group__api__network__wlan.html	Tue Aug 12 02:44:34 2014 -0700
+++ b/doc/html/group__api__network__wlan.html	Wed Aug 13 03:14:30 2014 -0700
@@ -3,8 +3,9 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.7"/>
-<title>WiConnect Library: WLAN</title>
+<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>
@@ -24,29 +25,30 @@
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
-  <td style="padding-left: 0.5em;">
-   <div id="projectname">WiConnect Library
-   </div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.7 -->
+<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>Main&#160;Page</span></a></li>
-      <li><a href="modules.html"><span>Modules</span></a></li>
-      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <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">
@@ -98,39 +100,126 @@
   <div class="summary">
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
-<div class="title">WLAN<div class="ingroups"><a class="el" href="group__api__network.html">Network API</a></div></div>  </div>
+<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>API methods for joining/leaving a WLAN.  
+<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"><a class="anchor" id="gac439d0af5a17da32d405e25dcba83d16"></a>
-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>
-<tr class="memdesc:gac439d0af5a17da32d405e25dcba83d16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join a WiFi network. <br /></td></tr>
+<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>
+<tr class="memdesc:gac439d0af5a17da32d405e25dcba83d16"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
-<tr class="memitem:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga14dc0f4fa58a7ebb25b77fae22052328"></a>
-WiconnectResult&#160;</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">&#160;</td><td class="mdescRight">Leave a WiFi network. <br /></td></tr>
+<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>
+<tr class="memdesc:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
-<tr class="memitem:ga047ba9670f60406466391cec5bdd28e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga047ba9670f60406466391cec5bdd28e5"></a>
-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>
-<tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get connection status to WiFi network. <br /></td></tr>
+<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>
+<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>
 <tr class="separator:ga047ba9670f60406466391cec5bdd28e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<p>API methods for joining/leaving a WLAN. </p>
+<p>Methods for joining/leaving a WLAN. </p>
+<h2 class="groupheader">Function Documentation</h2>
+<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> *&#160;</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 *&#160;</td>
+          <td class="paramname"><em>ssid</em> = <code>NULL</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</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> &amp;&#160;</td>
+          <td class="paramname"><em>completeHandler</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Join a WiFi network. </p>
+<dl class="section note"><dt>Note</dt><dd>This command is returns when the join sequence has STARTED. To determine if the module has successfully join the network either specify the completeHandler or periodically call <a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5" title="Get connection status to WiFi network. ">getNetworkStatus()</a></dd></dl>
+<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>
+<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. </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 -->
-<!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Tue Aug 12 2014 02:15:21 for WiConnect Library by
-    <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
+    <li class="footer">&copy; ACKme Networks 2014</li>
   </ul>
 </div>
 </body>
-</html>
+</html>
\ No newline at end of file