Diff: doc/html/classwiconnect_1_1_wiconnect.html

Revision:

26:8067e3d463d3

Parent:

21:17bb3eddcbae

Child:

29:b6af04b77a56

--- a/doc/html/classwiconnect_1_1_wiconnect.html	Tue Aug 26 16:53:06 2014 -0700
+++ b/doc/html/classwiconnect_1_1_wiconnect.html	Thu Oct 23 15:16:06 2014 -0700
@@ -47,7 +47,7 @@
       <li><a href="modules.html"><span>Library&#160;API</span></a></li>
       <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
-      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
       <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
@@ -129,9 +129,9 @@
 <tr class="memitem:afe9fa2efde4e26944cdc9b6be51a1a34"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html#afe9fa2efde4e26944cdc9b6be51a1a34">Wiconnect</a> (const <a class="el" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> &amp;serialConfig, int internalBufferSize, void *internalBuffer=NULL, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> <a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>, <a class="el" href="group__api__core__types.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:afe9fa2efde4e26944cdc9b6be51a1a34"><td class="mdescLeft">&#160;</td><td class="mdescRight">WiConnect class constructor.  <a href="#afe9fa2efde4e26944cdc9b6be51a1a34">More...</a><br /></td></tr>
 <tr class="separator:afe9fa2efde4e26944cdc9b6be51a1a34"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga2c12dea5cb989353f39b3bee7e538c86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga2c12dea5cb989353f39b3bee7e538c86">init</a> (bool bringNetworkUp=true)</td></tr>
-<tr class="memdesc:ga2c12dea5cb989353f39b3bee7e538c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize library and communication link with WiConnect WiFi module.  <a href="group__api__core__misc.html#ga2c12dea5cb989353f39b3bee7e538c86">More...</a><br /></td></tr>
-<tr class="separator:ga2c12dea5cb989353f39b3bee7e538c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gae2e3add2e60543d0e3340ed7a9e034ad">init</a> (bool bringNetworkUp=false)</td></tr>
+<tr class="memdesc:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize library and communication link with WiConnect WiFi module.  <a href="group__api__core__misc.html#gae2e3add2e60543d0e3340ed7a9e034ad">More...</a><br /></td></tr>
+<tr class="separator:gae2e3add2e60543d0e3340ed7a9e034ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga9d6c981a54c6ab964b469e4f247142d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9d6c981a54c6ab964b469e4f247142d6"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">deinit</a> ()</td></tr>
 <tr class="memdesc:ga9d6c981a54c6ab964b469e4f247142d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize library. <br /></td></tr>
@@ -151,6 +151,9 @@
 <tr class="memitem:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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 <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;completeCallback=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
 <tr class="memdesc:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return current version of WiConnect WiFi module.  <a href="group__api__core__misc.html#ga4fc195839bc6c6bd0091074cbdc94c4f">More...</a><br /></td></tr>
 <tr class="separator:ga4fc195839bc6c6bd0091074cbdc94c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gad447fe3341539eb9b276d269645bb632"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__misc.html#gad447fe3341539eb9b276d269645bb632">updateFirmware</a> (bool forced=false, const char *versionStr=NULL, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;completeCallback=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
+<tr class="memdesc:gad447fe3341539eb9b276d269645bb632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the wifi module's internal firmware.  <a href="group__api__core__misc.html#gad447fe3341539eb9b276d269645bb632">More...</a><br /></td></tr>
+<tr class="separator:gad447fe3341539eb9b276d269645bb632"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga3a2637e5ce300a03c448edf1eff13c2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">sendCommand</a> (const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &amp;completeCallback, char *responseBuffer, int responseBufferLen, int timeoutMs, const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &amp;reader, void *user, const char *cmd, va_list vaList)</td></tr>
 <tr class="memdesc:ga3a2637e5ce300a03c448edf1eff13c2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send command to WiConnect WiFi module.  <a href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c">More...</a><br /></td></tr>
 <tr class="separator:ga3a2637e5ce300a03c448edf1eff13c2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -209,6 +212,21 @@
 <tr class="memitem:gada79343aece515e00f9be4045d3858a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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="memdesc:gada79343aece515e00f9be4045d3858a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper method to convert previous response to int32.  <a href="group__api__core__misc.html#gada79343aece515e00f9be4045d3858a0">More...</a><br /></td></tr>
 <tr class="separator:gada79343aece515e00f9be4045d3858a0"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gace51a2841415a53f54fcce336182f0ec">setSetting</a> (const char *settingStr, uint32_t value)</td></tr>
+<tr class="memdesc:gace51a2841415a53f54fcce336182f0ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a module setting.  <a href="group__api__core__settings.html#gace51a2841415a53f54fcce336182f0ec">More...</a><br /></td></tr>
+<tr class="separator:gace51a2841415a53f54fcce336182f0ec"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga085a17a466905069940611bdd14c1d3e">setSetting</a> (const char *settingStr, const char *value)</td></tr>
+<tr class="memdesc:ga085a17a466905069940611bdd14c1d3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a module setting.  <a href="group__api__core__settings.html#ga085a17a466905069940611bdd14c1d3e">More...</a><br /></td></tr>
+<tr class="separator:ga085a17a466905069940611bdd14c1d3e"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga16d5022d1fbd784fe0fd90a56911c5bc">getSetting</a> (const char *settingStr, uint32_t *valuePtr)</td></tr>
+<tr class="memdesc:ga16d5022d1fbd784fe0fd90a56911c5bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a module setting.  <a href="group__api__core__settings.html#ga16d5022d1fbd784fe0fd90a56911c5bc">More...</a><br /></td></tr>
+<tr class="separator:ga16d5022d1fbd784fe0fd90a56911c5bc"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga9dfd70aac8f0770f300ccf3a126ba296">getSetting</a> (const char *settingStr, char **valuePtr)</td></tr>
+<tr class="memdesc:ga9dfd70aac8f0770f300ccf3a126ba296"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a module setting.  <a href="group__api__core__settings.html#ga9dfd70aac8f0770f300ccf3a126ba296">More...</a><br /></td></tr>
+<tr class="separator:ga9dfd70aac8f0770f300ccf3a126ba296"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga670947ef630233f7866f885500548233">getSetting</a> (const char *settingStr, char *valueBuffer, uint16_t valueBufferLen)</td></tr>
+<tr class="memdesc:ga670947ef630233f7866f885500548233"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a module setting.  <a href="group__api__core__settings.html#ga670947ef630233f7866f885500548233">More...</a><br /></td></tr>
+<tr class="separator:ga670947ef630233f7866f885500548233"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaaaf8be221699870053ad98911b066a32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">setCommandDefaultTimeout</a> (int timeoutMs)</td></tr>
 <tr class="memdesc:gaaaf8be221699870053ad98911b066a32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the default maximum time an API method may execute before terminating and return a timeout error code.  <a href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">More...</a><br /></td></tr>
 <tr class="separator:gaaaf8be221699870053ad98911b066a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -243,6 +261,9 @@
 <tr class="memitem:ga047ba9670f60406466391cec5bdd28e5 inherit pub_methods_classwiconnect_1_1_network_interface"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">getNetworkStatus</a> (<a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> *statusPtr)</td></tr>
 <tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5 inherit pub_methods_classwiconnect_1_1_network_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get connection status to WiFi network.  <a href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">More...</a><br /></td></tr>
 <tr class="separator:ga047ba9670f60406466391cec5bdd28e5 inherit pub_methods_classwiconnect_1_1_network_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gafefe6e679d7b48a7127d3ed6371fe58b inherit pub_methods_classwiconnect_1_1_network_interface"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">getNetworkJoinResult</a> (<a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> *joinResultPtr)</td></tr>
+<tr class="memdesc:gafefe6e679d7b48a7127d3ed6371fe58b inherit pub_methods_classwiconnect_1_1_network_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the result of joining the network.  <a href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">More...</a><br /></td></tr>
+<tr class="separator:gafefe6e679d7b48a7127d3ed6371fe58b inherit pub_methods_classwiconnect_1_1_network_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gacdf014d8aca9de33dbc1563c6bb1f956 inherit pub_methods_classwiconnect_1_1_network_interface"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">scan</a> (<a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> &amp;resultList, const uint8_t *channelList=NULL, const char *ssid=NULL)</td></tr>
 <tr class="memdesc:gacdf014d8aca9de33dbc1563c6bb1f956 inherit pub_methods_classwiconnect_1_1_network_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scan for available WiFi networks.  <a href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">More...</a><br /></td></tr>
 <tr class="separator:gacdf014d8aca9de33dbc1563c6bb1f956 inherit pub_methods_classwiconnect_1_1_network_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -365,6 +386,10 @@
 static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">networkStatusToStr</a> (<a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> status)</td></tr>
 <tr class="memdesc:gacff5a4927d79e8b4c0d5a3050f5950b0 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> to string. <br /></td></tr>
 <tr class="separator:gacff5a4927d79e8b4c0d5a3050f5950b0 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga5a682e671900b9b7f931137deb847fa6 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5a682e671900b9b7f931137deb847fa6"></a>
+static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga5a682e671900b9b7f931137deb847fa6">networkJoinResultToStr</a> (<a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> joinResult)</td></tr>
+<tr class="memdesc:ga5a682e671900b9b7f931137deb847fa6 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> to string. <br /></td></tr>
+<tr class="separator:ga5a682e671900b9b7f931137deb847fa6 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gad4661f859cfadbe193793898671043c9 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad4661f859cfadbe193793898671043c9"></a>
 static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">signalStrengthToStr</a> (<a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> signalStrenth)</td></tr>
 <tr class="memdesc:gad4661f859cfadbe193793898671043c9 inherit pub_static_methods_classwiconnect_1_1_network_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> to string. <br /></td></tr>