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
Diff: doc/html/group__conversion__util.html
- Revision:
- 13:2b51f5267c92
- Parent:
- 11:ea484e1b7fc4
- Child:
- 26:8067e3d463d3
diff -r 3dfec824715a -r 2b51f5267c92 doc/html/group__conversion__util.html --- a/doc/html/group__conversion__util.html Tue Aug 12 02:44:34 2014 -0700 +++ b/doc/html/group__conversion__util.html Wed Aug 13 03:14:30 2014 -0700 @@ -3,8 +3,9 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.7"/> -<title>WiConnect Library: Conversion Utilities</title> +<title>ACKme WiConnect Host Library</title> +<link rel="icon" href="favicon.ico" type="image/x-icon"> +<link rel="shortcut icon" href="favicon.ico" type="image/x-icon"> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -24,29 +25,30 @@ </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">WiConnect Library - </div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.7 --> +<div id="titlearea" style="font-family:verdana;"> + <table border='0' cellpadding='0' cellspacing='0' width="98%"> + <tr style="height:20px"><td> </td></tr> + <tr style="border-collapse: collapse; padding: 0;"> + <td style="width:20px"></td> + <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td> + <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;"> + WiConnect Host Library- API Reference Guide</td> + <td style="width:20px"></td> + </tr> + <tr><td> </td></tr> + </table> +</div><!-- Generated by Doxygen 1.8.7 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="modules.html"><span>Modules</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="index.html"><span>Library Overview</span></a></li> + <li><a href="modules.html"><span>Library API</span></a></li> + <li><a href="examples.html"><span>API Examples</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li> + <li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> @@ -115,11 +117,11 @@ static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae995028f5a70c58ccf6013c9811e79aa">wiconnect::FileInterface::fileVersionStrToInt</a> (const char *versionStr, uint32_t *versionIntPtr)</td></tr> <tr class="memdesc:gae995028f5a70c58ccf6013c9811e79aa"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to file version uint32. <br /></td></tr> <tr class="separator:gae995028f5a70c58ccf6013c9811e79aa"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">wiconnect::FileInterface::fileTypeToStr</a> (<a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type)</td></tr> +<tr class="memitem:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">wiconnect::FileInterface::fileTypeToStr</a> (<a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type)</td></tr> <tr class="separator:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7503f1876a6e1f5086d8b4bb2c1a653a"></a> -static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">wiconnect::FileInterface::fileFlagsToStr</a> (<a class="el" href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> flags, char *buffer=NULL)</td></tr> -<tr class="memdesc:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> to string. <br /></td></tr> +static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">wiconnect::FileInterface::fileFlagsToStr</a> (<a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> flags, char *buffer=NULL)</td></tr> +<tr class="memdesc:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> to string. <br /></td></tr> <tr class="separator:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga93bdb8669a70adaa61dc76073ce66591"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bdb8669a70adaa61dc76073ce66591"></a> static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga93bdb8669a70adaa61dc76073ce66591">wiconnect::NetworkInterface::strToIp</a> (const char *str, uint32_t *intPtr)</td></tr> @@ -131,23 +133,23 @@ <tr class="separator:gaff8b0af70f4d4be792b943ad3af27303"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacff5a4927d79e8b4c0d5a3050f5950b0"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">wiconnect::NetworkInterface::networkStatusToStr</a> (NetworkStatus status)</td></tr> -<tr class="memdesc:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> to string. <br /></td></tr> +<tr class="memdesc:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> to string. <br /></td></tr> <tr class="separator:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad4661f859cfadbe193793898671043c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad4661f859cfadbe193793898671043c9"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">wiconnect::NetworkInterface::signalStrengthToStr</a> (NetworkSignalStrength signalStrenth)</td></tr> -<tr class="memdesc:gad4661f859cfadbe193793898671043c9"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> to string. <br /></td></tr> +<tr class="memdesc:gad4661f859cfadbe193793898671043c9"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> to string. <br /></td></tr> <tr class="separator:gad4661f859cfadbe193793898671043c9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6216eed4cc05c37ce1ed13a0fbb6acd8"></a> static NetworkSignalStrength </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga6216eed4cc05c37ce1ed13a0fbb6acd8">wiconnect::NetworkInterface::rssiToSignalStrength</a> (int rssi)</td></tr> -<tr class="memdesc:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="mdescLeft"> </td><td class="mdescRight">Convert RSSI (in dBm) to <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a>. <br /></td></tr> +<tr class="memdesc:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="mdescLeft"> </td><td class="mdescRight">Convert RSSI (in dBm) to <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a>. <br /></td></tr> <tr class="separator:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad7d49be19f9ca91bc129668dd50d9e57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad7d49be19f9ca91bc129668dd50d9e57"></a> static NetworkSecurity </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad7d49be19f9ca91bc129668dd50d9e57">wiconnect::NetworkInterface::strToNetworkSecurity</a> (const char *str)</td></tr> -<tr class="memdesc:gad7d49be19f9ca91bc129668dd50d9e57"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to <a class="el" href="group__types__network.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a>. <br /></td></tr> +<tr class="memdesc:gad7d49be19f9ca91bc129668dd50d9e57"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to <a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a>. <br /></td></tr> <tr class="separator:gad7d49be19f9ca91bc129668dd50d9e57"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae02c549079cfb0350117cd6343a3d66f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae02c549079cfb0350117cd6343a3d66f"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">wiconnect::NetworkInterface::networkSecurityToStr</a> (NetworkSecurity security)</td></tr> -<tr class="memdesc:gae02c549079cfb0350117cd6343a3d66f"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__types__network.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> to string. <br /></td></tr> +<tr class="memdesc:gae02c549079cfb0350117cd6343a3d66f"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> to string. <br /></td></tr> <tr class="separator:gae02c549079cfb0350117cd6343a3d66f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6a479a58591ead92dcf0586e11fcad17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6a479a58591ead92dcf0586e11fcad17"></a> static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga6a479a58591ead92dcf0586e11fcad17">wiconnect::NetworkInterface::strToSsid</a> (const char *str, Ssid *ssid)</td></tr> @@ -165,9 +167,8 @@ static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga13ecaf390b4bf4a68b51a6b18e669134">wiconnect::NetworkInterface::macAddressToStr</a> (const MacAddress *macAddress, char *macStrBuffer=NULL)</td></tr> <tr class="memdesc:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> to string. <br /></td></tr> <tr class="separator:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac96e2d2fca60cba12e7429626f9186be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac96e2d2fca60cba12e7429626f9186be"></a> -static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gac96e2d2fca60cba12e7429626f9186be">wiconnect::Wiconnect::getWiconnectResultStr</a> (<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnectResult)</td></tr> -<tr class="memdesc:gac96e2d2fca60cba12e7429626f9186be"><td class="mdescLeft"> </td><td class="mdescRight">Converts a <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> to string representation. <br /></td></tr> +<tr class="memitem:gac96e2d2fca60cba12e7429626f9186be"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gac96e2d2fca60cba12e7429626f9186be">wiconnect::Wiconnect::getWiconnectResultStr</a> (<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnectResult)</td></tr> +<tr class="memdesc:gac96e2d2fca60cba12e7429626f9186be"><td class="mdescLeft"> </td><td class="mdescRight">Converts a <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> to string representation. <a href="#gac96e2d2fca60cba12e7429626f9186be">More...</a><br /></td></tr> <tr class="separator:gac96e2d2fca60cba12e7429626f9186be"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> @@ -183,7 +184,7 @@ <tr> <td class="memname">static const char* wiconnect::FileInterface::fileTypeToStr </td> <td>(</td> - <td class="paramtype"><a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> </td> + <td class="paramtype"><a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> </td> <td class="paramname"><em>type</em></td><td>)</td> <td></td> </tr> @@ -194,19 +195,49 @@ </tr> </table> </div><div class="memdoc"> -<p>Convert <a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> to string. </p> +<p>Convert <a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> to string. </p> + +</div> +</div> +<a class="anchor" id="gac96e2d2fca60cba12e7429626f9186be"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static const char* wiconnect::Wiconnect::getWiconnectResultStr </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td> + <td class="paramname"><em>wiconnectResult</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Converts a <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> to string representation. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">wiconnectResult</td><td>Result code </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>String representaion of result code </dd></dl> </div> </div> </div><!-- contents --> </div><!-- doc-content --> -<!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Tue Aug 12 2014 02:15:23 for WiConnect Library by - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li> + <li class="footer">© ACKme Networks 2014</li> </ul> </div> </body> -</html> +</html> \ No newline at end of file