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

Release v1.4.0

Browse Source
This commit is contained in:
h2zero committed 2022-07-31 11:38:16 -06:00
1 parent 6ae5666f7a
commit a116f0d0c0
238 files changed
+9929 -4077
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

class_nim_b_l_e_device.html
+130 -11
View File
@@ -26,7 +26,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.3.2</span>
&#160;<span id="projectnumber">1.4.0</span>
</div>
</td>
</tr>
@@ -179,17 +179,18 @@ 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: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="memitem:aa994b01b2b5bb9f677f3cffb2f05d140"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_nim_b_l_e_ext_advertising.html">NimBLEExtAdvertising</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>
<tr class="memitem:ad0bc1019facfd79291b5353ff970473d"><td class="memItemLeft" align="right" valign="top"><a id="ad0bc1019facfd79291b5353ff970473d"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#ad0bc1019facfd79291b5353ff970473d">startAdvertising</a> ()</td></tr>
<tr class="memdesc:ad0bc1019facfd79291b5353ff970473d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to begin advertising. <br /></td></tr>
<tr class="separator:ad0bc1019facfd79291b5353ff970473d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b23c6ade03a69048f0568eb9ad3b034"><td class="memItemLeft" align="right" valign="top"><a id="a8b23c6ade03a69048f0568eb9ad3b034"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a8b23c6ade03a69048f0568eb9ad3b034">stopAdvertising</a> ()</td></tr>
<tr class="memdesc:a8b23c6ade03a69048f0568eb9ad3b034"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to stop advertising. <br /></td></tr>
<tr class="separator:a8b23c6ade03a69048f0568eb9ad3b034"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea8d74a45689590e965db210c7648e5a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#aea8d74a45689590e965db210c7648e5a">startAdvertising</a> (uint8_t inst_id, int duration=0, int max_events=0)</td></tr>
<tr class="memdesc:aea8d74a45689590e965db210c7648e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to begin advertising. <a href="class_nim_b_l_e_device.html#aea8d74a45689590e965db210c7648e5a">More...</a><br /></td></tr>
<tr class="separator:aea8d74a45689590e965db210c7648e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3be45b458aada9b37019e43840ef7275"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a3be45b458aada9b37019e43840ef7275">stopAdvertising</a> (uint8_t inst_id)</td></tr>
<tr class="memdesc:a3be45b458aada9b37019e43840ef7275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to stop advertising a data set. <a href="class_nim_b_l_e_device.html#a3be45b458aada9b37019e43840ef7275">More...</a><br /></td></tr>
<tr class="separator:a3be45b458aada9b37019e43840ef7275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c251b1d5c651ab9ef9b4819f79c1629"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#a3c251b1d5c651ab9ef9b4819f79c1629">stopAdvertising</a> ()</td></tr>
<tr class="memdesc:a3c251b1d5c651ab9ef9b4819f79c1629"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to stop all advertising. <a href="class_nim_b_l_e_device.html#a3c251b1d5c651ab9ef9b4819f79c1629">More...</a><br /></td></tr>
<tr class="separator:a3c251b1d5c651ab9ef9b4819f79c1629"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8142995252f486916dbb9de2a5b0c9e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_device.html#af8142995252f486916dbb9de2a5b0c9e">createClient</a> (<a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> peerAddress=<a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a>(&quot;&quot;))</td></tr>
<tr class="memdesc:af8142995252f486916dbb9de2a5b0c9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new client object and maintains a list of all client objects each client can connect to 1 peripheral device. <a href="class_nim_b_l_e_device.html#af8142995252f486916dbb9de2a5b0c9e">More...</a><br /></td></tr>
<tr class="separator:af8142995252f486916dbb9de2a5b0c9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -294,7 +295,7 @@ static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" hre
<p>Creates a new client object and maintains a list of all client objects each client can connect to 1 peripheral device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">peerAddress</td><td>An optional peer address that is copied to the new client object, allows for calling <a class="el" href="class_nim_b_l_e_client.html#a836438fc9d5c2001207249661ad10e01" title="Connect to the BLE Server.">NimBLEClient::connect(bool)</a> without a device or address parameter. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">peerAddress</td><td>An optional peer address that is copied to the new client object, allows for calling <a class="el" href="class_nim_b_l_e_client.html#a1f9d4ad6d3d03b819bfad82d1f39b684" title="Connect to the BLE Server.">NimBLEClient::connect(bool)</a> without a device or address parameter. </td></tr>
</table>
</dd>
</dl>
@@ -1409,6 +1410,61 @@ The available bits are defined as:<ul>
</dd>
</dl>
</div>
</div>
<a id="aea8d74a45689590e965db210c7648e5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea8d74a45689590e965db210c7648e5a">&#9670;&nbsp;</a></span>startAdvertising()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLEDevice::startAdvertising </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>duration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_events</em> = <code>0</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>Convenience function to begin advertising. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to start. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>How long to advertise for in milliseconds, 0 = forever (default). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_events</td><td>Maximum number of advertisement events to send, 0 = no limit (default). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising started successfully.</dd>
<dd>
True if advertising started successfully. </dd></dl>
</div>
</div>
<a id="a339157bf3d8fc712fa838e9a5127cc62"></a>
@@ -1444,6 +1500,69 @@ The available bits are defined as:<ul>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NimBLE stack return code, 0 = success. </dd></dl>
</div>
</div>
<a id="a3c251b1d5c651ab9ef9b4819f79c1629"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c251b1d5c651ab9ef9b4819f79c1629">&#9670;&nbsp;</a></span>stopAdvertising() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLEDevice::stopAdvertising </td>
<td>(</td>
<td class="paramname"></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>Convenience function to stop all advertising. </p>
<dl class="section return"><dt>Returns</dt><dd>True if advertising stopped successfully. </dd></dl>
</div>
</div>
<a id="a3be45b458aada9b37019e43840ef7275"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3be45b458aada9b37019e43840ef7275">&#9670;&nbsp;</a></span>stopAdvertising() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLEDevice::stopAdvertising </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</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>Convenience function to stop advertising a data set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to stop advertising. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising stopped successfully. </dd></dl>
</div>
</div>
<a id="abf8c494b54d9f0c9466c80f25dbdd961"></a>