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

Revision:
39:a963f69cb2de
Parent:
34:2616445d0823
--- a/doc/mbed/html/_ghm_interface_8h_source.html	Thu Nov 27 10:27:18 2014 +0000
+++ b/doc/mbed/html/_ghm_interface_8h_source.html	Mon Feb 23 20:30:18 2015 -0800
@@ -196,17 +196,17 @@
 <div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160;}</div>
 <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>
 <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>
-<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>
+<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#l00465">WiconnectTypes.h:465</a></div></div>
 <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>
 <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>
 <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>
 <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>
 <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>
-<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>
+<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#l00474">WiconnectTypes.h:474</a></div></div>
 <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>
 <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>
-<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>
-<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>
+<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#l00476">WiconnectTypes.h:476</a></div></div>
+<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#l00463">WiconnectTypes.h:463</a></div></div>
 <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>
 <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>
 <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>
@@ -214,7 +214,7 @@
 <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>
 <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>
 <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>
-<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>
+<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#l00453">WiconnectTypes.h:453</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->