esp-nimble-cpp/class_nim_b_l_e_eddystone_t_l_m.html

551 lines
27 KiB
HTML
Raw Normal View 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
2022-01-15 23:23:57 +01:00
<title>esp-nimble-cpp: NimBLEEddystoneTLM Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_nim_b_l_e_eddystone_t_l_m.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_eddystone_t_l_m-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">NimBLEEddystoneTLM Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Representation of a beacon. See:
<a href="class_nim_b_l_e_eddystone_t_l_m.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nim_b_l_e_eddystone_t_l_m_8h_source.html">NimBLEEddystoneTLM.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a32c448f92ce2e61a9589d1cb0d149d07" id="r_a32c448f92ce2e61a9589d1cb0d149d07"><td class="memItemLeft" align="right" valign="top">const BeaconData&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a32c448f92ce2e61a9589d1cb0d149d07">getData</a> ()</td></tr>
<tr class="memdesc:a32c448f92ce2e61a9589d1cb0d149d07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the data that is being advertised. <br /></td></tr>
<tr class="separator:a32c448f92ce2e61a9589d1cb0d149d07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa511375f22952c0f5846a51e6c2511c5" id="r_aa511375f22952c0f5846a51e6c2511c5"><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_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">getUUID</a> ()</td></tr>
<tr class="memdesc:aa511375f22952c0f5846a51e6c2511c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID being advertised. <br /></td></tr>
<tr class="separator:aa511375f22952c0f5846a51e6c2511c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9f17d2c1e4150775881babb73f0b10c" id="r_ae9f17d2c1e4150775881babb73f0b10c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">getVersion</a> ()</td></tr>
<tr class="memdesc:ae9f17d2c1e4150775881babb73f0b10c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version being advertised. <br /></td></tr>
<tr class="separator:ae9f17d2c1e4150775881babb73f0b10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9862f983df6f48a96220e936d13d17b" id="r_af9862f983df6f48a96220e936d13d17b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">getVolt</a> ()</td></tr>
<tr class="memdesc:af9862f983df6f48a96220e936d13d17b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the battery voltage. <br /></td></tr>
<tr class="separator:af9862f983df6f48a96220e936d13d17b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72589029e329c3939b05f9df5e8113ce" id="r_a72589029e329c3939b05f9df5e8113ce"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a72589029e329c3939b05f9df5e8113ce">getTemp</a> ()</td></tr>
<tr class="memdesc:a72589029e329c3939b05f9df5e8113ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the temperature being advertised. <br /></td></tr>
<tr class="separator:a72589029e329c3939b05f9df5e8113ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a556a6b6a75693997390f3bacf6e5ca5e" id="r_a556a6b6a75693997390f3bacf6e5ca5e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">getCount</a> ()</td></tr>
<tr class="memdesc:a556a6b6a75693997390f3bacf6e5ca5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the count of advertisements sent. <br /></td></tr>
<tr class="separator:a556a6b6a75693997390f3bacf6e5ca5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1c4a13c2f57a6e0293810dd09be3db3" id="r_ab1c4a13c2f57a6e0293810dd09be3db3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">getTime</a> ()</td></tr>
<tr class="memdesc:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the advertisement time. <br /></td></tr>
<tr class="separator:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a970ba10424567d17c961ed3b3ef83d8e" id="r_a970ba10424567d17c961ed3b3ef83d8e"><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_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">toString</a> ()</td></tr>
<tr class="memdesc:a970ba10424567d17c961ed3b3ef83d8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string representation of the beacon. <br /></td></tr>
<tr class="separator:a970ba10424567d17c961ed3b3ef83d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05989cc6df5d5dc423c878d2317ddb89" id="r_a05989cc6df5d5dc423c878d2317ddb89"><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_t_l_m.html#a05989cc6df5d5dc423c878d2317ddb89">setData</a> (const uint8_t *data, uint8_t length)</td></tr>
<tr class="memdesc:a05989cc6df5d5dc423c878d2317ddb89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the raw data for the beacon advertisement. <br /></td></tr>
<tr class="separator:a05989cc6df5d5dc423c878d2317ddb89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a394d96131aecd687905fbff05196d4e6" id="r_a394d96131aecd687905fbff05196d4e6"><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_t_l_m.html#a394d96131aecd687905fbff05196d4e6">setData</a> (const BeaconData &amp;data)</td></tr>
<tr class="memdesc:a394d96131aecd687905fbff05196d4e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the raw data for the beacon advertisement. <br /></td></tr>
<tr class="separator:a394d96131aecd687905fbff05196d4e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49fdfb7c2edf2ae92f69856ec0ce4291" id="r_a49fdfb7c2edf2ae92f69856ec0ce4291"><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_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">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:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the UUID to advertise. <br /></td></tr>
<tr class="separator:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a205e0e2efc09c4c5043f11aeddee4d63" id="r_a205e0e2efc09c4c5043f11aeddee4d63"><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_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">setVersion</a> (uint8_t version)</td></tr>
<tr class="memdesc:a205e0e2efc09c4c5043f11aeddee4d63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the version to advertise. <br /></td></tr>
<tr class="separator:a205e0e2efc09c4c5043f11aeddee4d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad69af8fe47502d922203916357f6c206" id="r_ad69af8fe47502d922203916357f6c206"><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_t_l_m.html#ad69af8fe47502d922203916357f6c206">setVolt</a> (uint16_t volt)</td></tr>
<tr class="memdesc:ad69af8fe47502d922203916357f6c206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the battery voltage to advertise. <br /></td></tr>
<tr class="separator:ad69af8fe47502d922203916357f6c206"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5ff73359f3c7f7e76395d32f4efe575" id="r_af5ff73359f3c7f7e76395d32f4efe575"><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_t_l_m.html#af5ff73359f3c7f7e76395d32f4efe575">setTemp</a> (int16_t temp)</td></tr>
<tr class="memdesc:af5ff73359f3c7f7e76395d32f4efe575"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the temperature to advertise. <br /></td></tr>
<tr class="separator:af5ff73359f3c7f7e76395d32f4efe575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d033c09a513b2dfdad6f1b962b906a8" id="r_a6d033c09a513b2dfdad6f1b962b906a8"><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_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">setCount</a> (uint32_t advCount)</td></tr>
<tr class="memdesc:a6d033c09a513b2dfdad6f1b962b906a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisement count. <br /></td></tr>
<tr class="separator:a6d033c09a513b2dfdad6f1b962b906a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a999d53f4bad59c2ebc688403f66474b1" id="r_a999d53f4bad59c2ebc688403f66474b1"><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_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">setTime</a> (uint32_t tmil)</td></tr>
<tr class="memdesc:a999d53f4bad59c2ebc688403f66474b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisement time. <br /></td></tr>
<tr class="separator:a999d53f4bad59c2ebc688403f66474b1"><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="a556a6b6a75693997390f3bacf6e5ca5e" name="a556a6b6a75693997390f3bacf6e5ca5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a556a6b6a75693997390f3bacf6e5ca5e">&#9670;&#160;</a></span>getCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t NimBLEEddystoneTLM::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2022-07-31 19:38:16 +02:00
<p>Get the count of advertisements sent. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of advertisements. </dd></dl>
</div>
</div>
<a id="a32c448f92ce2e61a9589d1cb0d149d07" name="a32c448f92ce2e61a9589d1cb0d149d07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32c448f92ce2e61a9589d1cb0d149d07">&#9670;&#160;</a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const NimBLEEddystoneTLM::BeaconData NimBLEEddystoneTLM::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="a72589029e329c3939b05f9df5e8113ce" name="a72589029e329c3939b05f9df5e8113ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72589029e329c3939b05f9df5e8113ce">&#9670;&#160;</a></span>getTemp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t NimBLEEddystoneTLM::getTemp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the temperature being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The temperature value. </dd></dl>
</div>
</div>
<a id="ab1c4a13c2f57a6e0293810dd09be3db3" name="ab1c4a13c2f57a6e0293810dd09be3db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1c4a13c2f57a6e0293810dd09be3db3">&#9670;&#160;</a></span>getTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t NimBLEEddystoneTLM::getTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2022-07-31 19:38:16 +02:00
<p>Get the advertisement time. </p>
<dl class="section return"><dt>Returns</dt><dd>The advertisement time. </dd></dl>
</div>
</div>
<a id="aa511375f22952c0f5846a51e6c2511c5" name="aa511375f22952c0f5846a51e6c2511c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa511375f22952c0f5846a51e6c2511c5">&#9670;&#160;</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> NimBLEEddystoneTLM::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="ae9f17d2c1e4150775881babb73f0b10c" name="ae9f17d2c1e4150775881babb73f0b10c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9f17d2c1e4150775881babb73f0b10c">&#9670;&#160;</a></span>getVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t NimBLEEddystoneTLM::getVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The version number. </dd></dl>
</div>
</div>
<a id="af9862f983df6f48a96220e936d13d17b" name="af9862f983df6f48a96220e936d13d17b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9862f983df6f48a96220e936d13d17b">&#9670;&#160;</a></span>getVolt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEEddystoneTLM::getVolt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the battery voltage. </p>
<dl class="section return"><dt>Returns</dt><dd>The battery voltage. </dd></dl>
</div>
</div>
<a id="a6d033c09a513b2dfdad6f1b962b906a8" name="a6d033c09a513b2dfdad6f1b962b906a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d033c09a513b2dfdad6f1b962b906a8">&#9670;&#160;</a></span>setCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setCount </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>advCount</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2022-07-31 19:38:16 +02:00
<p>Set the advertisement count. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
2022-07-31 19:38:16 +02:00
<tr><td class="paramdir">[in]</td><td class="paramname">advCount</td><td>The advertisement number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a394d96131aecd687905fbff05196d4e6" name="a394d96131aecd687905fbff05196d4e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a394d96131aecd687905fbff05196d4e6">&#9670;&#160;</a></span>setData() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setData </td>
<td>(</td>
<td class="paramtype">const BeaconData &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2022-07-31 19:38:16 +02:00
<p>Set the raw data for the beacon advertisement. </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="a05989cc6df5d5dc423c878d2317ddb89" name="a05989cc6df5d5dc423c878d2317ddb89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05989cc6df5d5dc423c878d2317ddb89">&#9670;&#160;</a></span>setData() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setData </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the raw data for the beacon advertisement. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to the data to advertise. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af5ff73359f3c7f7e76395d32f4efe575" name="af5ff73359f3c7f7e76395d32f4efe575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5ff73359f3c7f7e76395d32f4efe575">&#9670;&#160;</a></span>setTemp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setTemp </td>
<td>(</td>
<td class="paramtype">int16_t&#160;</td>
<td class="paramname"><em>temp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the temperature to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">temp</td><td>The temperature value in 8.8 fixed point format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a999d53f4bad59c2ebc688403f66474b1" name="a999d53f4bad59c2ebc688403f66474b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a999d53f4bad59c2ebc688403f66474b1">&#9670;&#160;</a></span>setTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setTime </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>tmil</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2022-07-31 19:38:16 +02:00
<p>Set the advertisement time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
2022-07-31 19:38:16 +02:00
<tr><td class="paramdir">[in]</td><td class="paramname">tmil</td><td>The advertisement time in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a49fdfb7c2edf2ae92f69856ec0ce4291" name="a49fdfb7c2edf2ae92f69856ec0ce4291"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49fdfb7c2edf2ae92f69856ec0ce4291">&#9670;&#160;</a></span>setUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::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>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">uuid</td><td>The UUID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a205e0e2efc09c4c5043f11aeddee4d63" name="a205e0e2efc09c4c5043f11aeddee4d63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a205e0e2efc09c4c5043f11aeddee4d63">&#9670;&#160;</a></span>setVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setVersion </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>version</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the version to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>The version number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad69af8fe47502d922203916357f6c206" name="ad69af8fe47502d922203916357f6c206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad69af8fe47502d922203916357f6c206">&#9670;&#160;</a></span>setVolt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setVolt </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>volt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the battery voltage to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">volt</td><td>The voltage in millivolts. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a970ba10424567d17c961ed3b3ef83d8e" name="a970ba10424567d17c961ed3b3ef83d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a970ba10424567d17c961ed3b3ef83d8e">&#9670;&#160;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneTLM::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a string representation of the beacon. </p>
<dl class="section return"><dt>Returns</dt><dd>The string representation. </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_t_l_m.html">NimBLEEddystoneTLM</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>