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
Diff: doc/html/group__api__ghm__com.html
- Revision:
- 29:b6af04b77a56
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/group__api__ghm__com.html Mon Oct 27 13:42:26 2014 -0700 @@ -0,0 +1,429 @@ +<!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__com.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">Read/Write<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 reading & writing data from/to <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:ga3fde7b34da992719b41fc52178b73bc2"><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__com.html#ga3fde7b34da992719b41fc52178b73bc2">wiconnect::GhmInterface::ghmRead</a> (const char *controlName, const char **valueStrPtr)</td></tr> +<tr class="memdesc:ga3fde7b34da992719b41fc52178b73bc2"><td class="mdescLeft"> </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> +<tr class="separator:ga3fde7b34da992719b41fc52178b73bc2"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:ga2d4f14ef409c30b49ce2a06b72d10c7f"><td class="mdescLeft"> </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> +<tr class="separator:ga2d4f14ef409c30b49ce2a06b72d10c7f"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:ga965090d4b28bda9f58716b522a6bee12"><td class="mdescLeft"> </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> +<tr class="separator:ga965090d4b28bda9f58716b522a6bee12"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:ga2f57fc33ad0e71d608b1350d4e3ab223"><td class="mdescLeft"> </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> +<tr class="separator:ga2f57fc33ad0e71d608b1350d4e3ab223"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:ga26ef47c451e7dbe869f19f5f36695e7c"><td class="mdescLeft"> </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> +<tr class="separator:ga26ef47c451e7dbe869f19f5f36695e7c"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:gab524e64f4bbae826c27bf39d7f2d3c2e"><td class="mdescLeft"> </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> +<tr class="separator:gab524e64f4bbae826c27bf39d7f2d3c2e"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:ga5eb797aba87a3ab76d742afe34292ee6"><td class="mdescLeft"> </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> +<tr class="separator:ga5eb797aba87a3ab76d742afe34292ee6"><td class="memSeparator" colspan="2"> </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> </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> +<tr class="memdesc:ga0aa48506edb22c90be513683672b96c7"><td class="mdescLeft"> </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> +<tr class="separator:ga0aa48506edb22c90be513683672b96c7"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Methods for reading & writing data from/to <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga3fde7b34da992719b41fc52178b73bc2"></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::ghmRead </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>controlName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char ** </td> + <td class="paramname"><em>valueStrPtr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Read control data from <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">controlName</td><td>The name of the control in the activated capabilities file. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">valueStrPtr</td><td>Pointer to pointer to hold control's string value </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="ga2d4f14ef409c30b49ce2a06b72d10c7f"></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::ghmRead </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>controlName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t * </td> + <td class="paramname"><em>valueIntPtr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Read control data from <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">controlName</td><td>The name of the control in the activated capabilities file. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">valueIntPtr</td><td>Pointer hold control's integer value </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="ga965090d4b28bda9f58716b522a6bee12"></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::ghmRead </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>controlName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>valueBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>valueBufferLen</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Read control data from <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">controlName</td><td>The name of the control in the activated capabilities file. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">valueBuffer</td><td>Buffer to hold control's string value </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">valueBufferLen</td><td>Length of valueBuffer </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="ga0aa48506edb22c90be513683672b96c7"></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::ghmSynchronize </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> </td> + <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> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Synchronize WiFi module with <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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> + </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="ga2f57fc33ad0e71d608b1350d4e3ab223"></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::ghmWrite </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>elementName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>strValue</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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> + <tr><td class="paramdir">[in]</td><td class="paramname">strValue</td><td>String value of control or stream </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="ga26ef47c451e7dbe869f19f5f36695e7c"></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::ghmWrite </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>elementName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>uintValue</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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> + <tr><td class="paramdir">[in]</td><td class="paramname">uintValue</td><td>Unsigned integer value of control or stream </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="gab524e64f4bbae826c27bf39d7f2d3c2e"></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::ghmWrite </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>elementName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>intValue</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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> + <tr><td class="paramdir">[in]</td><td class="paramname">intValue</td><td>signed integer value of control or stream </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="ga5eb797aba87a3ab76d742afe34292ee6"></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::ghmWrite </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a> * </td> + <td class="paramname"><em>elementArray</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Write stream or control data to <a href="http://goHACK.me">http://goHACK.me</a>. </p> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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> + </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> \ No newline at end of file