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:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 29:b6af04b77a56 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 29:b6af04b77a56 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 29:b6af04b77a56 3 <head>
dan_ackme 29:b6af04b77a56 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 29:b6af04b77a56 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 29:b6af04b77a56 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 29:b6af04b77a56 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 29:b6af04b77a56 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 29:b6af04b77a56 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 29:b6af04b77a56 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 29:b6af04b77a56 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 29:b6af04b77a56 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 29:b6af04b77a56 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 29:b6af04b77a56 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 29:b6af04b77a56 15 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 16 $(document).ready(initResizable);
dan_ackme 29:b6af04b77a56 17 $(window).load(resizeHeight);
dan_ackme 29:b6af04b77a56 18 </script>
dan_ackme 29:b6af04b77a56 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 29:b6af04b77a56 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 29:b6af04b77a56 21 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 29:b6af04b77a56 23 </script>
dan_ackme 29:b6af04b77a56 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 29:b6af04b77a56 25 </head>
dan_ackme 29:b6af04b77a56 26 <body>
dan_ackme 29:b6af04b77a56 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 29:b6af04b77a56 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 29:b6af04b77a56 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 29:b6af04b77a56 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 29:b6af04b77a56 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 29:b6af04b77a56 32 <td style="width:20px"></td>
dan_ackme 29:b6af04b77a56 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 29:b6af04b77a56 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 29:b6af04b77a56 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 29:b6af04b77a56 36 <td style="width:20px"></td>
dan_ackme 29:b6af04b77a56 37 </tr>
dan_ackme 29:b6af04b77a56 38 <tr><td>&nbsp;</td></tr>
dan_ackme 29:b6af04b77a56 39 </table>
dan_ackme 29:b6af04b77a56 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 29:b6af04b77a56 41 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 29:b6af04b77a56 43 </script>
dan_ackme 29:b6af04b77a56 44 <div id="navrow1" class="tabs">
dan_ackme 29:b6af04b77a56 45 <ul class="tablist">
dan_ackme 29:b6af04b77a56 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 29:b6af04b77a56 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 29:b6af04b77a56 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 29:b6af04b77a56 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 29:b6af04b77a56 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 29:b6af04b77a56 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 29:b6af04b77a56 52 <li>
dan_ackme 29:b6af04b77a56 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 29:b6af04b77a56 54 <span class="left">
dan_ackme 29:b6af04b77a56 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 29:b6af04b77a56 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 29:b6af04b77a56 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 29:b6af04b77a56 58 alt=""/>
dan_ackme 29:b6af04b77a56 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 29:b6af04b77a56 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 29:b6af04b77a56 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 29:b6af04b77a56 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 29:b6af04b77a56 63 </span><span class="right">
dan_ackme 29:b6af04b77a56 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 29:b6af04b77a56 65 </span>
dan_ackme 29:b6af04b77a56 66 </div>
dan_ackme 29:b6af04b77a56 67 </li>
dan_ackme 29:b6af04b77a56 68 </ul>
dan_ackme 29:b6af04b77a56 69 </div>
dan_ackme 29:b6af04b77a56 70 </div><!-- top -->
dan_ackme 29:b6af04b77a56 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 29:b6af04b77a56 72 <div id="nav-tree">
dan_ackme 29:b6af04b77a56 73 <div id="nav-tree-contents">
dan_ackme 29:b6af04b77a56 74 <div id="nav-sync" class="sync"></div>
dan_ackme 29:b6af04b77a56 75 </div>
dan_ackme 29:b6af04b77a56 76 </div>
dan_ackme 29:b6af04b77a56 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 29:b6af04b77a56 78 class="ui-resizable-handle">
dan_ackme 29:b6af04b77a56 79 </div>
dan_ackme 29:b6af04b77a56 80 </div>
dan_ackme 29:b6af04b77a56 81 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 82 $(document).ready(function(){initNavTree('group__api__ghm__activate.html','');});
dan_ackme 29:b6af04b77a56 83 </script>
dan_ackme 29:b6af04b77a56 84 <div id="doc-content">
dan_ackme 29:b6af04b77a56 85 <!-- window showing the filter options -->
dan_ackme 29:b6af04b77a56 86 <div id="MSearchSelectWindow"
dan_ackme 29:b6af04b77a56 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 29:b6af04b77a56 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 29:b6af04b77a56 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 29:b6af04b77a56 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 29:b6af04b77a56 91
dan_ackme 29:b6af04b77a56 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 29:b6af04b77a56 93 <div id="MSearchResultsWindow">
dan_ackme 29:b6af04b77a56 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 29:b6af04b77a56 95 name="MSearchResults" id="MSearchResults">
dan_ackme 29:b6af04b77a56 96 </iframe>
dan_ackme 29:b6af04b77a56 97 </div>
dan_ackme 29:b6af04b77a56 98
dan_ackme 29:b6af04b77a56 99 <div class="header">
dan_ackme 29:b6af04b77a56 100 <div class="summary">
dan_ackme 29:b6af04b77a56 101 <a href="#func-members">Functions</a> </div>
dan_ackme 29:b6af04b77a56 102 <div class="headertitle">
dan_ackme 29:b6af04b77a56 103 <div class="title">Activation<div class="ingroups"><a class="el" href="group__api__ghm.html">goHACK.me</a></div></div> </div>
dan_ackme 29:b6af04b77a56 104 </div><!--header-->
dan_ackme 29:b6af04b77a56 105 <div class="contents">
dan_ackme 29:b6af04b77a56 106
dan_ackme 29:b6af04b77a56 107 <p>Methods for activating/deactivating the module with <a href="http://goHACK.me">http://goHACK.me</a>.
dan_ackme 29:b6af04b77a56 108 <a href="#details">More...</a></p>
dan_ackme 29:b6af04b77a56 109 <table class="memberdecls">
dan_ackme 29:b6af04b77a56 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 29:b6af04b77a56 111 Functions</h2></td></tr>
dan_ackme 29:b6af04b77a56 112 <tr class="memitem:gaff03ecaa08146e6925820209cdab56bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#gaff03ecaa08146e6925820209cdab56bd">wiconnect::GhmInterface::ghmDownloadCapabilities</a> (const char *capsNameOrCustomUrl=NULL, uint32_t version=0)</td></tr>
dan_ackme 29:b6af04b77a56 113 <tr class="memdesc:gaff03ecaa08146e6925820209cdab56bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Download a device capabilities file to WiFi module's internal file system. <a href="#gaff03ecaa08146e6925820209cdab56bd">More...</a><br /></td></tr>
dan_ackme 29:b6af04b77a56 114 <tr class="separator:gaff03ecaa08146e6925820209cdab56bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 115 <tr class="memitem:gaa0213731eebd4a14e9099d01ff76beff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">wiconnect::GhmInterface::ghmActivate</a> (const char *userName, const char *password, const char *capsFilename=NULL)</td></tr>
dan_ackme 29:b6af04b77a56 116 <tr class="memdesc:gaa0213731eebd4a14e9099d01ff76beff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#gaa0213731eebd4a14e9099d01ff76beff">More...</a><br /></td></tr>
dan_ackme 29:b6af04b77a56 117 <tr class="separator:gaa0213731eebd4a14e9099d01ff76beff"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 118 <tr class="memitem:gad0e0484d1f9a6608475874544f96708b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#gad0e0484d1f9a6608475874544f96708b">wiconnect::GhmInterface::ghmDeactivate</a> (const char *userName, const char *password)</td></tr>
dan_ackme 29:b6af04b77a56 119 <tr class="memdesc:gad0e0484d1f9a6608475874544f96708b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#gad0e0484d1f9a6608475874544f96708b">More...</a><br /></td></tr>
dan_ackme 29:b6af04b77a56 120 <tr class="separator:gad0e0484d1f9a6608475874544f96708b"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 121 <tr class="memitem:ga8bec70f780ca7de9dce1a15830c179ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">wiconnect::GhmInterface::ghmIsActivated</a> (bool *statusPtr)</td></tr>
dan_ackme 29:b6af04b77a56 122 <tr class="memdesc:ga8bec70f780ca7de9dce1a15830c179ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return if WiFi module is activated with <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#ga8bec70f780ca7de9dce1a15830c179ff">More...</a><br /></td></tr>
dan_ackme 29:b6af04b77a56 123 <tr class="separator:ga8bec70f780ca7de9dce1a15830c179ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 124 </table>
dan_ackme 29:b6af04b77a56 125 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 29:b6af04b77a56 126 <p>Methods for activating/deactivating the module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 29:b6af04b77a56 127 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 29:b6af04b77a56 128 <a class="anchor" id="gaa0213731eebd4a14e9099d01ff76beff"></a>
dan_ackme 29:b6af04b77a56 129 <div class="memitem">
dan_ackme 29:b6af04b77a56 130 <div class="memproto">
dan_ackme 29:b6af04b77a56 131 <table class="memname">
dan_ackme 29:b6af04b77a56 132 <tr>
dan_ackme 29:b6af04b77a56 133 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmActivate </td>
dan_ackme 29:b6af04b77a56 134 <td>(</td>
dan_ackme 29:b6af04b77a56 135 <td class="paramtype">const char *&#160;</td>
dan_ackme 29:b6af04b77a56 136 <td class="paramname"><em>userName</em>, </td>
dan_ackme 29:b6af04b77a56 137 </tr>
dan_ackme 29:b6af04b77a56 138 <tr>
dan_ackme 29:b6af04b77a56 139 <td class="paramkey"></td>
dan_ackme 29:b6af04b77a56 140 <td></td>
dan_ackme 29:b6af04b77a56 141 <td class="paramtype">const char *&#160;</td>
dan_ackme 29:b6af04b77a56 142 <td class="paramname"><em>password</em>, </td>
dan_ackme 29:b6af04b77a56 143 </tr>
dan_ackme 29:b6af04b77a56 144 <tr>
dan_ackme 29:b6af04b77a56 145 <td class="paramkey"></td>
dan_ackme 29:b6af04b77a56 146 <td></td>
dan_ackme 29:b6af04b77a56 147 <td class="paramtype">const char *&#160;</td>
dan_ackme 29:b6af04b77a56 148 <td class="paramname"><em>capsFilename</em> = <code>NULL</code>&#160;</td>
dan_ackme 29:b6af04b77a56 149 </tr>
dan_ackme 29:b6af04b77a56 150 <tr>
dan_ackme 29:b6af04b77a56 151 <td></td>
dan_ackme 29:b6af04b77a56 152 <td>)</td>
dan_ackme 29:b6af04b77a56 153 <td></td><td></td>
dan_ackme 29:b6af04b77a56 154 </tr>
dan_ackme 29:b6af04b77a56 155 </table>
dan_ackme 29:b6af04b77a56 156 </div><div class="memdoc">
dan_ackme 29:b6af04b77a56 157
dan_ackme 29:b6af04b77a56 158 <p>Activate WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 29:b6af04b77a56 159 <dl class="section note"><dt>Note</dt><dd>You must first sign-up with <a href="http://goHACK.me">http://goHACK.me</a> before you can activate the device. Go to <a href="http://goHACK.me">http://goHACK.me</a> to sign-up.</dd></dl>
dan_ackme 29:b6af04b77a56 160 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 29:b6af04b77a56 161 <table class="params">
dan_ackme 29:b6af04b77a56 162 <tr><td class="paramdir">[in]</td><td class="paramname">userName</td><td>Your username </td></tr>
dan_ackme 29:b6af04b77a56 163 <tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Your password </td></tr>
dan_ackme 29:b6af04b77a56 164 <tr><td class="paramdir">[in]</td><td class="paramname">capsFilename</td><td>Optional, filename of existing capabilities file on module's internal file system. </td></tr>
dan_ackme 29:b6af04b77a56 165 </table>
dan_ackme 29:b6af04b77a56 166 </dd>
dan_ackme 29:b6af04b77a56 167 </dl>
dan_ackme 29:b6af04b77a56 168 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 29:b6af04b77a56 169
dan_ackme 29:b6af04b77a56 170 </div>
dan_ackme 29:b6af04b77a56 171 </div>
dan_ackme 29:b6af04b77a56 172 <a class="anchor" id="gad0e0484d1f9a6608475874544f96708b"></a>
dan_ackme 29:b6af04b77a56 173 <div class="memitem">
dan_ackme 29:b6af04b77a56 174 <div class="memproto">
dan_ackme 29:b6af04b77a56 175 <table class="memname">
dan_ackme 29:b6af04b77a56 176 <tr>
dan_ackme 29:b6af04b77a56 177 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmDeactivate </td>
dan_ackme 29:b6af04b77a56 178 <td>(</td>
dan_ackme 29:b6af04b77a56 179 <td class="paramtype">const char *&#160;</td>
dan_ackme 29:b6af04b77a56 180 <td class="paramname"><em>userName</em>, </td>
dan_ackme 29:b6af04b77a56 181 </tr>
dan_ackme 29:b6af04b77a56 182 <tr>
dan_ackme 29:b6af04b77a56 183 <td class="paramkey"></td>
dan_ackme 29:b6af04b77a56 184 <td></td>
dan_ackme 29:b6af04b77a56 185 <td class="paramtype">const char *&#160;</td>
dan_ackme 29:b6af04b77a56 186 <td class="paramname"><em>password</em>&#160;</td>
dan_ackme 29:b6af04b77a56 187 </tr>
dan_ackme 29:b6af04b77a56 188 <tr>
dan_ackme 29:b6af04b77a56 189 <td></td>
dan_ackme 29:b6af04b77a56 190 <td>)</td>
dan_ackme 29:b6af04b77a56 191 <td></td><td></td>
dan_ackme 29:b6af04b77a56 192 </tr>
dan_ackme 29:b6af04b77a56 193 </table>
dan_ackme 29:b6af04b77a56 194 </div><div class="memdoc">
dan_ackme 29:b6af04b77a56 195
dan_ackme 29:b6af04b77a56 196 <p>Deactivate WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 29:b6af04b77a56 197 <dl class="section note"><dt>Note</dt><dd>You must first sign-up with <a href="http://goHACK.me">http://goHACK.me</a> before you can deactivate the device. Go to <a href="http://goHACK.me">http://goHACK.me</a> to sign-up.</dd></dl>
dan_ackme 29:b6af04b77a56 198 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 29:b6af04b77a56 199 <table class="params">
dan_ackme 29:b6af04b77a56 200 <tr><td class="paramdir">[in]</td><td class="paramname">userName</td><td>Your username </td></tr>
dan_ackme 29:b6af04b77a56 201 <tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Your password </td></tr>
dan_ackme 29:b6af04b77a56 202 </table>
dan_ackme 29:b6af04b77a56 203 </dd>
dan_ackme 29:b6af04b77a56 204 </dl>
dan_ackme 29:b6af04b77a56 205 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 29:b6af04b77a56 206
dan_ackme 29:b6af04b77a56 207 </div>
dan_ackme 29:b6af04b77a56 208 </div>
dan_ackme 29:b6af04b77a56 209 <a class="anchor" id="gaff03ecaa08146e6925820209cdab56bd"></a>
dan_ackme 29:b6af04b77a56 210 <div class="memitem">
dan_ackme 29:b6af04b77a56 211 <div class="memproto">
dan_ackme 29:b6af04b77a56 212 <table class="memname">
dan_ackme 29:b6af04b77a56 213 <tr>
dan_ackme 29:b6af04b77a56 214 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmDownloadCapabilities </td>
dan_ackme 29:b6af04b77a56 215 <td>(</td>
dan_ackme 29:b6af04b77a56 216 <td class="paramtype">const char *&#160;</td>
dan_ackme 29:b6af04b77a56 217 <td class="paramname"><em>capsNameOrCustomUrl</em> = <code>NULL</code>, </td>
dan_ackme 29:b6af04b77a56 218 </tr>
dan_ackme 29:b6af04b77a56 219 <tr>
dan_ackme 29:b6af04b77a56 220 <td class="paramkey"></td>
dan_ackme 29:b6af04b77a56 221 <td></td>
dan_ackme 29:b6af04b77a56 222 <td class="paramtype">uint32_t&#160;</td>
dan_ackme 29:b6af04b77a56 223 <td class="paramname"><em>version</em> = <code>0</code>&#160;</td>
dan_ackme 29:b6af04b77a56 224 </tr>
dan_ackme 29:b6af04b77a56 225 <tr>
dan_ackme 29:b6af04b77a56 226 <td></td>
dan_ackme 29:b6af04b77a56 227 <td>)</td>
dan_ackme 29:b6af04b77a56 228 <td></td><td></td>
dan_ackme 29:b6af04b77a56 229 </tr>
dan_ackme 29:b6af04b77a56 230 </table>
dan_ackme 29:b6af04b77a56 231 </div><div class="memdoc">
dan_ackme 29:b6af04b77a56 232
dan_ackme 29:b6af04b77a56 233 <p>Download a device capabilities file to WiFi module's internal file system. </p>
dan_ackme 29:b6af04b77a56 234 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 29:b6af04b77a56 235 <table class="params">
dan_ackme 29:b6af04b77a56 236 <tr><td class="paramdir">[in]</td><td class="paramname">capsNameOrCustomUrl</td><td>Optional, specify the caps file name or URL to caps file </td></tr>
dan_ackme 29:b6af04b77a56 237 <tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>Optional, version to set downloaded caps file as </td></tr>
dan_ackme 29:b6af04b77a56 238 </table>
dan_ackme 29:b6af04b77a56 239 </dd>
dan_ackme 29:b6af04b77a56 240 </dl>
dan_ackme 29:b6af04b77a56 241 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 29:b6af04b77a56 242
dan_ackme 29:b6af04b77a56 243 </div>
dan_ackme 29:b6af04b77a56 244 </div>
dan_ackme 29:b6af04b77a56 245 <a class="anchor" id="ga8bec70f780ca7de9dce1a15830c179ff"></a>
dan_ackme 29:b6af04b77a56 246 <div class="memitem">
dan_ackme 29:b6af04b77a56 247 <div class="memproto">
dan_ackme 29:b6af04b77a56 248 <table class="memname">
dan_ackme 29:b6af04b77a56 249 <tr>
dan_ackme 29:b6af04b77a56 250 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmIsActivated </td>
dan_ackme 29:b6af04b77a56 251 <td>(</td>
dan_ackme 29:b6af04b77a56 252 <td class="paramtype">bool *&#160;</td>
dan_ackme 29:b6af04b77a56 253 <td class="paramname"><em>statusPtr</em></td><td>)</td>
dan_ackme 29:b6af04b77a56 254 <td></td>
dan_ackme 29:b6af04b77a56 255 </tr>
dan_ackme 29:b6af04b77a56 256 </table>
dan_ackme 29:b6af04b77a56 257 </div><div class="memdoc">
dan_ackme 29:b6af04b77a56 258
dan_ackme 29:b6af04b77a56 259 <p>Return if WiFi module is activated with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 29:b6af04b77a56 260 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 29:b6af04b77a56 261 <table class="params">
dan_ackme 29:b6af04b77a56 262 <tr><td class="paramdir">[out]</td><td class="paramname">statusPtr</td><td>Pointer to hold activation status. </td></tr>
dan_ackme 29:b6af04b77a56 263 </table>
dan_ackme 29:b6af04b77a56 264 </dd>
dan_ackme 29:b6af04b77a56 265 </dl>
dan_ackme 29:b6af04b77a56 266 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 29:b6af04b77a56 267
dan_ackme 29:b6af04b77a56 268 </div>
dan_ackme 29:b6af04b77a56 269 </div>
dan_ackme 29:b6af04b77a56 270 </div><!-- contents -->
dan_ackme 29:b6af04b77a56 271 </div><!-- doc-content -->
dan_ackme 29:b6af04b77a56 272 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 29:b6af04b77a56 273 <ul>
dan_ackme 29:b6af04b77a56 274 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 29:b6af04b77a56 275 </ul>
dan_ackme 29:b6af04b77a56 276 </div>
dan_ackme 29:b6af04b77a56 277 </body>
dan_ackme 29:b6af04b77a56 278 </html>