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/group__api__network__types.html@16:7f1d6d359787, 2014-08-13 (annotated)
- Committer:
- dan_ackme
- Date:
- Wed Aug 13 04:41:04 2014 -0700
- Revision:
- 16:7f1d6d359787
- Parent:
- 14:85a2ed029f37
- Child:
- 17:7268f365676b
updated documentation and copyright
Who changed what in which revision?
User | Revision | Line number | New 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> </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> </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 Overview</span></a></li> |
dan_ackme | 14:85a2ed029f37 | 47 | <li><a href="modules.html"><span>Library API</span></a></li> |
dan_ackme | 14:85a2ed029f37 | 48 | <li><a href="examples.html"><span>API Examples</span></a></li> |
dan_ackme | 14:85a2ed029f37 | 49 | <li><a href="annotated.html"><span>Classes</span></a></li> |
dan_ackme | 14:85a2ed029f37 | 50 | <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li> |
dan_ackme | 14:85a2ed029f37 | 51 | <li><a href="http://www.ack.me/WiConnect"><span>ACKme 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><!-- top --> |
dan_ackme | 14:85a2ed029f37 | 71 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
dan_ackme | 14:85a2ed029f37 | 72 | <div id="nav-tree"> |
dan_ackme | 14:85a2ed029f37 | 73 | <div id="nav-tree-contents"> |
dan_ackme | 14:85a2ed029f37 | 74 | <div id="nav-sync" class="sync"></div> |
dan_ackme | 14:85a2ed029f37 | 75 | </div> |
dan_ackme | 14:85a2ed029f37 | 76 | </div> |
dan_ackme | 14:85a2ed029f37 | 77 | <div id="splitbar" style="-moz-user-select:none;" |
dan_ackme | 14:85a2ed029f37 | 78 | class="ui-resizable-handle"> |
dan_ackme | 14:85a2ed029f37 | 79 | </div> |
dan_ackme | 14:85a2ed029f37 | 80 | </div> |
dan_ackme | 14:85a2ed029f37 | 81 | <script type="text/javascript"> |
dan_ackme | 14:85a2ed029f37 | 82 | $(document).ready(function(){initNavTree('group__api__network__types.html','');}); |
dan_ackme | 14:85a2ed029f37 | 83 | </script> |
dan_ackme | 14:85a2ed029f37 | 84 | <div id="doc-content"> |
dan_ackme | 14:85a2ed029f37 | 85 | <!-- window showing the filter options --> |
dan_ackme | 14:85a2ed029f37 | 86 | <div id="MSearchSelectWindow" |
dan_ackme | 14:85a2ed029f37 | 87 | onmouseover="return searchBox.OnSearchSelectShow()" |
dan_ackme | 14:85a2ed029f37 | 88 | onmouseout="return searchBox.OnSearchSelectHide()" |
dan_ackme | 14:85a2ed029f37 | 89 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
dan_ackme | 14:85a2ed029f37 | 90 | <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> |
dan_ackme | 14:85a2ed029f37 | 91 | |
dan_ackme | 14:85a2ed029f37 | 92 | <!-- iframe showing the search results (closed by default) --> |
dan_ackme | 14:85a2ed029f37 | 93 | <div id="MSearchResultsWindow"> |
dan_ackme | 14:85a2ed029f37 | 94 | <iframe src="javascript:void(0)" frameborder="0" |
dan_ackme | 14:85a2ed029f37 | 95 | name="MSearchResults" id="MSearchResults"> |
dan_ackme | 14:85a2ed029f37 | 96 | </iframe> |
dan_ackme | 14:85a2ed029f37 | 97 | </div> |
dan_ackme | 14:85a2ed029f37 | 98 | |
dan_ackme | 14:85a2ed029f37 | 99 | <div class="header"> |
dan_ackme | 14:85a2ed029f37 | 100 | <div class="summary"> |
dan_ackme | 14:85a2ed029f37 | 101 | <a href="#nested-classes">Classes</a> | |
dan_ackme | 14:85a2ed029f37 | 102 | <a href="#typedef-members">Typedefs</a> | |
dan_ackme | 14:85a2ed029f37 | 103 | <a href="#enum-members">Enumerations</a> </div> |
dan_ackme | 14:85a2ed029f37 | 104 | <div class="headertitle"> |
dan_ackme | 14:85a2ed029f37 | 105 | <div class="title">Types<div class="ingroups"><a class="el" href="group__api__network.html">Network</a></div></div> </div> |
dan_ackme | 14:85a2ed029f37 | 106 | </div><!--header--> |
dan_ackme | 14:85a2ed029f37 | 107 | <div class="contents"> |
dan_ackme | 14:85a2ed029f37 | 108 | |
dan_ackme | 14:85a2ed029f37 | 109 | <p>Network Types. |
dan_ackme | 14:85a2ed029f37 | 110 | <a href="#details">More...</a></p> |
dan_ackme | 14:85a2ed029f37 | 111 | <table class="memberdecls"> |
dan_ackme | 14:85a2ed029f37 | 112 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
dan_ackme | 14:85a2ed029f37 | 113 | Classes</h2></td></tr> |
dan_ackme | 14:85a2ed029f37 | 114 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td></tr> |
dan_ackme | 14:85a2ed029f37 | 115 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for joining and/or creating a network. It provides other utilities such as scanning for networks, pinging a network, resolving a domain name to IP address. <a href="classwiconnect_1_1_network_interface.html#details">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 116 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 117 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ssid.html">wiconnect::Ssid</a></td></tr> |
dan_ackme | 14:85a2ed029f37 | 118 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Network SSID type. <a href="structwiconnect_1_1_ssid.html#details">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 119 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 120 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_mac_address.html">wiconnect::MacAddress</a></td></tr> |
dan_ackme | 14:85a2ed029f37 | 121 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Network MAC Address type. <a href="structwiconnect_1_1_mac_address.html#details">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 122 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 123 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_scan_result.html">wiconnect::ScanResult</a></td></tr> |
dan_ackme | 14:85a2ed029f37 | 124 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains single entry from WiFi scan results. <a href="classwiconnect_1_1_scan_result.html#details">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 125 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 126 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_scan_result_list.html">wiconnect::ScanResultList</a></td></tr> |
dan_ackme | 14:85a2ed029f37 | 127 | <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List of WiFi network scan results. <a href="classwiconnect_1_1_scan_result_list.html#details">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 128 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 129 | </table><table class="memberdecls"> |
dan_ackme | 14:85a2ed029f37 | 130 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
dan_ackme | 14:85a2ed029f37 | 131 | Typedefs</h2></td></tr> |
dan_ackme | 14:85a2ed029f37 | 132 | <tr class="memitem:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga04b095d2e2f32a3fd23e346a4be969d8"></a> |
dan_ackme | 14:85a2ed029f37 | 133 | typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga04b095d2e2f32a3fd23e346a4be969d8">wiconnect::MacAddressStrBuffer</a> [18]</td></tr> |
dan_ackme | 14:85a2ed029f37 | 134 | <tr class="memdesc:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold a MAC address string. <br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 135 | <tr class="separator:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 136 | <tr class="memitem:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga38e0a82235258f96340b9ce2c6e1426c"></a> |
dan_ackme | 14:85a2ed029f37 | 137 | typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga38e0a82235258f96340b9ce2c6e1426c">wiconnect::SsidStrBuffer</a> [129]</td></tr> |
dan_ackme | 14:85a2ed029f37 | 138 | <tr class="memdesc:ga38e0a82235258f96340b9ce2c6e1426c"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold a SSID string. <br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 139 | <tr class="separator:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 140 | <tr class="memitem:gaa68646bb07ee9f174097b60ac7327342"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa68646bb07ee9f174097b60ac7327342"></a> |
dan_ackme | 14:85a2ed029f37 | 141 | typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gaa68646bb07ee9f174097b60ac7327342">wiconnect::IpStrBuffer</a> [18]</td></tr> |
dan_ackme | 14:85a2ed029f37 | 142 | <tr class="memdesc:gaa68646bb07ee9f174097b60ac7327342"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold an IP address string. <br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 143 | <tr class="separator:gaa68646bb07ee9f174097b60ac7327342"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 144 | </table><table class="memberdecls"> |
dan_ackme | 14:85a2ed029f37 | 145 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
dan_ackme | 14:85a2ed029f37 | 146 | Enumerations</h2></td></tr> |
dan_ackme | 14:85a2ed029f37 | 147 | <tr class="memitem:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a> { <br /> |
dan_ackme | 14:85a2ed029f37 | 148 |   <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067">wiconnect::NETWORK_STATUS_DOWN</a>, |
dan_ackme | 14:85a2ed029f37 | 149 | <br /> |
dan_ackme | 14:85a2ed029f37 | 150 |   <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c">wiconnect::NETWORK_STATUS_WIFI_ONLY</a>, |
dan_ackme | 14:85a2ed029f37 | 151 | <br /> |
dan_ackme | 14:85a2ed029f37 | 152 |   <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46">wiconnect::NETWORK_STATUS_UP</a>, |
dan_ackme | 14:85a2ed029f37 | 153 | <br /> |
dan_ackme | 14:85a2ed029f37 | 154 |   <a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a2916360f96699b2bf42cf5e122562497">wiconnect::NETWORK_STATUS_JOINING</a> |
dan_ackme | 14:85a2ed029f37 | 155 | <br /> |
dan_ackme | 14:85a2ed029f37 | 156 | }</td></tr> |
dan_ackme | 14:85a2ed029f37 | 157 | <tr class="memdesc:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="mdescLeft"> </td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 158 | <tr class="separator:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 159 | <tr class="memitem:gac5aead2b4cca0122a60168e75ea41d36"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a> { <br /> |
dan_ackme | 14:85a2ed029f37 | 160 |   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385">wiconnect::NETWORK_RSSI_EXCELLENT</a> = 0, |
dan_ackme | 14:85a2ed029f37 | 161 | <br /> |
dan_ackme | 14:85a2ed029f37 | 162 |   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713">wiconnect::NETWORK_RSSI_VERY_GOOD</a> = 1, |
dan_ackme | 14:85a2ed029f37 | 163 | <br /> |
dan_ackme | 14:85a2ed029f37 | 164 |   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533">wiconnect::NETWORK_RSSI_GOOD</a> = 2, |
dan_ackme | 14:85a2ed029f37 | 165 | <br /> |
dan_ackme | 14:85a2ed029f37 | 166 |   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae">wiconnect::NETWORK_RSSI_POOR</a> = 3, |
dan_ackme | 14:85a2ed029f37 | 167 | <br /> |
dan_ackme | 14:85a2ed029f37 | 168 |   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa">wiconnect::NETWORK_RSSI_VERY_POOR</a> = 4, |
dan_ackme | 14:85a2ed029f37 | 169 | <br /> |
dan_ackme | 14:85a2ed029f37 | 170 |   <a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4">wiconnect::NETWORK_RSSI_UNKNOWN</a> = 5 |
dan_ackme | 14:85a2ed029f37 | 171 | <br /> |
dan_ackme | 14:85a2ed029f37 | 172 | }</td></tr> |
dan_ackme | 14:85a2ed029f37 | 173 | <tr class="memdesc:gac5aead2b4cca0122a60168e75ea41d36"><td class="mdescLeft"> </td><td class="mdescRight">Network RSSI signal level. <a href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">More...</a><br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 174 | <tr class="separator:gac5aead2b4cca0122a60168e75ea41d36"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 175 | <tr class="memitem:ga026bd11cd5df47b7022362243e2d553f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga026bd11cd5df47b7022362243e2d553f"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">wiconnect::NetworkSecurity</a> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 176 | <tr class="memdesc:ga026bd11cd5df47b7022362243e2d553f"><td class="mdescLeft"> </td><td class="mdescRight">Network security type. <br /></td></tr> |
dan_ackme | 14:85a2ed029f37 | 177 | <tr class="separator:ga026bd11cd5df47b7022362243e2d553f"><td class="memSeparator" colspan="2"> </td></tr> |
dan_ackme | 14:85a2ed029f37 | 178 | </table> |
dan_ackme | 14:85a2ed029f37 | 179 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
dan_ackme | 14:85a2ed029f37 | 180 | <p>Network Types. </p> |
dan_ackme | 14:85a2ed029f37 | 181 | <h2 class="groupheader">Enumeration Type Documentation</h2> |
dan_ackme | 14:85a2ed029f37 | 182 | <a class="anchor" id="gac5aead2b4cca0122a60168e75ea41d36"></a> |
dan_ackme | 14:85a2ed029f37 | 183 | <div class="memitem"> |
dan_ackme | 14:85a2ed029f37 | 184 | <div class="memproto"> |
dan_ackme | 14:85a2ed029f37 | 185 | <table class="memname"> |
dan_ackme | 14:85a2ed029f37 | 186 | <tr> |
dan_ackme | 14:85a2ed029f37 | 187 | <td class="memname">enum <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></td> |
dan_ackme | 14:85a2ed029f37 | 188 | </tr> |
dan_ackme | 14:85a2ed029f37 | 189 | </table> |
dan_ackme | 14:85a2ed029f37 | 190 | </div><div class="memdoc"> |
dan_ackme | 14:85a2ed029f37 | 191 | |
dan_ackme | 14:85a2ed029f37 | 192 | <p>Network RSSI signal level. </p> |
dan_ackme | 14:85a2ed029f37 | 193 | <table class="fieldtable"> |
dan_ackme | 14:85a2ed029f37 | 194 | <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385"></a>NETWORK_RSSI_EXCELLENT </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 195 | <p>> -20 dBm </p> |
dan_ackme | 14:85a2ed029f37 | 196 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 197 | <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713"></a>NETWORK_RSSI_VERY_GOOD </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 198 | <p>> -35 dBm </p> |
dan_ackme | 14:85a2ed029f37 | 199 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 200 | <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533"></a>NETWORK_RSSI_GOOD </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 201 | <p>> -50 dBm </p> |
dan_ackme | 14:85a2ed029f37 | 202 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 203 | <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae"></a>NETWORK_RSSI_POOR </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 204 | <p>> -70 dBm </p> |
dan_ackme | 14:85a2ed029f37 | 205 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 206 | <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa"></a>NETWORK_RSSI_VERY_POOR </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 207 | <p>< -71 dBm </p> |
dan_ackme | 14:85a2ed029f37 | 208 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 209 | <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4"></a>NETWORK_RSSI_UNKNOWN </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 210 | <p>Not available. </p> |
dan_ackme | 14:85a2ed029f37 | 211 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 212 | </table> |
dan_ackme | 14:85a2ed029f37 | 213 | |
dan_ackme | 16:7f1d6d359787 | 214 | <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00221">221</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> |
dan_ackme | 14:85a2ed029f37 | 215 | |
dan_ackme | 14:85a2ed029f37 | 216 | </div> |
dan_ackme | 14:85a2ed029f37 | 217 | </div> |
dan_ackme | 14:85a2ed029f37 | 218 | <a class="anchor" id="gab448e57fc1a5e21cbba0283fd1a35d99"></a> |
dan_ackme | 14:85a2ed029f37 | 219 | <div class="memitem"> |
dan_ackme | 14:85a2ed029f37 | 220 | <div class="memproto"> |
dan_ackme | 14:85a2ed029f37 | 221 | <table class="memname"> |
dan_ackme | 14:85a2ed029f37 | 222 | <tr> |
dan_ackme | 14:85a2ed029f37 | 223 | <td class="memname">enum <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></td> |
dan_ackme | 14:85a2ed029f37 | 224 | </tr> |
dan_ackme | 14:85a2ed029f37 | 225 | </table> |
dan_ackme | 14:85a2ed029f37 | 226 | </div><div class="memdoc"> |
dan_ackme | 14:85a2ed029f37 | 227 | |
dan_ackme | 14:85a2ed029f37 | 228 | <p>Network connection status. </p> |
dan_ackme | 14:85a2ed029f37 | 229 | <table class="fieldtable"> |
dan_ackme | 14:85a2ed029f37 | 230 | <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067"></a>NETWORK_STATUS_DOWN </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 231 | <p>Not connected to network. </p> |
dan_ackme | 14:85a2ed029f37 | 232 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 233 | <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c"></a>NETWORK_STATUS_WIFI_ONLY </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 234 | <p>Connected to network but don't have IP address. </p> |
dan_ackme | 14:85a2ed029f37 | 235 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 236 | <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46"></a>NETWORK_STATUS_UP </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 237 | <p>Conntected to network and have IP address. </p> |
dan_ackme | 14:85a2ed029f37 | 238 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 239 | <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a2916360f96699b2bf42cf5e122562497"></a>NETWORK_STATUS_JOINING </td><td class="fielddoc"> |
dan_ackme | 14:85a2ed029f37 | 240 | <p>Joining a network. </p> |
dan_ackme | 14:85a2ed029f37 | 241 | </td></tr> |
dan_ackme | 14:85a2ed029f37 | 242 | </table> |
dan_ackme | 14:85a2ed029f37 | 243 | <dl><dt><b>Examples: </b></dt><dd><a class="el" href="join_2example_8cpp-example.html#a0">join/example.cpp</a>.</dd> |
dan_ackme | 14:85a2ed029f37 | 244 | </dl> |
dan_ackme | 16:7f1d6d359787 | 245 | <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00209">209</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> |
dan_ackme | 14:85a2ed029f37 | 246 | |
dan_ackme | 14:85a2ed029f37 | 247 | </div> |
dan_ackme | 14:85a2ed029f37 | 248 | </div> |
dan_ackme | 14:85a2ed029f37 | 249 | </div><!-- contents --> |
dan_ackme | 14:85a2ed029f37 | 250 | </div><!-- doc-content --> |
dan_ackme | 14:85a2ed029f37 | 251 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
dan_ackme | 14:85a2ed029f37 | 252 | <ul> |
dan_ackme | 14:85a2ed029f37 | 253 | <li class="footer">© ACKme Networks 2014</li> |
dan_ackme | 14:85a2ed029f37 | 254 | </ul> |
dan_ackme | 14:85a2ed029f37 | 255 | </div> |
dan_ackme | 14:85a2ed029f37 | 256 | </body> |
dan_ackme | 14:85a2ed029f37 | 257 | </html> |