ACKme / WiConnect

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/mbed/html/ota_2example_8cpp-example.html

Revision:
34:2616445d0823
Child:
39:a963f69cb2de
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/mbed/html/ota_2example_8cpp-example.html	Wed Nov 26 23:46:00 2014 -0800
@@ -0,0 +1,236 @@
+<!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>&nbsp;</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>&nbsp;</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&#160;Overview</span></a></li>
+      <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><a href="annotated.html"><span>Classes</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><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;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('ota_2example_8cpp-example.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">&#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>
+
+<!-- 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">ota/example.cpp</div>  </div>
+</div><!--header-->
+<div class="contents">
+<p>This is an example of using the wiconnect API to update the wifi module's internal firmware to the latest version.</p>
+<p>It works as follows:</p><ol type="1">
+<li>Instantiate the WiConnect Library</li>
+<li>Initiate Communication with WiFi Module</li>
+<li>Join a network using the specified parameters</li>
+<li>Call the 'updateFirmware' wiconnect API and wait for the update to complete (takes ~60s)</li>
+<li>That's it!</li>
+</ol>
+<div class="fragment"><div class="line"></div>
+<div class="line"><span class="comment">/******************************************************************************</span></div>
+<div class="line"><span class="comment"> * Example Variables</span></div>
+<div class="line"><span class="comment"> */</span></div>
+<div class="line"></div>
+<div class="line"><span class="comment">// This is the name of your WiFi network</span></div>
+<div class="line"><span class="comment">// Look for this name in your WiFi settings</span></div>
+<div class="line"><span class="comment">// (e.g. your phone&#39;s list of WiFi networks in the WiFi settings menu)</span></div>
+<div class="line"><span class="comment">// tip: add double-quotes around SSID to add spaces to name</span></div>
+<div class="line"><span class="preprocessor">#define NETWORK_SSID &quot;\&quot;&lt;YOUR NETWORK NAME HERE&gt;\&quot;&quot;</span></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"><span class="comment">// This is the password of your WiFi network</span></div>
+<div class="line"><span class="comment">// Leave as empty string (e.g &quot;&quot;) to connect to OPEN network</span></div>
+<div class="line"><span class="preprocessor">#define NETWORK_PASSWORD &quot;\&quot;&lt;YOUR NETWORK PASSWORD HERE&gt;\&quot;&quot;</span></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"><span class="comment">/******************************************************************************</span></div>
+<div class="line"><span class="comment"> * Includes</span></div>
+<div class="line"><span class="comment"> */</span></div>
+<div class="line"></div>
+<div class="line"><span class="comment">// include C library headers</span></div>
+<div class="line"><span class="preprocessor">#include &lt;stdio.h&gt;</span> <span class="comment">// needed for printf</span></div>
+<div class="line"></div>
+<div class="line"><span class="comment">// include target specific defines</span></div>
+<div class="line"><span class="preprocessor">#include &quot;target_config.h&quot;</span></div>
+<div class="line"><span class="comment">// include the Wiconnect Host Library API header</span></div>
+<div class="line"><span class="preprocessor">#include &quot;Wiconnect.h&quot;</span></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"><span class="comment">/******************************************************************************</span></div>
+<div class="line"><span class="comment"> * Global Defines</span></div>
+<div class="line"><span class="comment"> */</span></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"><span class="comment">// Serial used for printfs to terminal (i.e. NOT used for WiConnect)</span></div>
+<div class="line"><span class="keyword">static</span> Serial consoleSerial(STDIO_UART_TX, STDIO_UART_RX);</div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line"><span class="comment">/******************************************************************************</span></div>
+<div class="line"><span class="comment"> * Starting point of application</span></div>
+<div class="line"><span class="comment"> */</span></div>
+<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div>
+<div class="line">{</div>
+<div class="line">    consoleSerial.baud(115200); <span class="comment">// console terminal to 115200 baud</span></div>
+<div class="line"></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line">    <span class="comment">// STEP 1: Instantiate WiConnect Library</span></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line"></div>
+<div class="line">    <span class="comment">// Setup  wiconnect serial interface configuration</span></div>
+<div class="line">    <span class="comment">// Here we only specify the rx buffer size and not rx buffer pointer, this means</span></div>
+<div class="line">    <span class="comment">// The serial RX buffer will be dynamically allocated</span></div>
+<div class="line">    SerialConfig serialConfig(WICONNECT_RX_PIN, WICONNECT_TX_PIN, 256, NULL);</div>
+<div class="line"></div>
+<div class="line">    <span class="comment">// Instantiate the Wiconnect library</span></div>
+<div class="line">    <span class="comment">// Here we only specify the buffer size and not buffer pointer, this means</span></div>
+<div class="line">    <span class="comment">// The internal buffer will be dynamically allocated</span></div>
+<div class="line">    Wiconnect wiconnect(serialConfig, 256, NULL, WICONNECT_RESET_PIN);</div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line">    <span class="comment">// STEP 2: Initiate Communication with WiFi Module</span></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line"></div>
+<div class="line">    printf(<span class="stringliteral">&quot;Initializing WiConnect Library...\r\n&quot;</span>);</div>
+<div class="line"></div>
+<div class="line">    <span class="comment">// Initialize communication with WiFi module</span></div>
+<div class="line">    <span class="keywordflow">if</span>(wiconnect.init(<span class="keyword">true</span>) != <a name="a0"></a><a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div>
+<div class="line">    {</div>
+<div class="line">        printf(<span class="stringliteral">&quot;Failed to initialize communication with WiFi module!\r\n&quot;</span></div>
+<div class="line">                <span class="stringliteral">&quot;Make sure the wires are connected correctly\r\n&quot;</span>);</div>
+<div class="line">        <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div>
+<div class="line">    }</div>
+<div class="line"></div>
+<div class="line"></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line">    <span class="comment">// STEP 3: Join a network using the specified parameters</span></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line"></div>
+<div class="line">    printf(<span class="stringliteral">&quot;Joining network: %s....\r\n&quot;</span>, NETWORK_SSID);</div>
+<div class="line"></div>
+<div class="line">    <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">    {</div>
+<div class="line">        printf(<span class="stringliteral">&quot;Failed to send join command\r\n&quot;</span>);</div>
+<div class="line">        <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div>
+<div class="line">    }</div>
+<div class="line"></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line">    <span class="comment">// STEP 4: Update the module&#39;s firmware, this takes about 60s</span></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line"></div>
+<div class="line">    printf(<span class="stringliteral">&quot;Updating WiFi module&#39;s internal firmware to latest...\r\n&quot;</span>);</div>
+<div class="line"></div>
+<div class="line">    <span class="keywordflow">if</span>(wiconnect.updateFirmware() != <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>)</div>
+<div class="line">    {</div>
+<div class="line">        printf(<span class="stringliteral">&quot;Failed to update the module&#39;s firmware\r\n&quot;</span>);</div>
+<div class="line">        <span class="keywordflow">for</span>(;;); <span class="comment">// infinite loop</span></div>
+<div class="line">    }</div>
+<div class="line"></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line">    <span class="comment">// STEP 5: Done!</span></div>
+<div class="line">    <span class="comment">//-------------------------------------------------------------------------</span></div>
+<div class="line"></div>
+<div class="line">    wiconnect.getVersion();</div>
+<div class="line">    printf(<span class="stringliteral">&quot;Version: %s\r\n&quot;</span>, wiconnect.getResponseBuffer());</div>
+<div class="line"></div>
+<div class="line">    <span class="keywordflow">while</span>(<span class="keyword">true</span>){} <span class="comment">// infinite loop</span></div>
+<div class="line">}</div>
+<div class="line"></div>
+</div><!-- fragment --> </div><!-- contents -->
+</div><!-- doc-content -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">&copy; ACKme Networks 2014</li>
+  </ul>
+</div>
+</body>
+</html>
\ No newline at end of file