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/classwiconnect_1_1_serial_config.html@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3 
refactored library layout

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 class="current"><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 id="navrow2" class="tabs2">
dan_ackme 14:85a2ed029f37 71 <ul class="tablist">
dan_ackme 14:85a2ed029f37 72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 14:85a2ed029f37 73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 14:85a2ed029f37 74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 14:85a2ed029f37 75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 14:85a2ed029f37 76 </ul>
dan_ackme 14:85a2ed029f37 77 </div>
dan_ackme 14:85a2ed029f37 78 </div><!-- top -->
dan_ackme 14:85a2ed029f37 79 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 80 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 81 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 82 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 83 </div>
dan_ackme 14:85a2ed029f37 84 </div>
dan_ackme 14:85a2ed029f37 85 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 86 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 87 </div>
dan_ackme 14:85a2ed029f37 88 </div>
dan_ackme 14:85a2ed029f37 89 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 90 $(document).ready(function(){initNavTree('classwiconnect_1_1_serial_config.html','');});
dan_ackme 14:85a2ed029f37 91 </script>
dan_ackme 14:85a2ed029f37 92 <div id="doc-content">
dan_ackme 14:85a2ed029f37 93 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 94 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 95 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 96 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 97 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 98 <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 99
dan_ackme 14:85a2ed029f37 100 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 101 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 102 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 103 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 104 </iframe>
dan_ackme 14:85a2ed029f37 105 </div>
dan_ackme 14:85a2ed029f37 106
dan_ackme 14:85a2ed029f37 107 <div class="header">
dan_ackme 14:85a2ed029f37 108 <div class="summary">
dan_ackme 14:85a2ed029f37 109 <a href="classwiconnect_1_1_serial_config-members.html">List of all members</a> </div>
dan_ackme 14:85a2ed029f37 110 <div class="headertitle">
dan_ackme 14:85a2ed029f37 111 <div class="title">wiconnect::SerialConfig Class Reference<div class="ingroups"><a class="el" href="group__api__core__types.html">Types</a></div></div> </div>
dan_ackme 14:85a2ed029f37 112 </div><!--header-->
dan_ackme 14:85a2ed029f37 113 <div class="contents">
dan_ackme 14:85a2ed029f37 114
dan_ackme 14:85a2ed029f37 115 <p>Host&lt;-&gt;<a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration.
dan_ackme 14:85a2ed029f37 116 <a href="classwiconnect_1_1_serial_config.html#details">More...</a></p>
dan_ackme 14:85a2ed029f37 117
dan_ackme 14:85a2ed029f37 118 <p><code>#include &lt;<a class="el" href="sdk_8h_source.html">sdk.h</a>&gt;</code></p>
dan_ackme 14:85a2ed029f37 119 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 14:85a2ed029f37 120 <div class="textblock"><p>Host&lt;-&gt;<a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. </p>
dan_ackme 14:85a2ed029f37 121
dan_ackme 29:b6af04b77a56 122 <p>Definition at line <a class="el" href="sdk_8h_source.html#l00140">140</a> of file <a class="el" href="sdk_8h_source.html">sdk.h</a>.</p>
dan_ackme 14:85a2ed029f37 123 </div><hr/>The documentation for this class was generated from the following file:<ul>
dan_ackme 14:85a2ed029f37 124 <li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/sdk/mbed/<a class="el" href="sdk_8h_source.html">sdk.h</a></li>
dan_ackme 14:85a2ed029f37 125 </ul>
dan_ackme 14:85a2ed029f37 126 </div><!-- contents -->
dan_ackme 14:85a2ed029f37 127 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 128 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 129 <ul>
dan_ackme 14:85a2ed029f37 130 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 131 </ul>
dan_ackme 14:85a2ed029f37 132 </div>
dan_ackme 14:85a2ed029f37 133 </body>
dan_ackme 14:85a2ed029f37 134 </html>