feedc0de/esp-nimble-cpp
1
0 Fork 0
forked from h2zero/esp-nimble-cpp
Code Pull Requests Activity

v1.3.2

Browse Source
This commit is contained in:
h2zero committed 2022-01-15 15:23:57 -07:00
1 parent c51c0f2cf5
commit 6ae5666f7a
259 files changed
+4332 -4672
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

class_nim_b_l_e_client.html
+62 -6
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: NimBLEClient Class Reference</title>
<title>esp-nimble-cpp: NimBLEClient 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');
@@ -176,6 +176,9 @@ Called automatically when a characteristic or descriptor requires encryption or
<tr class="memitem:aff7d389ec48567286ea732c54d320526"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">updateConnParams</a> (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</td></tr>
<tr class="memdesc:aff7d389ec48567286ea732c54d320526"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the connection parameters: <a href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">More...</a><br /></td></tr>
<tr class="separator:aff7d389ec48567286ea732c54d320526"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33a0114a126e0e58f7b4359c74f4ed41"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a33a0114a126e0e58f7b4359c74f4ed41">setDataLen</a> (uint16_t tx_octets)</td></tr>
<tr class="memdesc:a33a0114a126e0e58f7b4359c74f4ed41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an update of the data packet length. <a href="class_nim_b_l_e_client.html#a33a0114a126e0e58f7b4359c74f4ed41">More...</a><br /></td></tr>
<tr class="separator:a33a0114a126e0e58f7b4359c74f4ed41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8cbf51caf8b3b8a0ec6ce2074ba71d"><td class="memItemLeft" align="right" valign="top"><a id="a3d8cbf51caf8b3b8a0ec6ce2074ba71d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a3d8cbf51caf8b3b8a0ec6ce2074ba71d">discoverAttributes</a> ()</td></tr>
<tr class="memdesc:a3d8cbf51caf8b3b8a0ec6ce2074ba71d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the full database of attributes that the peripheral has available. <br /></td></tr>
@@ -184,6 +187,9 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a566207f548c6b799792fc092f1748267">getConnInfo</a> ()</td></tr>
<tr class="memdesc:a566207f548c6b799792fc092f1748267"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get detailed information about the current peer connection. <br /></td></tr>
<tr class="separator:a566207f548c6b799792fc092f1748267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a178d06bed13028e4ae0384923062d18d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a178d06bed13028e4ae0384923062d18d">getLastError</a> ()</td></tr>
<tr class="memdesc:a178d06bed13028e4ae0384923062d18d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the last error code reported by the NimBLE host. <a href="class_nim_b_l_e_client.html#a178d06bed13028e4ae0384923062d18d">More...</a><br /></td></tr>
<tr class="separator:a178d06bed13028e4ae0384923062d18d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of a BLE client. </p>
@@ -427,6 +433,26 @@ have created and clears the vectors after successful connection. </td></tr>
<p>Get the connection id for this client. </p>
<dl class="section return"><dt>Returns</dt><dd>The connection id. </dd></dl>
</div>
</div>
<a id="a178d06bed13028e4ae0384923062d18d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a178d06bed13028e4ae0384923062d18d">&#9670;&nbsp;</a></span>getLastError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NimBLEClient::getLastError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the last error code reported by the NimBLE host. </p>
<dl class="section return"><dt>Returns</dt><dd>int, the NimBLE error code. </dd></dl>
</div>
</div>
<a id="ab971537eec4e53d621598eb1c760af3a"></a>
@@ -757,6 +783,36 @@ Called automatically when a characteristic or descriptor requires encryption or
</dd>
</dl>
</div>
</div>
<a id="a33a0114a126e0e58f7b4359c74f4ed41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33a0114a126e0e58f7b4359c74f4ed41">&#9670;&nbsp;</a></span>setDataLen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEClient::setDataLen </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tx_octets</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request an update of the data packet length. </p>
<ul>
<li><p class="startli">Can only be used after a connection has been established.</p>
<p class="startli">Sends a data length update request to the server the client is connected to. The Data Length Extension (DLE) allows to increase the Data Channel Payload from 27 bytes to up to 251 bytes. The server needs to support the Bluetooth 4.2 specifications, to be capable of DLE. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">tx_octets</td><td>The preferred number of payload octets to use (Range 0x001B-0x00FB). </td></tr>
</table>
</dd>
</dl>
</li>
</ul>
</div>
</div>
<a id="a93b5b7c01e58a95dcea335f837d81d07"></a>
@@ -917,7 +973,7 @@ Called automatically when a characteristic or descriptor requires encryption or
<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_client.html">NimBLEClient</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>