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/mbed/html/structwiconnect_1_1_ssid.html@34:2616445d0823, 2014-11-26 (annotated)

Committer:
dan_ackme
Date:
Wed Nov 26 23:46:00 2014 -0800
Revision:
34:2616445d0823
added support for out-dated wifi firmware

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 34:2616445d0823 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 34:2616445d0823 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 34:2616445d0823 3 <head>
dan_ackme 34:2616445d0823 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 34:2616445d0823 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 34:2616445d0823 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 34:2616445d0823 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 34:2616445d0823 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 34:2616445d0823 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 34:2616445d0823 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 34:2616445d0823 15 <script type="text/javascript">
dan_ackme 34:2616445d0823 16 $(document).ready(initResizable);
dan_ackme 34:2616445d0823 17 $(window).load(resizeHeight);
dan_ackme 34:2616445d0823 18 </script>
dan_ackme 34:2616445d0823 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 34:2616445d0823 21 <script type="text/javascript">
dan_ackme 34:2616445d0823 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 34:2616445d0823 23 </script>
dan_ackme 34:2616445d0823 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 34:2616445d0823 25 </head>
dan_ackme 34:2616445d0823 26 <body>
dan_ackme 34:2616445d0823 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 34:2616445d0823 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 34:2616445d0823 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 34:2616445d0823 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 34:2616445d0823 32 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 34:2616445d0823 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 34:2616445d0823 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 34:2616445d0823 36 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 37 </tr>
dan_ackme 34:2616445d0823 38 <tr><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 39 </table>
dan_ackme 34:2616445d0823 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 34:2616445d0823 41 <script type="text/javascript">
dan_ackme 34:2616445d0823 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 34:2616445d0823 43 </script>
dan_ackme 34:2616445d0823 44 <div id="navrow1" class="tabs">
dan_ackme 34:2616445d0823 45 <ul class="tablist">
dan_ackme 34:2616445d0823 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 34:2616445d0823 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 34:2616445d0823 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 34:2616445d0823 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 34:2616445d0823 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 34:2616445d0823 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 34:2616445d0823 52 <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
dan_ackme 34:2616445d0823 53 <li>
dan_ackme 34:2616445d0823 54 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 34:2616445d0823 55 <span class="left">
dan_ackme 34:2616445d0823 56 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 34:2616445d0823 57 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 58 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 59 alt=""/>
dan_ackme 34:2616445d0823 60 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 34:2616445d0823 61 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 34:2616445d0823 62 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 34:2616445d0823 63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 34:2616445d0823 64 </span><span class="right">
dan_ackme 34:2616445d0823 65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 34:2616445d0823 66 </span>
dan_ackme 34:2616445d0823 67 </div>
dan_ackme 34:2616445d0823 68 </li>
dan_ackme 34:2616445d0823 69 </ul>
dan_ackme 34:2616445d0823 70 </div>
dan_ackme 34:2616445d0823 71 <div id="navrow2" class="tabs2">
dan_ackme 34:2616445d0823 72 <ul class="tablist">
dan_ackme 34:2616445d0823 73 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 34:2616445d0823 74 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 34:2616445d0823 75 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 34:2616445d0823 76 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 34:2616445d0823 77 </ul>
dan_ackme 34:2616445d0823 78 </div>
dan_ackme 34:2616445d0823 79 </div><!-- top -->
dan_ackme 34:2616445d0823 80 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 81 <div id="nav-tree">
dan_ackme 34:2616445d0823 82 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 83 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 84 </div>
dan_ackme 34:2616445d0823 85 </div>
dan_ackme 34:2616445d0823 86 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 87 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 88 </div>
dan_ackme 34:2616445d0823 89 </div>
dan_ackme 34:2616445d0823 90 <script type="text/javascript">
dan_ackme 34:2616445d0823 91 $(document).ready(function(){initNavTree('structwiconnect_1_1_ssid.html','');});
dan_ackme 34:2616445d0823 92 </script>
dan_ackme 34:2616445d0823 93 <div id="doc-content">
dan_ackme 34:2616445d0823 94 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 95 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 96 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 97 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 98 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 99 <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 34:2616445d0823 100
dan_ackme 34:2616445d0823 101 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 102 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 103 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 104 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 105 </iframe>
dan_ackme 34:2616445d0823 106 </div>
dan_ackme 34:2616445d0823 107
dan_ackme 34:2616445d0823 108 <div class="header">
dan_ackme 34:2616445d0823 109 <div class="summary">
dan_ackme 34:2616445d0823 110 <a href="#pub-attribs">Public Attributes</a> &#124;
dan_ackme 34:2616445d0823 111 <a href="structwiconnect_1_1_ssid-members.html">List of all members</a> </div>
dan_ackme 34:2616445d0823 112 <div class="headertitle">
dan_ackme 34:2616445d0823 113 <div class="title">wiconnect::Ssid Struct Reference<div class="ingroups"><a class="el" href="group__api__network__types.html">Types</a></div></div> </div>
dan_ackme 34:2616445d0823 114 </div><!--header-->
dan_ackme 34:2616445d0823 115 <div class="contents">
dan_ackme 34:2616445d0823 116
dan_ackme 34:2616445d0823 117 <p>Network SSID type.
dan_ackme 34:2616445d0823 118 <a href="structwiconnect_1_1_ssid.html#details">More...</a></p>
dan_ackme 34:2616445d0823 119
dan_ackme 34:2616445d0823 120 <p><code>#include &lt;<a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>&gt;</code></p>
dan_ackme 34:2616445d0823 121 <table class="memberdecls">
dan_ackme 34:2616445d0823 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
dan_ackme 34:2616445d0823 123 Public Attributes</h2></td></tr>
dan_ackme 34:2616445d0823 124 <tr class="memitem:ab8b77bf8f59ef8c17d8f6e59f1ceab7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8b77bf8f59ef8c17d8f6e59f1ceab7a"></a>
dan_ackme 34:2616445d0823 125 uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ssid.html#ab8b77bf8f59ef8c17d8f6e59f1ceab7a">val</a> [32]</td></tr>
dan_ackme 34:2616445d0823 126 <tr class="memdesc:ab8b77bf8f59ef8c17d8f6e59f1ceab7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The raw data of the SSID (not necessarily a string) <br /></td></tr>
dan_ackme 34:2616445d0823 127 <tr class="separator:ab8b77bf8f59ef8c17d8f6e59f1ceab7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 128 <tr class="memitem:a7dd62e15567d9de9e9191f9aaba6a0a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dd62e15567d9de9e9191f9aaba6a0a3"></a>
dan_ackme 34:2616445d0823 129 uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ssid.html#a7dd62e15567d9de9e9191f9aaba6a0a3">len</a></td></tr>
dan_ackme 34:2616445d0823 130 <tr class="memdesc:a7dd62e15567d9de9e9191f9aaba6a0a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The length in bytes of the SSID raw data. <br /></td></tr>
dan_ackme 34:2616445d0823 131 <tr class="separator:a7dd62e15567d9de9e9191f9aaba6a0a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 132 </table>
dan_ackme 34:2616445d0823 133 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 134 <div class="textblock"><p>Network SSID type. </p>
dan_ackme 34:2616445d0823 135
dan_ackme 34:2616445d0823 136 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00298">298</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 34:2616445d0823 137 </div><hr/>The documentation for this struct was generated from the following file:<ul>
dan_ackme 34:2616445d0823 138 <li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/api/<a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a></li>
dan_ackme 34:2616445d0823 139 </ul>
dan_ackme 34:2616445d0823 140 </div><!-- contents -->
dan_ackme 34:2616445d0823 141 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 142 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 143 <ul>
dan_ackme 34:2616445d0823 144 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 145 </ul>
dan_ackme 34:2616445d0823 146 </div>
dan_ackme 34:2616445d0823 147 </body>
dan_ackme 34:2616445d0823 148 </html>