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:
- 16:7f1d6d359787
- Parent:
- 14:85a2ed029f37
- Child:
- 26:8067e3d463d3
--- a/doc/html/_wiconnect_serial_8h_source.html Wed Aug 13 03:15:49 2014 -0700 +++ b/doc/html/_wiconnect_serial_8h_source.html Wed Aug 13 04:41:04 2014 -0700 @@ -101,47 +101,38 @@ <div class="title">WiconnectSerial.h</div> </div> </div><!--header--> <div class="contents"> -<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> -<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2014, ACKme Networks</span></div> -<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div> -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div> -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div> -<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div> -<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * written permission of ACKme Networks.</span></div> -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "WiconnectTypes.h"</span></div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>wiconnect</div> -<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div> -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> -<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span>WiconnectSerial WICONNECT_SERIAL_BASE_CLASS</div> -<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  WiconnectSerial(<span class="keyword">const</span> SerialConfig &config, Wiconnect *wiconnect = NULL);</div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">virtual</span> ~WiconnectSerial();</div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">void</span> flush(<span class="keywordtype">void</span>);</div> -<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <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="l00032"></a><span class="lineno"> 32</span>  <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="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "WiconnectTypes.h"</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> -<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">protected</span>:</div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  TimeoutTimer timeoutTimer;</div> -<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifdef WICONNECT_SERIAL_RX_BUFFER</span></div> -<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  uint8_t ringBuffer[32];</div> -<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">bool</span> bufferAlloc;</div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> rxIrqHandler(<span class="keywordtype">void</span>);</div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif</span></div> -<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div> -<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> -<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> -<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> }</div> -<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> -<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>wiconnect</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>WiconnectSerial WICONNECT_SERIAL_BASE_CLASS</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  WiconnectSerial(<span class="keyword">const</span> SerialConfig &config, Wiconnect *wiconnect = NULL);</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> ~WiconnectSerial();</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> flush(<span class="keywordtype">void</span>);</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <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>  <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> </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  TimeoutTimer timeoutTimer;</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#ifdef WICONNECT_SERIAL_RX_BUFFER</span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  uint8_t ringBuffer[32];</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">bool</span> bufferAlloc;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> rxIrqHandler(<span class="keywordtype">void</span>);</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->