ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-25 20:20:47 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_scan_8h_source.html
h2zero 887379cd3f deploy: da48844e2f
2024-12-22 00:10:12 +00:00

260 lines
38 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/NimBLEScan.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.2</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_scan_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">NimBLEScan.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_SCAN_H_</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_SCAN_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_OBSERVER)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor"># include &quot;NimBLEAdvertisedDevice.h&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor"># include &quot;NimBLEUtils.h&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor"># if defined(CONFIG_NIMBLE_CPP_IDF)</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor"># include &quot;host/ble_gap.h&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor"># else</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor"># include &quot;nimble/nimble/host/include/host/ble_gap.h&quot;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor"># endif</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor"># include &lt;vector&gt;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_device.html">NimBLEDevice</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_scan.html">NimBLEScan</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_address.html">NimBLEAddress</a>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="foldopen" id="foldopen00048" data-start="{" data-end="};">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_scan_results.html"> 48</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan_results.html#af143b1aa3bd67157dd263fcbeb4827ba">dump</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_nim_b_l_e_scan_results.html#a59c62c0825917ebb26bcb1efa2a98f4d">getCount</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* <a class="code hl_function" href="class_nim_b_l_e_scan_results.html#a98b106a3929919bf2c80cc0dfff59ba1">getDevice</a>(uint32_t idx) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* <a class="code hl_function" href="class_nim_b_l_e_scan_results.html#a98b106a3929919bf2c80cc0dfff59ba1">getDevice</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&amp; address) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> std::vector&lt;NimBLEAdvertisedDevice*&gt;::const_iterator <a class="code hl_function" href="class_nim_b_l_e_scan_results.html#a5a0b1dc434c4ad68ae5ce233eeacc230">begin</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> std::vector&lt;NimBLEAdvertisedDevice*&gt;::const_iterator <a class="code hl_function" href="class_nim_b_l_e_scan_results.html#a2547ebc0f9f0e1f48346ff0188ed6479">end</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">friend</span> <a class="code hl_class" href="class_nim_b_l_e_scan.html">NimBLEScan</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::vector&lt;NimBLEAdvertisedDevice*&gt; m_deviceVec;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="foldopen" id="foldopen00067" data-start="{" data-end="};">
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_scan.html"> 67</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_scan.html">NimBLEScan</a> {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#ac1307f30a881688d3a4d57bac7abe02c">start</a>(uint32_t duration, <span class="keywordtype">bool</span> isContinue = <span class="keyword">false</span>, <span class="keywordtype">bool</span> restart = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016">isScanning</a>();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a3b0d41fc5d9113a02357c1b2a43c5d1d">setScanCallbacks</a>(<a class="code hl_class" href="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</a>* pScanCallbacks, <span class="keywordtype">bool</span> wantDuplicates = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910">setActiveScan</a>(<span class="keywordtype">bool</span> active);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a4c3e1794c3e56acba76ee269ffb1393e">setInterval</a>(uint16_t intervalMs);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a0fec97ad0f4ff191bb853138c30d5316">setWindow</a>(uint16_t windowMs);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#aabbf3f1804a844a7db0284ecc2b78408">setDuplicateFilter</a>(uint8_t enabled);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1">setLimitedOnly</a>(<span class="keywordtype">bool</span> enabled);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967">setFilterPolicy</a>(uint8_t filter);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1">stop</a>();</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b">clearResults</a>();</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_class" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">getResults</a>();</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_class" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">getResults</a>(uint32_t duration, <span class="keywordtype">bool</span> is_continue = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81">setMaxResults</a>(uint8_t maxResults);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">erase</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&amp; address);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">erase</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* device);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="preprocessor"># if CONFIG_BT_NIMBLE_EXT_ADV</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">enum</span> Phy { SCAN_1M = 0x01, SCAN_CODED = 0x02, SCAN_ALL = 0x03 };</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#a17f2f775b5e6793f06a412f840d5dceb">setPhy</a>(Phy phyMask);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan.html#aaace4d0b128b6294276347f6790f3f8b">setPeriod</a>(uint32_t periodMs);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor"># endif</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_device.html">NimBLEDevice</a>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_class" href="class_nim_b_l_e_scan.html">NimBLEScan</a>();</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_class" href="class_nim_b_l_e_scan.html">~NimBLEScan</a>();</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(ble_gap_event* event, <span class="keywordtype">void</span>* arg);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">void</span> onHostSync();</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_class" href="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</a>* m_pScanCallbacks;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> ble_gap_disc_params m_scanParams;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <a class="code hl_class" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> m_scanResults;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <a class="code hl_struct" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a>* m_pTaskData;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> uint8_t m_maxResults;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor"># if CONFIG_BT_NIMBLE_EXT_ADV</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> uint8_t m_phy{SCAN_ALL};</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> uint16_t m_period{0};</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="preprocessor"># endif</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>};</div>
</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="foldopen" id="foldopen00115" data-start="{" data-end="};">
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_scan_callbacks.html"> 115</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</a> {</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_nim_b_l_e_scan_callbacks.html">~NimBLEScanCallbacks</a>() {}</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan_callbacks.html#a1f9b5eac5982340afbb84954a4c06277">onDiscovered</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* advertisedDevice);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan_callbacks.html#a962d8b08cf14ac3091e6fd6962d7e283">onResult</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* advertisedDevice);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_scan_callbacks.html#a61c11db405e87ec847066ca3b6ad8375">onScanEnd</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>&amp; scanResults, <span class="keywordtype">int</span> reason);</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span>};</div>
</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED CONFIG_BT_NIMBLE_ROLE_OBSERVER</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="preprocessor">#endif </span><span class="comment">// NIMBLE_CPP_SCAN_H_</span></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html"><div class="ttname"><a href="class_nim_b_l_e_address.html">NimBLEAddress</a></div><div class="ttdoc">A BLE device address.</div><div class="ttdef"><b>Definition</b> NimBLEAddress.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></div><div class="ttdoc">A representation of a BLE advertised device found by a scan.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisedDevice.h:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html"><div class="ttname"><a href="class_nim_b_l_e_device.html">NimBLEDevice</a></div><div class="ttdoc">A model of a BLE Device from which all the BLE roles are created.</div><div class="ttdef"><b>Definition</b> NimBLEDevice.h:109</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</a></div><div class="ttdoc">A callback handler for callbacks associated device scanning.</div><div class="ttdef"><b>Definition</b> NimBLEScan.h:115</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a1f9b5eac5982340afbb84954a4c06277"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a1f9b5eac5982340afbb84954a4c06277">NimBLEScanCallbacks::onDiscovered</a></div><div class="ttdeci">virtual void onDiscovered(const NimBLEAdvertisedDevice *advertisedDevice)</div><div class="ttdoc">Called when a new device is discovered, before the scan result is received (if applicable).</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:538</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a61c11db405e87ec847066ca3b6ad8375"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a61c11db405e87ec847066ca3b6ad8375">NimBLEScanCallbacks::onScanEnd</a></div><div class="ttdeci">virtual void onScanEnd(const NimBLEScanResults &amp;scanResults, int reason)</div><div class="ttdoc">Called when a scan operation ends.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:546</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a962d8b08cf14ac3091e6fd6962d7e283"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a962d8b08cf14ac3091e6fd6962d7e283">NimBLEScanCallbacks::onResult</a></div><div class="ttdeci">virtual void onResult(const NimBLEAdvertisedDevice *advertisedDevice)</div><div class="ttdoc">Called when a new scan result is complete, including scan response data (if applicable).</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:542</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html"><div class="ttname"><a href="class_nim_b_l_e_scan.html">NimBLEScan</a></div><div class="ttdoc">Perform and manage BLE scans.</div><div class="ttdef"><b>Definition</b> NimBLEScan.h:67</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a0fec97ad0f4ff191bb853138c30d5316"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a0fec97ad0f4ff191bb853138c30d5316">NimBLEScan::setWindow</a></div><div class="ttdeci">void setWindow(uint16_t windowMs)</div><div class="ttdoc">Set the window to actively scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:257</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a17f2f775b5e6793f06a412f840d5dceb"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a17f2f775b5e6793f06a412f840d5dceb">NimBLEScan::setPhy</a></div><div class="ttdeci">void setPhy(Phy phyMask)</div><div class="ttdoc">Set the PHYs to scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:276</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a2ae53719546e2d410c816e12c56aad61"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">NimBLEScan::getResults</a></div><div class="ttdeci">NimBLEScanResults getResults()</div><div class="ttdoc">Get the results of the scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:463</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a3b0d41fc5d9113a02357c1b2a43c5d1d"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a3b0d41fc5d9113a02357c1b2a43c5d1d">NimBLEScan::setScanCallbacks</a></div><div class="ttdeci">void setScanCallbacks(NimBLEScanCallbacks *pScanCallbacks, bool wantDuplicates=false)</div><div class="ttdoc">Set the call backs to be invoked.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:234</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a4248aabb5da67953eadab2a6f834d967"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967">NimBLEScan::setFilterPolicy</a></div><div class="ttdeci">void setFilterPolicy(uint8_t filter)</div><div class="ttdoc">Sets the scan filter policy.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:216</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a4c3e1794c3e56acba76ee269ffb1393e"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a4c3e1794c3e56acba76ee269ffb1393e">NimBLEScan::setInterval</a></div><div class="ttdeci">void setInterval(uint16_t intervalMs)</div><div class="ttdoc">Set the interval to scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:249</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a566a9ef25b04e946ac23402bb760cda1"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">NimBLEScan::erase</a></div><div class="ttdeci">void erase(const NimBLEAddress &amp;address)</div><div class="ttdoc">Delete peer device from the scan results vector.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:398</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a68fa5cc715f62a9a97ac0dccfb8557c1"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1">NimBLEScan::stop</a></div><div class="ttdeci">bool stop()</div><div class="ttdoc">Stop an in progress scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:373</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a77483be2bd9dad08322cc64f4e7012c1"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1">NimBLEScan::setLimitedOnly</a></div><div class="ttdeci">void setLimitedOnly(bool enabled)</div><div class="ttdoc">Set whether or not the BLE controller only reports scan results from devices advertising in limited d...</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:194</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a7d24e77d6b339552b6ac16effdb54910"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910">NimBLEScan::setActiveScan</a></div><div class="ttdeci">void setActiveScan(bool active)</div><div class="ttdoc">Should we perform an active or passive scan? The default is a passive scan. An active scan means that...</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:171</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_aaace4d0b128b6294276347f6790f3f8b"><div class="ttname"><a href="class_nim_b_l_e_scan.html#aaace4d0b128b6294276347f6790f3f8b">NimBLEScan::setPeriod</a></div><div class="ttdeci">void setPeriod(uint32_t periodMs)</div><div class="ttdoc">Set the extended scanning period.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:287</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_aabbf3f1804a844a7db0284ecc2b78408"><div class="ttname"><a href="class_nim_b_l_e_scan.html#aabbf3f1804a844a7db0284ecc2b78408">NimBLEScan::setDuplicateFilter</a></div><div class="ttdeci">void setDuplicateFilter(uint8_t enabled)</div><div class="ttdoc">Set whether or not the BLE controller should only report results from devices it has not already seen...</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:185</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_aad9cd2462d00d7c0fa39d095aa2d8e81"><div class="ttname"><a href="class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81">NimBLEScan::setMaxResults</a></div><div class="ttdeci">void setMaxResults(uint8_t maxResults)</div><div class="ttdoc">Sets the max number of results to store.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:225</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ab788ad282fdbf4467302f6ad2d4d6016"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016">NimBLEScan::isScanning</a></div><div class="ttdeci">bool isScanning()</div><div class="ttdoc">Get the status of the scanner.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:265</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ac1307f30a881688d3a4d57bac7abe02c"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ac1307f30a881688d3a4d57bac7abe02c">NimBLEScan::start</a></div><div class="ttdeci">bool start(uint32_t duration, bool isContinue=false, bool restart=true)</div><div class="ttdoc">Start scanning.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:300</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ad421a09eeb021755b193a7a5e01f183b"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b">NimBLEScan::clearResults</a></div><div class="ttdeci">void clearResults()</div><div class="ttdoc">Clear the stored results of the scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:470</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></div><div class="ttdoc">A class that contains and operates on the results of a BLE scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.h:48</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a2547ebc0f9f0e1f48346ff0188ed6479"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a2547ebc0f9f0e1f48346ff0188ed6479">NimBLEScanResults::end</a></div><div class="ttdeci">std::vector&lt; NimBLEAdvertisedDevice * &gt;::const_iterator end() const</div><div class="ttdoc">Get iterator to the end of the vector of advertised device pointers.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:516</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a59c62c0825917ebb26bcb1efa2a98f4d"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a59c62c0825917ebb26bcb1efa2a98f4d">NimBLEScanResults::getCount</a></div><div class="ttdeci">int getCount() const</div><div class="ttdoc">Get the count of devices found in the last scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:490</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a5a0b1dc434c4ad68ae5ce233eeacc230"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a5a0b1dc434c4ad68ae5ce233eeacc230">NimBLEScanResults::begin</a></div><div class="ttdeci">std::vector&lt; NimBLEAdvertisedDevice * &gt;::const_iterator begin() const</div><div class="ttdoc">Get iterator to the beginning of the vector of advertised device pointers.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:508</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a98b106a3929919bf2c80cc0dfff59ba1"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a98b106a3929919bf2c80cc0dfff59ba1">NimBLEScanResults::getDevice</a></div><div class="ttdeci">const NimBLEAdvertisedDevice * getDevice(uint32_t idx) const</div><div class="ttdoc">Return the specified device at the given index. The index should be between 0 and getCount()-1.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:500</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_af143b1aa3bd67157dd263fcbeb4827ba"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#af143b1aa3bd67157dd263fcbeb4827ba">NimBLEScanResults::dump</a></div><div class="ttdeci">void dump() const</div><div class="ttdoc">Dump the scan results to the log.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:480</div></div>
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div>
<div class="ttc" id="astruct_nim_b_l_e_task_data_html"><div class="ttname"><a href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a></div><div class="ttdoc">A structure to hold data for a task that is waiting for a response.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.h:32</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>NimBLEScan.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