ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-23 13:40:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/class_nim_b_l_e_eddystone_u_r_l.html
h2zero 6ae5666f7a v1.3.2
2022-01-15 15:23:57 -07:00

350 lines
17 KiB
HTML
Raw Blame History

<!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: NimBLEEddystoneURL 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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_eddystone_u_r_l.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> &#124;
<a href="class_nim_b_l_e_eddystone_u_r_l-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEEddystoneURL Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Representation of a beacon. See:
<a href="class_nim_b_l_e_eddystone_u_r_l.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:ae102214d20e32e31c9c84d723f67df15"><td class="memItemLeft" align="right" valign="top"><a id="ae102214d20e32e31c9c84d723f67df15"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ae102214d20e32e31c9c84d723f67df15">NimBLEEddystoneURL</a> ()</td></tr>
<tr class="memdesc:ae102214d20e32e31c9c84d723f67df15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a default EddystoneURL beacon object. <br /></td></tr>
<tr class="separator:ae102214d20e32e31c9c84d723f67df15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac32c7066ce1ee8d495a35ec870f0e7bf"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">getData</a> ()</td></tr>
<tr class="memdesc:ac32c7066ce1ee8d495a35ec870f0e7bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the data that is being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">More...</a><br /></td></tr>
<tr class="separator:ac32c7066ce1ee8d495a35ec870f0e7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fde0fcf7d90f79e0eb718967518247a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">getUUID</a> ()</td></tr>
<tr class="memdesc:a1fde0fcf7d90f79e0eb718967518247a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">More...</a><br /></td></tr>
<tr class="separator:a1fde0fcf7d90f79e0eb718967518247a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42583c740bbdb9591422e8770f8bd0d5"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">getPower</a> ()</td></tr>
<tr class="memdesc:a42583c740bbdb9591422e8770f8bd0d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the transmit power being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">More...</a><br /></td></tr>
<tr class="separator:a42583c740bbdb9591422e8770f8bd0d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0109874399f3e70a72ee9f4a909710e1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">getURL</a> ()</td></tr>
<tr class="memdesc:a0109874399f3e70a72ee9f4a909710e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the raw URL being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">More...</a><br /></td></tr>
<tr class="separator:a0109874399f3e70a72ee9f4a909710e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b68cc96a84da85e20d8583ba375c2ff"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">getDecodedURL</a> ()</td></tr>
<tr class="memdesc:a8b68cc96a84da85e20d8583ba375c2ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the full URL being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">More...</a><br /></td></tr>
<tr class="separator:a8b68cc96a84da85e20d8583ba375c2ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada3ac4a544b8565635871f39f1593811"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">setData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:ada3ac4a544b8565635871f39f1593811"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the raw data for the beacon advertisment. <a href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">More...</a><br /></td></tr>
<tr class="separator:ada3ac4a544b8565635871f39f1593811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af183e8483ae81fff65d909e67986fcad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">setUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;l_uuid)</td></tr>
<tr class="memdesc:af183e8483ae81fff65d909e67986fcad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the UUID to advertise. <a href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">More...</a><br /></td></tr>
<tr class="separator:af183e8483ae81fff65d909e67986fcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8038c895e8da7c7ac861557ea0a9d91b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">setPower</a> (int8_t advertisedTxPower)</td></tr>
<tr class="memdesc:a8038c895e8da7c7ac861557ea0a9d91b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the transmit power to advertise. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">More...</a><br /></td></tr>
<tr class="separator:a8038c895e8da7c7ac861557ea0a9d91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8102533ff1e7b6527ea744279f8f64ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">setURL</a> (const std::string &amp;url)</td></tr>
<tr class="memdesc:a8102533ff1e7b6527ea744279f8f64ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the URL to advertise. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">More...</a><br /></td></tr>
<tr class="separator:a8102533ff1e7b6527ea744279f8f64ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of a beacon. See: </p>
<ul>
<li><a href="https://github.com/google/eddystone">https://github.com/google/eddystone</a> </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac32c7066ce1ee8d495a35ec870f0e7bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac32c7066ce1ee8d495a35ec870f0e7bf">&#9670;&nbsp;</a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneURL::getData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the data that is being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The advertised data. </dd></dl>
</div>
</div>
<a id="a8b68cc96a84da85e20d8583ba375c2ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b68cc96a84da85e20d8583ba375c2ff">&#9670;&nbsp;</a></span>getDecodedURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneURL::getDecodedURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the full URL being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The full URL. </dd></dl>
</div>
</div>
<a id="a42583c740bbdb9591422e8770f8bd0d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42583c740bbdb9591422e8770f8bd0d5">&#9670;&nbsp;</a></span>getPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t NimBLEEddystoneURL::getPower </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the transmit power being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The transmit power. </dd></dl>
</div>
</div>
<a id="a0109874399f3e70a72ee9f4a909710e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0109874399f3e70a72ee9f4a909710e1">&#9670;&nbsp;</a></span>getURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneURL::getURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the raw URL being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The raw URL. </dd></dl>
</div>
</div>
<a id="a1fde0fcf7d90f79e0eb718967518247a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fde0fcf7d90f79e0eb718967518247a">&#9670;&nbsp;</a></span>getUUID()</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> NimBLEEddystoneURL::getUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the UUID being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The UUID advertised. </dd></dl>
</div>
</div>
<a id="ada3ac4a544b8565635871f39f1593811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada3ac4a544b8565635871f39f1593811">&#9670;&nbsp;</a></span>setData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the raw data for the beacon advertisment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The raw data to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8038c895e8da7c7ac861557ea0a9d91b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8038c895e8da7c7ac861557ea0a9d91b">&#9670;&nbsp;</a></span>setPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setPower </td>
<td>(</td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>advertisedTxPower</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the transmit power to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advertisedTxPower</td><td>The transmit power level. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8102533ff1e7b6527ea744279f8f64ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8102533ff1e7b6527ea744279f8f64ca">&#9670;&nbsp;</a></span>setURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setURL </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the URL to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>The URL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af183e8483ae81fff65d909e67986fcad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af183e8483ae81fff65d909e67986fcad">&#9670;&nbsp;</a></span>setUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>l_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the UUID to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">l_uuid</td><td>The UUID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</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>
Reference in a new issue View git blame Copy permalink