This commit is contained in:
h2zero
2022-01-15 15:23:57 -07:00
parent c51c0f2cf5
commit 6ae5666f7a
259 changed files with 4332 additions and 4672 deletions
+6 -273
View File
@@ -3,9 +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.9.0"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp / NimBLE-Arduino: NimBLEDevice Class Reference</title>
<title>esp-nimble-cpp: NimBLEDevice Class Reference</title>
<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>
@@ -25,8 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<span id="projectnumber">1.3.1</span>
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.3.2</span>
</div>
</td>
</tr>
@@ -34,7 +34,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.0 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
@@ -134,12 +134,6 @@ Static Public Member Functions</h2></td></tr>
<tr class="memitem:a41d4cc7c85cba0721c6649b001b31b4d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a41d4cc7c85cba0721c6649b001b31b4d">getServer</a> ()</td></tr>
<tr class="memdesc:a41d4cc7c85cba0721c6649b001b31b4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the instance of the server. <a href="class_nim_b_l_e_device.html#a41d4cc7c85cba0721c6649b001b31b4d">More...</a><br /></td></tr>
<tr class="separator:a41d4cc7c85cba0721c6649b001b31b4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac81f123fc1345596eb147c4fad125b1c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#ac81f123fc1345596eb147c4fad125b1c">setPower</a> (esp_power_level_t powerLevel, esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT)</td></tr>
<tr class="memdesc:ac81f123fc1345596eb147c4fad125b1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the transmission power. <a href="class_nim_b_l_e_device.html#ac81f123fc1345596eb147c4fad125b1c">More...</a><br /></td></tr>
<tr class="separator:ac81f123fc1345596eb147c4fad125b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34b50f12dc40ed47bdbb2b5ce4387a8c"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a34b50f12dc40ed47bdbb2b5ce4387a8c">getPower</a> (esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT)</td></tr>
<tr class="memdesc:a34b50f12dc40ed47bdbb2b5ce4387a8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the transmission power. <a href="class_nim_b_l_e_device.html#a34b50f12dc40ed47bdbb2b5ce4387a8c">More...</a><br /></td></tr>
<tr class="separator:a34b50f12dc40ed47bdbb2b5ce4387a8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d4e1013815e7b021029f447f1702833"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a8d4e1013815e7b021029f447f1702833">setCustomGapHandler</a> (gap_event_handler handler)</td></tr>
<tr class="memdesc:a8d4e1013815e7b021029f447f1702833"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a custom callback for gap events. <a href="class_nim_b_l_e_device.html#a8d4e1013815e7b021029f447f1702833">More...</a><br /></td></tr>
<tr class="separator:a8d4e1013815e7b021029f447f1702833"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -167,9 +161,6 @@ Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7d44bb960c0bb1bec02a33369c693085"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a7d44bb960c0bb1bec02a33369c693085">setSecurityCallbacks</a> (<a class="el" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a> *pCallbacks)</td></tr>
<tr class="memdesc:a7d44bb960c0bb1bec02a33369c693085"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set callbacks that will be used to handle encryption negotiation events and authentication events. <a href="class_nim_b_l_e_device.html#a7d44bb960c0bb1bec02a33369c693085">More...</a><br /></td></tr>
<tr class="separator:a7d44bb960c0bb1bec02a33369c693085"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa95f75d0a4325335ed0165f566d3a27d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#aa95f75d0a4325335ed0165f566d3a27d">setOwnAddrType</a> (uint8_t own_addr_type, bool useNRPA=false)</td></tr>
<tr class="memdesc:aa95f75d0a4325335ed0165f566d3a27d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the own address type. <a href="class_nim_b_l_e_device.html#aa95f75d0a4325335ed0165f566d3a27d">More...</a><br /></td></tr>
<tr class="separator:aa95f75d0a4325335ed0165f566d3a27d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a339157bf3d8fc712fa838e9a5127cc62"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a339157bf3d8fc712fa838e9a5127cc62">startSecurity</a> (uint16_t conn_id)</td></tr>
<tr class="memdesc:a339157bf3d8fc712fa838e9a5127cc62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the connection securing and authorization for this connection. <a href="class_nim_b_l_e_device.html#a339157bf3d8fc712fa838e9a5127cc62">More...</a><br /></td></tr>
<tr class="separator:a339157bf3d8fc712fa838e9a5127cc62"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -188,12 +179,6 @@ Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0374ab8e323277bd8498609559966924"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a0374ab8e323277bd8498609559966924">removeIgnored</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address)</td></tr>
<tr class="memdesc:a0374ab8e323277bd8498609559966924"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a device from the ignore list. <a href="class_nim_b_l_e_device.html#a0374ab8e323277bd8498609559966924">More...</a><br /></td></tr>
<tr class="separator:a0374ab8e323277bd8498609559966924"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fdc368b81152a55599e2041181cef08"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a9fdc368b81152a55599e2041181cef08">setScanDuplicateCacheSize</a> (uint16_t cacheSize)</td></tr>
<tr class="memdesc:a9fdc368b81152a55599e2041181cef08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the duplicate filter cache size for filtering scanned devices. <a href="class_nim_b_l_e_device.html#a9fdc368b81152a55599e2041181cef08">More...</a><br /></td></tr>
<tr class="separator:a9fdc368b81152a55599e2041181cef08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba7ad0c41541428243d5c5e94b512c93"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#aba7ad0c41541428243d5c5e94b512c93">setScanFilterMode</a> (uint8_t type)</td></tr>
<tr class="memdesc:aba7ad0c41541428243d5c5e94b512c93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the duplicate filter mode for filtering scanned devices. <a href="class_nim_b_l_e_device.html#aba7ad0c41541428243d5c5e94b512c93">More...</a><br /></td></tr>
<tr class="separator:aba7ad0c41541428243d5c5e94b512c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa994b01b2b5bb9f677f3cffb2f05d140"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140">getAdvertising</a> ()</td></tr>
<tr class="memdesc:aa994b01b2b5bb9f677f3cffb2f05d140"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the instance of the advertising object. <a href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140">More...</a><br /></td></tr>
<tr class="separator:aa994b01b2b5bb9f677f3cffb2f05d140"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -749,55 +734,6 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
<p>Get local MTU value set. </p>
<dl class="section return"><dt>Returns</dt><dd>The current preferred MTU setting. </dd></dl>
</div>
</div>
<a id="a34b50f12dc40ed47bdbb2b5ce4387a8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34b50f12dc40ed47bdbb2b5ce4387a8c">&#9670;&nbsp;</a></span>getPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int NimBLEDevice::getPower </td>
<td>(</td>
<td class="paramtype">esp_ble_power_type_t&#160;</td>
<td class="paramname"><em>powerType</em> = <code>ESP_BLE_PWR_TYPE_DEFAULT</code></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>Get the transmission power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">powerType</td><td>The power level to set, can be one of:<ul>
<li>ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, For connection handle 0</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, For connection handle 1</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL2 = 2, For connection handle 2</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL3 = 3, For connection handle 3</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL4 = 4, For connection handle 4</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL5 = 5, For connection handle 5</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL6 = 6, For connection handle 6</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL7 = 7, For connection handle 7</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL8 = 8, For connection handle 8</li>
<li>ESP_BLE_PWR_TYPE_ADV = 9, For advertising</li>
<li>ESP_BLE_PWR_TYPE_SCAN = 10, For scan</li>
<li>ESP_BLE_PWR_TYPE_DEFAULT = 11, For default, if not set other, it will use default value </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the power level currently used by the type specified. </dd></dl>
</div>
</div>
<a id="af93d92316454b051125460056368baec"></a>
@@ -1189,209 +1125,6 @@ Checks if it is connected or trying to connect and disconnects/stops it first. <
</dd>
</dl>
</div>
</div>
<a id="aa95f75d0a4325335ed0165f566d3a27d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa95f75d0a4325335ed0165f566d3a27d">&#9670;&nbsp;</a></span>setOwnAddrType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDevice::setOwnAddrType </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>own_addr_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>useNRPA</em> = <code>false</code>&#160;</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>Set the own address type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">own_addr_type</td><td>Own Bluetooth Device address type.<br />
The available bits are defined as:<ul>
<li>0x00: BLE_OWN_ADDR_PUBLIC</li>
<li>0x01: BLE_OWN_ADDR_RANDOM</li>
<li>0x02: BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT</li>
<li>0x03: BLE_OWN_ADDR_RPA_RANDOM_DEFAULT </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">useNRPA</td><td>If true, and address type is random, uses a non-resolvable random address. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac81f123fc1345596eb147c4fad125b1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac81f123fc1345596eb147c4fad125b1c">&#9670;&nbsp;</a></span>setPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDevice::setPower </td>
<td>(</td>
<td class="paramtype">esp_power_level_t&#160;</td>
<td class="paramname"><em>powerLevel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">esp_ble_power_type_t&#160;</td>
<td class="paramname"><em>powerType</em> = <code>ESP_BLE_PWR_TYPE_DEFAULT</code>&#160;</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>Set the transmission power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">powerLevel</td><td>The power level to set, can be one of:<ul>
<li>ESP_PWR_LVL_N12 = 0, Corresponding to -12dbm</li>
<li>ESP_PWR_LVL_N9 = 1, Corresponding to -9dbm</li>
<li>ESP_PWR_LVL_N6 = 2, Corresponding to -6dbm</li>
<li>ESP_PWR_LVL_N3 = 3, Corresponding to -3dbm</li>
<li>ESP_PWR_LVL_N0 = 4, Corresponding to 0dbm</li>
<li>ESP_PWR_LVL_P3 = 5, Corresponding to +3dbm</li>
<li>ESP_PWR_LVL_P6 = 6, Corresponding to +6dbm</li>
<li>ESP_PWR_LVL_P9 = 7, Corresponding to +9dbm </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">powerType</td><td>The BLE function to set the power level for, can be one of:<ul>
<li>ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, For connection handle 0</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, For connection handle 1</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL2 = 2, For connection handle 2</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL3 = 3, For connection handle 3</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL4 = 4, For connection handle 4</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL5 = 5, For connection handle 5</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL6 = 6, For connection handle 6</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL7 = 7, For connection handle 7</li>
<li>ESP_BLE_PWR_TYPE_CONN_HDL8 = 8, For connection handle 8</li>
<li>ESP_BLE_PWR_TYPE_ADV = 9, For advertising</li>
<li>ESP_BLE_PWR_TYPE_SCAN = 10, For scan</li>
<li>ESP_BLE_PWR_TYPE_DEFAULT = 11, For default, if not set other, it will use default value </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9fdc368b81152a55599e2041181cef08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fdc368b81152a55599e2041181cef08">&#9670;&nbsp;</a></span>setScanDuplicateCacheSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDevice::setScanDuplicateCacheSize </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>cacheSize</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>Set the duplicate filter cache size for filtering scanned devices. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cacheSize</td><td>The number of advertisements filtered before the cache is reset.<br />
Range is 10-1000, a larger value will reduce how often the same devices are reported.</td></tr>
</table>
</dd>
</dl>
<p>Must only be called before calling <a class="el" href="class_nim_b_l_e_device.html#a674d2e68d4ba0e3f84d7993f9da7d15b" title="Initialize the BLE environment.">NimBLEDevice::init</a>. </p>
</div>
</div>
<a id="aba7ad0c41541428243d5c5e94b512c93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba7ad0c41541428243d5c5e94b512c93">&#9670;&nbsp;</a></span>setScanFilterMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDevice::setScanFilterMode </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mode</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>Set the duplicate filter mode for filtering scanned devices. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>One of three possible options:<ul>
<li>CONFIG_BTDM_SCAN_DUPL_TYPE_DEVICE (0) (default)<br />
Filter by device address only, advertisements from the same address will be reported only once.</li>
<li>CONFIG_BTDM_SCAN_DUPL_TYPE_DATA (1)<br />
Filter by data only, advertisements with the same data will only be reported once,<br />
even from different addresses.</li>
<li><p class="startli">CONFIG_BTDM_SCAN_DUPL_TYPE_DATA_DEVICE (2)<br />
Filter by address and data, advertisements from the same address will be reported only once,<br />
except if the data in the advertisement has changed, then it will be reported again.</p>
<p class="startli">Must only be called before calling <a class="el" href="class_nim_b_l_e_device.html#a674d2e68d4ba0e3f84d7993f9da7d15b" title="Initialize the BLE environment.">NimBLEDevice::init</a>. </p>
</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa8e340c02418771ce72dec758d560938"></a>
@@ -1817,7 +1550,7 @@ The available bits are defined as:<ul>
<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_device.html">NimBLEDevice</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.0 </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>
</ul>
</div>
</body>