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__send__command.html
- Revision:
- 34:2616445d0823
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/mbed/html/group__api__core__send__command.html Wed Nov 26 23:46:00 2014 -0800 @@ -0,0 +1,983 @@ +<!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><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect 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__send__command.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Send Command Methods<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>API methods for sending commands to WiConnect WiFi module. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gadd23f2f86fcc0a438dad798ab3353505"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gadd23f2f86fcc0a438dad798ab3353505">wiconnect::Wiconnect::sendCommand</a> (const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, char *responseBuffer, int responseBufferLen, <a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *cmd, va_list vaList)</td></tr> +<tr class="memdesc:gadd23f2f86fcc0a438dad798ab3353505"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gadd23f2f86fcc0a438dad798ab3353505">More...</a><br /></td></tr> +<tr class="separator:gadd23f2f86fcc0a438dad798ab3353505"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa36b07b28a166fe51f9dc92bcab5d3d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaa36b07b28a166fe51f9dc92bcab5d3d8">wiconnect::Wiconnect::sendCommand</a> (char *responseBuffer, int responseBufferLen, <a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *cmd, va_list vaList)</td></tr> +<tr class="memdesc:gaa36b07b28a166fe51f9dc92bcab5d3d8"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gaa36b07b28a166fe51f9dc92bcab5d3d8">More...</a><br /></td></tr> +<tr class="separator:gaa36b07b28a166fe51f9dc92bcab5d3d8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabe0e5c170b9c6ec7d6dc96a3639c721e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gabe0e5c170b9c6ec7d6dc96a3639c721e">wiconnect::Wiconnect::sendCommand</a> (char *responseBuffer, int responseBufferLen, <a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *cmd,...)</td></tr> +<tr class="memdesc:gabe0e5c170b9c6ec7d6dc96a3639c721e"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gabe0e5c170b9c6ec7d6dc96a3639c721e">More...</a><br /></td></tr> +<tr class="separator:gabe0e5c170b9c6ec7d6dc96a3639c721e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8c6d84b338847fbdd41f61c5375117e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga8c6d84b338847fbdd41f61c5375117e9">wiconnect::Wiconnect::sendCommand</a> (<a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *cmd,...)</td></tr> +<tr class="memdesc:ga8c6d84b338847fbdd41f61c5375117e9"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#ga8c6d84b338847fbdd41f61c5375117e9">More...</a><br /></td></tr> +<tr class="separator:ga8c6d84b338847fbdd41f61c5375117e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaca2f1b17d2cc98cbc6dac219ffcf9e84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaca2f1b17d2cc98cbc6dac219ffcf9e84">wiconnect::Wiconnect::sendCommand</a> (const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *cmd,...)</td></tr> +<tr class="memdesc:gaca2f1b17d2cc98cbc6dac219ffcf9e84"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gaca2f1b17d2cc98cbc6dac219ffcf9e84">More...</a><br /></td></tr> +<tr class="separator:gaca2f1b17d2cc98cbc6dac219ffcf9e84"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5f437c3518de14706c6fcff32a0b0f97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga5f437c3518de14706c6fcff32a0b0f97">wiconnect::Wiconnect::sendCommand</a> (char *responseBuffer, int responseBufferLen, <a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const char *cmd,...)</td></tr> +<tr class="memdesc:ga5f437c3518de14706c6fcff32a0b0f97"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#ga5f437c3518de14706c6fcff32a0b0f97">More...</a><br /></td></tr> +<tr class="separator:ga5f437c3518de14706c6fcff32a0b0f97"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf93db1b2730bb586287f7756f3cdf092"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaf93db1b2730bb586287f7756f3cdf092">wiconnect::Wiconnect::sendCommand</a> (const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, char *responseBuffer, int responseBufferLen, const char *cmd,...)</td></tr> +<tr class="memdesc:gaf93db1b2730bb586287f7756f3cdf092"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gaf93db1b2730bb586287f7756f3cdf092">More...</a><br /></td></tr> +<tr class="separator:gaf93db1b2730bb586287f7756f3cdf092"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaac75ca154bd5d5a21c714dd828a92363"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaac75ca154bd5d5a21c714dd828a92363">wiconnect::Wiconnect::sendCommand</a> (char *responseBuffer, int responseBufferLen, const char *cmd,...)</td></tr> +<tr class="memdesc:gaac75ca154bd5d5a21c714dd828a92363"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gaac75ca154bd5d5a21c714dd828a92363">More...</a><br /></td></tr> +<tr class="separator:gaac75ca154bd5d5a21c714dd828a92363"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7eb983a196daa5de20a73fd234dc6f64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga7eb983a196daa5de20a73fd234dc6f64">wiconnect::Wiconnect::sendCommand</a> (const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, const char *cmd,...)</td></tr> +<tr class="memdesc:ga7eb983a196daa5de20a73fd234dc6f64"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#ga7eb983a196daa5de20a73fd234dc6f64">More...</a><br /></td></tr> +<tr class="separator:ga7eb983a196daa5de20a73fd234dc6f64"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadad1c5b3df07a24ab09492edf93dd1f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gadad1c5b3df07a24ab09492edf93dd1f4">wiconnect::Wiconnect::sendCommand</a> (const char *cmd,...)</td></tr> +<tr class="memdesc:gadad1c5b3df07a24ab09492edf93dd1f4"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#gadad1c5b3df07a24ab09492edf93dd1f4">More...</a><br /></td></tr> +<tr class="separator:gadad1c5b3df07a24ab09492edf93dd1f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9a89a0dd00f8eedb5e3eb8d4a4ed58df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga9a89a0dd00f8eedb5e3eb8d4a4ed58df">wiconnect::Wiconnect::sendCommand</a> (const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeCallback, <a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const char *cmd,...)</td></tr> +<tr class="separator:ga9a89a0dd00f8eedb5e3eb8d4a4ed58df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5666d99d72494995db0a812fcc9bbd09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga5666d99d72494995db0a812fcc9bbd09">wiconnect::Wiconnect::sendCommand</a> (<a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs, const char *cmd,...)</td></tr> +<tr class="memdesc:ga5666d99d72494995db0a812fcc9bbd09"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module. <a href="#ga5666d99d72494995db0a812fcc9bbd09">More...</a><br /></td></tr> +<tr class="separator:ga5666d99d72494995db0a812fcc9bbd09"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9d0ade0ec2866d7e0df5391bc69f5698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga9d0ade0ec2866d7e0df5391bc69f5698">wiconnect::Wiconnect::sendCommand</a> (const char *cmd, va_list vaList)</td></tr> +<tr class="separator:ga9d0ade0ec2866d7e0df5391bc69f5698"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf48c1ec0b92af2619ab846baaaa471cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">wiconnect::Wiconnect::checkCurrentCommand</a> ()</td></tr> +<tr class="memdesc:gaf48c1ec0b92af2619ab846baaaa471cd"><td class="mdescLeft"> </td><td class="mdescRight">Check the status of the currently executing command. <a href="#gaf48c1ec0b92af2619ab846baaaa471cd">More...</a><br /></td></tr> +<tr class="separator:gaf48c1ec0b92af2619ab846baaaa471cd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4a9bd29de1d5c496fbcc28ecfa51e7c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga4a9bd29de1d5c496fbcc28ecfa51e7c0">wiconnect::Wiconnect::stopCurrentCommand</a> ()</td></tr> +<tr class="memdesc:ga4a9bd29de1d5c496fbcc28ecfa51e7c0"><td class="mdescLeft"> </td><td class="mdescRight">Stop the currently executing command. <a href="#ga4a9bd29de1d5c496fbcc28ecfa51e7c0">More...</a><br /></td></tr> +<tr class="separator:ga4a9bd29de1d5c496fbcc28ecfa51e7c0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga423c201755b4bac9e069d4ab4c241d1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga423c201755b4bac9e069d4ab4c241d1a">wiconnect::Wiconnect::enqueueCommand</a> (<a class="el" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a> *command, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &commandCompleteHandler=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr> +<tr class="memdesc:ga423c201755b4bac9e069d4ab4c241d1a"><td class="mdescLeft"> </td><td class="mdescRight">Add user command to be executed asynchronously. <a href="#ga423c201755b4bac9e069d4ab4c241d1a">More...</a><br /></td></tr> +<tr class="separator:ga423c201755b4bac9e069d4ab4c241d1a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>API methods for sending commands to WiConnect WiFi module. </p> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="gaf48c1ec0b92af2619ab846baaaa471cd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::checkCurrentCommand </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check the status of the currently executing command. </p> +<p>Refer to <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> for more information about the return code.</p> +<dl class="section note"><dt>Note</dt><dd>This command is only applicable for non-blocking mode. Refer to <a class="el" href="index.html#setting_blocking_modes">Blocking / Non-blocking Modes</a>.</dd></dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga423c201755b4bac9e069d4ab4c241d1a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::enqueueCommand </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a> * </td> + <td class="paramname"><em>command</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td> + <td class="paramname"><em>commandCompleteHandler</em> = <code><a class="el" href="classwiconnect_1_1_callback.html">Callback</a>()</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Add user command to be executed asynchronously. </p> +<p>Refer to <a class="el" href="index.html#setting_async_processing">Asynchronous Processing</a> for more info.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>Pointer to <a class="el" href="classwiconnect_1_1_queued_command.html" title="Class which contains command for asynchronous processing. ">QueuedCommand</a> to be executed asynchronously </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">commandCompleteHandler</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> to be executed when processing is complete. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gadd23f2f86fcc0a438dad798ab3353505"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td> + <td class="paramname"><em>completeCallback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>responseBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>responseBufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> & </td> + <td class="paramname"><em>reader</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">va_list </td> + <td class="paramname"><em>vaList</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">completeCallback</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBuffer</td><td>Buffer to hold command response </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBufferLen</td><td>Length of responseBuffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">reader</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> for reading data to be read from host and send to module during command </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>User data struct used during read <a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a>. Library doesn't use this. Set NULL if not used. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">vaList</td><td>Varaible list of arguments </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gaa36b07b28a166fe51f9dc92bcab5d3d8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>responseBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>responseBufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> & </td> + <td class="paramname"><em>reader</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">va_list </td> + <td class="paramname"><em>vaList</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBuffer</td><td>Buffer to hold command response </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBufferLen</td><td>Length of responseBuffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">reader</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> for reading data to be read from host and send to module during command </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>User data struct used during read <a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a>. Library doesn't use this. Set NULL if not used. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">vaList</td><td>Varaible list of arguments </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gabe0e5c170b9c6ec7d6dc96a3639c721e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>responseBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>responseBufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> & </td> + <td class="paramname"><em>reader</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBuffer</td><td>Buffer to hold command response </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBufferLen</td><td>Length of responseBuffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">reader</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> for reading data to be read from host and send to module during command </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>User data struct used during read <a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a>. Library doesn't use this. Set NULL if not used. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga8c6d84b338847fbdd41f61c5375117e9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> & </td> + <td class="paramname"><em>reader</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<p>This method uses the library internal buffer.</p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">reader</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> for reading data to be read from host and send to module during command </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>User data struct used during read <a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a>. Library doesn't use this. Set NULL if not used. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gaca2f1b17d2cc98cbc6dac219ffcf9e84"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> & </td> + <td class="paramname"><em>reader</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<ul> +<li>This method uses the library internal buffer and</li> +<li>default timeout. See <a class="el" href="group__api__core__settings.html#gacae50138f9388a66496408f9c2bf6a6f" title="Sets the default maximum time an API method may execute before terminating and return a timeout error...">setCommandDefaultTimeout()</a></li> +</ul> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">reader</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> for reading data to be read from host and send to module during command </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">user</td><td>User data struct used during read <a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a>. Library doesn't use this. Set NULL if not used. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga5f437c3518de14706c6fcff32a0b0f97"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>responseBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>responseBufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBuffer</td><td>Buffer to hold command response </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBufferLen</td><td>Length of responseBuffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gaf93db1b2730bb586287f7756f3cdf092"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td> + <td class="paramname"><em>completeCallback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>responseBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>responseBufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">completeCallback</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBuffer</td><td>Buffer to hold command response </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBufferLen</td><td>Length of responseBuffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gaac75ca154bd5d5a21c714dd828a92363"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>responseBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>responseBufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBuffer</td><td>Buffer to hold command response </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">responseBufferLen</td><td>Length of responseBuffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga7eb983a196daa5de20a73fd234dc6f64"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td> + <td class="paramname"><em>completeCallback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<ul> +<li>This method uses the library internal buffer and</li> +<li>default timeout. See <a class="el" href="group__api__core__settings.html#gacae50138f9388a66496408f9c2bf6a6f" title="Sets the default maximum time an API method may execute before terminating and return a timeout error...">setCommandDefaultTimeout()</a></li> +</ul> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">completeCallback</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gadad1c5b3df07a24ab09492edf93dd1f4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<ul> +<li>This method uses the library internal buffer and</li> +<li>default timeout. See <a class="el" href="group__api__core__settings.html#gacae50138f9388a66496408f9c2bf6a6f" title="Sets the default maximum time an API method may execute before terminating and return a timeout error...">setCommandDefaultTimeout()</a></li> +</ul> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9a89a0dd00f8eedb5e3eb8d4a4ed58df"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> & </td> + <td class="paramname"><em>completeCallback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>This method uses the library internal buffer</p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">completeCallback</td><td><a class="el" href="classwiconnect_1_1_callback.html" title="Generic callback function. ">Callback</a> when command completes. arg1 of callback contains responseBuffer pointer, arg2 contains the response length </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga5666d99d72494995db0a812fcc9bbd09"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td> + <td class="paramname"><em>timeoutMs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Send command to WiConnect WiFi module. </p> +<p>This method uses the library internal buffer</p> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info </dd> +<dd> +This method supports variable arguments</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Maximum time in milliseconds this command should execute </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga9d0ade0ec2866d7e0df5391bc69f5698"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::Wiconnect::sendCommand </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>cmd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">va_list </td> + <td class="paramname"><em>vaList</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<ul> +<li>This method uses the library internal buffer and</li> +<li>default timeout. See <a class="el" href="group__api__core__settings.html#gacae50138f9388a66496408f9c2bf6a6f" title="Sets the default maximum time an API method may execute before terminating and return a timeout error...">setCommandDefaultTimeout()</a></li> +</ul> +<dl class="section note"><dt>Note</dt><dd>Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info</dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>WiConnect command to send to module </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">vaList</td><td>Varaible list of arguments </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga4a9bd29de1d5c496fbcc28ecfa51e7c0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void wiconnect::Wiconnect::stopCurrentCommand </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Stop the currently executing command. </p> +<dl class="section note"><dt>Note</dt><dd>This command is only applicable for non-blocking mode. Refer to <a class="el" href="index.html#setting_blocking_modes">Blocking / Non-blocking Modes</a>. </dd></dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">© ACKme Networks 2014</li> + </ul> +</div> +</body> +</html> \ No newline at end of file