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/modules.html@13:2b51f5267c92, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 03:14:30 2014 -0700
Revision:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
26:8067e3d463d3
doc updates

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 class="current"><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 13:2b51f5267c92 50 <li><a href="http://wiconnect.ack.me/1.2/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('modules.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 10:735194df0097 100 <div class="headertitle">
dan_ackme 13:2b51f5267c92 101 <div class="title">Library API</div> </div>
dan_ackme 10:735194df0097 102 </div><!--header-->
dan_ackme 10:735194df0097 103 <div class="contents">
dan_ackme 10:735194df0097 104 <div class="textblock">Here is a list of all modules:</div><div class="directory">
dan_ackme 10:735194df0097 105 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
dan_ackme 13:2b51f5267c92 106 <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>
dan_ackme 13:2b51f5267c92 107 <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>
dan_ackme 13:2b51f5267c92 108 <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>
dan_ackme 13:2b51f5267c92 109 <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>
dan_ackme 13:2b51f5267c92 110 <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>
dan_ackme 13:2b51f5267c92 111 <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>
dan_ackme 13:2b51f5267c92 112 <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>
dan_ackme 13:2b51f5267c92 113 <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>
dan_ackme 13:2b51f5267c92 114 <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>
dan_ackme 13:2b51f5267c92 115 <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>
dan_ackme 13:2b51f5267c92 116 <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>
dan_ackme 13:2b51f5267c92 117 <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>
dan_ackme 13:2b51f5267c92 118 <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>
dan_ackme 13:2b51f5267c92 119 <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>
dan_ackme 13:2b51f5267c92 120 <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>
dan_ackme 13:2b51f5267c92 121 <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>
dan_ackme 13:2b51f5267c92 122 <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>
dan_ackme 13:2b51f5267c92 123 <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>
dan_ackme 13:2b51f5267c92 124 <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>
dan_ackme 13:2b51f5267c92 125 <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>
dan_ackme 13:2b51f5267c92 126 <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>
dan_ackme 13:2b51f5267c92 127 <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>
dan_ackme 13:2b51f5267c92 128 <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>
dan_ackme 13:2b51f5267c92 129 <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>
dan_ackme 13:2b51f5267c92 130 <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>
dan_ackme 13:2b51f5267c92 131 <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>
dan_ackme 13:2b51f5267c92 132 <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>
dan_ackme 13:2b51f5267c92 133 <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>
dan_ackme 13:2b51f5267c92 134 <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>
dan_ackme 13:2b51f5267c92 135 <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>
dan_ackme 10:735194df0097 136 </table>
dan_ackme 10:735194df0097 137 </div><!-- directory -->
dan_ackme 10:735194df0097 138 </div><!-- contents -->
dan_ackme 10:735194df0097 139 </div><!-- doc-content -->
dan_ackme 10:735194df0097 140 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 141 <ul>
dan_ackme 13:2b51f5267c92 142 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 143 </ul>
dan_ackme 10:735194df0097 144 </div>
dan_ackme 10:735194df0097 145 </body>
dan_ackme 13:2b51f5267c92 146 </html>