ACKme
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/group__api__ghm__activate.html
- Committer:
- dan_ackme
- Date:
- 2014-10-27
- Revision:
- 29:b6af04b77a56
File content as of revision 29:b6af04b77a56:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__api__ghm__activate.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Activation<div class="ingroups"><a class="el" href="group__api__ghm.html">goHACK.me</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Methods for activating/deactivating the module with <a href="http://goHACK.me">http://goHACK.me</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaff03ecaa08146e6925820209cdab56bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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>
<tr class="memdesc:gaff03ecaa08146e6925820209cdab56bd"><td class="mdescLeft"> </td><td class="mdescRight">Download a device capabilities file to WiFi module's internal file system. <a href="#gaff03ecaa08146e6925820209cdab56bd">More...</a><br /></td></tr>
<tr class="separator:gaff03ecaa08146e6925820209cdab56bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa0213731eebd4a14e9099d01ff76beff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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>
<tr class="memdesc:gaa0213731eebd4a14e9099d01ff76beff"><td class="mdescLeft"> </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>
<tr class="separator:gaa0213731eebd4a14e9099d01ff76beff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad0e0484d1f9a6608475874544f96708b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </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>
<tr class="memdesc:gad0e0484d1f9a6608475874544f96708b"><td class="mdescLeft"> </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>
<tr class="separator:gad0e0484d1f9a6608475874544f96708b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bec70f780ca7de9dce1a15830c179ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">wiconnect::GhmInterface::ghmIsActivated</a> (bool *statusPtr)</td></tr>
<tr class="memdesc:ga8bec70f780ca7de9dce1a15830c179ff"><td class="mdescLeft"> </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>
<tr class="separator:ga8bec70f780ca7de9dce1a15830c179ff"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Methods for activating/deactivating the module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaa0213731eebd4a14e9099d01ff76beff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmActivate </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>userName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>capsFilename</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
<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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">userName</td><td>Your username </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Your password </td></tr>
<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>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a class="anchor" id="gad0e0484d1f9a6608475874544f96708b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmDeactivate </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>userName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deactivate WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
<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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">userName</td><td>Your username </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>Your password </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a class="anchor" id="gaff03ecaa08146e6925820209cdab56bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmDownloadCapabilities </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>capsNameOrCustomUrl</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>version</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Download a device capabilities file to WiFi module's internal file system. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
<tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>Optional, version to set downloaded caps file as </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a class="anchor" id="ga8bec70f780ca7de9dce1a15830c179ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmIsActivated </td>
<td>(</td>
<td class="paramtype">bool * </td>
<td class="paramname"><em>statusPtr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return if WiFi module is activated with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">statusPtr</td><td>Pointer to hold activation status. </td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</li>
</ul>
</div>
</body>
</html>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02