ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

doc/mbed/html/group__api__ghm__com.html@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
34:2616445d0823 
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 34:2616445d0823 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 34:2616445d0823 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 34:2616445d0823 3 <head>
dan_ackme 34:2616445d0823 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 34:2616445d0823 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 34:2616445d0823 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 34:2616445d0823 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 34:2616445d0823 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 34:2616445d0823 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 34:2616445d0823 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 34:2616445d0823 15 <script type="text/javascript">
dan_ackme 34:2616445d0823 16 $(document).ready(initResizable);
dan_ackme 34:2616445d0823 17 $(window).load(resizeHeight);
dan_ackme 34:2616445d0823 18 </script>
dan_ackme 34:2616445d0823 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 34:2616445d0823 21 <script type="text/javascript">
dan_ackme 34:2616445d0823 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 34:2616445d0823 23 </script>
dan_ackme 34:2616445d0823 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 34:2616445d0823 25 </head>
dan_ackme 34:2616445d0823 26 <body>
dan_ackme 34:2616445d0823 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 34:2616445d0823 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 34:2616445d0823 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 34:2616445d0823 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 34:2616445d0823 32 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 34:2616445d0823 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 34:2616445d0823 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 34:2616445d0823 36 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 37 </tr>
dan_ackme 34:2616445d0823 38 <tr><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 39 </table>
dan_ackme 34:2616445d0823 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 34:2616445d0823 41 <script type="text/javascript">
dan_ackme 34:2616445d0823 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 34:2616445d0823 43 </script>
dan_ackme 34:2616445d0823 44 <div id="navrow1" class="tabs">
dan_ackme 34:2616445d0823 45 <ul class="tablist">
dan_ackme 34:2616445d0823 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 34:2616445d0823 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 34:2616445d0823 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 34:2616445d0823 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 34:2616445d0823 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 34:2616445d0823 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 34:2616445d0823 52 <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
dan_ackme 34:2616445d0823 53 <li>
dan_ackme 34:2616445d0823 54 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 34:2616445d0823 55 <span class="left">
dan_ackme 34:2616445d0823 56 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 34:2616445d0823 57 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 58 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 59 alt=""/>
dan_ackme 34:2616445d0823 60 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 34:2616445d0823 61 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 34:2616445d0823 62 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 34:2616445d0823 63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 34:2616445d0823 64 </span><span class="right">
dan_ackme 34:2616445d0823 65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 34:2616445d0823 66 </span>
dan_ackme 34:2616445d0823 67 </div>
dan_ackme 34:2616445d0823 68 </li>
dan_ackme 34:2616445d0823 69 </ul>
dan_ackme 34:2616445d0823 70 </div>
dan_ackme 34:2616445d0823 71 </div><!-- top -->
dan_ackme 34:2616445d0823 72 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 73 <div id="nav-tree">
dan_ackme 34:2616445d0823 74 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 75 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 76 </div>
dan_ackme 34:2616445d0823 77 </div>
dan_ackme 34:2616445d0823 78 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 79 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 80 </div>
dan_ackme 34:2616445d0823 81 </div>
dan_ackme 34:2616445d0823 82 <script type="text/javascript">
dan_ackme 34:2616445d0823 83 $(document).ready(function(){initNavTree('group__api__ghm__com.html','');});
dan_ackme 34:2616445d0823 84 </script>
dan_ackme 34:2616445d0823 85 <div id="doc-content">
dan_ackme 34:2616445d0823 86 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 87 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 88 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 89 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 90 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 91 <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 34:2616445d0823 92
dan_ackme 34:2616445d0823 93 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 94 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 95 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 96 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 97 </iframe>
dan_ackme 34:2616445d0823 98 </div>
dan_ackme 34:2616445d0823 99
dan_ackme 34:2616445d0823 100 <div class="header">
dan_ackme 34:2616445d0823 101 <div class="summary">
dan_ackme 34:2616445d0823 102 <a href="#func-members">Functions</a> </div>
dan_ackme 34:2616445d0823 103 <div class="headertitle">
dan_ackme 34:2616445d0823 104 <div class="title">Read/Write<div class="ingroups"><a class="el" href="group__api__ghm.html">goHACK.me</a></div></div> </div>
dan_ackme 34:2616445d0823 105 </div><!--header-->
dan_ackme 34:2616445d0823 106 <div class="contents">
dan_ackme 34:2616445d0823 107
dan_ackme 34:2616445d0823 108 <p>Methods for reading &amp; writing data from/to <a href="http://goHACK.me">http://goHACK.me</a>.
dan_ackme 34:2616445d0823 109 <a href="#details">More...</a></p>
dan_ackme 34:2616445d0823 110 <table class="memberdecls">
dan_ackme 34:2616445d0823 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 34:2616445d0823 112 Functions</h2></td></tr>
dan_ackme 34:2616445d0823 113 <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">wiconnect::GhmInterface::ghmRead</a> (const char *controlName, const char **valueStrPtr)</td></tr>
dan_ackme 34:2616445d0823 114 <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="#ga3fde7b34da992719b41fc52178b73bc2">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 115 <tr class="separator:ga3fde7b34da992719b41fc52178b73bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 116 <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">wiconnect::GhmInterface::ghmRead</a> (const char *controlName, uint32_t *valueIntPtr)</td></tr>
dan_ackme 34:2616445d0823 117 <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="#ga2d4f14ef409c30b49ce2a06b72d10c7f">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 118 <tr class="separator:ga2d4f14ef409c30b49ce2a06b72d10c7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 119 <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">wiconnect::GhmInterface::ghmRead</a> (const char *controlName, char *valueBuffer, uint16_t valueBufferLen)</td></tr>
dan_ackme 34:2616445d0823 120 <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="#ga965090d4b28bda9f58716b522a6bee12">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 121 <tr class="separator:ga965090d4b28bda9f58716b522a6bee12"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 122 <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">wiconnect::GhmInterface::ghmWrite</a> (const char *elementName, const char *strValue)</td></tr>
dan_ackme 34:2616445d0823 123 <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="#ga2f57fc33ad0e71d608b1350d4e3ab223">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 124 <tr class="separator:ga2f57fc33ad0e71d608b1350d4e3ab223"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 125 <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">wiconnect::GhmInterface::ghmWrite</a> (const char *elementName, uint32_t uintValue)</td></tr>
dan_ackme 34:2616445d0823 126 <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="#ga26ef47c451e7dbe869f19f5f36695e7c">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 127 <tr class="separator:ga26ef47c451e7dbe869f19f5f36695e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 128 <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">wiconnect::GhmInterface::ghmWrite</a> (const char *elementName, int32_t intValue)</td></tr>
dan_ackme 34:2616445d0823 129 <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="#gab524e64f4bbae826c27bf39d7f2d3c2e">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 130 <tr class="separator:gab524e64f4bbae826c27bf39d7f2d3c2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 131 <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">wiconnect::GhmInterface::ghmWrite</a> (const <a class="el" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a> *elementArray)</td></tr>
dan_ackme 34:2616445d0823 132 <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="#ga5eb797aba87a3ab76d742afe34292ee6">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 133 <tr class="separator:ga5eb797aba87a3ab76d742afe34292ee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 134 <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">wiconnect::GhmInterface::ghmSynchronize</a> (<a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> type=GHM_SYNC_ALL)</td></tr>
dan_ackme 34:2616445d0823 135 <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="#ga0aa48506edb22c90be513683672b96c7">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 136 <tr class="separator:ga0aa48506edb22c90be513683672b96c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 137 </table>
dan_ackme 34:2616445d0823 138 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 139 <p>Methods for reading &amp; writing data from/to <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 140 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 34:2616445d0823 141 <a class="anchor" id="ga3fde7b34da992719b41fc52178b73bc2"></a>
dan_ackme 34:2616445d0823 142 <div class="memitem">
dan_ackme 34:2616445d0823 143 <div class="memproto">
dan_ackme 34:2616445d0823 144 <table class="memname">
dan_ackme 34:2616445d0823 145 <tr>
dan_ackme 34:2616445d0823 146 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmRead </td>
dan_ackme 34:2616445d0823 147 <td>(</td>
dan_ackme 34:2616445d0823 148 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 149 <td class="paramname"><em>controlName</em>, </td>
dan_ackme 34:2616445d0823 150 </tr>
dan_ackme 34:2616445d0823 151 <tr>
dan_ackme 34:2616445d0823 152 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 153 <td></td>
dan_ackme 34:2616445d0823 154 <td class="paramtype">const char **&#160;</td>
dan_ackme 34:2616445d0823 155 <td class="paramname"><em>valueStrPtr</em>&#160;</td>
dan_ackme 34:2616445d0823 156 </tr>
dan_ackme 34:2616445d0823 157 <tr>
dan_ackme 34:2616445d0823 158 <td></td>
dan_ackme 34:2616445d0823 159 <td>)</td>
dan_ackme 34:2616445d0823 160 <td></td><td></td>
dan_ackme 34:2616445d0823 161 </tr>
dan_ackme 34:2616445d0823 162 </table>
dan_ackme 34:2616445d0823 163 </div><div class="memdoc">
dan_ackme 34:2616445d0823 164
dan_ackme 34:2616445d0823 165 <p>Read control data from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 166 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 167 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 168 <table class="params">
dan_ackme 34:2616445d0823 169 <tr><td class="paramdir">[in]</td><td class="paramname">controlName</td><td>The name of the control in the activated capabilities file. </td></tr>
dan_ackme 34:2616445d0823 170 <tr><td class="paramdir">[in]</td><td class="paramname">valueStrPtr</td><td>Pointer to pointer to hold control's string value </td></tr>
dan_ackme 34:2616445d0823 171 </table>
dan_ackme 34:2616445d0823 172 </dd>
dan_ackme 34:2616445d0823 173 </dl>
dan_ackme 34:2616445d0823 174 <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 34:2616445d0823 175
dan_ackme 34:2616445d0823 176 </div>
dan_ackme 34:2616445d0823 177 </div>
dan_ackme 34:2616445d0823 178 <a class="anchor" id="ga2d4f14ef409c30b49ce2a06b72d10c7f"></a>
dan_ackme 34:2616445d0823 179 <div class="memitem">
dan_ackme 34:2616445d0823 180 <div class="memproto">
dan_ackme 34:2616445d0823 181 <table class="memname">
dan_ackme 34:2616445d0823 182 <tr>
dan_ackme 34:2616445d0823 183 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmRead </td>
dan_ackme 34:2616445d0823 184 <td>(</td>
dan_ackme 34:2616445d0823 185 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 186 <td class="paramname"><em>controlName</em>, </td>
dan_ackme 34:2616445d0823 187 </tr>
dan_ackme 34:2616445d0823 188 <tr>
dan_ackme 34:2616445d0823 189 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 190 <td></td>
dan_ackme 34:2616445d0823 191 <td class="paramtype">uint32_t *&#160;</td>
dan_ackme 34:2616445d0823 192 <td class="paramname"><em>valueIntPtr</em>&#160;</td>
dan_ackme 34:2616445d0823 193 </tr>
dan_ackme 34:2616445d0823 194 <tr>
dan_ackme 34:2616445d0823 195 <td></td>
dan_ackme 34:2616445d0823 196 <td>)</td>
dan_ackme 34:2616445d0823 197 <td></td><td></td>
dan_ackme 34:2616445d0823 198 </tr>
dan_ackme 34:2616445d0823 199 </table>
dan_ackme 34:2616445d0823 200 </div><div class="memdoc">
dan_ackme 34:2616445d0823 201
dan_ackme 34:2616445d0823 202 <p>Read control data from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 203 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 204 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 205 <table class="params">
dan_ackme 34:2616445d0823 206 <tr><td class="paramdir">[in]</td><td class="paramname">controlName</td><td>The name of the control in the activated capabilities file. </td></tr>
dan_ackme 34:2616445d0823 207 <tr><td class="paramdir">[in]</td><td class="paramname">valueIntPtr</td><td>Pointer hold control's integer value </td></tr>
dan_ackme 34:2616445d0823 208 </table>
dan_ackme 34:2616445d0823 209 </dd>
dan_ackme 34:2616445d0823 210 </dl>
dan_ackme 34:2616445d0823 211 <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 34:2616445d0823 212
dan_ackme 34:2616445d0823 213 </div>
dan_ackme 34:2616445d0823 214 </div>
dan_ackme 34:2616445d0823 215 <a class="anchor" id="ga965090d4b28bda9f58716b522a6bee12"></a>
dan_ackme 34:2616445d0823 216 <div class="memitem">
dan_ackme 34:2616445d0823 217 <div class="memproto">
dan_ackme 34:2616445d0823 218 <table class="memname">
dan_ackme 34:2616445d0823 219 <tr>
dan_ackme 34:2616445d0823 220 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmRead </td>
dan_ackme 34:2616445d0823 221 <td>(</td>
dan_ackme 34:2616445d0823 222 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 223 <td class="paramname"><em>controlName</em>, </td>
dan_ackme 34:2616445d0823 224 </tr>
dan_ackme 34:2616445d0823 225 <tr>
dan_ackme 34:2616445d0823 226 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 227 <td></td>
dan_ackme 34:2616445d0823 228 <td class="paramtype">char *&#160;</td>
dan_ackme 34:2616445d0823 229 <td class="paramname"><em>valueBuffer</em>, </td>
dan_ackme 34:2616445d0823 230 </tr>
dan_ackme 34:2616445d0823 231 <tr>
dan_ackme 34:2616445d0823 232 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 233 <td></td>
dan_ackme 34:2616445d0823 234 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 34:2616445d0823 235 <td class="paramname"><em>valueBufferLen</em>&#160;</td>
dan_ackme 34:2616445d0823 236 </tr>
dan_ackme 34:2616445d0823 237 <tr>
dan_ackme 34:2616445d0823 238 <td></td>
dan_ackme 34:2616445d0823 239 <td>)</td>
dan_ackme 34:2616445d0823 240 <td></td><td></td>
dan_ackme 34:2616445d0823 241 </tr>
dan_ackme 34:2616445d0823 242 </table>
dan_ackme 34:2616445d0823 243 </div><div class="memdoc">
dan_ackme 34:2616445d0823 244
dan_ackme 34:2616445d0823 245 <p>Read control data from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 246 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 247 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 248 <table class="params">
dan_ackme 34:2616445d0823 249 <tr><td class="paramdir">[in]</td><td class="paramname">controlName</td><td>The name of the control in the activated capabilities file. </td></tr>
dan_ackme 34:2616445d0823 250 <tr><td class="paramdir">[in]</td><td class="paramname">valueBuffer</td><td>Buffer to hold control's string value </td></tr>
dan_ackme 34:2616445d0823 251 <tr><td class="paramdir">[in]</td><td class="paramname">valueBufferLen</td><td>Length of valueBuffer </td></tr>
dan_ackme 34:2616445d0823 252 </table>
dan_ackme 34:2616445d0823 253 </dd>
dan_ackme 34:2616445d0823 254 </dl>
dan_ackme 34:2616445d0823 255 <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 34:2616445d0823 256
dan_ackme 34:2616445d0823 257 </div>
dan_ackme 34:2616445d0823 258 </div>
dan_ackme 34:2616445d0823 259 <a class="anchor" id="ga0aa48506edb22c90be513683672b96c7"></a>
dan_ackme 34:2616445d0823 260 <div class="memitem">
dan_ackme 34:2616445d0823 261 <div class="memproto">
dan_ackme 34:2616445d0823 262 <table class="memname">
dan_ackme 34:2616445d0823 263 <tr>
dan_ackme 34:2616445d0823 264 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmSynchronize </td>
dan_ackme 34:2616445d0823 265 <td>(</td>
dan_ackme 34:2616445d0823 266 <td class="paramtype"><a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a>&#160;</td>
dan_ackme 34:2616445d0823 267 <td class="paramname"><em>type</em> = <code><a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">GHM_SYNC_ALL</a></code></td><td>)</td>
dan_ackme 34:2616445d0823 268 <td></td>
dan_ackme 34:2616445d0823 269 </tr>
dan_ackme 34:2616445d0823 270 </table>
dan_ackme 34:2616445d0823 271 </div><div class="memdoc">
dan_ackme 34:2616445d0823 272
dan_ackme 34:2616445d0823 273 <p>Synchronize WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 274 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 275 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 276 <table class="params">
dan_ackme 34:2616445d0823 277 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of synchronization. See <a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> </td></tr>
dan_ackme 34:2616445d0823 278 </table>
dan_ackme 34:2616445d0823 279 </dd>
dan_ackme 34:2616445d0823 280 </dl>
dan_ackme 34:2616445d0823 281 <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 34:2616445d0823 282
dan_ackme 34:2616445d0823 283 </div>
dan_ackme 34:2616445d0823 284 </div>
dan_ackme 34:2616445d0823 285 <a class="anchor" id="ga2f57fc33ad0e71d608b1350d4e3ab223"></a>
dan_ackme 34:2616445d0823 286 <div class="memitem">
dan_ackme 34:2616445d0823 287 <div class="memproto">
dan_ackme 34:2616445d0823 288 <table class="memname">
dan_ackme 34:2616445d0823 289 <tr>
dan_ackme 34:2616445d0823 290 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmWrite </td>
dan_ackme 34:2616445d0823 291 <td>(</td>
dan_ackme 34:2616445d0823 292 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 293 <td class="paramname"><em>elementName</em>, </td>
dan_ackme 34:2616445d0823 294 </tr>
dan_ackme 34:2616445d0823 295 <tr>
dan_ackme 34:2616445d0823 296 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 297 <td></td>
dan_ackme 34:2616445d0823 298 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 299 <td class="paramname"><em>strValue</em>&#160;</td>
dan_ackme 34:2616445d0823 300 </tr>
dan_ackme 34:2616445d0823 301 <tr>
dan_ackme 34:2616445d0823 302 <td></td>
dan_ackme 34:2616445d0823 303 <td>)</td>
dan_ackme 34:2616445d0823 304 <td></td><td></td>
dan_ackme 34:2616445d0823 305 </tr>
dan_ackme 34:2616445d0823 306 </table>
dan_ackme 34:2616445d0823 307 </div><div class="memdoc">
dan_ackme 34:2616445d0823 308
dan_ackme 34:2616445d0823 309 <p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 310 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 311 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 312 <table class="params">
dan_ackme 34:2616445d0823 313 <tr><td class="paramdir">[in]</td><td class="paramname">elementName</td><td>The name of the control or stream in the activated capabilities file. </td></tr>
dan_ackme 34:2616445d0823 314 <tr><td class="paramdir">[in]</td><td class="paramname">strValue</td><td>String value of control or stream </td></tr>
dan_ackme 34:2616445d0823 315 </table>
dan_ackme 34:2616445d0823 316 </dd>
dan_ackme 34:2616445d0823 317 </dl>
dan_ackme 34:2616445d0823 318 <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 34:2616445d0823 319
dan_ackme 34:2616445d0823 320 </div>
dan_ackme 34:2616445d0823 321 </div>
dan_ackme 34:2616445d0823 322 <a class="anchor" id="ga26ef47c451e7dbe869f19f5f36695e7c"></a>
dan_ackme 34:2616445d0823 323 <div class="memitem">
dan_ackme 34:2616445d0823 324 <div class="memproto">
dan_ackme 34:2616445d0823 325 <table class="memname">
dan_ackme 34:2616445d0823 326 <tr>
dan_ackme 34:2616445d0823 327 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmWrite </td>
dan_ackme 34:2616445d0823 328 <td>(</td>
dan_ackme 34:2616445d0823 329 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 330 <td class="paramname"><em>elementName</em>, </td>
dan_ackme 34:2616445d0823 331 </tr>
dan_ackme 34:2616445d0823 332 <tr>
dan_ackme 34:2616445d0823 333 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 334 <td></td>
dan_ackme 34:2616445d0823 335 <td class="paramtype">uint32_t&#160;</td>
dan_ackme 34:2616445d0823 336 <td class="paramname"><em>uintValue</em>&#160;</td>
dan_ackme 34:2616445d0823 337 </tr>
dan_ackme 34:2616445d0823 338 <tr>
dan_ackme 34:2616445d0823 339 <td></td>
dan_ackme 34:2616445d0823 340 <td>)</td>
dan_ackme 34:2616445d0823 341 <td></td><td></td>
dan_ackme 34:2616445d0823 342 </tr>
dan_ackme 34:2616445d0823 343 </table>
dan_ackme 34:2616445d0823 344 </div><div class="memdoc">
dan_ackme 34:2616445d0823 345
dan_ackme 34:2616445d0823 346 <p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 347 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 348 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 349 <table class="params">
dan_ackme 34:2616445d0823 350 <tr><td class="paramdir">[in]</td><td class="paramname">elementName</td><td>The name of the control or stream in the activated capabilities file. </td></tr>
dan_ackme 34:2616445d0823 351 <tr><td class="paramdir">[in]</td><td class="paramname">uintValue</td><td>Unsigned integer value of control or stream </td></tr>
dan_ackme 34:2616445d0823 352 </table>
dan_ackme 34:2616445d0823 353 </dd>
dan_ackme 34:2616445d0823 354 </dl>
dan_ackme 34:2616445d0823 355 <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 34:2616445d0823 356
dan_ackme 34:2616445d0823 357 </div>
dan_ackme 34:2616445d0823 358 </div>
dan_ackme 34:2616445d0823 359 <a class="anchor" id="gab524e64f4bbae826c27bf39d7f2d3c2e"></a>
dan_ackme 34:2616445d0823 360 <div class="memitem">
dan_ackme 34:2616445d0823 361 <div class="memproto">
dan_ackme 34:2616445d0823 362 <table class="memname">
dan_ackme 34:2616445d0823 363 <tr>
dan_ackme 34:2616445d0823 364 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmWrite </td>
dan_ackme 34:2616445d0823 365 <td>(</td>
dan_ackme 34:2616445d0823 366 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 367 <td class="paramname"><em>elementName</em>, </td>
dan_ackme 34:2616445d0823 368 </tr>
dan_ackme 34:2616445d0823 369 <tr>
dan_ackme 34:2616445d0823 370 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 371 <td></td>
dan_ackme 34:2616445d0823 372 <td class="paramtype">int32_t&#160;</td>
dan_ackme 34:2616445d0823 373 <td class="paramname"><em>intValue</em>&#160;</td>
dan_ackme 34:2616445d0823 374 </tr>
dan_ackme 34:2616445d0823 375 <tr>
dan_ackme 34:2616445d0823 376 <td></td>
dan_ackme 34:2616445d0823 377 <td>)</td>
dan_ackme 34:2616445d0823 378 <td></td><td></td>
dan_ackme 34:2616445d0823 379 </tr>
dan_ackme 34:2616445d0823 380 </table>
dan_ackme 34:2616445d0823 381 </div><div class="memdoc">
dan_ackme 34:2616445d0823 382
dan_ackme 34:2616445d0823 383 <p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 384 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 385 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 386 <table class="params">
dan_ackme 34:2616445d0823 387 <tr><td class="paramdir">[in]</td><td class="paramname">elementName</td><td>The name of the control or stream in the activated capabilities file. </td></tr>
dan_ackme 34:2616445d0823 388 <tr><td class="paramdir">[in]</td><td class="paramname">intValue</td><td>signed integer value of control or stream </td></tr>
dan_ackme 34:2616445d0823 389 </table>
dan_ackme 34:2616445d0823 390 </dd>
dan_ackme 34:2616445d0823 391 </dl>
dan_ackme 34:2616445d0823 392 <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 34:2616445d0823 393
dan_ackme 34:2616445d0823 394 </div>
dan_ackme 34:2616445d0823 395 </div>
dan_ackme 34:2616445d0823 396 <a class="anchor" id="ga5eb797aba87a3ab76d742afe34292ee6"></a>
dan_ackme 34:2616445d0823 397 <div class="memitem">
dan_ackme 34:2616445d0823 398 <div class="memproto">
dan_ackme 34:2616445d0823 399 <table class="memname">
dan_ackme 34:2616445d0823 400 <tr>
dan_ackme 34:2616445d0823 401 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmWrite </td>
dan_ackme 34:2616445d0823 402 <td>(</td>
dan_ackme 34:2616445d0823 403 <td class="paramtype">const <a class="el" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a> *&#160;</td>
dan_ackme 34:2616445d0823 404 <td class="paramname"><em>elementArray</em></td><td>)</td>
dan_ackme 34:2616445d0823 405 <td></td>
dan_ackme 34:2616445d0823 406 </tr>
dan_ackme 34:2616445d0823 407 </table>
dan_ackme 34:2616445d0823 408 </div><div class="memdoc">
dan_ackme 34:2616445d0823 409
dan_ackme 34:2616445d0823 410 <p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 411 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 412 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 413 <table class="params">
dan_ackme 34:2616445d0823 414 <tr><td class="paramdir">[in]</td><td class="paramname">elementArray</td><td>Array of stream and/or control values to send to <a href="http://goHACK.me">http://goHACK.me</a> </td></tr>
dan_ackme 34:2616445d0823 415 </table>
dan_ackme 34:2616445d0823 416 </dd>
dan_ackme 34:2616445d0823 417 </dl>
dan_ackme 34:2616445d0823 418 <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 34:2616445d0823 419
dan_ackme 34:2616445d0823 420 </div>
dan_ackme 34:2616445d0823 421 </div>
dan_ackme 34:2616445d0823 422 </div><!-- contents -->
dan_ackme 34:2616445d0823 423 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 424 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 425 <ul>
dan_ackme 34:2616445d0823 426 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 427 </ul>
dan_ackme 34:2616445d0823 428 </div>
dan_ackme 34:2616445d0823 429 </body>
dan_ackme 34:2616445d0823 430 </html>