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/mbed/html/join_2example_8cpp_source.html
- Committer:
- dan_ackme
- Date:
- 2015-02-23
- Revision:
- 39:a963f69cb2de
- Parent:
- 34:2616445d0823
File content as of revision 39:a963f69cb2de:
<!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"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<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" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- 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>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect Repository</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('join_2example_8cpp_source.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="headertitle">
<div class="title">example.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/******************************************************************************</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Example Variables</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// This is the name of your WiFi network</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// Look for this name in your WiFi settings</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// (e.g. your phone's list of WiFi networks in the WiFi settings menu)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// tip: add double-quotes around SSID to add spaces to name</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define NETWORK_SSID "\"<YOUR NETWORK NAME HERE>\""</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// This is the password of your WiFi network</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Leave as empty string (e.g "") to connect to OPEN network</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define NETWORK_PASSWORD "\"<YOUR NETWORK PASSWORD HERE>\""</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/******************************************************************************</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * Includes</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// include C library headers</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <stdio.h></span> <span class="comment">// needed for printf</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// include target specific defines</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "target_config.h"</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// include the Wiconnect Host Library API header</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include "Wiconnect.h"</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/******************************************************************************</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * Global Defines</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Serial used for printfs to terminal (i.e. NOT used for WiConnect)</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static</span> Serial consoleSerial(STDIO_UART_TX, STDIO_UART_RX);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/******************************************************************************</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * Starting point of application</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</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="l00059"></a><span class="lineno"> 59</span> {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  consoleSerial.baud(115200); <span class="comment">// console terminal to 115200 baud</span></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>  <span class="comment">//-------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// STEP 1: Instantiate WiConnect Library</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> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Setup wiconnect serial interface configuration</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</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="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// The serial RX buffer will be dynamically allocated</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</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="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// Instantiate the Wiconnect library</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// Here we only specify the buffer size and not buffer pointer, this means</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// The internal 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_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, 256, NULL, WICONNECT_RESET_PIN);</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">//-------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// STEP 2: Initiate Communication with WiFi Module</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">//-------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  printf(<span class="stringliteral">"Initializing WiConnect Library...\r\n"</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">// Initialize communication with WiFi module</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span>(<a class="code" href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a>(result, wiconnect.init(<span class="keyword">true</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="keywordflow">if</span>(result == <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e">WICONNECT_FIRMWARE_OUTDATED</a>)</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  printf(<span class="stringliteral">"** The WiFi firmware is not supported. Run the ota example to update the firmware:\r\n"</span>);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  printf(<span class="stringliteral">"https://developer.mbed.org/teams/ACKme/code/wiconnect-ota_example\r\n\r\n"</span>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">else</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>  printf(<span class="stringliteral">"Failed to initialize communication with WiFi module!\r\n"</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="stringliteral">"Make sure the wires are connected correctly\r\n"</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>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</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> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</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>  <span class="comment">// STEP 3: Join a network using the specified parameters</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">//-------------------------------------------------------------------------</span></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>  printf(<span class="stringliteral">"Joining network: %s....\r\n"</span>, NETWORK_SSID);</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>  <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="l00108"></a><span class="lineno"> 108</span>  {</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  printf(<span class="stringliteral">"Failed to send join command\r\n"</span>);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</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> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">//-------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">// STEP 4: Done!</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">//-------------------------------------------------------------------------</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>  printf(<span class="stringliteral">"IP Address: %s\r\n"</span>, wiconnect.getIpAddress());</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  printf(<span class="stringliteral">"Network join example has completed!\r\n"</span>);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">while</span>(<span class="keyword">true</span>){} <span class="comment">// infinite loop</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00166">WiconnectTypes.h:166</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#l00148">sdk.h:148</a></div></div>
<div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e">wiconnect::WICONNECT_FIRMWARE_OUTDATED</a></div><div class="ttdoc">The WiFi module's firmware is out-dated. See updateFirmware() to update the firmware. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00194">WiconnectTypes.h:194</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#l00172">WiconnectTypes.h:172</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#l00078">WiconnectInterface.h:78</a></div></div>
<div class="ttc" id="group__api__core__macro_html_gab27aa3ef76302b5221766abfd4f47e64"><div class="ttname"><a href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a></div><div class="ttdeci">#define WICONNECT_FAILED(result, func)</div><div class="ttdoc">Populates result with return value from func, returns TRUE if return value contains error...</div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00093">WiconnectTypes.h:93</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</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