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

Committer:
dan_ackme
Date:
Thu Oct 23 15:16:06 2014 -0700
Revision:
26:8067e3d463d3
Parent:
21:17bb3eddcbae
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 14:85a2ed029f37 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 14:85a2ed029f37 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 14:85a2ed029f37 3 <head>
dan_ackme 14:85a2ed029f37 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 14:85a2ed029f37 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 14:85a2ed029f37 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 14:85a2ed029f37 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 14:85a2ed029f37 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 14:85a2ed029f37 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 14:85a2ed029f37 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 14:85a2ed029f37 15 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 16 $(document).ready(initResizable);
dan_ackme 14:85a2ed029f37 17 $(window).load(resizeHeight);
dan_ackme 14:85a2ed029f37 18 </script>
dan_ackme 14:85a2ed029f37 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 14:85a2ed029f37 21 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 14:85a2ed029f37 23 </script>
dan_ackme 14:85a2ed029f37 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 14:85a2ed029f37 25 </head>
dan_ackme 14:85a2ed029f37 26 <body>
dan_ackme 14:85a2ed029f37 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 14:85a2ed029f37 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 14:85a2ed029f37 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 14:85a2ed029f37 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 14:85a2ed029f37 32 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 14:85a2ed029f37 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 14:85a2ed029f37 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 14:85a2ed029f37 36 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 37 </tr>
dan_ackme 14:85a2ed029f37 38 <tr><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 39 </table>
dan_ackme 14:85a2ed029f37 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 14:85a2ed029f37 41 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 14:85a2ed029f37 43 </script>
dan_ackme 14:85a2ed029f37 44 <div id="navrow1" class="tabs">
dan_ackme 14:85a2ed029f37 45 <ul class="tablist">
dan_ackme 14:85a2ed029f37 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 14:85a2ed029f37 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 14:85a2ed029f37 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 14:85a2ed029f37 49 <li><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 14:85a2ed029f37 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 14:85a2ed029f37 52 <li>
dan_ackme 14:85a2ed029f37 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 14:85a2ed029f37 54 <span class="left">
dan_ackme 14:85a2ed029f37 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 14:85a2ed029f37 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 58 alt=""/>
dan_ackme 14:85a2ed029f37 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 14:85a2ed029f37 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 14:85a2ed029f37 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 14:85a2ed029f37 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 14:85a2ed029f37 63 </span><span class="right">
dan_ackme 14:85a2ed029f37 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 14:85a2ed029f37 65 </span>
dan_ackme 14:85a2ed029f37 66 </div>
dan_ackme 14:85a2ed029f37 67 </li>
dan_ackme 14:85a2ed029f37 68 </ul>
dan_ackme 14:85a2ed029f37 69 </div>
dan_ackme 14:85a2ed029f37 70 </div><!-- top -->
dan_ackme 14:85a2ed029f37 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 72 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 73 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 74 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 75 </div>
dan_ackme 14:85a2ed029f37 76 </div>
dan_ackme 14:85a2ed029f37 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 78 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 79 </div>
dan_ackme 14:85a2ed029f37 80 </div>
dan_ackme 14:85a2ed029f37 81 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 82 $(document).ready(function(){initNavTree('group__api__file__types.html','');});
dan_ackme 14:85a2ed029f37 83 </script>
dan_ackme 14:85a2ed029f37 84 <div id="doc-content">
dan_ackme 14:85a2ed029f37 85 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 86 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 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 14:85a2ed029f37 91
dan_ackme 14:85a2ed029f37 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 93 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 95 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 96 </iframe>
dan_ackme 14:85a2ed029f37 97 </div>
dan_ackme 14:85a2ed029f37 98
dan_ackme 14:85a2ed029f37 99 <div class="header">
dan_ackme 14:85a2ed029f37 100 <div class="summary">
dan_ackme 14:85a2ed029f37 101 <a href="#nested-classes">Classes</a> &#124;
dan_ackme 14:85a2ed029f37 102 <a href="#enum-members">Enumerations</a> </div>
dan_ackme 14:85a2ed029f37 103 <div class="headertitle">
dan_ackme 14:85a2ed029f37 104 <div class="title">Types<div class="ingroups"><a class="el" href="group__api__file.html">File</a></div></div> </div>
dan_ackme 14:85a2ed029f37 105 </div><!--header-->
dan_ackme 14:85a2ed029f37 106 <div class="contents">
dan_ackme 14:85a2ed029f37 107
dan_ackme 14:85a2ed029f37 108 <p>File Types.
dan_ackme 14:85a2ed029f37 109 <a href="#details">More...</a></p>
dan_ackme 14:85a2ed029f37 110 <table class="memberdecls">
dan_ackme 14:85a2ed029f37 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
dan_ackme 14:85a2ed029f37 112 Classes</h2></td></tr>
dan_ackme 14:85a2ed029f37 113 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td></tr>
dan_ackme 14:85a2ed029f37 114 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. <a href="classwiconnect_1_1_file_interface.html#details">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 115 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 116 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file_list.html">wiconnect::FileList</a></td></tr>
dan_ackme 14:85a2ed029f37 117 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">WiConnect WiFi module file listing. <a href="classwiconnect_1_1_file_list.html#details">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 118 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 17:7268f365676b 119 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_file.html">wiconnect::WiconnectFile</a></td></tr>
dan_ackme 17:7268f365676b 120 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">WiConnect WiFi module file object. <a href="classwiconnect_1_1_wiconnect_file.html#details">More...</a><br /></td></tr>
dan_ackme 17:7268f365676b 121 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 122 </table><table class="memberdecls">
dan_ackme 14:85a2ed029f37 123 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
dan_ackme 14:85a2ed029f37 124 Enumerations</h2></td></tr>
dan_ackme 14:85a2ed029f37 125 <tr class="memitem:gafbe48908f5c190c3b0f272d3016e609e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">wiconnect::FileFlags</a> { <br />
dan_ackme 14:85a2ed029f37 126 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eac40bade251c1d671283d3ab2515725a6">wiconnect::FILE_FLAG_NONE</a> = 0,
dan_ackme 14:85a2ed029f37 127 <br />
dan_ackme 14:85a2ed029f37 128 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaff56da02ac3626bf5636e0aa6ffff78a">wiconnect::FILE_FLAG_VALID</a> = (1 &lt;&lt; 0),
dan_ackme 14:85a2ed029f37 129 <br />
dan_ackme 14:85a2ed029f37 130 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea94ddbab88df5f29013d5deb3f3d092c5">wiconnect::FILE_FLAG_EXECUTABLE</a> = (1 &lt;&lt; 1),
dan_ackme 14:85a2ed029f37 131 <br />
dan_ackme 14:85a2ed029f37 132 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea07f098f34c015d1c81d7592b476312e6">wiconnect::FILE_FLAG_ENCRYPTED</a> = (1 &lt;&lt; 2),
dan_ackme 14:85a2ed029f37 133 <br />
dan_ackme 14:85a2ed029f37 134 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaad3ddfddf9e28a26df73b689e0898df0">wiconnect::FILE_FLAG_INTERNAL</a> = (1 &lt;&lt; 3),
dan_ackme 14:85a2ed029f37 135 <br />
dan_ackme 14:85a2ed029f37 136 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaffe90e6784ad43acffbf823502a6a7bf">wiconnect::FILE_FLAG_BOOTABLE</a> = (1 &lt;&lt; 4),
dan_ackme 14:85a2ed029f37 137 <br />
dan_ackme 14:85a2ed029f37 138 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea3864357fd0b63b4cd6594d00c2194ca8">wiconnect::FILE_FLAG_USER</a> = (1 &lt;&lt; 5),
dan_ackme 14:85a2ed029f37 139 <br />
dan_ackme 14:85a2ed029f37 140 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaa74f44cd76d69e9f32d70a2b13c8c4e2">wiconnect::FILE_FLAG_ESSENTIAL</a> = (1 &lt;&lt; 6),
dan_ackme 14:85a2ed029f37 141 <br />
dan_ackme 14:85a2ed029f37 142 &#160;&#160;<a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea21f35fd8f0a4e38d91d5d1f5c5cc977f">wiconnect::FILE_FLAG_INVALID</a> = 0xFFFF
dan_ackme 14:85a2ed029f37 143 <br />
dan_ackme 14:85a2ed029f37 144 }</td></tr>
dan_ackme 14:85a2ed029f37 145 <tr class="memdesc:gafbe48908f5c190c3b0f272d3016e609e"><td class="mdescLeft">&#160;</td><td class="mdescRight">File flags type. <a href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 146 <tr class="separator:gafbe48908f5c190c3b0f272d3016e609e"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 147 <tr class="memitem:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">wiconnect::FileType</a> { <br />
dan_ackme 14:85a2ed029f37 148 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63ac2bf941d4f7f23cabf7c781c5741dc04">wiconnect::FILE_TYPE_UPGRADE_APP</a> = 0x00,
dan_ackme 14:85a2ed029f37 149 <br />
dan_ackme 14:85a2ed029f37 150 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63ad127cd0d4eeefee993a24b4d5095bfe7">wiconnect::FILE_TYPE_WIFI_FW</a> = 0x01,
dan_ackme 14:85a2ed029f37 151 <br />
dan_ackme 14:85a2ed029f37 152 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a681a5a935adbd3aefdbb3639c36a4169">wiconnect::FILE_TYPE_REGULAR_APP</a> = 0x81,
dan_ackme 14:85a2ed029f37 153 <br />
dan_ackme 14:85a2ed029f37 154 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a2271e7ab227bf95699c260a258902eeb">wiconnect::FILE_TYPE_USER_RANGE_START</a> = 150,
dan_ackme 14:85a2ed029f37 155 <br />
dan_ackme 14:85a2ed029f37 156 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a2958dab5107b78cd1c14400770ab9b4e">wiconnect::FILE_TYPE_USER_RANGE_END</a> = 199,
dan_ackme 14:85a2ed029f37 157 <br />
dan_ackme 14:85a2ed029f37 158 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63aaa4d15bf30361c1026fe15e029e9c3e2">wiconnect::FILE_TYPE_TEMPORY</a> = 0xF9,
dan_ackme 14:85a2ed029f37 159 <br />
dan_ackme 14:85a2ed029f37 160 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a5df6fc01411942aabcf83731d0d02d52">wiconnect::FILE_TYPE_GPIO_CONFIG</a> = 0xFA,
dan_ackme 14:85a2ed029f37 161 <br />
dan_ackme 14:85a2ed029f37 162 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a35624c078c19b7b632d832d15c0d1ef0">wiconnect::FILE_TYPE_COMMAND_HELP</a> = 0xFB,
dan_ackme 14:85a2ed029f37 163 <br />
dan_ackme 14:85a2ed029f37 164 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a244c4ea312de84a2f4cabaff386fcffd">wiconnect::FILE_TYPE_SDC_CAPS</a> = 0xFC,
dan_ackme 14:85a2ed029f37 165 <br />
dan_ackme 14:85a2ed029f37 166 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63afd6c376410552b54187a162e2c6fdad2">wiconnect::FILE_TYPE_SETUP_SCRIPT</a> = 0xFD,
dan_ackme 14:85a2ed029f37 167 <br />
dan_ackme 14:85a2ed029f37 168 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a2508195aa2793d49c5c6a24879b52206">wiconnect::FILE_TYPE_MISC_FIX_LEN</a> = 0xFE,
dan_ackme 14:85a2ed029f37 169 <br />
dan_ackme 14:85a2ed029f37 170 &#160;&#160;<a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a077782e07756b6dc93f96e9a0cca5c9e">wiconnect::FILE_TYPE_UNKNOWN</a> = 0xFF
dan_ackme 14:85a2ed029f37 171 <br />
dan_ackme 14:85a2ed029f37 172 }</td></tr>
dan_ackme 14:85a2ed029f37 173 <tr class="memdesc:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="mdescLeft">&#160;</td><td class="mdescRight">File type type. <a href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 174 <tr class="separator:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 175 </table>
dan_ackme 14:85a2ed029f37 176 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 14:85a2ed029f37 177 <p>File Types. </p>
dan_ackme 14:85a2ed029f37 178 <h2 class="groupheader">Enumeration Type Documentation</h2>
dan_ackme 14:85a2ed029f37 179 <a class="anchor" id="gafbe48908f5c190c3b0f272d3016e609e"></a>
dan_ackme 14:85a2ed029f37 180 <div class="memitem">
dan_ackme 14:85a2ed029f37 181 <div class="memproto">
dan_ackme 14:85a2ed029f37 182 <table class="memname">
dan_ackme 14:85a2ed029f37 183 <tr>
dan_ackme 14:85a2ed029f37 184 <td class="memname">enum <a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">wiconnect::FileFlags</a></td>
dan_ackme 14:85a2ed029f37 185 </tr>
dan_ackme 14:85a2ed029f37 186 </table>
dan_ackme 14:85a2ed029f37 187 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 188
dan_ackme 17:7268f365676b 189 <p>File flags type. </p>
dan_ackme 14:85a2ed029f37 190 <table class="fieldtable">
dan_ackme 14:85a2ed029f37 191 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eac40bade251c1d671283d3ab2515725a6"></a>FILE_FLAG_NONE&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 192 <p>No flags. </p>
dan_ackme 14:85a2ed029f37 193 </td></tr>
dan_ackme 14:85a2ed029f37 194 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaff56da02ac3626bf5636e0aa6ffff78a"></a>FILE_FLAG_VALID&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 195 <p>File valid. </p>
dan_ackme 14:85a2ed029f37 196 </td></tr>
dan_ackme 14:85a2ed029f37 197 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea94ddbab88df5f29013d5deb3f3d092c5"></a>FILE_FLAG_EXECUTABLE&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 198 <p>File executable. </p>
dan_ackme 14:85a2ed029f37 199 </td></tr>
dan_ackme 14:85a2ed029f37 200 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea07f098f34c015d1c81d7592b476312e6"></a>FILE_FLAG_ENCRYPTED&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 201 <p>File encrypted. </p>
dan_ackme 14:85a2ed029f37 202 </td></tr>
dan_ackme 14:85a2ed029f37 203 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaad3ddfddf9e28a26df73b689e0898df0"></a>FILE_FLAG_INTERNAL&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 204 <p>File on internal module flash. </p>
dan_ackme 14:85a2ed029f37 205 </td></tr>
dan_ackme 14:85a2ed029f37 206 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaffe90e6784ad43acffbf823502a6a7bf"></a>FILE_FLAG_BOOTABLE&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 207 <p>File bootable. </p>
dan_ackme 14:85a2ed029f37 208 </td></tr>
dan_ackme 14:85a2ed029f37 209 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea3864357fd0b63b4cd6594d00c2194ca8"></a>FILE_FLAG_USER&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 210 <p>File created by user. </p>
dan_ackme 14:85a2ed029f37 211 </td></tr>
dan_ackme 14:85a2ed029f37 212 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaa74f44cd76d69e9f32d70a2b13c8c4e2"></a>FILE_FLAG_ESSENTIAL&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 213 <p>File is essential. </p>
dan_ackme 14:85a2ed029f37 214 </td></tr>
dan_ackme 14:85a2ed029f37 215 <tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea21f35fd8f0a4e38d91d5d1f5c5cc977f"></a>FILE_FLAG_INVALID&#160;</td><td class="fielddoc">
dan_ackme 17:7268f365676b 216 <p>File flags invalid. </p>
dan_ackme 14:85a2ed029f37 217 </td></tr>
dan_ackme 14:85a2ed029f37 218 </table>
dan_ackme 14:85a2ed029f37 219
dan_ackme 26:8067e3d463d3 220 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00364">364</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 14:85a2ed029f37 221
dan_ackme 14:85a2ed029f37 222 </div>
dan_ackme 14:85a2ed029f37 223 </div>
dan_ackme 14:85a2ed029f37 224 <a class="anchor" id="ga9919a4237eea2b0d1f27c16d64e62c63"></a>
dan_ackme 14:85a2ed029f37 225 <div class="memitem">
dan_ackme 14:85a2ed029f37 226 <div class="memproto">
dan_ackme 14:85a2ed029f37 227 <table class="memname">
dan_ackme 14:85a2ed029f37 228 <tr>
dan_ackme 14:85a2ed029f37 229 <td class="memname">enum <a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">wiconnect::FileType</a></td>
dan_ackme 14:85a2ed029f37 230 </tr>
dan_ackme 14:85a2ed029f37 231 </table>
dan_ackme 14:85a2ed029f37 232 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 233
dan_ackme 17:7268f365676b 234 <p>File type type. </p>
dan_ackme 14:85a2ed029f37 235 <table class="fieldtable">
dan_ackme 14:85a2ed029f37 236 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63ac2bf941d4f7f23cabf7c781c5741dc04"></a>FILE_TYPE_UPGRADE_APP&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 237 <p>Internal upgrade application. </p>
dan_ackme 14:85a2ed029f37 238 </td></tr>
dan_ackme 14:85a2ed029f37 239 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63ad127cd0d4eeefee993a24b4d5095bfe7"></a>FILE_TYPE_WIFI_FW&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 240 <p>Wifi firmware binary. </p>
dan_ackme 14:85a2ed029f37 241 </td></tr>
dan_ackme 14:85a2ed029f37 242 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a681a5a935adbd3aefdbb3639c36a4169"></a>FILE_TYPE_REGULAR_APP&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 243 <p>Regular application. </p>
dan_ackme 14:85a2ed029f37 244 </td></tr>
dan_ackme 14:85a2ed029f37 245 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a2271e7ab227bf95699c260a258902eeb"></a>FILE_TYPE_USER_RANGE_START&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 246 <p>User type start index. </p>
dan_ackme 14:85a2ed029f37 247 </td></tr>
dan_ackme 14:85a2ed029f37 248 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a2958dab5107b78cd1c14400770ab9b4e"></a>FILE_TYPE_USER_RANGE_END&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 249 <p>User type end index. </p>
dan_ackme 14:85a2ed029f37 250 </td></tr>
dan_ackme 14:85a2ed029f37 251 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63aaa4d15bf30361c1026fe15e029e9c3e2"></a>FILE_TYPE_TEMPORY&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 252 <p>Temporary file. </p>
dan_ackme 14:85a2ed029f37 253 </td></tr>
dan_ackme 14:85a2ed029f37 254 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a5df6fc01411942aabcf83731d0d02d52"></a>FILE_TYPE_GPIO_CONFIG&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 255 <p>GPIO configuration file. </p>
dan_ackme 14:85a2ed029f37 256 </td></tr>
dan_ackme 14:85a2ed029f37 257 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a35624c078c19b7b632d832d15c0d1ef0"></a>FILE_TYPE_COMMAND_HELP&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 258 <p>WiConnect command help file. </p>
dan_ackme 14:85a2ed029f37 259 </td></tr>
dan_ackme 14:85a2ed029f37 260 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a244c4ea312de84a2f4cabaff386fcffd"></a>FILE_TYPE_SDC_CAPS&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 261 <p>SDC / goHACK.me file. </p>
dan_ackme 14:85a2ed029f37 262 </td></tr>
dan_ackme 14:85a2ed029f37 263 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63afd6c376410552b54187a162e2c6fdad2"></a>FILE_TYPE_SETUP_SCRIPT&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 264 <p>Setup script file. </p>
dan_ackme 14:85a2ed029f37 265 </td></tr>
dan_ackme 14:85a2ed029f37 266 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a2508195aa2793d49c5c6a24879b52206"></a>FILE_TYPE_MISC_FIX_LEN&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 267 <p>Miscellaneous fixed length file. </p>
dan_ackme 14:85a2ed029f37 268 </td></tr>
dan_ackme 14:85a2ed029f37 269 <tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a077782e07756b6dc93f96e9a0cca5c9e"></a>FILE_TYPE_UNKNOWN&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 270 <p>Unknown file type. </p>
dan_ackme 14:85a2ed029f37 271 </td></tr>
dan_ackme 14:85a2ed029f37 272 </table>
dan_ackme 14:85a2ed029f37 273
dan_ackme 26:8067e3d463d3 274 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00383">383</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 14:85a2ed029f37 275
dan_ackme 14:85a2ed029f37 276 </div>
dan_ackme 14:85a2ed029f37 277 </div>
dan_ackme 14:85a2ed029f37 278 </div><!-- contents -->
dan_ackme 14:85a2ed029f37 279 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 280 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 281 <ul>
dan_ackme 14:85a2ed029f37 282 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 283 </ul>
dan_ackme 14:85a2ed029f37 284 </div>
dan_ackme 14:85a2ed029f37 285 </body>
dan_ackme 14:85a2ed029f37 286 </html>