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:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
34:2616445d0823
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 34:2616445d0823 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 34:2616445d0823 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 34:2616445d0823 3 <head>
dan_ackme 34:2616445d0823 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 34:2616445d0823 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 34:2616445d0823 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 34:2616445d0823 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 34:2616445d0823 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 34:2616445d0823 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 34:2616445d0823 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 34:2616445d0823 15 <script type="text/javascript">
dan_ackme 34:2616445d0823 16 $(document).ready(initResizable);
dan_ackme 34:2616445d0823 17 $(window).load(resizeHeight);
dan_ackme 34:2616445d0823 18 </script>
dan_ackme 34:2616445d0823 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 34:2616445d0823 21 <script type="text/javascript">
dan_ackme 34:2616445d0823 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 34:2616445d0823 23 </script>
dan_ackme 34:2616445d0823 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 34:2616445d0823 25 </head>
dan_ackme 34:2616445d0823 26 <body>
dan_ackme 34:2616445d0823 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 34:2616445d0823 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 34:2616445d0823 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 34:2616445d0823 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 34:2616445d0823 32 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 34:2616445d0823 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 34:2616445d0823 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 34:2616445d0823 36 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 37 </tr>
dan_ackme 34:2616445d0823 38 <tr><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 39 </table>
dan_ackme 34:2616445d0823 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 34:2616445d0823 41 <script type="text/javascript">
dan_ackme 34:2616445d0823 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 34:2616445d0823 43 </script>
dan_ackme 34:2616445d0823 44 <div id="navrow1" class="tabs">
dan_ackme 34:2616445d0823 45 <ul class="tablist">
dan_ackme 34:2616445d0823 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 34:2616445d0823 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 34:2616445d0823 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 34:2616445d0823 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 34:2616445d0823 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 34:2616445d0823 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 34:2616445d0823 52 <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
dan_ackme 34:2616445d0823 53 <li>
dan_ackme 34:2616445d0823 54 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 34:2616445d0823 55 <span class="left">
dan_ackme 34:2616445d0823 56 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 34:2616445d0823 57 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 58 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 59 alt=""/>
dan_ackme 34:2616445d0823 60 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 34:2616445d0823 61 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 34:2616445d0823 62 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 34:2616445d0823 63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 34:2616445d0823 64 </span><span class="right">
dan_ackme 34:2616445d0823 65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 34:2616445d0823 66 </span>
dan_ackme 34:2616445d0823 67 </div>
dan_ackme 34:2616445d0823 68 </li>
dan_ackme 34:2616445d0823 69 </ul>
dan_ackme 34:2616445d0823 70 </div>
dan_ackme 34:2616445d0823 71 </div><!-- top -->
dan_ackme 34:2616445d0823 72 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 73 <div id="nav-tree">
dan_ackme 34:2616445d0823 74 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 75 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 76 </div>
dan_ackme 34:2616445d0823 77 </div>
dan_ackme 34:2616445d0823 78 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 79 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 80 </div>
dan_ackme 34:2616445d0823 81 </div>
dan_ackme 34:2616445d0823 82 <script type="text/javascript">
dan_ackme 34:2616445d0823 83 $(document).ready(function(){initNavTree('target__config_8h_source.html','');});
dan_ackme 34:2616445d0823 84 </script>
dan_ackme 34:2616445d0823 85 <div id="doc-content">
dan_ackme 34:2616445d0823 86 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 87 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 88 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 89 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 90 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 91 <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 34:2616445d0823 92
dan_ackme 34:2616445d0823 93 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 94 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 95 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 96 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 97 </iframe>
dan_ackme 34:2616445d0823 98 </div>
dan_ackme 34:2616445d0823 99
dan_ackme 34:2616445d0823 100 <div class="header">
dan_ackme 34:2616445d0823 101 <div class="headertitle">
dan_ackme 34:2616445d0823 102 <div class="title">target_config.h</div> </div>
dan_ackme 34:2616445d0823 103 </div><!--header-->
dan_ackme 34:2616445d0823 104 <div class="contents">
dan_ackme 34:2616445d0823 105 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 34:2616445d0823 106 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 34:2616445d0823 107 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
dan_ackme 34:2616445d0823 108 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 34:2616445d0823 109 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// The BAUD rate your PC/MAC/Linux terminal uses with the eval board</span></div>
dan_ackme 34:2616445d0823 110 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define CONSOLE_BAUD 115200</span></div>
dan_ackme 34:2616445d0823 111 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
dan_ackme 34:2616445d0823 112 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
dan_ackme 34:2616445d0823 113 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// Uncomment this to enable WiConnect serial interface hardware flow control</span></div>
dan_ackme 34:2616445d0823 114 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">// NOTE: your platform must support the serial flow control api functions</span></div>
dan_ackme 34:2616445d0823 115 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment">//#define ENABLE_FLOW_CONTROL</span></div>
dan_ackme 34:2616445d0823 116 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
dan_ackme 34:2616445d0823 117 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
dan_ackme 34:2616445d0823 118 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define WICONNECT_INTERNAL_BUFFER_SIZE (4*1024)</span></div>
dan_ackme 34:2616445d0823 119 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define WICONNECT_SERIAL_RX_BUFFER_SIZE (4*1024)</span></div>
dan_ackme 34:2616445d0823 120 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
dan_ackme 34:2616445d0823 121 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#define DEFAULT_CMD_GETCHAR_TIMEOUT 250</span></div>
dan_ackme 34:2616445d0823 122 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#define DEFAULT_COMMAND_LINE_LENGTH_MAX 128</span></div>
dan_ackme 34:2616445d0823 123 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define DEFAULT_COMMAND_MAX_HISTORY 16</span></div>
dan_ackme 34:2616445d0823 124 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define DEFAULT_CMD_PROMPT_STR &quot;&gt; &quot;</span></div>
dan_ackme 34:2616445d0823 125 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define DEFAULT_COMMAND_MAX_ARGV 16</span></div>
dan_ackme 34:2616445d0823 126 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
dan_ackme 34:2616445d0823 127 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define TEST_NONBLOCKING_API false</span></div>
dan_ackme 34:2616445d0823 128 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#define TEST_BUFFER_LENGTH 4*1024</span></div>
dan_ackme 34:2616445d0823 129 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
dan_ackme 34:2616445d0823 130 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
dan_ackme 34:2616445d0823 131 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment">//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</span></div>
dan_ackme 34:2616445d0823 132 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">// Seabass Target Configuration</span></div>
dan_ackme 34:2616445d0823 133 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#ifdef TARGET_SEABASS</span></div>
dan_ackme 34:2616445d0823 134 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
dan_ackme 34:2616445d0823 135 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#define WICONNECT_TX_PIN PA_9</span></div>
dan_ackme 34:2616445d0823 136 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#define WICONNECT_RX_PIN PA_10</span></div>
dan_ackme 34:2616445d0823 137 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#define WICONNECT_RESET_PIN PB_0</span></div>
dan_ackme 34:2616445d0823 138 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#define WICONNECT_WAKE_PIN NC</span></div>
dan_ackme 34:2616445d0823 139 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
dan_ackme 34:2616445d0823 140 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#ifdef ENABLE_FLOW_CONTROL</span></div>
dan_ackme 34:2616445d0823 141 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#define WICONNECT_CTS_PIN PA_11</span></div>
dan_ackme 34:2616445d0823 142 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#define WICONNECT_RTS_PIN PA_12</span></div>
dan_ackme 34:2616445d0823 143 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#else</span></div>
dan_ackme 34:2616445d0823 144 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#define WICONNECT_CTS_PIN NC</span></div>
dan_ackme 34:2616445d0823 145 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#define WICONNECT_RTS_PIN NC</span></div>
dan_ackme 34:2616445d0823 146 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif</span></div>
dan_ackme 34:2616445d0823 147 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
dan_ackme 34:2616445d0823 148 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif</span></div>
dan_ackme 34:2616445d0823 149 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
dan_ackme 34:2616445d0823 150 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
dan_ackme 34:2616445d0823 151 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment">//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</span></div>
dan_ackme 34:2616445d0823 152 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment">// Nucleo F401RE Target Configuration</span></div>
dan_ackme 34:2616445d0823 153 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#ifdef TARGET_NUCLEO_F401RE</span></div>
dan_ackme 34:2616445d0823 154 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
dan_ackme 34:2616445d0823 155 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#define WICONNECT_TX_PIN PA_9</span></div>
dan_ackme 34:2616445d0823 156 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#define WICONNECT_RX_PIN PA_10</span></div>
dan_ackme 34:2616445d0823 157 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#define WICONNECT_RESET_PIN PC_7</span></div>
dan_ackme 34:2616445d0823 158 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#define WICONNECT_WAKE_PIN NC</span></div>
dan_ackme 34:2616445d0823 159 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
dan_ackme 34:2616445d0823 160 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#ifdef ENABLE_FLOW_CONTROL</span></div>
dan_ackme 34:2616445d0823 161 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="preprocessor">#define WICONNECT_CTS_PIN PA_11</span></div>
dan_ackme 34:2616445d0823 162 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#define WICONNECT_RTS_PIN PA_12</span></div>
dan_ackme 34:2616445d0823 163 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#else</span></div>
dan_ackme 34:2616445d0823 164 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#define WICONNECT_CTS_PIN NC</span></div>
dan_ackme 34:2616445d0823 165 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#define WICONNECT_RTS_PIN NC</span></div>
dan_ackme 34:2616445d0823 166 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif</span></div>
dan_ackme 34:2616445d0823 167 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
dan_ackme 34:2616445d0823 168 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="preprocessor">#endif</span></div>
dan_ackme 34:2616445d0823 169 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div>
dan_ackme 34:2616445d0823 170 </div><!-- fragment --></div><!-- contents -->
dan_ackme 34:2616445d0823 171 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 172 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 173 <ul>
dan_ackme 34:2616445d0823 174 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 175 </ul>
dan_ackme 34:2616445d0823 176 </div>
dan_ackme 34:2616445d0823 177 </body>
dan_ackme 34:2616445d0823 178 </html>