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__setup.html

Revision:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
26:8067e3d463d3
--- a/doc/html/group__api__network__setup.html	Tue Aug 12 02:44:34 2014 -0700
+++ b/doc/html/group__api__network__setup.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: Web Setup</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,125 @@
   <div class="summary">
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
-<div class="title">Web Setup<div class="ingroups"><a class="el" href="group__api__network.html">Network API</a></div></div>  </div>
+<div class="title">Web Setup 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 enabled/disabling module web setup.  
+<p>Methods for enabled/disabling module web setup.  
 <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:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaea3e133f2ee8c95d8d108c15561f3847"></a>
-WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">wiconnect::NetworkInterface::startWebSetup</a> (const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</td></tr>
-<tr class="memdesc:gaea3e133f2ee8c95d8d108c15561f3847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the WiConnect WiFi module 'web setup' feature. <br /></td></tr>
+<tr class="memitem:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">wiconnect::NetworkInterface::startWebSetup</a> (const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</td></tr>
+<tr class="memdesc:gaea3e133f2ee8c95d8d108c15561f3847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the WiConnect WiFi module 'web setup' feature.  <a href="#gaea3e133f2ee8c95d8d108c15561f3847">More...</a><br /></td></tr>
 <tr class="separator:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac5ca67b7bfa587935b5619e441dc8d8a"></a>
-WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">wiconnect::NetworkInterface::stopWebSetup</a> ()</td></tr>
-<tr class="memdesc:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the WiConnect WiFi module 'web setup' feature. <br /></td></tr>
+<tr class="memitem:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">wiconnect::NetworkInterface::stopWebSetup</a> ()</td></tr>
+<tr class="memdesc:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the WiConnect WiFi module 'web setup' feature.  <a href="#gac5ca67b7bfa587935b5619e441dc8d8a">More...</a><br /></td></tr>
 <tr class="separator:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gab52d3a01427d0e8bd52460d992144f65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab52d3a01427d0e8bd52460d992144f65"></a>
-WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">wiconnect::NetworkInterface::isWebSetupRunning</a> (bool *isRunningPtr)</td></tr>
-<tr class="memdesc:gab52d3a01427d0e8bd52460d992144f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return status of WiConnect WiFi module 'web setup' feature. <br /></td></tr>
+<tr class="memitem:gab52d3a01427d0e8bd52460d992144f65"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">wiconnect::NetworkInterface::isWebSetupRunning</a> (bool *isRunningPtr)</td></tr>
+<tr class="memdesc:gab52d3a01427d0e8bd52460d992144f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return status of WiConnect WiFi module 'web setup' feature.  <a href="#gab52d3a01427d0e8bd52460d992144f65">More...</a><br /></td></tr>
 <tr class="separator:gab52d3a01427d0e8bd52460d992144f65"><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 enabled/disabling module web setup. </p>
+<p>Methods for enabled/disabling module web setup. </p>
+<h2 class="groupheader">Function Documentation</h2>
+<a class="anchor" id="gab52d3a01427d0e8bd52460d992144f65"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">WiconnectResult wiconnect::NetworkInterface::isWebSetupRunning </td>
+          <td>(</td>
+          <td class="paramtype">bool *&#160;</td>
+          <td class="paramname"><em>isRunningPtr</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Return status of WiConnect WiFi module 'web setup' feature. </p>
+<p>This may be called at any time (whether web setpu has been stared or not).</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">isRunningPtr</td><td>Pointer to bool to contain TRUE if web setup is running, FALSE else </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="gaea3e133f2ee8c95d8d108c15561f3847"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">WiconnectResult wiconnect::NetworkInterface::startWebSetup </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>Start the WiConnect WiFi module 'web setup' feature. </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 web setup status (essentially it'll call <a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65" title="Return status of WiConnect WiFi module &#39;web setup&#39; feature. ">isWebSetupRunning()</a> every second in the background). When the web setup is no longer running the callback will be executed. The background processing is disabled when <a class="el" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a" title="Stop the WiConnect WiFi module &#39;web setup&#39; feature. ">stopWebSetup()</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 module's softAp </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Optional, optionally set the WPA2-PSK password for the module'S softap Note: make an OPEN softAp, 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 module web setup 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="gac5ca67b7bfa587935b5619e441dc8d8a"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">WiconnectResult wiconnect::NetworkInterface::stopWebSetup </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Stop the WiConnect WiFi module 'web setup' feature. </p>
+<p>This method should be called AFTER <a class="el" href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847" title="Start the WiConnect WiFi module &#39;web setup&#39; feature. ">startWebSetup()</a> to prematurely terminate web setup. Note that this is not needed if web setup completes by itself (i.e. if the user exits web setup from the webpage).</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:22 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