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__conversion__util.html
- Committer:
- aymangrais
- Date:
- 2015-09-28
- Revision:
- 42:8ffb253b09e7
- Parent:
- 29:b6af04b77a56
File content as of revision 42:8ffb253b09e7:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <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> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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>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/2.0/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"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('group__conversion__util.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <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> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Conversion Utilities</div> </div> </div><!--header--> <div class="contents"> <p>This contains all the conversion utility static functions. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gad74fbe6faf90d987b31380978f3ea341"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad74fbe6faf90d987b31380978f3ea341"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad74fbe6faf90d987b31380978f3ea341">wiconnect::FileInterface::fileVersionIntToStr</a> (uint32_t version, bool verbose=true, char *buffer=NULL)</td></tr> <tr class="memdesc:gad74fbe6faf90d987b31380978f3ea341"><td class="mdescLeft"> </td><td class="mdescRight">Convert file version uint32 to string. <br /></td></tr> <tr class="separator:gad74fbe6faf90d987b31380978f3ea341"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae995028f5a70c58ccf6013c9811e79aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae995028f5a70c58ccf6013c9811e79aa"></a> 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__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__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> <tr class="memdesc:ga93bdb8669a70adaa61dc76073ce66591"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to IP address. <br /></td></tr> <tr class="separator:ga93bdb8669a70adaa61dc76073ce66591"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga02e6b01f11f2283208f051b1b49b634c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga02e6b01f11f2283208f051b1b49b634c"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga02e6b01f11f2283208f051b1b49b634c">wiconnect::NetworkInterface::ipToStr</a> (uint32_t ip, char *ipStrBuffer ALLOW_NULL_STRING_BUFFER)</td></tr> <tr class="memdesc:ga02e6b01f11f2283208f051b1b49b634c"><td class="mdescLeft"> </td><td class="mdescRight">Convert IP address to string. <br /></td></tr> <tr class="separator:ga02e6b01f11f2283208f051b1b49b634c"><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__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:ga5a682e671900b9b7f931137deb847fa6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5a682e671900b9b7f931137deb847fa6"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga5a682e671900b9b7f931137deb847fa6">wiconnect::NetworkInterface::networkJoinResultToStr</a> (NetworkJoinResult joinResult)</td></tr> <tr class="memdesc:ga5a682e671900b9b7f931137deb847fa6"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> to string. <br /></td></tr> <tr class="separator:ga5a682e671900b9b7f931137deb847fa6"><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__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__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__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__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> <tr class="memdesc:ga6a479a58591ead92dcf0586e11fcad17"><td class="mdescLeft"> </td><td class="mdescRight">Convert string <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a>. <br /></td></tr> <tr class="separator:ga6a479a58591ead92dcf0586e11fcad17"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae8b534c249d503aa764017bb088f3890"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae8b534c249d503aa764017bb088f3890"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae8b534c249d503aa764017bb088f3890">wiconnect::NetworkInterface::ssidToStr</a> (const Ssid *ssid, char *ssidStrBuffer ALLOW_NULL_STRING_BUFFER)</td></tr> <tr class="memdesc:gae8b534c249d503aa764017bb088f3890"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> to string. <br /></td></tr> <tr class="separator:gae8b534c249d503aa764017bb088f3890"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga347f05073370d6872a5cdac74de39b1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga347f05073370d6872a5cdac74de39b1b"></a> static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga347f05073370d6872a5cdac74de39b1b">wiconnect::NetworkInterface::strToMacAddress</a> (const char *str, MacAddress *macAddress)</td></tr> <tr class="memdesc:ga347f05073370d6872a5cdac74de39b1b"><td class="mdescLeft"> </td><td class="mdescRight">Convert string <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a>. <br /></td></tr> <tr class="separator:ga347f05073370d6872a5cdac74de39b1b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga01520d55f1923d90fb899ddef2f21cdf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga01520d55f1923d90fb899ddef2f21cdf"></a> static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga01520d55f1923d90fb899ddef2f21cdf">wiconnect::NetworkInterface::macAddressToStr</a> (const MacAddress *macAddress, char *macStrBuffer ALLOW_NULL_STRING_BUFFER)</td></tr> <tr class="memdesc:ga01520d55f1923d90fb899ddef2f21cdf"><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:ga01520d55f1923d90fb899ddef2f21cdf"><td class="memSeparator" colspan="2"> </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> <p>This contains all the conversion utility static functions. </p> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga8d8da39cd5d2948367429ed4d8885c6b"></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::FileInterface::fileTypeToStr </td> <td>(</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> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <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 --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">© ACKme Networks 2014</li> </ul> </div> </body> </html>