mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 20:50:46 +01:00
217 lines
30 KiB
HTML
217 lines
30 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.0"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>esp-nimble-cpp / NimBLE-Arduino: 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 style="height: 56px;">
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
|
||
|
|
 <span id="projectnumber">1.3.1</span>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.0 -->
|
||
|
|
<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('_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">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
||
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * NimBLEScan.h</span></div>
|
||
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
||
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Created: on Jan 24 2020</span></div>
|
||
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author H2zero</span></div>
|
||
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
||
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Originally:</span></div>
|
||
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
|
||
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * BLEScan.h</span></div>
|
||
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
||
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Created on: Jul 1, 2017</span></div>
|
||
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Author: kolban</span></div>
|
||
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div>
|
||
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef COMPONENTS_NIMBLE_SCAN_H_</span></div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define COMPONENTS_NIMBLE_SCAN_H_</span></div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "sdkconfig.h"</span></div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="nimconfig_8h.html">nimconfig.h</a>"</span></div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "NimBLEAdvertisedDevice.h"</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "NimBLEUtils.h"</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "host/ble_gap.h"</span></div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <vector></span></div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_device.html">NimBLEDevice</a>;</div>
|
||
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>;</div>
|
||
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>;</div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a>;</div>
|
||
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>;</div>
|
||
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_scan_results.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> {</div>
|
||
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4">dump</a>();</div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">getCount</a>();</div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> <a class="code" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">getDevice</a>(uint32_t i);</div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::vector<NimBLEAdvertisedDevice*>::iterator <a class="code" href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">begin</a>();</div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::vector<NimBLEAdvertisedDevice*>::iterator <a class="code" href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">end</a>();</div>
|
||
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *<a class="code" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">getDevice</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &address);</div>
|
||
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
||
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">private</span>:</div>
|
||
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">friend</span> <a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>;</div>
|
||
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::vector<NimBLEAdvertisedDevice*> m_advertisedDevicesVector;</div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
||
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_scan.html"> 61</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a> {</div>
|
||
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">public</span>:</div>
|
||
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820">start</a>(uint32_t duration, <span class="keywordtype">void</span> (*scanCompleteCB)(<a class="code" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>), <span class="keywordtype">bool</span> is_continue = <span class="keyword">false</span>);</div>
|
||
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> <a class="code" href="class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820">start</a>(uint32_t duration, <span class="keywordtype">bool</span> is_continue = <span class="keyword">false</span>);</div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016">isScanning</a>();</div>
|
||
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#ab275a9fec35c8957acf47689056d94af">setAdvertisedDeviceCallbacks</a>(<a class="code" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a>* pAdvertisedDeviceCallbacks, <span class="keywordtype">bool</span> wantDuplicates = <span class="keyword">false</span>);</div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910">setActiveScan</a>(<span class="keywordtype">bool</span> active);</div>
|
||
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#a3f3e30d8b79aeb4d64af10d5f9d33788">setInterval</a>(uint16_t intervalMSecs);</div>
|
||
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#ac2e8c921413f1ad217f45fecf63c0d22">setWindow</a>(uint16_t windowMSecs);</div>
|
||
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#ac40563af803f3b9ab88398c7f30e21bb">setDuplicateFilter</a>(<span class="keywordtype">bool</span> enabled);</div>
|
||
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1">setLimitedOnly</a>(<span class="keywordtype">bool</span> enabled);</div>
|
||
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967">setFilterPolicy</a>(uint8_t filter);</div>
|
||
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#a6a97fd1c7f16fccd7f19994592b6dfe6">clearDuplicateCache</a>();</div>
|
||
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1">stop</a>();</div>
|
||
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b">clearResults</a>();</div>
|
||
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> <a class="code" href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">getResults</a>();</div>
|
||
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81">setMaxResults</a>(uint8_t maxResults);</div>
|
||
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">erase</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &address);</div>
|
||
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
||
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
||
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">private</span>:</div>
|
||
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_device.html">NimBLEDevice</a>;</div>
|
||
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
||
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>();</div>
|
||
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  ~<a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>();</div>
|
||
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</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 name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> onHostReset();</div>
|
||
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> onHostSync();</div>
|
||
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
||
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a>* m_pAdvertisedDeviceCallbacks = <span class="keyword">nullptr</span>;</div>
|
||
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  void (*m_scanCompleteCB)(<a class="code" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> scanResults);</div>
|
||
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  ble_gap_disc_params m_scan_params;</div>
|
||
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">bool</span> m_ignoreResults;</div>
|
||
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> m_scanResults;</div>
|
||
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  uint32_t m_duration;</div>
|
||
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  ble_task_data_t *m_pTaskData;</div>
|
||
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  uint8_t m_maxResults;</div>
|
||
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> };</div>
|
||
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
||
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
|
||
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
|
||
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLE_SCAN_H_ */</span><span class="preprocessor"></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:34</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a></div><div class="ttdoc">A callback handler for callbacks associated device scanning.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.h:162</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:40</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:91</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:61</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a21b1e27816717b77533755f31dfaa820"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820">NimBLEScan::start</a></div><div class="ttdeci">bool start(uint32_t duration, void(*scanCompleteCB)(NimBLEScanResults), bool is_continue=false)</div><div class="ttdoc">Start scanning.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:286</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:455</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a3f3e30d8b79aeb4d64af10d5f9d33788"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a3f3e30d8b79aeb4d64af10d5f9d33788">NimBLEScan::setInterval</a></div><div class="ttdeci">void setInterval(uint16_t intervalMSecs)</div><div class="ttdoc">Set the interval to scan.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:256</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:225</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 &address)</div><div class="ttdoc">Delete peer device from the scan results vector.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:418</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:377</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a6a97fd1c7f16fccd7f19994592b6dfe6"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a6a97fd1c7f16fccd7f19994592b6dfe6">NimBLEScan::clearDuplicateCache</a></div><div class="ttdeci">void clearDuplicateCache()</div><div class="ttdoc">Clears the duplicate scan filter cache.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:406</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 report scan results from devices advertising in limited di...</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:202</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:180</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:235</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ab275a9fec35c8957acf47689056d94af"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ab275a9fec35c8957acf47689056d94af">NimBLEScan::setAdvertisedDeviceCallbacks</a></div><div class="ttdeci">void setAdvertisedDeviceCallbacks(NimBLEAdvertisedDeviceCallbacks *pAdvertisedDeviceCallbacks, bool wantDuplicates=false)</div><div class="ttdoc">Set the call backs to be invoked.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:245</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:274</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ac2e8c921413f1ad217f45fecf63c0d22"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ac2e8c921413f1ad217f45fecf63c0d22">NimBLEScan::setWindow</a></div><div class="ttdeci">void setWindow(uint16_t windowMSecs)</div><div class="ttdoc">Set the window to actively scan.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:265</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ac40563af803f3b9ab88398c7f30e21bb"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ac40563af803f3b9ab88398c7f30e21bb">NimBLEScan::setDuplicateFilter</a></div><div class="ttdeci">void setDuplicateFilter(bool 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:192</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 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_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:42</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a2bbead75105733d04796b69e10c56cd4"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4">NimBLEScanResults::dump</a></div><div class="ttdeci">void dump()</div><div class="ttdoc">Dump the scan results to the log.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:475</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a44e183a7ce0c9fb587d11910ce5ef200"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">NimBLEScanResults::end</a></div><div class="ttdeci">std::vector< NimBLEAdvertisedDevice * >::iterator end()</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_a68aa3ebffb1be785497f228c1d11e500"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">NimBLEScanResults::getDevice</a></div><div class="ttdeci">NimBLEAdvertisedDevice getDevice(uint32_t i)</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:498</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_ad426f221e8c18c0c3f5784786710e8f0"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">NimBLEScanResults::begin</a></div><div class="ttdeci">std::vector< NimBLEAdvertisedDevice * >::iterator begin()</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:507</div></div>
|
||
|
|
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_ae4796dd6ce1845c46f66bc1a36ad746a"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">NimBLEScanResults::getCount</a></div><div class="ttdeci">int getCount()</div><div class="ttdoc">Get the count of devices found in the last scan.</div><div class="ttdef"><b>Definition:</b> NimBLEScan.cpp:487</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>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.0 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|