mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
408 lines
22 KiB
HTML
408 lines
22 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: NimBLEAddress Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">esp-nimble-cpp
|
|
 <span id="projectnumber">1.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_nim_b_l_e_address.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_address-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NimBLEAddress Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A BLE device address.
|
|
<a href="class_nim_b_l_e_address.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:a19058addb94417e2921cade37a79d04c"><td class="memItemLeft" align="right" valign="top"><a id="a19058addb94417e2921cade37a79d04c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a> ()</td></tr>
|
|
<tr class="memdesc:a19058addb94417e2921cade37a79d04c"><td class="mdescLeft"> </td><td class="mdescRight">Create a blank address, i.e. 00:00:00:00:00:00, type 0. <br /></td></tr>
|
|
<tr class="separator:a19058addb94417e2921cade37a79d04c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8c9105b825ed0be5d1bbab966f2a0cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#ab8c9105b825ed0be5d1bbab966f2a0cf">NimBLEAddress</a> (ble_addr_t address)</td></tr>
|
|
<tr class="memdesc:ab8c9105b825ed0be5d1bbab966f2a0cf"><td class="mdescLeft"> </td><td class="mdescRight">Create an address from the native NimBLE representation. <a href="class_nim_b_l_e_address.html#ab8c9105b825ed0be5d1bbab966f2a0cf">More...</a><br /></td></tr>
|
|
<tr class="separator:ab8c9105b825ed0be5d1bbab966f2a0cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92637adc75c8010bcf34e2dd8f16cd94"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a92637adc75c8010bcf34e2dd8f16cd94">NimBLEAddress</a> (uint8_t address[6], uint8_t type=BLE_ADDR_PUBLIC)</td></tr>
|
|
<tr class="memdesc:a92637adc75c8010bcf34e2dd8f16cd94"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for compatibility with bluedroid esp library using native ESP representation. <a href="class_nim_b_l_e_address.html#a92637adc75c8010bcf34e2dd8f16cd94">More...</a><br /></td></tr>
|
|
<tr class="separator:a92637adc75c8010bcf34e2dd8f16cd94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb6dafff197dc01e2713bbf43e21f1f3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#aeb6dafff197dc01e2713bbf43e21f1f3">NimBLEAddress</a> (const std::string &stringAddress, uint8_t type=BLE_ADDR_PUBLIC)</td></tr>
|
|
<tr class="memdesc:aeb6dafff197dc01e2713bbf43e21f1f3"><td class="mdescLeft"> </td><td class="mdescRight">Create an address from a hex string. <a href="class_nim_b_l_e_address.html#aeb6dafff197dc01e2713bbf43e21f1f3">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb6dafff197dc01e2713bbf43e21f1f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a139790cf03d8297e253e5353a0213bff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a139790cf03d8297e253e5353a0213bff">NimBLEAddress</a> (const uint64_t &address, uint8_t type=BLE_ADDR_PUBLIC)</td></tr>
|
|
<tr class="memdesc:a139790cf03d8297e253e5353a0213bff"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for address using a hex value.<br />
|
|
Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16". <a href="class_nim_b_l_e_address.html#a139790cf03d8297e253e5353a0213bff">More...</a><br /></td></tr>
|
|
<tr class="separator:a139790cf03d8297e253e5353a0213bff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a826fe8850cbc7d54f0696b8af4637169"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">equals</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &otherAddress) const</td></tr>
|
|
<tr class="memdesc:a826fe8850cbc7d54f0696b8af4637169"><td class="mdescLeft"> </td><td class="mdescRight">Determine if this address equals another. <a href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">More...</a><br /></td></tr>
|
|
<tr class="separator:a826fe8850cbc7d54f0696b8af4637169"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adef69a03a08303957d7e40eef07b4d80"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">getNative</a> () const</td></tr>
|
|
<tr class="memdesc:adef69a03a08303957d7e40eef07b4d80"><td class="mdescLeft"> </td><td class="mdescRight">Get the native representation of the address. <a href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">More...</a><br /></td></tr>
|
|
<tr class="separator:adef69a03a08303957d7e40eef07b4d80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac53b0cc945e1505d3e72d48164ad01d6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">toString</a> () const</td></tr>
|
|
<tr class="memdesc:ac53b0cc945e1505d3e72d48164ad01d6"><td class="mdescLeft"> </td><td class="mdescRight">Convert a BLE address to a string. <a href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">More...</a><br /></td></tr>
|
|
<tr class="separator:ac53b0cc945e1505d3e72d48164ad01d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18f8361ed20146cbc374a246d87015eb"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">getType</a> () const</td></tr>
|
|
<tr class="memdesc:a18f8361ed20146cbc374a246d87015eb"><td class="mdescLeft"> </td><td class="mdescRight">Get the address type. <a href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">More...</a><br /></td></tr>
|
|
<tr class="separator:a18f8361ed20146cbc374a246d87015eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87e8ccc81c2d83bf0503166939319164"><td class="memItemLeft" align="right" valign="top"><a id="a87e8ccc81c2d83bf0503166939319164"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164">operator==</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &rhs) const</td></tr>
|
|
<tr class="memdesc:a87e8ccc81c2d83bf0503166939319164"><td class="mdescLeft"> </td><td class="mdescRight">Convenience operator to check if this address is equal to another. <br /></td></tr>
|
|
<tr class="separator:a87e8ccc81c2d83bf0503166939319164"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae243127c78af69b26dfa225effd806ce"><td class="memItemLeft" align="right" valign="top"><a id="ae243127c78af69b26dfa225effd806ce"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce">operator!=</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &rhs) const</td></tr>
|
|
<tr class="memdesc:ae243127c78af69b26dfa225effd806ce"><td class="mdescLeft"> </td><td class="mdescRight">Convenience operator to check if this address is not equal to another. <br /></td></tr>
|
|
<tr class="separator:ae243127c78af69b26dfa225effd806ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5398ed7c6d8e95a7527103095e07093a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a5398ed7c6d8e95a7527103095e07093a">operator std::string</a> () const</td></tr>
|
|
<tr class="memdesc:a5398ed7c6d8e95a7527103095e07093a"><td class="mdescLeft"> </td><td class="mdescRight">Convienience operator to convert this address to string representation. <a href="class_nim_b_l_e_address.html#a5398ed7c6d8e95a7527103095e07093a">More...</a><br /></td></tr>
|
|
<tr class="separator:a5398ed7c6d8e95a7527103095e07093a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7d5d8d323d2846bf2082b83381bd7c8"><td class="memItemLeft" align="right" valign="top"><a id="aa7d5d8d323d2846bf2082b83381bd7c8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#aa7d5d8d323d2846bf2082b83381bd7c8">operator uint64_t</a> () const</td></tr>
|
|
<tr class="memdesc:aa7d5d8d323d2846bf2082b83381bd7c8"><td class="mdescLeft"> </td><td class="mdescRight">Convenience operator to convert the native address representation to uint_64. <br /></td></tr>
|
|
<tr class="separator:aa7d5d8d323d2846bf2082b83381bd7c8"><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 BLE device address. </p>
|
|
<p>Every BLE device has a unique address which can be used to identify it and form connections. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ab8c9105b825ed0be5d1bbab966f2a0cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8c9105b825ed0be5d1bbab966f2a0cf">◆ </a></span>NimBLEAddress() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAddress::NimBLEAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ble_addr_t </td>
|
|
<td class="paramname"><em>address</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create an address from the native NimBLE representation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The native NimBLE address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a92637adc75c8010bcf34e2dd8f16cd94"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92637adc75c8010bcf34e2dd8f16cd94">◆ </a></span>NimBLEAddress() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAddress::NimBLEAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>address</em>[6], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>type</em> = <code>BLE_ADDR_PUBLIC</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor for compatibility with bluedroid esp library using native ESP representation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>A uint8_t[6] or esp_bd_addr_t containing the address. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb6dafff197dc01e2713bbf43e21f1f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb6dafff197dc01e2713bbf43e21f1f3">◆ </a></span>NimBLEAddress() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAddress::NimBLEAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>stringAddress</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>type</em> = <code>BLE_ADDR_PUBLIC</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create an address from a hex string. </p>
|
|
<p>A hex string is of the format: </p><div class="fragment"><div class="line">00:00:00:00:00:00</div>
|
|
</div><!-- fragment --><p> which is 17 characters in length.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">stringAddress</td><td>The hex string representation of the address. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a139790cf03d8297e253e5353a0213bff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a139790cf03d8297e253e5353a0213bff">◆ </a></span>NimBLEAddress() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAddress::NimBLEAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint64_t & </td>
|
|
<td class="paramname"><em>address</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>type</em> = <code>BLE_ADDR_PUBLIC</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor for address using a hex value.<br />
|
|
Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16". </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>uint64_t containing the address. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a826fe8850cbc7d54f0696b8af4637169"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a826fe8850cbc7d54f0696b8af4637169">◆ </a></span>equals()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAddress::equals </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>otherAddress</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determine if this address equals another. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">otherAddress</td><td>The other address to compare against. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the addresses are equal. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adef69a03a08303957d7e40eef07b4d80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adef69a03a08303957d7e40eef07b4d80">◆ </a></span>getNative()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t * NimBLEAddress::getNative </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the native representation of the address. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>a pointer to the uint8_t[6] array of the address. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18f8361ed20146cbc374a246d87015eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18f8361ed20146cbc374a246d87015eb">◆ </a></span>getType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t NimBLEAddress::getType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the address type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The address type. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5398ed7c6d8e95a7527103095e07093a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5398ed7c6d8e95a7527103095e07093a">◆ </a></span>operator std::string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAddress::operator std::string </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convienience operator to convert this address to string representation. </p>
|
|
<p>This allows passing <a class="el" href="class_nim_b_l_e_address.html" title="A BLE device address.">NimBLEAddress</a> to functions that accept std::string and/or or it's methods as a parameter. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac53b0cc945e1505d3e72d48164ad01d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac53b0cc945e1505d3e72d48164ad01d6">◆ </a></span>toString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string NimBLEAddress::toString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a BLE address to a string. </p>
|
|
<p>A string representation of an address is in the format:</p>
|
|
<div class="fragment"><div class="line">xx:xx:xx:xx:xx:xx</div>
|
|
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The string representation of the address. </dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use std::string() operator instead. </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_address.html">NimBLEAddress</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>
|