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@17:7268f365676b, 2014-08-23 (annotated)

Committer:
dan_ackme
Date:
Sat Aug 23 05:39:17 2014 -0700
Revision:
17:7268f365676b
Parent:
13:2b51f5267c92
Child:
26:8067e3d463d3
Fixes and documentation updates

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 13:2b51f5267c92 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 13:2b51f5267c92 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 13:2b51f5267c92 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 10:735194df0097 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 15 <script type="text/javascript">
dan_ackme 10:735194df0097 16 $(document).ready(initResizable);
dan_ackme 10:735194df0097 17 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 18 </script>
dan_ackme 11:ea484e1b7fc4 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 21 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 23 </script>
dan_ackme 10:735194df0097 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 25 </head>
dan_ackme 10:735194df0097 26 <body>
dan_ackme 10:735194df0097 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 13:2b51f5267c92 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 13:2b51f5267c92 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 13:2b51f5267c92 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 13:2b51f5267c92 32 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 13:2b51f5267c92 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 13:2b51f5267c92 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 13:2b51f5267c92 36 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 37 </tr>
dan_ackme 13:2b51f5267c92 38 <tr><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 39 </table>
dan_ackme 13:2b51f5267c92 40 </div><!-- 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 13:2b51f5267c92 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 10:735194df0097 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 13:2b51f5267c92 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 11:ea484e1b7fc4 52 <li>
dan_ackme 11:ea484e1b7fc4 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 54 <span class="left">
dan_ackme 11:ea484e1b7fc4 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 58 alt=""/>
dan_ackme 11:ea484e1b7fc4 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 63 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 65 </span>
dan_ackme 11:ea484e1b7fc4 66 </div>
dan_ackme 11:ea484e1b7fc4 67 </li>
dan_ackme 10:735194df0097 68 </ul>
dan_ackme 10:735194df0097 69 </div>
dan_ackme 10:735194df0097 70 </div><!-- top -->
dan_ackme 10:735194df0097 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 72 <div id="nav-tree">
dan_ackme 10:735194df0097 73 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 74 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 75 </div>
dan_ackme 10:735194df0097 76 </div>
dan_ackme 10:735194df0097 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 78 class="ui-resizable-handle">
dan_ackme 10:735194df0097 79 </div>
dan_ackme 10:735194df0097 80 </div>
dan_ackme 10:735194df0097 81 <script type="text/javascript">
dan_ackme 10:735194df0097 82 $(document).ready(function(){initNavTree('group__api__network__settings.html','');});
dan_ackme 10:735194df0097 83 </script>
dan_ackme 10:735194df0097 84 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 85 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 86 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 90 <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 91
dan_ackme 11:ea484e1b7fc4 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 93 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 95 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 96 </iframe>
dan_ackme 11:ea484e1b7fc4 97 </div>
dan_ackme 11:ea484e1b7fc4 98
dan_ackme 10:735194df0097 99 <div class="header">
dan_ackme 11:ea484e1b7fc4 100 <div class="summary">
dan_ackme 11:ea484e1b7fc4 101 <a href="#func-members">Functions</a> </div>
dan_ackme 10:735194df0097 102 <div class="headertitle">
dan_ackme 13:2b51f5267c92 103 <div class="title">Settings Methods<div class="ingroups"><a class="el" href="group__api__network.html">Network</a></div></div> </div>
dan_ackme 10:735194df0097 104 </div><!--header-->
dan_ackme 10:735194df0097 105 <div class="contents">
dan_ackme 10:735194df0097 106
dan_ackme 10:735194df0097 107 <p>API getters/setters for module network settings.
dan_ackme 10:735194df0097 108 <a href="#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 109 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 11:ea484e1b7fc4 111 Functions</h2></td></tr>
dan_ackme 13:2b51f5267c92 112 <tr class="memitem:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memItemLeft" align="right" valign="top">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 13:2b51f5267c92 113 <tr class="memdesc:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DHCP enabled. <a href="#ga65eb99f880ed739d0f3cd393e5b56eaf">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 114 <tr class="separator:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 115 <tr class="memitem:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70ec796b88eb6f8e7990dbf3eb2f2eff"></a>
dan_ackme 11:ea484e1b7fc4 116 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 117 <tr class="memdesc:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get if DHCP enabled. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 118 <tr class="separator:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 119 <tr class="memitem:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2f7ec21084d3f2835d9c1c201915a9e0"></a>
dan_ackme 11:ea484e1b7fc4 120 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 121 <tr class="memdesc:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 122 <tr class="separator:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 123 <tr class="memitem:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa418175dd3d06b870f3dd8e035cb4dd0"></a>
dan_ackme 11:ea484e1b7fc4 124 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 125 <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 126 <tr class="separator:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 127 <tr class="memitem:ga291aef702f1c10bf2970394e3458022b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga291aef702f1c10bf2970394e3458022b"></a>
dan_ackme 11:ea484e1b7fc4 128 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 129 <tr class="memdesc:ga291aef702f1c10bf2970394e3458022b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get network IP settings. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 130 <tr class="separator:ga291aef702f1c10bf2970394e3458022b"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 131 <tr class="memitem:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba16b9918e55c08285cf5b8b50dbabea"></a>
dan_ackme 11:ea484e1b7fc4 132 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 133 <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 134 <tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 17:7268f365676b 135 <tr class="memitem:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">wiconnect::NetworkInterface::getIpAddress</a> (char *buffer=NULL)</td></tr>
dan_ackme 17:7268f365676b 136 <tr class="memdesc:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current IP address of the module if possible, else return 0.0.0.0. <a href="#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">More...</a><br /></td></tr>
dan_ackme 17:7268f365676b 137 <tr class="separator:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 138 </table>
dan_ackme 11:ea484e1b7fc4 139 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 10:735194df0097 140 <p>API getters/setters for module network settings. </p>
dan_ackme 13:2b51f5267c92 141 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 17:7268f365676b 142 <a class="anchor" id="ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"></a>
dan_ackme 17:7268f365676b 143 <div class="memitem">
dan_ackme 17:7268f365676b 144 <div class="memproto">
dan_ackme 17:7268f365676b 145 <table class="memname">
dan_ackme 17:7268f365676b 146 <tr>
dan_ackme 17:7268f365676b 147 <td class="memname">const char* wiconnect::NetworkInterface::getIpAddress </td>
dan_ackme 17:7268f365676b 148 <td>(</td>
dan_ackme 17:7268f365676b 149 <td class="paramtype">char *&#160;</td>
dan_ackme 17:7268f365676b 150 <td class="paramname"><em>buffer</em> = <code>NULL</code></td><td>)</td>
dan_ackme 17:7268f365676b 151 <td></td>
dan_ackme 17:7268f365676b 152 </tr>
dan_ackme 17:7268f365676b 153 </table>
dan_ackme 17:7268f365676b 154 </div><div class="memdoc">
dan_ackme 17:7268f365676b 155
dan_ackme 17:7268f365676b 156 <p>Return the current IP address of the module if possible, else return 0.0.0.0. </p>
dan_ackme 17:7268f365676b 157 <dl class="section note"><dt>Note</dt><dd>This method is only supported in blocking mode.</dd></dl>
dan_ackme 17:7268f365676b 158 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 17:7268f365676b 159 <table class="params">
dan_ackme 17:7268f365676b 160 <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Optional, buffer to IP address string. If omitted, the IP address string is stored in a local static buffer (this is non-reentrant!) </td></tr>
dan_ackme 17:7268f365676b 161 </table>
dan_ackme 17:7268f365676b 162 </dd>
dan_ackme 17:7268f365676b 163 </dl>
dan_ackme 17:7268f365676b 164
dan_ackme 17:7268f365676b 165 </div>
dan_ackme 17:7268f365676b 166 </div>
dan_ackme 13:2b51f5267c92 167 <a class="anchor" id="ga65eb99f880ed739d0f3cd393e5b56eaf"></a>
dan_ackme 13:2b51f5267c92 168 <div class="memitem">
dan_ackme 13:2b51f5267c92 169 <div class="memproto">
dan_ackme 13:2b51f5267c92 170 <table class="memname">
dan_ackme 13:2b51f5267c92 171 <tr>
dan_ackme 13:2b51f5267c92 172 <td class="memname">WiconnectResult wiconnect::NetworkInterface::setDhcpEnabled </td>
dan_ackme 13:2b51f5267c92 173 <td>(</td>
dan_ackme 13:2b51f5267c92 174 <td class="paramtype">bool&#160;</td>
dan_ackme 13:2b51f5267c92 175 <td class="paramname"><em>enabled</em></td><td>)</td>
dan_ackme 13:2b51f5267c92 176 <td></td>
dan_ackme 13:2b51f5267c92 177 </tr>
dan_ackme 13:2b51f5267c92 178 </table>
dan_ackme 13:2b51f5267c92 179 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 180
dan_ackme 13:2b51f5267c92 181 <p>Set DHCP enabled. </p>
dan_ackme 13:2b51f5267c92 182 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 13:2b51f5267c92 183
dan_ackme 13:2b51f5267c92 184 </div>
dan_ackme 13:2b51f5267c92 185 </div>
dan_ackme 10:735194df0097 186 </div><!-- contents -->
dan_ackme 10:735194df0097 187 </div><!-- doc-content -->
dan_ackme 10:735194df0097 188 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 189 <ul>
dan_ackme 13:2b51f5267c92 190 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 191 </ul>
dan_ackme 10:735194df0097 192 </div>
dan_ackme 10:735194df0097 193 </body>
dan_ackme 13:2b51f5267c92 194 </html>