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/tcp__echo__client_2main_8cpp_source.html
- Revision:
- 34:2616445d0823
- Child:
- 39:a963f69cb2de
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/mbed/html/tcp__echo__client_2main_8cpp_source.html Wed Nov 26 23:46:00 2014 -0800 @@ -0,0 +1,188 @@ +<!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> </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> </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 Overview</span></a></li> + <li><a href="modules.html"><span>Library API</span></a></li> + <li><a href="examples.html"><span>API 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 Reference Manual</span></a></li> + <li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li> + <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect 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('tcp__echo__client_2main_8cpp_source.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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">main.cpp</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "Wiconnect.h"</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include "target_config.h"</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#define NETWORK_SSID "<YOUR NETWORK SSID HERE>"</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#define NETWORK_PASSWORD "<YOUR NETWORK PASSWORD HERE>"</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define ECHO_SERVER_ADDRESS "<YOUR LOCAL IP ADDRESS HERE>"</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define ECHO_SERVER_PORT 7</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> </div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">static</span> Serial consoleSerial(STDIO_UART_TX, STDIO_UART_RX);</div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">static</span> <span class="keywordtype">char</span> buf[256];</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="keywordtype">int</span> main()</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>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> result;</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> serialConfig(WICONNECT_RX_PIN, WICONNECT_TX_PIN, 256);</div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> wiconnect(serialConfig, 256, NULL, WICONNECT_RESET_PIN);</div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  consoleSerial.baud(115200);</div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordflow">if</span>(<a class="code" href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a>(result, wiconnect.init(<span class="keyword">true</span>)))</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>  printf(<span class="stringliteral">"Failed to initialize Wiconnect: %s\r\n"</span>, Wiconnect::getWiconnectResultStr(result));</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">if</span>(result == <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e">WICONNECT_FIRMWARE_OUTDATED</a>)</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  printf(<span class="stringliteral">"The WiFi firmware is not supported. Run the ota example to update the firmware:\r\n"</span>);</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  printf(<span class="stringliteral">"https://developer.mbed.org/teams/ACKme/code/wiconnect-ota_example"</span>);</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">for</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="keywordflow">else</span> <span class="keywordflow">if</span>(<a class="code" href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a>(result, wiconnect.join(NETWORK_SSID, NETWORK_PASSWORD)))</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>  printf(<span class="stringliteral">"Failed to join network: %s\r\n"</span>, Wiconnect::getWiconnectResultStr(result));</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">for</span>(;;);</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  printf(<span class="stringliteral">"IP Address is %s\n"</span>, wiconnect.getIpAddress());</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>  TCPSocketConnection socket;</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">while</span> (socket.connect(ECHO_SERVER_ADDRESS, ECHO_SERVER_PORT) < 0)</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>  printf(<span class="stringliteral">"Unable to connect to (%s) on port (%d)\r\n"</span>, ECHO_SERVER_ADDRESS, ECHO_SERVER_PORT);</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  wait(1);</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> </div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">char</span> hello[] = <span class="stringliteral">"Hello World\n"</span>;</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">if</span>(socket.send_all(hello, <span class="keyword">sizeof</span>(hello) - 1) == -1)</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>  printf(<span class="stringliteral">"Failed to send data\r\n"</span>);</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">for</span>(;;);</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> n = socket.receive(buf, 256);</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span>(n == -1)</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  printf(<span class="stringliteral">"Failed to receive data\r\n"</span>);</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">for</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>  buf[n] = <span class="charliteral">'\0'</span>;</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  printf(<span class="stringliteral">"%s"</span>, buf);</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  socket.close();</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  wiconnect.deinit();</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  printf(<span class="stringliteral">"Finished!"</span>);</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">while</span>(<span class="keyword">true</span>) {}</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</div> +<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00166">WiconnectTypes.h:166</a></div></div> +<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#l00148">sdk.h:148</a></div></div> +<div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e">wiconnect::WICONNECT_FIRMWARE_OUTDATED</a></div><div class="ttdoc">The WiFi module's firmware is out-dated. See updateFirmware() to update the firmware. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00194">WiconnectTypes.h:194</a></div></div> +<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00078">WiconnectInterface.h:78</a></div></div> +<div class="ttc" id="group__api__core__macro_html_gab27aa3ef76302b5221766abfd4f47e64"><div class="ttname"><a href="group__api__core__macro.html#gab27aa3ef76302b5221766abfd4f47e64">WICONNECT_FAILED</a></div><div class="ttdeci">#define WICONNECT_FAILED(result, func)</div><div class="ttdoc">Populates result with return value from func, returns TRUE if return value contains error...</div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00093">WiconnectTypes.h:93</a></div></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">© ACKme Networks 2014</li> + </ul> +</div> +</body> +</html> \ No newline at end of file