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@11:ea484e1b7fc4, 2014-08-12 (annotated)
- Committer:
- dan_ackme
- Date:
- Tue Aug 12 02:34:46 2014 -0700
- Revision:
- 11:ea484e1b7fc4
- Parent:
- 10:735194df0097
- Child:
- 13:2b51f5267c92
updated documnetation
Who changed what in which revision?
User | Revision | Line number | New 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 | 10:735194df0097 | 6 | <meta name="generator" content="Doxygen 1.8.7"/> |
dan_ackme | 10:735194df0097 | 7 | <title>WiConnect Library: Modules</title> |
dan_ackme | 10:735194df0097 | 8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 10:735194df0097 | 9 | <script type="text/javascript" src="jquery.js"></script> |
dan_ackme | 10:735194df0097 | 10 | <script type="text/javascript" src="dynsections.js"></script> |
dan_ackme | 10:735194df0097 | 11 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 10:735194df0097 | 12 | <script type="text/javascript" src="resize.js"></script> |
dan_ackme | 10:735194df0097 | 13 | <script type="text/javascript" src="navtree.js"></script> |
dan_ackme | 10:735194df0097 | 14 | <script type="text/javascript"> |
dan_ackme | 10:735194df0097 | 15 | $(document).ready(initResizable); |
dan_ackme | 10:735194df0097 | 16 | $(window).load(resizeHeight); |
dan_ackme | 10:735194df0097 | 17 | </script> |
dan_ackme | 11:ea484e1b7fc4 | 18 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
dan_ackme | 11:ea484e1b7fc4 | 19 | <script type="text/javascript" src="search/search.js"></script> |
dan_ackme | 11:ea484e1b7fc4 | 20 | <script type="text/javascript"> |
dan_ackme | 11:ea484e1b7fc4 | 21 | $(document).ready(function() { searchBox.OnSelectItem(0); }); |
dan_ackme | 11:ea484e1b7fc4 | 22 | </script> |
dan_ackme | 10:735194df0097 | 23 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
dan_ackme | 10:735194df0097 | 24 | </head> |
dan_ackme | 10:735194df0097 | 25 | <body> |
dan_ackme | 10:735194df0097 | 26 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
dan_ackme | 10:735194df0097 | 27 | <div id="titlearea"> |
dan_ackme | 10:735194df0097 | 28 | <table cellspacing="0" cellpadding="0"> |
dan_ackme | 10:735194df0097 | 29 | <tbody> |
dan_ackme | 10:735194df0097 | 30 | <tr style="height: 56px;"> |
dan_ackme | 10:735194df0097 | 31 | <td style="padding-left: 0.5em;"> |
dan_ackme | 10:735194df0097 | 32 | <div id="projectname">WiConnect Library |
dan_ackme | 10:735194df0097 | 33 | </div> |
dan_ackme | 10:735194df0097 | 34 | </td> |
dan_ackme | 10:735194df0097 | 35 | </tr> |
dan_ackme | 10:735194df0097 | 36 | </tbody> |
dan_ackme | 10:735194df0097 | 37 | </table> |
dan_ackme | 10:735194df0097 | 38 | </div> |
dan_ackme | 10:735194df0097 | 39 | <!-- end header part --> |
dan_ackme | 10:735194df0097 | 40 | <!-- 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 | 10:735194df0097 | 46 | <li><a href="index.html"><span>Main Page</span></a></li> |
dan_ackme | 10:735194df0097 | 47 | <li class="current"><a href="modules.html"><span>Modules</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 48 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
dan_ackme | 10:735194df0097 | 49 | <li><a href="annotated.html"><span>Classes</span></a></li> |
dan_ackme | 11:ea484e1b7fc4 | 50 | <li> |
dan_ackme | 11:ea484e1b7fc4 | 51 | <div id="MSearchBox" class="MSearchBoxInactive"> |
dan_ackme | 11:ea484e1b7fc4 | 52 | <span class="left"> |
dan_ackme | 11:ea484e1b7fc4 | 53 | <img id="MSearchSelect" src="search/mag_sel.png" |
dan_ackme | 11:ea484e1b7fc4 | 54 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 11:ea484e1b7fc4 | 55 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 11:ea484e1b7fc4 | 56 | alt=""/> |
dan_ackme | 11:ea484e1b7fc4 | 57 | <input type="text" id="MSearchField" value="Search" accesskey="S" |
dan_ackme | 11:ea484e1b7fc4 | 58 | onfocus="searchBox.OnSearchFieldFocus(true)" |
dan_ackme | 11:ea484e1b7fc4 | 59 | onblur="searchBox.OnSearchFieldFocus(false)" |
dan_ackme | 11:ea484e1b7fc4 | 60 | onkeyup="searchBox.OnSearchFieldChange(event)"/> |
dan_ackme | 11:ea484e1b7fc4 | 61 | </span><span class="right"> |
dan_ackme | 11:ea484e1b7fc4 | 62 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
dan_ackme | 11:ea484e1b7fc4 | 63 | </span> |
dan_ackme | 11:ea484e1b7fc4 | 64 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 65 | </li> |
dan_ackme | 10:735194df0097 | 66 | </ul> |
dan_ackme | 10:735194df0097 | 67 | </div> |
dan_ackme | 10:735194df0097 | 68 | </div><!-- top --> |
dan_ackme | 10:735194df0097 | 69 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
dan_ackme | 10:735194df0097 | 70 | <div id="nav-tree"> |
dan_ackme | 10:735194df0097 | 71 | <div id="nav-tree-contents"> |
dan_ackme | 10:735194df0097 | 72 | <div id="nav-sync" class="sync"></div> |
dan_ackme | 10:735194df0097 | 73 | </div> |
dan_ackme | 10:735194df0097 | 74 | </div> |
dan_ackme | 10:735194df0097 | 75 | <div id="splitbar" style="-moz-user-select:none;" |
dan_ackme | 10:735194df0097 | 76 | class="ui-resizable-handle"> |
dan_ackme | 10:735194df0097 | 77 | </div> |
dan_ackme | 10:735194df0097 | 78 | </div> |
dan_ackme | 10:735194df0097 | 79 | <script type="text/javascript"> |
dan_ackme | 10:735194df0097 | 80 | $(document).ready(function(){initNavTree('modules.html','');}); |
dan_ackme | 10:735194df0097 | 81 | </script> |
dan_ackme | 10:735194df0097 | 82 | <div id="doc-content"> |
dan_ackme | 11:ea484e1b7fc4 | 83 | <!-- window showing the filter options --> |
dan_ackme | 11:ea484e1b7fc4 | 84 | <div id="MSearchSelectWindow" |
dan_ackme | 11:ea484e1b7fc4 | 85 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 11:ea484e1b7fc4 | 86 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 11:ea484e1b7fc4 | 87 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
dan_ackme | 11:ea484e1b7fc4 | 88 | <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> |
dan_ackme | 11:ea484e1b7fc4 | 89 | |
dan_ackme | 11:ea484e1b7fc4 | 90 | <!-- iframe showing the search results (closed by default) --> |
dan_ackme | 11:ea484e1b7fc4 | 91 | <div id="MSearchResultsWindow"> |
dan_ackme | 11:ea484e1b7fc4 | 92 | <iframe src="javascript:void(0)" frameborder="0" |
dan_ackme | 11:ea484e1b7fc4 | 93 | name="MSearchResults" id="MSearchResults"> |
dan_ackme | 11:ea484e1b7fc4 | 94 | </iframe> |
dan_ackme | 11:ea484e1b7fc4 | 95 | </div> |
dan_ackme | 11:ea484e1b7fc4 | 96 | |
dan_ackme | 10:735194df0097 | 97 | <div class="header"> |
dan_ackme | 10:735194df0097 | 98 | <div class="headertitle"> |
dan_ackme | 10:735194df0097 | 99 | <div class="title">Modules</div> </div> |
dan_ackme | 10:735194df0097 | 100 | </div><!--header--> |
dan_ackme | 10:735194df0097 | 101 | <div class="contents"> |
dan_ackme | 10:735194df0097 | 102 | <div class="textblock">Here is a list of all modules:</div><div class="directory"> |
dan_ackme | 10:735194df0097 | 103 | <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 | 10:735194df0097 | 104 | <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</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> |
dan_ackme | 10:735194df0097 | 105 | <tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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> |
dan_ackme | 10:735194df0097 | 106 | <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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> |
dan_ackme | 10:735194df0097 | 107 | <tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__core__misc.html" target="_self">Miscellaneous</a></td><td class="desc">Other core API methods </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 108 | <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__core__macro.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 109 | <tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</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> |
dan_ackme | 11:ea484e1b7fc4 | 110 | <tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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> |
dan_ackme | 11:ea484e1b7fc4 | 111 | <tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;"> </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> |
dan_ackme | 11:ea484e1b7fc4 | 112 | <tr id="row_1_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </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> |
dan_ackme | 11:ea484e1b7fc4 | 113 | <tr id="row_1_3_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__network__util.html" target="_self">Utilities</a></td><td class="desc">Network utility API methods </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 114 | <tr id="row_1_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__network__macros.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr> |
dan_ackme | 10:735194df0097 | 115 | <tr id="row_2_"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">▼</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> |
dan_ackme | 10:735194df0097 | 116 | <tr id="row_2_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__socket__tcp.html" target="_self">TCP</a></td><td class="desc">TCP API methods </td></tr> |
dan_ackme | 10:735194df0097 | 117 | <tr id="row_2_1_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__socket__udp.html" target="_self">UDP</a></td><td class="desc">UDP API methods </td></tr> |
dan_ackme | 10:735194df0097 | 118 | <tr id="row_2_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__socket__tls.html" target="_self">TLS</a></td><td class="desc">TLS API methods </td></tr> |
dan_ackme | 10:735194df0097 | 119 | <tr id="row_2_3_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__socket__http.html" target="_self">HTTP</a></td><td class="desc">HTTP API methods </td></tr> |
dan_ackme | 10:735194df0097 | 120 | <tr id="row_2_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__socket__misc.html" target="_self">Miscellaneous</a></td><td class="desc">Miscellaneous socket API methods </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 121 | <tr id="row_2_5_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__api__socket__macro.html" target="_self">Macros</a></td><td class="desc">API specific macros </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 122 | <tr id="row_3_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">▼</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> |
dan_ackme | 11:ea484e1b7fc4 | 123 | <tr id="row_3_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </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 | 11:ea484e1b7fc4 | 124 | <tr id="row_4_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">▼</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> |
dan_ackme | 11:ea484e1b7fc4 | 125 | <tr id="row_4_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__types__core.html" target="_self">Core API</a></td><td class="desc">Core API Types </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 126 | <tr id="row_4_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__types__network.html" target="_self">Network API</a></td><td class="desc">Network API Types </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 127 | <tr id="row_4_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__types__socket.html" target="_self">Socket API</a></td><td class="desc">Socket API Types </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 128 | <tr id="row_4_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="group__types__file.html" target="_self">File API</a></td><td class="desc">File API Types </td></tr> |
dan_ackme | 11:ea484e1b7fc4 | 129 | <tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;"> </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 | 130 | </table> |
dan_ackme | 10:735194df0097 | 131 | </div><!-- directory --> |
dan_ackme | 10:735194df0097 | 132 | </div><!-- contents --> |
dan_ackme | 10:735194df0097 | 133 | </div><!-- doc-content --> |
dan_ackme | 10:735194df0097 | 134 | <!-- start footer part --> |
dan_ackme | 10:735194df0097 | 135 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
dan_ackme | 10:735194df0097 | 136 | <ul> |
dan_ackme | 11:ea484e1b7fc4 | 137 | <li class="footer">Generated on Tue Aug 12 2014 02:15:27 for WiConnect Library by |
dan_ackme | 10:735194df0097 | 138 | <a href="http://www.doxygen.org/index.html"> |
dan_ackme | 10:735194df0097 | 139 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li> |
dan_ackme | 10:735194df0097 | 140 | </ul> |
dan_ackme | 10:735194df0097 | 141 | </div> |
dan_ackme | 10:735194df0097 | 142 | </body> |
dan_ackme | 10:735194df0097 | 143 | </html> |