mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-25 20:20:47 +01:00
1631 lines
86 KiB
HTML
1631 lines
86 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" 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: 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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">esp-nimble-cpp<span id="projectnumber"> 2.0.2</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&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&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&dn=expat.txt MIT */
|
|
$(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">
|
|
<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 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>
|
|
|
|
<p><code>#include <<a class="el" href="_nim_b_l_e_ext_advertising_8h_source.html">NimBLEExtAdvertising.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9e739c3117da31c486f8f4dd8d273c9c" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a9e739c3117da31c486f8f4dd8d273c9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a048872d3793e7e0884f958b7c0719b9f" id="r_a048872d3793e7e0884f958b7c0719b9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a048872d3793e7e0884f958b7c0719b9f">setAppearance</a> (uint16_t appearance)</td></tr>
|
|
<tr class="memdesc:a048872d3793e7e0884f958b7c0719b9f"><td class="mdescLeft"> </td><td class="mdescRight">Set the appearance. <br /></td></tr>
|
|
<tr class="separator:a048872d3793e7e0884f958b7c0719b9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e7a8731b021ba8813a3a9024171e926" id="r_a0e7a8731b021ba8813a3a9024171e926"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a0e7a8731b021ba8813a3a9024171e926">addServiceUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &serviceUUID)</td></tr>
|
|
<tr class="memdesc:a0e7a8731b021ba8813a3a9024171e926"><td class="mdescLeft"> </td><td class="mdescRight">Add a service uuid to exposed list of services. <br /></td></tr>
|
|
<tr class="separator:a0e7a8731b021ba8813a3a9024171e926"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b4bea2600ee592ffe6877fe8eac7872" id="r_a4b4bea2600ee592ffe6877fe8eac7872"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a4b4bea2600ee592ffe6877fe8eac7872">addServiceUUID</a> (const char *serviceUUID)</td></tr>
|
|
<tr class="memdesc:a4b4bea2600ee592ffe6877fe8eac7872"><td class="mdescLeft"> </td><td class="mdescRight">Add a service uuid to exposed list of services. <br /></td></tr>
|
|
<tr class="separator:a4b4bea2600ee592ffe6877fe8eac7872"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ddd5bc3a96406518580bc33aab62a84" id="r_a5ddd5bc3a96406518580bc33aab62a84"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a5ddd5bc3a96406518580bc33aab62a84">removeServiceUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &serviceUUID)</td></tr>
|
|
<tr class="memdesc:a5ddd5bc3a96406518580bc33aab62a84"><td class="mdescLeft"> </td><td class="mdescRight">Remove a service UUID from the advertisement. <br /></td></tr>
|
|
<tr class="separator:a5ddd5bc3a96406518580bc33aab62a84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cb10f1b8cbfe6706144a20ee3258c63" id="r_a7cb10f1b8cbfe6706144a20ee3258c63"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a7cb10f1b8cbfe6706144a20ee3258c63">removeServiceUUID</a> (const char *serviceUUID)</td></tr>
|
|
<tr class="memdesc:a7cb10f1b8cbfe6706144a20ee3258c63"><td class="mdescLeft"> </td><td class="mdescRight">Remove a service UUID from the advertisement. <br /></td></tr>
|
|
<tr class="separator:a7cb10f1b8cbfe6706144a20ee3258c63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab71e5616a011eae51c58b4edfbd3bc71" id="r_ab71e5616a011eae51c58b4edfbd3bc71"><td class="memItemLeft" align="right" valign="top"><a id="ab71e5616a011eae51c58b4edfbd3bc71" name="ab71e5616a011eae51c58b4edfbd3bc71"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>removeServices</b> ()</td></tr>
|
|
<tr class="memdesc:ab71e5616a011eae51c58b4edfbd3bc71"><td class="mdescLeft"> </td><td class="mdescRight">Remove all service UUIDs from the advertisement. <br /></td></tr>
|
|
<tr class="separator:ab71e5616a011eae51c58b4edfbd3bc71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af254895a52b1ee65f47ace003039514a" id="r_af254895a52b1ee65f47ace003039514a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#af254895a52b1ee65f47ace003039514a">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:af254895a52b1ee65f47ace003039514a"><td class="mdescLeft"> </td><td class="mdescRight">Set a single service to advertise as a complete list of services. <br /></td></tr>
|
|
<tr class="separator:af254895a52b1ee65f47ace003039514a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fd2471e3ffd6dca56133eeb195a7662" id="r_a1fd2471e3ffd6dca56133eeb195a7662"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a1fd2471e3ffd6dca56133eeb195a7662">setCompleteServices16</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &uuids)</td></tr>
|
|
<tr class="memdesc:a1fd2471e3ffd6dca56133eeb195a7662"><td class="mdescLeft"> </td><td class="mdescRight">Set the complete list of 16 bit services to advertise. <br /></td></tr>
|
|
<tr class="separator:a1fd2471e3ffd6dca56133eeb195a7662"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaaebae05827e8264f2ca6d4f23828bdf" id="r_aaaebae05827e8264f2ca6d4f23828bdf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#aaaebae05827e8264f2ca6d4f23828bdf">setCompleteServices32</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &uuids)</td></tr>
|
|
<tr class="memdesc:aaaebae05827e8264f2ca6d4f23828bdf"><td class="mdescLeft"> </td><td class="mdescRight">Set the complete list of 32 bit services to advertise. <br /></td></tr>
|
|
<tr class="separator:aaaebae05827e8264f2ca6d4f23828bdf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0707d6393d91e1e8912cff65e3d030ca" id="r_a0707d6393d91e1e8912cff65e3d030ca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a0707d6393d91e1e8912cff65e3d030ca">setFlags</a> (uint8_t flag)</td></tr>
|
|
<tr class="memdesc:a0707d6393d91e1e8912cff65e3d030ca"><td class="mdescLeft"> </td><td class="mdescRight">Set the advertisement flags. <br /></td></tr>
|
|
<tr class="separator:a0707d6393d91e1e8912cff65e3d030ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d994e568031faf320eb988b9a2a372e" id="r_a4d994e568031faf320eb988b9a2a372e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a4d994e568031faf320eb988b9a2a372e">setManufacturerData</a> (const uint8_t *data, size_t length)</td></tr>
|
|
<tr class="memdesc:a4d994e568031faf320eb988b9a2a372e"><td class="mdescLeft"> </td><td class="mdescRight">Set manufacturer specific data. <br /></td></tr>
|
|
<tr class="separator:a4d994e568031faf320eb988b9a2a372e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97eb35f2d1942178bc56e1a13fc0fc8b" id="r_a97eb35f2d1942178bc56e1a13fc0fc8b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a97eb35f2d1942178bc56e1a13fc0fc8b">setManufacturerData</a> (const std::string &data)</td></tr>
|
|
<tr class="memdesc:a97eb35f2d1942178bc56e1a13fc0fc8b"><td class="mdescLeft"> </td><td class="mdescRight">Set manufacturer specific data. <br /></td></tr>
|
|
<tr class="separator:a97eb35f2d1942178bc56e1a13fc0fc8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50dceb2c296b11957fc837a6dc420503" id="r_a50dceb2c296b11957fc837a6dc420503"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a50dceb2c296b11957fc837a6dc420503">setManufacturerData</a> (const std::vector< uint8_t > &data)</td></tr>
|
|
<tr class="memdesc:a50dceb2c296b11957fc837a6dc420503"><td class="mdescLeft"> </td><td class="mdescRight">Set manufacturer specific data. <br /></td></tr>
|
|
<tr class="separator:a50dceb2c296b11957fc837a6dc420503"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a691335b073c8385b3e2e75c6962fbe3f" id="r_a691335b073c8385b3e2e75c6962fbe3f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a691335b073c8385b3e2e75c6962fbe3f">setURI</a> (const std::string &uri)</td></tr>
|
|
<tr class="memdesc:a691335b073c8385b3e2e75c6962fbe3f"><td class="mdescLeft"> </td><td class="mdescRight">Set the URI to advertise. <br /></td></tr>
|
|
<tr class="separator:a691335b073c8385b3e2e75c6962fbe3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8388496cf91818138b10e898c7fc2bfc" id="r_a8388496cf91818138b10e898c7fc2bfc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a8388496cf91818138b10e898c7fc2bfc">setName</a> (const std::string &name, bool isComplete=true)</td></tr>
|
|
<tr class="memdesc:a8388496cf91818138b10e898c7fc2bfc"><td class="mdescLeft"> </td><td class="mdescRight">Set the complete name of this device. <br /></td></tr>
|
|
<tr class="separator:a8388496cf91818138b10e898c7fc2bfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45a7838bb2ca27edac22b02d77072e3c" id="r_a45a7838bb2ca27edac22b02d77072e3c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a45a7838bb2ca27edac22b02d77072e3c">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:a45a7838bb2ca27edac22b02d77072e3c"><td class="mdescLeft"> </td><td class="mdescRight">Set a single service to advertise as a partial list of services. <br /></td></tr>
|
|
<tr class="separator:a45a7838bb2ca27edac22b02d77072e3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad968d1999c50acd24170be9d8d3ba095" id="r_ad968d1999c50acd24170be9d8d3ba095"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ad968d1999c50acd24170be9d8d3ba095">setPartialServices16</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &uuids)</td></tr>
|
|
<tr class="memdesc:ad968d1999c50acd24170be9d8d3ba095"><td class="mdescLeft"> </td><td class="mdescRight">Set the partial list of services to advertise. <br /></td></tr>
|
|
<tr class="separator:ad968d1999c50acd24170be9d8d3ba095"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ef0dd63c99b5cab049a61c75c8e1ac2" id="r_a1ef0dd63c99b5cab049a61c75c8e1ac2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a1ef0dd63c99b5cab049a61c75c8e1ac2">setPartialServices32</a> (const std::vector< <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> > &uuids)</td></tr>
|
|
<tr class="memdesc:a1ef0dd63c99b5cab049a61c75c8e1ac2"><td class="mdescLeft"> </td><td class="mdescRight">Set the partial list of services to advertise. <br /></td></tr>
|
|
<tr class="separator:a1ef0dd63c99b5cab049a61c75c8e1ac2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bcfe468c00347e93c0f4ac2b46654be" id="r_a2bcfe468c00347e93c0f4ac2b46654be"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a2bcfe468c00347e93c0f4ac2b46654be">setServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, const uint8_t *data, size_t length)</td></tr>
|
|
<tr class="memdesc:a2bcfe468c00347e93c0f4ac2b46654be"><td class="mdescLeft"> </td><td class="mdescRight">Set the service data advertised for the UUID. <br /></td></tr>
|
|
<tr class="separator:a2bcfe468c00347e93c0f4ac2b46654be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56418c5b331cecae3c5b644567329c56" id="r_a56418c5b331cecae3c5b644567329c56"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a56418c5b331cecae3c5b644567329c56">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:a56418c5b331cecae3c5b644567329c56"><td class="mdescLeft"> </td><td class="mdescRight">Set the service data (UUID + data) <br /></td></tr>
|
|
<tr class="separator:a56418c5b331cecae3c5b644567329c56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f4e01c26ab1d26123d81dfbc0f6f9f8" id="r_a6f4e01c26ab1d26123d81dfbc0f6f9f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a6f4e01c26ab1d26123d81dfbc0f6f9f8">setServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, const std::vector< uint8_t > &data)</td></tr>
|
|
<tr class="memdesc:a6f4e01c26ab1d26123d81dfbc0f6f9f8"><td class="mdescLeft"> </td><td class="mdescRight">Set the service data advertised for the UUID. <br /></td></tr>
|
|
<tr class="separator:a6f4e01c26ab1d26123d81dfbc0f6f9f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f8da0cb7cf2b3e18543e78b15b46918" id="r_a4f8da0cb7cf2b3e18543e78b15b46918"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a4f8da0cb7cf2b3e18543e78b15b46918">setShortName</a> (const std::string &name)</td></tr>
|
|
<tr class="memdesc:a4f8da0cb7cf2b3e18543e78b15b46918"><td class="mdescLeft"> </td><td class="mdescRight">Set the short name. <br /></td></tr>
|
|
<tr class="separator:a4f8da0cb7cf2b3e18543e78b15b46918"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbc963aac74110423c22537f905ca259" id="r_afbc963aac74110423c22537f905ca259"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#afbc963aac74110423c22537f905ca259">setData</a> (const uint8_t *data, size_t length)</td></tr>
|
|
<tr class="memdesc:afbc963aac74110423c22537f905ca259"><td class="mdescLeft"> </td><td class="mdescRight">Set the advertisement data. <br /></td></tr>
|
|
<tr class="separator:afbc963aac74110423c22537f905ca259"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f449f67deca3d7ef66c07d61c12d28e" id="r_a1f449f67deca3d7ef66c07d61c12d28e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a1f449f67deca3d7ef66c07d61c12d28e">addData</a> (const uint8_t *data, size_t length)</td></tr>
|
|
<tr class="memdesc:a1f449f67deca3d7ef66c07d61c12d28e"><td class="mdescLeft"> </td><td class="mdescRight">Add data to the payload to be advertised. <br /></td></tr>
|
|
<tr class="separator:a1f449f67deca3d7ef66c07d61c12d28e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab387e2739a3b8b207b965ba0cda70595" id="r_ab387e2739a3b8b207b965ba0cda70595"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#ab387e2739a3b8b207b965ba0cda70595">addData</a> (const std::string &data)</td></tr>
|
|
<tr class="memdesc:ab387e2739a3b8b207b965ba0cda70595"><td class="mdescLeft"> </td><td class="mdescRight">Add data to the payload to be advertised. <br /></td></tr>
|
|
<tr class="separator:ab387e2739a3b8b207b965ba0cda70595"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d95f2975f229386023348749305df43" id="r_a2d95f2975f229386023348749305df43"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a2d95f2975f229386023348749305df43">setPreferredParams</a> (uint16_t min, uint16_t max)</td></tr>
|
|
<tr class="memdesc:a2d95f2975f229386023348749305df43"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred min and max connection intervals to advertise. <br /></td></tr>
|
|
<tr class="separator:a2d95f2975f229386023348749305df43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9f82eb0112544b977eb1947ed308525" id="r_ac9f82eb0112544b977eb1947ed308525"><td class="memItemLeft" align="right" valign="top"><a id="ac9f82eb0112544b977eb1947ed308525" name="ac9f82eb0112544b977eb1947ed308525"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>addTxPower</b> ()</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:a3a597fa81719aa3bbea590ee7b8c10fe" id="r_a3a597fa81719aa3bbea590ee7b8c10fe"><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#a3a597fa81719aa3bbea590ee7b8c10fe">setLegacyAdvertising</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a3a597fa81719aa3bbea590ee7b8c10fe"><td class="mdescLeft"> </td><td class="mdescRight">Sets wether the advertisement should use legacy (BLE 4.0, 31 bytes max) advertising. <br /></td></tr>
|
|
<tr class="separator:a3a597fa81719aa3bbea590ee7b8c10fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd02fa34228263fef2d2b875e6576316" id="r_abd02fa34228263fef2d2b875e6576316"><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#abd02fa34228263fef2d2b875e6576316">setConnectable</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:abd02fa34228263fef2d2b875e6576316"><td class="mdescLeft"> </td><td class="mdescRight">Sets wether this advertisement should advertise as a connectable device. <br /></td></tr>
|
|
<tr class="separator:abd02fa34228263fef2d2b875e6576316"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc868da6e3e33c3e21f78ac386e9eb50" id="r_adc868da6e3e33c3e21f78ac386e9eb50"><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#adc868da6e3e33c3e21f78ac386e9eb50">setScannable</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:adc868da6e3e33c3e21f78ac386e9eb50"><td class="mdescLeft"> </td><td class="mdescRight">Sets wether the advertisement has scan response data available. <br /></td></tr>
|
|
<tr class="separator:adc868da6e3e33c3e21f78ac386e9eb50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9777a0c544be6c674f4e39d56e930b8" id="r_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. <br /></td></tr>
|
|
<tr class="separator:ae9777a0c544be6c674f4e39d56e930b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c339022b5523d20cc7fa956c5dbe1be" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a4c339022b5523d20cc7fa956c5dbe1be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8522542b90067e3a53076823d2087c3" id="r_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. <br /></td></tr>
|
|
<tr class="separator:ad8522542b90067e3a53076823d2087c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa47ca630ab01d75bdea8d252d10b506" id="r_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. <br /></td></tr>
|
|
<tr class="separator:aaa47ca630ab01d75bdea8d252d10b506"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24034d49c9ebadd947db1ef839c8b138" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a24034d49c9ebadd947db1ef839c8b138"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52ee2ff1ccd011ed3410d52c0518728e" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a52ee2ff1ccd011ed3410d52c0518728e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7a99ce4a6fab8034435e6719e27e934" id="r_af7a99ce4a6fab8034435e6719e27e934"><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#af7a99ce4a6fab8034435e6719e27e934">setDirected</a> (bool enable, bool high_duty=true)</td></tr>
|
|
<tr class="memdesc:af7a99ce4a6fab8034435e6719e27e934"><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> <br /></td></tr>
|
|
<tr class="separator:af7a99ce4a6fab8034435e6719e27e934"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b1c9d52252b651163826b0c6c098439" id="r_a1b1c9d52252b651163826b0c6c098439"><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#a1b1c9d52252b651163826b0c6c098439">setAnonymous</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a1b1c9d52252b651163826b0c6c098439"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the advertisement should be anonymous. <br /></td></tr>
|
|
<tr class="separator:a1b1c9d52252b651163826b0c6c098439"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6103c5e86949d0e334101353b109775" id="r_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. <br /></td></tr>
|
|
<tr class="separator:ab6103c5e86949d0e334101353b109775"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63c2f5900752edad428304c5342b8458" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a63c2f5900752edad428304c5342b8458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02fe1652f994e5bf76dc03381e47b39e" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a02fe1652f994e5bf76dc03381e47b39e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf6c44bc23f03a72bc02c3d45a9adf1d" id="r_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. <br /></td></tr>
|
|
<tr class="separator:aaf6c44bc23f03a72bc02c3d45a9adf1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1391be9ee1b2ba1dc0548f2431b1d3af" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a1391be9ee1b2ba1dc0548f2431b1d3af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cf145aa6be376efaddadc507f5018d0" id="r_a7cf145aa6be376efaddadc507f5018d0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a7cf145aa6be376efaddadc507f5018d0">getDataLocation</a> (uint8_t type) const</td></tr>
|
|
<tr class="memdesc:a7cf145aa6be376efaddadc507f5018d0"><td class="mdescLeft"> </td><td class="mdescRight">Get the location of the data in the payload. <br /></td></tr>
|
|
<tr class="separator:a7cf145aa6be376efaddadc507f5018d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28a6b771e81c043d471d87a6aa5a7622" id="r_a28a6b771e81c043d471d87a6aa5a7622"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a28a6b771e81c043d471d87a6aa5a7622">removeData</a> (uint8_t type)</td></tr>
|
|
<tr class="memdesc:a28a6b771e81c043d471d87a6aa5a7622"><td class="mdescLeft"> </td><td class="mdescRight">Remove data from the advertisement data. <br /></td></tr>
|
|
<tr class="separator:a28a6b771e81c043d471d87a6aa5a7622"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3f915131471deba63c1275fc8557aa2" id="r_ae3f915131471deba63c1275fc8557aa2"><td class="memItemLeft" align="right" valign="top"><a id="ae3f915131471deba63c1275fc8557aa2" name="ae3f915131471deba63c1275fc8557aa2"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>getDataSize</b> () const</td></tr>
|
|
<tr class="memdesc:ae3f915131471deba63c1275fc8557aa2"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the current data. <br /></td></tr>
|
|
<tr class="separator:ae3f915131471deba63c1275fc8557aa2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54d2bb1e314a975643bcd7d038f1c164" id="r_a54d2bb1e314a975643bcd7d038f1c164"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertisement.html#a54d2bb1e314a975643bcd7d038f1c164">toString</a> () const</td></tr>
|
|
<tr class="memdesc:a54d2bb1e314a975643bcd7d038f1c164"><td class="mdescLeft"> </td><td class="mdescRight">Get the string representation of the advertisement data. <br /></td></tr>
|
|
<tr class="separator:a54d2bb1e314a975643bcd7d038f1c164"><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" name="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="ab387e2739a3b8b207b965ba0cda70595" name="ab387e2739a3b8b207b965ba0cda70595"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab387e2739a3b8b207b965ba0cda70595">◆ </a></span>addData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful, false if the data is too large. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f449f67deca3d7ef66c07d61c12d28e" name="a1f449f67deca3d7ef66c07d61c12d28e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f449f67deca3d7ef66c07d61c12d28e">◆ </a></span>addData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful, false if the data is too large. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b4bea2600ee592ffe6877fe8eac7872" name="a4b4bea2600ee592ffe6877fe8eac7872"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b4bea2600ee592ffe6877fe8eac7872">◆ </a></span>addServiceUUID() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::addServiceUUID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>serviceUUID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a service uuid to exposed list of services. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The string representation of the service to expose. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e7a8731b021ba8813a3a9024171e926" name="a0e7a8731b021ba8813a3a9024171e926"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e7a8731b021ba8813a3a9024171e926">◆ </a></span>addServiceUUID() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::addServiceUUID </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>serviceUUID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a service uuid to exposed list of services. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The UUID of the service to expose. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1391be9ee1b2ba1dc0548f2431b1d3af" name="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" name="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="a7cf145aa6be376efaddadc507f5018d0" name="a7cf145aa6be376efaddadc507f5018d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cf145aa6be376efaddadc507f5018d0">◆ </a></span>getDataLocation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int NimBLEExtAdvertisement::getDataLocation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the location of the data in the payload. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of data to search for. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 if the data is not found, otherwise the index of the data in the payload. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28a6b771e81c043d471d87a6aa5a7622" name="a28a6b771e81c043d471d87a6aa5a7622"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28a6b771e81c043d471d87a6aa5a7622">◆ </a></span>removeData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::removeData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove data from the advertisement data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of data to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful, false if the data was not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7cb10f1b8cbfe6706144a20ee3258c63" name="a7cb10f1b8cbfe6706144a20ee3258c63"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cb10f1b8cbfe6706144a20ee3258c63">◆ </a></span>removeServiceUUID() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::removeServiceUUID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>serviceUUID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove a service UUID from the advertisement. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The UUID of the service to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful or uuid not found, false if uuid error or data could not be reset. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ddd5bc3a96406518580bc33aab62a84" name="a5ddd5bc3a96406518580bc33aab62a84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ddd5bc3a96406518580bc33aab62a84">◆ </a></span>removeServiceUUID() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::removeServiceUUID </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>serviceUUID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove a service UUID from the advertisement. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The UUID of the service to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful or uuid not found, false if uuid error or data could not be reset. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02fe1652f994e5bf76dc03381e47b39e" name="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="a1b1c9d52252b651163826b0c6c098439" name="a1b1c9d52252b651163826b0c6c098439"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b1c9d52252b651163826b0c6c098439">◆ </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>enable</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">enable</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="a048872d3793e7e0884f958b7c0719b9f" name="a048872d3793e7e0884f958b7c0719b9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a048872d3793e7e0884f958b7c0719b9f">◆ </a></span>setAppearance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful.</dd></dl>
|
|
<p>If the appearance value is 0 then it will be removed from the advertisement if set previously. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af254895a52b1ee65f47ace003039514a" name="af254895a52b1ee65f47ace003039514a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af254895a52b1ee65f47ace003039514a">◆ </a></span>setCompleteServices()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1fd2471e3ffd6dca56133eeb195a7662" name="a1fd2471e3ffd6dca56133eeb195a7662"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1fd2471e3ffd6dca56133eeb195a7662">◆ </a></span>setCompleteServices16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaaebae05827e8264f2ca6d4f23828bdf" name="aaaebae05827e8264f2ca6d4f23828bdf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaaebae05827e8264f2ca6d4f23828bdf">◆ </a></span>setCompleteServices32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd02fa34228263fef2d2b875e6576316" name="abd02fa34228263fef2d2b875e6576316"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd02fa34228263fef2d2b875e6576316">◆ </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>enable</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">enable</td><td>True = connectable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afbc963aac74110423c22537f905ca259" name="afbc963aac74110423c22537f905ca259"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbc963aac74110423c22537f905ca259">◆ </a></span>setData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful, false if the data is too large.</dd></dl>
|
|
<p>This will completely replace any data that was previously set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7a99ce4a6fab8034435e6719e27e934" name="af7a99ce4a6fab8034435e6719e27e934"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7a99ce4a6fab8034435e6719e27e934">◆ </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>enable</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">enable</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" name="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="a0707d6393d91e1e8912cff65e3d030ca" name="a0707d6393d91e1e8912cff65e3d030ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0707d6393d91e1e8912cff65e3d030ca">◆ </a></span>setFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful.</dd></dl>
|
|
<p>If the flag value is 0 then it will be removed from the advertisement if set previously. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a597fa81719aa3bbea590ee7b8c10fe" name="a3a597fa81719aa3bbea590ee7b8c10fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a597fa81719aa3bbea590ee7b8c10fe">◆ </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>enable</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">enable</td><td>true = using legacy advertising. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97eb35f2d1942178bc56e1a13fc0fc8b" name="a97eb35f2d1942178bc56e1a13fc0fc8b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97eb35f2d1942178bc56e1a13fc0fc8b">◆ </a></span>setManufacturerData() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50dceb2c296b11957fc837a6dc420503" name="a50dceb2c296b11957fc837a6dc420503"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50dceb2c296b11957fc837a6dc420503">◆ </a></span>setManufacturerData() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::setManufacturerData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< uint8_t > & </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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d994e568031faf320eb988b9a2a372e" name="a4d994e568031faf320eb988b9a2a372e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d994e568031faf320eb988b9a2a372e">◆ </a></span>setManufacturerData() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::setManufacturerData </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 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>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c339022b5523d20cc7fa956c5dbe1be" name="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" name="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="a8388496cf91818138b10e898c7fc2bfc" name="a8388496cf91818138b10e898c7fc2bfc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8388496cf91818138b10e898c7fc2bfc">◆ </a></span>setName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::setName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isComplete</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">isComplete</td><td>If true the name is complete, if false it is shortened. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a45a7838bb2ca27edac22b02d77072e3c" name="a45a7838bb2ca27edac22b02d77072e3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a45a7838bb2ca27edac22b02d77072e3c">◆ </a></span>setPartialServices()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad968d1999c50acd24170be9d8d3ba095" name="ad968d1999c50acd24170be9d8d3ba095"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad968d1999c50acd24170be9d8d3ba095">◆ </a></span>setPartialServices16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1ef0dd63c99b5cab049a61c75c8e1ac2" name="a1ef0dd63c99b5cab049a61c75c8e1ac2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ef0dd63c99b5cab049a61c75c8e1ac2">◆ </a></span>setPartialServices32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2d95f2975f229386023348749305df43" name="a2d95f2975f229386023348749305df43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d95f2975f229386023348749305df43">◆ </a></span>setPreferredParams()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEExtAdvertisement::setPreferredParams </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>minInterval</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>maxInterval</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the preferred min and max connection intervals to advertise. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">minInterval</td><td>The minimum preferred connection interval. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxInterval</td><td>The Maximum preferred connection interval.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Range = 0x0006(7.5ms) to 0x0C80(4000ms), values not within the range will be limited to this range. </p><dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6103c5e86949d0e334101353b109775" name="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" name="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" name="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="adc868da6e3e33c3e21f78ac386e9eb50" name="adc868da6e3e33c3e21f78ac386e9eb50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc868da6e3e33c3e21f78ac386e9eb50">◆ </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>enable</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">enable</td><td>true = scan response is available. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa47ca630ab01d75bdea8d252d10b506" name="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="a56418c5b331cecae3c5b644567329c56" name="a56418c5b331cecae3c5b644567329c56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a56418c5b331cecae3c5b644567329c56">◆ </a></span>setServiceData() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the service data was set successfully. </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>If data length is 0 the service data will not be advertised. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f4e01c26ab1d26123d81dfbc0f6f9f8" name="a6f4e01c26ab1d26123d81dfbc0f6f9f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f4e01c26ab1d26123d81dfbc0f6f9f8">◆ </a></span>setServiceData() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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::vector< uint8_t > & </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 advertised for the UUID. </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 the service data belongs to. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to advertise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the service data was set successfully. </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>If data length is 0 the service data will not be advertised. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bcfe468c00347e93c0f4ac2b46654be" name="a2bcfe468c00347e93c0f4ac2b46654be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bcfe468c00347e93c0f4ac2b46654be">◆ </a></span>setServiceData() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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 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 service data advertised for the UUID. </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 the service data belongs to. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to advertise. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>If data length is 0 the service data will not be advertised. </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful, false if data length is too long or could not be set. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f8da0cb7cf2b3e18543e78b15b46918" name="a4f8da0cb7cf2b3e18543e78b15b46918"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f8da0cb7cf2b3e18543e78b15b46918">◆ </a></span>setShortName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63c2f5900752edad428304c5342b8458" name="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. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a691335b073c8385b3e2e75c6962fbe3f" name="a691335b073c8385b3e2e75c6962fbe3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a691335b073c8385b3e2e75c6962fbe3f">◆ </a></span>setURI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a54d2bb1e314a975643bcd7d038f1c164" name="a54d2bb1e314a975643bcd7d038f1c164"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54d2bb1e314a975643bcd7d038f1c164">◆ </a></span>toString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEExtAdvertisement::toString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the string representation of the advertisement data. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The string representation of the advertisement data. </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.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|