ACKme
Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
doc/html/group__types__core.html
- Committer:
- dan_ackme
- Date:
- 2014-08-12
- Revision:
- 11:ea484e1b7fc4
File content as of revision 11:ea484e1b7fc4:
<!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"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>WiConnect Library: Core API</title>
<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">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">WiConnect Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</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__types__core.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Core API<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Core API Types.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The root WiConnect library class. This class inheriets all WiConnect functionality. <a href="classwiconnect_1_1_wiconnect.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_buffer.html">wiconnect::Buffer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic buffer type. <a href="structwiconnect_1_1_buffer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic callback function. <a href="classwiconnect_1_1_callback.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_function_pointer.html">wiconnect::FunctionPointer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic function pointer. <a href="classwiconnect_1_1_function_pointer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_log_func.html">wiconnect::LogFunc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Logging callback function. <a href="classwiconnect_1_1_log_func.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_queued_command.html">wiconnect::QueuedCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class which contains command for asynchronous processing. <a href="classwiconnect_1_1_queued_command.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_reader_func.html">wiconnect::ReaderFunc</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic data reading callback function. <a href="classwiconnect_1_1_reader_func.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1___serial_config.html">wiconnect::_SerialConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Host<-><a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. <a href="structwiconnect_1_1___serial_config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaadd4d5e6774e21f382c20b594a644470"><td class="memItemLeft" align="right" valign="top">typedef int8_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#gaadd4d5e6774e21f382c20b594a644470">wiconnect::PinToGpioMapper</a> )(Pin pin)</td></tr>
<tr class="memdesc:gaadd4d5e6774e21f382c20b594a644470"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer for mapping from a host pin to a WiConnect Module GPIO. <a href="#gaadd4d5e6774e21f382c20b594a644470">More...</a><br /></td></tr>
<tr class="separator:gaadd4d5e6774e21f382c20b594a644470"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1cf4dfa71da0b0dc3dc707dacf56cc9c"></a>
typedef PinName </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></td></tr>
<tr class="memdesc:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="mdescLeft"> </td><td class="mdescRight">Pin name on HOST. <br /></td></tr>
<tr class="separator:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef13192ccd0895903ea42e83427b13b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaef13192ccd0895903ea42e83427b13b4"></a>
typedef struct <br class="typebreak" />
<a class="el" href="structwiconnect_1_1___serial_config.html">wiconnect::_SerialConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">wiconnect::SerialConfig</a></td></tr>
<tr class="memdesc:gaef13192ccd0895903ea42e83427b13b4"><td class="mdescLeft"> </td><td class="mdescRight">Host<-><a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. <br /></td></tr>
<tr class="separator:gaef13192ccd0895903ea42e83427b13b4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a> { <br />
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789">wiconnect::WICONNECT_ABORTED</a> = 3,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1">wiconnect::WICONNECT_IDLE</a> = 2,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">wiconnect::WICONNECT_PROCESSING</a> = 1,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a> = 0,
<br />
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6">wiconnect::WICONNECT_ERROR</a> = -1,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff">wiconnect::WICONNECT_CMD_RESPONSE_ERROR</a> = -2,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5">wiconnect::WICONNECT_NULL_BUFFER</a> = -3,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43">wiconnect::WICONNECT_NOT_INITIALIZED</a> = -4,
<br />
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f">wiconnect::WICONNECT_OVERFLOW</a> = -5,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac">wiconnect::WICONNECT_TIMEOUT</a> = -6,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5">wiconnect::WICONNECT_RESPONSE_PARSE_ERROR</a> = -8,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83">wiconnect::WICONNECT_ANOTHER_CMD_EXECUTING</a> = -9,
<br />
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa">wiconnect::WICONNECT_BAD_ARG</a> = -10,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc">wiconnect::WICONNECT_UNSUPPORTED</a> = -11,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff">wiconnect::WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL</a> = -12,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">wiconnect::WICONNECT_DUPLICATE</a> = -13,
<br />
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">wiconnect::WICONNECT_NOT_FOUND</a> = -14,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a">wiconnect::WICONNECT_PINNAME_TO_GPIO_NO_MAPPING</a> = -15,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2">wiconnect::WICONNECT_NOT_CONNECTED</a> = -16,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02">wiconnect::WICONNECT_UNDERFLOW</a> = -17,
<br />
  <a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e">wiconnect::WICONNECT_MONITOR_NOT_AVAILABLE</a> = -18,
<a class="el" href="group__types__core.html#gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2">wiconnect::WICONNECT_NOT_OPENED_FOR_READING</a> = -19
<br />
}</td></tr>
<tr class="memdesc:ga325637ed501728bd6c8c7a7982b9ce05"><td class="mdescLeft"> </td><td class="mdescRight">API Result code. <a href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">More...</a><br /></td></tr>
<tr class="separator:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga285510a2cba5341db387101ac75a4389"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#ga285510a2cba5341db387101ac75a4389">wiconnect::Wiconnect::Wiconnect</a> (const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> &serialConfig, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> reset=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> wake=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, bool nonBlocking=<a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS)</td></tr>
<tr class="memdesc:ga285510a2cba5341db387101ac75a4389"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect class constructor. <a href="#ga285510a2cba5341db387101ac75a4389">More...</a><br /></td></tr>
<tr class="separator:ga285510a2cba5341db387101ac75a4389"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad39105b9aa5858c3b3bbf81b2cebcd30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__core.html#gad39105b9aa5858c3b3bbf81b2cebcd30">wiconnect::Wiconnect::Wiconnect</a> (const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> &serialConfig, void *internalBuffer, int internalBufferSize, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> reset=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> wake=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, bool nonBlocking=<a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS)</td></tr>
<tr class="memdesc:gad39105b9aa5858c3b3bbf81b2cebcd30"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect class constructor. <a href="#gad39105b9aa5858c3b3bbf81b2cebcd30">More...</a><br /></td></tr>
<tr class="separator:gad39105b9aa5858c3b3bbf81b2cebcd30"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Core API Types. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaadd4d5e6774e21f382c20b594a644470"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int8_t(* wiconnect::PinToGpioMapper)(Pin pin)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function pointer for mapping from a host pin to a WiConnect Module GPIO. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>A host pin </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The corresponding WiConnect Module GPIO (which the given pin is physically connected). Return -1 if no mapping is available. </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga325637ed501728bd6c8c7a7982b9ce05"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>API Result code. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789"></a>WICONNECT_ABORTED </td><td class="fielddoc">
<p>Command was aborted. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1"></a>WICONNECT_IDLE </td><td class="fielddoc">
<p>Library not processing any commands. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0"></a>WICONNECT_PROCESSING </td><td class="fielddoc">
<p>Library processing current command. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"></a>WICONNECT_SUCCESS </td><td class="fielddoc">
<p>Command successfully completed. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6"></a>WICONNECT_ERROR </td><td class="fielddoc">
<p>Generic error. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff"></a>WICONNECT_CMD_RESPONSE_ERROR </td><td class="fielddoc">
<p>Module returned error code. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5"></a>WICONNECT_NULL_BUFFER </td><td class="fielddoc">
<p>Null buffer supplied. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43"></a>WICONNECT_NOT_INITIALIZED </td><td class="fielddoc">
<p>Library not initialed. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f"></a>WICONNECT_OVERFLOW </td><td class="fielddoc">
<p><a class="el" href="structwiconnect_1_1_buffer.html" title="Generic buffer type. ">Buffer</a> overflowed. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac"></a>WICONNECT_TIMEOUT </td><td class="fielddoc">
<p>Command timed out. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5"></a>WICONNECT_RESPONSE_PARSE_ERROR </td><td class="fielddoc">
<p>Failed to parse module response. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83"></a>WICONNECT_ANOTHER_CMD_EXECUTING </td><td class="fielddoc">
<p>Currently executing another command. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa"></a>WICONNECT_BAD_ARG </td><td class="fielddoc">
<p>Bad argument supplied. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc"></a>WICONNECT_UNSUPPORTED </td><td class="fielddoc">
<p>Command / parameter not supported. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff"></a>WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL </td><td class="fielddoc">
<p>The pinToGpioMapper hasn't been set. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4"></a>WICONNECT_DUPLICATE </td><td class="fielddoc">
<p>Duplicate value. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195"></a>WICONNECT_NOT_FOUND </td><td class="fielddoc">
<p>Not found. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a"></a>WICONNECT_PINNAME_TO_GPIO_NO_MAPPING </td><td class="fielddoc">
<p>No mapping found for given pin. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2"></a>WICONNECT_NOT_CONNECTED </td><td class="fielddoc">
<p>Not connected. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02"></a>WICONNECT_UNDERFLOW </td><td class="fielddoc">
<p>Data underflow. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e"></a>WICONNECT_MONITOR_NOT_AVAILABLE </td><td class="fielddoc">
<p>Background processing monitor is not available (i.e in use) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2"></a>WICONNECT_NOT_OPENED_FOR_READING </td><td class="fielddoc">
<p>The file is not open for reading. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga285510a2cba5341db387101ac75a4389"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wiconnect::Wiconnect::Wiconnect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> & </td>
<td class="paramname"><em>serialConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
<td class="paramname"><em>reset</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
<td class="paramname"><em>wake</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nonBlocking</em> = <code><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>WiConnect class constructor. </p>
<dl class="section note"><dt>Note</dt><dd>This should only be called once within a program as the WiConnect library is implemented as a singleton.</dd>
<dd>
If this constructor is used, then all commands must be supplied with an external response buffer. This means most the API functions will not work as they use the internal buffer. It's recommended to use the other constructor that supplies an internal buffer. See <a class="el" href="index.html#setting_alloc">Dynamic / Static Allocation</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serialConfig</td><td>The serial (i.e. UART) configuration connected to a WiConnect module. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reset</td><td>Optional, The pin connected to the WiConnect module reset signal. Default: No connection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">wake</td><td>Optional, The pin connected to the WiConnect module wake signal. Default: No connection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nonBlocking</td><td>Optional, indicates if the API blocking mode. See <a class="el" href="index.html#setting_blocking_modes">Blocking / Non-blocking Modes</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad39105b9aa5858c3b3bbf81b2cebcd30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wiconnect::Wiconnect::Wiconnect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__types__core.html#gaef13192ccd0895903ea42e83427b13b4">SerialConfig</a> & </td>
<td class="paramname"><em>serialConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>internalBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>internalBufferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
<td class="paramname"><em>reset</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types__core.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> </td>
<td class="paramname"><em>wake</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nonBlocking</em> = <code><a class="el" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401">WICONNECT_DEFAULT_NONBLOCKING</a> WICONNECT_MALLOC_ARGS</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>WiConnect class constructor. </p>
<dl class="section note"><dt>Note</dt><dd>This should only be called once within a program as the WiConnect library is implemented as a singleton.</dd>
<dd>
This is the recommended construstor as it supplies the WiConnect library with an internal buffer. Most API calls require the internal buffer.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serialConfig</td><td>The serial (i.e. UART) configuration connected to a WiConnect module. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">internalBuffer</td><td>Optional, a user allocated buffer. See <a class="el" href="index.html#setting_alloc">Dynamic / Static Allocation</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">internalBufferSize</td><td>The size of the internal buffer. If internalBuffer is NULL, then this size will be dynamically allocated. See <a class="el" href="index.html#setting_alloc">Dynamic / Static Allocation</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reset</td><td>Optional, The pin connected to the WiConnect module reset signal. Default: No connection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">wake</td><td>Optional, The pin connected to the WiConnect module wake signal. Default: No connection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nonBlocking</td><td>Optional, indicates if the API blocking mode. See <a class="el" href="index.html#setting_blocking_modes">Blocking / Non-blocking Modes</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </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