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/_nim_b_l_e_beacon_8h_source.html
h2zero 6ae5666f7a v1.3.2
2022-01-15 15:23:57 -07:00

160 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: K:/Users/Ryan/Desktop/thermo-git/components/esp-nimble-cpp/src/NimBLEBeacon.h Source File</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('_nim_b_l_e_beacon_8h_source.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="headertitle">
<div class="title">NimBLEBeacon.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEBeacon2.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 15 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEBeacon2.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jan 4, 2018</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLEBEACON_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLEBEACON_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_beacon.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; uint16_t manufacturerId;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; uint8_t subType;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; uint8_t subTypeLength;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; uint8_t proximityUUID[16];</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; uint16_t major;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint16_t minor;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; int8_t signalPower;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; } __attribute__((packed)) m_beaconData;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37">NimBLEBeacon</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::string <a class="code" href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">getData</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">getMajor</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">getMinor</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">getManufacturerId</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">getProximityUUID</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; int8_t <a class="code" href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">getSignalPower</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">setData</a>(<span class="keyword">const</span> std::string &amp;data);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">setMajor</a>(uint16_t major);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">setMinor</a>(uint16_t minor);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">setManufacturerId</a>(uint16_t manufacturerId);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">setProximityUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">setSignalPower</a>(int8_t signalPower);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;}; <span class="comment">// NimBLEBeacon</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLEBEACON_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html"><div class="ttname"><a href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></div><div class="ttdoc">Representation of a beacon. See:</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.h:24</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a1ec99fe7684181e7b899cd763f9b44d9"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">NimBLEBeacon::setManufacturerId</a></div><div class="ttdeci">void setManufacturerId(uint16_t manufacturerId)</div><div class="ttdoc">Set the manufacturer ID.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:122</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a44d03b0c2b1bea3bee8f15feeb73fb8e"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">NimBLEBeacon::setMinor</a></div><div class="ttdeci">void setMinor(uint16_t minor)</div><div class="ttdoc">Set the minor value.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:131</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a4bc9fd3a68b4b1772dc4d102573c6788"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">NimBLEBeacon::getMinor</a></div><div class="ttdeci">uint16_t getMinor()</div><div class="ttdoc">Get the minor value being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:72</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a4eb27b3e447f8f0b44128f77933be668"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">NimBLEBeacon::getSignalPower</a></div><div class="ttdeci">int8_t getSignalPower()</div><div class="ttdoc">Get the signal power being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:90</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a7f33ffc298285d1ab02088b2584f2256"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">NimBLEBeacon::setProximityUUID</a></div><div class="ttdeci">void setProximityUUID(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Set the proximity UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:140</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a8803d70e8c238ccb98edcf31af0ead40"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">NimBLEBeacon::getManufacturerId</a></div><div class="ttdeci">uint16_t getManufacturerId()</div><div class="ttdoc">Get the manufacturer ID being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:63</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a92292c8b1f5ba0097f063ff6e60934ff"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">NimBLEBeacon::setData</a></div><div class="ttdeci">void setData(const std::string &amp;data)</div><div class="ttdoc">Set the raw data for the beacon record.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:99</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a999ade63059620d619609676d85186ad"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">NimBLEBeacon::getProximityUUID</a></div><div class="ttdeci">NimBLEUUID getProximityUUID()</div><div class="ttdoc">Get the proximity UUID being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:81</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_aac32b7f86c73221152909528c8dbad3c"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">NimBLEBeacon::getMajor</a></div><div class="ttdeci">uint16_t getMajor()</div><div class="ttdoc">Get the major value being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:54</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_abef1334108f8049832da7fffb56f6eea"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">NimBLEBeacon::setMajor</a></div><div class="ttdeci">void setMajor(uint16_t major)</div><div class="ttdoc">Set the major value.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:113</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_ac99e1fb4ef4795785a655b117dabdd37"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37">NimBLEBeacon::NimBLEBeacon</a></div><div class="ttdeci">NimBLEBeacon()</div><div class="ttdoc">Construct a default beacon object.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:30</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_ae2458f7db169b696e6368802d5ece0d9"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">NimBLEBeacon::getData</a></div><div class="ttdeci">std::string getData()</div><div class="ttdoc">Retrieve the data that is being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_ae2dd8cd367260dd8374309576457cec0"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">NimBLEBeacon::setSignalPower</a></div><div class="ttdeci">void setSignalPower(int8_t signalPower)</div><div class="ttdoc">Set the signal power.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:153</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a></div><div class="ttdoc">A model of a BLE UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.h:37</div></div>
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLEBeacon.h</b></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