mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-23 13:40:55 +01:00
506 lines
25 KiB
HTML
506 lines
25 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: 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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">esp-nimble-cpp
|
|
 <span id="projectnumber">1.4.0</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_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">
|
|
<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_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>
|
|
<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:a4d87d0b11420af2ae04bc4e6ce2f8607"><td class="memItemLeft" align="right" valign="top"><a id="a4d87d0b11420af2ae04bc4e6ce2f8607"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a4d87d0b11420af2ae04bc4e6ce2f8607">NimBLEEddystoneTLM</a> ()</td></tr>
|
|
<tr class="memdesc:a4d87d0b11420af2ae04bc4e6ce2f8607"><td class="mdescLeft"> </td><td class="mdescRight">Construct a default EddystoneTLM beacon object. <br /></td></tr>
|
|
<tr class="separator:a4d87d0b11420af2ae04bc4e6ce2f8607"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae146a8f066ef3fc6994070654ec5d7ea"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">getData</a> ()</td></tr>
|
|
<tr class="memdesc:ae146a8f066ef3fc6994070654ec5d7ea"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the data that is being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">More...</a><br /></td></tr>
|
|
<tr class="separator:ae146a8f066ef3fc6994070654ec5d7ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa511375f22952c0f5846a51e6c2511c5"><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_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">getUUID</a> ()</td></tr>
|
|
<tr class="memdesc:aa511375f22952c0f5846a51e6c2511c5"><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">More...</a><br /></td></tr>
|
|
<tr class="separator:aa511375f22952c0f5846a51e6c2511c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9f17d2c1e4150775881babb73f0b10c"><td class="memItemLeft" align="right" valign="top">uint8_t </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"> </td><td class="mdescRight">Get the version being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9f17d2c1e4150775881babb73f0b10c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9862f983df6f48a96220e936d13d17b"><td class="memItemLeft" align="right" valign="top">uint16_t </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"> </td><td class="mdescRight">Get the battery voltage. <a href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">More...</a><br /></td></tr>
|
|
<tr class="separator:af9862f983df6f48a96220e936d13d17b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abda56940f7d9f7ccef2629b75880dd5f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">getTemp</a> ()</td></tr>
|
|
<tr class="memdesc:abda56940f7d9f7ccef2629b75880dd5f"><td class="mdescLeft"> </td><td class="mdescRight">Get the temperature being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">More...</a><br /></td></tr>
|
|
<tr class="separator:abda56940f7d9f7ccef2629b75880dd5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a556a6b6a75693997390f3bacf6e5ca5e"><td class="memItemLeft" align="right" valign="top">uint32_t </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"> </td><td class="mdescRight">Get the count of advertisements sent. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">More...</a><br /></td></tr>
|
|
<tr class="separator:a556a6b6a75693997390f3bacf6e5ca5e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="memItemLeft" align="right" valign="top">uint32_t </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"> </td><td class="mdescRight">Get the advertisement time. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">More...</a><br /></td></tr>
|
|
<tr class="separator:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a970ba10424567d17c961ed3b3ef83d8e"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td><td class="mdescRight">Get a string representation of the beacon. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">More...</a><br /></td></tr>
|
|
<tr class="separator:a970ba10424567d17c961ed3b3ef83d8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a160e33218dc7fb33f678cda1605da52e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">setData</a> (const std::string &data)</td></tr>
|
|
<tr class="memdesc:a160e33218dc7fb33f678cda1605da52e"><td class="mdescLeft"> </td><td class="mdescRight">Set the raw data for the beacon advertisement. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">More...</a><br /></td></tr>
|
|
<tr class="separator:a160e33218dc7fb33f678cda1605da52e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="memItemLeft" align="right" valign="top">void </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> &l_uuid)</td></tr>
|
|
<tr class="memdesc:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="mdescLeft"> </td><td class="mdescRight">Set the UUID to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">More...</a><br /></td></tr>
|
|
<tr class="separator:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a205e0e2efc09c4c5043f11aeddee4d63"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Set the version to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">More...</a><br /></td></tr>
|
|
<tr class="separator:a205e0e2efc09c4c5043f11aeddee4d63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad69af8fe47502d922203916357f6c206"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Set the battery voltage to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206">More...</a><br /></td></tr>
|
|
<tr class="separator:ad69af8fe47502d922203916357f6c206"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e8ee8fff10730089a370f9da7b6a691"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">setTemp</a> (float temp)</td></tr>
|
|
<tr class="memdesc:a8e8ee8fff10730089a370f9da7b6a691"><td class="mdescLeft"> </td><td class="mdescRight">Set the temperature to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e8ee8fff10730089a370f9da7b6a691"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d033c09a513b2dfdad6f1b962b906a8"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Set the advertisement count. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">More...</a><br /></td></tr>
|
|
<tr class="separator:a6d033c09a513b2dfdad6f1b962b906a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a999d53f4bad59c2ebc688403f66474b1"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Set the advertisement time. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a999d53f4bad59c2ebc688403f66474b1"><td class="memSeparator" colspan="2"> </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a556a6b6a75693997390f3bacf6e5ca5e">◆ </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">
|
|
|
|
<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="ae146a8f066ef3fc6994070654ec5d7ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae146a8f066ef3fc6994070654ec5d7ea">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string 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="abda56940f7d9f7ccef2629b75880dd5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abda56940f7d9f7ccef2629b75880dd5f">◆ </a></span>getTemp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float 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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1c4a13c2f57a6e0293810dd09be3db3">◆ </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">
|
|
|
|
<p>Get the advertisement time. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The advertisement time. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa511375f22952c0f5846a51e6c2511c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa511375f22952c0f5846a51e6c2511c5">◆ </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9f17d2c1e4150775881babb73f0b10c">◆ </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9862f983df6f48a96220e936d13d17b">◆ </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d033c09a513b2dfdad6f1b962b906a8">◆ </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 </td>
|
|
<td class="paramname"><em>advCount</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the advertisement count. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">advCount</td><td>The advertisement number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a160e33218dc7fb33f678cda1605da52e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a160e33218dc7fb33f678cda1605da52e">◆ </a></span>setData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NimBLEEddystoneTLM::setData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set 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="a8e8ee8fff10730089a370f9da7b6a691"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e8ee8fff10730089a370f9da7b6a691">◆ </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">float </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. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a999d53f4bad59c2ebc688403f66474b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a999d53f4bad59c2ebc688403f66474b1">◆ </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 </td>
|
|
<td class="paramname"><em>tmil</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the advertisement time. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49fdfb7c2edf2ae92f69856ec0ce4291">◆ </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> & </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>
|
|
<a id="a205e0e2efc09c4c5043f11aeddee4d63"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a205e0e2efc09c4c5043f11aeddee4d63">◆ </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 </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad69af8fe47502d922203916357f6c206">◆ </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 </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a970ba10424567d17c961ed3b3ef83d8e">◆ </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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|