ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-26 04:30:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_advertisement_data_8h_source.html
h2zero 059364985d deploy: 275def333c
2024-12-17 01:50:27 +00:00

216 lines
34 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" 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"/>
<title>esp-nimble-cpp: /github/workspace/src/NimBLEAdvertisementData.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 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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('_nim_b_l_e_advertisement_data_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">
<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="headertitle"><div class="title">NimBLEAdvertisementData.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright 2020-2024 Ryan Powell &lt;ryan@nable-embedded.io&gt; and</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * esp-nimble-cpp, NimBLE-Arduino contributors.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * limitations under the License.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef NIMBLE_CPP_ADVERTISEMENT_DATA_H_</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_ADVERTISEMENT_DATA_H_</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if (defined(CONFIG_BT_ENABLED) &amp;&amp; defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) &amp;&amp; !CONFIG_BT_NIMBLE_EXT_ADV) || \</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor"> defined(_DOXYGEN_)</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor"># include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor"># include &lt;string&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor"># include &lt;vector&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>;</div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertisement_data.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Only a subset of the possible BLE architected advertisement fields are currently exposed. Others will</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// be exposed on demand/request or as time permits.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a67f4d6869eb2797bc78389adf20cb59e">addData</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a67f4d6869eb2797bc78389adf20cb59e">addData</a>(<span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; data);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a63dca8c3219f682569db26eddbc8880c">setAppearance</a>(uint16_t appearance);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a00c9c605b9a1054ad056fc0f0f7ebf0d">setFlags</a>(uint8_t);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a3f227c597ec00f639e4bd26b80ce404b">addTxPower</a>();</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#acee3a78f4c8d69a1dc3df1f9af16632f">setPreferredParams</a>(uint16_t minInterval, uint16_t maxInterval);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#acbea9f95711b329a427919ecd9cbeb23">addServiceUUID</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; serviceUUID);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#acbea9f95711b329a427919ecd9cbeb23">addServiceUUID</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* serviceUUID);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#ad22fa3253134dd5bfd3e76f8c31bef2e">removeServiceUUID</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; serviceUUID);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#ad22fa3253134dd5bfd3e76f8c31bef2e">removeServiceUUID</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* serviceUUID);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#aff30e0d0dc95e1dc8bb1cb6858a4e813">removeServices</a>();</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0b076298058755149b4351727d70b198">setManufacturerData</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0b076298058755149b4351727d70b198">setManufacturerData</a>(<span class="keyword">const</span> std::string&amp; data);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0b076298058755149b4351727d70b198">setManufacturerData</a>(<span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; data);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a852969e05a7884faf6cfcd2001f80ec9">setURI</a>(<span class="keyword">const</span> std::string&amp; uri);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#adf8f35c7735f8a29130482b302f04006">setName</a>(<span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">bool</span> isComplete = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a32922b53631443b92463c8942b8d0839">setShortName</a>(<span class="keyword">const</span> std::string&amp; name);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#aafa437cd95751da68d6b8691ce3eea46">setCompleteServices</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a89c45ddb804600bd6b6175687f6c1bb0">setCompleteServices16</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt;&amp; uuids);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#aef5e7a5b2d3dd9c09b6a55582d7d22d6">setCompleteServices32</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt;&amp; uuids);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0a4102da7495d39e8a0033e1661b76a6">setPartialServices</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a91671d595cfed4547df670884633a7a4">setPartialServices16</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt;&amp; uuids);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a736480e1e778ed93890d2071f558f186">setPartialServices32</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt;&amp; uuids);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0399149f6359d33ca4781c8282844394">setServiceData</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid, <span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0399149f6359d33ca4781c8282844394">setServiceData</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid, <span class="keyword">const</span> std::string&amp; data);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a0399149f6359d33ca4781c8282844394">setServiceData</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid, <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; data);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#acf839da2c36a9ac5ef53e86b57d73874">removeData</a>(uint8_t type);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#ac0f2238cf17bf3e8bbef8b0ef0d61dcf">clearData</a>();</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a57d4ece891cc23b2079ccc4e06d477b2">getDataLocation</a>(uint8_t type) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> std::string <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a6ff7fc36a9f5966792f354d2586714a6">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> std::vector&lt;uint8_t&gt; <a class="code hl_function" href="class_nim_b_l_e_advertisement_data.html#a2f6960683e8b98d1c3ecf88bb5ec56eb">getPayload</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">bool</span> setServices(<span class="keywordtype">bool</span> complete, uint8_t size, <span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt;&amp; v_uuid);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> std::vector&lt;uint8_t&gt; m_payload{};</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}; <span class="comment">// NimBLEAdvertisementData</span></div>
</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED &amp;&amp; CONFIG_BT_NIMBLE_ROLE_BROADCASTER &amp;&amp; !CONFIG_BT_NIMBLE_EXT_ADV</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#endif </span><span class="comment">// NIMBLE_CPP_ADVERTISEMENT_DATA_H_</span></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></div><div class="ttdoc">Advertisement data set by the programmer to be published by the BLE server.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.h:33</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a00c9c605b9a1054ad056fc0f0f7ebf0d"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a00c9c605b9a1054ad056fc0f0f7ebf0d">NimBLEAdvertisementData::setFlags</a></div><div class="ttdeci">bool setFlags(uint8_t)</div><div class="ttdoc">Set the advertisement flags.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:86</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a0399149f6359d33ca4781c8282844394"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a0399149f6359d33ca4781c8282844394">NimBLEAdvertisementData::setServiceData</a></div><div class="ttdeci">bool setServiceData(const NimBLEUUID &amp;uuid, const uint8_t *data, size_t length)</div><div class="ttdoc">Set the service data advertised for the UUID.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:458</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a0a4102da7495d39e8a0033e1661b76a6"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a0a4102da7495d39e8a0033e1661b76a6">NimBLEAdvertisementData::setPartialServices</a></div><div class="ttdeci">bool setPartialServices(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Set a single service to advertise as a partial list of services.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:381</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a0b076298058755149b4351727d70b198"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a0b076298058755149b4351727d70b198">NimBLEAdvertisementData::setManufacturerData</a></div><div class="ttdeci">bool setManufacturerData(const uint8_t *data, size_t length)</div><div class="ttdoc">Set manufacturer specific data.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:268</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a2f6960683e8b98d1c3ecf88bb5ec56eb"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a2f6960683e8b98d1c3ecf88bb5ec56eb">NimBLEAdvertisementData::getPayload</a></div><div class="ttdeci">std::vector&lt; uint8_t &gt; getPayload() const</div><div class="ttdoc">Retrieve the payload that is to be advertised.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:554</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a32922b53631443b92463c8942b8d0839"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a32922b53631443b92463c8942b8d0839">NimBLEAdvertisementData::setShortName</a></div><div class="ttdeci">bool setShortName(const std::string &amp;name)</div><div class="ttdoc">Set the short name.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:345</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a3f227c597ec00f639e4bd26b80ce404b"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a3f227c597ec00f639e4bd26b80ce404b">NimBLEAdvertisementData::addTxPower</a></div><div class="ttdeci">bool addTxPower()</div><div class="ttdoc">Adds Tx power level to the advertisement data.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:108</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a57d4ece891cc23b2079ccc4e06d477b2"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a57d4ece891cc23b2079ccc4e06d477b2">NimBLEAdvertisementData::getDataLocation</a></div><div class="ttdeci">int getDataLocation(uint8_t type) const</div><div class="ttdoc">Get the location of the data in the payload.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:521</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a63dca8c3219f682569db26eddbc8880c"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a63dca8c3219f682569db26eddbc8880c">NimBLEAdvertisementData::setAppearance</a></div><div class="ttdeci">bool setAppearance(uint16_t appearance)</div><div class="ttdoc">Set the appearance.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:65</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a67f4d6869eb2797bc78389adf20cb59e"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a67f4d6869eb2797bc78389adf20cb59e">NimBLEAdvertisementData::addData</a></div><div class="ttdeci">bool addData(const uint8_t *data, size_t length)</div><div class="ttdoc">Add data to the payload to be advertised.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a6ff7fc36a9f5966792f354d2586714a6"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a6ff7fc36a9f5966792f354d2586714a6">NimBLEAdvertisementData::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Get the string representation of the advertisement data.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:569</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a736480e1e778ed93890d2071f558f186"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a736480e1e778ed93890d2071f558f186">NimBLEAdvertisementData::setPartialServices32</a></div><div class="ttdeci">bool setPartialServices32(const std::vector&lt; NimBLEUUID &gt; &amp;uuids)</div><div class="ttdoc">Set the partial list of services to advertise.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:399</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a852969e05a7884faf6cfcd2001f80ec9"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a852969e05a7884faf6cfcd2001f80ec9">NimBLEAdvertisementData::setURI</a></div><div class="ttdeci">bool setURI(const std::string &amp;uri)</div><div class="ttdoc">Set the URI to advertise.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:304</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a89c45ddb804600bd6b6175687f6c1bb0"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a89c45ddb804600bd6b6175687f6c1bb0">NimBLEAdvertisementData::setCompleteServices16</a></div><div class="ttdeci">bool setCompleteServices16(const std::vector&lt; NimBLEUUID &gt; &amp;uuids)</div><div class="ttdoc">Set the complete list of 16 bit services to advertise.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:363</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a91671d595cfed4547df670884633a7a4"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a91671d595cfed4547df670884633a7a4">NimBLEAdvertisementData::setPartialServices16</a></div><div class="ttdeci">bool setPartialServices16(const std::vector&lt; NimBLEUUID &gt; &amp;uuids)</div><div class="ttdoc">Set the partial list of services to advertise.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:390</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aafa437cd95751da68d6b8691ce3eea46"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aafa437cd95751da68d6b8691ce3eea46">NimBLEAdvertisementData::setCompleteServices</a></div><div class="ttdeci">bool setCompleteServices(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Set a single service to advertise as a complete list of services.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:354</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_ac0f2238cf17bf3e8bbef8b0ef0d61dcf"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#ac0f2238cf17bf3e8bbef8b0ef0d61dcf">NimBLEAdvertisementData::clearData</a></div><div class="ttdeci">void clearData()</div><div class="ttdoc">Clear the advertisement data for reuse.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:561</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_acbea9f95711b329a427919ecd9cbeb23"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#acbea9f95711b329a427919ecd9cbeb23">NimBLEAdvertisementData::addServiceUUID</a></div><div class="ttdeci">bool addServiceUUID(const NimBLEUUID &amp;serviceUUID)</div><div class="ttdoc">Add a service uuid to exposed list of services.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:148</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_acee3a78f4c8d69a1dc3df1f9af16632f"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#acee3a78f4c8d69a1dc3df1f9af16632f">NimBLEAdvertisementData::setPreferredParams</a></div><div class="ttdeci">bool setPreferredParams(uint16_t minInterval, uint16_t maxInterval)</div><div class="ttdoc">Set the preferred min and max connection intervals to advertise.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:127</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_acf839da2c36a9ac5ef53e86b57d73874"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#acf839da2c36a9ac5ef53e86b57d73874">NimBLEAdvertisementData::removeData</a></div><div class="ttdeci">bool removeData(uint8_t type)</div><div class="ttdoc">Remove data from the advertisement data.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:537</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_ad22fa3253134dd5bfd3e76f8c31bef2e"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#ad22fa3253134dd5bfd3e76f8c31bef2e">NimBLEAdvertisementData::removeServiceUUID</a></div><div class="ttdeci">bool removeServiceUUID(const NimBLEUUID &amp;serviceUUID)</div><div class="ttdoc">Remove a service UUID from the advertisement.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:203</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_adf8f35c7735f8a29130482b302f04006"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#adf8f35c7735f8a29130482b302f04006">NimBLEAdvertisementData::setName</a></div><div class="ttdeci">bool setName(const std::string &amp;name, bool isComplete=true)</div><div class="ttdoc">Set the complete name of this device.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:326</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aef5e7a5b2d3dd9c09b6a55582d7d22d6"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aef5e7a5b2d3dd9c09b6a55582d7d22d6">NimBLEAdvertisementData::setCompleteServices32</a></div><div class="ttdeci">bool setCompleteServices32(const std::vector&lt; NimBLEUUID &gt; &amp;uuids)</div><div class="ttdoc">Set the complete list of 32 bit services to advertise.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:372</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aff30e0d0dc95e1dc8bb1cb6858a4e813"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aff30e0d0dc95e1dc8bb1cb6858a4e813">NimBLEAdvertisementData::removeServices</a></div><div class="ttdeci">bool removeServices()</div><div class="ttdoc">Remove all service UUIDs from the advertisement.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisementData.cpp:258</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html"><div class="ttname"><a href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></div><div class="ttdoc">Perform and manage BLE advertising.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertising.h:52</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:41</div></div>
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></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>NimBLEAdvertisementData.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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink