esp-nimble-cpp/md__bluetooth_015_01features.html

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<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: Bluetooth 5.x features</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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('md__bluetooth_015_01features.html',''); initResizable(); });
/* @license-end */
</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)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<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><div class="header">
  <div class="headertitle"><div class="title">Bluetooth 5.x features</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="bluetooth-5x-features"></a> </p>
<h1><a class="anchor" id="about-extended-advertising"></a>
About extended advertising</h1>
<p>Extended advertising allows for much more capability and flexibility.</p>
<ul>
<li>Allows for 251 bytes of advertisement data and up to 1650 bytes when chained (configuration dependant) vs 31.</li>
<li>New PHY's (physical layers) that allow for faster data rate (2M PHY) or long range/slower data rates (CODED PHY) as well as the original 1M PHY.</li>
<li>New periodic advertising, allowing the scanning device to sync with the advertisements of a beacon. This allows for the scanning device to sleep or perform other tasks before the next expected advertisement is sent, preserving cpu cycles and power (To be implemented). <br  />
 <br  />
</li>
</ul>
<h1><a class="anchor" id="enabling-extended-advertising"></a>
Enabling extended advertising</h1>
<p>Extended advertising is supported when enabled with the config option <code>CONFIG_BT_NIMBLE_EXT_ADV</code> set to a value of 1. This is done in menuconfig under <code>Component config &gt; Bluetooth &gt; NimBLE options &gt; Enable extended advertising</code>, or set in <code><a class="el" href="nimconfig_8h.html">nimconfig.h</a></code> for Arduino, or in <code>build_flags</code> in PlatformIO.</p>
<p>When enabled the following will occur:</p><ul>
<li><code><a class="el" href="class_nim_b_l_e_scan.html#ac1307f30a881688d3a4d57bac7abe02c" title="Start scanning.">NimBLEScan::start</a></code> method will scan on both the 1M PHY and the coded PHY standards automatically.</li>
<li><code><a class="el" href="class_nim_b_l_e_client.html#a2b49bc73802bf716cf3df3b5a93f0543" title="Connect to an advertising device.">NimBLEClient::connect</a></code> will use the primary PHY the device is listening on, unless specified (see below).</li>
<li><code><a class="el" href="class_nim_b_l_e_client.html#a004a85999b1ee4283e1e8e1e31090cca" title="Set the PHY types to use when connecting to a server.">NimBLEClient::setConnectPhy</a></code> becomes available to specify the PHY's to connect with (default is all).</li>
<li><code><a class="el" href="class_nim_b_l_e_advertising.html" title="Perform and manage BLE advertising.">NimBLEAdvertising</a></code> is no longer available for use and is replaced by <code><a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a></code>. <code><a class="el" href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140" title="Get the instance of the extended advertising object.">NimBLEDevice::getAdvertising</a></code> will now return an instance of <code><a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a></code>.</li>
<li><code><a class="el" href="class_nim_b_l_e_advertisement_data.html" title="Advertisement data set by the programmer to be published by the BLE server.">NimBLEAdvertisementData</a></code> is no longer available for use and is replaced by <code><a class="el" href="class_nim_b_l_e_ext_advertisement.html" title="Extended advertisement data.">NimBLEExtAdvertisement</a></code>. This new class is where everything about the advertisement is configured, including the advertisement intervals and advertisement ended callback. </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <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>
</html>
Release v1.4.0 2022-07-31 19:38:16 +02:00			`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`<head>`
			`<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<meta http-equiv="X-UA-Compatible" content="IE=11"/>`
			`<meta name="generator" content="Doxygen 1.9.8"/>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`<meta name="viewport" content="width=device-width, initial-scale=1"/>`
			`<title>esp-nimble-cpp: Bluetooth 5.x features</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>`
			`<link href="navtree.css" rel="stylesheet" type="text/css"/>`
			`<script type="text/javascript" src="resize.js"></script>`
			`<script type="text/javascript" src="navtreedata.js"></script>`
			`<script type="text/javascript" src="navtree.js"></script>`
			`<link href="search/search.css" rel="stylesheet" type="text/css"/>`
			`<script type="text/javascript" src="search/searchdata.js"></script>`
			`<script type="text/javascript" src="search/search.js"></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">`
			`<table cellspacing="0" cellpadding="0">`
			`<tbody>`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<tr id="projectrow">`
			`<td id="projectalign">`
deploy: 275def333cbafa0188415ac3f51c8134b8ec0492 2024-12-17 02:50:27 +01:00			`<div id="projectname">esp-nimble-cpp<span id="projectnumber"> 2.0.1</span>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`</div>`
			`</td>`
			`</tr>`
			`</tbody>`
			`</table>`
			`</div>`
			`<!-- end header part -->`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<!-- Generated by Doxygen 1.9.8 -->`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`<script type="text/javascript">`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */`
			`var searchBox = new SearchBox("searchBox", "search/",'.html');`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`/* @license-end */`
			`</script>`
			`<script type="text/javascript" src="menudata.js"></script>`
			`<script type="text/javascript" src="menu.js"></script>`
			`<script type="text/javascript">`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`$(function() {`
			`initMenu('',true,false,'search.php','Search');`
			`$(document).ready(function() { init_search(); });`
			`});`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`/* @license-end */`
			`</script>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`<div id="main-nav"></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">`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */`
			`$(document).ready(function(){initNavTree('md__bluetooth_015_01features.html',''); initResizable(); });`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`/* @license-end */`
			`</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)">`
			`</div>`

			`<!-- iframe showing the search results (closed by default) -->`
			`<div id="MSearchResultsWindow">`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<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>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`</div>`

deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<div><div class="header">`
			`<div class="headertitle"><div class="title">Bluetooth 5.x features</div></div>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`</div><!--header-->`
			`<div class="contents">`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<div class="textblock"><p><a class="anchor" id="bluetooth-5x-features"></a> </p>`
			`<h1><a class="anchor" id="about-extended-advertising"></a>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`About extended advertising</h1>`
			`<p>Extended advertising allows for much more capability and flexibility.</p>`
			`<ul>`
			`<li>Allows for 251 bytes of advertisement data and up to 1650 bytes when chained (configuration dependant) vs 31.</li>`
			`<li>New PHY's (physical layers) that allow for faster data rate (2M PHY) or long range/slower data rates (CODED PHY) as well as the original 1M PHY.</li>`
			`<li>New periodic advertising, allowing the scanning device to sync with the advertisements of a beacon. This allows for the scanning device to sleep or perform other tasks before the next expected advertisement is sent, preserving cpu cycles and power (To be implemented). <br />`
			`<br />`
			`</li>`
			`</ul>`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<h1><a class="anchor" id="enabling-extended-advertising"></a>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`Enabling extended advertising</h1>`
			`<p>Extended advertising is supported when enabled with the config option <code>CONFIG_BT_NIMBLE_EXT_ADV</code> set to a value of 1. This is done in menuconfig under <code>Component config > Bluetooth > NimBLE options > Enable extended advertising</code>, or set in <code><a class="el" href="nimconfig_8h.html">nimconfig.h</a></code> for Arduino, or in <code>build_flags</code> in PlatformIO.</p>`
			`<p>When enabled the following will occur:</p><ul>`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<li><code><a class="el" href="class_nim_b_l_e_scan.html#ac1307f30a881688d3a4d57bac7abe02c" title="Start scanning.">NimBLEScan::start</a></code> method will scan on both the 1M PHY and the coded PHY standards automatically.</li>`
			`<li><code><a class="el" href="class_nim_b_l_e_client.html#a2b49bc73802bf716cf3df3b5a93f0543" title="Connect to an advertising device.">NimBLEClient::connect</a></code> will use the primary PHY the device is listening on, unless specified (see below).</li>`
			`<li><code><a class="el" href="class_nim_b_l_e_client.html#a004a85999b1ee4283e1e8e1e31090cca" title="Set the PHY types to use when connecting to a server.">NimBLEClient::setConnectPhy</a></code> becomes available to specify the PHY's to connect with (default is all).</li>`
			<li><code><a class="el" href="class_nim_b_l_e_advertising.html" title="Perform and manage BLE advertising.">NimBLEAdvertising</a></code> is no longer available for use and is replaced by <code><a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a></code>. <code><a class="el" href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140" title="Get the instance of the extended advertising object.">NimBLEDevice::getAdvertising</a></code> will now return an instance of <code><a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a></code>.</li>
Release v1.4.0 2022-07-31 19:38:16 +02:00			<li><code><a class="el" href="class_nim_b_l_e_advertisement_data.html" title="Advertisement data set by the programmer to be published by the BLE server.">NimBLEAdvertisementData</a></code> is no longer available for use and is replaced by <code><a class="el" href="class_nim_b_l_e_ext_advertisement.html" title="Extended advertisement data.">NimBLEExtAdvertisement</a></code>. This new class is where everything about the advertisement is configured, including the advertisement intervals and advertisement ended callback. </li>
			`</ul>`
			`</div></div><!-- contents -->`
			`</div><!-- PageDoc -->`
			`</div><!-- doc-content -->`
			`<!-- start footer part -->`
			`<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->`
			`<ul>`
deploy: a6ed1933bc05559145097269ee6e551884a48c4c 2024-12-15 01:45:58 +01:00			`<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>`
Release v1.4.0 2022-07-31 19:38:16 +02:00			`</ul>`
			`</div>`
			`</body>`
			`</html>`