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__core__settings.html@10:735194df0097, 2014-08-11 (annotated)

Committer:
dan_ackme
Date:
Mon Aug 11 21:59:00 2014 -0700
Revision:
10:735194df0097
Child:
11:ea484e1b7fc4
added doc files

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 10:735194df0097 18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 19 </head>
dan_ackme 10:735194df0097 20 <body>
dan_ackme 10:735194df0097 21 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 10:735194df0097 22 <div id="titlearea">
dan_ackme 10:735194df0097 23 <table cellspacing="0" cellpadding="0">
dan_ackme 10:735194df0097 24 <tbody>
dan_ackme 10:735194df0097 25 <tr style="height: 56px;">
dan_ackme 10:735194df0097 26 <td style="padding-left: 0.5em;">
dan_ackme 10:735194df0097 27 <div id="projectname">WiConnect Library
dan_ackme 10:735194df0097 28 </div>
dan_ackme 10:735194df0097 29 </td>
dan_ackme 10:735194df0097 30 </tr>
dan_ackme 10:735194df0097 31 </tbody>
dan_ackme 10:735194df0097 32 </table>
dan_ackme 10:735194df0097 33 </div>
dan_ackme 10:735194df0097 34 <!-- end header part -->
dan_ackme 10:735194df0097 35 <!-- Generated by Doxygen 1.8.7 -->
dan_ackme 10:735194df0097 36 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 37 <ul class="tablist">
dan_ackme 10:735194df0097 38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
dan_ackme 10:735194df0097 39 <li><a href="modules.html"><span>Modules</span></a></li>
dan_ackme 10:735194df0097 40 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 10:735194df0097 41 <li><a href="files.html"><span>Files</span></a></li>
dan_ackme 10:735194df0097 42 </ul>
dan_ackme 10:735194df0097 43 </div>
dan_ackme 10:735194df0097 44 </div><!-- top -->
dan_ackme 10:735194df0097 45 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 46 <div id="nav-tree">
dan_ackme 10:735194df0097 47 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 48 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 49 </div>
dan_ackme 10:735194df0097 50 </div>
dan_ackme 10:735194df0097 51 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 52 class="ui-resizable-handle">
dan_ackme 10:735194df0097 53 </div>
dan_ackme 10:735194df0097 54 </div>
dan_ackme 10:735194df0097 55 <script type="text/javascript">
dan_ackme 10:735194df0097 56 $(document).ready(function(){initNavTree('group__api__core__settings.html','');});
dan_ackme 10:735194df0097 57 </script>
dan_ackme 10:735194df0097 58 <div id="doc-content">
dan_ackme 10:735194df0097 59 <div class="header">
dan_ackme 10:735194df0097 60 <div class="summary">
dan_ackme 10:735194df0097 61 <a href="#func-members">Functions</a> </div>
dan_ackme 10:735194df0097 62 <div class="headertitle">
dan_ackme 10:735194df0097 63 <div class="title">Settings<div class="ingroups"><a class="el" href="group__api__core.html">Core API</a></div></div> </div>
dan_ackme 10:735194df0097 64 </div><!--header-->
dan_ackme 10:735194df0097 65 <div class="contents">
dan_ackme 10:735194df0097 66
dan_ackme 10:735194df0097 67 <p>API getters/setters for core library settings.
dan_ackme 10:735194df0097 68 <a href="#details">More...</a></p>
dan_ackme 10:735194df0097 69 <table class="memberdecls">
dan_ackme 10:735194df0097 70 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 10:735194df0097 71 Functions</h2></td></tr>
dan_ackme 10:735194df0097 72 <tr class="memitem:gaaaf8be221699870053ad98911b066a32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">wiconnect::Wiconnect::setCommandDefaultTimeout</a> (int timeoutMs)</td></tr>
dan_ackme 10:735194df0097 73 <tr class="separator:gaaaf8be221699870053ad98911b066a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 74 <tr class="memitem:gad5d31980a7b1e143f00b0117468c1a7e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">wiconnect::Wiconnect::getCommandDefaultTimeout</a> ()</td></tr>
dan_ackme 10:735194df0097 75 <tr class="separator:gad5d31980a7b1e143f00b0117468c1a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 76 <tr class="memitem:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">wiconnect::Wiconnect::setPinToGpioMapper</a> (PinToGpioMapper mapper)</td></tr>
dan_ackme 10:735194df0097 77 <tr class="separator:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 78 <tr class="memitem:ga75fb083451ee530a1c19e6a4c1be185e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga75fb083451ee530a1c19e6a4c1be185e">wiconnect::Wiconnect::setDebugLogger</a> (LogFunc logFunc)</td></tr>
dan_ackme 10:735194df0097 79 <tr class="separator:ga75fb083451ee530a1c19e6a4c1be185e"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 80 <tr class="memitem:ga273f67fede26be4a3d5d909c5cf8c7e0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga273f67fede26be4a3d5d909c5cf8c7e0">wiconnect::Wiconnect::setAssertLogger</a> (LogFunc assertLogFunc)</td></tr>
dan_ackme 10:735194df0097 81 <tr class="separator:ga273f67fede26be4a3d5d909c5cf8c7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 10:735194df0097 82 </table>
dan_ackme 10:735194df0097 83 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 10:735194df0097 84 <p>API getters/setters for core library settings. </p>
dan_ackme 10:735194df0097 85 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 10:735194df0097 86 <a class="anchor" id="gad5d31980a7b1e143f00b0117468c1a7e"></a>
dan_ackme 10:735194df0097 87 <div class="memitem">
dan_ackme 10:735194df0097 88 <div class="memproto">
dan_ackme 10:735194df0097 89 <table class="memname">
dan_ackme 10:735194df0097 90 <tr>
dan_ackme 10:735194df0097 91 <td class="memname">int wiconnect::Wiconnect::getCommandDefaultTimeout </td>
dan_ackme 10:735194df0097 92 <td>(</td>
dan_ackme 10:735194df0097 93 <td class="paramname"></td><td>)</td>
dan_ackme 10:735194df0097 94 <td></td>
dan_ackme 10:735194df0097 95 </tr>
dan_ackme 10:735194df0097 96 </table>
dan_ackme 10:735194df0097 97 </div><div class="memdoc">
dan_ackme 10:735194df0097 98 <p>Returns the current default maximum API execution time. </p>
dan_ackme 10:735194df0097 99
dan_ackme 10:735194df0097 100 </div>
dan_ackme 10:735194df0097 101 </div>
dan_ackme 10:735194df0097 102 <a class="anchor" id="ga273f67fede26be4a3d5d909c5cf8c7e0"></a>
dan_ackme 10:735194df0097 103 <div class="memitem">
dan_ackme 10:735194df0097 104 <div class="memproto">
dan_ackme 10:735194df0097 105 <table class="memname">
dan_ackme 10:735194df0097 106 <tr>
dan_ackme 10:735194df0097 107 <td class="memname">void wiconnect::Wiconnect::setAssertLogger </td>
dan_ackme 10:735194df0097 108 <td>(</td>
dan_ackme 10:735194df0097 109 <td class="paramtype">LogFunc&#160;</td>
dan_ackme 10:735194df0097 110 <td class="paramname"><em>assertLogFunc</em></td><td>)</td>
dan_ackme 10:735194df0097 111 <td></td>
dan_ackme 10:735194df0097 112 </tr>
dan_ackme 10:735194df0097 113 </table>
dan_ackme 10:735194df0097 114 </div><div class="memdoc">
dan_ackme 10:735194df0097 115 <p>Sets callback used when <a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> Library hits and internal assertion.</p>
dan_ackme 10:735194df0097 116 <dl class="section note"><dt>Note</dt><dd>This is mainly for debugging. There's nothing the callback can do to fix the assertion. </dd></dl>
dan_ackme 10:735194df0097 117
dan_ackme 10:735194df0097 118 </div>
dan_ackme 10:735194df0097 119 </div>
dan_ackme 10:735194df0097 120 <a class="anchor" id="gaaaf8be221699870053ad98911b066a32"></a>
dan_ackme 10:735194df0097 121 <div class="memitem">
dan_ackme 10:735194df0097 122 <div class="memproto">
dan_ackme 10:735194df0097 123 <table class="memname">
dan_ackme 10:735194df0097 124 <tr>
dan_ackme 10:735194df0097 125 <td class="memname">void wiconnect::Wiconnect::setCommandDefaultTimeout </td>
dan_ackme 10:735194df0097 126 <td>(</td>
dan_ackme 10:735194df0097 127 <td class="paramtype">int&#160;</td>
dan_ackme 10:735194df0097 128 <td class="paramname"><em>timeoutMs</em></td><td>)</td>
dan_ackme 10:735194df0097 129 <td></td>
dan_ackme 10:735194df0097 130 </tr>
dan_ackme 10:735194df0097 131 </table>
dan_ackme 10:735194df0097 132 </div><div class="memdoc">
dan_ackme 10:735194df0097 133 <p>Sets the default maximum time an API method may execute before terminating and return a timeout error code.</p>
dan_ackme 10:735194df0097 134 <dl class="section note"><dt>Note</dt><dd>All API method (execpt some <a class="el" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c" title="Send command to WiConnect WiFi module Refer to Sending Commands To WiFi Module for more info...">sendCommand()</a>) use this default value. </dd></dl>
dan_ackme 10:735194df0097 135
dan_ackme 10:735194df0097 136 </div>
dan_ackme 10:735194df0097 137 </div>
dan_ackme 10:735194df0097 138 <a class="anchor" id="ga75fb083451ee530a1c19e6a4c1be185e"></a>
dan_ackme 10:735194df0097 139 <div class="memitem">
dan_ackme 10:735194df0097 140 <div class="memproto">
dan_ackme 10:735194df0097 141 <table class="memname">
dan_ackme 10:735194df0097 142 <tr>
dan_ackme 10:735194df0097 143 <td class="memname">void wiconnect::Wiconnect::setDebugLogger </td>
dan_ackme 10:735194df0097 144 <td>(</td>
dan_ackme 10:735194df0097 145 <td class="paramtype">LogFunc&#160;</td>
dan_ackme 10:735194df0097 146 <td class="paramname"><em>logFunc</em></td><td>)</td>
dan_ackme 10:735194df0097 147 <td></td>
dan_ackme 10:735194df0097 148 </tr>
dan_ackme 10:735194df0097 149 </table>
dan_ackme 10:735194df0097 150 </div><div class="memdoc">
dan_ackme 10:735194df0097 151 <p>Sets callback function used to debug WiConnect WiFi module RX/TX serial data. </p>
dan_ackme 10:735194df0097 152
dan_ackme 10:735194df0097 153 </div>
dan_ackme 10:735194df0097 154 </div>
dan_ackme 10:735194df0097 155 <a class="anchor" id="ga180b043ec83c53b5bf6b9ef2b187d08d"></a>
dan_ackme 10:735194df0097 156 <div class="memitem">
dan_ackme 10:735194df0097 157 <div class="memproto">
dan_ackme 10:735194df0097 158 <table class="memname">
dan_ackme 10:735194df0097 159 <tr>
dan_ackme 10:735194df0097 160 <td class="memname">void wiconnect::Wiconnect::setPinToGpioMapper </td>
dan_ackme 10:735194df0097 161 <td>(</td>
dan_ackme 10:735194df0097 162 <td class="paramtype">PinToGpioMapper&#160;</td>
dan_ackme 10:735194df0097 163 <td class="paramname"><em>mapper</em></td><td>)</td>
dan_ackme 10:735194df0097 164 <td></td>
dan_ackme 10:735194df0097 165 </tr>
dan_ackme 10:735194df0097 166 </table>
dan_ackme 10:735194df0097 167 </div><div class="memdoc">
dan_ackme 10:735194df0097 168 <p>Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO. </p>
dan_ackme 10:735194df0097 169
dan_ackme 10:735194df0097 170 </div>
dan_ackme 10:735194df0097 171 </div>
dan_ackme 10:735194df0097 172 </div><!-- contents -->
dan_ackme 10:735194df0097 173 </div><!-- doc-content -->
dan_ackme 10:735194df0097 174 <!-- start footer part -->
dan_ackme 10:735194df0097 175 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 176 <ul>
dan_ackme 10:735194df0097 177 <li class="footer">Generated on Mon Aug 11 2014 21:58:24 for WiConnect Library by
dan_ackme 10:735194df0097 178 <a href="http://www.doxygen.org/index.html">
dan_ackme 10:735194df0097 179 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 10:735194df0097 180 </ul>
dan_ackme 10:735194df0097 181 </div>
dan_ackme 10:735194df0097 182 </body>
dan_ackme 10:735194df0097 183 </html>