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/_ghm_interface_8h_source.html@34:2616445d0823, 2014-11-26 (annotated)

Committer:
dan_ackme
Date:
Wed Nov 26 23:46:00 2014 -0800
Revision:
34:2616445d0823
Child:
39:a963f69cb2de
added support for out-dated wifi firmware

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('_ghm_interface_8h_source.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="headertitle">
dan_ackme 34:2616445d0823 102 <div class="title">GhmInterface.h</div> </div>
dan_ackme 34:2616445d0823 103 </div><!--header-->
dan_ackme 34:2616445d0823 104 <div class="contents">
dan_ackme 34:2616445d0823 105 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 34:2616445d0823 106 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 34:2616445d0823 107 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
dan_ackme 34:2616445d0823 108 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;Wiconnect.h&quot;</span></div>
dan_ackme 34:2616445d0823 109 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
dan_ackme 34:2616445d0823 110 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;api/types/WiconnectSocket.h&quot;</span></div>
dan_ackme 34:2616445d0823 111 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;api/types/GhmMessageList.h&quot;</span></div>
dan_ackme 34:2616445d0823 112 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
dan_ackme 34:2616445d0823 113 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">namespace </span>wiconnect {</div>
dan_ackme 34:2616445d0823 114 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
dan_ackme 34:2616445d0823 115 <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__api__ghm__macro.html#ga44f544c4ecf31c39907fc256ea16e86a"> 45</a></span>&#160;<span class="preprocessor">#define GHM_ADD_INT(array, name, integerVal) \</span></div>
dan_ackme 34:2616445d0823 116 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">{ \</span></div>
dan_ackme 34:2616445d0823 117 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"> array.elementName = name; \</span></div>
dan_ackme 34:2616445d0823 118 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"> array.type = GHM_VALUE_INT; \</span></div>
dan_ackme 34:2616445d0823 119 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor"> array.u.intValue = (uint32_t)integerVal; \</span></div>
dan_ackme 34:2616445d0823 120 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">}</span></div>
dan_ackme 34:2616445d0823 121 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
dan_ackme 34:2616445d0823 122 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
dan_ackme 34:2616445d0823 123 <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__api__ghm__macro.html#gaab18c9d71474abbd98b34982644e8069"> 57</a></span>&#160;<span class="preprocessor">#define GHM_ADD_STR(array, name, stringVal) \</span></div>
dan_ackme 34:2616445d0823 124 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">{ \</span></div>
dan_ackme 34:2616445d0823 125 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor"> array.elementName = name; \</span></div>
dan_ackme 34:2616445d0823 126 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor"> array.type = GHM_VALUE_STR; \</span></div>
dan_ackme 34:2616445d0823 127 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor"> array.u.strValue = (const char*)stringVal; \</span></div>
dan_ackme 34:2616445d0823 128 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">}</span></div>
dan_ackme 34:2616445d0823 129 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
dan_ackme 34:2616445d0823 130 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
dan_ackme 34:2616445d0823 131 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
dan_ackme 34:2616445d0823 132 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
dan_ackme 34:2616445d0823 133 <div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_ghm_interface.html"> 81</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_ghm_interface.html">GhmInterface</a></div>
dan_ackme 34:2616445d0823 134 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;{</div>
dan_ackme 34:2616445d0823 135 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 34:2616445d0823 136 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
dan_ackme 34:2616445d0823 137 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__activate.html#gaff03ecaa08146e6925820209cdab56bd">ghmDownloadCapabilities</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *capsNameOrCustomUrl = NULL, uint32_t version = 0);</div>
dan_ackme 34:2616445d0823 138 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
dan_ackme 34:2616445d0823 139 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *userName, <span class="keyword">const</span> <span class="keywordtype">char</span> *password, <span class="keyword">const</span> <span class="keywordtype">char</span> *capsFilename = NULL);</div>
dan_ackme 34:2616445d0823 140 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
dan_ackme 34:2616445d0823 141 <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__activate.html#gad0e0484d1f9a6608475874544f96708b">ghmDeactivate</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *userName, <span class="keyword">const</span> <span class="keywordtype">char</span> *password);</div>
dan_ackme 34:2616445d0823 142 <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div>
dan_ackme 34:2616445d0823 143 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">ghmIsActivated</a>(<span class="keywordtype">bool</span> *statusPtr);</div>
dan_ackme 34:2616445d0823 144 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div>
dan_ackme 34:2616445d0823 145 <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div>
dan_ackme 34:2616445d0823 146 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 147 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;</div>
dan_ackme 34:2616445d0823 148 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div>
dan_ackme 34:2616445d0823 149 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga3fde7b34da992719b41fc52178b73bc2">ghmRead</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *controlName, <span class="keyword">const</span> <span class="keywordtype">char</span> **valueStrPtr);</div>
dan_ackme 34:2616445d0823 150 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;</div>
dan_ackme 34:2616445d0823 151 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga3fde7b34da992719b41fc52178b73bc2">ghmRead</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *controlName, uint32_t *valueIntPtr);</div>
dan_ackme 34:2616445d0823 152 <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;</div>
dan_ackme 34:2616445d0823 153 <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga3fde7b34da992719b41fc52178b73bc2">ghmRead</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *controlName, <span class="keywordtype">char</span> *valueBuffer, uint16_t valueBufferLen);</div>
dan_ackme 34:2616445d0823 154 <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;</div>
dan_ackme 34:2616445d0823 155 <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">ghmWrite</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *elementName, <span class="keyword">const</span> <span class="keywordtype">char</span> *strValue);</div>
dan_ackme 34:2616445d0823 156 <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;</div>
dan_ackme 34:2616445d0823 157 <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">ghmWrite</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *elementName, uint32_t uintValue);</div>
dan_ackme 34:2616445d0823 158 <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;</div>
dan_ackme 34:2616445d0823 159 <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">ghmWrite</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *elementName, int32_t intValue);</div>
dan_ackme 34:2616445d0823 160 <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;</div>
dan_ackme 34:2616445d0823 161 <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">ghmWrite</a>(<span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a> *elementArray);</div>
dan_ackme 34:2616445d0823 162 <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;</div>
dan_ackme 34:2616445d0823 163 <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__com.html#ga0aa48506edb22c90be513683672b96c7">ghmSynchronize</a>(<a class="code" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> type = <a class="code" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">GHM_SYNC_ALL</a>);</div>
dan_ackme 34:2616445d0823 164 <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;</div>
dan_ackme 34:2616445d0823 165 <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;</div>
dan_ackme 34:2616445d0823 166 <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 34:2616445d0823 167 <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;</div>
dan_ackme 34:2616445d0823 168 <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;</div>
dan_ackme 34:2616445d0823 169 <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#gadc281f497041b26a151c72a0b5d03543">ghmPostMessage</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, <span class="keywordtype">bool</span> jsonFormatted=<span class="keyword">false</span>);</div>
dan_ackme 34:2616445d0823 170 <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;</div>
dan_ackme 34:2616445d0823 171 <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">ghmGetMessage</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, <a class="code" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType = <a class="code" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>);</div>
dan_ackme 34:2616445d0823 172 <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;</div>
dan_ackme 34:2616445d0823 173 <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">ghmGetMessage</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint8_t listIndex, <a class="code" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType = <a class="code" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>);</div>
dan_ackme 34:2616445d0823 174 <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;</div>
dan_ackme 34:2616445d0823 175 <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">ghmGetMessage</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *msgId, <a class="code" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType = <a class="code" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>);</div>
dan_ackme 34:2616445d0823 176 <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;</div>
dan_ackme 34:2616445d0823 177 <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">ghmDeleteMessage</a>(uint8_t listIndex);</div>
dan_ackme 34:2616445d0823 178 <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;</div>
dan_ackme 34:2616445d0823 179 <div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">ghmDeleteMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *msgId);</div>
dan_ackme 34:2616445d0823 180 <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;</div>
dan_ackme 34:2616445d0823 181 <div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">ghmListMessages</a>(<a class="code" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a> &amp;msgList, uint8_t maxCount = 0);</div>
dan_ackme 34:2616445d0823 182 <div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;</div>
dan_ackme 34:2616445d0823 183 <div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;</div>
dan_ackme 34:2616445d0823 184 <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 34:2616445d0823 185 <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; <a class="code" href="classwiconnect_1_1_ghm_interface.html">GhmInterface</a>(<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect);</div>
dan_ackme 34:2616445d0823 186 <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;</div>
dan_ackme 34:2616445d0823 187 <div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">ghmGetMessage</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint8_t listIndex, <span class="keyword">const</span> <span class="keywordtype">char</span> *msgId, <a class="code" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType);</div>
dan_ackme 34:2616445d0823 188 <div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> processMessageList(<span class="keywordtype">char</span> *resultStr, <a class="code" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a> &amp;resultList);</div>
dan_ackme 34:2616445d0823 189 <div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;</div>
dan_ackme 34:2616445d0823 190 <div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="keyword">private</span>:</div>
dan_ackme 34:2616445d0823 191 <div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
dan_ackme 34:2616445d0823 192 <div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;</div>
dan_ackme 34:2616445d0823 193 <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;};</div>
dan_ackme 34:2616445d0823 194 <div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;</div>
dan_ackme 34:2616445d0823 195 <div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;</div>
dan_ackme 34:2616445d0823 196 <div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;}</div>
dan_ackme 34:2616445d0823 197 <div class="ttc" id="group__api__ghm__activate_html_gad0e0484d1f9a6608475874544f96708b"><div class="ttname"><a href="group__api__ghm__activate.html#gad0e0484d1f9a6608475874544f96708b">wiconnect::GhmInterface::ghmDeactivate</a></div><div class="ttdeci">WiconnectResult ghmDeactivate(const char *userName, const char *password)</div><div class="ttdoc">Deactivate WiFi module with http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 198 <div class="ttc" id="group__api__ghm__msg_html_gae69971594793e1a10f11a51277909502"><div class="ttname"><a href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">wiconnect::GhmInterface::ghmListMessages</a></div><div class="ttdeci">WiconnectResult ghmListMessages(GhmMessageList &amp;msgList, uint8_t maxCount=0)</div><div class="ttdoc">List available messages for device on http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 199 <div class="ttc" id="group__api__ghm__types_html_gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7"><div class="ttname"><a href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">wiconnect::GHM_SYNC_ALL</a></div><div class="ttdoc">Push and pull all streams and controls. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00464">WiconnectTypes.h:464</a></div></div>
dan_ackme 34:2616445d0823 200 <div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00166">WiconnectTypes.h:166</a></div></div>
dan_ackme 34:2616445d0823 201 <div class="ttc" id="group__api__ghm__activate_html_ga8bec70f780ca7de9dce1a15830c179ff"><div class="ttname"><a href="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">wiconnect::GhmInterface::ghmIsActivated</a></div><div class="ttdeci">WiconnectResult ghmIsActivated(bool *statusPtr)</div><div class="ttdoc">Return if WiFi module is activated with http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 202 <div class="ttc" id="group__api__ghm__msg_html_ga451de9d69f7ecbf38e36056e502b94b0"><div class="ttname"><a href="group__api__ghm__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">wiconnect::GhmInterface::ghmDeleteMessage</a></div><div class="ttdeci">WiconnectResult ghmDeleteMessage(uint8_t listIndex)</div><div class="ttdoc">Delete message from http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 203 <div class="ttc" id="group__api__ghm__com_html_ga2f57fc33ad0e71d608b1350d4e3ab223"><div class="ttname"><a href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">wiconnect::GhmInterface::ghmWrite</a></div><div class="ttdeci">WiconnectResult ghmWrite(const char *elementName, const char *strValue)</div><div class="ttdoc">Write stream or control data to http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 204 <div class="ttc" id="group__api__ghm__msg_html_gadc281f497041b26a151c72a0b5d03543"><div class="ttname"><a href="group__api__ghm__msg.html#gadc281f497041b26a151c72a0b5d03543">wiconnect::GhmInterface::ghmPostMessage</a></div><div class="ttdeci">WiconnectResult ghmPostMessage(WiconnectSocket &amp;socket, bool jsonFormatted=false)</div><div class="ttdoc">POST message to http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 205 <div class="ttc" id="group__api__ghm__types_html_gaf75750bfef61c73f9e4677e9de663df1"><div class="ttname"><a href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">wiconnect::GhmMessageGetType</a></div><div class="ttdeci">GhmMessageGetType</div><div class="ttdoc">goHACK.me message GET type </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00473">WiconnectTypes.h:473</a></div></div>
dan_ackme 34:2616445d0823 206 <div class="ttc" id="classwiconnect_1_1_ghm_message_list_html"><div class="ttname"><a href="classwiconnect_1_1_ghm_message_list.html">wiconnect::GhmMessageList</a></div><div class="ttdoc">List of goHACK.me messages. </div><div class="ttdef"><b>Definition:</b> <a href="_ghm_message_list_8h_source.html#l00046">GhmMessageList.h:46</a></div></div>
dan_ackme 34:2616445d0823 207 <div class="ttc" id="classwiconnect_1_1_ghm_interface_html"><div class="ttname"><a href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></div><div class="ttdoc">The provides an interface for http://goHACK.me. </div><div class="ttdef"><b>Definition:</b> <a href="_ghm_interface_8h_source.html#l00081">GhmInterface.h:81</a></div></div>
dan_ackme 34:2616445d0823 208 <div class="ttc" id="group__api__ghm__types_html_ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127"><div class="ttname"><a href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">wiconnect::GHM_MSG_GET_DATA_ONLY</a></div><div class="ttdoc">Only GET the message data. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00475">WiconnectTypes.h:475</a></div></div>
dan_ackme 34:2616445d0823 209 <div class="ttc" id="group__api__ghm__types_html_ga44ea17651dcf42ac9816f549beb577ac"><div class="ttname"><a href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">wiconnect::GhmSyncType</a></div><div class="ttdeci">GhmSyncType</div><div class="ttdoc">goHACK.me sychronization type </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00462">WiconnectTypes.h:462</a></div></div>
dan_ackme 34:2616445d0823 210 <div class="ttc" id="group__api__ghm__activate_html_gaa0213731eebd4a14e9099d01ff76beff"><div class="ttname"><a href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">wiconnect::GhmInterface::ghmActivate</a></div><div class="ttdeci">WiconnectResult ghmActivate(const char *userName, const char *password, const char *capsFilename=NULL)</div><div class="ttdoc">Activate WiFi module with http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 211 <div class="ttc" id="group__api__ghm__activate_html_gaff03ecaa08146e6925820209cdab56bd"><div class="ttname"><a href="group__api__ghm__activate.html#gaff03ecaa08146e6925820209cdab56bd">wiconnect::GhmInterface::ghmDownloadCapabilities</a></div><div class="ttdeci">WiconnectResult ghmDownloadCapabilities(const char *capsNameOrCustomUrl=NULL, uint32_t version=0)</div><div class="ttdoc">Download a device capabilities file to WiFi module&#39;s internal file system. </div></div>
dan_ackme 34:2616445d0823 212 <div class="ttc" id="group__api__ghm__com_html_ga3fde7b34da992719b41fc52178b73bc2"><div class="ttname"><a href="group__api__ghm__com.html#ga3fde7b34da992719b41fc52178b73bc2">wiconnect::GhmInterface::ghmRead</a></div><div class="ttdeci">WiconnectResult ghmRead(const char *controlName, const char **valueStrPtr)</div><div class="ttdoc">Read control data from http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 213 <div class="ttc" id="classwiconnect_1_1_wiconnect_socket_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect_socket.html">wiconnect::WiconnectSocket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_socket_8h_source.html#l00043">WiconnectSocket.h:43</a></div></div>
dan_ackme 34:2616445d0823 214 <div class="ttc" id="group__api__ghm__com_html_ga0aa48506edb22c90be513683672b96c7"><div class="ttname"><a href="group__api__ghm__com.html#ga0aa48506edb22c90be513683672b96c7">wiconnect::GhmInterface::ghmSynchronize</a></div><div class="ttdeci">WiconnectResult ghmSynchronize(GhmSyncType type=GHM_SYNC_ALL)</div><div class="ttdoc">Synchronize WiFi module with http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 215 <div class="ttc" id="group__api__ghm__msg_html_gaaa05391432b2ca38bb416c671f57b234"><div class="ttname"><a href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">wiconnect::GhmInterface::ghmGetMessage</a></div><div class="ttdeci">WiconnectResult ghmGetMessage(WiconnectSocket &amp;socket, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)</div><div class="ttdoc">GET message from http://goHACK.me. </div></div>
dan_ackme 34:2616445d0823 216 <div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00078">WiconnectInterface.h:78</a></div></div>
dan_ackme 34:2616445d0823 217 <div class="ttc" id="structwiconnect_1_1_ghm_element_array_html"><div class="ttname"><a href="structwiconnect_1_1_ghm_element_array.html">wiconnect::GhmElementArray</a></div><div class="ttdoc">Array of goHACK.me stream or control values. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00452">WiconnectTypes.h:452</a></div></div>
dan_ackme 34:2616445d0823 218 </div><!-- fragment --></div><!-- contents -->
dan_ackme 34:2616445d0823 219 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 220 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 221 <ul>
dan_ackme 34:2616445d0823 222 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 223 </ul>
dan_ackme 34:2616445d0823 224 </div>
dan_ackme 34:2616445d0823 225 </body>
dan_ackme 34:2616445d0823 226 </html>