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

Revision:
16:7f1d6d359787
Parent:
14:85a2ed029f37
Child:
17:7268f365676b
--- a/doc/html/join_2example_8cpp_source.html	Wed Aug 13 03:15:49 2014 -0700
+++ b/doc/html/join_2example_8cpp_source.html	Wed Aug 13 04:41:04 2014 -0700
@@ -110,11 +110,11 @@
 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">// Look for this name in your WiFi settings</span></div>
 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// (e.g. your phone&#39;s list of WiFi networks in the WiFi settings menu)</span></div>
 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// tip: add double-quotes around SSID to add spaces to name</span></div>
-<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define NETWORK_SSID &quot;ASUS&quot;</span></div>
+<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define NETWORK_SSID &quot;\&quot;&lt;YOUR NETWORK NAME HERE&gt;\&quot;&quot;</span></div>
 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">// This is the password of your WiFi network</span></div>
 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">// Leave as empty string (e.g &quot;&quot;) to connect to OPEN network</span></div>
-<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#define NETWORK_PASSWORD &quot;Y@nkee123&quot;</span></div>
+<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#define NETWORK_PASSWORD &quot;\&quot;&lt;YOUR NETWORK PASSWORD HERE&gt;\&quot;&quot;</span></div>
 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
@@ -161,12 +161,12 @@
 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="comment">// Setup  wiconnect serial interface configuration</span></div>
 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="comment">// Here we only specify the rx buffer size and not rx buffer pointer, this means</span></div>
 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="comment">// The serial RX buffer will be dynamically allocated</span></div>
-<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> serialConfig(WICONNECT_RX_PIN, WICONNECT_TX_PIN, WICONNECT_SERIAL_RX_BUFFER_SIZE, NULL);</div>
+<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> serialConfig(WICONNECT_RX_PIN, WICONNECT_TX_PIN, 256, NULL);</div>
 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <span class="comment">// Instantiate the Wiconnect library</span></div>
 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="comment">// Here we only specify the buffer size and not buffer pointer, this means</span></div>
 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="comment">// The internal buffer will be dynamically allocated</span></div>
-<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, WICONNECT_INTERNAL_BUFFER_SIZE, NULL, WICONNECT_RESET_PIN);</div>
+<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, 256, NULL, WICONNECT_RESET_PIN);</div>
 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    <span class="comment">//-------------------------------------------------------------------------</span></div>
@@ -226,11 +226,11 @@
 <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;    <span class="keywordflow">return</span> 0;</div>
 <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;}</div>
 <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;</div>
-<div class="ttc" id="classwiconnect_1_1_serial_config_html"><div class="ttname"><a href="classwiconnect_1_1_serial_config.html">wiconnect::SerialConfig</a></div><div class="ttdoc">Host<->Wiconnect Module serial configuration. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00108">sdk.h:108</a></div></div>
-<div class="ttc" id="group__api__network__types_html_ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067"><div class="ttname"><a href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067">wiconnect::NETWORK_STATUS_DOWN</a></div><div class="ttdoc">Not connected to network. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00193">WiconnectTypes.h:193</a></div></div>
-<div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a></div><div class="ttdoc">Command successfully completed. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00133">WiconnectTypes.h:133</a></div></div>
-<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00056">WiconnectInterface.h:56</a></div></div>
-<div class="ttc" id="group__api__network__types_html_gab448e57fc1a5e21cbba0283fd1a35d99"><div class="ttname"><a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></div><div class="ttdeci">NetworkStatus</div><div class="ttdoc">Network connection status. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00191">WiconnectTypes.h:191</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_serial_config_html"><div class="ttname"><a href="classwiconnect_1_1_serial_config.html">wiconnect::SerialConfig</a></div><div class="ttdoc">Host<->Wiconnect Module serial configuration. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00126">sdk.h:126</a></div></div>
+<div class="ttc" id="group__api__network__types_html_ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067"><div class="ttname"><a href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067">wiconnect::NETWORK_STATUS_DOWN</a></div><div class="ttdoc">Not connected to network. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00211">WiconnectTypes.h:211</a></div></div>
+<div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a></div><div class="ttdoc">Command successfully completed. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00151">WiconnectTypes.h:151</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00074">WiconnectInterface.h:74</a></div></div>
+<div class="ttc" id="group__api__network__types_html_gab448e57fc1a5e21cbba0283fd1a35d99"><div class="ttname"><a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></div><div class="ttdeci">NetworkStatus</div><div class="ttdoc">Network connection status. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00209">WiconnectTypes.h:209</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->