mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
1213 lines
66 KiB
HTML
1213 lines
66 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: NimBLEAdvertisedDevice 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.3.2</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_advertised_device.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_advertised_device-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NimBLEAdvertisedDevice Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A representation of a BLE advertised device found by a scan.
|
|
<a href="class_nim_b_l_e_advertised_device.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:ab8972714ecd578fca51fb63d9834a34e"><td class="memItemLeft" align="right" valign="top"><a id="ab8972714ecd578fca51fb63d9834a34e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ab8972714ecd578fca51fb63d9834a34e">NimBLEAdvertisedDevice</a> ()</td></tr>
|
|
<tr class="memdesc:ab8972714ecd578fca51fb63d9834a34e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
|
|
<tr class="separator:ab8972714ecd578fca51fb63d9834a34e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa60721a7b5b44a3bb66980f003517579"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#aa60721a7b5b44a3bb66980f003517579">getAddress</a> ()</td></tr>
|
|
<tr class="memdesc:aa60721a7b5b44a3bb66980f003517579"><td class="mdescLeft"> </td><td class="mdescRight">Get the address of the advertising device. <a href="class_nim_b_l_e_advertised_device.html#aa60721a7b5b44a3bb66980f003517579">More...</a><br /></td></tr>
|
|
<tr class="separator:aa60721a7b5b44a3bb66980f003517579"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d07ee4c38de4170db24a5e01663ee6d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9d07ee4c38de4170db24a5e01663ee6d">getAdvType</a> ()</td></tr>
|
|
<tr class="memdesc:a9d07ee4c38de4170db24a5e01663ee6d"><td class="mdescLeft"> </td><td class="mdescRight">Get the advertisement type. <a href="class_nim_b_l_e_advertised_device.html#a9d07ee4c38de4170db24a5e01663ee6d">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d07ee4c38de4170db24a5e01663ee6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a228afa5e43421b4d96d9c08241718309"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a228afa5e43421b4d96d9c08241718309">getAppearance</a> ()</td></tr>
|
|
<tr class="memdesc:a228afa5e43421b4d96d9c08241718309"><td class="mdescLeft"> </td><td class="mdescRight">Get the appearance. <a href="class_nim_b_l_e_advertised_device.html#a228afa5e43421b4d96d9c08241718309">More...</a><br /></td></tr>
|
|
<tr class="separator:a228afa5e43421b4d96d9c08241718309"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a7a36e9937e16ffab4f1543ea54073f"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9a7a36e9937e16ffab4f1543ea54073f">getAdvInterval</a> ()</td></tr>
|
|
<tr class="memdesc:a9a7a36e9937e16ffab4f1543ea54073f"><td class="mdescLeft"> </td><td class="mdescRight">Get the advertisement interval. <a href="class_nim_b_l_e_advertised_device.html#a9a7a36e9937e16ffab4f1543ea54073f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a7a36e9937e16ffab4f1543ea54073f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33fcdc3bf5107c157b10ad4519938c9f"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a33fcdc3bf5107c157b10ad4519938c9f">getMinInterval</a> ()</td></tr>
|
|
<tr class="memdesc:a33fcdc3bf5107c157b10ad4519938c9f"><td class="mdescLeft"> </td><td class="mdescRight">Get the preferred min connection interval. <a href="class_nim_b_l_e_advertised_device.html#a33fcdc3bf5107c157b10ad4519938c9f">More...</a><br /></td></tr>
|
|
<tr class="separator:a33fcdc3bf5107c157b10ad4519938c9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a450eca96c605f199d2786a044612db17"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a450eca96c605f199d2786a044612db17">getMaxInterval</a> ()</td></tr>
|
|
<tr class="memdesc:a450eca96c605f199d2786a044612db17"><td class="mdescLeft"> </td><td class="mdescRight">Get the preferred max connection interval. <a href="class_nim_b_l_e_advertised_device.html#a450eca96c605f199d2786a044612db17">More...</a><br /></td></tr>
|
|
<tr class="separator:a450eca96c605f199d2786a044612db17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa334006230601cc5c6429b18819a2e2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2">getManufacturerData</a> ()</td></tr>
|
|
<tr class="memdesc:afa334006230601cc5c6429b18819a2e2"><td class="mdescLeft"> </td><td class="mdescRight">Get the manufacturer data. <a href="class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2">More...</a><br /></td></tr>
|
|
<tr class="separator:afa334006230601cc5c6429b18819a2e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad65f8040a142f8d6d0763d4876f0d22e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ad65f8040a142f8d6d0763d4876f0d22e">getURI</a> ()</td></tr>
|
|
<tr class="memdesc:ad65f8040a142f8d6d0763d4876f0d22e"><td class="mdescLeft"> </td><td class="mdescRight">Get the URI from the advertisement. <a href="class_nim_b_l_e_advertised_device.html#ad65f8040a142f8d6d0763d4876f0d22e">More...</a><br /></td></tr>
|
|
<tr class="separator:ad65f8040a142f8d6d0763d4876f0d22e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9a586e46a555cf5fc817c9fe301b295"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ae9a586e46a555cf5fc817c9fe301b295"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295">getManufacturerData</a> (bool skipSizeCheck=false)</td></tr>
|
|
<tr class="memdesc:ae9a586e46a555cf5fc817c9fe301b295"><td class="mdescLeft"> </td><td class="mdescRight">A template to convert the service data to <type>. <a href="class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9a586e46a555cf5fc817c9fe301b295"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6c6b48369d71a5998c1393c0d6a0179"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ae6c6b48369d71a5998c1393c0d6a0179">getName</a> ()</td></tr>
|
|
<tr class="memdesc:ae6c6b48369d71a5998c1393c0d6a0179"><td class="mdescLeft"> </td><td class="mdescRight">Get the advertised name. <a href="class_nim_b_l_e_advertised_device.html#ae6c6b48369d71a5998c1393c0d6a0179">More...</a><br /></td></tr>
|
|
<tr class="separator:ae6c6b48369d71a5998c1393c0d6a0179"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd42dfbc92a43fc90e933df975c029f3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#acd42dfbc92a43fc90e933df975c029f3">getRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:acd42dfbc92a43fc90e933df975c029f3"><td class="mdescLeft"> </td><td class="mdescRight">Get the RSSI. <a href="class_nim_b_l_e_advertised_device.html#acd42dfbc92a43fc90e933df975c029f3">More...</a><br /></td></tr>
|
|
<tr class="separator:acd42dfbc92a43fc90e933df975c029f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3931c72aaded3b594896c29b3691562"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ad3931c72aaded3b594896c29b3691562">getScan</a> ()</td></tr>
|
|
<tr class="memdesc:ad3931c72aaded3b594896c29b3691562"><td class="mdescLeft"> </td><td class="mdescRight">Get the scan object that created this advertised device. <a href="class_nim_b_l_e_advertised_device.html#ad3931c72aaded3b594896c29b3691562">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3931c72aaded3b594896c29b3691562"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fc9be9de9209622259f8d28b01825df"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a5fc9be9de9209622259f8d28b01825df">getServiceDataCount</a> ()</td></tr>
|
|
<tr class="memdesc:a5fc9be9de9209622259f8d28b01825df"><td class="mdescLeft"> </td><td class="mdescRight">Get the count of advertised service data UUIDS. <a href="class_nim_b_l_e_advertised_device.html#a5fc9be9de9209622259f8d28b01825df">More...</a><br /></td></tr>
|
|
<tr class="separator:a5fc9be9de9209622259f8d28b01825df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecb3e30a94abd59401cafb70a5903abb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">getServiceData</a> (uint8_t index=0)</td></tr>
|
|
<tr class="memdesc:aecb3e30a94abd59401cafb70a5903abb"><td class="mdescLeft"> </td><td class="mdescRight">Get the service data. <a href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">More...</a><br /></td></tr>
|
|
<tr class="separator:aecb3e30a94abd59401cafb70a5903abb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf4398ca81f800445092ccc77deaf00b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#acf4398ca81f800445092ccc77deaf00b">getServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid)</td></tr>
|
|
<tr class="memdesc:acf4398ca81f800445092ccc77deaf00b"><td class="mdescLeft"> </td><td class="mdescRight">Get the service data. <a href="class_nim_b_l_e_advertised_device.html#acf4398ca81f800445092ccc77deaf00b">More...</a><br /></td></tr>
|
|
<tr class="separator:acf4398ca81f800445092ccc77deaf00b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9017ce5b59bdae3cebf33c54f28cee70"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a9017ce5b59bdae3cebf33c54f28cee70"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70">getServiceData</a> (uint8_t index=0, bool skipSizeCheck=false)</td></tr>
|
|
<tr class="memdesc:a9017ce5b59bdae3cebf33c54f28cee70"><td class="mdescLeft"> </td><td class="mdescRight">A template to convert the service data to <code><type></code>. <a href="class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70">More...</a><br /></td></tr>
|
|
<tr class="separator:a9017ce5b59bdae3cebf33c54f28cee70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ca1c022e10764ec72850ff3a011b009"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a9ca1c022e10764ec72850ff3a011b009"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009">getServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, bool skipSizeCheck=false)</td></tr>
|
|
<tr class="memdesc:a9ca1c022e10764ec72850ff3a011b009"><td class="mdescLeft"> </td><td class="mdescRight">A template to convert the service data to <code><type></code>. <a href="class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009">More...</a><br /></td></tr>
|
|
<tr class="separator:a9ca1c022e10764ec72850ff3a011b009"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f89e99dffdfde45c1cafff74a20a95f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a4f89e99dffdfde45c1cafff74a20a95f">getServiceDataUUID</a> (uint8_t index=0)</td></tr>
|
|
<tr class="memdesc:a4f89e99dffdfde45c1cafff74a20a95f"><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID of the serice data at the index. <a href="class_nim_b_l_e_advertised_device.html#a4f89e99dffdfde45c1cafff74a20a95f">More...</a><br /></td></tr>
|
|
<tr class="separator:a4f89e99dffdfde45c1cafff74a20a95f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab53f862df15953d19ba7a45d4cf51b46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ab53f862df15953d19ba7a45d4cf51b46">getServiceUUID</a> (uint8_t index=0)</td></tr>
|
|
<tr class="memdesc:ab53f862df15953d19ba7a45d4cf51b46"><td class="mdescLeft"> </td><td class="mdescRight">Get the Service UUID. <a href="class_nim_b_l_e_advertised_device.html#ab53f862df15953d19ba7a45d4cf51b46">More...</a><br /></td></tr>
|
|
<tr class="separator:ab53f862df15953d19ba7a45d4cf51b46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dc4484bc89ea5560a51c349b5300049"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a6dc4484bc89ea5560a51c349b5300049">getServiceUUIDCount</a> ()</td></tr>
|
|
<tr class="memdesc:a6dc4484bc89ea5560a51c349b5300049"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of services advertised. <a href="class_nim_b_l_e_advertised_device.html#a6dc4484bc89ea5560a51c349b5300049">More...</a><br /></td></tr>
|
|
<tr class="separator:a6dc4484bc89ea5560a51c349b5300049"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a599cad9a3f3d535049c87a911bc1b14d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a599cad9a3f3d535049c87a911bc1b14d">getTargetAddress</a> (uint8_t index=0)</td></tr>
|
|
<tr class="memdesc:a599cad9a3f3d535049c87a911bc1b14d"><td class="mdescLeft"> </td><td class="mdescRight">Get the target address at the index. <a href="class_nim_b_l_e_advertised_device.html#a599cad9a3f3d535049c87a911bc1b14d">More...</a><br /></td></tr>
|
|
<tr class="separator:a599cad9a3f3d535049c87a911bc1b14d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9352a7760d9e4af0561d7923fcbe2535"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9352a7760d9e4af0561d7923fcbe2535">getTargetAddressCount</a> ()</td></tr>
|
|
<tr class="memdesc:a9352a7760d9e4af0561d7923fcbe2535"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of target addresses. <a href="class_nim_b_l_e_advertised_device.html#a9352a7760d9e4af0561d7923fcbe2535">More...</a><br /></td></tr>
|
|
<tr class="separator:a9352a7760d9e4af0561d7923fcbe2535"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afee346437447173eed1b9edf1de70f34"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#afee346437447173eed1b9edf1de70f34">getTXPower</a> ()</td></tr>
|
|
<tr class="memdesc:afee346437447173eed1b9edf1de70f34"><td class="mdescLeft"> </td><td class="mdescRight">Get the TX Power. <a href="class_nim_b_l_e_advertised_device.html#afee346437447173eed1b9edf1de70f34">More...</a><br /></td></tr>
|
|
<tr class="separator:afee346437447173eed1b9edf1de70f34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afacf7717a15b36af184cd957d397e384"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#afacf7717a15b36af184cd957d397e384">getPayload</a> ()</td></tr>
|
|
<tr class="memdesc:afacf7717a15b36af184cd957d397e384"><td class="mdescLeft"> </td><td class="mdescRight">Get the payload advertised by the device. <a href="class_nim_b_l_e_advertised_device.html#afacf7717a15b36af184cd957d397e384">More...</a><br /></td></tr>
|
|
<tr class="separator:afacf7717a15b36af184cd957d397e384"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae960e43434bf62ec83e9230d7bf7046c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ae960e43434bf62ec83e9230d7bf7046c">getAdvLength</a> ()</td></tr>
|
|
<tr class="memdesc:ae960e43434bf62ec83e9230d7bf7046c"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the advertisement data in the payload. <a href="class_nim_b_l_e_advertised_device.html#ae960e43434bf62ec83e9230d7bf7046c">More...</a><br /></td></tr>
|
|
<tr class="separator:ae960e43434bf62ec83e9230d7bf7046c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7879f4aa0f2b069b1d3aff4809ae62c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ac7879f4aa0f2b069b1d3aff4809ae62c">getPayloadLength</a> ()</td></tr>
|
|
<tr class="memdesc:ac7879f4aa0f2b069b1d3aff4809ae62c"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the payload advertised by the device. <a href="class_nim_b_l_e_advertised_device.html#ac7879f4aa0f2b069b1d3aff4809ae62c">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7879f4aa0f2b069b1d3aff4809ae62c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc79cdc087c81b34643d70c8259eb9a3"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#afc79cdc087c81b34643d70c8259eb9a3">getAddressType</a> ()</td></tr>
|
|
<tr class="memdesc:afc79cdc087c81b34643d70c8259eb9a3"><td class="mdescLeft"> </td><td class="mdescRight">Get the advertised device address type. <a href="class_nim_b_l_e_advertised_device.html#afc79cdc087c81b34643d70c8259eb9a3">More...</a><br /></td></tr>
|
|
<tr class="separator:afc79cdc087c81b34643d70c8259eb9a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1855415f3c60bc88d62e9206fe6ed75a"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a1855415f3c60bc88d62e9206fe6ed75a">getTimestamp</a> ()</td></tr>
|
|
<tr class="memdesc:a1855415f3c60bc88d62e9206fe6ed75a"><td class="mdescLeft"> </td><td class="mdescRight">Get the timeStamp of when the device last advertised. <a href="class_nim_b_l_e_advertised_device.html#a1855415f3c60bc88d62e9206fe6ed75a">More...</a><br /></td></tr>
|
|
<tr class="separator:a1855415f3c60bc88d62e9206fe6ed75a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37ad095c066aa231a52a7259734c9bce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a37ad095c066aa231a52a7259734c9bce">isAdvertisingService</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid)</td></tr>
|
|
<tr class="memdesc:a37ad095c066aa231a52a7259734c9bce"><td class="mdescLeft"> </td><td class="mdescRight">Check advertised services for existance of the required UUID. <a href="class_nim_b_l_e_advertised_device.html#a37ad095c066aa231a52a7259734c9bce">More...</a><br /></td></tr>
|
|
<tr class="separator:a37ad095c066aa231a52a7259734c9bce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accc6713f85db6174cfe8436059aa8bf1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#accc6713f85db6174cfe8436059aa8bf1">haveAppearance</a> ()</td></tr>
|
|
<tr class="memdesc:accc6713f85db6174cfe8436059aa8bf1"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have an appearance value? <a href="class_nim_b_l_e_advertised_device.html#accc6713f85db6174cfe8436059aa8bf1">More...</a><br /></td></tr>
|
|
<tr class="separator:accc6713f85db6174cfe8436059aa8bf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe58f5fde119d8c0a8fb85ba1e8cc5c9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#abe58f5fde119d8c0a8fb85ba1e8cc5c9">haveManufacturerData</a> ()</td></tr>
|
|
<tr class="memdesc:abe58f5fde119d8c0a8fb85ba1e8cc5c9"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have manufacturer data? <a href="class_nim_b_l_e_advertised_device.html#abe58f5fde119d8c0a8fb85ba1e8cc5c9">More...</a><br /></td></tr>
|
|
<tr class="separator:abe58f5fde119d8c0a8fb85ba1e8cc5c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86805fecd4432335feecf77bb6a0f12e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a86805fecd4432335feecf77bb6a0f12e">haveName</a> ()</td></tr>
|
|
<tr class="memdesc:a86805fecd4432335feecf77bb6a0f12e"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have a name value? <a href="class_nim_b_l_e_advertised_device.html#a86805fecd4432335feecf77bb6a0f12e">More...</a><br /></td></tr>
|
|
<tr class="separator:a86805fecd4432335feecf77bb6a0f12e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a611802e8898e422842d60486b60b8c42"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a611802e8898e422842d60486b60b8c42">haveRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:a611802e8898e422842d60486b60b8c42"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have a signal strength value? <a href="class_nim_b_l_e_advertised_device.html#a611802e8898e422842d60486b60b8c42">More...</a><br /></td></tr>
|
|
<tr class="separator:a611802e8898e422842d60486b60b8c42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afba3425cfcfc12eca219a1abe5f6732c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#afba3425cfcfc12eca219a1abe5f6732c">haveServiceData</a> ()</td></tr>
|
|
<tr class="memdesc:afba3425cfcfc12eca219a1abe5f6732c"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have a service data value? <a href="class_nim_b_l_e_advertised_device.html#afba3425cfcfc12eca219a1abe5f6732c">More...</a><br /></td></tr>
|
|
<tr class="separator:afba3425cfcfc12eca219a1abe5f6732c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c4aae7e27c27201846ba4e15448e557"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a5c4aae7e27c27201846ba4e15448e557">haveServiceUUID</a> ()</td></tr>
|
|
<tr class="memdesc:a5c4aae7e27c27201846ba4e15448e557"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have a service UUID value? <a href="class_nim_b_l_e_advertised_device.html#a5c4aae7e27c27201846ba4e15448e557">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c4aae7e27c27201846ba4e15448e557"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5293030ef439856c195caa3aba86543"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#af5293030ef439856c195caa3aba86543">haveTXPower</a> ()</td></tr>
|
|
<tr class="memdesc:af5293030ef439856c195caa3aba86543"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have a transmission power value? <a href="class_nim_b_l_e_advertised_device.html#af5293030ef439856c195caa3aba86543">More...</a><br /></td></tr>
|
|
<tr class="separator:af5293030ef439856c195caa3aba86543"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3274624943c942f357c6f8d489481bc8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a3274624943c942f357c6f8d489481bc8">haveConnParams</a> ()</td></tr>
|
|
<tr class="memdesc:a3274624943c942f357c6f8d489481bc8"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have preferred connection parameters? <a href="class_nim_b_l_e_advertised_device.html#a3274624943c942f357c6f8d489481bc8">More...</a><br /></td></tr>
|
|
<tr class="separator:a3274624943c942f357c6f8d489481bc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8b4660e5d123f16a07e0fefa3bcf4bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#aa8b4660e5d123f16a07e0fefa3bcf4bc">haveAdvInterval</a> ()</td></tr>
|
|
<tr class="memdesc:aa8b4660e5d123f16a07e0fefa3bcf4bc"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have have the advertising interval? <a href="class_nim_b_l_e_advertised_device.html#aa8b4660e5d123f16a07e0fefa3bcf4bc">More...</a><br /></td></tr>
|
|
<tr class="separator:aa8b4660e5d123f16a07e0fefa3bcf4bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1172d33a77bc018e314be78664b222b9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a1172d33a77bc018e314be78664b222b9">haveTargetAddress</a> ()</td></tr>
|
|
<tr class="memdesc:a1172d33a77bc018e314be78664b222b9"><td class="mdescLeft"> </td><td class="mdescRight">Does the advertisement contain a target address? <a href="class_nim_b_l_e_advertised_device.html#a1172d33a77bc018e314be78664b222b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a1172d33a77bc018e314be78664b222b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83ebd08b512dc936b1059db7a69b9ead"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#a83ebd08b512dc936b1059db7a69b9ead">haveURI</a> ()</td></tr>
|
|
<tr class="memdesc:a83ebd08b512dc936b1059db7a69b9ead"><td class="mdescLeft"> </td><td class="mdescRight">Does this advertisement have a URI? <a href="class_nim_b_l_e_advertised_device.html#a83ebd08b512dc936b1059db7a69b9ead">More...</a><br /></td></tr>
|
|
<tr class="separator:a83ebd08b512dc936b1059db7a69b9ead"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1b8ff0f2897abda335743d55668fcd9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device.html#ac1b8ff0f2897abda335743d55668fcd9">toString</a> ()</td></tr>
|
|
<tr class="memdesc:ac1b8ff0f2897abda335743d55668fcd9"><td class="mdescLeft"> </td><td class="mdescRight">Create a string representation of this device. <a href="class_nim_b_l_e_advertised_device.html#ac1b8ff0f2897abda335743d55668fcd9">More...</a><br /></td></tr>
|
|
<tr class="separator:ac1b8ff0f2897abda335743d55668fcd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A representation of a BLE advertised device found by a scan. </p>
|
|
<p>When we perform a BLE scan, the result will be a set of devices that are advertising. This class provides a model of a detected device. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa60721a7b5b44a3bb66980f003517579"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa60721a7b5b44a3bb66980f003517579">◆ </a></span>getAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> NimBLEAdvertisedDevice::getAddress </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the address of the advertising device. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The address of the advertised device. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc79cdc087c81b34643d70c8259eb9a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc79cdc087c81b34643d70c8259eb9a3">◆ </a></span>getAddressType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t NimBLEAdvertisedDevice::getAddressType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the advertised device address type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The device address type:<ul>
|
|
<li>BLE_ADDR_PUBLIC (0x00)</li>
|
|
<li>BLE_ADDR_RANDOM (0x01)</li>
|
|
<li>BLE_ADDR_PUBLIC_ID (0x02)</li>
|
|
<li>BLE_ADDR_RANDOM_ID (0x03) </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a7a36e9937e16ffab4f1543ea54073f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a7a36e9937e16ffab4f1543ea54073f">◆ </a></span>getAdvInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t NimBLEAdvertisedDevice::getAdvInterval </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the advertisement interval. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertisement interval in 0.625ms units. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae960e43434bf62ec83e9230d7bf7046c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae960e43434bf62ec83e9230d7bf7046c">◆ </a></span>getAdvLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t NimBLEAdvertisedDevice::getAdvLength </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the length of the advertisement data in the payload. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of bytes in the payload that is from the advertisment. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d07ee4c38de4170db24a5e01663ee6d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d07ee4c38de4170db24a5e01663ee6d">◆ </a></span>getAdvType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t NimBLEAdvertisedDevice::getAdvType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the advertisement type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertising type the device is reporting:<ul>
|
|
<li>BLE_HCI_ADV_TYPE_ADV_IND (0) - indirect advertising</li>
|
|
<li>BLE_HCI_ADV_TYPE_ADV_DIRECT_IND_HD (1) - direct advertisng - high duty cycle</li>
|
|
<li>BLE_HCI_ADV_TYPE_ADV_SCAN_IND (2) - indirect scan response</li>
|
|
<li>BLE_HCI_ADV_TYPE_ADV_NONCONN_IND (3) - indirect advertisng - not connectable</li>
|
|
<li>BLE_HCI_ADV_TYPE_ADV_DIRECT_IND_LD (4) - direct advertising - low duty cycle </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a228afa5e43421b4d96d9c08241718309"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a228afa5e43421b4d96d9c08241718309">◆ </a></span>getAppearance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t NimBLEAdvertisedDevice::getAppearance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the appearance. </p>
|
|
<p>A BLE device can declare its own appearance. The appearance is how it would like to be shown to an end user typcially in the form of an icon.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The appearance of the advertised device. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa334006230601cc5c6429b18819a2e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa334006230601cc5c6429b18819a2e2">◆ </a></span>getManufacturerData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAdvertisedDevice::getManufacturerData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the manufacturer data. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The manufacturer data of the advertised device. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9a586e46a555cf5fc817c9fe301b295"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9a586e46a555cf5fc817c9fe301b295">◆ </a></span>getManufacturerData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T NimBLEAdvertisedDevice::getManufacturerData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A template to convert the service data to <type>. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The type to convert the data to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">skipSizeCheck</td><td>If true it will skip checking if the data size is less than <code>sizeof(<type>)</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The data converted to <type> or NULL if skipSizeCheck is false and the data is less than <code>sizeof(<type>)</code>.</dd></dl>
|
|
<p><b>Use:</b> <code>getManufacturerData<type>(skipSizeCheck);</code> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a450eca96c605f199d2786a044612db17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a450eca96c605f199d2786a044612db17">◆ </a></span>getMaxInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t NimBLEAdvertisedDevice::getMaxInterval </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the preferred max connection interval. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The preferred max connection interval in 1.25ms units. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33fcdc3bf5107c157b10ad4519938c9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33fcdc3bf5107c157b10ad4519938c9f">◆ </a></span>getMinInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t NimBLEAdvertisedDevice::getMinInterval </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the preferred min connection interval. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The preferred min connection interval in 1.25ms units. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6c6b48369d71a5998c1393c0d6a0179"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6c6b48369d71a5998c1393c0d6a0179">◆ </a></span>getName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAdvertisedDevice::getName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the advertised name. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The name of the advertised device. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afacf7717a15b36af184cd957d397e384"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afacf7717a15b36af184cd957d397e384">◆ </a></span>getPayload()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t * NimBLEAdvertisedDevice::getPayload </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the payload advertised by the device. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertisement payload. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7879f4aa0f2b069b1d3aff4809ae62c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7879f4aa0f2b069b1d3aff4809ae62c">◆ </a></span>getPayloadLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t NimBLEAdvertisedDevice::getPayloadLength </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the length of the payload advertised by the device. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The size of the payload in bytes. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd42dfbc92a43fc90e933df975c029f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd42dfbc92a43fc90e933df975c029f3">◆ </a></span>getRSSI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int NimBLEAdvertisedDevice::getRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the RSSI. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The RSSI of the advertised device. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3931c72aaded3b594896c29b3691562"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3931c72aaded3b594896c29b3691562">◆ </a></span>getScan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a> * NimBLEAdvertisedDevice::getScan </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the scan object that created this advertised device. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The scan object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf4398ca81f800445092ccc77deaf00b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf4398ca81f800445092ccc77deaf00b">◆ </a></span>getServiceData() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAdvertisedDevice::getServiceData </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>Get the service 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 of the service data requested. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertised service data or empty string if no data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ca1c022e10764ec72850ff3a011b009"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ca1c022e10764ec72850ff3a011b009">◆ </a></span>getServiceData() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T NimBLEAdvertisedDevice::getServiceData </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">bool </td>
|
|
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A template to convert the service data to <code><type></code>. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The type to convert the data to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The uuid of the service data requested. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">skipSizeCheck</td><td>If true it will skip checking if the data size is less than <code>sizeof(<type>)</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The data converted to <type> or NULL if skipSizeCheck is false and the data is less than <code>sizeof(<type>)</code>.</dd></dl>
|
|
<p><b>Use:</b> <code>getServiceData<type>(skipSizeCheck);</code> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aecb3e30a94abd59401cafb70a5903abb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecb3e30a94abd59401cafb70a5903abb">◆ </a></span>getServiceData() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAdvertisedDevice::getServiceData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the service data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the service data requested. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertised service data or empty string if no data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9017ce5b59bdae3cebf33c54f28cee70"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9017ce5b59bdae3cebf33c54f28cee70">◆ </a></span>getServiceData() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T NimBLEAdvertisedDevice::getServiceData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A template to convert the service data to <code><type></code>. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The type to convert the data to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The vector index of the service data requested. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">skipSizeCheck</td><td>If true it will skip checking if the data size is less than <code>sizeof(<type>)</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The data converted to <type> or NULL if skipSizeCheck is false and the data is less than <code>sizeof(<type>)</code>.</dd></dl>
|
|
<p><b>Use:</b> <code>getServiceData<type>(skipSizeCheck);</code> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5fc9be9de9209622259f8d28b01825df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5fc9be9de9209622259f8d28b01825df">◆ </a></span>getServiceDataCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t NimBLEAdvertisedDevice::getServiceDataCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the count of advertised service data UUIDS. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of service data UUIDS in the vector. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f89e99dffdfde45c1cafff74a20a95f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f89e99dffdfde45c1cafff74a20a95f">◆ </a></span>getServiceDataUUID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLEAdvertisedDevice::getServiceDataUUID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the UUID of the serice data at the index. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the service data UUID requested. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertised service data UUID or an empty UUID if not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab53f862df15953d19ba7a45d4cf51b46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab53f862df15953d19ba7a45d4cf51b46">◆ </a></span>getServiceUUID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLEAdvertisedDevice::getServiceUUID </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the Service UUID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the service UUID requested. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The Service UUID of the advertised service, or an empty UUID if not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6dc4484bc89ea5560a51c349b5300049"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6dc4484bc89ea5560a51c349b5300049">◆ </a></span>getServiceUUIDCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t NimBLEAdvertisedDevice::getServiceUUIDCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of services advertised. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The count of services in the advertising packet. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a599cad9a3f3d535049c87a911bc1b14d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a599cad9a3f3d535049c87a911bc1b14d">◆ </a></span>getTargetAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> NimBLEAdvertisedDevice::getTargetAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the target address at the index. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the target address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The target address. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9352a7760d9e4af0561d7923fcbe2535"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9352a7760d9e4af0561d7923fcbe2535">◆ </a></span>getTargetAddressCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t NimBLEAdvertisedDevice::getTargetAddressCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of target addresses. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of addresses. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1855415f3c60bc88d62e9206fe6ed75a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1855415f3c60bc88d62e9206fe6ed75a">◆ </a></span>getTimestamp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">time_t NimBLEAdvertisedDevice::getTimestamp </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the timeStamp of when the device last advertised. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The timeStamp of when the device was last seen. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afee346437447173eed1b9edf1de70f34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afee346437447173eed1b9edf1de70f34">◆ </a></span>getTXPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int8_t NimBLEAdvertisedDevice::getTXPower </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the TX Power. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The TX Power of the advertised device. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad65f8040a142f8d6d0763d4876f0d22e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad65f8040a142f8d6d0763d4876f0d22e">◆ </a></span>getURI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAdvertisedDevice::getURI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the URI from the advertisement. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The URI data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa8b4660e5d123f16a07e0fefa3bcf4bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8b4660e5d123f16a07e0fefa3bcf4bc">◆ </a></span>haveAdvInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveAdvInterval </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have have the advertising interval? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the advertisement interval is present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="accc6713f85db6174cfe8436059aa8bf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#accc6713f85db6174cfe8436059aa8bf1">◆ </a></span>haveAppearance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveAppearance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have an appearance value? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is an appearance value present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3274624943c942f357c6f8d489481bc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3274624943c942f357c6f8d489481bc8">◆ </a></span>haveConnParams()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveConnParams </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have preferred connection parameters? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if connection parameters are present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe58f5fde119d8c0a8fb85ba1e8cc5c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe58f5fde119d8c0a8fb85ba1e8cc5c9">◆ </a></span>haveManufacturerData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveManufacturerData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have manufacturer data? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is manufacturer data present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86805fecd4432335feecf77bb6a0f12e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86805fecd4432335feecf77bb6a0f12e">◆ </a></span>haveName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have a name value? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is a name value present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a611802e8898e422842d60486b60b8c42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a611802e8898e422842d60486b60b8c42">◆ </a></span>haveRSSI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have a signal strength value? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is a signal strength value present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afba3425cfcfc12eca219a1abe5f6732c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afba3425cfcfc12eca219a1abe5f6732c">◆ </a></span>haveServiceData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveServiceData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have a service data value? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is a service data value present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c4aae7e27c27201846ba4e15448e557"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c4aae7e27c27201846ba4e15448e557">◆ </a></span>haveServiceUUID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveServiceUUID </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have a service UUID value? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is a service UUID value present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1172d33a77bc018e314be78664b222b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1172d33a77bc018e314be78664b222b9">◆ </a></span>haveTargetAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveTargetAddress </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does the advertisement contain a target address? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if an address is present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5293030ef439856c195caa3aba86543"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5293030ef439856c195caa3aba86543">◆ </a></span>haveTXPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveTXPower </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have a transmission power value? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is a transmission power value present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a83ebd08b512dc936b1059db7a69b9ead"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a83ebd08b512dc936b1059db7a69b9ead">◆ </a></span>haveURI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::haveURI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Does this advertisement have a URI? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there is a URI present. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37ad095c066aa231a52a7259734c9bce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37ad095c066aa231a52a7259734c9bce">◆ </a></span>isAdvertisingService()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAdvertisedDevice::isAdvertisingService </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>Check advertised services for existance of the required 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 service uuid to look for in the advertisement. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Return true if service is advertised </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1b8ff0f2897abda335743d55668fcd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1b8ff0f2897abda335743d55668fcd9">◆ </a></span>toString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAdvertisedDevice::toString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a string representation of this device. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string representation of this device. </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_advertised_device.html">NimBLEAdvertisedDevice</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>
|