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

Diff: doc/mbed/html/group__api__core__macro.html

Revision:
34:2616445d0823
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/mbed/html/group__api__core__macro.html	Wed Nov 26 23:46:00 2014 -0800
@@ -0,0 +1,256 @@
+<!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>&nbsp;</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>&nbsp;</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&#160;Overview</span></a></li>
+      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
+      <li><a href="examples.html"><span>API&#160;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&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
+      <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <img id="MSearchSelect" src="search/mag_sel.png"
+               onmouseover="return searchBox.OnSearchSelectShow()"
+               onmouseout="return searchBox.OnSearchSelectHide()"
+               alt=""/>
+          <input type="text" id="MSearchField" value="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+          </span>
+        </div>
+      </li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('group__api__core__macro.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">&#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>
+
+<!-- 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="#define-members">Macros</a>  </div>
+  <div class="headertitle">
+<div class="title">Macros<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Core macros.  
+<a href="#details">More...</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
+Macros</h2></td></tr>
+<tr class="memitem:ga74e75242132eaabbc1c512488a135926"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga74e75242132eaabbc1c512488a135926"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga74e75242132eaabbc1c512488a135926">MIN</a>(x, y)&#160;&#160;&#160;((x) &lt; (y) ? (x) : (y))</td></tr>
+<tr class="memdesc:ga74e75242132eaabbc1c512488a135926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the minimum of <em>x</em> and <em>y</em>. <br /></td></tr>
+<tr class="separator:ga74e75242132eaabbc1c512488a135926"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaacc3ee1a7f283f8ef65cea31f4436a95"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaacc3ee1a7f283f8ef65cea31f4436a95"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaacc3ee1a7f283f8ef65cea31f4436a95">MAX</a>(x, y)&#160;&#160;&#160;((x) &gt; (y) ? (x) : (y))</td></tr>
+<tr class="memdesc:gaacc3ee1a7f283f8ef65cea31f4436a95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the maximum of <em>x</em> and <em>y</em>. <br /></td></tr>
+<tr class="separator:gaacc3ee1a7f283f8ef65cea31f4436a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga346c951fa5af23cdbf1d18a59b2babd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga346c951fa5af23cdbf1d18a59b2babd1"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga346c951fa5af23cdbf1d18a59b2babd1">ALIGN_n</a>(x, n)&#160;&#160;&#160;((((uint32_t)x) + ((n)-1)) &amp; ~((n)-1))</td></tr>
+<tr class="memdesc:ga346c951fa5af23cdbf1d18a59b2babd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Align <em>x</em> to <em>n</em> bytes (<em>n</em> must be power of 2) <br /></td></tr>
+<tr class="separator:ga346c951fa5af23cdbf1d18a59b2babd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gad7bc04eee187f219f2544905267568b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad7bc04eee187f219f2544905267568b0"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gad7bc04eee187f219f2544905267568b0">ALIGN_8</a>(x)&#160;&#160;&#160;<a class="el" href="group__api__core__macro.html#ga346c951fa5af23cdbf1d18a59b2babd1">ALIGN_n</a>(x, 8)</td></tr>
+<tr class="memdesc:gad7bc04eee187f219f2544905267568b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Align <em>x</em> to 8 bytes. <br /></td></tr>
+<tr class="separator:gad7bc04eee187f219f2544905267568b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga8d334bd237af6b4e1eb929ef32b33ab0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8d334bd237af6b4e1eb929ef32b33ab0"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga8d334bd237af6b4e1eb929ef32b33ab0">ALIGN_4</a>(x)&#160;&#160;&#160;<a class="el" href="group__api__core__macro.html#ga346c951fa5af23cdbf1d18a59b2babd1">ALIGN_n</a>(x, 4)</td></tr>
+<tr class="memdesc:ga8d334bd237af6b4e1eb929ef32b33ab0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Align <em>x</em> to 4 bytes. <br /></td></tr>
+<tr class="separator:ga8d334bd237af6b4e1eb929ef32b33ab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga77baa56c8d3584b953f0a2626e6844ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga77baa56c8d3584b953f0a2626e6844ad"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga77baa56c8d3584b953f0a2626e6844ad">ARRAY_COUNT</a>(x)&#160;&#160;&#160;(sizeof (x) / sizeof *(x))</td></tr>
+<tr class="memdesc:ga77baa56c8d3584b953f0a2626e6844ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return number of elements in static array <em>x</em>. <br /></td></tr>
+<tr class="separator:ga77baa56c8d3584b953f0a2626e6844ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gab27aa3ef76302b5221766abfd4f47e64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab27aa3ef76302b5221766abfd4f47e64"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a>(result, func)&#160;&#160;&#160;((int)(result = (func)) &lt; (int)<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a>)</td></tr>
+<tr class="memdesc:gab27aa3ef76302b5221766abfd4f47e64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value contains error. <br /></td></tr>
+<tr class="separator:gab27aa3ef76302b5221766abfd4f47e64"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabb158b483cd6d8a8d2d4bf8d38bc9830"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gabb158b483cd6d8a8d2d4bf8d38bc9830">WICONNECT_SUCCEEDED</a>(result, func)&#160;&#160;&#160;((result = (func)) == <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a>)</td></tr>
+<tr class="memdesc:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value is WICONNECT_SUCCESS. <br /></td></tr>
+<tr class="separator:gabb158b483cd6d8a8d2d4bf8d38bc9830"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga436d782bd2cdce3696eadda1083416af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga436d782bd2cdce3696eadda1083416af"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga436d782bd2cdce3696eadda1083416af">WICONNECT_IS_PROCESSING</a>(result, func)&#160;&#160;&#160;((result = (func)) == <a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">wiconnect::WICONNECT_PROCESSING</a>)</td></tr>
+<tr class="memdesc:ga436d782bd2cdce3696eadda1083416af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populates <em>result</em> with return value from <em>func</em>, returns TRUE if return value is WICONNECT_PROCESSING. <br /></td></tr>
+<tr class="separator:ga436d782bd2cdce3696eadda1083416af"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2aa16118029ab13ab41514cb8eb93ba7"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga2aa16118029ab13ab41514cb8eb93ba7">WICONNECT_MAX_CMD_SIZE</a>&#160;&#160;&#160;128</td></tr>
+<tr class="memdesc:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum command size that may be sent to the WiConnect WiFi module. <br /></td></tr>
+<tr class="separator:ga2aa16118029ab13ab41514cb8eb93ba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga1525d7c98c2da34fc1a64de49253abdb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1525d7c98c2da34fc1a64de49253abdb"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga1525d7c98c2da34fc1a64de49253abdb">WICONNECT_MAX_VERSION_SIZE</a>&#160;&#160;&#160;96</td></tr>
+<tr class="memdesc:ga1525d7c98c2da34fc1a64de49253abdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum WiConnect WiFi module version string size. <br /></td></tr>
+<tr class="separator:ga1525d7c98c2da34fc1a64de49253abdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga45fe565132845ca570ded816f25561b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga45fe565132845ca570ded816f25561b0"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga45fe565132845ca570ded816f25561b0">WICONNECT_MAX_SOCKETS</a>&#160;&#160;&#160;8</td></tr>
+<tr class="memdesc:ga45fe565132845ca570ded816f25561b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of simulanteous opened sockets. <br /></td></tr>
+<tr class="separator:ga45fe565132845ca570ded816f25561b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7c5dcedd35669199b46bb292b3d3b525"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7c5dcedd35669199b46bb292b3d3b525"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga7c5dcedd35669199b46bb292b3d3b525">WICONNECT_MAX_HOST_SIZE</a>&#160;&#160;&#160;64</td></tr>
+<tr class="memdesc:ga7c5dcedd35669199b46bb292b3d3b525"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum server string length. <br /></td></tr>
+<tr class="separator:ga7c5dcedd35669199b46bb292b3d3b525"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga8bc3b8d2e7e7c9d10b23e0a15cd4507a">WICONNECT_MAX_FILENAME_SIZE</a>&#160;&#160;&#160;96</td></tr>
+<tr class="memdesc:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum Wiconnect Module flash filesystem filename length. <br /></td></tr>
+<tr class="separator:ga8bc3b8d2e7e7c9d10b23e0a15cd4507a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga580e5f45fee866c845e0d3fd1eb1744a"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>&#160;&#160;&#160;0xFFFFFFFFUL</td></tr>
+<tr class="memdesc:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Never timeout. <br /></td></tr>
+<tr class="separator:ga580e5f45fee866c845e0d3fd1eb1744a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga12620767dcf50182fb9f72fe5d995301"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga12620767dcf50182fb9f72fe5d995301"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga12620767dcf50182fb9f72fe5d995301">WICONNECT_NO_WAIT</a>&#160;&#160;&#160;0</td></tr>
+<tr class="memdesc:ga12620767dcf50182fb9f72fe5d995301"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout immediately. <br /></td></tr>
+<tr class="separator:ga12620767dcf50182fb9f72fe5d995301"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga6d336ec791dcd22238d2fc4995fb9431"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6d336ec791dcd22238d2fc4995fb9431"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga6d336ec791dcd22238d2fc4995fb9431">WICONNECT_FIRMWARE_UPDATE_TIMEOUT</a>&#160;&#160;&#160;90000UL</td></tr>
+<tr class="memdesc:ga6d336ec791dcd22238d2fc4995fb9431"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default firmware update timeout in ms. <br /></td></tr>
+<tr class="separator:ga6d336ec791dcd22238d2fc4995fb9431"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2e7c7d657cf5debc8b385206c13a1c0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2e7c7d657cf5debc8b385206c13a1c0d"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga2e7c7d657cf5debc8b385206c13a1c0d">WICONNECT_MINIMUM_VERSION</a>&#160;&#160;&#160;<a class="el" href="group__api__file__macro.html#gac39210b86d0465e494a6d0d56cf8dd05">FILE_MAKE_VERSION</a>(2, 0, 0, 11)</td></tr>
+<tr class="memdesc:ga2e7c7d657cf5debc8b385206c13a1c0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the minimum supported WiConnect version. If your WiFi module's firmware is out-dated, use the updateFirmware() API call to update your module's firmware. <br /></td></tr>
+<tr class="separator:ga2e7c7d657cf5debc8b385206c13a1c0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gad466ede4f07512308e38402d777d8380"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad466ede4f07512308e38402d777d8380"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gad466ede4f07512308e38402d777d8380">WICONNECT_ASYNC_TIMER_ENABLED</a></td></tr>
+<tr class="memdesc:gad466ede4f07512308e38402d777d8380"><td class="mdescLeft">&#160;</td><td class="mdescRight">When defined enables asynchronous command processing. <br /></td></tr>
+<tr class="separator:gad466ede4f07512308e38402d777d8380"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gae9cf1249b46e784aa05250e2bcbe2e02"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9cf1249b46e784aa05250e2bcbe2e02"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gae9cf1249b46e784aa05250e2bcbe2e02">WICONNECT_ENABLE_MALLOC</a></td></tr>
+<tr class="memdesc:gae9cf1249b46e784aa05250e2bcbe2e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">When defined enables user supplied dynamic memory allocation. <br /></td></tr>
+<tr class="separator:gae9cf1249b46e784aa05250e2bcbe2e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga53fde64c3e7647a192281a015cd02f48"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga53fde64c3e7647a192281a015cd02f48"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga53fde64c3e7647a192281a015cd02f48">WICONNECT_SERIAL_RX_BUFFER</a></td></tr>
+<tr class="memdesc:ga53fde64c3e7647a192281a015cd02f48"><td class="mdescLeft">&#160;</td><td class="mdescRight">When defined enables Host&lt;-&gt;Wiconnect Module serial RX buffering. <br /></td></tr>
+<tr class="separator:ga53fde64c3e7647a192281a015cd02f48"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gae7b6cfdff3a9aef465d5c4434937417d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae7b6cfdff3a9aef465d5c4434937417d"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gae7b6cfdff3a9aef465d5c4434937417d">WICONNECT_USE_DEFAULT_STRING_BUFFERS</a></td></tr>
+<tr class="memdesc:gae7b6cfdff3a9aef465d5c4434937417d"><td class="mdescLeft">&#160;</td><td class="mdescRight">When defined enables certain conversion API functions to use a default buffer to store string. <br /></td></tr>
+<tr class="separator:gae7b6cfdff3a9aef465d5c4434937417d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga593c6629b59a853057cd6a5547ed3f4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga593c6629b59a853057cd6a5547ed3f4f"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga593c6629b59a853057cd6a5547ed3f4f">WICONNECT_GPIO_IRQ_ENABLED</a></td></tr>
+<tr class="memdesc:ga593c6629b59a853057cd6a5547ed3f4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">When defined enables external interrupts on specified gpios. <br /></td></tr>
+<tr class="separator:ga593c6629b59a853057cd6a5547ed3f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaff0108d684631b2bb88e1f6c255e9ac"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaaff0108d684631b2bb88e1f6c255e9ac">WICONNECT_DEFAULT_MALLOC</a>&#160;&#160;&#160;malloc</td></tr>
+<tr class="memdesc:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">When WICONNECT_ENABLE_MALLOC defined, this is the default malloc function. <br /></td></tr>
+<tr class="separator:gaaff0108d684631b2bb88e1f6c255e9ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga0a14e4bc7a0aed9311b552c0ee8fd7ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0a14e4bc7a0aed9311b552c0ee8fd7ef"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga0a14e4bc7a0aed9311b552c0ee8fd7ef">WICONNECT_DEFAULT_FREE</a>&#160;&#160;&#160;free</td></tr>
+<tr class="memdesc:ga0a14e4bc7a0aed9311b552c0ee8fd7ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">When WICONNECT_ENABLE_MALLOC defined, this is the default free function. <br /></td></tr>
+<tr class="separator:ga0a14e4bc7a0aed9311b552c0ee8fd7ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2e7ffaac225bc56852bb504f531aafa0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2e7ffaac225bc56852bb504f531aafa0"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga2e7ffaac225bc56852bb504f531aafa0">WICONNECT_DEFAULT_BAUD</a>&#160;&#160;&#160;115200</td></tr>
+<tr class="memdesc:ga2e7ffaac225bc56852bb504f531aafa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default Host&lt;-&gt;Wiconnect Module serial BAUD rate. <br /></td></tr>
+<tr class="separator:ga2e7ffaac225bc56852bb504f531aafa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7741b7a0fbbf9b7e47898b7d30e5e321"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7741b7a0fbbf9b7e47898b7d30e5e321"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga7741b7a0fbbf9b7e47898b7d30e5e321">WICONNECT_DEFAULT_TIMEOUT</a>&#160;&#160;&#160;3000</td></tr>
+<tr class="memdesc:ga7741b7a0fbbf9b7e47898b7d30e5e321"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default command timeout (i.e max command executing time) <br /></td></tr>
+<tr class="separator:ga7741b7a0fbbf9b7e47898b7d30e5e321"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7352d6662e438d0969593df9e657d43f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7352d6662e438d0969593df9e657d43f"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>&#160;&#160;&#160;8</td></tr>
+<tr class="memdesc:ga7352d6662e438d0969593df9e657d43f"><td class="mdescLeft">&#160;</td><td class="mdescRight">When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the max number of asynchronous commands that may be queued. <br /></td></tr>
+<tr class="separator:ga7352d6662e438d0969593df9e657d43f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga9e7032540d999edf0dbae31e51c85962"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e7032540d999edf0dbae31e51c85962"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga9e7032540d999edf0dbae31e51c85962">WICONNECT_DEFAULT_COMMAND_PROCESSING_PERIOD</a>&#160;&#160;&#160;50</td></tr>
+<tr class="memdesc:ga9e7032540d999edf0dbae31e51c85962"><td class="mdescLeft">&#160;</td><td class="mdescRight">When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the period in milliseconds commands should be processed. <br /></td></tr>
+<tr class="separator:ga9e7032540d999edf0dbae31e51c85962"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga347d0e1228e8174563c6bcf48de18401"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga347d0e1228e8174563c6bcf48de18401"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a>&#160;&#160;&#160;false</td></tr>
+<tr class="memdesc:ga347d0e1228e8174563c6bcf48de18401"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default blocking mode of the Library. <br /></td></tr>
+<tr class="separator:ga347d0e1228e8174563c6bcf48de18401"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga80e1660ca602aff9f95ccbb4822fad9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga80e1660ca602aff9f95ccbb4822fad9c"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga80e1660ca602aff9f95ccbb4822fad9c">WICONNECT_ENABLE_DEBUGGING</a></td></tr>
+<tr class="memdesc:ga80e1660ca602aff9f95ccbb4822fad9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">If defined, enables low-level debugging. <br /></td></tr>
+<tr class="separator:ga80e1660ca602aff9f95ccbb4822fad9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa1dbeca66111f3a22d0ee6b122d69270"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>&#160;&#160;&#160;NC</td></tr>
+<tr class="memdesc:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value for a pin, Not connected. <br /></td></tr>
+<tr class="separator:gaa1dbeca66111f3a22d0ee6b122d69270"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga596d1da2fb23f4e748c83d64a47e10b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga596d1da2fb23f4e748c83d64a47e10b3"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3">delayMs</a>(ms)&#160;&#160;&#160;wait_ms(ms)</td></tr>
+<tr class="memdesc:ga596d1da2fb23f4e748c83d64a47e10b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to stop processor for specified number of milliseconds. <br /></td></tr>
+<tr class="separator:ga596d1da2fb23f4e748c83d64a47e10b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<p>Core macros. </p>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">&copy; ACKme Networks 2014</li>
+  </ul>
+</div>
+</body>
+</html>
\ No newline at end of file