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/classwiconnect_1_1_wiconnect.html
- Committer:
- dan_ackme
- Date:
- 2014-08-11
- Revision:
- 10:735194df0097
- Child:
- 11:ea484e1b7fc4
File content as of revision 10:735194df0097:
<!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: wiconnect::Wiconnect Class Reference</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="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 -->
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></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('classwiconnect_1_1_wiconnect.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classwiconnect_1_1_wiconnect-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wiconnect::Wiconnect Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="_wiconnect_interface_8h_source.html">WiconnectInterface.h</a>></code></p>
<p>Inherits wiconnect::NetworkInterface, wiconnect::SocketInterface, and wiconnect::FileInterface.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a285510a2cba5341db387101ac75a4389"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a> (const SerialConfig &serialConfig, Pin <a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td></tr>
<tr class="separator:a285510a2cba5341db387101ac75a4389"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad39105b9aa5858c3b3bbf81b2cebcd30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html#ad39105b9aa5858c3b3bbf81b2cebcd30">Wiconnect</a> (const SerialConfig &serialConfig, void *internalBuffer, int internalBufferSize, Pin <a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td></tr>
<tr class="separator:ad39105b9aa5858c3b3bbf81b2cebcd30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad62e847c65166134a361d68b5c95e57c"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad62e847c65166134a361d68b5c95e57c">init</a> (bool bringNetworkUp)</td></tr>
<tr class="separator:gad62e847c65166134a361d68b5c95e57c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">deinit</a> ()</td></tr>
<tr class="separator:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab00c7110984f6d6187241d17a4a431ff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gab00c7110984f6d6187241d17a4a431ff">isInitialized</a> ()</td></tr>
<tr class="separator:gab00c7110984f6d6187241d17a4a431ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabec1504eb7f486085dad82c4a94310e3"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a> ()</td></tr>
<tr class="separator:gabec1504eb7f486085dad82c4a94310e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wakeup</a> ()</td></tr>
<tr class="separator:gad552c8f23dd0a0e8844ee1fc4d9358e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96ac50d85d8ab376755d7d5325de1713"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga96ac50d85d8ab376755d7d5325de1713">flush</a> (int delayMs=500)</td></tr>
<tr class="separator:ga96ac50d85d8ab376755d7d5325de1713"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">getVersion</a> (char *versionBuffer=NULL, int versionBufferSize=0, const Callback &completeCallback=Callback())</td></tr>
<tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3a2637e5ce300a03c448edf1eff13c2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3a2637e5ce300a03c448edf1eff13c2c"></a>
WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a> (const Callback &completeCallback, char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList)</td></tr>
<tr class="memdesc:ga3a2637e5ce300a03c448edf1eff13c2c"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <br /></td></tr>
<tr class="separator:ga3a2637e5ce300a03c448edf1eff13c2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad23730a1f2f7714ef962f24a0f99f0f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad23730a1f2f7714ef962f24a0f99f0f7"></a>
WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gad23730a1f2f7714ef962f24a0f99f0f7">sendCommand</a> (char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList)</td></tr>
<tr class="memdesc:gad23730a1f2f7714ef962f24a0f99f0f7"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <br /></td></tr>
<tr class="separator:gad23730a1f2f7714ef962f24a0f99f0f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e0591e923da9ab814bb3dd3afbda197"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga0e0591e923da9ab814bb3dd3afbda197">sendCommand</a> (char *responseBuffer, int responseBufferLen, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd,...)</td></tr>
<tr class="memdesc:ga0e0591e923da9ab814bb3dd3afbda197"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#ga0e0591e923da9ab814bb3dd3afbda197">More...</a><br /></td></tr>
<tr class="separator:ga0e0591e923da9ab814bb3dd3afbda197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadd347dd3952ebab2fa27561c12858f65"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gadd347dd3952ebab2fa27561c12858f65">sendCommand</a> (int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd,...)</td></tr>
<tr class="memdesc:gadd347dd3952ebab2fa27561c12858f65"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#gadd347dd3952ebab2fa27561c12858f65">More...</a><br /></td></tr>
<tr class="separator:gadd347dd3952ebab2fa27561c12858f65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca2f1b17d2cc98cbc6dac219ffcf9e84"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaca2f1b17d2cc98cbc6dac219ffcf9e84">sendCommand</a> (const ReaderFunc &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 Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#gaca2f1b17d2cc98cbc6dac219ffcf9e84">More...</a><br /></td></tr>
<tr class="separator:gaca2f1b17d2cc98cbc6dac219ffcf9e84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3655750f929f8f4e966278193d0385a9"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga3655750f929f8f4e966278193d0385a9">sendCommand</a> (char *responseBuffer, int responseBufferLen, int timeoutMs, const char *cmd,...)</td></tr>
<tr class="memdesc:ga3655750f929f8f4e966278193d0385a9"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#ga3655750f929f8f4e966278193d0385a9">More...</a><br /></td></tr>
<tr class="separator:ga3655750f929f8f4e966278193d0385a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf93db1b2730bb586287f7756f3cdf092"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaf93db1b2730bb586287f7756f3cdf092">sendCommand</a> (const Callback &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 Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#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">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaac75ca154bd5d5a21c714dd828a92363">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 Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#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">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga7eb983a196daa5de20a73fd234dc6f64">sendCommand</a> (const Callback &completeCallback, const char *cmd,...)</td></tr>
<tr class="memdesc:ga7eb983a196daa5de20a73fd234dc6f64"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#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">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gadad1c5b3df07a24ab09492edf93dd1f4">sendCommand</a> (const char *cmd,...)</td></tr>
<tr class="memdesc:gadad1c5b3df07a24ab09492edf93dd1f4"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#gadad1c5b3df07a24ab09492edf93dd1f4">More...</a><br /></td></tr>
<tr class="separator:gadad1c5b3df07a24ab09492edf93dd1f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6d744ec08ba6c9abf451bdc2b0beb00"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaa6d744ec08ba6c9abf451bdc2b0beb00">sendCommand</a> (const Callback &completeCallback, int timeoutMs, const char *cmd,...)</td></tr>
<tr class="memdesc:gaa6d744ec08ba6c9abf451bdc2b0beb00"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#gaa6d744ec08ba6c9abf451bdc2b0beb00">More...</a><br /></td></tr>
<tr class="separator:gaa6d744ec08ba6c9abf451bdc2b0beb00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace479d34633141ff1eefa0e98c4d2351"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gace479d34633141ff1eefa0e98c4d2351">sendCommand</a> (int timeoutMs, const char *cmd,...)</td></tr>
<tr class="memdesc:gace479d34633141ff1eefa0e98c4d2351"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <a href="group__api__core__send__command.html#gace479d34633141ff1eefa0e98c4d2351">More...</a><br /></td></tr>
<tr class="separator:gace479d34633141ff1eefa0e98c4d2351"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d0ade0ec2866d7e0df5391bc69f5698"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9d0ade0ec2866d7e0df5391bc69f5698"></a>
WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga9d0ade0ec2866d7e0df5391bc69f5698">sendCommand</a> (const char *cmd, va_list vaList)</td></tr>
<tr class="memdesc:ga9d0ade0ec2866d7e0df5391bc69f5698"><td class="mdescLeft"> </td><td class="mdescRight">Send command to WiConnect WiFi module Refer to <a class="el" href="index.html#send_command_desc">Sending Commands To WiFi Module</a> for more info. <br /></td></tr>
<tr class="separator:ga9d0ade0ec2866d7e0df5391bc69f5698"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8069679fabb52d44647d27703f1a09a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad8069679fabb52d44647d27703f1a09a">getLastCommandResponseCodeStr</a> ()</td></tr>
<tr class="separator:gad8069679fabb52d44647d27703f1a09a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga600215de23210071c42996d04390071e"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga600215de23210071c42996d04390071e">getLastCommandResponseLength</a> ()</td></tr>
<tr class="separator:ga600215de23210071c42996d04390071e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga27b5d6b8207e4ef0f73875606d628da8">getResponseBuffer</a> ()</td></tr>
<tr class="separator:ga27b5d6b8207e4ef0f73875606d628da8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac40b2964149e60245ff3cac6adbcd565"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gac40b2964149e60245ff3cac6adbcd565">responseToUint32</a> (uint32_t *uint32Ptr)</td></tr>
<tr class="separator:gac40b2964149e60245ff3cac6adbcd565"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gada79343aece515e00f9be4045d3858a0"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">responseToInt32</a> (int32_t *int32Ptr)</td></tr>
<tr class="separator:gada79343aece515e00f9be4045d3858a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf48c1ec0b92af2619ab846baaaa471cd"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">checkCurrentCommand</a> ()</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">stopCurrentCommand</a> ()</td></tr>
<tr class="separator:ga4a9bd29de1d5c496fbcc28ecfa51e7c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaaf8be221699870053ad98911b066a32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">setCommandDefaultTimeout</a> (int timeoutMs)</td></tr>
<tr class="separator:gaaaf8be221699870053ad98911b066a32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad5d31980a7b1e143f00b0117468c1a7e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">getCommandDefaultTimeout</a> ()</td></tr>
<tr class="separator:gad5d31980a7b1e143f00b0117468c1a7e"><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">setPinToGpioMapper</a> (PinToGpioMapper mapper)</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">setDebugLogger</a> (LogFunc logFunc)</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">setAssertLogger</a> (LogFunc assertLogFunc)</td></tr>
<tr class="separator:ga273f67fede26be4a3d5d909c5cf8c7e0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">getInstance</a> ()</td></tr>
<tr class="separator:ga8dcd3ac87afd58b225abb068e835d06e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac96e2d2fca60cba12e7429626f9186be"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html#ac96e2d2fca60cba12e7429626f9186be">getWiconnectResultStr</a> (WiconnectResult wiconnectResult)</td></tr>
<tr class="separator:ac96e2d2fca60cba12e7429626f9186be"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The root WiConnect library class. This class inheriets all WiConnect functionality.</p>
<p>This class is implemented as a 'singleton'. This means it only needs to be instantiated once. Subsequent class may either use the class instance or the static function: <a class="el" href="group__api__core__misc.html#ga8dcd3ac87afd58b225abb068e835d06e">Wiconnect::getInstance()</a> </p>
<p>Definition at line <a class="el" href="_wiconnect_interface_8h_source.html#l00053">53</a> of file <a class="el" href="_wiconnect_interface_8h_source.html">WiconnectInterface.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a285510a2cba5341db387101ac75a4389"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wiconnect::Wiconnect::Wiconnect </td>
<td>(</td>
<td class="paramtype">const SerialConfig & </td>
<td class="paramname"><em>serialConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Pin </td>
<td class="paramname"><em>reset</em> = <code>PIN_NC</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Pin </td>
<td class="paramname"><em>wake</em> = <code>PIN_NC</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nonBlocking</em> = <code>WICONNECT_DEFAULT_NONBLOCKING 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="ad39105b9aa5858c3b3bbf81b2cebcd30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wiconnect::Wiconnect::Wiconnect </td>
<td>(</td>
<td class="paramtype">const SerialConfig & </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">Pin </td>
<td class="paramname"><em>reset</em> = <code>PIN_NC</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Pin </td>
<td class="paramname"><em>wake</em> = <code>PIN_NC</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nonBlocking</em> = <code>WICONNECT_DEFAULT_NONBLOCKING 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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac96e2d2fca60cba12e7429626f9186be"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const char* wiconnect::Wiconnect::getWiconnectResultStr </td>
<td>(</td>
<td class="paramtype">WiconnectResult </td>
<td class="paramname"><em>wiconnectResult</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a WiconnectResult to string representation. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/<a class="el" href="_wiconnect_interface_8h_source.html">WiconnectInterface.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>wiconnect</b></li><li class="navelem"><a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a></li>
<li class="footer">Generated on Mon Aug 11 2014 21:58:24 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