ACKme
Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/html/namespacewiconnect.html
- Committer:
- dan_ackme
- Date:
- 2014-10-27
- Revision:
- 29:b6af04b77a56
- Parent:
- 26:8067e3d463d3
File content as of revision 29:b6af04b77a56:
<!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('namespacewiconnect.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="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">wiconnect Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The entire <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library is contained within the 'wiconnect' namespace.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_callback.html">Callback</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic callback function. <a href="classwiconnect_1_1_callback.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file_interface.html">FileInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. <a href="classwiconnect_1_1_file_interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file_list.html">FileList</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect WiFi module file listing. <a href="classwiconnect_1_1_file_list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_function_pointer.html">FunctionPointer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic function pointer. <a href="classwiconnect_1_1_function_pointer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ghm_element.html">GhmElement</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me stream or control value <a href="structwiconnect_1_1_ghm_element.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Array of goHACK.me stream or control values. <a href="structwiconnect_1_1_ghm_element_array.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_interface.html">GhmInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for <a href="http://goHACK.me">http://goHACK.me</a>. <a href="classwiconnect_1_1_ghm_interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_message.html">GhmMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains single entry from goHACK.me message listing. <a href="classwiconnect_1_1_ghm_message.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List of goHACK.me messages. <a href="classwiconnect_1_1_ghm_message_list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct for hold HTTP socket configuration. <a href="structwiconnect_1_1_http_socket_args.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Logging callback function. <a href="classwiconnect_1_1_log_func.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Network MAC Address type. <a href="structwiconnect_1_1_mac_address.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for joining and/or creating a network. It provides other utilities such as scanning for networks, pinging a network, resolving a domain name to IP address. <a href="classwiconnect_1_1_network_interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class which contains command for asynchronous processing. <a href="classwiconnect_1_1_queued_command.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic data reading callback function. <a href="classwiconnect_1_1_reader_func.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_scan_result.html">ScanResult</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains single entry from WiFi scan results. <a href="classwiconnect_1_1_scan_result.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List of WiFi network scan results. <a href="classwiconnect_1_1_scan_result_list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_serial_config.html">SerialConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Host<-><a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. <a href="classwiconnect_1_1_serial_config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. <a href="classwiconnect_1_1_socket_interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Network SSID type. <a href="structwiconnect_1_1_ssid.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The root WiConnect library class. This class inheriets all WiConnect functionality. <a href="classwiconnect_1_1_wiconnect.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect WiFi module file object. <a href="classwiconnect_1_1_wiconnect_file.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Connection object to remote server. <a href="classwiconnect_1_1_wiconnect_socket.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UDP Server Listening socket. <a href="classwiconnect_1_1_wiconnect_udp_server.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aadd4d5e6774e21f382c20b594a644470"><td class="memItemLeft" align="right" valign="top">typedef int8_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacewiconnect.html#aadd4d5e6774e21f382c20b594a644470">PinToGpioMapper</a> )(<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> pin)</td></tr>
<tr class="memdesc:aadd4d5e6774e21f382c20b594a644470"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer for mapping from a host pin to a WiConnect Module GPIO. <a href="#aadd4d5e6774e21f382c20b594a644470">More...</a><br /></td></tr>
<tr class="separator:aadd4d5e6774e21f382c20b594a644470"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c27570b2913afc6339821df7c934810"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c27570b2913afc6339821df7c934810"></a>
typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a></td></tr>
<tr class="memdesc:a0c27570b2913afc6339821df7c934810"><td class="mdescLeft"> </td><td class="mdescRight">Timeout type. <br /></td></tr>
<tr class="separator:a0c27570b2913afc6339821df7c934810"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga04b095d2e2f32a3fd23e346a4be969d8"></a>
typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga04b095d2e2f32a3fd23e346a4be969d8">MacAddressStrBuffer</a> [18]</td></tr>
<tr class="memdesc:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold a MAC address string. <br /></td></tr>
<tr class="separator:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga38e0a82235258f96340b9ce2c6e1426c"></a>
typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga38e0a82235258f96340b9ce2c6e1426c">SsidStrBuffer</a> [129]</td></tr>
<tr class="memdesc:ga38e0a82235258f96340b9ce2c6e1426c"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold a SSID string. <br /></td></tr>
<tr class="separator:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa68646bb07ee9f174097b60ac7327342"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa68646bb07ee9f174097b60ac7327342"></a>
typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gaa68646bb07ee9f174097b60ac7327342">IpStrBuffer</a> [18]</td></tr>
<tr class="memdesc:gaa68646bb07ee9f174097b60ac7327342"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold an IP address string. <br /></td></tr>
<tr class="separator:gaa68646bb07ee9f174097b60ac7327342"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1cf4dfa71da0b0dc3dc707dacf56cc9c"></a>
typedef PinName </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a></td></tr>
<tr class="memdesc:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="mdescLeft"> </td><td class="mdescRight">Pin name on HOST. <br /></td></tr>
<tr class="separator:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> { <br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789">WICONNECT_ABORTED</a> = 3,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1">WICONNECT_IDLE</a> = 2,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">WICONNECT_PROCESSING</a> = 1,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a> = 0,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6">WICONNECT_ERROR</a> = -1,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff">WICONNECT_CMD_RESPONSE_ERROR</a> = -2,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5">WICONNECT_NULL_BUFFER</a> = -3,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43">WICONNECT_NOT_INITIALIZED</a> = -4,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f">WICONNECT_OVERFLOW</a> = -5,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac">WICONNECT_TIMEOUT</a> = -6,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5">WICONNECT_RESPONSE_PARSE_ERROR</a> = -8,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83">WICONNECT_ANOTHER_CMD_EXECUTING</a> = -9,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa">WICONNECT_BAD_ARG</a> = -10,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc">WICONNECT_UNSUPPORTED</a> = -11,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff">WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL</a> = -12,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">WICONNECT_DUPLICATE</a> = -13,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">WICONNECT_NOT_FOUND</a> = -14,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a">WICONNECT_PINNAME_TO_GPIO_NO_MAPPING</a> = -15,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2">WICONNECT_NOT_CONNECTED</a> = -16,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02">WICONNECT_UNDERFLOW</a> = -17,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e">WICONNECT_MONITOR_NOT_AVAILABLE</a> = -18,
<br />
  <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2">WICONNECT_NOT_OPENED_FOR_READING</a> = -19
<br />
}</td></tr>
<tr class="memdesc:ga325637ed501728bd6c8c7a7982b9ce05"><td class="mdescLeft"> </td><td class="mdescRight">API Result code. <a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">More...</a><br /></td></tr>
<tr class="separator:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> { <br />
  <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067">NETWORK_STATUS_DOWN</a>,
<br />
  <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c">NETWORK_STATUS_WIFI_ONLY</a>,
<br />
  <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46">NETWORK_STATUS_UP</a>,
<br />
  <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a2916360f96699b2bf42cf5e122562497">NETWORK_STATUS_JOINING</a>
<br />
}</td></tr>
<tr class="memdesc:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="mdescLeft"> </td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">More...</a><br /></td></tr>
<tr class="separator:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> { <br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da2ac6866940725552e31532002ef649a5">NETWORK_JOIN_RESULT_NONE</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451dabfbb179ad94f8d5a57a9da86de9c65a8">NETWORK_JOIN_RESULT_SUCCESS</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da60569216928bd30142e2e143eaf58475">NETWORK_JOIN_RESULT_JOINING</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451daea6aa0a779a2823eadafa82dda6b7304">NETWORK_JOIN_RESULT_NO_SSID</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da02f32115d4a39e6028e5ebb4944f0bec">NETWORK_JOIN_RESULT_NO_PASSWORD</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451dabb8da6425a24810668eade3488113957">NETWORK_JOIN_RESULT_BAD_SECURITY</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da5c790fb0440c39d95ec785e1c31c3cb2">NETWORK_JOIN_RESULT_NOT_FOUND</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da76b3ad647f00a3dc52e71e4ed670e7dc">NETWORK_JOIN_RESULT_FAILED</a>,
<br />
  <a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451daed880c261bae590a5f59aebb01b6912c">NETWORK_JOIN_RESULT_ABORTED</a>
<br />
}</td></tr>
<tr class="memdesc:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="mdescLeft"> </td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">More...</a><br /></td></tr>
<tr class="separator:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5aead2b4cca0122a60168e75ea41d36"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> { <br />
  <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385">NETWORK_RSSI_EXCELLENT</a> = 0,
<br />
  <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713">NETWORK_RSSI_VERY_GOOD</a> = 1,
<br />
  <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533">NETWORK_RSSI_GOOD</a> = 2,
<br />
  <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae">NETWORK_RSSI_POOR</a> = 3,
<br />
  <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa">NETWORK_RSSI_VERY_POOR</a> = 4,
<br />
  <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4">NETWORK_RSSI_UNKNOWN</a> = 5
<br />
}</td></tr>
<tr class="memdesc:gac5aead2b4cca0122a60168e75ea41d36"><td class="mdescLeft"> </td><td class="mdescRight">Network RSSI signal level. <a href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">More...</a><br /></td></tr>
<tr class="separator:gac5aead2b4cca0122a60168e75ea41d36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga026bd11cd5df47b7022362243e2d553f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga026bd11cd5df47b7022362243e2d553f"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> </td></tr>
<tr class="memdesc:ga026bd11cd5df47b7022362243e2d553f"><td class="mdescLeft"> </td><td class="mdescRight">Network security type. <br /></td></tr>
<tr class="separator:ga026bd11cd5df47b7022362243e2d553f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga69dc55558df4c81599c5fb3dff98756d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> { <br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da6469a1b9d8fa6448c0f6f13e0028a60e">SOCKET_TYPE_UNKNOWN</a>,
<br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756daece967eb28f8913c30bc70fa1e0e5ff9">SOCKET_TYPE_TCP</a>,
<br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da0c365c200e62d61bf22798c25ccb96b4">SOCKET_TYPE_TLS</a>,
<br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756dab1b41b1c4daf8d171414b68e9033cfbc">SOCKET_TYPE_UDP</a>,
<br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751">SOCKET_TYPE_HTTP</a>,
<br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da77625728d545a400e0eae1483225ff91">SOCKET_TYPE_UDPS</a>,
<br />
  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da94c82597ad724e81c0bace9ed64ebc5f">SOCKET_TYPE_GHM</a>
<br />
}</td></tr>
<tr class="memdesc:ga69dc55558df4c81599c5fb3dff98756d"><td class="mdescLeft"> </td><td class="mdescRight">Socket type. <a href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">More...</a><br /></td></tr>
<tr class="separator:ga69dc55558df4c81599c5fb3dff98756d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__types.html#gadc1d6e26d4138c536bd5dce7ed4569d6">HttpSocketType</a> { <br />
  <a class="el" href="group__api__socket__types.html#ggadc1d6e26d4138c536bd5dce7ed4569d6afc257aa28936e9fa8a332995b5449685">SOCKET_HTTP_GET</a>,
<br />
  <a class="el" href="group__api__socket__types.html#ggadc1d6e26d4138c536bd5dce7ed4569d6ab271a5cd1775076aeb8c25fc14da12cb">SOCKET_HTTP_POST</a>,
<br />
  <a class="el" href="group__api__socket__types.html#ggadc1d6e26d4138c536bd5dce7ed4569d6a6d256a218aac67dffe66ae6c49a61236">SOCKET_HTTP_HEAD</a>
<br />
}</td></tr>
<tr class="memdesc:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="mdescLeft"> </td><td class="mdescRight">HTTP Socket sub-type. <a href="group__api__socket__types.html#gadc1d6e26d4138c536bd5dce7ed4569d6">More...</a><br /></td></tr>
<tr class="separator:gadc1d6e26d4138c536bd5dce7ed4569d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafbe48908f5c190c3b0f272d3016e609e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> { <br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eac40bade251c1d671283d3ab2515725a6">FILE_FLAG_NONE</a> = 0,
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaff56da02ac3626bf5636e0aa6ffff78a">FILE_FLAG_VALID</a> = (1 << 0),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea94ddbab88df5f29013d5deb3f3d092c5">FILE_FLAG_EXECUTABLE</a> = (1 << 1),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea07f098f34c015d1c81d7592b476312e6">FILE_FLAG_ENCRYPTED</a> = (1 << 2),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaad3ddfddf9e28a26df73b689e0898df0">FILE_FLAG_INTERNAL</a> = (1 << 3),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaffe90e6784ad43acffbf823502a6a7bf">FILE_FLAG_BOOTABLE</a> = (1 << 4),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea3864357fd0b63b4cd6594d00c2194ca8">FILE_FLAG_USER</a> = (1 << 5),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609eaa74f44cd76d69e9f32d70a2b13c8c4e2">FILE_FLAG_ESSENTIAL</a> = (1 << 6),
<br />
  <a class="el" href="group__api__file__types.html#ggafbe48908f5c190c3b0f272d3016e609ea21f35fd8f0a4e38d91d5d1f5c5cc977f">FILE_FLAG_INVALID</a> = 0xFFFF
<br />
}</td></tr>
<tr class="memdesc:gafbe48908f5c190c3b0f272d3016e609e"><td class="mdescLeft"> </td><td class="mdescRight">File flags type. <a href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">More...</a><br /></td></tr>
<tr class="separator:gafbe48908f5c190c3b0f272d3016e609e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> { <br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63ac2bf941d4f7f23cabf7c781c5741dc04">FILE_TYPE_UPGRADE_APP</a> = 0x00,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63ad127cd0d4eeefee993a24b4d5095bfe7">FILE_TYPE_WIFI_FW</a> = 0x01,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a681a5a935adbd3aefdbb3639c36a4169">FILE_TYPE_REGULAR_APP</a> = 0x81,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a2271e7ab227bf95699c260a258902eeb">FILE_TYPE_USER_RANGE_START</a> = 150,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a2958dab5107b78cd1c14400770ab9b4e">FILE_TYPE_USER_RANGE_END</a> = 199,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63aaa4d15bf30361c1026fe15e029e9c3e2">FILE_TYPE_TEMPORY</a> = 0xF9,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a5df6fc01411942aabcf83731d0d02d52">FILE_TYPE_GPIO_CONFIG</a> = 0xFA,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a35624c078c19b7b632d832d15c0d1ef0">FILE_TYPE_COMMAND_HELP</a> = 0xFB,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a244c4ea312de84a2f4cabaff386fcffd">FILE_TYPE_SDC_CAPS</a> = 0xFC,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63afd6c376410552b54187a162e2c6fdad2">FILE_TYPE_SETUP_SCRIPT</a> = 0xFD,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a2508195aa2793d49c5c6a24879b52206">FILE_TYPE_MISC_FIX_LEN</a> = 0xFE,
<br />
  <a class="el" href="group__api__file__types.html#gga9919a4237eea2b0d1f27c16d64e62c63a077782e07756b6dc93f96e9a0cca5c9e">FILE_TYPE_UNKNOWN</a> = 0xFF
<br />
}</td></tr>
<tr class="memdesc:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="mdescLeft"> </td><td class="mdescRight">File type type. <a href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">More...</a><br /></td></tr>
<tr class="separator:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4174104f02851ee92e51846877706e67"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4174104f02851ee92e51846877706e67"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#ga4174104f02851ee92e51846877706e67">GhmElementValueType</a> </td></tr>
<tr class="memdesc:ga4174104f02851ee92e51846877706e67"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me stream or control value type <br /></td></tr>
<tr class="separator:ga4174104f02851ee92e51846877706e67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga44ea17651dcf42ac9816f549beb577ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> { <br />
  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">GHM_SYNC_ALL</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577acafcf2af6407845b24a3abac79587243e0">GHM_SYNC_PUSH_ONLY</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577acaad5fbcfa42d14a2662bc5a517c108bdd">GHM_SYNC_PULL_ONLY</a>
<br />
}</td></tr>
<tr class="memdesc:ga44ea17651dcf42ac9816f549beb577ac"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me sychronization type <a href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">More...</a><br /></td></tr>
<tr class="separator:ga44ea17651dcf42ac9816f549beb577ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf75750bfef61c73f9e4677e9de663df1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> { <br />
  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a19876ca1d097b96c48a1e8b54ee562d1">GHM_MSG_GET_BODY</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1adcf75ccabf6676b9b8f3050080f4bab7">GHM_MSG_GET_ALL</a>
<br />
}</td></tr>
<tr class="memdesc:gaf75750bfef61c73f9e4677e9de663df1"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me message GET type <a href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">More...</a><br /></td></tr>
<tr class="separator:gaf75750bfef61c73f9e4677e9de663df1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The entire <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library is contained within the 'wiconnect' namespace. </p>
<p>ACKme WiConnect Host Library is licensed under the BSD licence:</p>
<p>Copyright (c)2014 ACKme Networks. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
<ol type="1">
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
<li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li>
<li>The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.</li>
</ol>
<p>THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="aadd4d5e6774e21f382c20b594a644470"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int8_t(* wiconnect::PinToGpioMapper)(<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> pin)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function pointer for mapping from a host pin to a WiConnect Module GPIO. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>A host pin </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The corresponding WiConnect Module GPIO (which the given pin is physically connected). Return -1 if no mapping is available. </dd></dl>
<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00206">206</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
</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>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02