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_ghm_interface.html

Committer:
aymangrais
Date:
2015-09-28
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56

File content as of revision 42:8ffb253b09e7:

<!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>&nbsp;</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>&nbsp;</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&#160;Overview</span></a></li>
      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></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('classwiconnect_1_1_ghm_interface.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">&#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>

<!-- 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="#pub-methods">Public Member Functions</a> &#124;
<a href="classwiconnect_1_1_ghm_interface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">wiconnect::GhmInterface Class Reference<div class="ingroups"><a class="el" href="group__api__ghm__types.html">Types</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The provides an interface for <a href="http://goHACK.me">http://goHACK.me</a>.  
 <a href="classwiconnect_1_1_ghm_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_ghm_interface_8h_source.html">GhmInterface.h</a>&gt;</code></p>

<p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member 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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#gaff03ecaa08146e6925820209cdab56bd">ghmDownloadCapabilities</a> (const char *capsNameOrCustomUrl=NULL, uint32_t version=0)</td></tr>
<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="group__api__ghm__activate.html#gaff03ecaa08146e6925820209cdab56bd">More...</a><br /></td></tr>
<tr class="separator:gaff03ecaa08146e6925820209cdab56bd"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate</a> (const char *userName, const char *password, const char *capsFilename=NULL)</td></tr>
<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="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">More...</a><br /></td></tr>
<tr class="separator:gaa0213731eebd4a14e9099d01ff76beff"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#gad0e0484d1f9a6608475874544f96708b">ghmDeactivate</a> (const char *userName, const char *password)</td></tr>
<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="group__api__ghm__activate.html#gad0e0484d1f9a6608475874544f96708b">More...</a><br /></td></tr>
<tr class="separator:gad0e0484d1f9a6608475874544f96708b"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">ghmIsActivated</a> (bool *statusPtr)</td></tr>
<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="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">More...</a><br /></td></tr>
<tr class="separator:ga8bec70f780ca7de9dce1a15830c179ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3fde7b34da992719b41fc52178b73bc2"><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__com.html#ga3fde7b34da992719b41fc52178b73bc2">ghmRead</a> (const char *controlName, const char **valueStrPtr)</td></tr>
<tr class="memdesc:ga3fde7b34da992719b41fc52178b73bc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read control data from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga3fde7b34da992719b41fc52178b73bc2">More...</a><br /></td></tr>
<tr class="separator:ga3fde7b34da992719b41fc52178b73bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d4f14ef409c30b49ce2a06b72d10c7f"><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__com.html#ga2d4f14ef409c30b49ce2a06b72d10c7f">ghmRead</a> (const char *controlName, uint32_t *valueIntPtr)</td></tr>
<tr class="memdesc:ga2d4f14ef409c30b49ce2a06b72d10c7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read control data from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga2d4f14ef409c30b49ce2a06b72d10c7f">More...</a><br /></td></tr>
<tr class="separator:ga2d4f14ef409c30b49ce2a06b72d10c7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga965090d4b28bda9f58716b522a6bee12"><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__com.html#ga965090d4b28bda9f58716b522a6bee12">ghmRead</a> (const char *controlName, char *valueBuffer, uint16_t valueBufferLen)</td></tr>
<tr class="memdesc:ga965090d4b28bda9f58716b522a6bee12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read control data from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga965090d4b28bda9f58716b522a6bee12">More...</a><br /></td></tr>
<tr class="separator:ga965090d4b28bda9f58716b522a6bee12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f57fc33ad0e71d608b1350d4e3ab223"><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__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">ghmWrite</a> (const char *elementName, const char *strValue)</td></tr>
<tr class="memdesc:ga2f57fc33ad0e71d608b1350d4e3ab223"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">More...</a><br /></td></tr>
<tr class="separator:ga2f57fc33ad0e71d608b1350d4e3ab223"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26ef47c451e7dbe869f19f5f36695e7c"><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__com.html#ga26ef47c451e7dbe869f19f5f36695e7c">ghmWrite</a> (const char *elementName, uint32_t uintValue)</td></tr>
<tr class="memdesc:ga26ef47c451e7dbe869f19f5f36695e7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga26ef47c451e7dbe869f19f5f36695e7c">More...</a><br /></td></tr>
<tr class="separator:ga26ef47c451e7dbe869f19f5f36695e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab524e64f4bbae826c27bf39d7f2d3c2e"><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__com.html#gab524e64f4bbae826c27bf39d7f2d3c2e">ghmWrite</a> (const char *elementName, int32_t intValue)</td></tr>
<tr class="memdesc:gab524e64f4bbae826c27bf39d7f2d3c2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#gab524e64f4bbae826c27bf39d7f2d3c2e">More...</a><br /></td></tr>
<tr class="separator:gab524e64f4bbae826c27bf39d7f2d3c2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5eb797aba87a3ab76d742afe34292ee6"><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__com.html#ga5eb797aba87a3ab76d742afe34292ee6">ghmWrite</a> (const <a class="el" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a> *elementArray)</td></tr>
<tr class="memdesc:ga5eb797aba87a3ab76d742afe34292ee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga5eb797aba87a3ab76d742afe34292ee6">More...</a><br /></td></tr>
<tr class="separator:ga5eb797aba87a3ab76d742afe34292ee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0aa48506edb22c90be513683672b96c7"><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__com.html#ga0aa48506edb22c90be513683672b96c7">ghmSynchronize</a> (<a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> type=<a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">GHM_SYNC_ALL</a>)</td></tr>
<tr class="memdesc:ga0aa48506edb22c90be513683672b96c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Synchronize WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__com.html#ga0aa48506edb22c90be513683672b96c7">More...</a><br /></td></tr>
<tr class="separator:ga0aa48506edb22c90be513683672b96c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc281f497041b26a151c72a0b5d03543"><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__msg.html#gadc281f497041b26a151c72a0b5d03543">ghmPostMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, bool jsonFormatted=false)</td></tr>
<tr class="memdesc:gadc281f497041b26a151c72a0b5d03543"><td class="mdescLeft">&#160;</td><td class="mdescRight">POST message to <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#gadc281f497041b26a151c72a0b5d03543">More...</a><br /></td></tr>
<tr class="separator:gadc281f497041b26a151c72a0b5d03543"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa05391432b2ca38bb416c671f57b234"><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__msg.html#gaaa05391432b2ca38bb416c671f57b234">ghmGetMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType=<a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>)</td></tr>
<tr class="memdesc:gaaa05391432b2ca38bb416c671f57b234"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET message from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">More...</a><br /></td></tr>
<tr class="separator:gaaa05391432b2ca38bb416c671f57b234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa905a010f0e234d290eaef6e42975c29"><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__msg.html#gaa905a010f0e234d290eaef6e42975c29">ghmGetMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint8_t listIndex, <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType=<a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>)</td></tr>
<tr class="memdesc:gaa905a010f0e234d290eaef6e42975c29"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET message from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#gaa905a010f0e234d290eaef6e42975c29">More...</a><br /></td></tr>
<tr class="separator:gaa905a010f0e234d290eaef6e42975c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c6dffaa871f2443a32d75276160682d"><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__msg.html#ga9c6dffaa871f2443a32d75276160682d">ghmGetMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *msgId, <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType=<a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>)</td></tr>
<tr class="memdesc:ga9c6dffaa871f2443a32d75276160682d"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET message from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#ga9c6dffaa871f2443a32d75276160682d">More...</a><br /></td></tr>
<tr class="separator:ga9c6dffaa871f2443a32d75276160682d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga451de9d69f7ecbf38e36056e502b94b0"><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__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">ghmDeleteMessage</a> (uint8_t listIndex)</td></tr>
<tr class="memdesc:ga451de9d69f7ecbf38e36056e502b94b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete message from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">More...</a><br /></td></tr>
<tr class="separator:ga451de9d69f7ecbf38e36056e502b94b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7273f4c691aeccd241327f1be3e8d0e9"><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__msg.html#ga7273f4c691aeccd241327f1be3e8d0e9">ghmDeleteMessage</a> (const char *msgId)</td></tr>
<tr class="memdesc:ga7273f4c691aeccd241327f1be3e8d0e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete message from <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#ga7273f4c691aeccd241327f1be3e8d0e9">More...</a><br /></td></tr>
<tr class="separator:ga7273f4c691aeccd241327f1be3e8d0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae69971594793e1a10f11a51277909502"><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__msg.html#gae69971594793e1a10f11a51277909502">ghmListMessages</a> (<a class="el" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a> &amp;msgList, uint8_t maxCount=0)</td></tr>
<tr class="memdesc:gae69971594793e1a10f11a51277909502"><td class="mdescLeft">&#160;</td><td class="mdescRight">List available messages for device on <a href="http://goHACK.me">http://goHACK.me</a>.  <a href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">More...</a><br /></td></tr>
<tr class="separator:gae69971594793e1a10f11a51277909502"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The provides an interface for <a href="http://goHACK.me">http://goHACK.me</a>. </p>
<p>The goHACK.me API provided by WiConnect enables monitoring and control of your ACKme device. You can set up a goHACK.me account, then using goHACK.me commands and goHACK.me variables, you can activate your device and synchronize data, control and messages with the goHACK.me cloud service.</p>
<p>More information here: <a href="http://wiconnect.ack.me/2.0/gohackme">http://wiconnect.ack.me/2.0/gohackme</a></p>
<dl class="section note"><dt>Note</dt><dd>This class is an interface to the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> class. It should never be independently instantiated or the parent of another class. </dd></dl>

<p>Definition at line <a class="el" href="_ghm_interface_8h_source.html#l00081">81</a> of file <a class="el" href="_ghm_interface_8h_source.html">GhmInterface.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/api/<a class="el" href="_ghm_interface_8h_source.html">GhmInterface.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">&copy; ACKme Networks 2014</li>
  </ul>
</div>
</body>
</html>