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

Revision:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
26:8067e3d463d3
--- a/doc/html/modules.html	Tue Aug 12 02:44:34 2014 -0700
+++ b/doc/html/modules.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: Modules</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 class="current"><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 class="current"><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">
@@ -96,48 +98,49 @@
 
 <div class="header">
   <div class="headertitle">
-<div class="title">Modules</div>  </div>
+<div class="title">Library API</div>  </div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock">Here is a list of all modules:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
-<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group__api__core.html" target="_self">Core API</a></td><td class="desc">This contains all core API Library methods </td></tr>
-<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__settings.html" target="_self">Settings</a></td><td class="desc">API getters/setters for core library settings </td></tr>
-<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__send__command.html" target="_self">Send Command</a></td><td class="desc">API methods for sending commands to WiConnect WiFi module </td></tr>
-<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__misc.html" target="_self">Miscellaneous</a></td><td class="desc">Other core API methods </td></tr>
-<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__macro.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr>
-<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><a class="el" href="group__api__network.html" target="_self">Network API</a></td><td class="desc">This contains all network API Library methods </td></tr>
-<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__settings.html" target="_self">Settings</a></td><td class="desc">API getters/setters for module network settings </td></tr>
-<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__wlan.html" target="_self">WLAN</a></td><td class="desc">API methods for joining/leaving a WLAN </td></tr>
-<tr id="row_1_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__setup.html" target="_self">Web Setup</a></td><td class="desc">API methods for enabled/disabling module web setup </td></tr>
-<tr id="row_1_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__util.html" target="_self">Utilities</a></td><td class="desc">Network utility API methods </td></tr>
-<tr id="row_1_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__macros.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr>
-<tr id="row_2_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><a class="el" href="group__api__socket.html" target="_self">Socket API</a></td><td class="desc">This contains all socket API Library methods </td></tr>
-<tr id="row_2_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__tcp.html" target="_self">TCP</a></td><td class="desc">TCP API methods </td></tr>
-<tr id="row_2_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__udp.html" target="_self">UDP</a></td><td class="desc">UDP API methods </td></tr>
-<tr id="row_2_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__tls.html" target="_self">TLS</a></td><td class="desc">TLS API methods </td></tr>
-<tr id="row_2_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__http.html" target="_self">HTTP</a></td><td class="desc">HTTP API methods </td></tr>
-<tr id="row_2_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__misc.html" target="_self">Miscellaneous</a></td><td class="desc">Miscellaneous socket API methods </td></tr>
-<tr id="row_2_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__macro.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr>
-<tr id="row_3_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">&#9660;</span><a class="el" href="group__api__file.html" target="_self">File API</a></td><td class="desc">This contains all file API Library methods </td></tr>
-<tr id="row_3_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__file__macro.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr>
-<tr id="row_4_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">&#9660;</span><a class="el" href="group__types.html" target="_self">Types</a></td><td class="desc">This contains all the Library typedefs and classes (including constructors) </td></tr>
-<tr id="row_4_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__types__core.html" target="_self">Core API</a></td><td class="desc">Core API Types </td></tr>
-<tr id="row_4_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__types__network.html" target="_self">Network API</a></td><td class="desc">Network API Types </td></tr>
-<tr id="row_4_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__types__socket.html" target="_self">Socket API</a></td><td class="desc">Socket API Types </td></tr>
-<tr id="row_4_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__types__file.html" target="_self">File API</a></td><td class="desc">File API Types </td></tr>
-<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__conversion__util.html" target="_self">Conversion Utilities</a></td><td class="desc">This contains all the conversion utility static functions </td></tr>
+<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group__api__core.html" target="_self">Core</a></td><td class="desc">This contains all core methods </td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__settings.html" target="_self">Settings Methods</a></td><td class="desc">API getters/setters for core library settings </td></tr>
+<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__send__command.html" target="_self">Send Command Methods</a></td><td class="desc">API methods for sending commands to WiConnect WiFi module </td></tr>
+<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__misc.html" target="_self">Miscellaneous Methods</a></td><td class="desc">Other core methods </td></tr>
+<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__types.html" target="_self">Types</a></td><td class="desc">Core Types </td></tr>
+<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__macro.html" target="_self">Macros</a></td><td class="desc">Core macros </td></tr>
+<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__core__examples.html" target="_self">Examples</a></td><td class="desc">Core examples </td></tr>
+<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><a class="el" href="group__api__network.html" target="_self">Network</a></td><td class="desc">This contains all network methods </td></tr>
+<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__settings.html" target="_self">Settings Methods</a></td><td class="desc">API getters/setters for module network settings </td></tr>
+<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__wlan.html" target="_self">WLAN Methods</a></td><td class="desc">Methods for joining/leaving a WLAN </td></tr>
+<tr id="row_1_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__setup.html" target="_self">Web Setup Methods</a></td><td class="desc">Methods for enabled/disabling module web setup </td></tr>
+<tr id="row_1_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__util.html" target="_self">Utility Methods</a></td><td class="desc">Network utility methods </td></tr>
+<tr id="row_1_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__types.html" target="_self">Types</a></td><td class="desc">Network Types </td></tr>
+<tr id="row_1_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__macros.html" target="_self">Macros</a></td><td class="desc">Network specific macros </td></tr>
+<tr id="row_1_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__network__examples.html" target="_self">Examples</a></td><td class="desc">Network examples </td></tr>
+<tr id="row_2_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><a class="el" href="group__api__socket.html" target="_self">Socket</a></td><td class="desc">This contains all socket methods </td></tr>
+<tr id="row_2_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__tcp.html" target="_self">TCP Methods</a></td><td class="desc">TCP methods </td></tr>
+<tr id="row_2_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__udp.html" target="_self">UDP Methods</a></td><td class="desc">UDP methods </td></tr>
+<tr id="row_2_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__tls.html" target="_self">TLS Methods</a></td><td class="desc">TLS methods </td></tr>
+<tr id="row_2_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__http.html" target="_self">HTTP Methods</a></td><td class="desc">HTTP methods </td></tr>
+<tr id="row_2_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__misc.html" target="_self">Miscellaneous Methods</a></td><td class="desc">Miscellaneous socket methods </td></tr>
+<tr id="row_2_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__types.html" target="_self">Types</a></td><td class="desc">Socket Types </td></tr>
+<tr id="row_2_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__macro.html" target="_self">Macros</a></td><td class="desc">Socket specific macros </td></tr>
+<tr id="row_2_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__socket__examples.html" target="_self">Examples</a></td><td class="desc">Socket examples </td></tr>
+<tr id="row_3_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">&#9660;</span><a class="el" href="group__api__file.html" target="_self">File</a></td><td class="desc">This contains all file methods </td></tr>
+<tr id="row_3_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__file__methods.html" target="_self">Methods</a></td><td class="desc">File Types </td></tr>
+<tr id="row_3_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__file__types.html" target="_self">Types</a></td><td class="desc">File Types </td></tr>
+<tr id="row_3_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__file__macro.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr>
+<tr id="row_3_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__api__file__examples.html" target="_self">Examples</a></td><td class="desc">File examples </td></tr>
+<tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__conversion__util.html" target="_self">Conversion Utilities</a></td><td class="desc">This contains all the conversion utility static functions </td></tr>
 </table>
 </div><!-- directory -->
 </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:27 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