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
Diff: doc/html/join_2example_8cpp_source.html
- Revision:
- 21:17bb3eddcbae
- Parent:
- 17:7268f365676b
- Child:
- 26:8067e3d463d3
--- a/doc/html/join_2example_8cpp_source.html Sat Aug 23 05:57:52 2014 -0700 +++ b/doc/html/join_2example_8cpp_source.html Tue Aug 26 16:38:19 2014 -0700 @@ -149,68 +149,63 @@ <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div> -<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> networkStatus;</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  consoleSerial.baud(115200); <span class="comment">// console terminal to 115200 baud</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> -<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> -<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  consoleSerial.baud(115200); <span class="comment">// console terminal to 115200 baud</span></div> -<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> -<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// STEP 1: Instantiate WiConnect Library</span></div> -<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> -<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// Setup wiconnect serial interface configuration</span></div> -<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <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="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// The serial RX buffer will be dynamically allocated</span></div> -<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <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="l00077"></a><span class="lineno"> 77</span> </div> -<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// Instantiate the Wiconnect library</span></div> -<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Here we only specify the buffer size and not buffer pointer, this means</span></div> -<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// The internal buffer will be dynamically allocated</span></div> -<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, 256, NULL, WICONNECT_RESET_PIN);</div> -<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> -<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> -<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// STEP 2: Initiate Communication with WiFi Module</span></div> -<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> -<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  printf(<span class="stringliteral">"Initializing WiConnect Library...\r\n"</span>);</div> -<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> -<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// Initialize communication with WiFi module</span></div> -<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">if</span>(wiconnect.init(<span class="keyword">true</span>) != <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div> -<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div> -<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  printf(<span class="stringliteral">"Failed to initialize communication with WiFi module!\r\n"</span></div> -<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="stringliteral">"Make sure the wires are connected correctly\r\n"</span>);</div> -<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div> -<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div> -<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> -<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div> -<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// STEP 3: Join a network using the specified parameters</span></div> -<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> -<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  printf(<span class="stringliteral">"Joining network: %s....\r\n"</span>, NETWORK_SSID);</div> -<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> -<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">if</span>(wiconnect.join(NETWORK_SSID, NETWORK_PASSWORD) != <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div> -<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  {</div> -<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  printf(<span class="stringliteral">"Failed to send join command\r\n"</span>);</div> -<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div> -<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  }</div> -<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> -<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// STEP 4: Done!</span></div> -<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// STEP 1: Instantiate WiConnect Library</span></div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Setup wiconnect serial interface configuration</span></div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <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="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// The serial RX buffer will be dynamically allocated</span></div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <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="l00074"></a><span class="lineno"> 74</span> </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// Instantiate the Wiconnect library</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Here we only specify the buffer size and not buffer pointer, this means</span></div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// The internal buffer will be dynamically allocated</span></div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, 256, NULL, WICONNECT_RESET_PIN);</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// STEP 2: Initiate Communication with WiFi Module</span></div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  printf(<span class="stringliteral">"Initializing WiConnect Library...\r\n"</span>);</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// Initialize communication with WiFi module</span></div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">if</span>(wiconnect.init(<span class="keyword">true</span>) != <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  {</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  printf(<span class="stringliteral">"Failed to initialize communication with WiFi module!\r\n"</span></div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="stringliteral">"Make sure the wires are connected correctly\r\n"</span>);</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// STEP 3: Join a network using the specified parameters</span></div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  printf(<span class="stringliteral">"Joining network: %s....\r\n"</span>, NETWORK_SSID);</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">if</span>(wiconnect.join(NETWORK_SSID, NETWORK_PASSWORD) != <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  {</div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  printf(<span class="stringliteral">"Failed to send join command\r\n"</span>);</div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">// STEP 4: Done!</span></div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">//-------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  printf(<span class="stringliteral">"IP Address: %s\r\n"</span>, wiconnect.getIpAddress());</div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  printf(<span class="stringliteral">"Network join example has completed!\r\n"</span>);</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> -<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  printf(<span class="stringliteral">"Network join example has completed!\r\n"</span>);</div> -<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> -<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div> -<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> -<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">return</span> 0;</div> -<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div> -<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">while</span>(<span class="keyword">true</span>){} <span class="comment">// infinite loop</span></div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> }</div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </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#l00129">sdk.h:129</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#l00152">WiconnectTypes.h:152</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#l00161">WiconnectTypes.h:161</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#l00210">WiconnectTypes.h:210</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->