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/mbed/html/group__api__core__settings.html
- Committer:
- dan_ackme
- Date:
- 2014-11-26
- Revision:
- 34:2616445d0823
- Child:
- 39:a963f69cb2de
File content as of revision 34:2616445d0823:
<!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__settings.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">Settings Methods<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>API getters/setters for core library settings.
<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:gace51a2841415a53f54fcce336182f0ec"><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__settings.html#gace51a2841415a53f54fcce336182f0ec">wiconnect::Wiconnect::setSetting</a> (const char *settingStr, uint32_t value)</td></tr>
<tr class="memdesc:gace51a2841415a53f54fcce336182f0ec"><td class="mdescLeft"> </td><td class="mdescRight">Set a module setting. <a href="#gace51a2841415a53f54fcce336182f0ec">More...</a><br /></td></tr>
<tr class="separator:gace51a2841415a53f54fcce336182f0ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga085a17a466905069940611bdd14c1d3e"><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__settings.html#ga085a17a466905069940611bdd14c1d3e">wiconnect::Wiconnect::setSetting</a> (const char *settingStr, const char *value)</td></tr>
<tr class="memdesc:ga085a17a466905069940611bdd14c1d3e"><td class="mdescLeft"> </td><td class="mdescRight">Set a module setting. <a href="#ga085a17a466905069940611bdd14c1d3e">More...</a><br /></td></tr>
<tr class="separator:ga085a17a466905069940611bdd14c1d3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga16d5022d1fbd784fe0fd90a56911c5bc"><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__settings.html#ga16d5022d1fbd784fe0fd90a56911c5bc">wiconnect::Wiconnect::getSetting</a> (const char *settingStr, uint32_t *valuePtr)</td></tr>
<tr class="memdesc:ga16d5022d1fbd784fe0fd90a56911c5bc"><td class="mdescLeft"> </td><td class="mdescRight">Get a module setting. <a href="#ga16d5022d1fbd784fe0fd90a56911c5bc">More...</a><br /></td></tr>
<tr class="separator:ga16d5022d1fbd784fe0fd90a56911c5bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9dfd70aac8f0770f300ccf3a126ba296"><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__settings.html#ga9dfd70aac8f0770f300ccf3a126ba296">wiconnect::Wiconnect::getSetting</a> (const char *settingStr, char **valuePtr)</td></tr>
<tr class="memdesc:ga9dfd70aac8f0770f300ccf3a126ba296"><td class="mdescLeft"> </td><td class="mdescRight">Get a module setting. <a href="#ga9dfd70aac8f0770f300ccf3a126ba296">More...</a><br /></td></tr>
<tr class="separator:ga9dfd70aac8f0770f300ccf3a126ba296"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga670947ef630233f7866f885500548233"><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__settings.html#ga670947ef630233f7866f885500548233">wiconnect::Wiconnect::getSetting</a> (const char *settingStr, char *valueBuffer, uint16_t valueBufferLen)</td></tr>
<tr class="memdesc:ga670947ef630233f7866f885500548233"><td class="mdescLeft"> </td><td class="mdescRight">Get a module setting. <a href="#ga670947ef630233f7866f885500548233">More...</a><br /></td></tr>
<tr class="separator:ga670947ef630233f7866f885500548233"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga851795595a422a14249b7ea9f0038c4c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga851795595a422a14249b7ea9f0038c4c">wiconnect::Wiconnect::setBlockingEnabled</a> (bool blockingEnabled)</td></tr>
<tr class="memdesc:ga851795595a422a14249b7ea9f0038c4c"><td class="mdescLeft"> </td><td class="mdescRight">Sets if API calls are blocking or non-blocking. <a href="#ga851795595a422a14249b7ea9f0038c4c">More...</a><br /></td></tr>
<tr class="separator:ga851795595a422a14249b7ea9f0038c4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf6115968c49c128717cacd2f06b883ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf6115968c49c128717cacd2f06b883ad"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gaf6115968c49c128717cacd2f06b883ad">wiconnect::Wiconnect::getBlockingEnabled</a> (void)</td></tr>
<tr class="memdesc:gaf6115968c49c128717cacd2f06b883ad"><td class="mdescLeft"> </td><td class="mdescRight">Gets if API calls are blocking or non-blocking. <br /></td></tr>
<tr class="separator:gaf6115968c49c128717cacd2f06b883ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacae50138f9388a66496408f9c2bf6a6f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gacae50138f9388a66496408f9c2bf6a6f">wiconnect::Wiconnect::setCommandDefaultTimeout</a> (<a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs)</td></tr>
<tr class="memdesc:gacae50138f9388a66496408f9c2bf6a6f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the default maximum time an API method may execute before terminating and return a timeout error code. <a href="#gacae50138f9388a66496408f9c2bf6a6f">More...</a><br /></td></tr>
<tr class="separator:gacae50138f9388a66496408f9c2bf6a6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8d98b8d2610f4ea564bede27e87857e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gad8d98b8d2610f4ea564bede27e87857e">wiconnect::Wiconnect::getCommandDefaultTimeout</a> ()</td></tr>
<tr class="memdesc:gad8d98b8d2610f4ea564bede27e87857e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current default maximum API execution time. <a href="#gad8d98b8d2610f4ea564bede27e87857e">More...</a><br /></td></tr>
<tr class="separator:gad8d98b8d2610f4ea564bede27e87857e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">wiconnect::Wiconnect::setPinToGpioMapper</a> (PinToGpioMapper mapper)</td></tr>
<tr class="memdesc:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="mdescLeft"> </td><td class="mdescRight">Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO. <a href="#ga180b043ec83c53b5bf6b9ef2b187d08d">More...</a><br /></td></tr>
<tr class="separator:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75fb083451ee530a1c19e6a4c1be185e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">wiconnect::Wiconnect::setDebugLogger</a> (<a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a> logFunc)</td></tr>
<tr class="memdesc:ga75fb083451ee530a1c19e6a4c1be185e"><td class="mdescLeft"> </td><td class="mdescRight">Sets callback function used to debug WiConnect WiFi module RX/TX serial data. <a href="#ga75fb083451ee530a1c19e6a4c1be185e">More...</a><br /></td></tr>
<tr class="separator:ga75fb083451ee530a1c19e6a4c1be185e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga273f67fede26be4a3d5d909c5cf8c7e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">wiconnect::Wiconnect::setAssertLogger</a> (<a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a> assertLogFunc)</td></tr>
<tr class="memdesc:ga273f67fede26be4a3d5d909c5cf8c7e0"><td class="mdescLeft"> </td><td class="mdescRight">Sets callback used when <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library hits and internal assertion. <a href="#ga273f67fede26be4a3d5d909c5cf8c7e0">More...</a><br /></td></tr>
<tr class="separator:ga273f67fede26be4a3d5d909c5cf8c7e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8dc9e906da9d4bcb9f44e111bc709042"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga8dc9e906da9d4bcb9f44e111bc709042">wiconnect::Wiconnect::setCommandProcessingPeriod</a> (uint32_t periodMs)</td></tr>
<tr class="memdesc:ga8dc9e906da9d4bcb9f44e111bc709042"><td class="mdescLeft"> </td><td class="mdescRight">Set the period at which an asynchronous command should be processed. <a href="#ga8dc9e906da9d4bcb9f44e111bc709042">More...</a><br /></td></tr>
<tr class="separator:ga8dc9e906da9d4bcb9f44e111bc709042"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>API getters/setters for core library settings. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad8d98b8d2610f4ea564bede27e87857e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> wiconnect::Wiconnect::getCommandDefaultTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current default maximum API execution time. </p>
<dl class="section return"><dt>Returns</dt><dd>Default command timeout in milliseconds </dd></dl>
</div>
</div>
<a class="anchor" id="ga16d5022d1fbd784fe0fd90a56911c5bc"></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::getSetting </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>settingStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>valuePtr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a module setting. </p>
<p>Refer to: <a href="http://wiconnect.ack.me/2.0/variables">http://wiconnect.ack.me/2.0/variables</a> for a list of the available settings and descriptions</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settingStr</td><td>String module setting name. </td></tr>
<tr><td class="paramname">valuePtr</td><td>Pointer to buffer to contain integer value</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="ga9dfd70aac8f0770f300ccf3a126ba296"></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::getSetting </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>settingStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>valuePtr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a module setting. </p>
<p>Refer to: <a href="http://wiconnect.ack.me/2.0/variables">http://wiconnect.ack.me/2.0/variables</a> for a list of the available settings and descriptions</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settingStr</td><td>String module setting name. </td></tr>
<tr><td class="paramname">valuePtr</td><td>Pointer to hold pointer to internal API buffer containing retrieved setting result</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="ga670947ef630233f7866f885500548233"></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::getSetting </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>settingStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>valueBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>valueBufferLen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a module setting. </p>
<p>Refer to: <a href="http://wiconnect.ack.me/2.0/variables">http://wiconnect.ack.me/2.0/variables</a> for a list of the available settings and descriptions</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settingStr</td><td>String module setting name. </td></tr>
<tr><td class="paramname">valueBuffer</td><td>Buffer to hold retrieved setting result </td></tr>
<tr><td class="paramname">valueBufferLen</td><td>The length of the input buffer</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="ga273f67fede26be4a3d5d909c5cf8c7e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wiconnect::Wiconnect::setAssertLogger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a> </td>
<td class="paramname"><em>assertLogFunc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets callback used when <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library hits and internal assertion. </p>
<dl class="section note"><dt>Note</dt><dd>This is mainly for debugging. There's nothing the callback can do to fix the assertion.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">assertLogFunc</td><td>Logging function pointer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga851795595a422a14249b7ea9f0038c4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wiconnect::Wiconnect::setBlockingEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>blockingEnabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets if API calls are blocking or non-blocking. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">blockingEnabled</td><td>The new blocking value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gacae50138f9388a66496408f9c2bf6a6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wiconnect::Wiconnect::setCommandDefaultTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> </td>
<td class="paramname"><em>timeoutMs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the default maximum time an API method may execute before terminating and return a timeout error code. </p>
<dl class="section note"><dt>Note</dt><dd>All API methods (execpt some <a class="el" href="group__api__core__send__command.html#gadd23f2f86fcc0a438dad798ab3353505" title="Send command to WiConnect WiFi module. ">sendCommand()</a>) use this default value.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Default command timeout in milliseconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8dc9e906da9d4bcb9f44e111bc709042"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wiconnect::Wiconnect::setCommandProcessingPeriod </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>periodMs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the period at which an asynchronous command should be processed. </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">periodMs</td><td>Processing period in milliseconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga75fb083451ee530a1c19e6a4c1be185e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wiconnect::Wiconnect::setDebugLogger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a> </td>
<td class="paramname"><em>logFunc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets callback function used to debug WiConnect WiFi module RX/TX serial data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">logFunc</td><td>Logging function pointer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga180b043ec83c53b5bf6b9ef2b187d08d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wiconnect::Wiconnect::setPinToGpioMapper </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacewiconnect.html#aadd4d5e6774e21f382c20b594a644470">PinToGpioMapper</a> </td>
<td class="paramname"><em>mapper</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mapper</td><td>Pin to GPIO mapper function pointer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gace51a2841415a53f54fcce336182f0ec"></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::setSetting </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>settingStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a module setting. </p>
<p>Refer to: <a href="http://wiconnect.ack.me/2.0/variables">http://wiconnect.ack.me/2.0/variables</a> for a list of the available settings and descriptions</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settingStr</td><td>String module setting name. </td></tr>
<tr><td class="paramname">value</td><td>The integer value to set</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="ga085a17a466905069940611bdd14c1d3e"></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::setSetting </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>settingStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a module setting. </p>
<p>Refer to: <a href="http://wiconnect.ack.me/2.0/variables">http://wiconnect.ack.me/2.0/variables</a> for a list of the available settings and descriptions</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settingStr</td><td>String module setting name. </td></tr>
<tr><td class="paramname">value</td><td>The string value to set</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>
</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