mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-23 13:40:55 +01:00
1226 lines
63 KiB
HTML
1226 lines
63 KiB
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">
|
|
<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 name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>esp-nimble-cpp: NimBLEExtAdvertisement 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>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">esp-nimble-cpp
|
|
 <span id="projectnumber">1.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<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-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 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_nim_b_l_e_ext_advertisement.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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_nim_b_l_e_ext_advertisement-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NimBLEExtAdvertisement Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Extended advertisement data.
|
|
<a href="class_nim_b_l_e_ext_advertisement.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9e739c3117da31c486f8f4dd8d273c9c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a9e739c3117da31c486f8f4dd8d273c9c">NimBLEExtAdvertisement</a> (uint8_t priPhy=BLE_HCI_LE_PHY_1M, uint8_t secPhy=BLE_HCI_LE_PHY_1M)</td></tr>
|
|
<tr class="memdesc:a9e739c3117da31c486f8f4dd8d273c9c"><td class="mdescLeft"> </td><td class="mdescRight">Construct a BLE extended advertisement. <a href="class_nim_b_l_e_ext_advertisement.html#a9e739c3117da31c486f8f4dd8d273c9c">More...</a><br /></td></tr>
|
|
<tr class="separator:a9e739c3117da31c486f8f4dd8d273c9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a852b96ea8e349caea04941adbe6d24b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a852b96ea8e349caea04941adbe6d24b4">setAppearance</a> (uint16_t appearance)</td></tr>
|
|
<tr class="memdesc:a852b96ea8e349caea04941adbe6d24b4"><td class="mdescLeft"> </td><td class="mdescRight">Set the appearance. <a href="class_nim_b_l_e_ext_advertisement.html#a852b96ea8e349caea04941adbe6d24b4">More...</a><br /></td></tr>
|
|
<tr class="separator:a852b96ea8e349caea04941adbe6d24b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01f8e18204071c11eb47ab243893fc53"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a01f8e18204071c11eb47ab243893fc53">setCompleteServices</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid)</td></tr>
|
|
<tr class="memdesc:a01f8e18204071c11eb47ab243893fc53"><td class="mdescLeft"> </td><td class="mdescRight">Set a single service to advertise as a complete list of services. <a href="class_nim_b_l_e_ext_advertisement.html#a01f8e18204071c11eb47ab243893fc53">More...</a><br /></td></tr>
|
|
<tr class="separator:a01f8e18204071c11eb47ab243893fc53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a1f0c1facf52f3688b53158e95153b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a0a1f0c1facf52f3688b53158e95153b6">setCompleteServices16</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &v_uuid)</td></tr>
|
|
<tr class="memdesc:a0a1f0c1facf52f3688b53158e95153b6"><td class="mdescLeft"> </td><td class="mdescRight">Set the complete list of 16 bit services to advertise. <a href="class_nim_b_l_e_ext_advertisement.html#a0a1f0c1facf52f3688b53158e95153b6">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a1f0c1facf52f3688b53158e95153b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31ef2860f84d44a110f2a6d2d8eda3fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a31ef2860f84d44a110f2a6d2d8eda3fc">setCompleteServices32</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &v_uuid)</td></tr>
|
|
<tr class="memdesc:a31ef2860f84d44a110f2a6d2d8eda3fc"><td class="mdescLeft"> </td><td class="mdescRight">Set the complete list of 32 bit services to advertise. <a href="class_nim_b_l_e_ext_advertisement.html#a31ef2860f84d44a110f2a6d2d8eda3fc">More...</a><br /></td></tr>
|
|
<tr class="separator:a31ef2860f84d44a110f2a6d2d8eda3fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5536d30615b87b68ec0c0f01292f5df9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a5536d30615b87b68ec0c0f01292f5df9">setFlags</a> (uint8_t flag)</td></tr>
|
|
<tr class="memdesc:a5536d30615b87b68ec0c0f01292f5df9"><td class="mdescLeft"> </td><td class="mdescRight">Set the advertisement flags. <a href="class_nim_b_l_e_ext_advertisement.html#a5536d30615b87b68ec0c0f01292f5df9">More...</a><br /></td></tr>
|
|
<tr class="separator:a5536d30615b87b68ec0c0f01292f5df9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e90a75173354fe9c6959004eb43b20a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a5e90a75173354fe9c6959004eb43b20a">setManufacturerData</a> (const std::string &data)</td></tr>
|
|
<tr class="memdesc:a5e90a75173354fe9c6959004eb43b20a"><td class="mdescLeft"> </td><td class="mdescRight">Set manufacturer specific data. <a href="class_nim_b_l_e_ext_advertisement.html#a5e90a75173354fe9c6959004eb43b20a">More...</a><br /></td></tr>
|
|
<tr class="separator:a5e90a75173354fe9c6959004eb43b20a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af25522e956cfeb64bd6beca881d8786e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#af25522e956cfeb64bd6beca881d8786e">setURI</a> (const std::string &uri)</td></tr>
|
|
<tr class="memdesc:af25522e956cfeb64bd6beca881d8786e"><td class="mdescLeft"> </td><td class="mdescRight">Set the URI to advertise. <a href="class_nim_b_l_e_ext_advertisement.html#af25522e956cfeb64bd6beca881d8786e">More...</a><br /></td></tr>
|
|
<tr class="separator:af25522e956cfeb64bd6beca881d8786e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d7d57268d7c54fe5492e92bc7af33d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a7d7d57268d7c54fe5492e92bc7af33d8">setName</a> (const std::string &name)</td></tr>
|
|
<tr class="memdesc:a7d7d57268d7c54fe5492e92bc7af33d8"><td class="mdescLeft"> </td><td class="mdescRight">Set the complete name of this device. <a href="class_nim_b_l_e_ext_advertisement.html#a7d7d57268d7c54fe5492e92bc7af33d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d7d57268d7c54fe5492e92bc7af33d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab76aa4b9fb743e5269cfbbae8215d8a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ab76aa4b9fb743e5269cfbbae8215d8a8">setPartialServices</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid)</td></tr>
|
|
<tr class="memdesc:ab76aa4b9fb743e5269cfbbae8215d8a8"><td class="mdescLeft"> </td><td class="mdescRight">Set a single service to advertise as a partial list of services. <a href="class_nim_b_l_e_ext_advertisement.html#ab76aa4b9fb743e5269cfbbae8215d8a8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab76aa4b9fb743e5269cfbbae8215d8a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a747ef73a02df72709cf9bd89aabc08b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a747ef73a02df72709cf9bd89aabc08b3">setPartialServices16</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &v_uuid)</td></tr>
|
|
<tr class="memdesc:a747ef73a02df72709cf9bd89aabc08b3"><td class="mdescLeft"> </td><td class="mdescRight">Set the partial list of services to advertise. <a href="class_nim_b_l_e_ext_advertisement.html#a747ef73a02df72709cf9bd89aabc08b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a747ef73a02df72709cf9bd89aabc08b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3bd08736cc70700c00432ec9ccfe94d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ad3bd08736cc70700c00432ec9ccfe94d">setPartialServices32</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &v_uuid)</td></tr>
|
|
<tr class="memdesc:ad3bd08736cc70700c00432ec9ccfe94d"><td class="mdescLeft"> </td><td class="mdescRight">Set the partial list of services to advertise. <a href="class_nim_b_l_e_ext_advertisement.html#ad3bd08736cc70700c00432ec9ccfe94d">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3bd08736cc70700c00432ec9ccfe94d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a4fd6883b11c339e397fc52f75c9ebb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a1a4fd6883b11c339e397fc52f75c9ebb">setServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, const std::string &data)</td></tr>
|
|
<tr class="memdesc:a1a4fd6883b11c339e397fc52f75c9ebb"><td class="mdescLeft"> </td><td class="mdescRight">Set the service data (UUID + data) <a href="class_nim_b_l_e_ext_advertisement.html#a1a4fd6883b11c339e397fc52f75c9ebb">More...</a><br /></td></tr>
|
|
<tr class="separator:a1a4fd6883b11c339e397fc52f75c9ebb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6220b378a1f2361c6dc76ba125936c51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a6220b378a1f2361c6dc76ba125936c51">setShortName</a> (const std::string &name)</td></tr>
|
|
<tr class="memdesc:a6220b378a1f2361c6dc76ba125936c51"><td class="mdescLeft"> </td><td class="mdescRight">Set the short name. <a href="class_nim_b_l_e_ext_advertisement.html#a6220b378a1f2361c6dc76ba125936c51">More...</a><br /></td></tr>
|
|
<tr class="separator:a6220b378a1f2361c6dc76ba125936c51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08a31a938ccd10fad61e1115c1db6274"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a08a31a938ccd10fad61e1115c1db6274">setData</a> (const uint8_t *data, size_t length)</td></tr>
|
|
<tr class="memdesc:a08a31a938ccd10fad61e1115c1db6274"><td class="mdescLeft"> </td><td class="mdescRight">Set the advertisement data. <a href="class_nim_b_l_e_ext_advertisement.html#a08a31a938ccd10fad61e1115c1db6274">More...</a><br /></td></tr>
|
|
<tr class="separator:a08a31a938ccd10fad61e1115c1db6274"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74d0b2a236d144c5bce05536ec6b8509"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a74d0b2a236d144c5bce05536ec6b8509">addData</a> (const std::string &data)</td></tr>
|
|
<tr class="memdesc:a74d0b2a236d144c5bce05536ec6b8509"><td class="mdescLeft"> </td><td class="mdescRight">Add data to the payload to be advertised. <a href="class_nim_b_l_e_ext_advertisement.html#a74d0b2a236d144c5bce05536ec6b8509">More...</a><br /></td></tr>
|
|
<tr class="separator:a74d0b2a236d144c5bce05536ec6b8509"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62d44c4e1e41d9c6a470a7ebb0b7b038"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a62d44c4e1e41d9c6a470a7ebb0b7b038">addData</a> (const uint8_t *data, size_t length)</td></tr>
|
|
<tr class="memdesc:a62d44c4e1e41d9c6a470a7ebb0b7b038"><td class="mdescLeft"> </td><td class="mdescRight">Add data to the payload to be advertised. <a href="class_nim_b_l_e_ext_advertisement.html#a62d44c4e1e41d9c6a470a7ebb0b7b038">More...</a><br /></td></tr>
|
|
<tr class="separator:a62d44c4e1e41d9c6a470a7ebb0b7b038"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9f82eb0112544b977eb1947ed308525"><td class="memItemLeft" align="right" valign="top"><a id="ac9f82eb0112544b977eb1947ed308525"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ac9f82eb0112544b977eb1947ed308525">addTxPower</a> ()</td></tr>
|
|
<tr class="memdesc:ac9f82eb0112544b977eb1947ed308525"><td class="mdescLeft"> </td><td class="mdescRight">Adds Tx power level to the advertisement data. <br /></td></tr>
|
|
<tr class="separator:ac9f82eb0112544b977eb1947ed308525"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb66ffe5783f91f03301fc705701569f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#abb66ffe5783f91f03301fc705701569f">setPreferredParams</a> (uint16_t min, uint16_t max)</td></tr>
|
|
<tr class="memdesc:abb66ffe5783f91f03301fc705701569f"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred connection interval parameters. <a href="class_nim_b_l_e_ext_advertisement.html#abb66ffe5783f91f03301fc705701569f">More...</a><br /></td></tr>
|
|
<tr class="separator:abb66ffe5783f91f03301fc705701569f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a0bcbde65ccb9e49aa93d31514c8225"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a6a0bcbde65ccb9e49aa93d31514c8225">setLegacyAdvertising</a> (bool val)</td></tr>
|
|
<tr class="memdesc:a6a0bcbde65ccb9e49aa93d31514c8225"><td class="mdescLeft"> </td><td class="mdescRight">Sets wether the advertisement should use legacy (BLE 4.0, 31 bytes max) advertising. <a href="class_nim_b_l_e_ext_advertisement.html#a6a0bcbde65ccb9e49aa93d31514c8225">More...</a><br /></td></tr>
|
|
<tr class="separator:a6a0bcbde65ccb9e49aa93d31514c8225"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6162f7b7692b5ddabf7e015893b0ffa2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a6162f7b7692b5ddabf7e015893b0ffa2">setConnectable</a> (bool val)</td></tr>
|
|
<tr class="memdesc:a6162f7b7692b5ddabf7e015893b0ffa2"><td class="mdescLeft"> </td><td class="mdescRight">Sets wether this advertisement should advertise as a connectable device. <a href="class_nim_b_l_e_ext_advertisement.html#a6162f7b7692b5ddabf7e015893b0ffa2">More...</a><br /></td></tr>
|
|
<tr class="separator:a6162f7b7692b5ddabf7e015893b0ffa2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07b1589ad58a9e09b6ba7269fec87df0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a07b1589ad58a9e09b6ba7269fec87df0">setScannable</a> (bool val)</td></tr>
|
|
<tr class="memdesc:a07b1589ad58a9e09b6ba7269fec87df0"><td class="mdescLeft"> </td><td class="mdescRight">Sets wether the advertisement has scan response data available. <a href="class_nim_b_l_e_ext_advertisement.html#a07b1589ad58a9e09b6ba7269fec87df0">More...</a><br /></td></tr>
|
|
<tr class="separator:a07b1589ad58a9e09b6ba7269fec87df0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9777a0c544be6c674f4e39d56e930b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ae9777a0c544be6c674f4e39d56e930b8">setMinInterval</a> (uint32_t mininterval)</td></tr>
|
|
<tr class="memdesc:ae9777a0c544be6c674f4e39d56e930b8"><td class="mdescLeft"> </td><td class="mdescRight">Set the minimum advertising interval. <a href="class_nim_b_l_e_ext_advertisement.html#ae9777a0c544be6c674f4e39d56e930b8">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9777a0c544be6c674f4e39d56e930b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c339022b5523d20cc7fa956c5dbe1be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a4c339022b5523d20cc7fa956c5dbe1be">setMaxInterval</a> (uint32_t maxinterval)</td></tr>
|
|
<tr class="memdesc:a4c339022b5523d20cc7fa956c5dbe1be"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum advertising interval. <a href="class_nim_b_l_e_ext_advertisement.html#a4c339022b5523d20cc7fa956c5dbe1be">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c339022b5523d20cc7fa956c5dbe1be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8522542b90067e3a53076823d2087c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ad8522542b90067e3a53076823d2087c3">setPrimaryPhy</a> (uint8_t phy)</td></tr>
|
|
<tr class="memdesc:ad8522542b90067e3a53076823d2087c3"><td class="mdescLeft"> </td><td class="mdescRight">Set the primary advertising PHY to use. <a href="class_nim_b_l_e_ext_advertisement.html#ad8522542b90067e3a53076823d2087c3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad8522542b90067e3a53076823d2087c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa47ca630ab01d75bdea8d252d10b506"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#aaa47ca630ab01d75bdea8d252d10b506">setSecondaryPhy</a> (uint8_t phy)</td></tr>
|
|
<tr class="memdesc:aaa47ca630ab01d75bdea8d252d10b506"><td class="mdescLeft"> </td><td class="mdescRight">Set the secondary advertising PHY to use. <a href="class_nim_b_l_e_ext_advertisement.html#aaa47ca630ab01d75bdea8d252d10b506">More...</a><br /></td></tr>
|
|
<tr class="separator:aaa47ca630ab01d75bdea8d252d10b506"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24034d49c9ebadd947db1ef839c8b138"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a24034d49c9ebadd947db1ef839c8b138">setScanFilter</a> (bool scanRequestWhitelistOnly, bool connectWhitelistOnly)</td></tr>
|
|
<tr class="memdesc:a24034d49c9ebadd947db1ef839c8b138"><td class="mdescLeft"> </td><td class="mdescRight">Set the filtering for the scan filter. <a href="class_nim_b_l_e_ext_advertisement.html#a24034d49c9ebadd947db1ef839c8b138">More...</a><br /></td></tr>
|
|
<tr class="separator:a24034d49c9ebadd947db1ef839c8b138"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52ee2ff1ccd011ed3410d52c0518728e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a52ee2ff1ccd011ed3410d52c0518728e">setDirectedPeer</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &addr)</td></tr>
|
|
<tr class="memdesc:a52ee2ff1ccd011ed3410d52c0518728e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the peer to directly advertise to. <a href="class_nim_b_l_e_ext_advertisement.html#a52ee2ff1ccd011ed3410d52c0518728e">More...</a><br /></td></tr>
|
|
<tr class="separator:a52ee2ff1ccd011ed3410d52c0518728e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b29a03b9a8b3a30245ff5468f239887"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a2b29a03b9a8b3a30245ff5468f239887">setDirected</a> (bool val, bool high_duty=true)</td></tr>
|
|
<tr class="memdesc:a2b29a03b9a8b3a30245ff5468f239887"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable direct advertisements to the peer set with <code><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a52ee2ff1ccd011ed3410d52c0518728e" title="Sets the peer to directly advertise to.">NimBLEExtAdvertisement::setDirectedPeer</a></code> <a href="class_nim_b_l_e_ext_advertisement.html#a2b29a03b9a8b3a30245ff5468f239887">More...</a><br /></td></tr>
|
|
<tr class="separator:a2b29a03b9a8b3a30245ff5468f239887"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3700ef4fd9078cf6dfd8c1eea4c520ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a3700ef4fd9078cf6dfd8c1eea4c520ba">setAnonymous</a> (bool val)</td></tr>
|
|
<tr class="memdesc:a3700ef4fd9078cf6dfd8c1eea4c520ba"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the advertisement should be anonymous. <a href="class_nim_b_l_e_ext_advertisement.html#a3700ef4fd9078cf6dfd8c1eea4c520ba">More...</a><br /></td></tr>
|
|
<tr class="separator:a3700ef4fd9078cf6dfd8c1eea4c520ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6103c5e86949d0e334101353b109775"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ab6103c5e86949d0e334101353b109775">setPrimaryChannels</a> (bool ch37, bool ch38, bool ch39)</td></tr>
|
|
<tr class="memdesc:ab6103c5e86949d0e334101353b109775"><td class="mdescLeft"> </td><td class="mdescRight">Sets The primary channels to advertise on. <a href="class_nim_b_l_e_ext_advertisement.html#ab6103c5e86949d0e334101353b109775">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6103c5e86949d0e334101353b109775"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63c2f5900752edad428304c5342b8458"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a63c2f5900752edad428304c5342b8458">setTxPower</a> (int8_t dbm)</td></tr>
|
|
<tr class="memdesc:a63c2f5900752edad428304c5342b8458"><td class="mdescLeft"> </td><td class="mdescRight">Sets the transmission power level for this advertisement. <a href="class_nim_b_l_e_ext_advertisement.html#a63c2f5900752edad428304c5342b8458">More...</a><br /></td></tr>
|
|
<tr class="separator:a63c2f5900752edad428304c5342b8458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02fe1652f994e5bf76dc03381e47b39e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a02fe1652f994e5bf76dc03381e47b39e">setAddress</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &addr)</td></tr>
|
|
<tr class="memdesc:a02fe1652f994e5bf76dc03381e47b39e"><td class="mdescLeft"> </td><td class="mdescRight">Set the address to use for this advertisement. <a href="class_nim_b_l_e_ext_advertisement.html#a02fe1652f994e5bf76dc03381e47b39e">More...</a><br /></td></tr>
|
|
<tr class="separator:a02fe1652f994e5bf76dc03381e47b39e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf6c44bc23f03a72bc02c3d45a9adf1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#aaf6c44bc23f03a72bc02c3d45a9adf1d">enableScanRequestCallback</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:aaf6c44bc23f03a72bc02c3d45a9adf1d"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the scan response request callback should be called. <a href="class_nim_b_l_e_ext_advertisement.html#aaf6c44bc23f03a72bc02c3d45a9adf1d">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf6c44bc23f03a72bc02c3d45a9adf1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1391be9ee1b2ba1dc0548f2431b1d3af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a1391be9ee1b2ba1dc0548f2431b1d3af">clearData</a> ()</td></tr>
|
|
<tr class="memdesc:a1391be9ee1b2ba1dc0548f2431b1d3af"><td class="mdescLeft"> </td><td class="mdescRight">Clears the data stored in this instance, does not change settings. <a href="class_nim_b_l_e_ext_advertisement.html#a1391be9ee1b2ba1dc0548f2431b1d3af">More...</a><br /></td></tr>
|
|
<tr class="separator:a1391be9ee1b2ba1dc0548f2431b1d3af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec383f3f61780ee5bda3599543c84dd8"><td class="memItemLeft" align="right" valign="top"><a id="aec383f3f61780ee5bda3599543c84dd8"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#aec383f3f61780ee5bda3599543c84dd8">getDataSize</a> ()</td></tr>
|
|
<tr class="memdesc:aec383f3f61780ee5bda3599543c84dd8"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the current data. <br /></td></tr>
|
|
<tr class="separator:aec383f3f61780ee5bda3599543c84dd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Extended advertisement data. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a9e739c3117da31c486f8f4dd8d273c9c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e739c3117da31c486f8f4dd8d273c9c">◆ </a></span>NimBLEExtAdvertisement()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEExtAdvertisement::NimBLEExtAdvertisement </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>priPhy</em> = <code>BLE_HCI_LE_PHY_1M</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>secPhy</em> = <code>BLE_HCI_LE_PHY_1M</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a BLE extended advertisement. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">priPhy</td><td>The primary Phy to advertise on, can be one of:<ul>
|
|
<li>BLE_HCI_LE_PHY_1M</li>
|
|
<li>BLE_HCI_LE_PHY_CODED </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">secPhy</td><td>The secondary Phy to advertise on, can be one of:<ul>
|
|
<li>BLE_HCI_LE_PHY_1M</li>
|
|
<li>BLE_HCI_LE_PHY_2M</li>
|
|
<li>BLE_HCI_LE_PHY_CODED </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a74d0b2a236d144c5bce05536ec6b8509"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74d0b2a236d144c5bce05536ec6b8509">◆ </a></span>addData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::addData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add data to the payload to be advertised. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be added to the payload. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62d44c4e1e41d9c6a470a7ebb0b7b038"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62d44c4e1e41d9c6a470a7ebb0b7b038">◆ </a></span>addData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::addData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add data to the payload to be advertised. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be added to the payload. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The size of data to be added to the payload. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1391be9ee1b2ba1dc0548f2431b1d3af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1391be9ee1b2ba1dc0548f2431b1d3af">◆ </a></span>clearData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::clearData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the data stored in this instance, does not change settings. </p>
|
|
<p>This will clear all data but preserves advertising parameter settings. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf6c44bc23f03a72bc02c3d45a9adf1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf6c44bc23f03a72bc02c3d45a9adf1d">◆ </a></span>enableScanRequestCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::enableScanRequestCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets whether the scan response request callback should be called. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>If true the scan response request callback will be called for this advertisement. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02fe1652f994e5bf76dc03381e47b39e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02fe1652f994e5bf76dc03381e47b39e">◆ </a></span>setAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> & </td>
|
|
<td class="paramname"><em>addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the address to use for this advertisement. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>The address to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3700ef4fd9078cf6dfd8c1eea4c520ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3700ef4fd9078cf6dfd8c1eea4c520ba">◆ </a></span>setAnonymous()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setAnonymous </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>val</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets whether the advertisement should be anonymous. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>Set to true to enable anonymous advertising.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Anonymous advertising omits the device's address from the advertisement. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a852b96ea8e349caea04941adbe6d24b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a852b96ea8e349caea04941adbe6d24b4">◆ </a></span>setAppearance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setAppearance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>appearance</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the appearance. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">appearance</td><td>The appearance code value.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>See also: <a href="https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml">https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a01f8e18204071c11eb47ab243893fc53"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a01f8e18204071c11eb47ab243893fc53">◆ </a></span>setCompleteServices()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setCompleteServices </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td>
|
|
<td class="paramname"><em>uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a single service to advertise as a complete list of services. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The service to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a1f0c1facf52f3688b53158e95153b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a1f0c1facf52f3688b53158e95153b6">◆ </a></span>setCompleteServices16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setCompleteServices16 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > & </td>
|
|
<td class="paramname"><em>v_uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the complete list of 16 bit services to advertise. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 16 bit UUID's to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a31ef2860f84d44a110f2a6d2d8eda3fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a31ef2860f84d44a110f2a6d2d8eda3fc">◆ </a></span>setCompleteServices32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setCompleteServices32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > & </td>
|
|
<td class="paramname"><em>v_uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the complete list of 32 bit services to advertise. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 32 bit UUID's to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6162f7b7692b5ddabf7e015893b0ffa2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6162f7b7692b5ddabf7e015893b0ffa2">◆ </a></span>setConnectable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setConnectable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>val</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets wether this advertisement should advertise as a connectable device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>True = connectable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a08a31a938ccd10fad61e1115c1db6274"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a08a31a938ccd10fad61e1115c1db6274">◆ </a></span>setData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the advertisement data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be set as the payload. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The size of data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This will completely replace any data that was previously set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2b29a03b9a8b3a30245ff5468f239887"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b29a03b9a8b3a30245ff5468f239887">◆ </a></span>setDirected()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setDirected </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>val</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>high_duty</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable or disable direct advertisements to the peer set with <code><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a52ee2ff1ccd011ed3410d52c0518728e" title="Sets the peer to directly advertise to.">NimBLEExtAdvertisement::setDirectedPeer</a></code> </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>true = send directed advertisements to peer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">high_duty</td><td>true = use fast advertising rate, default - true. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a52ee2ff1ccd011ed3410d52c0518728e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52ee2ff1ccd011ed3410d52c0518728e">◆ </a></span>setDirectedPeer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setDirectedPeer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> & </td>
|
|
<td class="paramname"><em>addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the peer to directly advertise to. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>The address of the peer to direct the advertisements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5536d30615b87b68ec0c0f01292f5df9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5536d30615b87b68ec0c0f01292f5df9">◆ </a></span>setFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>flag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the advertisement flags. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flag</td><td>The flags to be set in the advertisement.<ul>
|
|
<li>BLE_HS_ADV_F_DISC_LTD</li>
|
|
<li>BLE_HS_ADV_F_DISC_GEN</li>
|
|
<li>BLE_HS_ADV_F_BREDR_UNSUP - must always use with NimBLE </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6a0bcbde65ccb9e49aa93d31514c8225"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a0bcbde65ccb9e49aa93d31514c8225">◆ </a></span>setLegacyAdvertising()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setLegacyAdvertising </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>val</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets wether the advertisement should use legacy (BLE 4.0, 31 bytes max) advertising. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>true = using legacy advertising. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e90a75173354fe9c6959004eb43b20a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e90a75173354fe9c6959004eb43b20a">◆ </a></span>setManufacturerData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setManufacturerData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set manufacturer specific data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The manufacturer data to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c339022b5523d20cc7fa956c5dbe1be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c339022b5523d20cc7fa956c5dbe1be">◆ </a></span>setMaxInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setMaxInterval </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>maxinterval</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the maximum advertising interval. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxinterval</td><td>Maximum value for advertising interval in 0.625ms units, 0 = use default. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9777a0c544be6c674f4e39d56e930b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9777a0c544be6c674f4e39d56e930b8">◆ </a></span>setMinInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setMinInterval </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mininterval</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the minimum advertising interval. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mininterval</td><td>Minimum value for advertising interval in 0.625ms units, 0 = use default. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d7d57268d7c54fe5492e92bc7af33d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d7d57268d7c54fe5492e92bc7af33d8">◆ </a></span>setName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the complete name of this device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab76aa4b9fb743e5269cfbbae8215d8a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab76aa4b9fb743e5269cfbbae8215d8a8">◆ </a></span>setPartialServices()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setPartialServices </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td>
|
|
<td class="paramname"><em>uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a single service to advertise as a partial list of services. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The service to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a747ef73a02df72709cf9bd89aabc08b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a747ef73a02df72709cf9bd89aabc08b3">◆ </a></span>setPartialServices16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setPartialServices16 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > & </td>
|
|
<td class="paramname"><em>v_uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the partial list of services to advertise. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 16 bit UUID's to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3bd08736cc70700c00432ec9ccfe94d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3bd08736cc70700c00432ec9ccfe94d">◆ </a></span>setPartialServices32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setPartialServices32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > & </td>
|
|
<td class="paramname"><em>v_uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the partial list of services to advertise. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 32 bit UUID's to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb66ffe5783f91f03301fc705701569f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb66ffe5783f91f03301fc705701569f">◆ </a></span>setPreferredParams()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setPreferredParams </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>min</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the preferred connection interval parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">min</td><td>The minimum interval desired. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max</td><td>The maximum interval desired. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6103c5e86949d0e334101353b109775"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6103c5e86949d0e334101353b109775">◆ </a></span>setPrimaryChannels()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setPrimaryChannels </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>ch37</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>ch38</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>ch39</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets The primary channels to advertise on. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ch37</td><td>Advertise on channel 37. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ch38</td><td>Advertise on channel 38. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ch39</td><td>Advertise on channel 39.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This will set a bitmask using the input parameters to allow different <br />
|
|
combinations. If all inputs are false then all 3 channels will be used. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8522542b90067e3a53076823d2087c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8522542b90067e3a53076823d2087c3">◆ </a></span>setPrimaryPhy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setPrimaryPhy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>phy</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the primary advertising PHY to use. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">phy</td><td>Can be one of following constants:<ul>
|
|
<li>BLE_HCI_LE_PHY_1M</li>
|
|
<li>BLE_HCI_LE_PHY_CODED </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24034d49c9ebadd947db1ef839c8b138"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24034d49c9ebadd947db1ef839c8b138">◆ </a></span>setScanFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setScanFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>scanRequestWhitelistOnly</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>connectWhitelistOnly</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the filtering for the scan filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">scanRequestWhitelistOnly</td><td>If true, only allow scan requests from those on the white list. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">connectWhitelistOnly</td><td>If true, only allow connections from those on the white list. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07b1589ad58a9e09b6ba7269fec87df0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07b1589ad58a9e09b6ba7269fec87df0">◆ </a></span>setScannable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setScannable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>val</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets wether the advertisement has scan response data available. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>true = scan response is available. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa47ca630ab01d75bdea8d252d10b506"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa47ca630ab01d75bdea8d252d10b506">◆ </a></span>setSecondaryPhy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setSecondaryPhy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>phy</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the secondary advertising PHY to use. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">phy</td><td>Can be one of following constants:<ul>
|
|
<li>BLE_HCI_LE_PHY_1M</li>
|
|
<li>BLE_HCI_LE_PHY_2M</li>
|
|
<li>BLE_HCI_LE_PHY_CODED </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a4fd6883b11c339e397fc52f75c9ebb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a4fd6883b11c339e397fc52f75c9ebb">◆ </a></span>setServiceData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setServiceData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td>
|
|
<td class="paramname"><em>uuid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the service data (UUID + data) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID to set with the service data. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be associated with the service data advertised. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6220b378a1f2361c6dc76ba125936c51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6220b378a1f2361c6dc76ba125936c51">◆ </a></span>setShortName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setShortName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the short name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The short name of the device. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63c2f5900752edad428304c5342b8458"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63c2f5900752edad428304c5342b8458">◆ </a></span>setTxPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setTxPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>dbm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the transmission power level for this advertisement. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dbm</td><td>the transmission power to use in dbm.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The allowable value range depends on device hardware. <br />
|
|
The ESP32C3 and ESP32S3 have a range of -27 to +18. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af25522e956cfeb64bd6beca881d8786e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af25522e956cfeb64bd6beca881d8786e">◆ </a></span>setURI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEExtAdvertisement::setURI </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>uri</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the URI to advertise. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uri</td><td>The uri to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<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_ext_advertisement.html">NimBLEExtAdvertisement</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>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|