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/group__api__network__settings.html@11:ea484e1b7fc4, 2014-08-12 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 12 02:34:46 2014 -0700
Revision:
11:ea484e1b7fc4
Parent:
10:735194df0097
Child:
13:2b51f5267c92
updated documnetation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 10:735194df0097 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 10:735194df0097 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 10:735194df0097 3 <head>
dan_ackme 10:735194df0097 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 10:735194df0097 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 10:735194df0097 6 <meta name="generator" content="Doxygen 1.8.7"/>
dan_ackme 10:735194df0097 7 <title>WiConnect Library: Settings</title>
dan_ackme 10:735194df0097 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 9 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 12 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript">
dan_ackme 10:735194df0097 15 $(document).ready(initResizable);
dan_ackme 10:735194df0097 16 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 17 </script>
dan_ackme 11:ea484e1b7fc4 18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 19 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 21 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 22 </script>
dan_ackme 10:735194df0097 23 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 24 </head>
dan_ackme 10:735194df0097 25 <body>
dan_ackme 10:735194df0097 26 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 10:735194df0097 27 <div id="titlearea">
dan_ackme 10:735194df0097 28 <table cellspacing="0" cellpadding="0">
dan_ackme 10:735194df0097 29 <tbody>
dan_ackme 10:735194df0097 30 <tr style="height: 56px;">
dan_ackme 10:735194df0097 31 <td style="padding-left: 0.5em;">
dan_ackme 10:735194df0097 32 <div id="projectname">WiConnect Library
dan_ackme 10:735194df0097 33 </div>
dan_ackme 10:735194df0097 34 </td>
dan_ackme 10:735194df0097 35 </tr>
dan_ackme 10:735194df0097 36 </tbody>
dan_ackme 10:735194df0097 37 </table>
dan_ackme 10:735194df0097 38 </div>
dan_ackme 10:735194df0097 39 <!-- end header part -->
dan_ackme 10:735194df0097 40 <!-- Generated by Doxygen 1.8.7 -->
dan_ackme 11:ea484e1b7fc4 41 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 11:ea484e1b7fc4 43 </script>
dan_ackme 10:735194df0097 44 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 45 <ul class="tablist">
dan_ackme 10:735194df0097 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
dan_ackme 10:735194df0097 47 <li><a href="modules.html"><span>Modules</span></a></li>
dan_ackme 11:ea484e1b7fc4 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
dan_ackme 10:735194df0097 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 11:ea484e1b7fc4 50 <li>
dan_ackme 11:ea484e1b7fc4 51 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 52 <span class="left">
dan_ackme 11:ea484e1b7fc4 53 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 54 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 55 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 56 alt=""/>
dan_ackme 11:ea484e1b7fc4 57 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 58 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 59 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 60 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 61 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 62 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 63 </span>
dan_ackme 11:ea484e1b7fc4 64 </div>
dan_ackme 11:ea484e1b7fc4 65 </li>
dan_ackme 10:735194df0097 66 </ul>
dan_ackme 10:735194df0097 67 </div>
dan_ackme 10:735194df0097 68 </div><!-- top -->
dan_ackme 10:735194df0097 69 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 70 <div id="nav-tree">
dan_ackme 10:735194df0097 71 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 72 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 73 </div>
dan_ackme 10:735194df0097 74 </div>
dan_ackme 10:735194df0097 75 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 76 class="ui-resizable-handle">
dan_ackme 10:735194df0097 77 </div>
dan_ackme 10:735194df0097 78 </div>
dan_ackme 10:735194df0097 79 <script type="text/javascript">
dan_ackme 10:735194df0097 80 $(document).ready(function(){initNavTree('group__api__network__settings.html','');});
dan_ackme 10:735194df0097 81 </script>
dan_ackme 10:735194df0097 82 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 83 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 84 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 85 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 86 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 87 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 88 <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 11:ea484e1b7fc4 89
dan_ackme 11:ea484e1b7fc4 90 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 91 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 92 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 93 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 94 </iframe>
dan_ackme 11:ea484e1b7fc4 95 </div>
dan_ackme 11:ea484e1b7fc4 96
dan_ackme 10:735194df0097 97 <div class="header">
dan_ackme 11:ea484e1b7fc4 98 <div class="summary">
dan_ackme 11:ea484e1b7fc4 99 <a href="#func-members">Functions</a> </div>
dan_ackme 10:735194df0097 100 <div class="headertitle">
dan_ackme 10:735194df0097 101 <div class="title">Settings<div class="ingroups"><a class="el" href="group__api__network.html">Network API</a></div></div> </div>
dan_ackme 10:735194df0097 102 </div><!--header-->
dan_ackme 10:735194df0097 103 <div class="contents">
dan_ackme 10:735194df0097 104
dan_ackme 10:735194df0097 105 <p>API getters/setters for module network settings.
dan_ackme 10:735194df0097 106 <a href="#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 107 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 11:ea484e1b7fc4 109 Functions</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 110 <tr class="memitem:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga65eb99f880ed739d0f3cd393e5b56eaf"></a>
dan_ackme 11:ea484e1b7fc4 111 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">wiconnect::NetworkInterface::setDhcpEnabled</a> (bool enabled)</td></tr>
dan_ackme 11:ea484e1b7fc4 112 <tr class="memdesc:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DHCP enabled. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 113 <tr class="separator:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 114 <tr class="memitem:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70ec796b88eb6f8e7990dbf3eb2f2eff"></a>
dan_ackme 11:ea484e1b7fc4 115 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">wiconnect::NetworkInterface::getDhcpEnabled</a> (bool *enabledPtr)</td></tr>
dan_ackme 11:ea484e1b7fc4 116 <tr class="memdesc:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get if DHCP enabled. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 117 <tr class="separator:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 118 <tr class="memitem:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2f7ec21084d3f2835d9c1c201915a9e0"></a>
dan_ackme 11:ea484e1b7fc4 119 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">wiconnect::NetworkInterface::setIpSettings</a> (uint32_t ip, uint32_t netmask, uint32_t gateway)</td></tr>
dan_ackme 11:ea484e1b7fc4 120 <tr class="memdesc:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 121 <tr class="separator:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 122 <tr class="memitem:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa418175dd3d06b870f3dd8e035cb4dd0"></a>
dan_ackme 11:ea484e1b7fc4 123 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gaa418175dd3d06b870f3dd8e035cb4dd0">wiconnect::NetworkInterface::setIpSettings</a> (const char *ip, const char *netmask, const char *gateway)</td></tr>
dan_ackme 11:ea484e1b7fc4 124 <tr class="memdesc:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings (with string parameters) <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 125 <tr class="separator:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 126 <tr class="memitem:ga291aef702f1c10bf2970394e3458022b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga291aef702f1c10bf2970394e3458022b"></a>
dan_ackme 11:ea484e1b7fc4 127 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga291aef702f1c10bf2970394e3458022b">wiconnect::NetworkInterface::getIpSettings</a> (uint32_t *ip, uint32_t *netmask, uint32_t *gateway)</td></tr>
dan_ackme 11:ea484e1b7fc4 128 <tr class="memdesc:ga291aef702f1c10bf2970394e3458022b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get network IP settings. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 129 <tr class="separator:ga291aef702f1c10bf2970394e3458022b"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 130 <tr class="memitem:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba16b9918e55c08285cf5b8b50dbabea"></a>
dan_ackme 11:ea484e1b7fc4 131 WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gaba16b9918e55c08285cf5b8b50dbabea">wiconnect::NetworkInterface::getSignalStrength</a> (NetworkSignalStrength *signalStrengthPtr)</td></tr>
dan_ackme 11:ea484e1b7fc4 132 <tr class="memdesc:gaba16b9918e55c08285cf5b8b50dbabea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get signal strength to WiFi network. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 133 <tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 134 </table>
dan_ackme 11:ea484e1b7fc4 135 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 10:735194df0097 136 <p>API getters/setters for module network settings. </p>
dan_ackme 10:735194df0097 137 </div><!-- contents -->
dan_ackme 10:735194df0097 138 </div><!-- doc-content -->
dan_ackme 10:735194df0097 139 <!-- start footer part -->
dan_ackme 10:735194df0097 140 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 141 <ul>
dan_ackme 11:ea484e1b7fc4 142 <li class="footer">Generated on Tue Aug 12 2014 02:15:21 for WiConnect Library by
dan_ackme 10:735194df0097 143 <a href="http://www.doxygen.org/index.html">
dan_ackme 10:735194df0097 144 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 10:735194df0097 145 </ul>
dan_ackme 10:735194df0097 146 </div>
dan_ackme 10:735194df0097 147 </body>
dan_ackme 10:735194df0097 148 </html>