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/html/_wiconnect_serial_8h_source.html

Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3
--- a/doc/html/_wiconnect_serial_8h_source.html	Mon Oct 27 13:32:40 2014 -0700
+++ b/doc/html/_wiconnect_serial_8h_source.html	Mon Oct 27 13:42:26 2014 -0700
@@ -104,7 +104,7 @@
 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#pragma once</span></div>
 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
-<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
+<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;api/WiconnectTypes.h&quot;</span></div>
 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
@@ -116,23 +116,29 @@
 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    WiconnectSerial(<span class="keyword">const</span> SerialConfig  &amp;config, Wiconnect *wiconnect = NULL);</div>
 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="keyword">virtual</span> ~WiconnectSerial();</div>
 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
-<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="keywordtype">void</span> flush(<span class="keywordtype">void</span>);</div>
-<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">int</span> write(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> bytesToWrite, <span class="keywordtype">int</span> timeoutMs);</div>
-<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordtype">int</span> read(<span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> bytesToRead, <span class="keywordtype">int</span> timeoutMs);</div>
-<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
-<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">protected</span>:</div>
-<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    TimeoutTimer timeoutTimer;</div>
-<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#ifdef WICONNECT_SERIAL_RX_BUFFER</span></div>
-<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    uint8_t ringBuffer[32];</div>
-<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordtype">bool</span> bufferAlloc;</div>
-<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordtype">void</span> rxIrqHandler(<span class="keywordtype">void</span>);</div>
-<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#endif</span></div>
-<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;};</div>
-<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
-<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div>
-<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;}</div>
-<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
-<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
+<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>);</div>
+<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">void</span> flush(<span class="keywordtype">void</span>);</div>
+<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordtype">int</span> write(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> bytesToWrite, <a class="code" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs);</div>
+<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordtype">int</span> read(<span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> bytesToRead, <a class="code" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs);</div>
+<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div>
+<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    uint32_t getBaud(){ <span class="keywordflow">return</span> baudRate; }</div>
+<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keyword">protected</span>:</div>
+<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    TimeoutTimer timeoutTimer;</div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    uint32_t baudRate;</div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#ifdef WICONNECT_SERIAL_RX_BUFFER</span></div>
+<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    uint8_t ringBuffer[32];</div>
+<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordtype">bool</span> bufferAlloc;</div>
+<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordtype">void</span> rxIrqHandler(<span class="keywordtype">void</span>);</div>
+<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;};</div>
+<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
+<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;}</div>
+<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
+<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
+<div class="ttc" id="namespacewiconnect_html_a0c27570b2913afc6339821df7c934810"><div class="ttname"><a href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">wiconnect::TimerTimeout</a></div><div class="ttdeci">unsigned long TimerTimeout</div><div class="ttdoc">Timeout type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00212">WiconnectTypes.h:212</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->