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/classwiconnect_1_1_wiconnect_file.html@26:8067e3d463d3, 2014-10-23 (annotated)

Committer:
dan_ackme
Date:
Thu Oct 23 15:16:06 2014 -0700
Revision:
26:8067e3d463d3
Parent:
17:7268f365676b
Child:
29:b6af04b77a56
Added 'updateFirmware' and 'networkGetJoinResult' api methods

Various bug fixes

Updated documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 17:7268f365676b 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 17:7268f365676b 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 17:7268f365676b 3 <head>
dan_ackme 17:7268f365676b 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 17:7268f365676b 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 17:7268f365676b 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 17:7268f365676b 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 17:7268f365676b 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 17:7268f365676b 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 17:7268f365676b 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 17:7268f365676b 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 17:7268f365676b 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 17:7268f365676b 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 17:7268f365676b 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 17:7268f365676b 15 <script type="text/javascript">
dan_ackme 17:7268f365676b 16 $(document).ready(initResizable);
dan_ackme 17:7268f365676b 17 $(window).load(resizeHeight);
dan_ackme 17:7268f365676b 18 </script>
dan_ackme 17:7268f365676b 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 17:7268f365676b 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 17:7268f365676b 21 <script type="text/javascript">
dan_ackme 17:7268f365676b 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 17:7268f365676b 23 </script>
dan_ackme 17:7268f365676b 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 17:7268f365676b 25 </head>
dan_ackme 17:7268f365676b 26 <body>
dan_ackme 17:7268f365676b 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 17:7268f365676b 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 17:7268f365676b 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 17:7268f365676b 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 17:7268f365676b 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 17:7268f365676b 32 <td style="width:20px"></td>
dan_ackme 17:7268f365676b 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 17:7268f365676b 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 17:7268f365676b 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 17:7268f365676b 36 <td style="width:20px"></td>
dan_ackme 17:7268f365676b 37 </tr>
dan_ackme 17:7268f365676b 38 <tr><td>&nbsp;</td></tr>
dan_ackme 17:7268f365676b 39 </table>
dan_ackme 17:7268f365676b 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 17:7268f365676b 41 <script type="text/javascript">
dan_ackme 17:7268f365676b 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 17:7268f365676b 43 </script>
dan_ackme 17:7268f365676b 44 <div id="navrow1" class="tabs">
dan_ackme 17:7268f365676b 45 <ul class="tablist">
dan_ackme 17:7268f365676b 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 17:7268f365676b 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 17:7268f365676b 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 17:7268f365676b 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 26:8067e3d463d3 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 17:7268f365676b 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 17:7268f365676b 52 <li>
dan_ackme 17:7268f365676b 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 17:7268f365676b 54 <span class="left">
dan_ackme 17:7268f365676b 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 17:7268f365676b 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 17:7268f365676b 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 17:7268f365676b 58 alt=""/>
dan_ackme 17:7268f365676b 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 17:7268f365676b 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 17:7268f365676b 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 17:7268f365676b 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 17:7268f365676b 63 </span><span class="right">
dan_ackme 17:7268f365676b 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 17:7268f365676b 65 </span>
dan_ackme 17:7268f365676b 66 </div>
dan_ackme 17:7268f365676b 67 </li>
dan_ackme 17:7268f365676b 68 </ul>
dan_ackme 17:7268f365676b 69 </div>
dan_ackme 17:7268f365676b 70 <div id="navrow2" class="tabs2">
dan_ackme 17:7268f365676b 71 <ul class="tablist">
dan_ackme 17:7268f365676b 72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 17:7268f365676b 73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 17:7268f365676b 74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 17:7268f365676b 75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 17:7268f365676b 76 </ul>
dan_ackme 17:7268f365676b 77 </div>
dan_ackme 17:7268f365676b 78 </div><!-- top -->
dan_ackme 17:7268f365676b 79 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 17:7268f365676b 80 <div id="nav-tree">
dan_ackme 17:7268f365676b 81 <div id="nav-tree-contents">
dan_ackme 17:7268f365676b 82 <div id="nav-sync" class="sync"></div>
dan_ackme 17:7268f365676b 83 </div>
dan_ackme 17:7268f365676b 84 </div>
dan_ackme 17:7268f365676b 85 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 17:7268f365676b 86 class="ui-resizable-handle">
dan_ackme 17:7268f365676b 87 </div>
dan_ackme 17:7268f365676b 88 </div>
dan_ackme 17:7268f365676b 89 <script type="text/javascript">
dan_ackme 17:7268f365676b 90 $(document).ready(function(){initNavTree('classwiconnect_1_1_wiconnect_file.html','');});
dan_ackme 17:7268f365676b 91 </script>
dan_ackme 17:7268f365676b 92 <div id="doc-content">
dan_ackme 17:7268f365676b 93 <!-- window showing the filter options -->
dan_ackme 17:7268f365676b 94 <div id="MSearchSelectWindow"
dan_ackme 17:7268f365676b 95 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 17:7268f365676b 96 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 17:7268f365676b 97 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 17:7268f365676b 98 <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 17:7268f365676b 99
dan_ackme 17:7268f365676b 100 <!-- iframe showing the search results (closed by default) -->
dan_ackme 17:7268f365676b 101 <div id="MSearchResultsWindow">
dan_ackme 17:7268f365676b 102 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 17:7268f365676b 103 name="MSearchResults" id="MSearchResults">
dan_ackme 17:7268f365676b 104 </iframe>
dan_ackme 17:7268f365676b 105 </div>
dan_ackme 17:7268f365676b 106
dan_ackme 17:7268f365676b 107 <div class="header">
dan_ackme 17:7268f365676b 108 <div class="summary">
dan_ackme 17:7268f365676b 109 <a href="classwiconnect_1_1_wiconnect_file-members.html">List of all members</a> </div>
dan_ackme 17:7268f365676b 110 <div class="headertitle">
dan_ackme 17:7268f365676b 111 <div class="title">wiconnect::WiconnectFile Class Reference<div class="ingroups"><a class="el" href="group__api__file__types.html">Types</a></div></div> </div>
dan_ackme 17:7268f365676b 112 </div><!--header-->
dan_ackme 17:7268f365676b 113 <div class="contents">
dan_ackme 17:7268f365676b 114
dan_ackme 17:7268f365676b 115 <p>WiConnect WiFi module file object.
dan_ackme 17:7268f365676b 116 <a href="classwiconnect_1_1_wiconnect_file.html#details">More...</a></p>
dan_ackme 17:7268f365676b 117
dan_ackme 17:7268f365676b 118 <p><code>#include &lt;<a class="el" href="_wiconnect_file_8h_source.html">WiconnectFile.h</a>&gt;</code></p>
dan_ackme 17:7268f365676b 119 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 17:7268f365676b 120 <div class="textblock"><p>WiConnect WiFi module file object. </p>
dan_ackme 17:7268f365676b 121
dan_ackme 17:7268f365676b 122 <p>Definition at line <a class="el" href="_wiconnect_file_8h_source.html#l00044">44</a> of file <a class="el" href="_wiconnect_file_8h_source.html">WiconnectFile.h</a>.</p>
dan_ackme 17:7268f365676b 123 </div><hr/>The documentation for this class was generated from the following file:<ul>
dan_ackme 17:7268f365676b 124 <li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/types/<a class="el" href="_wiconnect_file_8h_source.html">WiconnectFile.h</a></li>
dan_ackme 17:7268f365676b 125 </ul>
dan_ackme 17:7268f365676b 126 </div><!-- contents -->
dan_ackme 17:7268f365676b 127 </div><!-- doc-content -->
dan_ackme 17:7268f365676b 128 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 17:7268f365676b 129 <ul>
dan_ackme 17:7268f365676b 130 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 17:7268f365676b 131 </ul>
dan_ackme 17:7268f365676b 132 </div>
dan_ackme 17:7268f365676b 133 </body>
dan_ackme 17:7268f365676b 134 </html>