forked from h2zero/esp-nimble-cpp
deploy: a6ed1933bc
This commit is contained in:
+183
-133
@@ -1,9 +1,9 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<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.9.1"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>esp-nimble-cpp: NimBLEUtils Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -23,10 +23,9 @@
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">esp-nimble-cpp
|
||||
 <span id="projectnumber">1.4.1</span>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">esp-nimble-cpp<span id="projectnumber"> 2.0.0</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -34,21 +33,22 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.1 -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */</script>
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
@@ -62,7 +62,7 @@ $(function() {
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function(){initNavTree('class_nim_b_l_e_utils.html',''); initResizable(); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
@@ -76,49 +76,60 @@ $(document).ready(function(){initNavTree('class_nim_b_l_e_utils.html',''); initR
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||||
<a href="class_nim_b_l_e_utils-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">NimBLEUtils Class Reference</div> </div>
|
||||
<div class="headertitle"><div class="title">NimBLEUtils Class Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>A BLE Utility class with methods for debugging and general purpose use.
|
||||
<a href="class_nim_b_l_e_utils.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_nim_b_l_e_utils_8h_source.html">NimBLEUtils.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
||||
Static Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a27df310308e72c477a3fda7a65806e01"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">dumpGapEvent</a> (ble_gap_event *event, void *arg)</td></tr>
|
||||
<tr class="memdesc:a27df310308e72c477a3fda7a65806e01"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to log the gap event info. <a href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">More...</a><br /></td></tr>
|
||||
<tr class="separator:a27df310308e72c477a3fda7a65806e01"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afb2df39418324f93a2477e314883ccae"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">gapEventToString</a> (uint8_t eventType)</td></tr>
|
||||
<tr class="memdesc:afb2df39418324f93a2477e314883ccae"><td class="mdescLeft"> </td><td class="mdescRight">Convert a GAP event type to a string representation. <a href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">More...</a><br /></td></tr>
|
||||
<tr class="memitem:afb2df39418324f93a2477e314883ccae" id="r_afb2df39418324f93a2477e314883ccae"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">gapEventToString</a> (uint8_t eventType)</td></tr>
|
||||
<tr class="memdesc:afb2df39418324f93a2477e314883ccae"><td class="mdescLeft"> </td><td class="mdescRight">Convert a GAP event type to a string representation. <br /></td></tr>
|
||||
<tr class="separator:afb2df39418324f93a2477e314883ccae"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6382edb7e8e4030b4fc65d463fa2a886"><td class="memItemLeft" align="right" valign="top">static char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">buildHexData</a> (uint8_t *target, const uint8_t *source, uint8_t length)</td></tr>
|
||||
<tr class="memdesc:a6382edb7e8e4030b4fc65d463fa2a886"><td class="mdescLeft"> </td><td class="mdescRight">Create a hex representation of data. <a href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6382edb7e8e4030b4fc65d463fa2a886"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6de9354eeba9f126aa14cfa7ed43cda4"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">advTypeToString</a> (uint8_t advType)</td></tr>
|
||||
<tr class="memdesc:a6de9354eeba9f126aa14cfa7ed43cda4"><td class="mdescLeft"> </td><td class="mdescRight">Convert the advertising type flag to a string. <a href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a53f0b19687b0706ec48d6b630e209acb" id="r_a53f0b19687b0706ec48d6b630e209acb"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a53f0b19687b0706ec48d6b630e209acb">dataToHexString</a> (const uint8_t *source, uint8_t length)</td></tr>
|
||||
<tr class="memdesc:a53f0b19687b0706ec48d6b630e209acb"><td class="mdescLeft"> </td><td class="mdescRight">Create a hexadecimal string representation of the input data. <br /></td></tr>
|
||||
<tr class="separator:a53f0b19687b0706ec48d6b630e209acb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6de9354eeba9f126aa14cfa7ed43cda4" id="r_a6de9354eeba9f126aa14cfa7ed43cda4"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">advTypeToString</a> (uint8_t advType)</td></tr>
|
||||
<tr class="memdesc:a6de9354eeba9f126aa14cfa7ed43cda4"><td class="mdescLeft"> </td><td class="mdescRight">Convert the advertising type flag to a string. <br /></td></tr>
|
||||
<tr class="separator:a6de9354eeba9f126aa14cfa7ed43cda4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9885eda5c51477aefc0ba9e1c96d5a34"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">returnCodeToString</a> (int rc)</td></tr>
|
||||
<tr class="memdesc:a9885eda5c51477aefc0ba9e1c96d5a34"><td class="mdescLeft"> </td><td class="mdescRight">Converts a return code from the NimBLE stack to a text string. <a href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a9885eda5c51477aefc0ba9e1c96d5a34" id="r_a9885eda5c51477aefc0ba9e1c96d5a34"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">returnCodeToString</a> (int rc)</td></tr>
|
||||
<tr class="memdesc:a9885eda5c51477aefc0ba9e1c96d5a34"><td class="mdescLeft"> </td><td class="mdescRight">Converts a return code from the NimBLE stack to a text string. <br /></td></tr>
|
||||
<tr class="separator:a9885eda5c51477aefc0ba9e1c96d5a34"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae521f9a6363c03e42da2f76f64ea431e"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">checkConnParams</a> (ble_gap_conn_params *params)</td></tr>
|
||||
<tr class="memdesc:ae521f9a6363c03e42da2f76f64ea431e"><td class="mdescLeft"> </td><td class="mdescRight">A function for checking validity of connection parameters. <a href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">More...</a><br /></td></tr>
|
||||
<tr class="separator:ae521f9a6363c03e42da2f76f64ea431e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6d47cf1adecd01d0102e0feec8232538" id="r_a6d47cf1adecd01d0102e0feec8232538"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a6d47cf1adecd01d0102e0feec8232538">generateAddr</a> (bool nrpa)</td></tr>
|
||||
<tr class="memdesc:a6d47cf1adecd01d0102e0feec8232538"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random BLE address. <br /></td></tr>
|
||||
<tr class="separator:a6d47cf1adecd01d0102e0feec8232538"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6b3a170f26ce51f353ff960f59739181" id="r_a6b3a170f26ce51f353ff960f59739181"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a6b3a170f26ce51f353ff960f59739181">taskWait</a> (const <a class="el" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a> &taskData, uint32_t timeout)</td></tr>
|
||||
<tr class="memdesc:a6b3a170f26ce51f353ff960f59739181"><td class="mdescLeft"> </td><td class="mdescRight">Blocks the calling task until released or timeout. <br /></td></tr>
|
||||
<tr class="separator:a6b3a170f26ce51f353ff960f59739181"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7b2de1e3827f9f6750550623dc6d9288" id="r_a7b2de1e3827f9f6750550623dc6d9288"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_utils.html#a7b2de1e3827f9f6750550623dc6d9288">taskRelease</a> (const <a class="el" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a> &taskData, int rc=0)</td></tr>
|
||||
<tr class="memdesc:a7b2de1e3827f9f6750550623dc6d9288"><td class="mdescLeft"> </td><td class="mdescRight">Release a task. <br /></td></tr>
|
||||
<tr class="separator:a7b2de1e3827f9f6750550623dc6d9288"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>A BLE Utility class with methods for debugging and general purpose use. </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a6de9354eeba9f126aa14cfa7ed43cda4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6de9354eeba9f126aa14cfa7ed43cda4">◆ </a></span>advTypeToString()</h2>
|
||||
<a id="a6de9354eeba9f126aa14cfa7ed43cda4" name="a6de9354eeba9f126aa14cfa7ed43cda4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6de9354eeba9f126aa14cfa7ed43cda4">◆ </a></span>advTypeToString()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -152,8 +163,8 @@ Static Public Member Functions</h2></td></tr>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6382edb7e8e4030b4fc65d463fa2a886"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6382edb7e8e4030b4fc65d463fa2a886">◆ </a></span>buildHexData()</h2>
|
||||
<a id="a53f0b19687b0706ec48d6b630e209acb" name="a53f0b19687b0706ec48d6b630e209acb"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a53f0b19687b0706ec48d6b630e209acb">◆ </a></span>dataToHexString()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -162,14 +173,8 @@ Static Public Member Functions</h2></td></tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">char * NimBLEUtils::buildHexData </td>
|
||||
<td class="memname">std::string NimBLEUtils::dataToHexString </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>target</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const uint8_t * </td>
|
||||
<td class="paramname"><em>source</em>, </td>
|
||||
</tr>
|
||||
@@ -192,101 +197,20 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Create a hex representation of data. </p>
|
||||
<p>Create a hexadecimal string representation of the input data. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Where to write the hex string. If this is null, we malloc storage. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">source</td><td>The start of the binary data. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data to convert. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A pointer to the formatted buffer. </dd></dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A string representation of the data. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ae521f9a6363c03e42da2f76f64ea431e"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ae521f9a6363c03e42da2f76f64ea431e">◆ </a></span>checkConnParams()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int NimBLEUtils::checkConnParams </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">ble_gap_conn_params * </td>
|
||||
<td class="paramname"><em>params</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>A function for checking validity of connection parameters. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>A pointer to the structure containing the parameters to check. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>valid == 0 or error code. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a27df310308e72c477a3fda7a65806e01"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a27df310308e72c477a3fda7a65806e01">◆ </a></span>dumpGapEvent()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void NimBLEUtils::dumpGapEvent </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">ble_gap_event * </td>
|
||||
<td class="paramname"><em>event</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">void * </td>
|
||||
<td class="paramname"><em>arg</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</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>Utility function to log the gap event info. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>A pointer to the gap event structure. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Unused. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="afb2df39418324f93a2477e314883ccae"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#afb2df39418324f93a2477e314883ccae">◆ </a></span>gapEventToString()</h2>
|
||||
<a id="afb2df39418324f93a2477e314883ccae" name="afb2df39418324f93a2477e314883ccae"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#afb2df39418324f93a2477e314883ccae">◆ </a></span>gapEventToString()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -320,8 +244,43 @@ Static Public Member Functions</h2></td></tr>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a9885eda5c51477aefc0ba9e1c96d5a34"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a9885eda5c51477aefc0ba9e1c96d5a34">◆ </a></span>returnCodeToString()</h2>
|
||||
<a id="a6d47cf1adecd01d0102e0feec8232538" name="a6d47cf1adecd01d0102e0feec8232538"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6d47cf1adecd01d0102e0feec8232538">◆ </a></span>generateAddr()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> NimBLEUtils::generateAddr </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>nrpa</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>Generate a random BLE address. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">nrpa</td><td>True to generate a non-resolvable private address, false to generate a random static address </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The generated address or a NULL address if there was an error. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a9885eda5c51477aefc0ba9e1c96d5a34" name="a9885eda5c51477aefc0ba9e1c96d5a34"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a9885eda5c51477aefc0ba9e1c96d5a34">◆ </a></span>returnCodeToString()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -353,6 +312,97 @@ Static Public Member Functions</h2></td></tr>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A string representation of the return code. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a7b2de1e3827f9f6750550623dc6d9288" name="a7b2de1e3827f9f6750550623dc6d9288"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7b2de1e3827f9f6750550623dc6d9288">◆ </a></span>taskRelease()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void NimBLEUtils::taskRelease </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const <a class="el" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a> & </td>
|
||||
<td class="paramname"><em>taskData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>flags</em> = <code>0</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</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>Release a task. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">taskData</td><td>A pointer to the task data structure. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>A return value to set in the task data structure. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6b3a170f26ce51f353ff960f59739181" name="a6b3a170f26ce51f353ff960f59739181"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6b3a170f26ce51f353ff960f59739181">◆ </a></span>taskWait()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool NimBLEUtils::taskWait </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const <a class="el" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a> & </td>
|
||||
<td class="paramname"><em>taskData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>timeout</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</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>Blocks the calling task until released or timeout. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">taskData</td><td>A pointer to the task data structure. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>The time to wait in milliseconds. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True if the task completed, false if the timeout was reached. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
@@ -361,7 +411,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_nim_b_l_e_utils.html">NimBLEUtils</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user