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

Committer:
dan_ackme
Date:
Thu Oct 23 15:16:06 2014 -0700
Revision:
26:8067e3d463d3
Parent:
21:17bb3eddcbae
Child:
29:b6af04b77a56
Added 'updateFirmware' and 'networkGetJoinResult' api methods
Various bug fixes
Updated documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 14:85a2ed029f37 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 14:85a2ed029f37 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 14:85a2ed029f37 3 <head>
dan_ackme 14:85a2ed029f37 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 14:85a2ed029f37 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 14:85a2ed029f37 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 14:85a2ed029f37 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 14:85a2ed029f37 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 14:85a2ed029f37 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 14:85a2ed029f37 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 14:85a2ed029f37 15 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 16 $(document).ready(initResizable);
dan_ackme 14:85a2ed029f37 17 $(window).load(resizeHeight);
dan_ackme 14:85a2ed029f37 18 </script>
dan_ackme 14:85a2ed029f37 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 14:85a2ed029f37 21 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 14:85a2ed029f37 23 </script>
dan_ackme 14:85a2ed029f37 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 14:85a2ed029f37 25 </head>
dan_ackme 14:85a2ed029f37 26 <body>
dan_ackme 14:85a2ed029f37 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 14:85a2ed029f37 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 14:85a2ed029f37 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 14:85a2ed029f37 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 14:85a2ed029f37 32 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 14:85a2ed029f37 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 14:85a2ed029f37 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 14:85a2ed029f37 36 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 37 </tr>
dan_ackme 14:85a2ed029f37 38 <tr><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 39 </table>
dan_ackme 14:85a2ed029f37 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 14:85a2ed029f37 41 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 14:85a2ed029f37 43 </script>
dan_ackme 14:85a2ed029f37 44 <div id="navrow1" class="tabs">
dan_ackme 14:85a2ed029f37 45 <ul class="tablist">
dan_ackme 14:85a2ed029f37 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 14:85a2ed029f37 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 14:85a2ed029f37 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 14:85a2ed029f37 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 26:8067e3d463d3 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 14:85a2ed029f37 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 14:85a2ed029f37 52 <li>
dan_ackme 14:85a2ed029f37 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 14:85a2ed029f37 54 <span class="left">
dan_ackme 14:85a2ed029f37 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 14:85a2ed029f37 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 58 alt=""/>
dan_ackme 14:85a2ed029f37 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 14:85a2ed029f37 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 14:85a2ed029f37 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 14:85a2ed029f37 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 14:85a2ed029f37 63 </span><span class="right">
dan_ackme 14:85a2ed029f37 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 14:85a2ed029f37 65 </span>
dan_ackme 14:85a2ed029f37 66 </div>
dan_ackme 14:85a2ed029f37 67 </li>
dan_ackme 14:85a2ed029f37 68 </ul>
dan_ackme 14:85a2ed029f37 69 </div>
dan_ackme 14:85a2ed029f37 70 </div><!-- top -->
dan_ackme 14:85a2ed029f37 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 72 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 73 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 74 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 75 </div>
dan_ackme 14:85a2ed029f37 76 </div>
dan_ackme 14:85a2ed029f37 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 78 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 79 </div>
dan_ackme 14:85a2ed029f37 80 </div>
dan_ackme 14:85a2ed029f37 81 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 82 $(document).ready(function(){initNavTree('web__setup_2example_8cpp_source.html','');});
dan_ackme 14:85a2ed029f37 83 </script>
dan_ackme 14:85a2ed029f37 84 <div id="doc-content">
dan_ackme 14:85a2ed029f37 85 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 86 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 90 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 14:85a2ed029f37 91
dan_ackme 14:85a2ed029f37 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 93 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 95 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 96 </iframe>
dan_ackme 14:85a2ed029f37 97 </div>
dan_ackme 14:85a2ed029f37 98
dan_ackme 14:85a2ed029f37 99 <div class="header">
dan_ackme 14:85a2ed029f37 100 <div class="headertitle">
dan_ackme 14:85a2ed029f37 101 <div class="title">example.cpp</div> </div>
dan_ackme 14:85a2ed029f37 102 </div><!--header-->
dan_ackme 14:85a2ed029f37 103 <div class="contents">
dan_ackme 14:85a2ed029f37 104 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 14:85a2ed029f37 105 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">/******************************************************************************</span></div>
dan_ackme 14:85a2ed029f37 106 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * Example Variables</span></div>
dan_ackme 14:85a2ed029f37 107 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 108 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
dan_ackme 14:85a2ed029f37 109 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// This is the name of the WebSetup network</span></div>
dan_ackme 14:85a2ed029f37 110 <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>
dan_ackme 14:85a2ed029f37 111 <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>
dan_ackme 14:85a2ed029f37 112 <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>
dan_ackme 14:85a2ed029f37 113 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define WEB_SETUP_SSID &quot;\&quot;WiConnect WebSetup Example\&quot;&quot;</span></div>
dan_ackme 14:85a2ed029f37 114 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
dan_ackme 14:85a2ed029f37 115 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">// This is the password for the WebSetup network</span></div>
dan_ackme 14:85a2ed029f37 116 <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 create OPEN network</span></div>
dan_ackme 14:85a2ed029f37 117 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define WEB_SETUP_PASSWORD &quot;password&quot;</span></div>
dan_ackme 14:85a2ed029f37 118 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 14:85a2ed029f37 119 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
dan_ackme 14:85a2ed029f37 120 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
dan_ackme 14:85a2ed029f37 121 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
dan_ackme 14:85a2ed029f37 122 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">/******************************************************************************</span></div>
dan_ackme 14:85a2ed029f37 123 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"> * Includes</span></div>
dan_ackme 14:85a2ed029f37 124 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 125 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
dan_ackme 14:85a2ed029f37 126 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// include C library headers</span></div>
dan_ackme 14:85a2ed029f37 127 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span> <span class="comment">// needed for printf</span></div>
dan_ackme 14:85a2ed029f37 128 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
dan_ackme 14:85a2ed029f37 129 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">// include target specific defines</span></div>
dan_ackme 14:85a2ed029f37 130 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#include &quot;target_config.h&quot;</span></div>
dan_ackme 14:85a2ed029f37 131 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// include the Wiconnect Host Library API header</span></div>
dan_ackme 14:85a2ed029f37 132 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;Wiconnect.h&quot;</span></div>
dan_ackme 14:85a2ed029f37 133 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
dan_ackme 14:85a2ed029f37 134 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
dan_ackme 14:85a2ed029f37 135 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
dan_ackme 14:85a2ed029f37 136 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">/******************************************************************************</span></div>
dan_ackme 14:85a2ed029f37 137 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> * Local Functions</span></div>
dan_ackme 14:85a2ed029f37 138 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 139 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> webSetupCompleteCallback(<a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result, <span class="keywordtype">void</span> *arg1, <span class="keywordtype">void</span> *arg2);</div>
dan_ackme 14:85a2ed029f37 140 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
dan_ackme 14:85a2ed029f37 141 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
dan_ackme 14:85a2ed029f37 142 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">/******************************************************************************</span></div>
dan_ackme 14:85a2ed029f37 143 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> * Global Defines</span></div>
dan_ackme 14:85a2ed029f37 144 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 145 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
dan_ackme 14:85a2ed029f37 146 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
dan_ackme 14:85a2ed029f37 147 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment">// Serial used for printfs to terminal (i.e. NOT used for WiConnect)</span></div>
dan_ackme 14:85a2ed029f37 148 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">static</span> Serial consoleSerial(STDIO_UART_TX, STDIO_UART_RX);</div>
dan_ackme 14:85a2ed029f37 149 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
dan_ackme 14:85a2ed029f37 150 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment">// Buffer used internally by WiConnect library, note that this is optional</span></div>
dan_ackme 16:7f1d6d359787 151 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">static</span> uint8_t wiconnectInternalBuffer[256];</div>
dan_ackme 14:85a2ed029f37 152 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
dan_ackme 14:85a2ed029f37 153 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment">// Flag that indicate websetup has completed</span></div>
dan_ackme 14:85a2ed029f37 154 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="keyword">static</span> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> webSetupCompleteFlag = <span class="keyword">false</span>;</div>
dan_ackme 14:85a2ed029f37 155 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
dan_ackme 14:85a2ed029f37 156 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
dan_ackme 14:85a2ed029f37 157 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment">/******************************************************************************</span></div>
dan_ackme 14:85a2ed029f37 158 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> * Starting point of application</span></div>
dan_ackme 14:85a2ed029f37 159 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 160 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div>
dan_ackme 14:85a2ed029f37 161 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;{</div>
dan_ackme 14:85a2ed029f37 162 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; consoleSerial.baud(115200); <span class="comment">// console terminal to 115200 baud</span></div>
dan_ackme 14:85a2ed029f37 163 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
dan_ackme 14:85a2ed029f37 164 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 165 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// STEP 1: Instantiate WiConnect Library</span></div>
dan_ackme 14:85a2ed029f37 166 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 167 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
dan_ackme 14:85a2ed029f37 168 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">// Setup wiconnect serial interface configuration</span></div>
dan_ackme 14:85a2ed029f37 169 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="comment">// Here we only specify the rx buffer size and not rx buffer pointer, this means</span></div>
dan_ackme 14:85a2ed029f37 170 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// The serial RX buffer will be dynamically allocated</span></div>
dan_ackme 16:7f1d6d359787 171 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> serialConfig(WICONNECT_RX_PIN, WICONNECT_TX_PIN, 256, NULL);</div>
dan_ackme 14:85a2ed029f37 172 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
dan_ackme 14:85a2ed029f37 173 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="comment">// Instantiate the Wiconnect library</span></div>
dan_ackme 14:85a2ed029f37 174 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// Here we specify the buffer size AND buffer pointer, this means we&#39;re using static allocation</span></div>
dan_ackme 14:85a2ed029f37 175 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, <span class="keyword">sizeof</span>(wiconnectInternalBuffer), wiconnectInternalBuffer, WICONNECT_RESET_PIN);</div>
dan_ackme 14:85a2ed029f37 176 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
dan_ackme 14:85a2ed029f37 177 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
dan_ackme 14:85a2ed029f37 178 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 179 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">// STEP 2: Initiate Communication with WiFi Module</span></div>
dan_ackme 14:85a2ed029f37 180 <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 181 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
dan_ackme 14:85a2ed029f37 182 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; printf(<span class="stringliteral">&quot;Initializing WiConnect Library...\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 183 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
dan_ackme 14:85a2ed029f37 184 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// Initialize communication with WiFi module</span></div>
dan_ackme 14:85a2ed029f37 185 <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <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>
dan_ackme 14:85a2ed029f37 186 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {</div>
dan_ackme 14:85a2ed029f37 187 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; printf(<span class="stringliteral">&quot;Failed to initialize communication with WiFi module!\r\n&quot;</span></div>
dan_ackme 14:85a2ed029f37 188 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="stringliteral">&quot;Make sure the wires are connected correctly\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 189 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div>
dan_ackme 14:85a2ed029f37 190 <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
dan_ackme 14:85a2ed029f37 191 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
dan_ackme 14:85a2ed029f37 192 <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div>
dan_ackme 14:85a2ed029f37 193 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 194 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="comment">// STEP 3: Start WebSetup with specified parameters</span></div>
dan_ackme 14:85a2ed029f37 195 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 196 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
dan_ackme 14:85a2ed029f37 197 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; printf(<span class="stringliteral">&quot;Starting Websetup...\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 198 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
dan_ackme 14:85a2ed029f37 199 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="comment">// Start web setup</span></div>
dan_ackme 14:85a2ed029f37 200 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">if</span>(wiconnect.startWebSetup(WEB_SETUP_SSID, WEB_SETUP_PASSWORD, <a class="code" href="classwiconnect_1_1_callback.html">Callback</a>(webSetupCompleteCallback)) != <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div>
dan_ackme 14:85a2ed029f37 201 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; {</div>
dan_ackme 14:85a2ed029f37 202 <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; printf(<span class="stringliteral">&quot;Failed to start web setup\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 203 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div>
dan_ackme 14:85a2ed029f37 204 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; }</div>
dan_ackme 14:85a2ed029f37 205 <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div>
dan_ackme 14:85a2ed029f37 206 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 207 <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// STEP 4: Wait for web setup webpage to complete</span></div>
dan_ackme 14:85a2ed029f37 208 <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 209 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
dan_ackme 14:85a2ed029f37 210 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; printf(<span class="stringliteral">&quot;Web setup has started.\r\n\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 211 <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; printf(<span class="stringliteral">&quot;1. Using your phone (or PC, Mac, Linux, etc.)\r\n connect to the WiFi network: %s\r\n&quot;</span>, WEB_SETUP_SSID);</div>
dan_ackme 14:85a2ed029f37 212 <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; printf(<span class="stringliteral">&quot;2. The password is: %s\r\n&quot;</span>, WEB_SETUP_PASSWORD);</div>
dan_ackme 14:85a2ed029f37 213 <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; printf(<span class="stringliteral">&quot;3. Once connected, open your browser and enter the URL: http://setup.com\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 214 <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; printf(<span class="stringliteral">&quot;4. This will bringup a setup page, enter your router&#39;s credentials.\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 215 <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; printf(<span class="stringliteral">&quot;5. Click the &#39;Save &amp; Exit&#39; button at the bottom of the webpage\r\n\r\n&quot;</span>);</div>
dan_ackme 14:85a2ed029f37 216 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
dan_ackme 14:85a2ed029f37 217 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordflow">while</span>(!webSetupCompleteFlag)</div>
dan_ackme 14:85a2ed029f37 218 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; {</div>
dan_ackme 14:85a2ed029f37 219 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="comment">// do nothing while we wait</span></div>
dan_ackme 14:85a2ed029f37 220 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="comment">// When the user exits web setup from the webpage</span></div>
dan_ackme 14:85a2ed029f37 221 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="comment">// webSetupCompleteCallback() will execute and set webSetupCompleteFlag TRUE</span></div>
dan_ackme 14:85a2ed029f37 222 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; }</div>
dan_ackme 14:85a2ed029f37 223 <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div>
dan_ackme 14:85a2ed029f37 224 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 225 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="comment">// STEP 5: Done!</span></div>
dan_ackme 14:85a2ed029f37 226 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="comment">//-------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 227 <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div>
dan_ackme 21:17bb3eddcbae 228 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; printf(<span class="stringliteral">&quot;IP Address: %s\r\n&quot;</span>, wiconnect.getIpAddress());</div>
dan_ackme 21:17bb3eddcbae 229 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; printf(<span class="stringliteral">&quot;Web setup example has completed!\r\n&quot;</span>);</div>
dan_ackme 21:17bb3eddcbae 230 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div>
dan_ackme 21:17bb3eddcbae 231 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keywordflow">while</span>(<span class="keyword">true</span>){} <span class="comment">// infinite loop</span></div>
dan_ackme 21:17bb3eddcbae 232 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;}</div>
dan_ackme 21:17bb3eddcbae 233 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;</div>
dan_ackme 14:85a2ed029f37 234 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;</div>
dan_ackme 21:17bb3eddcbae 235 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment">// this function is called when web setup completes</span></div>
dan_ackme 21:17bb3eddcbae 236 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="comment">// it is called in the background</span></div>
dan_ackme 21:17bb3eddcbae 237 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> webSetupCompleteCallback(<a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result, <span class="keywordtype">void</span> *arg1, <span class="keywordtype">void</span> *arg2)</div>
dan_ackme 21:17bb3eddcbae 238 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;{</div>
dan_ackme 21:17bb3eddcbae 239 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; webSetupCompleteFlag = <span class="keyword">true</span>;</div>
dan_ackme 21:17bb3eddcbae 240 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;}</div>
dan_ackme 26:8067e3d463d3 241 <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#l00159">WiconnectTypes.h:159</a></div></div>
dan_ackme 16:7f1d6d359787 242 <div class="ttc" id="classwiconnect_1_1_callback_html"><div class="ttname"><a href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></div><div class="ttdoc">Generic callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_callback_8h_source.html#l00049">Callback.h:49</a></div></div>
dan_ackme 17:7268f365676b 243 <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>
dan_ackme 26:8067e3d463d3 244 <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#l00165">WiconnectTypes.h:165</a></div></div>
dan_ackme 16:7f1d6d359787 245 <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>
dan_ackme 14:85a2ed029f37 246 </div><!-- fragment --></div><!-- contents -->
dan_ackme 14:85a2ed029f37 247 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 248 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 249 <ul>
dan_ackme 14:85a2ed029f37 250 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 251 </ul>
dan_ackme 14:85a2ed029f37 252 </div>
dan_ackme 14:85a2ed029f37 253 </body>
dan_ackme 14:85a2ed029f37 254 </html>