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

doc/html/sdk_8h_source.html@26:8067e3d463d3, 2014-10-23 (annotated)

Committer:
dan_ackme
Date:
Thu Oct 23 15:16:06 2014 -0700
Revision:
26:8067e3d463d3
Parent:
17:7268f365676b
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('sdk_8h_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">sdk.h</div> </div>
dan_ackme 14:85a2ed029f37 102 </div><!--header-->
dan_ackme 14:85a2ed029f37 103 <div class="contents">
dan_ackme 16:7f1d6d359787 104 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 16:7f1d6d359787 105 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 16:7f1d6d359787 106 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
dan_ackme 14:85a2ed029f37 107 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 16:7f1d6d359787 108 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define MBED_SDK</span></div>
dan_ackme 16:7f1d6d359787 109 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
dan_ackme 16:7f1d6d359787 110 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;mbed.h&quot;</span></div>
dan_ackme 16:7f1d6d359787 111 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
dan_ackme 17:7268f365676b 112 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
dan_ackme 17:7268f365676b 113 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
dan_ackme 16:7f1d6d359787 114 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
dan_ackme 17:7268f365676b 115 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
dan_ackme 17:7268f365676b 116 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;{</div>
dan_ackme 17:7268f365676b 117 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
dan_ackme 17:7268f365676b 118 <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#gad466ede4f07512308e38402d777d8380"> 46</a></span>&#160;<span class="preprocessor">#define WICONNECT_ASYNC_TIMER_ENABLED</span></div>
dan_ackme 17:7268f365676b 119 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
dan_ackme 17:7268f365676b 120 <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#gae9cf1249b46e784aa05250e2bcbe2e02"> 51</a></span>&#160;<span class="preprocessor">#define WICONNECT_ENABLE_MALLOC</span></div>
dan_ackme 17:7268f365676b 121 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
dan_ackme 17:7268f365676b 122 <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga53fde64c3e7647a192281a015cd02f48"> 56</a></span>&#160;<span class="preprocessor">#define WICONNECT_SERIAL_RX_BUFFER</span></div>
dan_ackme 17:7268f365676b 123 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
dan_ackme 17:7268f365676b 124 <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#gae7b6cfdff3a9aef465d5c4434937417d"> 61</a></span>&#160;<span class="preprocessor">#define WICONNECT_USE_DEFAULT_STRING_BUFFERS</span></div>
dan_ackme 17:7268f365676b 125 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
dan_ackme 17:7268f365676b 126 <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#gaaff0108d684631b2bb88e1f6c255e9ac"> 67</a></span>&#160;<span class="preprocessor">#define WICONNECT_DEFAULT_MALLOC malloc</span></div>
dan_ackme 17:7268f365676b 127 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
dan_ackme 17:7268f365676b 128 <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga0a14e4bc7a0aed9311b552c0ee8fd7ef"> 72</a></span>&#160;<span class="preprocessor">#define WICONNECT_DEFAULT_FREE free</span></div>
dan_ackme 17:7268f365676b 129 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
dan_ackme 17:7268f365676b 130 <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga2e7ffaac225bc56852bb504f531aafa0"> 78</a></span>&#160;<span class="preprocessor">#define WICONNECT_DEFAULT_BAUD 115200</span></div>
dan_ackme 17:7268f365676b 131 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
dan_ackme 17:7268f365676b 132 <div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga7741b7a0fbbf9b7e47898b7d30e5e321"> 83</a></span>&#160;<span class="preprocessor">#define WICONNECT_DEFAULT_TIMEOUT 3000 // ms</span></div>
dan_ackme 17:7268f365676b 133 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
dan_ackme 17:7268f365676b 134 <div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f"> 88</a></span>&#160;<span class="preprocessor">#define WICONNECT_MAX_QUEUED_COMMANDS 8</span></div>
dan_ackme 17:7268f365676b 135 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
dan_ackme 17:7268f365676b 136 <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga9e7032540d999edf0dbae31e51c85962"> 93</a></span>&#160;<span class="preprocessor">#define WICONNECT_DEFAULT_COMMAND_PROCESSING_PERIOD 50 // ms</span></div>
dan_ackme 17:7268f365676b 137 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
dan_ackme 17:7268f365676b 138 <div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga347d0e1228e8174563c6bcf48de18401"> 99</a></span>&#160;<span class="preprocessor">#define WICONNECT_DEFAULT_NONBLOCKING false</span></div>
dan_ackme 17:7268f365676b 139 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
dan_ackme 16:7f1d6d359787 140 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div>
dan_ackme 17:7268f365676b 141 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div>
dan_ackme 17:7268f365676b 142 <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment">// ----------------------------------------------------------------------------</span></div>
dan_ackme 17:7268f365676b 143 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
dan_ackme 17:7268f365676b 144 <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="preprocessor">#define WICONNECT_GPIO_BASE_CLASS : DigitalOut</span></div>
dan_ackme 17:7268f365676b 145 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="preprocessor">#define WICONNECT_SERIAL_BASE_CLASS : RawSerial</span></div>
dan_ackme 17:7268f365676b 146 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="preprocessor">#define WICONNECT_PERIODIC_TIMER_BASE_CLASS : Ticker</span></div>
dan_ackme 17:7268f365676b 147 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="preprocessor">#define WICONNECT_EXTERNAL_INTERRUPT_GPIO_BASE_CLASS : InterruptIn</span></div>
dan_ackme 16:7f1d6d359787 148 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
dan_ackme 17:7268f365676b 149 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="preprocessor">#define WICONNECT_MAX_PIN_IRQ_HANDLERS 3</span></div>
dan_ackme 17:7268f365676b 150 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
dan_ackme 17:7268f365676b 151 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div>
dan_ackme 17:7268f365676b 152 <div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270"> 117</a></span>&#160;<span class="preprocessor">#define PIN_NC NC</span></div>
dan_ackme 17:7268f365676b 153 <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div>
dan_ackme 17:7268f365676b 154 <div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c"> 123</a></span>&#160;<span class="keyword">typedef</span> PinName <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a>;</div>
dan_ackme 17:7268f365676b 155 <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div>
dan_ackme 17:7268f365676b 156 <div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_serial_config.html"> 129</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a></div>
dan_ackme 17:7268f365676b 157 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;{</div>
dan_ackme 17:7268f365676b 158 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 17:7268f365676b 159 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> rx;</div>
dan_ackme 17:7268f365676b 160 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> tx;</div>
dan_ackme 17:7268f365676b 161 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> cts;</div>
dan_ackme 17:7268f365676b 162 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> rts;</div>
dan_ackme 17:7268f365676b 163 <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordtype">int</span> baud;</div>
dan_ackme 17:7268f365676b 164 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">void</span> *serialRxBuffer;</div>
dan_ackme 17:7268f365676b 165 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordtype">int</span> serialRxBufferSize;</div>
dan_ackme 17:7268f365676b 166 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div>
dan_ackme 17:7268f365676b 167 <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> rx, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> tx, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> cts, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> rts, <span class="keywordtype">int</span> baud, <span class="keywordtype">int</span> serialRxBufferSize, <span class="keywordtype">void</span> *serialRxBuffer = NULL)</div>
dan_ackme 17:7268f365676b 168 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; {</div>
dan_ackme 17:7268f365676b 169 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; this-&gt;rx =rx;</div>
dan_ackme 17:7268f365676b 170 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; this-&gt;tx =tx;</div>
dan_ackme 17:7268f365676b 171 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; this-&gt;cts =cts;</div>
dan_ackme 17:7268f365676b 172 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; this-&gt;rts =rts;</div>
dan_ackme 17:7268f365676b 173 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; this-&gt;baud = baud;</div>
dan_ackme 17:7268f365676b 174 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; this-&gt;serialRxBuffer =serialRxBuffer;</div>
dan_ackme 17:7268f365676b 175 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; this-&gt;serialRxBufferSize =serialRxBufferSize;</div>
dan_ackme 17:7268f365676b 176 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; }</div>
dan_ackme 17:7268f365676b 177 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div>
dan_ackme 17:7268f365676b 178 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> rx, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> tx, <span class="keywordtype">int</span> serialRxBufferSize, <span class="keywordtype">void</span> *serialRxBuffer = NULL)</div>
dan_ackme 17:7268f365676b 179 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; {</div>
dan_ackme 17:7268f365676b 180 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; this-&gt;rx =rx;</div>
dan_ackme 17:7268f365676b 181 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; this-&gt;tx =tx;</div>
dan_ackme 17:7268f365676b 182 <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; this-&gt;cts = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>;</div>
dan_ackme 17:7268f365676b 183 <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; this-&gt;rts = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>;</div>
dan_ackme 17:7268f365676b 184 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; this-&gt;baud = <a class="code" href="group__api__core__macro.html#ga2e7ffaac225bc56852bb504f531aafa0">WICONNECT_DEFAULT_BAUD</a>;</div>
dan_ackme 17:7268f365676b 185 <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; this-&gt;serialRxBuffer =serialRxBuffer;</div>
dan_ackme 17:7268f365676b 186 <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; this-&gt;serialRxBufferSize =serialRxBufferSize;</div>
dan_ackme 17:7268f365676b 187 <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; }</div>
dan_ackme 17:7268f365676b 188 <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;</div>
dan_ackme 17:7268f365676b 189 <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> rx, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> tx)</div>
dan_ackme 17:7268f365676b 190 <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; {</div>
dan_ackme 17:7268f365676b 191 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; this-&gt;rx =rx;</div>
dan_ackme 17:7268f365676b 192 <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; this-&gt;tx =tx;</div>
dan_ackme 17:7268f365676b 193 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; this-&gt;cts =<a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>;</div>
dan_ackme 17:7268f365676b 194 <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; this-&gt;rts =<a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>;</div>
dan_ackme 17:7268f365676b 195 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; this-&gt;baud = <a class="code" href="group__api__core__macro.html#ga2e7ffaac225bc56852bb504f531aafa0">WICONNECT_DEFAULT_BAUD</a>;</div>
dan_ackme 17:7268f365676b 196 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; this-&gt;serialRxBuffer =NULL;</div>
dan_ackme 17:7268f365676b 197 <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; this-&gt;serialRxBufferSize =0;</div>
dan_ackme 17:7268f365676b 198 <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; }</div>
dan_ackme 16:7f1d6d359787 199 <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div>
dan_ackme 17:7268f365676b 200 <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;};</div>
dan_ackme 17:7268f365676b 201 <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;</div>
dan_ackme 17:7268f365676b 202 <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;</div>
dan_ackme 17:7268f365676b 203 <div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="group__api__core__macro.html#ga596d1da2fb23f4e748c83d64a47e10b3"> 180</a></span>&#160;<span class="preprocessor">#define delayMs(ms) wait_ms(ms)</span></div>
dan_ackme 16:7f1d6d359787 204 <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;</div>
dan_ackme 17:7268f365676b 205 <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div>
dan_ackme 17:7268f365676b 206 <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;</div>
dan_ackme 17:7268f365676b 207 <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div>
dan_ackme 17:7268f365676b 208 <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;}</div>
dan_ackme 17:7268f365676b 209 <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 17:7268f365676b 210 <div class="ttc" id="group__api__core__types_html_ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><div class="ttname"><a href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></div><div class="ttdeci">PinName Pin</div><div class="ttdoc">Pin name on HOST. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00123">sdk.h:123</a></div></div>
dan_ackme 17:7268f365676b 211 <div class="ttc" id="group__api__core__macro_html_ga2e7ffaac225bc56852bb504f531aafa0"><div class="ttname"><a href="group__api__core__macro.html#ga2e7ffaac225bc56852bb504f531aafa0">WICONNECT_DEFAULT_BAUD</a></div><div class="ttdeci">#define WICONNECT_DEFAULT_BAUD</div><div class="ttdoc">The default Host<->Wiconnect Module serial BAUD rate. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00078">sdk.h:78</a></div></div>
dan_ackme 17:7268f365676b 212 <div class="ttc" id="group__api__core__macro_html_gaa1dbeca66111f3a22d0ee6b122d69270"><div class="ttname"><a href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></div><div class="ttdeci">#define PIN_NC</div><div class="ttdoc">Default value for a pin, Not connected. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00117">sdk.h:117</a></div></div>
dan_ackme 14:85a2ed029f37 213 </div><!-- fragment --></div><!-- contents -->
dan_ackme 14:85a2ed029f37 214 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 215 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 216 <ul>
dan_ackme 14:85a2ed029f37 217 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 218 </ul>
dan_ackme 14:85a2ed029f37 219 </div>
dan_ackme 14:85a2ed029f37 220 </body>
dan_ackme 14:85a2ed029f37 221 </html>