Deploy h2zero/esp-nimble-cpp to github.com/h2zero/esp-nimble-cpp.git:gh-pages

This commit is contained in:
Deployment Bot (from Travis CI)
2021-08-05 01:02:30 +00:00
commit c51c0f2cf5
322 changed files with 43760 additions and 0 deletions

View File

@@ -0,0 +1,501 @@
<!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/HIDKeyboardTypes.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_h_i_d_keyboard_types_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">HIDKeyboardTypes.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (c) 2015 mbed.org, MIT License</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy of this software</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * and associated documentation files (the &quot;Software&quot;), to deal in the Software without</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * restriction, including without limitation the rights to use, copy, modify, merge, publish,</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all copies or</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * substantial portions of the Software.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * Note: this file was pulled from different parts of the USBHID library, in mbed SDK</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef KEYBOARD_DEFS_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define KEYBOARD_DEFS_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define REPORT_ID_KEYBOARD 1</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define REPORT_ID_VOLUME 3</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/* Modifiers */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">enum</span> MODIFIER_KEY {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; KEY_CTRL = 1,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; KEY_SHIFT = 2,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; KEY_ALT = 4,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;};</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">enum</span> MEDIA_KEY {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; KEY_NEXT_TRACK, </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; KEY_PREVIOUS_TRACK, </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; KEY_STOP, </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; KEY_PLAY_PAUSE, </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; KEY_MUTE, </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; KEY_VOLUME_UP, </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; KEY_VOLUME_DOWN, </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;};</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">enum</span> FUNCTION_KEY {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; KEY_F1 = 128, <span class="comment">/* F1 key */</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; KEY_F2, <span class="comment">/* F2 key */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; KEY_F3, <span class="comment">/* F3 key */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; KEY_F4, <span class="comment">/* F4 key */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; KEY_F5, <span class="comment">/* F5 key */</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; KEY_F6, <span class="comment">/* F6 key */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; KEY_F7, <span class="comment">/* F7 key */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; KEY_F8, <span class="comment">/* F8 key */</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; KEY_F9, <span class="comment">/* F9 key */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; KEY_F10, <span class="comment">/* F10 key */</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; KEY_F11, <span class="comment">/* F11 key */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; KEY_F12, <span class="comment">/* F12 key */</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; KEY_PRINT_SCREEN, <span class="comment">/* Print Screen key */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; KEY_SCROLL_LOCK, <span class="comment">/* Scroll lock */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; KEY_CAPS_LOCK, <span class="comment">/* caps lock */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; KEY_NUM_LOCK, <span class="comment">/* num lock */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; KEY_INSERT, <span class="comment">/* Insert key */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; KEY_HOME, <span class="comment">/* Home key */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; KEY_PAGE_UP, <span class="comment">/* Page Up key */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; KEY_PAGE_DOWN, <span class="comment">/* Page Down key */</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; RIGHT_ARROW, <span class="comment">/* Right arrow */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; LEFT_ARROW, <span class="comment">/* Left arrow */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; DOWN_ARROW, <span class="comment">/* Down arrow */</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; UP_ARROW, <span class="comment">/* Up arrow */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;};</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> usage;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> modifier;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;} KEYMAP;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#ifdef US_KEYBOARD</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment">/* US keyboard (as HID standard) */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#define KEYMAP_SIZE (152)</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="keyword">const</span> KEYMAP keymap[KEYMAP_SIZE] = {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {0, 0}, <span class="comment">/* NUL */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; {0, 0}, <span class="comment">/* SOH */</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; {0, 0}, <span class="comment">/* STX */</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {0, 0}, <span class="comment">/* ETX */</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {0, 0}, <span class="comment">/* EOT */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {0, 0}, <span class="comment">/* ENQ */</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; {0, 0}, <span class="comment">/* ACK */</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; {0, 0}, <span class="comment">/* BEL */</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; {0x2a, 0}, <span class="comment">/* BS */</span> <span class="comment">/* Keyboard Delete (Backspace) */</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {0x2b, 0}, <span class="comment">/* TAB */</span> <span class="comment">/* Keyboard Tab */</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {0x28, 0}, <span class="comment">/* LF */</span> <span class="comment">/* Keyboard Return (Enter) */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; {0, 0}, <span class="comment">/* VT */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; {0, 0}, <span class="comment">/* FF */</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; {0, 0}, <span class="comment">/* CR */</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; {0, 0}, <span class="comment">/* SO */</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; {0, 0}, <span class="comment">/* SI */</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {0, 0}, <span class="comment">/* DEL */</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; {0, 0}, <span class="comment">/* DC1 */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {0, 0}, <span class="comment">/* DC2 */</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; {0, 0}, <span class="comment">/* DC3 */</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; {0, 0}, <span class="comment">/* DC4 */</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {0, 0}, <span class="comment">/* NAK */</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; {0, 0}, <span class="comment">/* SYN */</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {0, 0}, <span class="comment">/* ETB */</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {0, 0}, <span class="comment">/* CAN */</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {0, 0}, <span class="comment">/* EM */</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {0, 0}, <span class="comment">/* SUB */</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; {0, 0}, <span class="comment">/* ESC */</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; {0, 0}, <span class="comment">/* FS */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; {0, 0}, <span class="comment">/* GS */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; {0, 0}, <span class="comment">/* RS */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; {0, 0}, <span class="comment">/* US */</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; {0x2c, 0}, <span class="comment">/* */</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; {0x1e, KEY_SHIFT}, <span class="comment">/* ! */</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; {0x34, KEY_SHIFT}, <span class="comment">/* &quot; */</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; {0x20, KEY_SHIFT}, <span class="comment">/* # */</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; {0x21, KEY_SHIFT}, <span class="comment">/* $ */</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; {0x22, KEY_SHIFT}, <span class="comment">/* % */</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; {0x24, KEY_SHIFT}, <span class="comment">/* &amp; */</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; {0x34, 0}, <span class="comment">/* &#39; */</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; {0x26, KEY_SHIFT}, <span class="comment">/* ( */</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; {0x27, KEY_SHIFT}, <span class="comment">/* ) */</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; {0x25, KEY_SHIFT}, <span class="comment">/* * */</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; {0x2e, KEY_SHIFT}, <span class="comment">/* + */</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; {0x36, 0}, <span class="comment">/* , */</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; {0x2d, 0}, <span class="comment">/* - */</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; {0x37, 0}, <span class="comment">/* . */</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; {0x38, 0}, <span class="comment">/* / */</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; {0x27, 0}, <span class="comment">/* 0 */</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; {0x1e, 0}, <span class="comment">/* 1 */</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; {0x1f, 0}, <span class="comment">/* 2 */</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; {0x20, 0}, <span class="comment">/* 3 */</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; {0x21, 0}, <span class="comment">/* 4 */</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; {0x22, 0}, <span class="comment">/* 5 */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; {0x23, 0}, <span class="comment">/* 6 */</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; {0x24, 0}, <span class="comment">/* 7 */</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; {0x25, 0}, <span class="comment">/* 8 */</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; {0x26, 0}, <span class="comment">/* 9 */</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; {0x33, KEY_SHIFT}, <span class="comment">/* : */</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; {0x33, 0}, <span class="comment">/* ; */</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; {0x36, KEY_SHIFT}, <span class="comment">/* &lt; */</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; {0x2e, 0}, <span class="comment">/* = */</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; {0x37, KEY_SHIFT}, <span class="comment">/* &gt; */</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; {0x38, KEY_SHIFT}, <span class="comment">/* ? */</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; {0x1f, KEY_SHIFT}, <span class="comment">/* @ */</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; {0x04, KEY_SHIFT}, <span class="comment">/* A */</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; {0x05, KEY_SHIFT}, <span class="comment">/* B */</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; {0x06, KEY_SHIFT}, <span class="comment">/* C */</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; {0x07, KEY_SHIFT}, <span class="comment">/* D */</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; {0x08, KEY_SHIFT}, <span class="comment">/* E */</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; {0x09, KEY_SHIFT}, <span class="comment">/* F */</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; {0x0a, KEY_SHIFT}, <span class="comment">/* G */</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; {0x0b, KEY_SHIFT}, <span class="comment">/* H */</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; {0x0c, KEY_SHIFT}, <span class="comment">/* I */</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; {0x0d, KEY_SHIFT}, <span class="comment">/* J */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; {0x0e, KEY_SHIFT}, <span class="comment">/* K */</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; {0x0f, KEY_SHIFT}, <span class="comment">/* L */</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; {0x10, KEY_SHIFT}, <span class="comment">/* M */</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; {0x11, KEY_SHIFT}, <span class="comment">/* N */</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; {0x12, KEY_SHIFT}, <span class="comment">/* O */</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; {0x13, KEY_SHIFT}, <span class="comment">/* P */</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; {0x14, KEY_SHIFT}, <span class="comment">/* Q */</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; {0x15, KEY_SHIFT}, <span class="comment">/* R */</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; {0x16, KEY_SHIFT}, <span class="comment">/* S */</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; {0x17, KEY_SHIFT}, <span class="comment">/* T */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; {0x18, KEY_SHIFT}, <span class="comment">/* U */</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; {0x19, KEY_SHIFT}, <span class="comment">/* V */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; {0x1a, KEY_SHIFT}, <span class="comment">/* W */</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; {0x1b, KEY_SHIFT}, <span class="comment">/* X */</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; {0x1c, KEY_SHIFT}, <span class="comment">/* Y */</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; {0x1d, KEY_SHIFT}, <span class="comment">/* Z */</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; {0x2f, 0}, <span class="comment">/* [ */</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; {0x31, 0}, <span class="comment">/* \ */</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; {0x30, 0}, <span class="comment">/* ] */</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; {0x23, KEY_SHIFT}, <span class="comment">/* ^ */</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; {0x2d, KEY_SHIFT}, <span class="comment">/* _ */</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; {0x35, 0}, <span class="comment">/* ` */</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; {0x04, 0}, <span class="comment">/* a */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; {0x05, 0}, <span class="comment">/* b */</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; {0x06, 0}, <span class="comment">/* c */</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; {0x07, 0}, <span class="comment">/* d */</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; {0x08, 0}, <span class="comment">/* e */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; {0x09, 0}, <span class="comment">/* f */</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; {0x0a, 0}, <span class="comment">/* g */</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; {0x0b, 0}, <span class="comment">/* h */</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; {0x0c, 0}, <span class="comment">/* i */</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; {0x0d, 0}, <span class="comment">/* j */</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; {0x0e, 0}, <span class="comment">/* k */</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; {0x0f, 0}, <span class="comment">/* l */</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; {0x10, 0}, <span class="comment">/* m */</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; {0x11, 0}, <span class="comment">/* n */</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; {0x12, 0}, <span class="comment">/* o */</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; {0x13, 0}, <span class="comment">/* p */</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; {0x14, 0}, <span class="comment">/* q */</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; {0x15, 0}, <span class="comment">/* r */</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; {0x16, 0}, <span class="comment">/* s */</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; {0x17, 0}, <span class="comment">/* t */</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; {0x18, 0}, <span class="comment">/* u */</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; {0x19, 0}, <span class="comment">/* v */</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; {0x1a, 0}, <span class="comment">/* w */</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; {0x1b, 0}, <span class="comment">/* x */</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; {0x1c, 0}, <span class="comment">/* y */</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; {0x1d, 0}, <span class="comment">/* z */</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; {0x2f, KEY_SHIFT}, <span class="comment">/* { */</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; {0x31, KEY_SHIFT}, <span class="comment">/* | */</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; {0x30, KEY_SHIFT}, <span class="comment">/* } */</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; {0x35, KEY_SHIFT}, <span class="comment">/* ~ */</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; {0,0}, <span class="comment">/* DEL */</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; </div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; {0x3a, 0}, <span class="comment">/* F1 */</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; {0x3b, 0}, <span class="comment">/* F2 */</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; {0x3c, 0}, <span class="comment">/* F3 */</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; {0x3d, 0}, <span class="comment">/* F4 */</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; {0x3e, 0}, <span class="comment">/* F5 */</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; {0x3f, 0}, <span class="comment">/* F6 */</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; {0x40, 0}, <span class="comment">/* F7 */</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; {0x41, 0}, <span class="comment">/* F8 */</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; {0x42, 0}, <span class="comment">/* F9 */</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; {0x43, 0}, <span class="comment">/* F10 */</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; {0x44, 0}, <span class="comment">/* F11 */</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; {0x45, 0}, <span class="comment">/* F12 */</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; </div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; {0x46, 0}, <span class="comment">/* PRINT_SCREEN */</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; {0x47, 0}, <span class="comment">/* SCROLL_LOCK */</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; {0x39, 0}, <span class="comment">/* CAPS_LOCK */</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; {0x53, 0}, <span class="comment">/* NUM_LOCK */</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; {0x49, 0}, <span class="comment">/* INSERT */</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; {0x4a, 0}, <span class="comment">/* HOME */</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; {0x4b, 0}, <span class="comment">/* PAGE_UP */</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; {0x4e, 0}, <span class="comment">/* PAGE_DOWN */</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; {0x4f, 0}, <span class="comment">/* RIGHT_ARROW */</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; {0x50, 0}, <span class="comment">/* LEFT_ARROW */</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; {0x51, 0}, <span class="comment">/* DOWN_ARROW */</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; {0x52, 0}, <span class="comment">/* UP_ARROW */</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;};</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; </div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;<span class="comment">/* UK keyboard */</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;<span class="preprocessor">#define KEYMAP_SIZE (152)</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="keyword">const</span> KEYMAP keymap[KEYMAP_SIZE] = {</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; {0, 0}, <span class="comment">/* NUL */</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; {0, 0}, <span class="comment">/* SOH */</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; {0, 0}, <span class="comment">/* STX */</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; {0, 0}, <span class="comment">/* ETX */</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; {0, 0}, <span class="comment">/* EOT */</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; {0, 0}, <span class="comment">/* ENQ */</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; {0, 0}, <span class="comment">/* ACK */</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; {0, 0}, <span class="comment">/* BEL */</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; {0x2a, 0}, <span class="comment">/* BS */</span> <span class="comment">/* Keyboard Delete (Backspace) */</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; {0x2b, 0}, <span class="comment">/* TAB */</span> <span class="comment">/* Keyboard Tab */</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; {0x28, 0}, <span class="comment">/* LF */</span> <span class="comment">/* Keyboard Return (Enter) */</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; {0, 0}, <span class="comment">/* VT */</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; {0, 0}, <span class="comment">/* FF */</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; {0, 0}, <span class="comment">/* CR */</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; {0, 0}, <span class="comment">/* SO */</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; {0, 0}, <span class="comment">/* SI */</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; {0, 0}, <span class="comment">/* DEL */</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160; {0, 0}, <span class="comment">/* DC1 */</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; {0, 0}, <span class="comment">/* DC2 */</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; {0, 0}, <span class="comment">/* DC3 */</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; {0, 0}, <span class="comment">/* DC4 */</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160; {0, 0}, <span class="comment">/* NAK */</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160; {0, 0}, <span class="comment">/* SYN */</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; {0, 0}, <span class="comment">/* ETB */</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160; {0, 0}, <span class="comment">/* CAN */</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; {0, 0}, <span class="comment">/* EM */</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; {0, 0}, <span class="comment">/* SUB */</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; {0, 0}, <span class="comment">/* ESC */</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; {0, 0}, <span class="comment">/* FS */</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160; {0, 0}, <span class="comment">/* GS */</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160; {0, 0}, <span class="comment">/* RS */</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; {0, 0}, <span class="comment">/* US */</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; {0x2c, 0}, <span class="comment">/* */</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160; {0x1e, KEY_SHIFT}, <span class="comment">/* ! */</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160; {0x1f, KEY_SHIFT}, <span class="comment">/* &quot; */</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; {0x32, 0}, <span class="comment">/* # */</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; {0x21, KEY_SHIFT}, <span class="comment">/* $ */</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; {0x22, KEY_SHIFT}, <span class="comment">/* % */</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; {0x24, KEY_SHIFT}, <span class="comment">/* &amp; */</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; {0x34, 0}, <span class="comment">/* &#39; */</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; {0x26, KEY_SHIFT}, <span class="comment">/* ( */</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; {0x27, KEY_SHIFT}, <span class="comment">/* ) */</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; {0x25, KEY_SHIFT}, <span class="comment">/* * */</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; {0x2e, KEY_SHIFT}, <span class="comment">/* + */</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; {0x36, 0}, <span class="comment">/* , */</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; {0x2d, 0}, <span class="comment">/* - */</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; {0x37, 0}, <span class="comment">/* . */</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; {0x38, 0}, <span class="comment">/* / */</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; {0x27, 0}, <span class="comment">/* 0 */</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; {0x1e, 0}, <span class="comment">/* 1 */</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160; {0x1f, 0}, <span class="comment">/* 2 */</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; {0x20, 0}, <span class="comment">/* 3 */</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160; {0x21, 0}, <span class="comment">/* 4 */</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; {0x22, 0}, <span class="comment">/* 5 */</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; {0x23, 0}, <span class="comment">/* 6 */</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; {0x24, 0}, <span class="comment">/* 7 */</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; {0x25, 0}, <span class="comment">/* 8 */</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; {0x26, 0}, <span class="comment">/* 9 */</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; {0x33, KEY_SHIFT}, <span class="comment">/* : */</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; {0x33, 0}, <span class="comment">/* ; */</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160; {0x36, KEY_SHIFT}, <span class="comment">/* &lt; */</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; {0x2e, 0}, <span class="comment">/* = */</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160; {0x37, KEY_SHIFT}, <span class="comment">/* &gt; */</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160; {0x38, KEY_SHIFT}, <span class="comment">/* ? */</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; {0x34, KEY_SHIFT}, <span class="comment">/* @ */</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; {0x04, KEY_SHIFT}, <span class="comment">/* A */</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; {0x05, KEY_SHIFT}, <span class="comment">/* B */</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160; {0x06, KEY_SHIFT}, <span class="comment">/* C */</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; {0x07, KEY_SHIFT}, <span class="comment">/* D */</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; {0x08, KEY_SHIFT}, <span class="comment">/* E */</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; {0x09, KEY_SHIFT}, <span class="comment">/* F */</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; {0x0a, KEY_SHIFT}, <span class="comment">/* G */</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; {0x0b, KEY_SHIFT}, <span class="comment">/* H */</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; {0x0c, KEY_SHIFT}, <span class="comment">/* I */</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; {0x0d, KEY_SHIFT}, <span class="comment">/* J */</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; {0x0e, KEY_SHIFT}, <span class="comment">/* K */</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; {0x0f, KEY_SHIFT}, <span class="comment">/* L */</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; {0x10, KEY_SHIFT}, <span class="comment">/* M */</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; {0x11, KEY_SHIFT}, <span class="comment">/* N */</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; {0x12, KEY_SHIFT}, <span class="comment">/* O */</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; {0x13, KEY_SHIFT}, <span class="comment">/* P */</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; {0x14, KEY_SHIFT}, <span class="comment">/* Q */</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; {0x15, KEY_SHIFT}, <span class="comment">/* R */</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; {0x16, KEY_SHIFT}, <span class="comment">/* S */</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; {0x17, KEY_SHIFT}, <span class="comment">/* T */</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; {0x18, KEY_SHIFT}, <span class="comment">/* U */</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; {0x19, KEY_SHIFT}, <span class="comment">/* V */</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; {0x1a, KEY_SHIFT}, <span class="comment">/* W */</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; {0x1b, KEY_SHIFT}, <span class="comment">/* X */</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; {0x1c, KEY_SHIFT}, <span class="comment">/* Y */</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; {0x1d, KEY_SHIFT}, <span class="comment">/* Z */</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; {0x2f, 0}, <span class="comment">/* [ */</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; {0x64, 0}, <span class="comment">/* \ */</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160; {0x30, 0}, <span class="comment">/* ] */</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; {0x23, KEY_SHIFT}, <span class="comment">/* ^ */</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; {0x2d, KEY_SHIFT}, <span class="comment">/* _ */</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160; {0x35, 0}, <span class="comment">/* ` */</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; {0x04, 0}, <span class="comment">/* a */</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; {0x05, 0}, <span class="comment">/* b */</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; {0x06, 0}, <span class="comment">/* c */</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160; {0x07, 0}, <span class="comment">/* d */</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; {0x08, 0}, <span class="comment">/* e */</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160; {0x09, 0}, <span class="comment">/* f */</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; {0x0a, 0}, <span class="comment">/* g */</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; {0x0b, 0}, <span class="comment">/* h */</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; {0x0c, 0}, <span class="comment">/* i */</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; {0x0d, 0}, <span class="comment">/* j */</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; {0x0e, 0}, <span class="comment">/* k */</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160; {0x0f, 0}, <span class="comment">/* l */</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; {0x10, 0}, <span class="comment">/* m */</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160; {0x11, 0}, <span class="comment">/* n */</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; {0x12, 0}, <span class="comment">/* o */</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160; {0x13, 0}, <span class="comment">/* p */</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; {0x14, 0}, <span class="comment">/* q */</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160; {0x15, 0}, <span class="comment">/* r */</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; {0x16, 0}, <span class="comment">/* s */</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; {0x17, 0}, <span class="comment">/* t */</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; {0x18, 0}, <span class="comment">/* u */</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160; {0x19, 0}, <span class="comment">/* v */</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; {0x1a, 0}, <span class="comment">/* w */</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; {0x1b, 0}, <span class="comment">/* x */</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; {0x1c, 0}, <span class="comment">/* y */</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160; {0x1d, 0}, <span class="comment">/* z */</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; {0x2f, KEY_SHIFT}, <span class="comment">/* { */</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160; {0x64, KEY_SHIFT}, <span class="comment">/* | */</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160; {0x30, KEY_SHIFT}, <span class="comment">/* } */</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160; {0x32, KEY_SHIFT}, <span class="comment">/* ~ */</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; {0,0}, <span class="comment">/* DEL */</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160; </div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160; {0x3a, 0}, <span class="comment">/* F1 */</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160; {0x3b, 0}, <span class="comment">/* F2 */</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160; {0x3c, 0}, <span class="comment">/* F3 */</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160; {0x3d, 0}, <span class="comment">/* F4 */</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160; {0x3e, 0}, <span class="comment">/* F5 */</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; {0x3f, 0}, <span class="comment">/* F6 */</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160; {0x40, 0}, <span class="comment">/* F7 */</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; {0x41, 0}, <span class="comment">/* F8 */</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160; {0x42, 0}, <span class="comment">/* F9 */</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160; {0x43, 0}, <span class="comment">/* F10 */</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160; {0x44, 0}, <span class="comment">/* F11 */</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160; {0x45, 0}, <span class="comment">/* F12 */</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160; </div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160; {0x46, 0}, <span class="comment">/* PRINT_SCREEN */</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160; {0x47, 0}, <span class="comment">/* SCROLL_LOCK */</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160; {0x39, 0}, <span class="comment">/* CAPS_LOCK */</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160; {0x53, 0}, <span class="comment">/* NUM_LOCK */</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160; {0x49, 0}, <span class="comment">/* INSERT */</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; {0x4a, 0}, <span class="comment">/* HOME */</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; {0x4b, 0}, <span class="comment">/* PAGE_UP */</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; {0x4e, 0}, <span class="comment">/* PAGE_DOWN */</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160; </div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160; {0x4f, 0}, <span class="comment">/* RIGHT_ARROW */</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; {0x50, 0}, <span class="comment">/* LEFT_ARROW */</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160; {0x51, 0}, <span class="comment">/* DOWN_ARROW */</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160; {0x52, 0}, <span class="comment">/* UP_ARROW */</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;};</div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; </div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160;<span class="preprocessor">#endif</span></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>HIDKeyboardTypes.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>

195
_h_i_d_types_8h_source.html Normal file
View File

@@ -0,0 +1,195 @@
<!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/HIDTypes.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_h_i_d_types_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">HIDTypes.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (c) 2010-2011 mbed.org, MIT License</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">* Permission is hereby granted, free of charge, to any person obtaining a copy of this software</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">* and associated documentation files (the &quot;Software&quot;), to deal in the Software without</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">* restriction, including without limitation the rights to use, copy, modify, merge, publish,</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">* distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">* Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">* The above copyright notice and this permission notice shall be included in all copies or</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">* substantial portions of the Software.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">* THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">* BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef USBCLASS_HID_TYPES</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define USBCLASS_HID_TYPES</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/* */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define HID_VERSION_1_11 (0x0111)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/* HID Class */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define HID_CLASS (3)</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define HID_SUBCLASS_NONE (0)</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define HID_PROTOCOL_NONE (0)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">/* Descriptors */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define HID_DESCRIPTOR (33)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define HID_DESCRIPTOR_LENGTH (0x09)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define REPORT_DESCRIPTOR (34)</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">/* Class requests */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define GET_REPORT (0x1)</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define GET_IDLE (0x2)</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define SET_REPORT (0x9)</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define SET_IDLE (0xa)</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">/* HID Class Report Descriptor */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">/* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">/* of data as per HID Class standard */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">/* Main items */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#ifdef ARDUINO_ARCH_ESP32</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#define HIDINPUT(size) (0x80 | size)</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define HIDOUTPUT(size) (0x90 | size)</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#define INPUT(size) (0x80 | size)</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#define OUTPUT(size) (0x90 | size)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#define FEATURE(size) (0xb0 | size)</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#define COLLECTION(size) (0xa0 | size)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#define END_COLLECTION(size) (0xc0 | size)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment">/* Global items */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#define USAGE_PAGE(size) (0x04 | size)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#define LOGICAL_MINIMUM(size) (0x14 | size)</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#define LOGICAL_MAXIMUM(size) (0x24 | size)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#define PHYSICAL_MINIMUM(size) (0x34 | size)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#define PHYSICAL_MAXIMUM(size) (0x44 | size)</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#define UNIT_EXPONENT(size) (0x54 | size)</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#define UNIT(size) (0x64 | size)</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#define REPORT_SIZE(size) (0x74 | size) </span><span class="comment">//bits</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#define REPORT_ID(size) (0x84 | size)</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#define REPORT_COUNT(size) (0x94 | size) </span><span class="comment">//bytes</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#define PUSH(size) (0xa4 | size)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#define POP(size) (0xb4 | size)</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment">/* Local items */</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor">#define USAGE(size) (0x08 | size)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#define USAGE_MINIMUM(size) (0x18 | size)</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#define USAGE_MAXIMUM(size) (0x28 | size)</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor">#define DESIGNATOR_INDEX(size) (0x38 | size)</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#define DESIGNATOR_MINIMUM(size) (0x48 | size)</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#define DESIGNATOR_MAXIMUM(size) (0x58 | size)</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#define STRING_INDEX(size) (0x78 | size)</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#define STRING_MINIMUM(size) (0x88 | size)</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#define STRING_MAXIMUM(size) (0x98 | size)</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#define DELIMITER(size) (0xa8 | size)</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment">/* HID Report */</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment">/* Where report IDs are used the first byte of &#39;data&#39; will be the */</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment">/* report ID and &#39;length&#39; will include this report ID byte. */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#define MAX_HID_REPORT_SIZE (64)</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; uint32_t length;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint8_t data[MAX_HID_REPORT_SIZE];</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;} HID_REPORT;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="preprocessor">#endif</span></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>HIDTypes.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>

View File

@@ -0,0 +1,187 @@
<!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/NimBLE2904.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e2904_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">NimBLE2904.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLE2904.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 13, 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLE2904.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Dec 23, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLE2904_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLE2904_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEDescriptor.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">struct </span>BLE2904_Data {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; uint8_t m_format;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; int8_t m_exponent;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; uint16_t m_unit; <span class="comment">// See https://www.bluetooth.com/specifications/assigned-numbers/units</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; uint8_t m_namespace;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; uint16_t m_description;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;} __attribute__((packed));</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_nim_b_l_e2904.html"> 43</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e2904.html">NimBLE2904</a>: <span class="keyword">public</span> <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="class_nim_b_l_e2904.html">NimBLE2904</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacterisitic = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_BOOLEAN = 1;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT2 = 2;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT4 = 3;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT8 = 4;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT12 = 5;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT16 = 6;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT24 = 7;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT32 = 8;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT48 = 9;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT64 = 10;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT128 = 11;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT8 = 12;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT12 = 13;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT16 = 14;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT24 = 15;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT32 = 16;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT48 = 17;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT64 = 18;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT128 = 19;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_FLOAT32 = 20;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_FLOAT64 = 21;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SFLOAT16 = 22;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SFLOAT32 = 23;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_IEEE20601 = 24;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UTF8 = 25;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UTF16 = 26;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_OPAQUE = 27;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c">setDescription</a>(uint16_t);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d">setExponent</a>(int8_t exponent);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1">setFormat</a>(uint8_t format);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962">setNamespace</a>(uint8_t namespace_value);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">setUnit</a>(uint16_t unit);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; BLE2904_Data m_data;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;}; <span class="comment">// BLE2904</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLE2904_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html"><div class="ttname"><a href="class_nim_b_l_e2904.html">NimBLE2904</a></div><div class="ttdoc">Descriptor for Characteristic Presentation Format.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.h:43</div></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html_a2206274c217d43a8ba121e1d279f8962"><div class="ttname"><a href="class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962">NimBLE2904::setNamespace</a></div><div class="ttdeci">void setNamespace(uint8_t namespace_value)</div><div class="ttdoc">Set the namespace.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:73</div></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html_a498c863cb3fbf92eecc23f9f8856037c"><div class="ttname"><a href="class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c">NimBLE2904::setDescription</a></div><div class="ttdeci">void setDescription(uint16_t)</div><div class="ttdoc">Set the description.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:46</div></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html_ab1c53f99246f67dca1d63b812bef631d"><div class="ttname"><a href="class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d">NimBLE2904::setExponent</a></div><div class="ttdeci">void setExponent(int8_t exponent)</div><div class="ttdoc">Set the exponent.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:55</div></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html_ab7f21651b4493fd3daaa0f1545032ff1"><div class="ttname"><a href="class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1">NimBLE2904::setFormat</a></div><div class="ttdeci">void setFormat(uint8_t format)</div><div class="ttdoc">Set the format.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:64</div></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html_ad0cf78a2a1c3418be9a39beaa0c826ee"><div class="ttname"><a href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">NimBLE2904::setUnit</a></div><div class="ttdeci">void setUnit(uint16_t unit)</div><div class="ttdoc">Set the units for this value. It should be one of the encoded values defined here: https://www....</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:84</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></div><div class="ttdoc">A model of a BLE descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.h:44</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>NimBLE2904.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>

View File

@@ -0,0 +1,159 @@
<!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/NimBLEAddress.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_address_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">NimBLEAddress.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEAddress.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 24 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEAddress.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jul 2, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEADDRESS_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEADDRESS_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;nimble/ble.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_address.html"> 34</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a>(ble_addr_t address);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a>(uint8_t address[6], uint8_t type = BLE_ADDR_PUBLIC);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a>(<span class="keyword">const</span> std::string &amp;stringAddress, uint8_t type = BLE_ADDR_PUBLIC);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a>(<span class="keyword">const</span> uint64_t &amp;address, uint8_t type = BLE_ADDR_PUBLIC);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">equals</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;otherAddress) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> uint8_t* <a class="code" href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">getNative</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; std::string <a class="code" href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">getType</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164">operator ==</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp; rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce">operator !=</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp; rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">operator</span> std::string() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">operator</span> uint64_t() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uint8_t m_address[6];</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint8_t m_addrType;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLEADDRESS_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_address_html_a18f8361ed20146cbc374a246d87015eb"><div class="ttname"><a href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">NimBLEAddress::getType</a></div><div class="ttdeci">uint8_t getType() const</div><div class="ttdoc">Get the address type.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:136</div></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html_a19058addb94417e2921cade37a79d04c"><div class="ttname"><a href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress::NimBLEAddress</a></div><div class="ttdeci">NimBLEAddress()</div><div class="ttdoc">Create a blank address, i.e. 00:00:00:00:00:00, type 0.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:43</div></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html_a826fe8850cbc7d54f0696b8af4637169"><div class="ttname"><a href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">NimBLEAddress::equals</a></div><div class="ttdeci">bool equals(const NimBLEAddress &amp;otherAddress) const</div><div class="ttdoc">Determine if this address equals another.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:118</div></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html_a87e8ccc81c2d83bf0503166939319164"><div class="ttname"><a href="class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164">NimBLEAddress::operator==</a></div><div class="ttdeci">bool operator==(const NimBLEAddress &amp;rhs) const</div><div class="ttdoc">Convienience operator to check if this address is equal to another.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:161</div></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html_ac53b0cc945e1505d3e72d48164ad01d6"><div class="ttname"><a href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">NimBLEAddress::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Convert a BLE address to a string.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:153</div></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html_adef69a03a08303957d7e40eef07b4d80"><div class="ttname"><a href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">NimBLEAddress::getNative</a></div><div class="ttdeci">const uint8_t * getNative() const</div><div class="ttdoc">Get the native representation of the address.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:127</div></div>
<div class="ttc" id="aclass_nim_b_l_e_address_html_ae243127c78af69b26dfa225effd806ce"><div class="ttname"><a href="class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce">NimBLEAddress::operator!=</a></div><div class="ttdeci">bool operator!=(const NimBLEAddress &amp;rhs) const</div><div class="ttdoc">Convienience operator to check if this address is not equal to another.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.cpp:169</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>NimBLEAddress.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>

View File

@@ -0,0 +1,278 @@
<!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/NimBLEAdvertisedDevice.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_advertised_device_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">NimBLEAdvertisedDevice.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEAdvertisedDevice.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 24 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEAdvertisedDevice.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jul 3, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEADVERTISEDDEVICE_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEADVERTISEDDEVICE_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEAddress.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLEScan.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;host/ble_hs_adv.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertised_device.html"> 40</a></span>&#160;<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="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="class_nim_b_l_e_advertised_device.html#ab8972714ecd578fca51fb63d9834a34e">NimBLEAdvertisedDevice</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_advertised_device.html#aa60721a7b5b44a3bb66980f003517579">getAddress</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_advertised_device.html#a9d07ee4c38de4170db24a5e01663ee6d">getAdvType</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_advertised_device.html#a228afa5e43421b4d96d9c08241718309">getAppearance</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_advertised_device.html#a9a7a36e9937e16ffab4f1543ea54073f">getAdvInterval</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_advertised_device.html#a33fcdc3bf5107c157b10ad4519938c9f">getMinInterval</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_advertised_device.html#a450eca96c605f199d2786a044612db17">getMaxInterval</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2">getManufacturerData</a>();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertised_device.html#ad65f8040a142f8d6d0763d4876f0d22e">getURI</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295"> 62</a></span>&#160; T <a class="code" href="class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295">getManufacturerData</a>(<span class="keywordtype">bool</span> skipSizeCheck = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; std::string data = <a class="code" href="class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2">getManufacturerData</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; data.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = data.data();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertised_device.html#ae6c6b48369d71a5998c1393c0d6a0179">getName</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#acd42dfbc92a43fc90e933df975c029f3">getRSSI</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>* <a class="code" href="class_nim_b_l_e_advertised_device.html#ad3931c72aaded3b594896c29b3691562">getScan</a>();</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a5fc9be9de9209622259f8d28b01825df">getServiceDataCount</a>();</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">getServiceData</a>(uint8_t index = 0);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">getServiceData</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70"> 86</a></span>&#160; T <a class="code" href="class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70">getServiceData</a>(uint8_t index = 0, <span class="keywordtype">bool</span> skipSizeCheck = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; std::string data = <a class="code" href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">getServiceData</a>(index);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; data.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = data.data();</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009"> 103</a></span>&#160; T <a class="code" href="class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009">getServiceData</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, <span class="keywordtype">bool</span> skipSizeCheck = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; std::string data = <a class="code" href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">getServiceData</a>(uuid);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; data.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = data.data();</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_advertised_device.html#a4f89e99dffdfde45c1cafff74a20a95f">getServiceDataUUID</a>(uint8_t index = 0);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_advertised_device.html#ab53f862df15953d19ba7a45d4cf51b46">getServiceUUID</a>(uint8_t index = 0);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a6dc4484bc89ea5560a51c349b5300049">getServiceUUIDCount</a>();</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_advertised_device.html#a599cad9a3f3d535049c87a911bc1b14d">getTargetAddress</a>(uint8_t index = 0);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a9352a7760d9e4af0561d7923fcbe2535">getTargetAddressCount</a>();</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; int8_t <a class="code" href="class_nim_b_l_e_advertised_device.html#afee346437447173eed1b9edf1de70f34">getTXPower</a>();</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; uint8_t* <a class="code" href="class_nim_b_l_e_advertised_device.html#afacf7717a15b36af184cd957d397e384">getPayload</a>();</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_advertised_device.html#ae960e43434bf62ec83e9230d7bf7046c">getAdvLength</a>();</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#ac7879f4aa0f2b069b1d3aff4809ae62c">getPayloadLength</a>();</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_advertised_device.html#afc79cdc087c81b34643d70c8259eb9a3">getAddressType</a>();</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; time_t <a class="code" href="class_nim_b_l_e_advertised_device.html#a1855415f3c60bc88d62e9206fe6ed75a">getTimestamp</a>();</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a37ad095c066aa231a52a7259734c9bce">isAdvertisingService</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#accc6713f85db6174cfe8436059aa8bf1">haveAppearance</a>();</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#abe58f5fde119d8c0a8fb85ba1e8cc5c9">haveManufacturerData</a>();</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a86805fecd4432335feecf77bb6a0f12e">haveName</a>();</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a611802e8898e422842d60486b60b8c42">haveRSSI</a>();</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#afba3425cfcfc12eca219a1abe5f6732c">haveServiceData</a>();</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a5c4aae7e27c27201846ba4e15448e557">haveServiceUUID</a>();</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#af5293030ef439856c195caa3aba86543">haveTXPower</a>();</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a3274624943c942f357c6f8d489481bc8">haveConnParams</a>();</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#aa8b4660e5d123f16a07e0fefa3bcf4bc">haveAdvInterval</a>();</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a1172d33a77bc018e314be78664b222b9">haveTargetAddress</a>();</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertised_device.html#a83ebd08b512dc936b1059db7a69b9ead">haveURI</a>();</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertised_device.html#ac1b8ff0f2897abda335743d55668fcd9">toString</a>();</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keyword">friend</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="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordtype">void</span> setAddress(<a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> address);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">void</span> setAdvType(uint8_t advType);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">void</span> setPayload(<span class="keyword">const</span> uint8_t *payload, uint8_t length, <span class="keywordtype">bool</span> append);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordtype">void</span> setRSSI(<span class="keywordtype">int</span> rssi);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; uint8_t findAdvField(uint8_t type, uint8_t index = 0, uint8_t *data_loc = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; uint8_t findServiceData(uint8_t index, uint8_t* bytes);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> m_address = <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>(<span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; uint8_t m_advType;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordtype">int</span> m_rssi;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; time_t m_timestamp;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keywordtype">bool</span> m_callbackSent;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; uint8_t m_advLength;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; std::vector&lt;uint8_t&gt; m_payload;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;};</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; </div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertised_device_callbacks.html"> 162</a></span>&#160;<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="l00163"></a><span class="lineno"> 163</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a>() {}</div>
<div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606"> 171</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606">onResult</a>(<a class="code" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* advertisedDevice) = 0;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;};</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLEADVERTISEDDEVICE_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_callbacks_html_af6a25e1bb773a147536b1785b2aae606"><div class="ttname"><a href="class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606">NimBLEAdvertisedDeviceCallbacks::onResult</a></div><div class="ttdeci">virtual void onResult(NimBLEAdvertisedDevice *advertisedDevice)=0</div><div class="ttdoc">Called when a new scan result is detected.</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_advertised_device_html_a1172d33a77bc018e314be78664b222b9"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a1172d33a77bc018e314be78664b222b9">NimBLEAdvertisedDevice::haveTargetAddress</a></div><div class="ttdeci">bool haveTargetAddress()</div><div class="ttdoc">Does the advertisement contain a target address?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:534</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a1855415f3c60bc88d62e9206fe6ed75a"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a1855415f3c60bc88d62e9206fe6ed75a">NimBLEAdvertisedDevice::getTimestamp</a></div><div class="ttdeci">time_t getTimestamp()</div><div class="ttdoc">Get the timeStamp of when the device last advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:773</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a228afa5e43421b4d96d9c08241718309"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a228afa5e43421b4d96d9c08241718309">NimBLEAdvertisedDevice::getAppearance</a></div><div class="ttdeci">uint16_t getAppearance()</div><div class="ttdoc">Get the appearance.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:73</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a3274624943c942f357c6f8d489481bc8"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a3274624943c942f357c6f8d489481bc8">NimBLEAdvertisedDevice::haveConnParams</a></div><div class="ttdeci">bool haveConnParams()</div><div class="ttdoc">Does this advertisement have preferred connection parameters?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:489</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a33fcdc3bf5107c157b10ad4519938c9f"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a33fcdc3bf5107c157b10ad4519938c9f">NimBLEAdvertisedDevice::getMinInterval</a></div><div class="ttdeci">uint16_t getMinInterval()</div><div class="ttdoc">Get the preferred min connection interval.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:109</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a37ad095c066aa231a52a7259734c9bce"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a37ad095c066aa231a52a7259734c9bce">NimBLEAdvertisedDevice::isAdvertisingService</a></div><div class="ttdeci">bool isAdvertisingService(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Check advertised services for existance of the required UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:455</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a450eca96c605f199d2786a044612db17"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a450eca96c605f199d2786a044612db17">NimBLEAdvertisedDevice::getMaxInterval</a></div><div class="ttdeci">uint16_t getMaxInterval()</div><div class="ttdoc">Get the preferred max connection interval.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:127</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a4f89e99dffdfde45c1cafff74a20a95f"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a4f89e99dffdfde45c1cafff74a20a95f">NimBLEAdvertisedDevice::getServiceDataUUID</a></div><div class="ttdeci">NimBLEUUID getServiceDataUUID(uint8_t index=0)</div><div class="ttdoc">Get the UUID of the serice data at the index.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:315</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a599cad9a3f3d535049c87a911bc1b14d"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a599cad9a3f3d535049c87a911bc1b14d">NimBLEAdvertisedDevice::getTargetAddress</a></div><div class="ttdeci">NimBLEAddress getTargetAddress(uint8_t index=0)</div><div class="ttdoc">Get the target address at the index.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:234</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a5c4aae7e27c27201846ba4e15448e557"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a5c4aae7e27c27201846ba4e15448e557">NimBLEAdvertisedDevice::haveServiceUUID</a></div><div class="ttdeci">bool haveServiceUUID()</div><div class="ttdoc">Does this advertisement have a service UUID value?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:572</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a5fc9be9de9209622259f8d28b01825df"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a5fc9be9de9209622259f8d28b01825df">NimBLEAdvertisedDevice::getServiceDataCount</a></div><div class="ttdeci">size_t getServiceDataCount()</div><div class="ttdoc">Get the count of advertised service data UUIDS.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:371</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a611802e8898e422842d60486b60b8c42"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a611802e8898e422842d60486b60b8c42">NimBLEAdvertisedDevice::haveRSSI</a></div><div class="ttdeci">bool haveRSSI()</div><div class="ttdoc">Does this advertisement have a signal strength value?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:554</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a6dc4484bc89ea5560a51c349b5300049"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a6dc4484bc89ea5560a51c349b5300049">NimBLEAdvertisedDevice::getServiceUUIDCount</a></div><div class="ttdeci">size_t getServiceUUIDCount()</div><div class="ttdoc">Get the number of services advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:436</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a83ebd08b512dc936b1059db7a69b9ead"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a83ebd08b512dc936b1059db7a69b9ead">NimBLEAdvertisedDevice::haveURI</a></div><div class="ttdeci">bool haveURI()</div><div class="ttdoc">Does this advertisement have a URI?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:525</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a86805fecd4432335feecf77bb6a0f12e"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a86805fecd4432335feecf77bb6a0f12e">NimBLEAdvertisedDevice::haveName</a></div><div class="ttdeci">bool haveName()</div><div class="ttdoc">Does this advertisement have a name value?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:544</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a9017ce5b59bdae3cebf33c54f28cee70"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70">NimBLEAdvertisedDevice::getServiceData</a></div><div class="ttdeci">T getServiceData(uint8_t index=0, bool skipSizeCheck=false)</div><div class="ttdoc">A template to convert the service data to &lt;type&gt;.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.h:86</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a9352a7760d9e4af0561d7923fcbe2535"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a9352a7760d9e4af0561d7923fcbe2535">NimBLEAdvertisedDevice::getTargetAddressCount</a></div><div class="ttdeci">size_t getTargetAddressCount()</div><div class="ttdoc">Get the number of target addresses.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:219</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a9a7a36e9937e16ffab4f1543ea54073f"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a9a7a36e9937e16ffab4f1543ea54073f">NimBLEAdvertisedDevice::getAdvInterval</a></div><div class="ttdeci">uint16_t getAdvInterval()</div><div class="ttdoc">Get the advertisement interval.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:91</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a9ca1c022e10764ec72850ff3a011b009"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009">NimBLEAdvertisedDevice::getServiceData</a></div><div class="ttdeci">T getServiceData(const NimBLEUUID &amp;uuid, bool skipSizeCheck=false)</div><div class="ttdoc">A template to convert the service data to &lt;type&gt;.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.h:103</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_a9d07ee4c38de4170db24a5e01663ee6d"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#a9d07ee4c38de4170db24a5e01663ee6d">NimBLEAdvertisedDevice::getAdvType</a></div><div class="ttdeci">uint8_t getAdvType()</div><div class="ttdoc">Get the advertisement type.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_aa60721a7b5b44a3bb66980f003517579"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#aa60721a7b5b44a3bb66980f003517579">NimBLEAdvertisedDevice::getAddress</a></div><div class="ttdeci">NimBLEAddress getAddress()</div><div class="ttdoc">Get the address of the advertising device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:46</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_aa8b4660e5d123f16a07e0fefa3bcf4bc"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#aa8b4660e5d123f16a07e0fefa3bcf4bc">NimBLEAdvertisedDevice::haveAdvInterval</a></div><div class="ttdeci">bool haveAdvInterval()</div><div class="ttdoc">Does this advertisement have have the advertising interval?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:498</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ab53f862df15953d19ba7a45d4cf51b46"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ab53f862df15953d19ba7a45d4cf51b46">NimBLEAdvertisedDevice::getServiceUUID</a></div><div class="ttdeci">NimBLEUUID getServiceUUID(uint8_t index=0)</div><div class="ttdoc">Get the Service UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:387</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ab8972714ecd578fca51fb63d9834a34e"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ab8972714ecd578fca51fb63d9834a34e">NimBLEAdvertisedDevice::NimBLEAdvertisedDevice</a></div><div class="ttdeci">NimBLEAdvertisedDevice()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:31</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_abe58f5fde119d8c0a8fb85ba1e8cc5c9"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#abe58f5fde119d8c0a8fb85ba1e8cc5c9">NimBLEAdvertisedDevice::haveManufacturerData</a></div><div class="ttdeci">bool haveManufacturerData()</div><div class="ttdoc">Does this advertisement have manufacturer data?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:516</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ac1b8ff0f2897abda335743d55668fcd9"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ac1b8ff0f2897abda335743d55668fcd9">NimBLEAdvertisedDevice::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Create a string representation of this device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:680</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ac7879f4aa0f2b069b1d3aff4809ae62c"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ac7879f4aa0f2b069b1d3aff4809ae62c">NimBLEAdvertisedDevice::getPayloadLength</a></div><div class="ttdeci">size_t getPayloadLength()</div><div class="ttdoc">Get the length of the payload advertised by the device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:782</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_accc6713f85db6174cfe8436059aa8bf1"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#accc6713f85db6174cfe8436059aa8bf1">NimBLEAdvertisedDevice::haveAppearance</a></div><div class="ttdeci">bool haveAppearance()</div><div class="ttdoc">Does this advertisement have an appearance value?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:507</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_acd42dfbc92a43fc90e933df975c029f3"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#acd42dfbc92a43fc90e933df975c029f3">NimBLEAdvertisedDevice::getRSSI</a></div><div class="ttdeci">int getRSSI()</div><div class="ttdoc">Get the RSSI.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:201</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ad3931c72aaded3b594896c29b3691562"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ad3931c72aaded3b594896c29b3691562">NimBLEAdvertisedDevice::getScan</a></div><div class="ttdeci">NimBLEScan * getScan()</div><div class="ttdoc">Get the scan object that created this advertised device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:210</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ad65f8040a142f8d6d0763d4876f0d22e"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ad65f8040a142f8d6d0763d4876f0d22e">NimBLEAdvertisedDevice::getURI</a></div><div class="ttdeci">std::string getURI()</div><div class="ttdoc">Get the URI from the advertisement.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:163</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ae6c6b48369d71a5998c1393c0d6a0179"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ae6c6b48369d71a5998c1393c0d6a0179">NimBLEAdvertisedDevice::getName</a></div><div class="ttdeci">std::string getName()</div><div class="ttdoc">Get the advertised name.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:181</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ae960e43434bf62ec83e9230d7bf7046c"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ae960e43434bf62ec83e9230d7bf7046c">NimBLEAdvertisedDevice::getAdvLength</a></div><div class="ttdeci">uint8_t getAdvLength()</div><div class="ttdoc">Get the length of the advertisement data in the payload.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:751</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_ae9a586e46a555cf5fc817c9fe301b295"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295">NimBLEAdvertisedDevice::getManufacturerData</a></div><div class="ttdeci">T getManufacturerData(bool skipSizeCheck=false)</div><div class="ttdoc">A template to convert the service data to &lt;type&gt;.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.h:62</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_aecb3e30a94abd59401cafb70a5903abb"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">NimBLEAdvertisedDevice::getServiceData</a></div><div class="ttdeci">std::string getServiceData(uint8_t index=0)</div><div class="ttdoc">Get the service data.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:266</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_af5293030ef439856c195caa3aba86543"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#af5293030ef439856c195caa3aba86543">NimBLEAdvertisedDevice::haveTXPower</a></div><div class="ttdeci">bool haveTXPower()</div><div class="ttdoc">Does this advertisement have a transmission power value?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:581</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_afa334006230601cc5c6429b18819a2e2"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2">NimBLEAdvertisedDevice::getManufacturerData</a></div><div class="ttdeci">std::string getManufacturerData()</div><div class="ttdoc">Get the manufacturer data.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:145</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_afacf7717a15b36af184cd957d397e384"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#afacf7717a15b36af184cd957d397e384">NimBLEAdvertisedDevice::getPayload</a></div><div class="ttdeci">uint8_t * getPayload()</div><div class="ttdoc">Get the payload advertised by the device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:726</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_afba3425cfcfc12eca219a1abe5f6732c"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#afba3425cfcfc12eca219a1abe5f6732c">NimBLEAdvertisedDevice::haveServiceData</a></div><div class="ttdeci">bool haveServiceData()</div><div class="ttdoc">Does this advertisement have a service data value?</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:563</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_afc79cdc087c81b34643d70c8259eb9a3"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#afc79cdc087c81b34643d70c8259eb9a3">NimBLEAdvertisedDevice::getAddressType</a></div><div class="ttdeci">uint8_t getAddressType()</div><div class="ttdoc">Get the advertised device address type.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:764</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html_afee346437447173eed1b9edf1de70f34"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html#afee346437447173eed1b9edf1de70f34">NimBLEAdvertisedDevice::getTXPower</a></div><div class="ttdeci">int8_t getTXPower()</div><div class="ttdoc">Get the TX Power.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertisedDevice.cpp:471</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_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:31</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>NimBLEAdvertisedDevice.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>

View File

@@ -0,0 +1,273 @@
<!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/NimBLEAdvertising.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_advertising_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">NimBLEAdvertising.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEAdvertising.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 3, 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEAdvertising.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jun 21, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_BLEADVERTISING_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_BLEADVERTISING_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;host/ble_gap.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">/* COMPATIBILITY - DO NOT USE */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define ESP_BLE_ADV_FLAG_LIMIT_DISC (0x01 &lt;&lt; 0)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define ESP_BLE_ADV_FLAG_GEN_DISC (0x01 &lt;&lt; 1)</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define ESP_BLE_ADV_FLAG_BREDR_NOT_SPT (0x01 &lt;&lt; 2)</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define ESP_BLE_ADV_FLAG_DMT_CONTROLLER_SPT (0x01 &lt;&lt; 3)</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define ESP_BLE_ADV_FLAG_DMT_HOST_SPT (0x01 &lt;&lt; 4)</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define ESP_BLE_ADV_FLAG_NON_LIMIT_DISC (0x00 )</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">/* ************************* */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertisement_data.html"> 46</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="comment">// Only a subset of the possible BLE architected advertisement fields are currently exposed. Others will</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// be exposed on demand/request or as time permits.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32">setAppearance</a>(uint16_t appearance);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822">setCompleteServices</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb">setCompleteServices16</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt; &amp;v_uuid);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f">setCompleteServices32</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt; &amp;v_uuid);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2">setFlags</a>(uint8_t);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27">setManufacturerData</a>(<span class="keyword">const</span> std::string &amp;data);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36">setURI</a>(<span class="keyword">const</span> std::string &amp;uri);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf">setName</a>(<span class="keyword">const</span> std::string &amp;name);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85">setPartialServices</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4">setPartialServices16</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt; &amp;v_uuid);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306">setPartialServices32</a>(<span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt; &amp;v_uuid);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5">setServiceData</a>(<span class="keyword">const</span> <a class="code" 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 name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5">setShortName</a>(<span class="keyword">const</span> std::string &amp;name);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870">addData</a>(<span class="keyword">const</span> std::string &amp;data); <span class="comment">// Add data to the payload.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870">addData</a>(<span class="keywordtype">char</span> * data, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a480ffc91f212e877ae31ab47190006c3">addTxPower</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5">setPreferredParams</a>(uint16_t min, uint16_t max);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; std::string <a class="code" href="class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1">getPayload</a>(); <span class="comment">// Retrieve the current advert payload.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">void</span> setServices(<span class="keyword">const</span> <span class="keywordtype">bool</span> complete, <span class="keyword">const</span> uint8_t size,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> std::vector&lt;NimBLEUUID&gt; &amp;v_uuid);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; std::string m_payload; <span class="comment">// The payload of the advertisement.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}; <span class="comment">// NimBLEAdvertisementData</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_advertising.html"> 83</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="class_nim_b_l_e_advertising.html#abe6258a917243a4567c3d6eece2ddcdd">NimBLEAdvertising</a>();</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69">addServiceUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69">addServiceUUID</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* serviceUUID);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a725437c00152ff57ef1e21bdf7be980d">removeServiceUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertising.html#aeeee5a131b42a4f76010751f4c182e4f">start</a>(uint32_t duration = 0, <span class="keywordtype">void</span> (*<a class="code" href="class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2">advCompleteCB</a>)(<a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> *pAdv) = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#ab19c9e9015e812055e3cad29d52ed2ff">stop</a>();</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#aa0d30dfb57670cc8180e17dffddad416">setAppearance</a>(uint16_t appearance);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#add2ecd09877d7e4548b11ec7cb8c7a47">setName</a>(<span class="keyword">const</span> std::string &amp;name);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a1eff592870a47b0f62b0f0894efadbd4">setManufacturerData</a>(<span class="keyword">const</span> std::string &amp;data);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a6495d7c9ad80a8c2a5edf974705f8103">setURI</a>(<span class="keyword">const</span> std::string &amp;uri);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a994e43e9e4ace6ce64c57e57d0575781">setServiceData</a>(<span class="keyword">const</span> <a class="code" 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 name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a68d54f11b47b9993322efec1d07c3519">setAdvertisementType</a>(uint8_t adv_type);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#aab512576d8873fbbb631bac8ada19530">setMaxInterval</a>(uint16_t maxinterval);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a16bd135cab3f06bc0ba81c2aec19cbbc">setMinInterval</a>(uint16_t mininterval);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#af7083f58717b7e76d90d367f00a0ef08">setAdvertisementData</a>(<a class="code" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a>&amp; advertisementData);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#aa3da80c7d17a7824484ee254076e4790">setScanFilter</a>(<span class="keywordtype">bool</span> scanRequestWhitelistOnly, <span class="keywordtype">bool</span> connectWhitelistOnly);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a04a51a0c639a70295a9b671f73b34358">setScanResponseData</a>(<a class="code" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a>&amp; advertisementData);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a6fb4d9ad3949928ac83d3e74857ab91f">setScanResponse</a>(<span class="keywordtype">bool</span>);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a3bc158da1f732361df69cf16ca1cfd42">setMinPreferred</a>(uint16_t);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a3382cdf80f5ae46a52e3b9159f8e1b66">setMaxPreferred</a>(uint16_t);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#ac4ff0af45d1f7ed5bc208612852bc43a">addTxPower</a>();</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a545b505ea76396c33133d41a78fad5b8">reset</a>();</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2">advCompleteCB</a>();</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_advertising.html#ac257ab68520a244cb6494d793f9b6c2a">isAdvertising</a>();</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <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="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">void</span> onHostSync();</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(<span class="keyword">struct</span> ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; ble_hs_adv_fields m_advData;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; ble_hs_adv_fields m_scanData;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; ble_gap_adv_params m_advParams;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; std::vector&lt;NimBLEUUID&gt; m_serviceUUIDs;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordtype">bool</span> m_customAdvData;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordtype">bool</span> m_customScanResponseData;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">bool</span> m_scanResp;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">bool</span> m_advDataSet;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; void (*m_advCompCB)(<a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> *pAdv);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; uint8_t m_slaveItvl[4];</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; uint32_t m_duration;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; std::vector&lt;uint8_t&gt; m_svcData16;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; std::vector&lt;uint8_t&gt; m_svcData32;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; std::vector&lt;uint8_t&gt; m_svcData128;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; std::vector&lt;uint8_t&gt; m_name;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; std::vector&lt;uint8_t&gt; m_mfgData;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; std::vector&lt;uint8_t&gt; m_uri;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;};</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_BLEADVERTISING_H_ */</span><span class="preprocessor"></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> NimBLEAdvertising.h:46</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a0f209913ef9f3dfb5be8db39567b4f32"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32">NimBLEAdvertisementData::setAppearance</a></div><div class="ttdeci">void setAppearance(uint16_t appearance)</div><div class="ttdoc">Set the appearance.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:778</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a0ff5a72bccd349e551270ceadf528306"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306">NimBLEAdvertisementData::setPartialServices32</a></div><div class="ttdeci">void setPartialServices32(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</div><div class="ttdoc">Set the partial list of services to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:887</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a480ffc91f212e877ae31ab47190006c3"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a480ffc91f212e877ae31ab47190006c3">NimBLEAdvertisementData::addTxPower</a></div><div class="ttdeci">void addTxPower()</div><div class="ttdoc">Adds Tx power level to the advertisement data.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:997</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a50063c7ffa24f0f0407366a450e23ae4"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4">NimBLEAdvertisementData::setPartialServices16</a></div><div class="ttdeci">void setPartialServices16(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</div><div class="ttdoc">Set the partial list of services to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:878</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a50a2584346208ef28274eeecc5befffb"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb">NimBLEAdvertisementData::setCompleteServices16</a></div><div class="ttdeci">void setCompleteServices16(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</div><div class="ttdoc">Set the complete list of 16 bit services to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:851</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a58ba06eb062a47cc58ba2829af8aafa5"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5">NimBLEAdvertisementData::setPreferredParams</a></div><div class="ttdeci">void setPreferredParams(uint16_t min, uint16_t max)</div><div class="ttdoc">Set the preferred connection interval parameters.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:1011</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a67fd95e586559b73964d5739051f3822"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822">NimBLEAdvertisementData::setCompleteServices</a></div><div class="ttdeci">void 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> NimBLEAdvertising.cpp:842</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a712aa09a4d7f2b3cae9b2f1f1be6372f"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f">NimBLEAdvertisementData::setCompleteServices32</a></div><div class="ttdeci">void setCompleteServices32(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</div><div class="ttdoc">Set the complete list of 32 bit services to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:860</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a73766a872477512bd750c773d96ca4e2"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2">NimBLEAdvertisementData::setFlags</a></div><div class="ttdeci">void setFlags(uint8_t)</div><div class="ttdoc">Set the advertisement flags.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:793</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_a885b4ed75dd71c4c19b86048c16350bf"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf">NimBLEAdvertisementData::setName</a></div><div class="ttdeci">void setName(const std::string &amp;name)</div><div class="ttdoc">Set the complete name of this device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:830</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aa003bc4cf9bff2b2bcac9b742ec97a36"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36">NimBLEAdvertisementData::setURI</a></div><div class="ttdeci">void setURI(const std::string &amp;uri)</div><div class="ttdoc">Set the URI to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:818</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aa4df88b578782cda2bd77368b50f2d27"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27">NimBLEAdvertisementData::setManufacturerData</a></div><div class="ttdeci">void setManufacturerData(const std::string &amp;data)</div><div class="ttdoc">Set manufacturer specific data.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:806</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_acbd638708c8b8b4663c09107bc38feb1"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1">NimBLEAdvertisementData::getPayload</a></div><div class="ttdeci">std::string getPayload()</div><div class="ttdoc">Retrieve the payload that is to be advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:1027</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_ae5b514ad9be6552727f1c7a744a29ae5"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5">NimBLEAdvertisementData::setShortName</a></div><div class="ttdeci">void setShortName(const std::string &amp;name)</div><div class="ttdoc">Set the short name.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:986</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aec5f567059c4b4fd0f6b5fc74a0ce870"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870">NimBLEAdvertisementData::addData</a></div><div class="ttdeci">void addData(const std::string &amp;data)</div><div class="ttdoc">Add data to the payload to be advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:752</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_aee4fdb5af06fcda9cab9fad3f5bf80d5"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5">NimBLEAdvertisementData::setServiceData</a></div><div class="ttdeci">void setServiceData(const NimBLEUUID &amp;uuid, const std::string &amp;data)</div><div class="ttdoc">Set the service data (UUID + data)</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:949</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertisement_data_html_af52546d7c3b733a831f6232a845bef85"><div class="ttname"><a href="class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85">NimBLEAdvertisementData::setPartialServices</a></div><div class="ttdeci">void 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> NimBLEAdvertising.cpp:869</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:83</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a04a51a0c639a70295a9b671f73b34358"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a04a51a0c639a70295a9b671f73b34358">NimBLEAdvertising::setScanResponseData</a></div><div class="ttdeci">void setScanResponseData(NimBLEAdvertisementData &amp;advertisementData)</div><div class="ttdoc">Set the advertisement data that is to be published in a scan response.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:368</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a16bd135cab3f06bc0ba81c2aec19cbbc"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a16bd135cab3f06bc0ba81c2aec19cbbc">NimBLEAdvertising::setMinInterval</a></div><div class="ttdeci">void setMinInterval(uint16_t mininterval)</div><div class="ttdoc">Set the minimum advertising interval.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:223</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a1eff592870a47b0f62b0f0894efadbd4"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a1eff592870a47b0f62b0f0894efadbd4">NimBLEAdvertising::setManufacturerData</a></div><div class="ttdeci">void setManufacturerData(const std::string &amp;data)</div><div class="ttdoc">Set the advertised manufacturer data.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:147</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a3382cdf80f5ae46a52e3b9159f8e1b66"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a3382cdf80f5ae46a52e3b9159f8e1b66">NimBLEAdvertising::setMaxPreferred</a></div><div class="ttdeci">void setMaxPreferred(uint16_t)</div><div class="ttdoc">Set the advertised max connection interval preferred by this device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:275</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a3bc158da1f732361df69cf16ca1cfd42"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a3bc158da1f732361df69cf16ca1cfd42">NimBLEAdvertising::setMinPreferred</a></div><div class="ttdeci">void setMinPreferred(uint16_t)</div><div class="ttdoc">Set the advertised min connection interval preferred by this device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:243</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a4de7bf016a086a2d3f6f14ae134678f2"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2">NimBLEAdvertising::advCompleteCB</a></div><div class="ttdeci">void advCompleteCB()</div><div class="ttdoc">Handles the callback when advertising stops.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:685</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a4f334752ea04223185292fe9ab524b69"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69">NimBLEAdvertising::addServiceUUID</a></div><div class="ttdeci">void 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> NimBLEAdvertising.cpp:78</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a545b505ea76396c33133d41a78fad5b8"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a545b505ea76396c33133d41a78fad5b8">NimBLEAdvertising::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Stops the current advertising and resets the advertising data to the default values.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:43</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a6495d7c9ad80a8c2a5edf974705f8103"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a6495d7c9ad80a8c2a5edf974705f8103">NimBLEAdvertising::setURI</a></div><div class="ttdeci">void setURI(const std::string &amp;uri)</div><div class="ttdoc">Set the advertised URI.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:159</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a68d54f11b47b9993322efec1d07c3519"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a68d54f11b47b9993322efec1d07c3519">NimBLEAdvertising::setAdvertisementType</a></div><div class="ttdeci">void setAdvertisementType(uint8_t adv_type)</div><div class="ttdoc">Set the type of advertisment to use.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:214</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a6fb4d9ad3949928ac83d3e74857ab91f"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a6fb4d9ad3949928ac83d3e74857ab91f">NimBLEAdvertising::setScanResponse</a></div><div class="ttdeci">void setScanResponse(bool)</div><div class="ttdoc">Set if scan response is available.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:303</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a725437c00152ff57ef1e21bdf7be980d"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a725437c00152ff57ef1e21bdf7be980d">NimBLEAdvertising::removeServiceUUID</a></div><div class="ttdeci">void removeServiceUUID(const NimBLEUUID &amp;serviceUUID)</div><div class="ttdoc">Add a service uuid to exposed list of services.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:98</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_a994e43e9e4ace6ce64c57e57d0575781"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#a994e43e9e4ace6ce64c57e57d0575781">NimBLEAdvertising::setServiceData</a></div><div class="ttdeci">void setServiceData(const NimBLEUUID &amp;uuid, const std::string &amp;data)</div><div class="ttdoc">Set the service data advertised for the UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:173</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_aa0d30dfb57670cc8180e17dffddad416"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#aa0d30dfb57670cc8180e17dffddad416">NimBLEAdvertising::setAppearance</a></div><div class="ttdeci">void setAppearance(uint16_t appearance)</div><div class="ttdoc">Set the device appearance in the advertising data. The codes for distinct appearances can be found he...</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:115</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_aa3da80c7d17a7824484ee254076e4790"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#aa3da80c7d17a7824484ee254076e4790">NimBLEAdvertising::setScanFilter</a></div><div class="ttdeci">void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly)</div><div class="ttdoc">Set the filtering for the scan filter.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:314</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_aab512576d8873fbbb631bac8ada19530"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#aab512576d8873fbbb631bac8ada19530">NimBLEAdvertising::setMaxInterval</a></div><div class="ttdeci">void setMaxInterval(uint16_t maxinterval)</div><div class="ttdoc">Set the maximum advertising interval.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:232</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_ab19c9e9015e812055e3cad29d52ed2ff"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#ab19c9e9015e812055e3cad29d52ed2ff">NimBLEAdvertising::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stop advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:668</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_abe6258a917243a4567c3d6eece2ddcdd"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#abe6258a917243a4567c3d6eece2ddcdd">NimBLEAdvertising::NimBLEAdvertising</a></div><div class="ttdeci">NimBLEAdvertising()</div><div class="ttdoc">Construct a default advertising object.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:35</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_ac257ab68520a244cb6494d793f9b6c2a"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#ac257ab68520a244cb6494d793f9b6c2a">NimBLEAdvertising::isAdvertising</a></div><div class="ttdeci">bool isAdvertising()</div><div class="ttdoc">Check if currently advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:696</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_ac4ff0af45d1f7ed5bc208612852bc43a"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#ac4ff0af45d1f7ed5bc208612852bc43a">NimBLEAdvertising::addTxPower</a></div><div class="ttdeci">void addTxPower()</div><div class="ttdoc">Add the transmission power level to the advertisement packet.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:125</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_add2ecd09877d7e4548b11ec7cb8c7a47"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#add2ecd09877d7e4548b11ec7cb8c7a47">NimBLEAdvertising::setName</a></div><div class="ttdeci">void setName(const std::string &amp;name)</div><div class="ttdoc">Set the advertised name of the device.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:135</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_aeeee5a131b42a4f76010751f4c182e4f"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#aeeee5a131b42a4f76010751f4c182e4f">NimBLEAdvertising::start</a></div><div class="ttdeci">bool start(uint32_t duration=0, void(*advCompleteCB)(NimBLEAdvertising *pAdv)=nullptr)</div><div class="ttdoc">Start advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:388</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertising_html_af7083f58717b7e76d90d367f00a0ef08"><div class="ttname"><a href="class_nim_b_l_e_advertising.html#af7083f58717b7e76d90d367f00a0ef08">NimBLEAdvertising::setAdvertisementData</a></div><div class="ttdeci">void setAdvertisementData(NimBLEAdvertisementData &amp;advertisementData)</div><div class="ttdoc">Set the advertisement data that is to be published in a regular advertisement.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.cpp:348</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_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:31</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>NimBLEAdvertising.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>

View File

@@ -0,0 +1,160 @@
<!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/NimBLEBeacon.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_beacon_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">NimBLEBeacon.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEBeacon2.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 15 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEBeacon2.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jan 4, 2018</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLEBEACON_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLEBEACON_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_beacon.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; uint16_t manufacturerId;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; uint8_t subType;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; uint8_t subTypeLength;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; uint8_t proximityUUID[16];</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; uint16_t major;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint16_t minor;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; int8_t signalPower;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; } __attribute__((packed)) m_beaconData;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37">NimBLEBeacon</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::string <a class="code" href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">getData</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">getMajor</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">getMinor</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">getManufacturerId</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">getProximityUUID</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; int8_t <a class="code" href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">getSignalPower</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">setData</a>(<span class="keyword">const</span> std::string &amp;data);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">setMajor</a>(uint16_t major);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">setMinor</a>(uint16_t minor);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">setManufacturerId</a>(uint16_t manufacturerId);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">setProximityUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">setSignalPower</a>(int8_t signalPower);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;}; <span class="comment">// NimBLEBeacon</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLEBEACON_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html"><div class="ttname"><a href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></div><div class="ttdoc">Representation of a beacon. See:</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.h:24</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a1ec99fe7684181e7b899cd763f9b44d9"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">NimBLEBeacon::setManufacturerId</a></div><div class="ttdeci">void setManufacturerId(uint16_t manufacturerId)</div><div class="ttdoc">Set the manufacturer ID.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:122</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a44d03b0c2b1bea3bee8f15feeb73fb8e"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">NimBLEBeacon::setMinor</a></div><div class="ttdeci">void setMinor(uint16_t minor)</div><div class="ttdoc">Set the minor value.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:131</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a4bc9fd3a68b4b1772dc4d102573c6788"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">NimBLEBeacon::getMinor</a></div><div class="ttdeci">uint16_t getMinor()</div><div class="ttdoc">Get the minor value being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:72</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a4eb27b3e447f8f0b44128f77933be668"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">NimBLEBeacon::getSignalPower</a></div><div class="ttdeci">int8_t getSignalPower()</div><div class="ttdoc">Get the signal power being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:90</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a7f33ffc298285d1ab02088b2584f2256"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">NimBLEBeacon::setProximityUUID</a></div><div class="ttdeci">void setProximityUUID(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Set the proximity UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:140</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a8803d70e8c238ccb98edcf31af0ead40"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">NimBLEBeacon::getManufacturerId</a></div><div class="ttdeci">uint16_t getManufacturerId()</div><div class="ttdoc">Get the manufacturer ID being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:63</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a92292c8b1f5ba0097f063ff6e60934ff"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">NimBLEBeacon::setData</a></div><div class="ttdeci">void setData(const std::string &amp;data)</div><div class="ttdoc">Set the raw data for the beacon record.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:99</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_a999ade63059620d619609676d85186ad"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">NimBLEBeacon::getProximityUUID</a></div><div class="ttdeci">NimBLEUUID getProximityUUID()</div><div class="ttdoc">Get the proximity UUID being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:81</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_aac32b7f86c73221152909528c8dbad3c"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">NimBLEBeacon::getMajor</a></div><div class="ttdeci">uint16_t getMajor()</div><div class="ttdoc">Get the major value being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:54</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_abef1334108f8049832da7fffb56f6eea"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">NimBLEBeacon::setMajor</a></div><div class="ttdeci">void setMajor(uint16_t major)</div><div class="ttdoc">Set the major value.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:113</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_ac99e1fb4ef4795785a655b117dabdd37"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37">NimBLEBeacon::NimBLEBeacon</a></div><div class="ttdeci">NimBLEBeacon()</div><div class="ttdoc">Construct a default beacon object.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:30</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_ae2458f7db169b696e6368802d5ece0d9"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">NimBLEBeacon::getData</a></div><div class="ttdeci">std::string getData()</div><div class="ttdoc">Retrieve the data that is being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_beacon_html_ae2dd8cd367260dd8374309576457cec0"><div class="ttname"><a href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">NimBLEBeacon::setSignalPower</a></div><div class="ttdeci">void setSignalPower(int8_t signalPower)</div><div class="ttdoc">Set the signal power.</div><div class="ttdef"><b>Definition:</b> NimBLEBeacon.cpp:153</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a></div><div class="ttdoc">A model of a BLE UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.h:31</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLEBeacon.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,303 @@
<!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/NimBLECharacteristic.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_characteristic_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">NimBLECharacteristic.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLECharacteristic.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 3, 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * BLECharacteristic.h</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Created on: Jun 22, 2017</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLECHARACTERISTIC_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define MAIN_NIMBLECHARACTERISTIC_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;host/ble_hs.h&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; READ = BLE_GATT_CHR_F_READ,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; READ_ENC = BLE_GATT_CHR_F_READ_ENC,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; READ_AUTHEN = BLE_GATT_CHR_F_READ_AUTHEN,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; READ_AUTHOR = BLE_GATT_CHR_F_READ_AUTHOR,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; WRITE = BLE_GATT_CHR_F_WRITE,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; WRITE_NR = BLE_GATT_CHR_F_WRITE_NO_RSP,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; WRITE_ENC = BLE_GATT_CHR_F_WRITE_ENC,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; WRITE_AUTHEN = BLE_GATT_CHR_F_WRITE_AUTHEN,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; WRITE_AUTHOR = BLE_GATT_CHR_F_WRITE_AUTHOR,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; BROADCAST = BLE_GATT_CHR_F_BROADCAST,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; NOTIFY = BLE_GATT_CHR_F_NOTIFY,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; INDICATE = BLE_GATT_CHR_F_INDICATE</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;} NIMBLE_PROPERTY;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#include &quot;NimBLEService.h&quot;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;NimBLEDescriptor.h&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_characteristic.html"> 60</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da">NimBLECharacteristic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint16_t properties =</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; NIMBLE_PROPERTY::READ |</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; NIMBLE_PROPERTY::WRITE,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* pService = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da">NimBLECharacteristic</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; uint16_t properties =</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; NIMBLE_PROPERTY::READ |</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; NIMBLE_PROPERTY::WRITE,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* pService = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html#a7fe29c5ec571d0513c51b8cbac942f4a">~NimBLECharacteristic</a>();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_characteristic.html#acc3ea122771cd447103adfce22537379">getHandle</a>();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_characteristic.html#a28b03617fe753133582ba4e58c60e52e">getUUID</a>();</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; std::string <a class="code" href="class_nim_b_l_e_characteristic.html#a4fa6b8ed011d12e2b1f16e92a02b9a89">toString</a>();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#a29dc2505e1d3b4a7d6800d1547965d17">setCallbacks</a>(<a class="code" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a>* pCallbacks);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a>*</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html#a1747ac4889c7adbb93a2d88a10327a47">getCallbacks</a>();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#a2ce9f62ecc3d1644ef4d58efe7a3c434">indicate</a>();</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813">notify</a>(<span class="keywordtype">bool</span> is_notification = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">getSubscribedCount</a>();</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* <a class="code" href="class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda">createDescriptor</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; uint32_t properties =</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; NIMBLE_PROPERTY::READ |</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; NIMBLE_PROPERTY::WRITE,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; uint16_t max_len = 100);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* <a class="code" href="class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda">createDescriptor</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid,</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint32_t properties =</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; NIMBLE_PROPERTY::READ |</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; NIMBLE_PROPERTY::WRITE,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; uint16_t max_len = 100);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#aed4b2241c89ad2a8f49117e2b9433e5b">addDescriptor</a>(<a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *pDescriptor);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* <a class="code" href="class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189">getDescriptorByUUID</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* <a class="code" href="class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189">getDescriptorByUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* <a class="code" href="class_nim_b_l_e_characteristic.html#a062f52918f13c49a37ce8e58b9e7382a">getDescriptorByHandle</a>(uint16_t handle);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#a2c0ed8932ee257a8632e3d72e353489b">removeDescriptor</a>(<a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *pDescriptor, <span class="keywordtype">bool</span> deleteDsc = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; std::string <a class="code" href="class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54">getValue</a>(time_t *timestamp = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_characteristic.html#a580ad0133fd82a673027c91cbb1c74fa">getDataLength</a>();</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4"> 116</a></span>&#160; T <a class="code" href="class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4">getValue</a>(time_t *timestamp = <span class="keyword">nullptr</span>, <span class="keywordtype">bool</span> skipSizeCheck = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; std::string value = <a class="code" href="class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54">getValue</a>();</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; value.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = value.data();</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">setValue</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">setValue</a>(<span class="keyword">const</span> std::string &amp;value);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730"> 130</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730">setValue</a>(<span class="keyword">const</span> T &amp;s) {</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">setValue</a>((uint8_t*)&amp;s, <span class="keyword">sizeof</span>(T));</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; }</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_characteristic.html#a84aa251a612810ec8d07e77ab03cb483">getService</a>();</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_characteristic.html#a79759a98d9bdb761cb12c1ea6f601afc">getProperties</a>();</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">void</span> setService(<a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a> *pService);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordtype">void</span> setSubscribe(<span class="keyword">struct</span> ble_gap_event *event);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(uint16_t conn_handle, uint16_t attr_handle,</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">struct</span> ble_gatt_access_ctxt *ctxt, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; uint16_t m_handle;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; uint16_t m_properties;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a>* m_pCallbacks;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* m_pService;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; std::string m_value;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; std::vector&lt;NimBLEDescriptor*&gt; m_dscVec;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; portMUX_TYPE m_valMux;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; time_t m_timestamp;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; uint8_t m_removed;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; std::vector&lt;std::pair&lt;uint16_t, uint16_t&gt;&gt; m_subscribedVec;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;}; <span class="comment">// NimBLECharacteristic</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_characteristic_callbacks.html"> 169</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a> {</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; </div>
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f"> 177</a></span>&#160; <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; SUCCESS_INDICATE,</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; SUCCESS_NOTIFY,</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; ERROR_INDICATE_DISABLED,</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; ERROR_NOTIFY_DISABLED,</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; ERROR_GATT,</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; ERROR_NO_CLIENT,</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; ERROR_INDICATE_TIMEOUT,</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; ERROR_INDICATE_FAILURE</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; }<a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">Status</a>;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a>();</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93">onRead</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic);</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93">onRead</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic, ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3">onWrite</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic);</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3">onWrite</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic, ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#a185eb5298cc042f1aceeba21caf0dcc9">onNotify</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic);</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#ab17e7c61723a33cd3c922e3ca9c20f1e">onStatus</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic, <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">Status</a> s, <span class="keywordtype">int</span> code);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_characteristic_callbacks.html#a3c0c0f524bc0d00d24a7c5ea92c5cb7e">onSubscribe</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic, ble_gap_conn_desc* desc, uint16_t subValue);</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;};</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/*MAIN_NIMBLECHARACTERISTIC_H_*/</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></div><div class="ttdoc">Callbacks that can be associated with a BLE characteristic to inform of events.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:169</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html_a104baba3c4bbdee7aa28273d265e4c6f"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">NimBLECharacteristicCallbacks::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">An enum to provide the callback the status of the notification/indication, implemented for backward c...</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:177</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html_a185eb5298cc042f1aceeba21caf0dcc9"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html#a185eb5298cc042f1aceeba21caf0dcc9">NimBLECharacteristicCallbacks::onNotify</a></div><div class="ttdeci">virtual void onNotify(NimBLECharacteristic *pCharacteristic)</div><div class="ttdoc">Callback function to support a Notify request.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:611</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html_a3c0c0f524bc0d00d24a7c5ea92c5cb7e"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html#a3c0c0f524bc0d00d24a7c5ea92c5cb7e">NimBLECharacteristicCallbacks::onSubscribe</a></div><div class="ttdeci">virtual void onSubscribe(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc, uint16_t subValue)</div><div class="ttdoc">Callback function called when a client changes subscription status.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:637</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html_a523904b8d39e364db094f623403bad93"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93">NimBLECharacteristicCallbacks::onRead</a></div><div class="ttdeci">virtual void onRead(NimBLECharacteristic *pCharacteristic)</div><div class="ttdoc">Callback function to support a read request.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:577</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html_aac7caf4a80da061b5beda5ebcd214fc3"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3">NimBLECharacteristicCallbacks::onWrite</a></div><div class="ttdeci">virtual void onWrite(NimBLECharacteristic *pCharacteristic)</div><div class="ttdoc">Callback function to support a write request.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:594</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_callbacks_html_ab17e7c61723a33cd3c922e3ca9c20f1e"><div class="ttname"><a href="class_nim_b_l_e_characteristic_callbacks.html#ab17e7c61723a33cd3c922e3ca9c20f1e">NimBLECharacteristicCallbacks::onStatus</a></div><div class="ttdeci">virtual void onStatus(NimBLECharacteristic *pCharacteristic, Status s, int code)</div><div class="ttdoc">Callback function to support a Notify/Indicate Status report.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:622</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a062f52918f13c49a37ce8e58b9e7382a"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a062f52918f13c49a37ce8e58b9e7382a">NimBLECharacteristic::getDescriptorByHandle</a></div><div class="ttdeci">NimBLEDescriptor * getDescriptorByHandle(uint16_t handle)</div><div class="ttdoc">Return the BLE Descriptor for the given handle.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:185</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a1747ac4889c7adbb93a2d88a10327a47"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a1747ac4889c7adbb93a2d88a10327a47">NimBLECharacteristic::getCallbacks</a></div><div class="ttdeci">NimBLECharacteristicCallbacks * getCallbacks()</div><div class="ttdoc">Get the callback handlers for this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:508</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a28b03617fe753133582ba4e58c60e52e"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a28b03617fe753133582ba4e58c60e52e">NimBLECharacteristic::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Get the UUID of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:230</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a29dc2505e1d3b4a7d6800d1547965d17"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a29dc2505e1d3b4a7d6800d1547965d17">NimBLECharacteristic::setCallbacks</a></div><div class="ttdeci">void setCallbacks(NimBLECharacteristicCallbacks *pCallbacks)</div><div class="ttdoc">Set the callback handlers for this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:497</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a2c0ed8932ee257a8632e3d72e353489b"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a2c0ed8932ee257a8632e3d72e353489b">NimBLECharacteristic::removeDescriptor</a></div><div class="ttdeci">void removeDescriptor(NimBLEDescriptor *pDescriptor, bool deleteDsc=false)</div><div class="ttdoc">Remove a descriptor from the characterisitc.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:133</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a2ce9f62ecc3d1644ef4d58efe7a3c434"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a2ce9f62ecc3d1644ef4d58efe7a3c434">NimBLECharacteristic::indicate</a></div><div class="ttdeci">void indicate()</div><div class="ttdoc">Send an indication. An indication is a transmission of up to the first 20 bytes of the characteristic...</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:396</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a37e908d114f6ad2b4bf19c7cc4db9c54"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54">NimBLECharacteristic::getValue</a></div><div class="ttdeci">std::string getValue(time_t *timestamp=nullptr)</div><div class="ttdoc">Retrieve the current value of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:239</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a4fa6b8ed011d12e2b1f16e92a02b9a89"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a4fa6b8ed011d12e2b1f16e92a02b9a89">NimBLECharacteristic::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Return a string representation of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:554</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a580ad0133fd82a673027c91cbb1c74fa"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a580ad0133fd82a673027c91cbb1c74fa">NimBLECharacteristic::getDataLength</a></div><div class="ttdeci">size_t getDataLength()</div><div class="ttdoc">Retrieve the the current data length of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:255</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a79759a98d9bdb761cb12c1ea6f601afc"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a79759a98d9bdb761cb12c1ea6f601afc">NimBLECharacteristic::getProperties</a></div><div class="ttdeci">uint16_t getProperties()</div><div class="ttdoc">Get the properties of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:208</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a7cd211a8bb9a0c2ffaed57f2af273677"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">NimBLECharacteristic::setValue</a></div><div class="ttdeci">void setValue(const uint8_t *data, size_t size)</div><div class="ttdoc">Set the value of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:518</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a7d09c29b26362f6ddcaf51a9c9dc8be4"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4">NimBLECharacteristic::getValue</a></div><div class="ttdeci">T getValue(time_t *timestamp=nullptr, bool skipSizeCheck=false)</div><div class="ttdoc">A template to convert the characteristic data to &lt;type&gt;.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:116</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a7fe29c5ec571d0513c51b8cbac942f4a"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a7fe29c5ec571d0513c51b8cbac942f4a">NimBLECharacteristic::~NimBLECharacteristic</a></div><div class="ttdeci">~NimBLECharacteristic()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:62</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a84aa251a612810ec8d07e77ab03cb483"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a84aa251a612810ec8d07e77ab03cb483">NimBLECharacteristic::getService</a></div><div class="ttdeci">NimBLEService * getService()</div><div class="ttdoc">Get the service associated with this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:216</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_a942b2d29d77fcef233549d0c4fd798da"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da">NimBLECharacteristic::NimBLECharacteristic</a></div><div class="ttdeci">NimBLECharacteristic(const char *uuid, uint16_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, NimBLEService *pService=nullptr)</div><div class="ttdoc">Construct a characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:37</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_aa45461059e1992c816e32c371d17e813"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813">NimBLECharacteristic::notify</a></div><div class="ttdeci">void notify(bool is_notification=true)</div><div class="ttdoc">Send a notification. A notification is a transmission of up to the first 20 bytes of the characterist...</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:408</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_aae014669e9ce1ad01520d68fe0cc0fda"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda">NimBLECharacteristic::createDescriptor</a></div><div class="ttdeci">NimBLEDescriptor * createDescriptor(const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=100)</div><div class="ttdoc">Create a new BLE Descriptor associated with this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:76</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_aba05898f446e31222fbe509fa357c730"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730">NimBLECharacteristic::setValue</a></div><div class="ttdeci">void setValue(const T &amp;s)</div><div class="ttdoc">Convenience template to set the characteristic value to &lt;type&gt;val.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:130</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_abc5f4819e4d2c0956857ddd7a1064189"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189">NimBLECharacteristic::getDescriptorByUUID</a></div><div class="ttdeci">NimBLEDescriptor * getDescriptorByUUID(const char *uuid)</div><div class="ttdoc">Return the BLE Descriptor for the given UUID.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:161</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_acc3ea122771cd447103adfce22537379"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#acc3ea122771cd447103adfce22537379">NimBLECharacteristic::getHandle</a></div><div class="ttdeci">uint16_t getHandle()</div><div class="ttdoc">Get the handle of the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:199</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_aced225d46153b6969f6ded30c0190e39"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">NimBLECharacteristic::getSubscribedCount</a></div><div class="ttdeci">size_t getSubscribedCount()</div><div class="ttdoc">Get the number of clients subscribed to the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:339</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html_aed4b2241c89ad2a8f49117e2b9433e5b"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html#aed4b2241c89ad2a8f49117e2b9433e5b">NimBLECharacteristic::addDescriptor</a></div><div class="ttdeci">void addDescriptor(NimBLEDescriptor *pDescriptor)</div><div class="ttdoc">Add a descriptor to the characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.cpp:107</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></div><div class="ttdoc">A model of a BLE descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.h:44</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.h:36</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:31</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>NimBLECharacteristic.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>

View File

@@ -0,0 +1,269 @@
<!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/NimBLEClient.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_client_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">NimBLEClient.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEClient.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 26 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * BLEClient.h</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Created on: Mar 22, 2017</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLECLIENT_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define MAIN_NIMBLECLIENT_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEAddress.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;NimBLEUtils.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;NimBLEConnInfo.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;NimBLEAdvertisedDevice.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;NimBLERemoteService.h&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<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="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_client.html"> 41</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">connect</a>(<a class="code" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>* device, <span class="keywordtype">bool</span> deleteAttibutes = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">connect</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address, <span class="keywordtype">bool</span> deleteAttibutes = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">connect</a>(<span class="keywordtype">bool</span> deleteAttibutes = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_client.html#a5f77999664cc8a83f3cdb603ba4a5c8c">disconnect</a>(uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_client.html#a0477ba593f0b7c0cfc4697efdba703eb">getPeerAddress</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#a93b5b7c01e58a95dcea335f837d81d07">setPeerAddress</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_client.html#ae216993cf4eeb5780a104a8b14044f78">getRssi</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::vector&lt;NimBLERemoteService*&gt;* <a class="code" href="class_nim_b_l_e_client.html#acb9007569b3bb13b3b49f3c4cb47b21a">getServices</a>(<span class="keywordtype">bool</span> refresh = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::vector&lt;NimBLERemoteService*&gt;::iterator <a class="code" href="class_nim_b_l_e_client.html#ab09639b499fdcd0021a2432b2b8203f5">begin</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; std::vector&lt;NimBLERemoteService*&gt;::iterator <a class="code" href="class_nim_b_l_e_client.html#a0accd665926ea77d85ecb483b2b853fe">end</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* <a class="code" href="class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366">getService</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* <a class="code" href="class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366">getService</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#a668d476de250055a106a9f46bb7719f3">deleteServices</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_client.html#a0f940c51807469db1f1802b742180beb">deleteService</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; std::string <a class="code" href="class_nim_b_l_e_client.html#afd7b5c40f3c190a542f25b0b9e4afaf3">getValue</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID, <span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUUID);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client.html#a0910bbe298a68e9122a169ab229bf767">setValue</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID, <span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUUID,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">const</span> std::string &amp;value, <span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* <a class="code" href="class_nim_b_l_e_client.html#a2fc46f43a71dd0df63a377961baf8009">getCharacteristic</a>(<span class="keyword">const</span> uint16_t handle);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client.html#af1603da59b829f75b162ac4a65ce181c">isConnected</a>();</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#aeede4deef7421b9121387a786c07820c">setClientCallbacks</a>(<a class="code" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a> *pClientCallbacks,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">bool</span> deleteCallbacks = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::string <a class="code" href="class_nim_b_l_e_client.html#aba9ae035357776514b61c2b6286ce1ab">toString</a>();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_client.html#aa09466a7050bf08bab2390da66007896">getConnId</a>();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_client.html#ab971537eec4e53d621598eb1c760af3a">getMTU</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client.html#a79935ecbe94f2a41e0106d011edafac4">secureConnection</a>();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#a4068b29a9bd12e3110465908864dd20e">setConnectTimeout</a>(uint8_t timeout);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#a17718339f76eb621db0d7919c73b9267">setConnectionParams</a>(uint16_t minInterval, uint16_t maxInterval,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; uint16_t latency, uint16_t timeout,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; uint16_t scanInterval=16, uint16_t scanWindow=16);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">updateConnParams</a>(uint16_t minInterval, uint16_t maxInterval,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; uint16_t latency, uint16_t timeout);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client.html#a3d8cbf51caf8b3b8a0ec6ce2074ba71d">discoverAttributes</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_client.html#a566207f548c6b799792fc092f1748267">getConnInfo</a>();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;peerAddress);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; ~<a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <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="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(<span class="keyword">struct</span> ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> serviceDiscoveredCB(uint16_t conn_handle,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_svc *service,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> dcTimerCb(ble_npl_event *event);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">bool</span> retrieveServices(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> *uuid_filter = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> m_peerAddress;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint16_t m_conn_id;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">bool</span> m_connEstablished;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">bool</span> m_deleteCallbacks;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; int32_t m_connectTimeout;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <a class="code" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a>* m_pClientCallbacks;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; ble_task_data_t* m_pTaskData;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; ble_npl_callout m_dcTimer;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; std::vector&lt;NimBLERemoteService*&gt; m_servicesVector;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a>;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; ble_gap_conn_params m_pConnParams;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;}; <span class="comment">// class NimBLEClient</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_client_callbacks.html"> 113</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a> {</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a>() {};</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae">onConnect</a>(<a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* pClient);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client_callbacks.html#a3e5571e4d5ee53c5c4b25ceaac66b808">onDisconnect</a>(<a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* pClient);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6">onConnParamsUpdateRequest</a>(<a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* pClient, <span class="keyword">const</span> ble_gap_upd_params* params);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_nim_b_l_e_client_callbacks.html#a9850764aec546747537c6baa2a4622f5">onPassKeyRequest</a>();</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="comment">/*virtual void onPassKeyNotify(uint32_t pass_key);</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="comment"> virtual bool onSecurityRequest();*/</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_client_callbacks.html#a40fb2013fc4ebe51f770699377922065">onAuthenticationComplete</a>(ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_client_callbacks.html#ace39ee838319e415bd0fc5c72a653ff0">onConfirmPIN</a>(uint32_t pin);</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;};</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLECLIENT_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_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_client_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></div><div class="ttdoc">Callbacks associated with a BLE client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.h:113</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_callbacks_html_a3e5571e4d5ee53c5c4b25ceaac66b808"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html#a3e5571e4d5ee53c5c4b25ceaac66b808">NimBLEClientCallbacks::onDisconnect</a></div><div class="ttdeci">virtual void onDisconnect(NimBLEClient *pClient)</div><div class="ttdoc">Called when disconnected from the server.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1143</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_callbacks_html_a40fb2013fc4ebe51f770699377922065"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html#a40fb2013fc4ebe51f770699377922065">NimBLEClientCallbacks::onAuthenticationComplete</a></div><div class="ttdeci">virtual void onAuthenticationComplete(ble_gap_conn_desc *desc)</div><div class="ttdoc">Called when the pairing procedure is complete.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1165</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_callbacks_html_a8bc6a072e1cc974ef084eb2cad18dac6"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6">NimBLEClientCallbacks::onConnParamsUpdateRequest</a></div><div class="ttdeci">virtual bool onConnParamsUpdateRequest(NimBLEClient *pClient, const ble_gap_upd_params *params)</div><div class="ttdoc">Called when server requests to update the connection parameters.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1147</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_callbacks_html_a96de53d9745f243d544cd89498f979ae"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae">NimBLEClientCallbacks::onConnect</a></div><div class="ttdeci">virtual void onConnect(NimBLEClient *pClient)</div><div class="ttdoc">Called after client connects.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1139</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_callbacks_html_a9850764aec546747537c6baa2a4622f5"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html#a9850764aec546747537c6baa2a4622f5">NimBLEClientCallbacks::onPassKeyRequest</a></div><div class="ttdeci">virtual uint32_t onPassKeyRequest()</div><div class="ttdoc">Called when server requests a passkey for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1152</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_callbacks_html_ace39ee838319e415bd0fc5c72a653ff0"><div class="ttname"><a href="class_nim_b_l_e_client_callbacks.html#ace39ee838319e415bd0fc5c72a653ff0">NimBLEClientCallbacks::onConfirmPIN</a></div><div class="ttdeci">virtual bool onConfirmPIN(uint32_t pin)</div><div class="ttdoc">Called when using numeric comparision for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1168</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a0477ba593f0b7c0cfc4697efdba703eb"><div class="ttname"><a href="class_nim_b_l_e_client.html#a0477ba593f0b7c0cfc4697efdba703eb">NimBLEClient::getPeerAddress</a></div><div class="ttdeci">NimBLEAddress getPeerAddress()</div><div class="ttdoc">Retrieve the address of the peer.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:478</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a0910bbe298a68e9122a169ab229bf767"><div class="ttname"><a href="class_nim_b_l_e_client.html#a0910bbe298a68e9122a169ab229bf767">NimBLEClient::setValue</a></div><div class="ttdeci">bool setValue(const NimBLEUUID &amp;serviceUUID, const NimBLEUUID &amp;characteristicUUID, const std::string &amp;value, bool response=false)</div><div class="ttdoc">Set the value of a specific characteristic associated with a specific service.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:747</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a0accd665926ea77d85ecb483b2b853fe"><div class="ttname"><a href="class_nim_b_l_e_client.html#a0accd665926ea77d85ecb483b2b853fe">NimBLEClient::end</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteService * &gt;::iterator end()</div><div class="ttdoc">Get iterator to the end of the vector of remote service pointers.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:535</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a0f940c51807469db1f1802b742180beb"><div class="ttname"><a href="class_nim_b_l_e_client.html#a0f940c51807469db1f1802b742180beb">NimBLEClient::deleteService</a></div><div class="ttdeci">size_t deleteService(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Delete service by UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:131</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a17718339f76eb621db0d7919c73b9267"><div class="ttname"><a href="class_nim_b_l_e_client.html#a17718339f76eb621db0d7919c73b9267">NimBLEClient::setConnectionParams</a></div><div class="ttdeci">void setConnectionParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16)</div><div class="ttdoc">Set the connection paramaters to use when connecting to a server.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:388</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a2fc46f43a71dd0df63a377961baf8009"><div class="ttname"><a href="class_nim_b_l_e_client.html#a2fc46f43a71dd0df63a377961baf8009">NimBLEClient::getCharacteristic</a></div><div class="ttdeci">NimBLERemoteCharacteristic * getCharacteristic(const uint16_t handle)</div><div class="ttdoc">Get the remote characteristic with the specified handle.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:773</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a3d8cbf51caf8b3b8a0ec6ce2074ba71d"><div class="ttname"><a href="class_nim_b_l_e_client.html#a3d8cbf51caf8b3b8a0ec6ce2074ba71d">NimBLEClient::discoverAttributes</a></div><div class="ttdeci">void discoverAttributes()</div><div class="ttdoc">Retrieves the full database of attributes that the peripheral has available.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:612</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a4068b29a9bd12e3110465908864dd20e"><div class="ttname"><a href="class_nim_b_l_e_client.html#a4068b29a9bd12e3110465908864dd20e">NimBLEClient::setConnectTimeout</a></div><div class="ttdeci">void setConnectTimeout(uint8_t timeout)</div><div class="ttdoc">Set the timeout to wait for connection attempt to complete.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:461</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a566207f548c6b799792fc092f1748267"><div class="ttname"><a href="class_nim_b_l_e_client.html#a566207f548c6b799792fc092f1748267">NimBLEClient::getConnInfo</a></div><div class="ttdeci">NimBLEConnInfo getConnInfo()</div><div class="ttdoc">Get detailed information about the current peer connection.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:442</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a5f77999664cc8a83f3cdb603ba4a5c8c"><div class="ttname"><a href="class_nim_b_l_e_client.html#a5f77999664cc8a83f3cdb603ba4a5c8c">NimBLEClient::disconnect</a></div><div class="ttdeci">int disconnect(uint8_t reason=BLE_ERR_REM_USER_CONN_TERM)</div><div class="ttdoc">Disconnect from the peer.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:336</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a668d476de250055a106a9f46bb7719f3"><div class="ttname"><a href="class_nim_b_l_e_client.html#a668d476de250055a106a9f46bb7719f3">NimBLEClient::deleteServices</a></div><div class="ttdeci">void deleteServices()</div><div class="ttdoc">Delete all service objects created by this client and clear the vector.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:114</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a79935ecbe94f2a41e0106d011edafac4"><div class="ttname"><a href="class_nim_b_l_e_client.html#a79935ecbe94f2a41e0106d011edafac4">NimBLEClient::secureConnection</a></div><div class="ttdeci">bool secureConnection()</div><div class="ttdoc">Initiate a secure connection (pair/bond) with the server. Called automatically when a characteristic ...</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:307</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_a93b5b7c01e58a95dcea335f837d81d07"><div class="ttname"><a href="class_nim_b_l_e_client.html#a93b5b7c01e58a95dcea335f837d81d07">NimBLEClient::setPeerAddress</a></div><div class="ttdeci">void setPeerAddress(const NimBLEAddress &amp;address)</div><div class="ttdoc">Set the peer address.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:488</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_aa09466a7050bf08bab2390da66007896"><div class="ttname"><a href="class_nim_b_l_e_client.html#aa09466a7050bf08bab2390da66007896">NimBLEClient::getConnId</a></div><div class="ttdeci">uint16_t getConnId()</div><div class="ttdoc">Get the connection id for this client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:470</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_aab311f0a8af21fb63f78e7fbac29951a"><div class="ttname"><a href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">NimBLEClient::connect</a></div><div class="ttdeci">bool connect(NimBLEAdvertisedDevice *device, bool deleteAttibutes=true)</div><div class="ttdoc">Connect to an advertising device.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:165</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_ab09639b499fdcd0021a2432b2b8203f5"><div class="ttname"><a href="class_nim_b_l_e_client.html#ab09639b499fdcd0021a2432b2b8203f5">NimBLEClient::begin</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteService * &gt;::iterator begin()</div><div class="ttdoc">Get iterator to the beginning of the vector of remote service pointers.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:526</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_ab971537eec4e53d621598eb1c760af3a"><div class="ttname"><a href="class_nim_b_l_e_client.html#ab971537eec4e53d621598eb1c760af3a">NimBLEClient::getMTU</a></div><div class="ttdeci">uint16_t getMTU()</div><div class="ttdoc">Get the current mtu of this connection.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:798</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_aba9ae035357776514b61c2b6286ce1ab"><div class="ttname"><a href="class_nim_b_l_e_client.html#aba9ae035357776514b61c2b6286ce1ab">NimBLEClient::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Return a string representation of this client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1127</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_acb9007569b3bb13b3b49f3c4cb47b21a"><div class="ttname"><a href="class_nim_b_l_e_client.html#acb9007569b3bb13b3b49f3c4cb47b21a">NimBLEClient::getServices</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteService * &gt; * getServices(bool refresh=false)</div><div class="ttdoc">Get a pointer to the vector of found services.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:594</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_ae216993cf4eeb5780a104a8b14044f78"><div class="ttname"><a href="class_nim_b_l_e_client.html#ae216993cf4eeb5780a104a8b14044f78">NimBLEClient::getRssi</a></div><div class="ttdeci">int getRssi()</div><div class="ttdoc">Ask the BLE server for the RSSI value.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:503</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_ae22379ab10bd82932d2303fb3753c366"><div class="ttname"><a href="class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366">NimBLEClient::getService</a></div><div class="ttdeci">NimBLERemoteService * getService(const char *uuid)</div><div class="ttdoc">Get the service BLE Remote Service instance corresponding to the uuid.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:545</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_aeede4deef7421b9121387a786c07820c"><div class="ttname"><a href="class_nim_b_l_e_client.html#aeede4deef7421b9121387a786c07820c">NimBLEClient::setClientCallbacks</a></div><div class="ttdeci">void setClientCallbacks(NimBLEClientCallbacks *pClientCallbacks, bool deleteCallbacks=true)</div><div class="ttdoc">Set the callbacks that will be invoked when events are received.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1113</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_af1603da59b829f75b162ac4a65ce181c"><div class="ttname"><a href="class_nim_b_l_e_client.html#af1603da59b829f75b162ac4a65ce181c">NimBLEClient::isConnected</a></div><div class="ttdeci">bool isConnected()</div><div class="ttdoc">Are we connected to a server?</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:1103</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_afd7b5c40f3c190a542f25b0b9e4afaf3"><div class="ttname"><a href="class_nim_b_l_e_client.html#afd7b5c40f3c190a542f25b0b9e4afaf3">NimBLEClient::getValue</a></div><div class="ttdeci">std::string getValue(const NimBLEUUID &amp;serviceUUID, const NimBLEUUID &amp;characteristicUUID)</div><div class="ttdoc">Get the value of a specific characteristic associated with a specific service.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:720</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html_aff7d389ec48567286ea732c54d320526"><div class="ttname"><a href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">NimBLEClient::updateConnParams</a></div><div class="ttdeci">void updateConnParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</div><div class="ttdoc">Update the connection parameters:</div><div class="ttdef"><b>Definition:</b> NimBLEClient.cpp:418</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></div><div class="ttdoc">Connection information.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:9</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_remote_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></div><div class="ttdoc">A model of a remote BLE characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></div><div class="ttdoc">A model of a remote BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.h:36</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:31</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>NimBLEClient.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>

View File

@@ -0,0 +1,155 @@
<!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/NimBLEConnInfo.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_conn_info_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">NimBLEConnInfo.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef NIMBLECONNINFO_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define NIMBLECONNINFO_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;NimBLEAddress.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html"> 9</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; ble_gap_conn_desc m_desc;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>() { m_desc = {}; }</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>(ble_gap_conn_desc desc) { m_desc = desc; }</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847"> 17</a></span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847">getAddress</a>() { <span class="keywordflow">return</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>(m_desc.peer_ota_addr); }</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a"> 20</a></span>&#160; <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a">getIdAddress</a>() { <span class="keywordflow">return</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>(m_desc.peer_id_addr); }</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4"> 23</a></span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4">getConnHandle</a>() { <span class="keywordflow">return</span> m_desc.conn_handle; }</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049"> 26</a></span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049">getConnInterval</a>() { <span class="keywordflow">return</span> m_desc.conn_itvl; }</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082"> 29</a></span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082">getConnTimeout</a>() { <span class="keywordflow">return</span> m_desc.supervision_timeout; }</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430"> 32</a></span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430">getConnLatency</a>() { <span class="keywordflow">return</span> m_desc.conn_latency; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462"> 35</a></span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462">getMTU</a>() { <span class="keywordflow">return</span> ble_att_mtu(m_desc.conn_handle); }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4"> 38</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4">isMaster</a>() { <span class="keywordflow">return</span> (m_desc.role == BLE_GAP_ROLE_MASTER); }</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af"> 41</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af">isSlave</a>() { <span class="keywordflow">return</span> (m_desc.role == BLE_GAP_ROLE_SLAVE); }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125"> 44</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125">isBonded</a>() { <span class="keywordflow">return</span> (m_desc.sec_state.bonded == 1); }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744"> 47</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744">isEncrypted</a>() { <span class="keywordflow">return</span> (m_desc.sec_state.encrypted == 1); }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89"> 50</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89">isAuthenticated</a>() { <span class="keywordflow">return</span> (m_desc.sec_state.authenticated == 1); }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782"> 53</a></span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782">getSecKeySize</a>() { <span class="keywordflow">return</span> m_desc.sec_state.key_size; }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif</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_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></div><div class="ttdoc">Connection information.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:9</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a10c6093ca2f92ea61b82815909106430"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430">NimBLEConnInfo::getConnLatency</a></div><div class="ttdeci">uint16_t getConnLatency()</div><div class="ttdoc">Gets the allowable latency for this connection (unit = number of intervals)</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:32</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a278a8456f9d7df9cea7d776e61b36782"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782">NimBLEConnInfo::getSecKeySize</a></div><div class="ttdeci">uint8_t getSecKeySize()</div><div class="ttdoc">Gets the key size used to encrypt the connection.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:53</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a63ff245a8848bf1cc5839adee7aa41c4"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4">NimBLEConnInfo::isMaster</a></div><div class="ttdeci">bool isMaster()</div><div class="ttdoc">Check if we are in the master role in this connection.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:38</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a7229e53d21c9c6b5b9fb5bd232862c89"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89">NimBLEConnInfo::isAuthenticated</a></div><div class="ttdeci">bool isAuthenticated()</div><div class="ttdoc">Check if the the connection has been authenticated.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:50</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a77e212f3e236b05da0978ea482e3efb4"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4">NimBLEConnInfo::getConnHandle</a></div><div class="ttdeci">uint16_t getConnHandle()</div><div class="ttdoc">Gets the connection handle of the connected peer.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:23</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a7bc23f09eb7dd53be902cb67d2ba745a"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a">NimBLEConnInfo::getIdAddress</a></div><div class="ttdeci">NimBLEAddress getIdAddress()</div><div class="ttdoc">Gets the ID address of the connected peer.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:20</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a8e885d340f1ab4e477c69ed7ea99b082"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082">NimBLEConnInfo::getConnTimeout</a></div><div class="ttdeci">uint16_t getConnTimeout()</div><div class="ttdoc">Gets the supervision timeout for this connection (in 10ms units)</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:29</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a8ecf3c58da6ffb529215ce6f13c96744"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744">NimBLEConnInfo::isEncrypted</a></div><div class="ttdeci">bool isEncrypted()</div><div class="ttdoc">Check if the connection in encrypted.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:47</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_a94796b6446ef40c0ae0d1f8af1ff9462"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462">NimBLEConnInfo::getMTU</a></div><div class="ttdeci">uint16_t getMTU()</div><div class="ttdoc">Gets the maximum transmission unit size for this connection (in bytes)</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:35</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_aa43374d84b7564f6d187fd0c637b1049"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049">NimBLEConnInfo::getConnInterval</a></div><div class="ttdeci">uint16_t getConnInterval()</div><div class="ttdoc">Gets the connection interval for this connection (in 1.25ms units)</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:26</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_abfb91b833cb200f795bc63d5affff6af"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af">NimBLEConnInfo::isSlave</a></div><div class="ttdeci">bool isSlave()</div><div class="ttdoc">Check if we are in the slave role in this connection.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_af17023ca06c3d1b9e142dcd5f8c54847"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847">NimBLEConnInfo::getAddress</a></div><div class="ttdeci">NimBLEAddress getAddress()</div><div class="ttdoc">Gets the over-the-air address of the connected peer.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:17</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html_af281a25921d36dc75cf1e37561940125"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125">NimBLEConnInfo::isBonded</a></div><div class="ttdeci">bool isBonded()</div><div class="ttdoc">Check if we are connected to a bonded peer.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:44</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</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>NimBLEConnInfo.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>

View File

@@ -0,0 +1,224 @@
<!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/NimBLEDescriptor.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_descriptor_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">NimBLEDescriptor.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEDescriptor.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 10, 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEDescriptor.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jun 22, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLEDESCRIPTOR_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLEDESCRIPTOR_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLECharacteristic.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; uint16_t attr_max_len; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint16_t attr_len; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; uint8_t *attr_value; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;} attr_value_t;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_descriptor.html"> 44</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t properties,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint16_t max_len,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor</a>(<a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> uuid, uint16_t properties,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint16_t max_len,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc">~NimBLEDescriptor</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">getHandle</a>();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186">getUUID</a>();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; std::string <a class="code" href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">toString</a>();</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a>(<a class="code" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>* pCallbacks);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">getLength</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint8_t* <a class="code" href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">getValue</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::string <a class="code" href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">getStringValue</a>();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a>(<span class="keyword">const</span> std::string &amp;value);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">getCharacteristic</a>();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477"> 75</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">setValue</a>(<span class="keyword">const</span> T &amp;s) {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a>((uint8_t*)&amp;s, <span class="keyword">sizeof</span>(T));</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e2904.html">NimBLE2904</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(uint16_t conn_handle, uint16_t attr_handle,</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">struct</span> ble_gatt_access_ctxt *ctxt, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordtype">void</span> setHandle(uint16_t handle);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> setCharacteristic(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pChar);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; uint16_t m_handle;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="code" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>* m_pCallbacks;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_pCharacteristic;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint8_t m_properties;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; attr_value_t m_value;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; portMUX_TYPE m_valMux;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; uint8_t m_removed;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}; <span class="comment">// NimBLEDescriptor</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_descriptor_callbacks.html"> 107</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>();</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_descriptor_callbacks.html#a6b13d2a8447f50a089b869cea9fcdcbc">onRead</a>(<a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* pDescriptor);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_descriptor_callbacks.html#a7081bf2c4f22225c4715e09762be40ed">onWrite</a>(<a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* pDescriptor);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;};</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="preprocessor">#include &quot;NimBLE2904.h&quot;</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLEDESCRIPTOR_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e2904_html"><div class="ttname"><a href="class_nim_b_l_e2904.html">NimBLE2904</a></div><div class="ttdoc">Descriptor for Characteristic Presentation Format.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.h:43</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a></div><div class="ttdoc">Callbacks that can be associated with a BLE descriptors to inform of events.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.h:107</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_callbacks_html_a6b13d2a8447f50a089b869cea9fcdcbc"><div class="ttname"><a href="class_nim_b_l_e_descriptor_callbacks.html#a6b13d2a8447f50a089b869cea9fcdcbc">NimBLEDescriptorCallbacks::onRead</a></div><div class="ttdeci">virtual void onRead(NimBLEDescriptor *pDescriptor)</div><div class="ttdoc">Callback function to support a read request.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:279</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_callbacks_html_a7081bf2c4f22225c4715e09762be40ed"><div class="ttname"><a href="class_nim_b_l_e_descriptor_callbacks.html#a7081bf2c4f22225c4715e09762be40ed">NimBLEDescriptorCallbacks::onWrite</a></div><div class="ttdeci">virtual void onWrite(NimBLEDescriptor *pDescriptor)</div><div class="ttdoc">Callback function to support a write request.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:288</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></div><div class="ttdoc">A model of a BLE descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.h:44</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a378346f59afb706d4c1d961227b98c5d"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">NimBLEDescriptor::getLength</a></div><div class="ttdeci">size_t getLength()</div><div class="ttdoc">Get the length of the value of this descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:106</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a3cf995352eb1b1c212a7911a05c33b25"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor::NimBLEDescriptor</a></div><div class="ttdeci">NimBLEDescriptor(const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr)</div><div class="ttdoc">NimBLEDescriptor constructor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:35</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a412b3735186d94e9ddcf37a06c2055e1"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">NimBLEDescriptor::getCharacteristic</a></div><div class="ttdeci">NimBLECharacteristic * getCharacteristic()</div><div class="ttdoc">Get the characteristic this descriptor belongs to.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:141</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a486af6799753dfa60b3faddfac2adbcd"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">NimBLEDescriptor::getHandle</a></div><div class="ttdeci">uint16_t getHandle()</div><div class="ttdoc">Get the BLE handle for this descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:97</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a7153e051e5808469c23e2207fa6711db"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">NimBLEDescriptor::getStringValue</a></div><div class="ttdeci">std::string getStringValue()</div><div class="ttdoc">Get the value of this descriptor as a string.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:132</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a9136cc9e4b41110b3dd99d1c9553a477"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">NimBLEDescriptor::setValue</a></div><div class="ttdeci">void setValue(const T &amp;s)</div><div class="ttdoc">Convenience template to set the descriptor value to &lt;type&gt;val.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.h:75</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a9447cee9092dc516266f7764131ba923"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">NimBLEDescriptor::setValue</a></div><div class="ttdeci">void setValue(const uint8_t *data, size_t size)</div><div class="ttdoc">Set the value of the descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:232</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_aa9cb8727f9e17cf8050cf619e5fe3096"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">NimBLEDescriptor::setCallbacks</a></div><div class="ttdeci">void setCallbacks(NimBLEDescriptorCallbacks *pCallbacks)</div><div class="ttdoc">Set the callback handlers for this descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:205</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_abc5398a570edc197fbadad3f5b45e186"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186">NimBLEDescriptor::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Get the UUID of the descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:114</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_ac15dc6c9c24d280c4b0eb766080497e5"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">NimBLEDescriptor::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Return a string representation of the descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:265</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_ac54fd0830ceb64b91037b623dbc427b5"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">NimBLEDescriptor::getValue</a></div><div class="ttdeci">uint8_t * getValue()</div><div class="ttdoc">Get the value of this descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:123</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_ad110851335bc7b225f5bea9ac11bedcc"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc">NimBLEDescriptor::~NimBLEDescriptor</a></div><div class="ttdeci">~NimBLEDescriptor()</div><div class="ttdoc">NimBLEDescriptor destructor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.cpp:89</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.h:36</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:31</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>NimBLEDescriptor.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>

View File

@@ -0,0 +1,361 @@
<!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/NimBLEDevice.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_device_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">NimBLEDevice.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEDevice.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 24 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEDevice.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Mar 16, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLEDEVICE_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLEDEVICE_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEScan.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;NimBLEAdvertising.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;NimBLEClient.h&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;NimBLEServer.h&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &quot;NimBLEUtils.h&quot;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#include &quot;NimBLESecurity.h&quot;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#include &quot;NimBLEAddress.h&quot;</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;esp_bt.h&quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &lt;list&gt;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define BLEDevice NimBLEDevice</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#define BLEClient NimBLEClient</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define BLERemoteService NimBLERemoteService</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#define BLERemoteCharacteristic NimBLERemoteCharacteristic</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#define BLERemoteDescriptor NimBLERemoteDescriptor</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#define BLEAdvertisedDevice NimBLEAdvertisedDevice</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#define BLEScan NimBLEScan</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#define BLEUUID NimBLEUUID</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#define BLESecurity NimBLESecurity</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#define BLESecurityCallbacks NimBLESecurityCallbacks</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#define BLEAddress NimBLEAddress</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#define BLEUtils NimBLEUtils</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#define BLEClientCallbacks NimBLEClientCallbacks</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#define BLEAdvertisedDeviceCallbacks NimBLEAdvertisedDeviceCallbacks</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#define BLEScanResults NimBLEScanResults</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#define BLEServer NimBLEServer</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#define BLEService NimBLEService</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#define BLECharacteristic NimBLECharacteristic</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#define BLEAdvertising NimBLEAdvertising</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#define BLEServerCallbacks NimBLEServerCallbacks</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#define BLECharacteristicCallbacks NimBLECharacteristicCallbacks</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#define BLEAdvertisementData NimBLEAdvertisementData</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#define BLEDescriptor NimBLEDescriptor</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#define BLE2902 NimBLE2902</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#define BLE2904 NimBLE2904</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#define BLEDescriptorCallbacks NimBLEDescriptorCallbacks</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor">#define BLEBeacon NimBLEBeacon</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#define BLEEddystoneTLM NimBLEEddystoneTLM</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#define BLEEddystoneURL NimBLEEddystoneURL</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#ifdef CONFIG_BT_NIMBLE_MAX_CONNECTIONS</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#define NIMBLE_MAX_CONNECTIONS CONFIG_BT_NIMBLE_MAX_CONNECTIONS</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#define NIMBLE_MAX_CONNECTIONS CONFIG_NIMBLE_MAX_CONNECTIONS</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword">typedef</span> int (*gap_event_handler)(ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> <span class="keywordtype">void</span> ble_store_config_init(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_device.html"> 91</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_device.html">NimBLEDevice</a> {</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a674d2e68d4ba0e3f84d7993f9da7d15b">init</a>(<span class="keyword">const</span> std::string &amp;deviceName);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#ae95693ce0f5b8e784ea8e10834dd624c">deinit</a>(<span class="keywordtype">bool</span> clearAll = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#ad6eda512195c7cbe249a1edbb99510cd">getInitialized</a>();</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_device.html#a77f9f343143d4f074ffb545dd14cbb2b">getAddress</a>();</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">static</span> std::string <a class="code" href="class_nim_b_l_e_device.html#abf8c494b54d9f0c9466c80f25dbdd961">toString</a>();</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#aabc68166b6dd4a744a98f94e569f37db">whiteListAdd</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp; address);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#a81abbad5e371fe1cdd91c002b42cc654">whiteListRemove</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp; address);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#ae51e2d4d6169a61133178a1b0d6b5b45">onWhiteList</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp; address);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_device.html#ab28cc2ec59fc9e62d05826633f53d2a0">getWhiteListCount</a>();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_device.html#a4a2229e9e517b84773e65c75124b0789">getWhiteListAddress</a>(<span class="keywordtype">size_t</span> index);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>* <a class="code" href="class_nim_b_l_e_device.html#af93d92316454b051125460056368baec">getScan</a>();</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* <a class="code" href="class_nim_b_l_e_device.html#a4d9780d0b5fafc279483822af802a508">createServer</a>();</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* <a class="code" href="class_nim_b_l_e_device.html#a41d4cc7c85cba0721c6649b001b31b4d">getServer</a>();</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#ac81f123fc1345596eb147c4fad125b1c">setPower</a>(esp_power_level_t powerLevel, esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_device.html#a34b50f12dc40ed47bdbb2b5ce4387a8c">getPower</a>(esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a8d4e1013815e7b021029f447f1702833">setCustomGapHandler</a>(gap_event_handler handler);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#aa8e340c02418771ce72dec758d560938">setSecurityAuth</a>(<span class="keywordtype">bool</span> bonding, <span class="keywordtype">bool</span> mitm, <span class="keywordtype">bool</span> sc);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#aa8e340c02418771ce72dec758d560938">setSecurityAuth</a>(uint8_t auth_req);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#ab9fee9e810d5fa18bc8a37053eb9b5d0">setSecurityIOCap</a>(uint8_t iocap);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a92d36c3a34d9474fa1d7f66c0e477d1e">setSecurityInitKey</a>(uint8_t init_key);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a57f0d4db1cc564176b23e860fce13f6a">setSecurityRespKey</a>(uint8_t init_key);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a84631f6d657fb6bd39722560fa229d35">setSecurityPasskey</a>(uint32_t pin);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">static</span> uint32_t <a class="code" href="class_nim_b_l_e_device.html#aa03937eadda020643b536c5d08174d3a">getSecurityPasskey</a>();</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a7d44bb960c0bb1bec02a33369c693085">setSecurityCallbacks</a>(<a class="code" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a>* pCallbacks);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#aa95f75d0a4325335ed0165f566d3a27d">setOwnAddrType</a>(uint8_t own_addr_type, <span class="keywordtype">bool</span> useNRPA=<span class="keyword">false</span>);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_device.html#a339157bf3d8fc712fa838e9a5127cc62">startSecurity</a>(uint16_t conn_id);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_device.html#a7d8203040611e3f82bf4848a9b371e98">setMTU</a>(uint16_t mtu);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">static</span> uint16_t <a class="code" href="class_nim_b_l_e_device.html#a5520cf3f544d571636eed162de394ec2">getMTU</a>();</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#a14ebc6070a261d7a6518ad435b673962">isIgnored</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a732425c5c5f5b5b4730c1689700346c0">addIgnored</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a0374ab8e323277bd8498609559966924">removeIgnored</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a9fdc368b81152a55599e2041181cef08">setScanDuplicateCacheSize</a>(uint16_t cacheSize);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#aba7ad0c41541428243d5c5e94b512c93">setScanFilterMode</a>(uint8_t type);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>* <a class="code" href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140">getAdvertising</a>();</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#ad0bc1019facfd79291b5353ff970473d">startAdvertising</a>();</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#a8b23c6ade03a69048f0568eb9ad3b034">stopAdvertising</a>();</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="preprocessor">#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* <a class="code" href="class_nim_b_l_e_device.html#af8142995252f486916dbb9de2a5b0c9e">createClient</a>(<a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> peerAddress = <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>(<span class="stringliteral">&quot;&quot;</span>));</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#a83aa0a3d9d57358d35082a442edf8549">deleteClient</a>(<a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* pClient);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* <a class="code" href="class_nim_b_l_e_device.html#ac7adcd510eef2b9546bcde9a253e56a9">getClientByID</a>(uint16_t conn_id);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* <a class="code" href="class_nim_b_l_e_device.html#ac4dbadc7fc170993e41532f675786504">getClientByPeerAddress</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;peer_addr);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* <a class="code" href="class_nim_b_l_e_device.html#a10aec48b56ef404f42ade96d6244b312">getDisconnectedClient</a>();</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_device.html#abe21dcac43493689a06bc6ddb91b6faf">getClientListSize</a>();</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keyword">static</span> std::list&lt;NimBLEClient*&gt;* <a class="code" href="class_nim_b_l_e_device.html#a1a6fb5e8f0e2cdc012ebae4fb4d12fd0">getClientList</a>();</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL) || defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#a20fc979ec9dbad5cce7f73e41b2e422e">deleteBond</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address);</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_device.html#a7fe0f568c17130150660e6307851be48">getNumBonds</a>();</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_device.html#a16bf4f5394735ed8d7f0bb32ca5d269a">isBonded</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_device.html#ab436502ecd044f8b3480ec3e824e1418">deleteAllBonds</a>();</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a> <a class="code" href="class_nim_b_l_e_device.html#ac7f090f4b1a2d593f38b20859e071f0c">getBondedAddress</a>(<span class="keywordtype">int</span> index);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="preprocessor">#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keyword">friend</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="l00165"></a><span class="lineno"> 165</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> onReset(<span class="keywordtype">int</span> reason);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> onSync(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> host_task(<span class="keywordtype">void</span> *param);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> m_synced;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_scan.html">NimBLEScan</a>* m_pScan;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* m_pServer;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; </div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>* m_bleAdvertising;</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;<span class="preprocessor">#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keyword">static</span> std::list &lt;NimBLEClient*&gt; m_cList;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keyword">static</span> std::list &lt;NimBLEAddress&gt; m_ignoreList;</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a>* m_securityCallbacks;</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keyword">static</span> uint32_t m_passkey;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keyword">static</span> ble_gap_event_listener m_listener;</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; <span class="keyword">static</span> gap_event_handler m_customGapHandler;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keyword">static</span> uint8_t m_own_addr_type;</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keyword">static</span> uint16_t m_scanDuplicateSize;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="keyword">static</span> uint8_t m_scanFilterMode;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <span class="keyword">static</span> std::vector&lt;NimBLEAddress&gt; m_whiteList;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;};</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; </div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// MAIN_NIMBLEDEVICE_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:34</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:83</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.h:41</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_device_html_a0374ab8e323277bd8498609559966924"><div class="ttname"><a href="class_nim_b_l_e_device.html#a0374ab8e323277bd8498609559966924">NimBLEDevice::removeIgnored</a></div><div class="ttdeci">static void removeIgnored(const NimBLEAddress &amp;address)</div><div class="ttdoc">Remove a device from the ignore list.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:1054</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a10aec48b56ef404f42ade96d6244b312"><div class="ttname"><a href="class_nim_b_l_e_device.html#a10aec48b56ef404f42ade96d6244b312">NimBLEDevice::getDisconnectedClient</a></div><div class="ttdeci">static NimBLEClient * getDisconnectedClient()</div><div class="ttdoc">Finds the first disconnected client in the list.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:261</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a14ebc6070a261d7a6518ad435b673962"><div class="ttname"><a href="class_nim_b_l_e_device.html#a14ebc6070a261d7a6518ad435b673962">NimBLEDevice::isIgnored</a></div><div class="ttdeci">static bool isIgnored(const NimBLEAddress &amp;address)</div><div class="ttdoc">Check if the device address is on our ignore list.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:1030</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a16bf4f5394735ed8d7f0bb32ca5d269a"><div class="ttname"><a href="class_nim_b_l_e_device.html#a16bf4f5394735ed8d7f0bb32ca5d269a">NimBLEDevice::isBonded</a></div><div class="ttdeci">static bool isBonded(const NimBLEAddress &amp;address)</div><div class="ttdoc">Checks if a peer device is bonded.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:505</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a1a6fb5e8f0e2cdc012ebae4fb4d12fd0"><div class="ttname"><a href="class_nim_b_l_e_device.html#a1a6fb5e8f0e2cdc012ebae4fb4d12fd0">NimBLEDevice::getClientList</a></div><div class="ttdeci">static std::list&lt; NimBLEClient * &gt; * getClientList()</div><div class="ttdoc">Get the list of created client objects.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:212</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a20fc979ec9dbad5cce7f73e41b2e422e"><div class="ttname"><a href="class_nim_b_l_e_device.html#a20fc979ec9dbad5cce7f73e41b2e422e">NimBLEDevice::deleteBond</a></div><div class="ttdeci">static bool deleteBond(const NimBLEAddress &amp;address)</div><div class="ttdoc">Deletes a peer bond.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:485</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a339157bf3d8fc712fa838e9a5127cc62"><div class="ttname"><a href="class_nim_b_l_e_device.html#a339157bf3d8fc712fa838e9a5127cc62">NimBLEDevice::startSecurity</a></div><div class="ttdeci">static int startSecurity(uint16_t conn_id)</div><div class="ttdoc">Start the connection securing and authorization for this connection.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:1011</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a34b50f12dc40ed47bdbb2b5ce4387a8c"><div class="ttname"><a href="class_nim_b_l_e_device.html#a34b50f12dc40ed47bdbb2b5ce4387a8c">NimBLEDevice::getPower</a></div><div class="ttdeci">static int getPower(esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT)</div><div class="ttdoc">Get the transmission power.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:326</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a41d4cc7c85cba0721c6649b001b31b4d"><div class="ttname"><a href="class_nim_b_l_e_device.html#a41d4cc7c85cba0721c6649b001b31b4d">NimBLEDevice::getServer</a></div><div class="ttdeci">static NimBLEServer * getServer()</div><div class="ttdoc">Get the instance of the server.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:91</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a4a2229e9e517b84773e65c75124b0789"><div class="ttname"><a href="class_nim_b_l_e_device.html#a4a2229e9e517b84773e65c75124b0789">NimBLEDevice::getWhiteListAddress</a></div><div class="ttdeci">static NimBLEAddress getWhiteListAddress(size_t index)</div><div class="ttdoc">Gets the address at the vector index.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:649</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a4d9780d0b5fafc279483822af802a508"><div class="ttname"><a href="class_nim_b_l_e_device.html#a4d9780d0b5fafc279483822af802a508">NimBLEDevice::createServer</a></div><div class="ttdeci">static NimBLEServer * createServer()</div><div class="ttdoc">Create a new instance of a server.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:75</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a5520cf3f544d571636eed162de394ec2"><div class="ttname"><a href="class_nim_b_l_e_device.html#a5520cf3f544d571636eed162de394ec2">NimBLEDevice::getMTU</a></div><div class="ttdeci">static uint16_t getMTU()</div><div class="ttdoc">Get local MTU value set.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:401</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a57f0d4db1cc564176b23e860fce13f6a"><div class="ttname"><a href="class_nim_b_l_e_device.html#a57f0d4db1cc564176b23e860fce13f6a">NimBLEDevice::setSecurityRespKey</a></div><div class="ttdeci">static void setSecurityRespKey(uint8_t init_key)</div><div class="ttdoc">Set the keys we are willing to accept during pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:938</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a674d2e68d4ba0e3f84d7993f9da7d15b"><div class="ttname"><a href="class_nim_b_l_e_device.html#a674d2e68d4ba0e3f84d7993f9da7d15b">NimBLEDevice::init</a></div><div class="ttdeci">static void init(const std::string &amp;deviceName)</div><div class="ttdoc">Initialize the BLE environment.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:738</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a732425c5c5f5b5b4730c1689700346c0"><div class="ttname"><a href="class_nim_b_l_e_device.html#a732425c5c5f5b5b4730c1689700346c0">NimBLEDevice::addIgnored</a></div><div class="ttdeci">static void addIgnored(const NimBLEAddress &amp;address)</div><div class="ttdoc">Add a device to the ignore list.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:1045</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a77f9f343143d4f074ffb545dd14cbb2b"><div class="ttname"><a href="class_nim_b_l_e_device.html#a77f9f343143d4f074ffb545dd14cbb2b">NimBLEDevice::getAddress</a></div><div class="ttdeci">static NimBLEAddress getAddress()</div><div class="ttdoc">Get our device address.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:356</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a7d44bb960c0bb1bec02a33369c693085"><div class="ttname"><a href="class_nim_b_l_e_device.html#a7d44bb960c0bb1bec02a33369c693085">NimBLEDevice::setSecurityCallbacks</a></div><div class="ttdeci">static void setSecurityCallbacks(NimBLESecurityCallbacks *pCallbacks)</div><div class="ttdoc">Set callbacks that will be used to handle encryption negotiation events and authentication events.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:966</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a7d8203040611e3f82bf4848a9b371e98"><div class="ttname"><a href="class_nim_b_l_e_device.html#a7d8203040611e3f82bf4848a9b371e98">NimBLEDevice::setMTU</a></div><div class="ttdeci">static int setMTU(uint16_t mtu)</div><div class="ttdoc">Setup local mtu that will be used to negotiate mtu during request from client peer.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:383</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a7fe0f568c17130150660e6307851be48"><div class="ttname"><a href="class_nim_b_l_e_device.html#a7fe0f568c17130150660e6307851be48">NimBLEDevice::getNumBonds</a></div><div class="ttdeci">static int getNumBonds()</div><div class="ttdoc">Gets the number of bonded peers stored.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:457</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a81abbad5e371fe1cdd91c002b42cc654"><div class="ttname"><a href="class_nim_b_l_e_device.html#a81abbad5e371fe1cdd91c002b42cc654">NimBLEDevice::whiteListRemove</a></div><div class="ttdeci">static bool whiteListRemove(const NimBLEAddress &amp;address)</div><div class="ttdoc">Remove a peer address from the whitelist.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:600</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a83aa0a3d9d57358d35082a442edf8549"><div class="ttname"><a href="class_nim_b_l_e_device.html#a83aa0a3d9d57358d35082a442edf8549">NimBLEDevice::deleteClient</a></div><div class="ttdeci">static bool deleteClient(NimBLEClient *pClient)</div><div class="ttdoc">Delete the client object and remove it from the list. Checks if it is connected or trying to connect ...</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:168</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a84631f6d657fb6bd39722560fa229d35"><div class="ttname"><a href="class_nim_b_l_e_device.html#a84631f6d657fb6bd39722560fa229d35">NimBLEDevice::setSecurityPasskey</a></div><div class="ttdeci">static void setSecurityPasskey(uint32_t pin)</div><div class="ttdoc">Set the passkey the server will ask for when pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:947</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a8b23c6ade03a69048f0568eb9ad3b034"><div class="ttname"><a href="class_nim_b_l_e_device.html#a8b23c6ade03a69048f0568eb9ad3b034">NimBLEDevice::stopAdvertising</a></div><div class="ttdeci">static void stopAdvertising()</div><div class="ttdoc">Convenience function to stop advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:121</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a8d4e1013815e7b021029f447f1702833"><div class="ttname"><a href="class_nim_b_l_e_device.html#a8d4e1013815e7b021029f447f1702833">NimBLEDevice::setCustomGapHandler</a></div><div class="ttdeci">static void setCustomGapHandler(gap_event_handler handler)</div><div class="ttdoc">Set a custom callback for gap events.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:1068</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a92d36c3a34d9474fa1d7f66c0e477d1e"><div class="ttname"><a href="class_nim_b_l_e_device.html#a92d36c3a34d9474fa1d7f66c0e477d1e">NimBLEDevice::setSecurityInitKey</a></div><div class="ttdeci">static void setSecurityInitKey(uint8_t init_key)</div><div class="ttdoc">If we are the initiator of the security procedure this sets the keys we will distribute.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:924</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_a9fdc368b81152a55599e2041181cef08"><div class="ttname"><a href="class_nim_b_l_e_device.html#a9fdc368b81152a55599e2041181cef08">NimBLEDevice::setScanDuplicateCacheSize</a></div><div class="ttdeci">static void setScanDuplicateCacheSize(uint16_t cacheSize)</div><div class="ttdoc">Set the duplicate filter cache size for filtering scanned devices.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:413</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_aa03937eadda020643b536c5d08174d3a"><div class="ttname"><a href="class_nim_b_l_e_device.html#aa03937eadda020643b536c5d08174d3a">NimBLEDevice::getSecurityPasskey</a></div><div class="ttdeci">static uint32_t getSecurityPasskey()</div><div class="ttdoc">Get the current passkey used for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:956</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_aa8e340c02418771ce72dec758d560938"><div class="ttname"><a href="class_nim_b_l_e_device.html#aa8e340c02418771ce72dec758d560938">NimBLEDevice::setSecurityAuth</a></div><div class="ttdeci">static void setSecurityAuth(bool bonding, bool mitm, bool sc)</div><div class="ttdoc">Set the authorization mode for this device.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:877</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_aa95f75d0a4325335ed0165f566d3a27d"><div class="ttname"><a href="class_nim_b_l_e_device.html#aa95f75d0a4325335ed0165f566d3a27d">NimBLEDevice::setOwnAddrType</a></div><div class="ttdeci">static void setOwnAddrType(uint8_t own_addr_type, bool useNRPA=false)</div><div class="ttdoc">Set the own address type.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:981</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_aa994b01b2b5bb9f677f3cffb2f05d140"><div class="ttname"><a href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140">NimBLEDevice::getAdvertising</a></div><div class="ttdeci">static NimBLEAdvertising * getAdvertising()</div><div class="ttdoc">Get the instance of the advertising object.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:102</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_aabc68166b6dd4a744a98f94e569f37db"><div class="ttname"><a href="class_nim_b_l_e_device.html#aabc68166b6dd4a744a98f94e569f37db">NimBLEDevice::whiteListAdd</a></div><div class="ttdeci">static bool whiteListAdd(const NimBLEAddress &amp;address)</div><div class="ttdoc">Add a peer address to the whitelist.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:569</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ab28cc2ec59fc9e62d05826633f53d2a0"><div class="ttname"><a href="class_nim_b_l_e_device.html#ab28cc2ec59fc9e62d05826633f53d2a0">NimBLEDevice::getWhiteListCount</a></div><div class="ttdeci">static size_t getWhiteListCount()</div><div class="ttdoc">Gets the count of addresses in the whitelist.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:639</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ab436502ecd044f8b3480ec3e824e1418"><div class="ttname"><a href="class_nim_b_l_e_device.html#ab436502ecd044f8b3480ec3e824e1418">NimBLEDevice::deleteAllBonds</a></div><div class="ttdeci">static void deleteAllBonds()</div><div class="ttdoc">Deletes all bonding information.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:474</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ab9fee9e810d5fa18bc8a37053eb9b5d0"><div class="ttname"><a href="class_nim_b_l_e_device.html#ab9fee9e810d5fa18bc8a37053eb9b5d0">NimBLEDevice::setSecurityIOCap</a></div><div class="ttdeci">static void setSecurityIOCap(uint8_t iocap)</div><div class="ttdoc">Set the Input/Output capabilities of this device.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:910</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_aba7ad0c41541428243d5c5e94b512c93"><div class="ttname"><a href="class_nim_b_l_e_device.html#aba7ad0c41541428243d5c5e94b512c93">NimBLEDevice::setScanFilterMode</a></div><div class="ttdeci">static void setScanFilterMode(uint8_t type)</div><div class="ttdoc">Set the duplicate filter mode for filtering scanned devices.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:440</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_abe21dcac43493689a06bc6ddb91b6faf"><div class="ttname"><a href="class_nim_b_l_e_device.html#abe21dcac43493689a06bc6ddb91b6faf">NimBLEDevice::getClientListSize</a></div><div class="ttdeci">static size_t getClientListSize()</div><div class="ttdoc">Get the number of created client objects.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:221</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_abf8c494b54d9f0c9466c80f25dbdd961"><div class="ttname"><a href="class_nim_b_l_e_device.html#abf8c494b54d9f0c9466c80f25dbdd961">NimBLEDevice::toString</a></div><div class="ttdeci">static std::string toString()</div><div class="ttdoc">Return a string representation of the address of this device.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:373</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ac4dbadc7fc170993e41532f675786504"><div class="ttname"><a href="class_nim_b_l_e_device.html#ac4dbadc7fc170993e41532f675786504">NimBLEDevice::getClientByPeerAddress</a></div><div class="ttdeci">static NimBLEClient * getClientByPeerAddress(const NimBLEAddress &amp;peer_addr)</div><div class="ttdoc">Get a reference to a client by peer address.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:247</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ac7adcd510eef2b9546bcde9a253e56a9"><div class="ttname"><a href="class_nim_b_l_e_device.html#ac7adcd510eef2b9546bcde9a253e56a9">NimBLEDevice::getClientByID</a></div><div class="ttdeci">static NimBLEClient * getClientByID(uint16_t conn_id)</div><div class="ttdoc">Get a reference to a client by connection ID.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:231</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ac7f090f4b1a2d593f38b20859e071f0c"><div class="ttname"><a href="class_nim_b_l_e_device.html#ac7f090f4b1a2d593f38b20859e071f0c">NimBLEDevice::getBondedAddress</a></div><div class="ttdeci">static NimBLEAddress getBondedAddress(int index)</div><div class="ttdoc">Get the address of a bonded peer device by index.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:531</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ac81f123fc1345596eb147c4fad125b1c"><div class="ttname"><a href="class_nim_b_l_e_device.html#ac81f123fc1345596eb147c4fad125b1c">NimBLEDevice::setPower</a></div><div class="ttdeci">static void setPower(esp_power_level_t powerLevel, esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT)</div><div class="ttdoc">Set the transmission power.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:298</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ad0bc1019facfd79291b5353ff970473d"><div class="ttname"><a href="class_nim_b_l_e_device.html#ad0bc1019facfd79291b5353ff970473d">NimBLEDevice::startAdvertising</a></div><div class="ttdeci">static void startAdvertising()</div><div class="ttdoc">Convenience function to begin advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:113</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ad6eda512195c7cbe249a1edbb99510cd"><div class="ttname"><a href="class_nim_b_l_e_device.html#ad6eda512195c7cbe249a1edbb99510cd">NimBLEDevice::getInitialized</a></div><div class="ttdeci">static bool getInitialized()</div><div class="ttdoc">Check if the initialization is complete.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:866</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ae51e2d4d6169a61133178a1b0d6b5b45"><div class="ttname"><a href="class_nim_b_l_e_device.html#ae51e2d4d6169a61133178a1b0d6b5b45">NimBLEDevice::onWhiteList</a></div><div class="ttdeci">static bool onWhiteList(const NimBLEAddress &amp;address)</div><div class="ttdoc">Checks if a peer device is whitelisted.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:553</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_ae95693ce0f5b8e784ea8e10834dd624c"><div class="ttname"><a href="class_nim_b_l_e_device.html#ae95693ce0f5b8e784ea8e10834dd624c">NimBLEDevice::deinit</a></div><div class="ttdeci">static void deinit(bool clearAll=false)</div><div class="ttdoc">Shutdown the NimBLE stack/controller.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:810</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_af8142995252f486916dbb9de2a5b0c9e"><div class="ttname"><a href="class_nim_b_l_e_device.html#af8142995252f486916dbb9de2a5b0c9e">NimBLEDevice::createClient</a></div><div class="ttdeci">static NimBLEClient * createClient(NimBLEAddress peerAddress=NimBLEAddress(&quot;&quot;))</div><div class="ttdoc">Creates a new client object and maintains a list of all client objects each client can connect to 1 p...</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:150</div></div>
<div class="ttc" id="aclass_nim_b_l_e_device_html_af93d92316454b051125460056368baec"><div class="ttname"><a href="class_nim_b_l_e_device.html#af93d92316454b051125460056368baec">NimBLEDevice::getScan</a></div><div class="ttdeci">static NimBLEScan * getScan()</div><div class="ttdoc">Retrieve the Scan object that we use for scanning.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.cpp:133</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_security_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a></div><div class="ttdoc">Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibi...</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.h:88</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</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>NimBLEDevice.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>

View File

@@ -0,0 +1,172 @@
<!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/NimBLEEddystoneTLM.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_eddystone_t_l_m_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">NimBLEEddystoneTLM.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEEddystoneTLM.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 15 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEEddystoneTLM.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Mar 12, 2018</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: pcbreflux</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef _NimBLEEddystoneTLM_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define _NimBLEEddystoneTLM_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define EDDYSTONE_TLM_FRAME_TYPE 0x20</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_eddystone_t_l_m.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a4d87d0b11420af2ae04bc4e6ce2f8607">NimBLEEddystoneTLM</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; std::string <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">getData</a>();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">getUUID</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">getVersion</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">getVolt</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">float</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">getTemp</a>();</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; uint32_t <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">getCount</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; uint32_t <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">getTime</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; std::string <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">toString</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">setData</a>(<span class="keyword">const</span> std::string &amp;data);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">setUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;l_uuid);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">setVersion</a>(uint8_t version);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206">setVolt</a>(uint16_t volt);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">setTemp</a>(<span class="keywordtype">float</span> temp);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">setCount</a>(uint32_t advCount);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">setTime</a>(uint32_t tmil);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint16_t beaconUUID;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; uint8_t frameType;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint8_t version;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uint16_t volt;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint16_t temp;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint32_t advCount;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uint32_t tmil;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; } __attribute__((packed)) m_eddystoneData;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}; <span class="comment">// NimBLEEddystoneTLM</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _NimBLEEddystoneTLM_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></div><div class="ttdoc">Representation of a beacon. See:</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.h:28</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a160e33218dc7fb33f678cda1605da52e"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">NimBLEEddystoneTLM::setData</a></div><div class="ttdeci">void setData(const std::string &amp;data)</div><div class="ttdoc">Set the raw data for the beacon advertisment.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:162</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a205e0e2efc09c4c5043f11aeddee4d63"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">NimBLEEddystoneTLM::setVersion</a></div><div class="ttdeci">void setVersion(uint8_t version)</div><div class="ttdoc">Set the version to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:185</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a49fdfb7c2edf2ae92f69856ec0ce4291"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">NimBLEEddystoneTLM::setUUID</a></div><div class="ttdeci">void setUUID(const NimBLEUUID &amp;l_uuid)</div><div class="ttdoc">Set the UUID to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:176</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a4d87d0b11420af2ae04bc4e6ce2f8607"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a4d87d0b11420af2ae04bc4e6ce2f8607">NimBLEEddystoneTLM::NimBLEEddystoneTLM</a></div><div class="ttdeci">NimBLEEddystoneTLM()</div><div class="ttdoc">Construct a default EddystoneTLM beacon object.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:30</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a556a6b6a75693997390f3bacf6e5ca5e"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">NimBLEEddystoneTLM::getCount</a></div><div class="ttdeci">uint32_t getCount()</div><div class="ttdoc">Get the count of advertisments sent.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:89</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a6d033c09a513b2dfdad6f1b962b906a8"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">NimBLEEddystoneTLM::setCount</a></div><div class="ttdeci">void setCount(uint32_t advCount)</div><div class="ttdoc">Set the advertisment count.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:212</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a8e8ee8fff10730089a370f9da7b6a691"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">NimBLEEddystoneTLM::setTemp</a></div><div class="ttdeci">void setTemp(float temp)</div><div class="ttdoc">Set the temperature to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:203</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a970ba10424567d17c961ed3b3ef83d8e"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">NimBLEEddystoneTLM::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Get a string representation of the beacon.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:107</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_a999d53f4bad59c2ebc688403f66474b1"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">NimBLEEddystoneTLM::setTime</a></div><div class="ttdeci">void setTime(uint32_t tmil)</div><div class="ttdoc">Set the advertisment time.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:221</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_aa511375f22952c0f5846a51e6c2511c5"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">NimBLEEddystoneTLM::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Get the UUID being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:54</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_ab1c4a13c2f57a6e0293810dd09be3db3"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">NimBLEEddystoneTLM::getTime</a></div><div class="ttdeci">uint32_t getTime()</div><div class="ttdoc">Get the advertisment time.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:98</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_abda56940f7d9f7ccef2629b75880dd5f"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">NimBLEEddystoneTLM::getTemp</a></div><div class="ttdeci">float getTemp()</div><div class="ttdoc">Get the temperature being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:81</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_ad69af8fe47502d922203916357f6c206"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206">NimBLEEddystoneTLM::setVolt</a></div><div class="ttdeci">void setVolt(uint16_t volt)</div><div class="ttdoc">Set the battery voltage to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:194</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_ae146a8f066ef3fc6994070654ec5d7ea"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">NimBLEEddystoneTLM::getData</a></div><div class="ttdeci">std::string getData()</div><div class="ttdoc">Retrieve the data that is being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_ae9f17d2c1e4150775881babb73f0b10c"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">NimBLEEddystoneTLM::getVersion</a></div><div class="ttdeci">uint8_t getVersion()</div><div class="ttdoc">Get the version being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:63</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_t_l_m_html_af9862f983df6f48a96220e936d13d17b"><div class="ttname"><a href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">NimBLEEddystoneTLM::getVolt</a></div><div class="ttdeci">uint16_t getVolt()</div><div class="ttdoc">Get the battery voltage.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneTLM.cpp:72</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:31</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>NimBLEEddystoneTLM.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>

View File

@@ -0,0 +1,158 @@
<!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/NimBLEEddystoneURL.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_eddystone_u_r_l_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">NimBLEEddystoneURL.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEEddystoneURL.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 15 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEEddystoneURL.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Mar 12, 2018</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: pcbreflux</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef _NIMBLEEddystoneURL_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define _NIMBLEEddystoneURL_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define EDDYSTONE_URL_FRAME_TYPE 0x10</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_eddystone_u_r_l.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#ae102214d20e32e31c9c84d723f67df15">NimBLEEddystoneURL</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; std::string <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">getData</a>();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">getUUID</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; int8_t <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">getPower</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::string <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">getURL</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; std::string <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">getDecodedURL</a>();</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">setData</a>(<span class="keyword">const</span> std::string &amp;data);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">setUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;l_uuid);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">setPower</a>(int8_t advertisedTxPower);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">setURL</a>(<span class="keyword">const</span> std::string &amp;url);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint16_t beaconUUID;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint8_t lengthURL;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; uint8_t frameType;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; int8_t advertisedTxPower;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint8_t url[16];</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; } __attribute__((packed)) m_eddystoneData;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;}; <span class="comment">// NIMBLEEddystoneURL</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _NIMBLEEddystoneURL_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></div><div class="ttdoc">Representation of a beacon. See:</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.h:28</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_a0109874399f3e70a72ee9f4a909710e1"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">NimBLEEddystoneURL::getURL</a></div><div class="ttdeci">std::string getURL()</div><div class="ttdoc">Get the raw URL being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:68</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_a1fde0fcf7d90f79e0eb718967518247a"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">NimBLEEddystoneURL::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Get the UUID being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:50</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_a42583c740bbdb9591422e8770f8bd0d5"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">NimBLEEddystoneURL::getPower</a></div><div class="ttdeci">int8_t getPower()</div><div class="ttdoc">Get the transmit power being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:59</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_a8038c895e8da7c7ac861557ea0a9d91b"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">NimBLEEddystoneURL::setPower</a></div><div class="ttdeci">void setPower(int8_t advertisedTxPower)</div><div class="ttdoc">Set the transmit power to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:183</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_a8102533ff1e7b6527ea744279f8f64ca"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">NimBLEEddystoneURL::setURL</a></div><div class="ttdeci">void setURL(const std::string &amp;url)</div><div class="ttdoc">Set the URL to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:192</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_a8b68cc96a84da85e20d8583ba375c2ff"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">NimBLEEddystoneURL::getDecodedURL</a></div><div class="ttdeci">std::string getDecodedURL()</div><div class="ttdoc">Get the full URL being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:77</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_ac32c7066ce1ee8d495a35ec870f0e7bf"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">NimBLEEddystoneURL::getData</a></div><div class="ttdeci">std::string getData()</div><div class="ttdoc">Retrieve the data that is being advertised.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_ada3ac4a544b8565635871f39f1593811"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">NimBLEEddystoneURL::setData</a></div><div class="ttdeci">void setData(const std::string &amp;data)</div><div class="ttdoc">Set the raw data for the beacon advertisment.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:158</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_ae102214d20e32e31c9c84d723f67df15"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#ae102214d20e32e31c9c84d723f67df15">NimBLEEddystoneURL::NimBLEEddystoneURL</a></div><div class="ttdeci">NimBLEEddystoneURL()</div><div class="ttdoc">Construct a default EddystoneURL beacon object.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:28</div></div>
<div class="ttc" id="aclass_nim_b_l_e_eddystone_u_r_l_html_af183e8483ae81fff65d909e67986fcad"><div class="ttname"><a href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">NimBLEEddystoneURL::setUUID</a></div><div class="ttdeci">void setUUID(const NimBLEUUID &amp;l_uuid)</div><div class="ttdoc">Set the UUID to advertise.</div><div class="ttdef"><b>Definition:</b> NimBLEEddystoneURL.cpp:174</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:31</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>NimBLEEddystoneURL.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>

View File

@@ -0,0 +1,207 @@
<!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/NimBLEHIDDevice.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_h_i_d_device_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">NimBLEHIDDevice.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEHIDDevice.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Oct 06 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author wakwak-koba</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEHIDDevice.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jan 03, 2018</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: chegewara</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef _BLEHIDDEVICE_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define _BLEHIDDEVICE_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLECharacteristic.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;NimBLEService.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;NimBLEDescriptor.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;HIDTypes.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define GENERIC_HID 0x03C0</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define HID_KEYBOARD 0x03C1</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#define HID_MOUSE 0x03C2</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define HID_JOYSTICK 0x03C3</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define HID_GAMEPAD 0x03C4</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define HID_TABLET 0x03C5</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define HID_CARD_READER 0x03C6</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define HID_DIGITAL_PEN 0x03C7</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define HID_BARCODE 0x03C8</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_h_i_d_device.html"> 43</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">NimBLEHIDDevice</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>*);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">reportMap</a>(uint8_t* map, uint16_t);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a5984042cd05ea4ead895f5577133a235">startServices</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a033c4ad91f1bc165ac6a322b4dcc1699">deviceInfo</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#ae80cf58c481c25bd6d7392a43b6fa48b">hidService</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a24498f7b714574ab4a90288f7e4d58b7">batteryService</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c">manufacturer</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c">manufacturer</a>(std::string name);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">//NimBLECharacteristic* pnp();</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">pnp</a>(uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">//NimBLECharacteristic* hidInfo();</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">hidInfo</a>(uint8_t country, uint8_t flags);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">//NimBLECharacteristic* batteryLevel();</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">setBatteryLevel</a>(uint8_t level);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">//NimBLECharacteristic* reportMap();</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a5c42da43e0b8dfcd1d045e8a86d0b5a2">hidControl</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">inputReport</a>(uint8_t reportID);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">outputReport</a>(uint8_t reportID);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">featureReport</a>(uint8_t reportID);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a1118c1e730f38b8b17795c8eb41a0861">protocolMode</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#a45ca7d4547dfea9a64987065d83653bd">bootInput</a>();</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_h_i_d_device.html#ace0141db690f1afec1b266f9ac9aa0f0">bootOutput</a>();</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* m_deviceInfoService; <span class="comment">//0x180a</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* m_hidService; <span class="comment">//0x1812</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* m_batteryService = 0; <span class="comment">//0x180f</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_manufacturerCharacteristic; <span class="comment">//0x2a29</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_pnpCharacteristic; <span class="comment">//0x2a50</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_hidInfoCharacteristic; <span class="comment">//0x2a4a</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_reportMapCharacteristic; <span class="comment">//0x2a4b</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_hidControlCharacteristic; <span class="comment">//0x2a4c</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_protocolModeCharacteristic; <span class="comment">//0x2a4e</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_batteryLevelCharacteristic; <span class="comment">//0x2a19</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;};</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_NIMBLE_ROLE_BROADCASTER</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _BLEHIDDEVICE_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></div><div class="ttdoc">A model of a BLE Human Interface Device.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.h:43</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a033c4ad91f1bc165ac6a322b4dcc1699"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a033c4ad91f1bc165ac6a322b4dcc1699">NimBLEHIDDevice::deviceInfo</a></div><div class="ttdeci">NimBLEService * deviceInfo()</div><div class="ttdoc">Returns a pointer to the device information service.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:232</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a1118c1e730f38b8b17795c8eb41a0861"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a1118c1e730f38b8b17795c8eb41a0861">NimBLEHIDDevice::protocolMode</a></div><div class="ttdeci">NimBLECharacteristic * protocolMode()</div><div class="ttdoc">Returns a pointer to the protocol mode characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:194</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a24498f7b714574ab4a90288f7e4d58b7"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a24498f7b714574ab4a90288f7e4d58b7">NimBLEHIDDevice::batteryService</a></div><div class="ttdeci">NimBLEService * batteryService()</div><div class="ttdoc">Returns a pointer to the battery service.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:246</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a33fc2bfc990ecd250859ca8f34a4314e"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">NimBLEHIDDevice::hidInfo</a></div><div class="ttdeci">void hidInfo(uint8_t country, uint8_t flags)</div><div class="ttdoc">Sets the HID Information characteristic value.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:120</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a3e5b8291ca88d85a352429415abaec9c"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c">NimBLEHIDDevice::manufacturer</a></div><div class="ttdeci">NimBLECharacteristic * manufacturer()</div><div class="ttdoc">Create a manufacturer characteristic (this characteristic is optional).</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:90</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a45ca7d4547dfea9a64987065d83653bd"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a45ca7d4547dfea9a64987065d83653bd">NimBLEHIDDevice::bootInput</a></div><div class="ttdeci">NimBLECharacteristic * bootInput()</div><div class="ttdoc">Creates a keyboard boot input report characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:173</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a468e599c7d75e691f8d34e1b24db8a38"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">NimBLEHIDDevice::featureReport</a></div><div class="ttdeci">NimBLECharacteristic * featureReport(uint8_t reportID)</div><div class="ttdoc">Create feature report characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:160</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a5309df317aa42de7ced2e34219b6666a"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">NimBLEHIDDevice::pnp</a></div><div class="ttdeci">void pnp(uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)</div><div class="ttdoc">Sets the Plug n Play characterisc value.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:110</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a5984042cd05ea4ead895f5577133a235"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a5984042cd05ea4ead895f5577133a235">NimBLEHIDDevice::startServices</a></div><div class="ttdeci">void startServices()</div><div class="ttdoc">Start the HID device services. This function called when all the services have been created.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:81</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a5c42da43e0b8dfcd1d045e8a86d0b5a2"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a5c42da43e0b8dfcd1d045e8a86d0b5a2">NimBLEHIDDevice::hidControl</a></div><div class="ttdeci">NimBLECharacteristic * hidControl()</div><div class="ttdoc">Returns a pointer to the HID control point characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:187</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a5e996a1668785f7a978f9874b4ff3b3e"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">NimBLEHIDDevice::reportMap</a></div><div class="ttdeci">void reportMap(uint8_t *map, uint16_t)</div><div class="ttdoc">Set the report map data formatting information.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:73</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a84e3127a05f7e6a44761ec4a9e7668e3"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">NimBLEHIDDevice::setBatteryLevel</a></div><div class="ttdeci">void setBatteryLevel(uint8_t level)</div><div class="ttdoc">Set the battery level characteristic value.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:202</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a91cfe81b47cea229e9bbe3c55be33701"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">NimBLEHIDDevice::inputReport</a></div><div class="ttdeci">NimBLECharacteristic * inputReport(uint8_t reportID)</div><div class="ttdoc">Create input report characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:130</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_a95b4935280494ffa24bfae89753f199a"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">NimBLEHIDDevice::NimBLEHIDDevice</a></div><div class="ttdeci">NimBLEHIDDevice(NimBLEServer *)</div><div class="ttdoc">Construct a default NimBLEHIDDevice object.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:27</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_ac1e63972c6a77665a6bbc76f9ff4a717"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">NimBLEHIDDevice::outputReport</a></div><div class="ttdeci">NimBLECharacteristic * outputReport(uint8_t reportID)</div><div class="ttdoc">Create output report characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:145</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_ace0141db690f1afec1b266f9ac9aa0f0"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#ace0141db690f1afec1b266f9ac9aa0f0">NimBLEHIDDevice::bootOutput</a></div><div class="ttdeci">NimBLECharacteristic * bootOutput()</div><div class="ttdoc">Create a keyboard boot output report characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:180</div></div>
<div class="ttc" id="aclass_nim_b_l_e_h_i_d_device_html_ae80cf58c481c25bd6d7392a43b6fa48b"><div class="ttname"><a href="class_nim_b_l_e_h_i_d_device.html#ae80cf58c481c25bd6d7392a43b6fa48b">NimBLEHIDDevice::hidService</a></div><div class="ttdeci">NimBLEService * hidService()</div><div class="ttdoc">Returns a pointer to the HID service.</div><div class="ttdef"><b>Definition:</b> NimBLEHIDDevice.cpp:239</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.h:36</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>NimBLEHIDDevice.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>

View File

@@ -0,0 +1,165 @@
<!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/NimBLELog.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_log_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">NimBLELog.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLELog.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Feb 24 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLELOG_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define MAIN_NIMBLELOG_H_</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifdef ARDUINO_ARCH_ESP32</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;syscfg/syscfg.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;modlog/modlog.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// If Arduino is being used, strip out the colors and ignore log printing below ui setting.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">// Note: because CONFIG_LOG_DEFAULT_LEVEL is set at ERROR in Arduino we must use MODLOG_DFLT(ERROR</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// otherwise no messages will be printed above that level.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef CORE_DEBUG_LEVEL</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define CORE_DEBUG_LEVEL CONFIG_ARDUHAL_LOG_DEFAULT_LEVEL</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#if CORE_DEBUG_LEVEL &gt;= 4</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define NIMBLE_LOGD( tag, format, ... ) MODLOG_DFLT(ERROR, &quot;D %s: &quot;</span>#format&quot;\n&quot;,tag,##__VA_ARGS__)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define NIMBLE_LOGD( tag, format, ... ) (void)tag</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#if CORE_DEBUG_LEVEL &gt;= 3</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define NIMBLE_LOGI( tag, format, ... ) MODLOG_DFLT(ERROR, &quot;I %s: &quot;</span>#format&quot;\n&quot;,tag,##__VA_ARGS__)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define NIMBLE_LOGI( tag, format, ... ) (void)tag</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#if CORE_DEBUG_LEVEL &gt;= 2</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define NIMBLE_LOGW( tag, format, ... ) MODLOG_DFLT(ERROR, &quot;W %s: &quot;</span>#format&quot;\n&quot;,tag,##__VA_ARGS__)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define NIMBLE_LOGW( tag, format, ... ) (void)tag</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#if CORE_DEBUG_LEVEL &gt;= 1</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define NIMBLE_LOGE( tag, format, ... ) MODLOG_DFLT(ERROR, &quot;E %s: &quot;</span>#format&quot;\n&quot;,tag,##__VA_ARGS__)</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define NIMBLE_LOGE( tag, format, ... ) (void)tag</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#define NIMBLE_LOGC( tag, format, ... ) MODLOG_DFLT(CRITICAL, &quot;CRIT %s: &quot;</span>#format&quot;\n&quot;,tag,##__VA_ARGS__)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#include &quot;esp_log.h&quot;</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#define NIMBLE_LOGE(tag, format, ...) ESP_LOGE(tag, format, ##__VA_ARGS__)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#define NIMBLE_LOGW(tag, format, ...) ESP_LOGW(tag, format, ##__VA_ARGS__)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#define NIMBLE_LOGI(tag, format, ...) ESP_LOGI(tag, format, ##__VA_ARGS__)</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#define NIMBLE_LOGD(tag, format, ...) ESP_LOGD(tag, format, ##__VA_ARGS__)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#define NIMBLE_LOGC(tag, format, ...) ESP_LOGE(tag, format, ##__VA_ARGS__)</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/*ARDUINO_ARCH_ESP32*/</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/*CONFIG_BT_ENABLED*/</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/*MAIN_NIMBLELOG_H_*/</span><span class="preprocessor"></span></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>NimBLELog.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>

View File

@@ -0,0 +1,280 @@
<!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/NimBLERemoteCharacteristic.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_remote_characteristic_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">NimBLERemoteCharacteristic.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLERemoteCharacteristic.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 27 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLERemoteCharacteristic.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jul 8, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEREMOTECHARACTERISTIC_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEREMOTECHARACTERISTIC_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLERemoteService.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLERemoteDescriptor.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">typedef</span> std::function&lt;void (<a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* pBLERemoteCharacteristic,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; uint8_t* pData, <span class="keywordtype">size_t</span> length, <span class="keywordtype">bool</span> isNotify)&gt; notify_callback;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> *uuid;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">void</span> *task_data;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;} desc_filter_t;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html"> 45</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a855d591de111b09013ae83c4043d06ed">~NimBLERemoteCharacteristic</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// Public member functions</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7163009a9f0ff718b5856d19cb4a3568">canBroadcast</a>();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a53322384b295a2548b3399e2c63d76f4">canIndicate</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a9c41acdbf23dc036f321d4f0a66d40d1">canNotify</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a0eb6655635394268a76c68e845d14135">canRead</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aae71c20d300ead52770e66fb8a1a47ea">canWrite</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a2614c7f437b52f385fc4fd29abe358eb">canWriteNoResponse</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; std::vector&lt;NimBLERemoteDescriptor*&gt;::iterator <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442">begin</a>();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; std::vector&lt;NimBLERemoteDescriptor*&gt;::iterator <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873">end</a>();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a>* <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a6178e1c58361b957be3c48548c1c4366">getDescriptor</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; std::vector&lt;NimBLERemoteDescriptor*&gt;* <a class="code" href="class_nim_b_l_e_remote_characteristic.html#acf11d225fe5a25327742349e9d6061f9">getDescriptors</a>(<span class="keywordtype">bool</span> refresh = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a5f0a51b4a7fb2244d236dcb96fcf5205">deleteDescriptors</a>();</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aad0ba99cad9779b33ea7cd4e94349099">deleteDescriptor</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6">getHandle</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380">getDefHandle</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb">getUUID</a>();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; std::string <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>(time_t *timestamp = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0"> 77</a></span>&#160; T <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0">readValue</a>(time_t *timestamp = <span class="keyword">nullptr</span>, <span class="keywordtype">bool</span> skipSizeCheck = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; std::string value = <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>(timestamp);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; value.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = value.data();</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; }</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080">readUInt8</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>&lt;uint8_t&gt;()&quot;)));</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d">readUInt16</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>&lt;uint16_t&gt;()&quot;)));</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; uint32_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d">readUInt32</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>&lt;uint32_t&gt;()&quot;)));</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">float</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef">readFloat</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>&lt;<span class="keywordtype">float</span>&gt;()&quot;)));</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; std::<span class="keywordtype">string</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">getValue</a>(time_t *timestamp = <span class="keywordtype">nullptr</span>);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; template&lt;typename T&gt;</div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b"> 100</a></span>&#160; T <a class="code" href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">getValue</a>(time_t *timestamp = <span class="keywordtype">nullptr</span>, <span class="keywordtype">bool</span> skipSizeCheck = false) {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; std::string value = <a class="code" href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">getValue</a>(timestamp);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; value.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = value.data();</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; }</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">subscribe</a>(<span class="keywordtype">bool</span> notifications = <span class="keyword">true</span>,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; notify_callback notifyCallback = <span class="keyword">nullptr</span>,</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">unsubscribe</a>(<span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#ab4f54eabe90a416546b7b3fc3477f49c">registerForNotify</a>(notify_callback notifyCallback,</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordtype">bool</span> notifications = <span class="keyword">true</span>,</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">bool</span> response = <span class="keyword">true</span>)</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; __attribute__ ((deprecated(&quot;Use <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">subscribe</a>()/<a class="code" href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">unsubscribe</a>()&quot;)));</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(const uint8_t* data,</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">size_t</span> length,</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordtype">bool</span> response = false);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(const std::<span class="keywordtype">string</span> &amp;newValue,</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordtype">bool</span> response = false);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; template&lt;typename T&gt;</div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae"> 126</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(const T &amp;s, <span class="keywordtype">bool</span> response = false) {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>((uint8_t*)&amp;s, <span class="keyword">sizeof</span>(T), response);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; std::string <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a">toString</a>();</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a943183a55b020de9e09ac2cfaebcde32">getRemoteService</a>();</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>(<a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> *pRemoteservice, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_chr *chr);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="comment">// Private member functions</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">bool</span> setNotify(uint16_t val, notify_callback notifyCallback = <span class="keyword">nullptr</span>, <span class="keywordtype">bool</span> response = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordtype">bool</span> retrieveDescriptors(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> *uuid_filter = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> onReadCB(uint16_t conn_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">struct</span> ble_gatt_attr *attr, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> onWriteCB(uint16_t conn_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keyword">struct</span> ble_gatt_attr *attr, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> descriptorDiscCB(uint16_t conn_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; uint16_t chr_val_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_dsc *dsc,</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> nextCharCB(uint16_t conn_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_chr *chr, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="comment">// Private properties</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; uint8_t m_charProp;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; uint16_t m_handle;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; uint16_t m_defHandle;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; uint16_t m_endHandle;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* m_pRemoteService;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; std::string m_value;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; notify_callback m_notifyCallback;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; time_t m_timestamp;</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; portMUX_TYPE m_valMux;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="comment">// We maintain a vector of descriptors owned by this characteristic.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; std::vector&lt;NimBLERemoteDescriptor*&gt; m_descriptorVector;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;}; <span class="comment">// NimBLERemoteCharacteristic</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLEREMOTECHARACTERISTIC_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></div><div class="ttdoc">A model of a remote BLE characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0eb6655635394268a76c68e845d14135"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0eb6655635394268a76c68e845d14135">NimBLERemoteCharacteristic::canRead</a></div><div class="ttdeci">bool canRead()</div><div class="ttdoc">Does the characteristic support reading?</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:118</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a181c54862bc422d8ad0b326af675922d"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d">NimBLERemoteCharacteristic::readUInt16</a></div><div class="ttdeci">uint16_t readUInt16() __attribute__((deprecated(&quot;Use template readValue&lt;uint16_t&gt;()&quot;)))</div><div class="ttdoc">Read an unsigned 16 bit value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:427</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a2614c7f437b52f385fc4fd29abe358eb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a2614c7f437b52f385fc4fd29abe358eb">NimBLERemoteCharacteristic::canWriteNoResponse</a></div><div class="ttdeci">bool canWriteNoResponse()</div><div class="ttdoc">Does the characteristic support writing with no response?</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:136</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a333adea9c9f243774c6a2f13beabd873"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873">NimBLERemoteCharacteristic::end</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator end()</div><div class="ttdoc">Get iterator to the end of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:365</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a3c8d1fd77dd074df866c091c614eafb3"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">NimBLERemoteCharacteristic::writeValue</a></div><div class="ttdeci">bool writeValue(const uint8_t *data, size_t length, bool response=false)</div><div class="ttdoc">Write the new value for the characteristic from a data buffer.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:726</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a463760cabc9ca104a6fe094eb942fec0"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0">NimBLERemoteCharacteristic::readValue</a></div><div class="ttdeci">T readValue(time_t *timestamp=nullptr, bool skipSizeCheck=false)</div><div class="ttdoc">A template to convert the remote characteristic data to &lt;type&gt;.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:77</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a4b86a1f600a61036487f5161f1f1726a"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a">NimBLERemoteCharacteristic::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Convert a NimBLERemoteCharacteristic to a string representation;.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:686</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a53322384b295a2548b3399e2c63d76f4"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a53322384b295a2548b3399e2c63d76f4">NimBLERemoteCharacteristic::canIndicate</a></div><div class="ttdeci">bool canIndicate()</div><div class="ttdoc">Does the characteristic support indications?</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:100</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a5f0a51b4a7fb2244d236dcb96fcf5205"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a5f0a51b4a7fb2244d236dcb96fcf5205">NimBLERemoteCharacteristic::deleteDescriptors</a></div><div class="ttdeci">void deleteDescriptors()</div><div class="ttdoc">Delete the descriptors in the descriptor vector.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:649</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a6178e1c58361b957be3c48548c1c4366"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a6178e1c58361b957be3c48548c1c4366">NimBLERemoteCharacteristic::getDescriptor</a></div><div class="ttdeci">NimBLERemoteDescriptor * getDescriptor(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Get the descriptor instance with the given UUID that belongs to this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:297</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a6e331afdbdbc32bf461c9866236a97aa"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">NimBLERemoteCharacteristic::unsubscribe</a></div><div class="ttdeci">bool unsubscribe(bool response=false)</div><div class="ttdoc">Unsubscribe for notifications or indications.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:618</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a7163009a9f0ff718b5856d19cb4a3568"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a7163009a9f0ff718b5856d19cb4a3568">NimBLERemoteCharacteristic::canBroadcast</a></div><div class="ttdeci">bool canBroadcast()</div><div class="ttdoc">Does the characteristic support broadcasting?</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:91</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a71793454ffab034f87af3a5e9677a63d"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d">NimBLERemoteCharacteristic::readUInt32</a></div><div class="ttdeci">uint32_t readUInt32() __attribute__((deprecated(&quot;Use template readValue&lt;uint32_t&gt;()&quot;)))</div><div class="ttdoc">Read an unsigned 32 bit value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:437</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a78ac88ca25d71dfe31b95898b79b0442"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442">NimBLERemoteCharacteristic::begin</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator begin()</div><div class="ttdoc">Get iterator to the beginning of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:356</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a7e10fa37095d7c80dc36c768fe783e67"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">NimBLERemoteCharacteristic::readValue</a></div><div class="ttdeci">std::string readValue(time_t *timestamp=nullptr)</div><div class="ttdoc">Read the value of the remote characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:466</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a81f39759d48a8fb792c94e4b3b455eef"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef">NimBLERemoteCharacteristic::readFloat</a></div><div class="ttdeci">float readFloat() __attribute__((deprecated(&quot;Use template readValue&lt;float&gt;()&quot;)))</div><div class="ttdoc">Read a float value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:456</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a855d591de111b09013ae83c4043d06ed"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a855d591de111b09013ae83c4043d06ed">NimBLERemoteCharacteristic::~NimBLERemoteCharacteristic</a></div><div class="ttdeci">~NimBLERemoteCharacteristic()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:72</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a943183a55b020de9e09ac2cfaebcde32"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a943183a55b020de9e09ac2cfaebcde32">NimBLERemoteCharacteristic::getRemoteService</a></div><div class="ttdeci">NimBLERemoteService * getRemoteService()</div><div class="ttdoc">Get the remote service associated with this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:391</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a9c41acdbf23dc036f321d4f0a66d40d1"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a9c41acdbf23dc036f321d4f0a66d40d1">NimBLERemoteCharacteristic::canNotify</a></div><div class="ttdeci">bool canNotify()</div><div class="ttdoc">Does the characteristic support notifications?</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:109</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aa08b2f62376568e1fc833e4ff91e8aa7"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">NimBLERemoteCharacteristic::subscribe</a></div><div class="ttdeci">bool subscribe(bool notifications=true, notify_callback notifyCallback=nullptr, bool response=false)</div><div class="ttdoc">Subscribe for notifications or indications.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:604</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aad0ba99cad9779b33ea7cd4e94349099"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aad0ba99cad9779b33ea7cd4e94349099">NimBLERemoteCharacteristic::deleteDescriptor</a></div><div class="ttdeci">size_t deleteDescriptor(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Delete descriptor by UUID.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:665</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aae71c20d300ead52770e66fb8a1a47ea"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aae71c20d300ead52770e66fb8a1a47ea">NimBLERemoteCharacteristic::canWrite</a></div><div class="ttdeci">bool canWrite()</div><div class="ttdoc">Does the characteristic support writing?</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:127</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ab46121a8f5000c40d521e7ee5d92bee6"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6">NimBLERemoteCharacteristic::getHandle</a></div><div class="ttdeci">uint16_t getHandle()</div><div class="ttdoc">Get the handle for this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:374</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ab4f54eabe90a416546b7b3fc3477f49c"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ab4f54eabe90a416546b7b3fc3477f49c">NimBLERemoteCharacteristic::registerForNotify</a></div><div class="ttdeci">bool registerForNotify(notify_callback notifyCallback, bool notifications=true, bool response=true) __attribute__((deprecated(&quot;Use subscribe()/unsubscribe()&quot;)))</div><div class="ttdoc">backward-compatibility method for subscribe/unsubscribe notifications/indications</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:632</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_acf11d225fe5a25327742349e9d6061f9"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#acf11d225fe5a25327742349e9d6061f9">NimBLERemoteCharacteristic::getDescriptors</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt; * getDescriptors(bool refresh=false)</div><div class="ttdoc">Get a pointer to the vector of found descriptors.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:337</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ad62c63468995a24d736c4176c9607eeb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb">NimBLERemoteCharacteristic::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Get the UUID for this characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:400</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_add1a1daed14b5f3e729e284dbd369257"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">NimBLERemoteCharacteristic::getValue</a></div><div class="ttdeci">std::string getValue(time_t *timestamp=nullptr)</div><div class="ttdoc">Get the value of the remote characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:410</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ade5c6ae280c3cf36c9905be23df8f080"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080">NimBLERemoteCharacteristic::readUInt8</a></div><div class="ttdeci">uint8_t readUInt8() __attribute__((deprecated(&quot;Use template readValue&lt;uint8_t&gt;()&quot;)))</div><div class="ttdoc">Read a byte value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:447</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aebbcd36740e49d7e29eb5b21d6802380"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380">NimBLERemoteCharacteristic::getDefHandle</a></div><div class="ttdeci">uint16_t getDefHandle()</div><div class="ttdoc">Get the handle for this characteristics definition.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:382</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></div><div class="ttdoc">A model of remote BLE descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.h:29</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></div><div class="ttdoc">A model of a remote BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.h:36</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:31</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>NimBLERemoteCharacteristic.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>

View File

@@ -0,0 +1,183 @@
<!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/NimBLERemoteDescriptor.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_remote_descriptor_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">NimBLERemoteDescriptor.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLERemoteDescriptor.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 27 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLERemoteDescriptor.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jul 8, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEREMOTEDESCRIPTOR_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEREMOTEDESCRIPTOR_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLERemoteCharacteristic.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_descriptor.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">getHandle</a>();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">getRemoteCharacteristic</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">getUUID</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::string <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46"> 45</a></span>&#160; T <a class="code" href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">readValue</a>(<span class="keywordtype">bool</span> skipSizeCheck = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; std::string value = <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span>(!skipSizeCheck &amp;&amp; value.size() &lt; <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pData = value.data();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> *((T *)pData);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b">readUInt8</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>&lt;uint8_t&gt;()&quot;)));</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53">readUInt16</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>&lt;uint16_t&gt;()&quot;)));</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint32_t <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204">readUInt32</a>() __attribute__ ((deprecated(&quot;Use template <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>&lt;uint32_t&gt;()&quot;)));</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; std::<span class="keywordtype">string</span> <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">toString</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a>(const uint8_t* data, <span class="keywordtype">size_t</span> length, <span class="keywordtype">bool</span> response = false);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a>(const std::<span class="keywordtype">string</span> &amp;newValue, <span class="keywordtype">bool</span> response = false);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; template&lt;typename T&gt;</div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c"> 65</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a>(const T &amp;s, <span class="keywordtype">bool</span> response = false) {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a>((uint8_t*)&amp;s, <span class="keyword">sizeof</span>(T), response);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> (<a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* pRemoteCharacteristic,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_dsc *dsc);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> onWriteCB(uint16_t conn_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">struct</span> ble_gatt_attr *attr, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> onReadCB(uint16_t conn_handle, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">struct</span> ble_gatt_attr *attr, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; uint16_t m_handle;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* m_pRemoteCharacteristic;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLEREMOTEDESCRIPTOR_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></div><div class="ttdoc">A model of a remote BLE characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></div><div class="ttdoc">A model of remote BLE descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.h:29</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_a008795a09d1fbe8533c2e9d0e8deb33a"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">NimBLERemoteDescriptor::toString</a></div><div class="ttdeci">std::string toString(void)</div><div class="ttdoc">Return a string representation of this Remote Descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:227</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_a0d3fb6424b2c86730e1a292281cd836e"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">NimBLERemoteDescriptor::writeValue</a></div><div class="ttdeci">bool writeValue(const uint8_t *data, size_t length, bool response=false)</div><div class="ttdoc">Write data to the BLE Remote Descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:269</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_a14351ea51b7b04f91b71e388881edd53"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53">NimBLERemoteDescriptor::readUInt16</a></div><div class="ttdeci">uint16_t readUInt16() __attribute__((deprecated(&quot;Use template readValue&lt;uint16_t&gt;()&quot;)))</div><div class="ttdoc">Read an unsigned 16 bit value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:102</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_a219606f84d63bc02f093051d66f05204"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204">NimBLERemoteDescriptor::readUInt32</a></div><div class="ttdeci">uint32_t readUInt32() __attribute__((deprecated(&quot;Use template readValue&lt;uint32_t&gt;()&quot;)))</div><div class="ttdoc">Read an unsigned 32 bit value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:116</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_a3b6952aa46b3541fb0a8247e4e542257"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">NimBLERemoteDescriptor::readValue</a></div><div class="ttdeci">std::string readValue()</div><div class="ttdoc">Read the value of the remote descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:129</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_a529e80c6731f68f3598e015df7618cfe"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">NimBLERemoteDescriptor::getRemoteCharacteristic</a></div><div class="ttdeci">NimBLERemoteCharacteristic * getRemoteCharacteristic()</div><div class="ttdoc">Get the characteristic that owns this descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:69</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_ab07e86707a91e48f68e9de55686e939b"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b">NimBLERemoteDescriptor::readUInt8</a></div><div class="ttdeci">uint8_t readUInt8() __attribute__((deprecated(&quot;Use template readValue&lt;uint8_t&gt;()&quot;)))</div><div class="ttdoc">Read a byte value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:88</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_ab8a774ebc69c0fb7ea17f926a82dba21"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">NimBLERemoteDescriptor::getHandle</a></div><div class="ttdeci">uint16_t getHandle()</div><div class="ttdoc">Retrieve the handle associated with this remote descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_ac4e3a21818903b69ace41c36a58d3c46"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">NimBLERemoteDescriptor::readValue</a></div><div class="ttdeci">T readValue(bool skipSizeCheck=false)</div><div class="ttdoc">A template to convert the remote descriptor data to &lt;type&gt;.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.h:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html_ace6b19cd3d9aa8226b4c17371616ad58"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">NimBLERemoteDescriptor::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Retrieve the UUID associated this remote descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteDescriptor.cpp:78</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:31</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>NimBLERemoteDescriptor.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>

View File

@@ -0,0 +1,201 @@
<!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/NimBLERemoteService.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_remote_service_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">NimBLERemoteService.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLERemoteService.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 27 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLERemoteService.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jul 8, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEREMOTESERVICE_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEREMOTESERVICE_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEClient.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;NimBLERemoteCharacteristic.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_service.html"> 36</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_nim_b_l_e_remote_service.html#a2803aa5cdfdb622ae8fe255dc939cb1d">~NimBLERemoteService</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// Public methods</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; std::vector&lt;NimBLERemoteCharacteristic*&gt;::iterator <a class="code" href="class_nim_b_l_e_remote_service.html#a49bb3134b570db877fac67e6ed077aa2">begin</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; std::vector&lt;NimBLERemoteCharacteristic*&gt;::iterator <a class="code" href="class_nim_b_l_e_remote_service.html#a10fe635fe9a0661d26c33021faaec53b">end</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* <a class="code" href="class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487">getCharacteristic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* <a class="code" href="class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487">getCharacteristic</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_remote_service.html#a221069047193f8d25f7112b44bbcb28f">deleteCharacteristics</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_remote_service.html#a15b3b750b073f334c3be680a99ce2e02">deleteCharacteristic</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* <a class="code" href="class_nim_b_l_e_remote_service.html#a3d1e7db457a9f3774eaa5e641dcc716e">getClient</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">//uint16_t getHandle();</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_remote_service.html#a565ed7d306645772d4e03ca65a07f7e5">getUUID</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::string <a class="code" href="class_nim_b_l_e_remote_service.html#a4a9b63b4e5cedb51a7748a88daeb518b">getValue</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUuid);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_service.html#a4bb8c7c85580d86fd9ab7be5c3933b72">setValue</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUuid,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">const</span> std::string &amp;value);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; std::string <a class="code" href="class_nim_b_l_e_remote_service.html#aaf106a37f24a51b967dd0984c973750f">toString</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; std::vector&lt;NimBLERemoteCharacteristic*&gt;* <a class="code" href="class_nim_b_l_e_remote_service.html#a2c9e91c842598a6a9576c7b87af0863a">getCharacteristics</a>(<span class="keywordtype">bool</span> refresh = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// Private constructor ... never meant to be created by a user application.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>(<a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* pClient, <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_svc *service);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// Friends</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">// Private methods</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">bool</span> retrieveCharacteristics(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> *uuid_filter = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> characteristicDiscCB(uint16_t conn_handle,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_error *error,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> ble_gatt_chr *chr,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; uint16_t getStartHandle();</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; uint16_t getEndHandle();</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span> releaseSemaphores();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">// Properties</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// We maintain a vector of characteristics owned by this service.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; std::vector&lt;NimBLERemoteCharacteristic*&gt; m_characteristicVector;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="class_nim_b_l_e_client.html">NimBLEClient</a>* m_pClient;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; uint16_t m_startHandle;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; uint16_t m_endHandle;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}; <span class="comment">// NimBLERemoteService</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLEREMOTESERVICE_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition:</b> NimBLEClient.h:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></div><div class="ttdoc">A model of a remote BLE characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:45</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></div><div class="ttdoc">A model of a remote BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.h:36</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a10fe635fe9a0661d26c33021faaec53b"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a10fe635fe9a0661d26c33021faaec53b">NimBLERemoteService::end</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteCharacteristic * &gt;::iterator end()</div><div class="ttdoc">Get iterator to the end of the vector of remote characteristic pointers.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:76</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a15b3b750b073f334c3be680a99ce2e02"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a15b3b750b073f334c3be680a99ce2e02">NimBLERemoteService::deleteCharacteristic</a></div><div class="ttdeci">size_t deleteCharacteristic(const NimBLEUUID &amp;uuid)</div><div class="ttdoc">Delete characteristic by UUID.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:345</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a221069047193f8d25f7112b44bbcb28f"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a221069047193f8d25f7112b44bbcb28f">NimBLERemoteService::deleteCharacteristics</a></div><div class="ttdeci">void deleteCharacteristics()</div><div class="ttdoc">Delete the characteristics in the characteristics vector.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:330</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a2803aa5cdfdb622ae8fe255dc939cb1d"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a2803aa5cdfdb622ae8fe255dc939cb1d">NimBLERemoteService::~NimBLERemoteService</a></div><div class="ttdeci">virtual ~NimBLERemoteService()</div><div class="ttdoc">When deleting the service make sure we delete all characteristics and descriptors.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:58</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a2c9e91c842598a6a9576c7b87af0863a"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a2c9e91c842598a6a9576c7b87af0863a">NimBLERemoteService::getCharacteristics</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteCharacteristic * &gt; * getCharacteristics(bool refresh=false)</div><div class="ttdoc">Get a pointer to the vector of found characteristics.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:135</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a3d1e7db457a9f3774eaa5e641dcc716e"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a3d1e7db457a9f3774eaa5e641dcc716e">NimBLERemoteService::getClient</a></div><div class="ttdeci">NimBLEClient * getClient(void)</div><div class="ttdoc">Get the client associated with this service.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:254</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a49bb3134b570db877fac67e6ed077aa2"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a49bb3134b570db877fac67e6ed077aa2">NimBLERemoteService::begin</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteCharacteristic * &gt;::iterator begin()</div><div class="ttdoc">Get iterator to the beginning of the vector of remote characteristic pointers.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:67</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a4a9b63b4e5cedb51a7748a88daeb518b"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a4a9b63b4e5cedb51a7748a88daeb518b">NimBLERemoteService::getValue</a></div><div class="ttdeci">std::string getValue(const NimBLEUUID &amp;characteristicUuid)</div><div class="ttdoc">Read the value of a characteristic associated with this service.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:288</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a4bb8c7c85580d86fd9ab7be5c3933b72"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a4bb8c7c85580d86fd9ab7be5c3933b72">NimBLERemoteService::setValue</a></div><div class="ttdeci">bool setValue(const NimBLEUUID &amp;characteristicUuid, const std::string &amp;value)</div><div class="ttdoc">Set the value of a characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:309</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_a565ed7d306645772d4e03ca65a07f7e5"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#a565ed7d306645772d4e03ca65a07f7e5">NimBLERemoteService::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID(void)</div><div class="ttdoc">Get the service UUID.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:278</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_aaf106a37f24a51b967dd0984c973750f"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#aaf106a37f24a51b967dd0984c973750f">NimBLERemoteService::toString</a></div><div class="ttdeci">std::string toString(void)</div><div class="ttdoc">Create a string representation of this remote service.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:366</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html_ab12d195a2239a3808d60457184f0c487"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487">NimBLERemoteService::getCharacteristic</a></div><div class="ttdeci">NimBLERemoteCharacteristic * getCharacteristic(const char *uuid)</div><div class="ttdoc">Get the remote characteristic object for the characteristic UUID.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteService.cpp:86</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:31</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>NimBLERemoteService.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>

View File

@@ -0,0 +1,216 @@
<!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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_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>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEScan.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 24 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEScan.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jul 1, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLE_SCAN_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLE_SCAN_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;NimBLEAdvertisedDevice.h&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEUtils.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;host/ble_gap.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160; </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>&#160;<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>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4">dump</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <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>&#160; <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>&#160; std::vector&lt;NimBLEAdvertisedDevice*&gt;::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>&#160; std::vector&lt;NimBLEAdvertisedDevice*&gt;::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>&#160; <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> &amp;address);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <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>&#160; std::vector&lt;NimBLEAdvertisedDevice*&gt; m_advertisedDevicesVector;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </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>&#160;<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>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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>&#160; <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> &amp;address);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <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>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <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>&#160; ~<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>&#160; <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>&#160; <span class="keywordtype">void</span> onHostReset();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">void</span> onHostSync();</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <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>&#160; 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>&#160; ble_gap_disc_params m_scan_params;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">bool</span> m_ignoreResults;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <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>&#160; uint32_t m_duration;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; ble_task_data_t *m_pTaskData;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; uint8_t m_maxResults;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;};</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<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>&#160;<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>&#160;<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 &amp;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&lt; NimBLEAdvertisedDevice * &gt;::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&lt; NimBLEAdvertisedDevice * &gt;::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>

View File

@@ -0,0 +1,199 @@
<!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/NimBLESecurity.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_security_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">NimBLESecurity.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLESecurity.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Feb 22 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLESecurity.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Dec 17, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: chegewara</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLESECURITY_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLESECURITY_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;host/ble_gap.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_NO_BOND 0x00 </span><span class="comment">/* relate to BTM_LE_AUTH_NO_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_BOND 0x01 </span><span class="comment">/* relate to BTM_LE_AUTH_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_MITM (1 &lt;&lt; 2) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_MITM in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_BOND_MITM (ESP_LE_AUTH_BOND | ESP_LE_AUTH_REQ_MITM)</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_ONLY (1 &lt;&lt; 3) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_ONLY in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_BOND (ESP_LE_AUTH_BOND | ESP_LE_AUTH_REQ_SC_ONLY) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_MITM (ESP_LE_AUTH_REQ_MITM | ESP_LE_AUTH_REQ_SC_ONLY) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_MITM in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_MITM_BOND (ESP_LE_AUTH_REQ_MITM | ESP_LE_AUTH_REQ_SC_ONLY | ESP_LE_AUTH_BOND) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_MITM_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_OUT 0 </span><span class="comment">/* relate to BTM_IO_CAP_OUT in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_IO 1 </span><span class="comment">/* relate to BTM_IO_CAP_IO in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_IN 2 </span><span class="comment">/* relate to BTM_IO_CAP_IN in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_NONE 3 </span><span class="comment">/* relate to BTM_IO_CAP_NONE in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_KBDISP 4 </span><span class="comment">/* relate to BTM_IO_CAP_KBDISP in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#define ESP_BLE_ENC_KEY_MASK (1 &lt;&lt; 0) </span><span class="comment">/* relate to BTM_BLE_ENC_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define ESP_BLE_ID_KEY_MASK (1 &lt;&lt; 1) </span><span class="comment">/* relate to BTM_BLE_ID_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define ESP_BLE_CSR_KEY_MASK (1 &lt;&lt; 2) </span><span class="comment">/* relate to BTM_BLE_CSR_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define ESP_BLE_LINK_KEY_MASK (1 &lt;&lt; 3) </span><span class="comment">/* relate to BTM_BLE_LINK_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">typedef</span> uint8_t esp_ble_auth_req_t; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">typedef</span> uint8_t esp_ble_io_cap_t; </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security.html"> 61</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_security.html">NimBLESecurity</a> {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="class_nim_b_l_e_security.html">NimBLESecurity</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_security.html">NimBLESecurity</a>();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">setAuthenticationMode</a>(esp_ble_auth_req_t auth_req);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">setCapability</a>(esp_ble_io_cap_t iocap);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">setInitEncryptionKey</a>(uint8_t init_key);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">setRespEncryptionKey</a>(uint8_t resp_key);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b">setKeySize</a>(uint8_t key_size = 16);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">setStaticPIN</a>(uint32_t pin);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">//static char* esp_key_type_to_str(esp_ble_key_type_t key_type);</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment">private:</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> esp_ble_auth_req_t m_authReq;</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> esp_ble_io_cap_t m_iocap;</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> uint8_t m_initKey;</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"> uint8_t m_respKey;</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"> uint8_t m_keySize;</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;}; <span class="comment">// BLESecurity</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html"> 88</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a> {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a>() {};</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f"> 97</a></span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f">onPassKeyRequest</a>() = 0;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be"> 104</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be">onPassKeyNotify</a>(uint32_t pass_key) = 0;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd"> 110</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd">onSecurityRequest</a>() = 0 ;</div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125"> 114</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125">onAuthenticationComplete</a>(ble_gap_conn_desc*) = 0;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92"> 121</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92">onConfirmPIN</a>(uint32_t pin) = 0;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;}; <span class="comment">// BLESecurityCallbacks</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// COMPONENTS_NIMBLESECURITY_H_</span></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a></div><div class="ttdoc">Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibi...</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.h:88</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a1cfc9c48c02aece1736f9070dc6ff90f"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f">NimBLESecurityCallbacks::onPassKeyRequest</a></div><div class="ttdeci">virtual uint32_t onPassKeyRequest()=0</div><div class="ttdoc">Its request from peer device to input authentication pin code displayed on peer device....</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a22a8079906070a13583daafd1521a125"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125">NimBLESecurityCallbacks::onAuthenticationComplete</a></div><div class="ttdeci">virtual void onAuthenticationComplete(ble_gap_conn_desc *)=0</div><div class="ttdoc">Provides us information when authentication process is completed.</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a2ce6a03693a43a55e51598d8b2654a92"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92">NimBLESecurityCallbacks::onConfirmPIN</a></div><div class="ttdeci">virtual bool onConfirmPIN(uint32_t pin)=0</div><div class="ttdoc">Called when using numeric comparison for authentication.</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a620de166c3fe26027871d18535839cdd"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd">NimBLESecurityCallbacks::onSecurityRequest</a></div><div class="ttdeci">virtual bool onSecurityRequest()=0</div><div class="ttdoc">Here we can make decision if we want to let negotiate authorization with peer device or not.</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_aa984ec6f29741b49bdd7dbfde60177be"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be">NimBLESecurityCallbacks::onPassKeyNotify</a></div><div class="ttdeci">virtual void onPassKeyNotify(uint32_t pass_key)=0</div><div class="ttdoc">Provide us 6-digits code to perform authentication. It requires that our device is capable to display...</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html"><div class="ttname"><a href="class_nim_b_l_e_security.html">NimBLESecurity</a></div><div class="ttdoc">A class to handle BLE security operations. Deprecated - provided for backward compatibility only.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.h:61</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_a0bb1535e1b0d48566c17f681b7539f82"><div class="ttname"><a href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">NimBLESecurity::setStaticPIN</a></div><div class="ttdeci">void setStaticPIN(uint32_t pin)</div><div class="ttdoc">Sets a static PIN used to authenticate/encrypt the connection.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:105</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_a1bb7902d5ceffaca86bd7638a74e35e3"><div class="ttname"><a href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">NimBLESecurity::setCapability</a></div><div class="ttdeci">void setCapability(esp_ble_io_cap_t iocap)</div><div class="ttdoc">Set our device IO capability to let end user perform authorization either by displaying or entering g...</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:58</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_a5cf0d3672a16f557032bcbf39a9e22f2"><div class="ttname"><a href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">NimBLESecurity::setAuthenticationMode</a></div><div class="ttdeci">void setAuthenticationMode(esp_ble_auth_req_t auth_req)</div><div class="ttdoc">Set requested authentication mode.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:40</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_aac8434faa02a6813b7efd87224e04714"><div class="ttname"><a href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">NimBLESecurity::setRespEncryptionKey</a></div><div class="ttdeci">void setRespEncryptionKey(uint8_t resp_key)</div><div class="ttdoc">Sets the keys we will accept during encryption.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:86</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_ab2be50284a325ec8937abdab0baafd4b"><div class="ttname"><a href="class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b">NimBLESecurity::setKeySize</a></div><div class="ttdeci">void setKeySize(uint8_t key_size=16)</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:94</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_adfc3caa3e1a5aedc3be5c0f1dc5c99ac"><div class="ttname"><a href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">NimBLESecurity::setInitEncryptionKey</a></div><div class="ttdeci">void setInitEncryptionKey(uint8_t init_key)</div><div class="ttdoc">Sets the keys we will distibute during encryption.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:72</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>NimBLESecurity.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>

View File

@@ -0,0 +1,258 @@
<!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/NimBLEServer.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_server_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">NimBLEServer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEServer.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 2, 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEServer.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Apr 16, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLESERVER_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLESERVER_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#define NIMBLE_ATT_REMOVE_HIDE 1</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define NIMBLE_ATT_REMOVE_DELETE 2</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;NimBLEUtils.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;NimBLEAddress.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;NimBLEAdvertising.h&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;NimBLEService.h&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;NimBLESecurity.h&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;NimBLEConnInfo.h&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_server.html"> 42</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a> {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_server.html#a98ea12f57c10c0477b0c1c5efab23ee5">getConnectedCount</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">createService</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">createService</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint32_t numHandles=15,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint8_t inst_id=0);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a00c92f62f41ec1c499dfaf042b487d75">removeService</a>(<a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* service, <span class="keywordtype">bool</span> deleteSvc = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a6eda4c9e0ac1dd031c678d4bf7da1d56">addService</a>(<a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* service);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>* <a class="code" href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">getAdvertising</a>();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a485c90ce36275f9e4ec26a7f3d348cd9">setCallbacks</a>(<a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>* pCallbacks,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> deleteCallbacks = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a2540ae7b61fc6513f794da2512d66f74">startAdvertising</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#ab713fd5619ddbfc1a88bf43a1686f454">stopAdvertising</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#ae94ad52f3c97f62553af9765acdb7bcb">start</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#a87ebb3d230e98a6b3cf85bc403d227e0">getServiceByUUID</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t instanceId = 0);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#a87ebb3d230e98a6b3cf85bc403d227e0">getServiceByUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint16_t instanceId = 0);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#a1ff39fc5235d1374d99b4f3d3acb5ddb">getServiceByHandle</a>(uint16_t handle);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_server.html#a63c9dce5c4bbc1c6bc720b6c51bcf3e1">disconnect</a>(uint16_t connID,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a9b08738766de90d7065263761314030a">updateConnParams</a>(uint16_t conn_handle,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint16_t minInterval, uint16_t maxInterval,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint16_t latency, uint16_t timeout);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_server.html#a9eb1f32b72ac93736585d6d89f393021">getPeerMTU</a>(uint16_t conn_id);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; std::vector&lt;uint16_t&gt; <a class="code" href="class_nim_b_l_e_server.html#ab95c428ddc94eb019a26d91e70f5974b">getPeerDevices</a>();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_server.html#a347c74f4ad6e2bcc2e301da11ae13e91">getPeerInfo</a>(<span class="keywordtype">size_t</span> index);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_server.html#a347c74f4ad6e2bcc2e301da11ae13e91">getPeerInfo</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&amp; address);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_server.html#ad241eb42e9775fb2f8aaa87c9fb9a76b">getPeerIDInfo</a>(uint16_t <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a6bfd923ecd0ea06d5564343ab7209122">advertiseOnDisconnect</a>(<span class="keywordtype">bool</span>);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>();</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; ~<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <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="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">bool</span> m_gattsStarted;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">bool</span> m_advertiseOnDisconnect;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">bool</span> m_svcChanged;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>* m_pServerCallbacks;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">bool</span> m_deleteCallbacks;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; uint16_t m_indWait[<a class="code" href="nimconfig_8h.html#a2ea633774bbf41ac57b314875f16d5f9">CONFIG_BT_NIMBLE_MAX_CONNECTIONS</a>];</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; std::vector&lt;uint16_t&gt; m_connectedPeersVec;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment">// uint16_t m_svcChgChrHdl; // Future use</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; std::vector&lt;NimBLEService*&gt; m_svcVec;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; std::vector&lt;NimBLECharacteristic*&gt; m_notifyChrVec;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(<span class="keyword">struct</span> ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">void</span> serviceChanged();</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> resetGATT();</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">bool</span> setIndicateWait(uint16_t conn_handle);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">void</span> clearIndicateWait(uint16_t conn_handle);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}; <span class="comment">// NimBLEServer</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_server_callbacks.html"> 103</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a> {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>() {};</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">onConnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">onConnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer, ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">onDisconnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">onDisconnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer, ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#ab4533f1317b36216c3c86695613c80a6">onMTUChange</a>(uint16_t MTU, ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_nim_b_l_e_server_callbacks.html#ad2c3035c3a284d03673ff1b5aeaa0fca">onPassKeyRequest</a>();</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="comment">//virtual void onPassKeyNotify(uint32_t pass_key);</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="comment">//virtual bool onSecurityRequest();</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a6a18155a8d3fa0980fab51f08ce5de2d">onAuthenticationComplete</a>(ble_gap_conn_desc* desc);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">onConfirmPIN</a>(uint32_t pin);</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;}; <span class="comment">// NimBLEServerCallbacks</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLESERVER_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_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:83</div></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></div><div class="ttdoc">Connection information.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:9</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_server_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a></div><div class="ttdoc">Callbacks associated with the operation of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:103</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a3dbf72280a895e80e0972599a7373ca0"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">NimBLEServerCallbacks::onDisconnect</a></div><div class="ttdeci">virtual void onDisconnect(NimBLEServer *pServer)</div><div class="ttdoc">Handle a client disconnection. This is called when a client disconnects.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:811</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a5327d11f249e8f020b59529b634e0c91"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">NimBLEServerCallbacks::onConfirmPIN</a></div><div class="ttdeci">virtual bool onConfirmPIN(uint32_t pin)</div><div class="ttdoc">Called when using numeric comparision for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:840</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a6a18155a8d3fa0980fab51f08ce5de2d"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a6a18155a8d3fa0980fab51f08ce5de2d">NimBLEServerCallbacks::onAuthenticationComplete</a></div><div class="ttdeci">virtual void onAuthenticationComplete(ble_gap_conn_desc *desc)</div><div class="ttdoc">Called when the pairing procedure is complete.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:837</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a80348ab2d08bbec7a6910c96662fc1d4"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">NimBLEServerCallbacks::onConnect</a></div><div class="ttdeci">virtual void onConnect(NimBLEServer *pServer)</div><div class="ttdoc">Handle a client connection. This is called when a client connects.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:801</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_ab4533f1317b36216c3c86695613c80a6"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#ab4533f1317b36216c3c86695613c80a6">NimBLEServerCallbacks::onMTUChange</a></div><div class="ttdeci">virtual void onMTUChange(uint16_t MTU, ble_gap_conn_desc *desc)</div><div class="ttdoc">Called when the connection MTU changes.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:819</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_ad2c3035c3a284d03673ff1b5aeaa0fca"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#ad2c3035c3a284d03673ff1b5aeaa0fca">NimBLEServerCallbacks::onPassKeyRequest</a></div><div class="ttdeci">virtual uint32_t onPassKeyRequest()</div><div class="ttdoc">Called when a client requests a passkey for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:823</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a00c92f62f41ec1c499dfaf042b487d75"><div class="ttname"><a href="class_nim_b_l_e_server.html#a00c92f62f41ec1c499dfaf042b487d75">NimBLEServer::removeService</a></div><div class="ttdeci">void removeService(NimBLEService *service, bool deleteSvc=false)</div><div class="ttdoc">Remove a service from the server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:633</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a1ff39fc5235d1374d99b4f3d3acb5ddb"><div class="ttname"><a href="class_nim_b_l_e_server.html#a1ff39fc5235d1374d99b4f3d3acb5ddb">NimBLEServer::getServiceByHandle</a></div><div class="ttdeci">NimBLEService * getServiceByHandle(uint16_t handle)</div><div class="ttdoc">Get a BLE Service by its handle.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:136</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a2540ae7b61fc6513f794da2512d66f74"><div class="ttname"><a href="class_nim_b_l_e_server.html#a2540ae7b61fc6513f794da2512d66f74">NimBLEServer::startAdvertising</a></div><div class="ttdeci">void startAdvertising()</div><div class="ttdoc">Start advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:727</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a347c74f4ad6e2bcc2e301da11ae13e91"><div class="ttname"><a href="class_nim_b_l_e_server.html#a347c74f4ad6e2bcc2e301da11ae13e91">NimBLEServer::getPeerInfo</a></div><div class="ttdeci">NimBLEConnInfo getPeerInfo(size_t index)</div><div class="ttdoc">Get the connection information of a connected peer by vector index.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:276</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a485c90ce36275f9e4ec26a7f3d348cd9"><div class="ttname"><a href="class_nim_b_l_e_server.html#a485c90ce36275f9e4ec26a7f3d348cd9">NimBLEServer::setCallbacks</a></div><div class="ttdeci">void setCallbacks(NimBLEServerCallbacks *pCallbacks, bool deleteCallbacks=true)</div><div class="ttdoc">Set the server callbacks.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:605</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a63c9dce5c4bbc1c6bc720b6c51bcf3e1"><div class="ttname"><a href="class_nim_b_l_e_server.html#a63c9dce5c4bbc1c6bc720b6c51bcf3e1">NimBLEServer::disconnect</a></div><div class="ttdeci">int disconnect(uint16_t connID, uint8_t reason=BLE_ERR_REM_USER_CONN_TERM)</div><div class="ttdoc">Disconnect the specified client with optional reason.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:232</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a6bfd923ecd0ea06d5564343ab7209122"><div class="ttname"><a href="class_nim_b_l_e_server.html#a6bfd923ecd0ea06d5564343ab7209122">NimBLEServer::advertiseOnDisconnect</a></div><div class="ttdeci">void advertiseOnDisconnect(bool)</div><div class="ttdoc">Set the server to automatically start advertising when a client disconnects.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:250</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a6eda4c9e0ac1dd031c678d4bf7da1d56"><div class="ttname"><a href="class_nim_b_l_e_server.html#a6eda4c9e0ac1dd031c678d4bf7da1d56">NimBLEServer::addService</a></div><div class="ttdeci">void addService(NimBLEService *service)</div><div class="ttdoc">Adds a service which was either already created but removed from availability, or created and later a...</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:669</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a87ebb3d230e98a6b3cf85bc403d227e0"><div class="ttname"><a href="class_nim_b_l_e_server.html#a87ebb3d230e98a6b3cf85bc403d227e0">NimBLEServer::getServiceByUUID</a></div><div class="ttdeci">NimBLEService * getServiceByUUID(const char *uuid, uint16_t instanceId=0)</div><div class="ttdoc">Get a BLE Service by its UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:107</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a98ea12f57c10c0477b0c1c5efab23ee5"><div class="ttname"><a href="class_nim_b_l_e_server.html#a98ea12f57c10c0477b0c1c5efab23ee5">NimBLEServer::getConnectedCount</a></div><div class="ttdeci">size_t getConnectedCount()</div><div class="ttdoc">Return the number of connected clients.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:259</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a9b08738766de90d7065263761314030a"><div class="ttname"><a href="class_nim_b_l_e_server.html#a9b08738766de90d7065263761314030a">NimBLEServer::updateConnParams</a></div><div class="ttdeci">void updateConnParams(uint16_t conn_handle, uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</div><div class="ttdoc">Request an Update the connection parameters:</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:758</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_a9eb1f32b72ac93736585d6d89f393021"><div class="ttname"><a href="class_nim_b_l_e_server.html#a9eb1f32b72ac93736585d6d89f393021">NimBLEServer::getPeerMTU</a></div><div class="ttdeci">uint16_t getPeerMTU(uint16_t conn_id)</div><div class="ttdoc">Get the MTU of the client.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:744</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_aaeb58b4de85754d1aac6964e9248aa35"><div class="ttname"><a href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">NimBLEServer::createService</a></div><div class="ttdeci">NimBLEService * createService(const char *uuid)</div><div class="ttdoc">Create a BLE Service.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:69</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_ab41d8bb9b334734f95a726f1e15200fc"><div class="ttname"><a href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">NimBLEServer::getAdvertising</a></div><div class="ttdeci">NimBLEAdvertising * getAdvertising()</div><div class="ttdoc">Retrieve the advertising object that can be used to advertise the existence of the server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:150</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_ab713fd5619ddbfc1a88bf43a1686f454"><div class="ttname"><a href="class_nim_b_l_e_server.html#ab713fd5619ddbfc1a88bf43a1686f454">NimBLEServer::stopAdvertising</a></div><div class="ttdeci">void stopAdvertising()</div><div class="ttdoc">Stop advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:735</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_ab95c428ddc94eb019a26d91e70f5974b"><div class="ttname"><a href="class_nim_b_l_e_server.html#ab95c428ddc94eb019a26d91e70f5974b">NimBLEServer::getPeerDevices</a></div><div class="ttdeci">std::vector&lt; uint16_t &gt; getPeerDevices()</div><div class="ttdoc">Get the vector of the connected client ID's.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:267</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_ad241eb42e9775fb2f8aaa87c9fb9a76b"><div class="ttname"><a href="class_nim_b_l_e_server.html#ad241eb42e9775fb2f8aaa87c9fb9a76b">NimBLEServer::getPeerIDInfo</a></div><div class="ttdeci">NimBLEConnInfo getPeerIDInfo(uint16_t id)</div><div class="ttdoc">Get the connection information of a connected peer by connection ID.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:309</div></div>
<div class="ttc" id="aclass_nim_b_l_e_server_html_ae94ad52f3c97f62553af9765acdb7bcb"><div class="ttname"><a href="class_nim_b_l_e_server.html#ae94ad52f3c97f62553af9765acdb7bcb">NimBLEServer::start</a></div><div class="ttdeci">void start()</div><div class="ttdoc">Start the GATT server. Required to be called after setup of all services and characteristics / descri...</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:171</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.h:36</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:31</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="animconfig_8h_html_a2ea633774bbf41ac57b314875f16d5f9"><div class="ttname"><a href="nimconfig_8h.html#a2ea633774bbf41ac57b314875f16d5f9">CONFIG_BT_NIMBLE_MAX_CONNECTIONS</a></div><div class="ttdeci">#define CONFIG_BT_NIMBLE_MAX_CONNECTIONS</div><div class="ttdoc">Un-comment to change the number of simultaneous connections (esp controller max is 9)</div><div class="ttdef"><b>Definition:</b> nimconfig.h:16</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>NimBLEServer.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>

View File

@@ -0,0 +1,205 @@
<!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/NimBLEService.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_service_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">NimBLEService.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEService.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on March 2, 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEService.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Mar 25, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef MAIN_NIMBLESERVICE_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define MAIN_NIMBLESERVICE_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;NimBLEServer.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;NimBLECharacteristic.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;NimBLEUUID.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_service.html"> 36</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="class_nim_b_l_e_service.html#a2f21520dead11ac352562c7b232bc854">NimBLEService</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t numHandles, <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="class_nim_b_l_e_service.html#a2f21520dead11ac352562c7b232bc854">NimBLEService</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint16_t numHandles, <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; ~<a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* <a class="code" href="class_nim_b_l_e_service.html#af304386c4e067dd0eeb27b86c0e59d0f">getServer</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_service.html#ab000b7d2b7dbb3978a5a8c1e17b1d649">getUUID</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; uint16_t <a class="code" href="class_nim_b_l_e_service.html#a86d65ef61a77bdd660632b4041c2b640">getHandle</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; std::string <a class="code" href="class_nim_b_l_e_service.html#a10d10d14f8c5a970a06915cd407a0a73">toString</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_service.html#a71488881933ae8adbf11c5986f9dfb75">dump</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_service.html#ad37324ed0404d596923d6fdc0133b985">start</a>();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_service.html#adab5552c080b9cb88095af262d326309">createCharacteristic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint32_t properties =</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; NIMBLE_PROPERTY::READ |</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; NIMBLE_PROPERTY::WRITE);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_service.html#adab5552c080b9cb88095af262d326309">createCharacteristic</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; uint32_t properties =</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; NIMBLE_PROPERTY::READ |</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; NIMBLE_PROPERTY::WRITE);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_service.html#af8215dbfdaf7ced32d6158f8ff5116e8">addCharacteristic</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_service.html#af992d0c27e3a559789fb77fc46623234">removeCharacteristic</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic, <span class="keywordtype">bool</span> deleteChr = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_service.html#a305b680286096638a4239620ec2de567">getCharacteristic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t instanceId = 0);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_service.html#a305b680286096638a4239620ec2de567">getCharacteristic</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint16_t instanceId = 0);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code" href="class_nim_b_l_e_service.html#a35b56ab3ef7fffb2b299f95d3176d07e">getCharacteristicByHandle</a>(uint16_t handle);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; std::vector&lt;NimBLECharacteristic*&gt; <a class="code" href="class_nim_b_l_e_service.html#aa2cba47cb4c935e15c77707643e5e9a5">getCharacteristics</a>();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; std::vector&lt;NimBLECharacteristic*&gt; <a class="code" href="class_nim_b_l_e_service.html#aa2cba47cb4c935e15c77707643e5e9a5">getCharacteristics</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; std::vector&lt;NimBLECharacteristic*&gt; <a class="code" href="class_nim_b_l_e_service.html#aa2cba47cb4c935e15c77707643e5e9a5">getCharacteristics</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <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="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; uint16_t m_handle;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* m_pServer;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; uint16_t m_numHandles;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; ble_gatt_svc_def* m_pSvcDef;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; uint8_t m_removed;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; std::vector&lt;NimBLECharacteristic*&gt; m_chrVec;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;}; <span class="comment">// NimBLEService</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLESERVICE_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</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_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.h:36</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a10d10d14f8c5a970a06915cd407a0a73"><div class="ttname"><a href="class_nim_b_l_e_service.html#a10d10d14f8c5a970a06915cd407a0a73">NimBLEService::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Return a string representation of this service. A service is defined by:</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:417</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a2f21520dead11ac352562c7b232bc854"><div class="ttname"><a href="class_nim_b_l_e_service.html#a2f21520dead11ac352562c7b232bc854">NimBLEService::NimBLEService</a></div><div class="ttdeci">NimBLEService(const char *uuid, uint16_t numHandles, NimBLEServer *pServer)</div><div class="ttdoc">Construct an instance of the NimBLEService.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:40</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a305b680286096638a4239620ec2de567"><div class="ttname"><a href="class_nim_b_l_e_service.html#a305b680286096638a4239620ec2de567">NimBLEService::getCharacteristic</a></div><div class="ttdeci">NimBLECharacteristic * getCharacteristic(const char *uuid, uint16_t instanceId=0)</div><div class="ttdoc">Get a pointer to the characteristic object with the specified UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:346</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a35b56ab3ef7fffb2b299f95d3176d07e"><div class="ttname"><a href="class_nim_b_l_e_service.html#a35b56ab3ef7fffb2b299f95d3176d07e">NimBLEService::getCharacteristicByHandle</a></div><div class="ttdeci">NimBLECharacteristic * getCharacteristicByHandle(uint16_t handle)</div><div class="ttdoc">Get a pointer to the characteristic object with the specified handle.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:374</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a71488881933ae8adbf11c5986f9dfb75"><div class="ttname"><a href="class_nim_b_l_e_service.html#a71488881933ae8adbf11c5986f9dfb75">NimBLEService::dump</a></div><div class="ttdeci">void dump()</div><div class="ttdoc">Dump details of this BLE GATT service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:85</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a86d65ef61a77bdd660632b4041c2b640"><div class="ttname"><a href="class_nim_b_l_e_service.html#a86d65ef61a77bdd660632b4041c2b640">NimBLEService::getHandle</a></div><div class="ttdeci">uint16_t getHandle()</div><div class="ttdoc">Get the handle associated with this service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:252</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_aa2cba47cb4c935e15c77707643e5e9a5"><div class="ttname"><a href="class_nim_b_l_e_service.html#aa2cba47cb4c935e15c77707643e5e9a5">NimBLEService::getCharacteristics</a></div><div class="ttdeci">std::vector&lt; NimBLECharacteristic * &gt; getCharacteristics()</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:386</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_ab000b7d2b7dbb3978a5a8c1e17b1d649"><div class="ttname"><a href="class_nim_b_l_e_service.html#ab000b7d2b7dbb3978a5a8c1e17b1d649">NimBLEService::getUUID</a></div><div class="ttdeci">NimBLEUUID getUUID()</div><div class="ttdoc">Get the UUID of the service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:109</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_ad37324ed0404d596923d6fdc0133b985"><div class="ttname"><a href="class_nim_b_l_e_service.html#ad37324ed0404d596923d6fdc0133b985">NimBLEService::start</a></div><div class="ttdeci">bool start()</div><div class="ttdoc">Builds the database of characteristics/descriptors for the service and registers it with the NimBLE s...</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:119</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_adab5552c080b9cb88095af262d326309"><div class="ttname"><a href="class_nim_b_l_e_service.html#adab5552c080b9cb88095af262d326309">NimBLEService::createCharacteristic</a></div><div class="ttdeci">NimBLECharacteristic * createCharacteristic(const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE)</div><div class="ttdoc">Create a new BLE Characteristic associated with this service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:263</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_af304386c4e067dd0eeb27b86c0e59d0f"><div class="ttname"><a href="class_nim_b_l_e_service.html#af304386c4e067dd0eeb27b86c0e59d0f">NimBLEService::getServer</a></div><div class="ttdeci">NimBLEServer * getServer()</div><div class="ttdoc">Get the BLE server associated with this service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:431</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_af8215dbfdaf7ced32d6158f8ff5116e8"><div class="ttname"><a href="class_nim_b_l_e_service.html#af8215dbfdaf7ced32d6158f8ff5116e8">NimBLEService::addCharacteristic</a></div><div class="ttdeci">void addCharacteristic(NimBLECharacteristic *pCharacteristic)</div><div class="ttdoc">Add a characteristic to the service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:291</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_af992d0c27e3a559789fb77fc46623234"><div class="ttname"><a href="class_nim_b_l_e_service.html#af992d0c27e3a559789fb77fc46623234">NimBLEService::removeCharacteristic</a></div><div class="ttdeci">void removeCharacteristic(NimBLECharacteristic *pCharacteristic, bool deleteChr=false)</div><div class="ttdoc">Remove a characteristic from the service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.cpp:317</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:31</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>NimBLEService.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>

View File

@@ -0,0 +1,163 @@
<!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/NimBLEUUID.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_u_u_i_d_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">NimBLEUUID.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEUUID.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 24 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLEUUID.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Jun 21, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: kolban</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEUUID_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEUUID_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;host/ble_uuid.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_u_u_i_d.html"> 31</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>(<span class="keyword">const</span> std::string &amp;uuid);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>(uint16_t uuid);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>(uint32_t uuid);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>(<span class="keyword">const</span> ble_uuid128_t* uuid);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>(<span class="keyword">const</span> uint8_t* pData, <span class="keywordtype">size_t</span> size, <span class="keywordtype">bool</span> msbFirst);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>(uint32_t first, uint16_t second, uint16_t third, uint64_t fourth);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; uint8_t <a class="code" href="class_nim_b_l_e_u_u_i_d.html#aefc88e493b63ccd6dc86227dc92af0c6">bitSize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html#a3d9763ff434905457ed69118e93a35fd">equals</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> ble_uuid_any_t* <a class="code" href="class_nim_b_l_e_u_u_i_d.html#a62e8e924f971c62cc42760d8c7dd6f28">getNative</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp; <a class="code" href="class_nim_b_l_e_u_u_i_d.html#a7103976da820d0c1840aa77aca38306c">to128</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; std::string <a class="code" href="class_nim_b_l_e_u_u_i_d.html#a9708e07b8e0915aafcfa32fe74ccdf64">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">static</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> <a class="code" href="class_nim_b_l_e_u_u_i_d.html#ae09acdc52e23a3a38c57aaf859c278c2">fromString</a>(<span class="keyword">const</span> std::string &amp;uuid);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html#a46484dcb0a1bfef6a8afe97f49f97875">operator ==</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp; rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html#abeee22e6661f7533f05802e1f89fedfe">operator !=</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp; rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">operator</span> std::string() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; ble_uuid_any_t m_uuid;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">bool</span> m_valueSet = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}; <span class="comment">// NimBLEUUID</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* COMPONENTS_NIMBLEUUID_H_ */</span><span class="preprocessor"></span></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:31</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_a3d9763ff434905457ed69118e93a35fd"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#a3d9763ff434905457ed69118e93a35fd">NimBLEUUID::equals</a></div><div class="ttdeci">bool equals(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Compare a UUID against this UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:186</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_a46484dcb0a1bfef6a8afe97f49f97875"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#a46484dcb0a1bfef6a8afe97f49f97875">NimBLEUUID::operator==</a></div><div class="ttdeci">bool operator==(const NimBLEUUID &amp;rhs) const</div><div class="ttdoc">Convienience operator to check if this UUID is equal to another.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:278</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_a62e8e924f971c62cc42760d8c7dd6f28"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#a62e8e924f971c62cc42760d8c7dd6f28">NimBLEUUID::getNative</a></div><div class="ttdeci">const ble_uuid_any_t * getNative() const</div><div class="ttdoc">Get the native UUID value.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:226</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_a7103976da820d0c1840aa77aca38306c"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#a7103976da820d0c1840aa77aca38306c">NimBLEUUID::to128</a></div><div class="ttdeci">const NimBLEUUID &amp; to128()</div><div class="ttdoc">Convert a UUID to its 128 bit representation.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:241</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_a9708e07b8e0915aafcfa32fe74ccdf64"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#a9708e07b8e0915aafcfa32fe74ccdf64">NimBLEUUID::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Get a string representation of the UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:270</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_abec7913c5989c3620c423c6717111453"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#abec7913c5989c3620c423c6717111453">NimBLEUUID::NimBLEUUID</a></div><div class="ttdeci">NimBLEUUID()</div><div class="ttdoc">Creates an empty UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:165</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_abeee22e6661f7533f05802e1f89fedfe"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#abeee22e6661f7533f05802e1f89fedfe">NimBLEUUID::operator!=</a></div><div class="ttdeci">bool operator!=(const NimBLEUUID &amp;rhs) const</div><div class="ttdoc">Convienience operator to check if this UUID is not equal to another.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:317</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_ae09acdc52e23a3a38c57aaf859c278c2"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#ae09acdc52e23a3a38c57aaf859c278c2">NimBLEUUID::fromString</a></div><div class="ttdeci">static NimBLEUUID fromString(const std::string &amp;uuid)</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:202</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html_aefc88e493b63ccd6dc86227dc92af0c6"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html#aefc88e493b63ccd6dc86227dc92af0c6">NimBLEUUID::bitSize</a></div><div class="ttdeci">uint8_t bitSize() const</div><div class="ttdoc">Get the number of bits in this uuid.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.cpp:174</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>NimBLEUUID.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>

View File

@@ -0,0 +1,149 @@
<!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/NimBLEUtils.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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_utils_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">NimBLEUtils.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLEUtils.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Jan 25 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLEUTILS_H_</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLEUTILS_H_</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;host/ble_gap.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordtype">void</span> *pATT;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; TaskHandle_t task;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">int</span> rc;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; std::string *buf;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;} ble_task_data_t;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_utils.html"> 34</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_utils.html">NimBLEUtils</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">dumpGapEvent</a>(ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">gapEventToString</a>(uint8_t eventType);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">buildHexData</a>(uint8_t* target, <span class="keyword">const</span> uint8_t* source, uint8_t length);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">advTypeToString</a>(uint8_t advType);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">returnCodeToString</a>(<span class="keywordtype">int</span> rc);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">checkConnParams</a>(ble_gap_conn_params* params);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;};</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// COMPONENTS_NIMBLEUTILS_H_</span></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html"><div class="ttname"><a href="class_nim_b_l_e_utils.html">NimBLEUtils</a></div><div class="ttdoc">A BLE Utility class with methods for debugging and general purpose use.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.h:34</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a27df310308e72c477a3fda7a65806e01"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a27df310308e72c477a3fda7a65806e01">NimBLEUtils::dumpGapEvent</a></div><div class="ttdeci">static void dumpGapEvent(ble_gap_event *event, void *arg)</div><div class="ttdoc">Utility function to log the gap event info.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:418</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6382edb7e8e4030b4fc65d463fa2a886"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6382edb7e8e4030b4fc65d463fa2a886">NimBLEUtils::buildHexData</a></div><div class="ttdeci">static char * buildHexData(uint8_t *target, const uint8_t *source, uint8_t length)</div><div class="ttdoc">Create a hex representation of data.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:385</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a6de9354eeba9f126aa14cfa7ed43cda4"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a6de9354eeba9f126aa14cfa7ed43cda4">NimBLEUtils::advTypeToString</a></div><div class="ttdeci">static const char * advTypeToString(uint8_t advType)</div><div class="ttdoc">Convert the advertising type flag to a string.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:355</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_a9885eda5c51477aefc0ba9e1c96d5a34"><div class="ttname"><a href="class_nim_b_l_e_utils.html#a9885eda5c51477aefc0ba9e1c96d5a34">NimBLEUtils::returnCodeToString</a></div><div class="ttdeci">static const char * returnCodeToString(int rc)</div><div class="ttdoc">Converts a return code from the NimBLE stack to a text string.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:62</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_ae521f9a6363c03e42da2f76f64ea431e"><div class="ttname"><a href="class_nim_b_l_e_utils.html#ae521f9a6363c03e42da2f76f64ea431e">NimBLEUtils::checkConnParams</a></div><div class="ttdeci">static int checkConnParams(ble_gap_conn_params *params)</div><div class="ttdoc">A function for checking validity of connection parameters.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:24</div></div>
<div class="ttc" id="aclass_nim_b_l_e_utils_html_afb2df39418324f93a2477e314883ccae"><div class="ttname"><a href="class_nim_b_l_e_utils.html#afb2df39418324f93a2477e314883ccae">NimBLEUtils::gapEventToString</a></div><div class="ttdeci">static const char * gapEventToString(uint8_t eventType)</div><div class="ttdoc">Convert a GAP event type to a string representation.</div><div class="ttdef"><b>Definition:</b> NimBLEUtils.cpp:430</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>NimBLEUtils.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>

132
annotated.html Normal file
View File

@@ -0,0 +1,132 @@
<!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: Class List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('annotated.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">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e2904.html" target="_self">NimBLE2904</a></td><td class="desc">Descriptor for Characteristic Presentation Format </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_address.html" target="_self">NimBLEAddress</a></td><td class="desc">A BLE device address </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertised_device.html" target="_self">NimBLEAdvertisedDevice</a></td><td class="desc">A representation of a BLE advertised device found by a scan </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html" target="_self">NimBLEAdvertisedDeviceCallbacks</a></td><td class="desc">A callback handler for callbacks associated device scanning </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertisement_data.html" target="_self">NimBLEAdvertisementData</a></td><td class="desc">Advertisement data set by the programmer to be published by the BLE server </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertising.html" target="_self">NimBLEAdvertising</a></td><td class="desc">Perform and manage BLE advertising </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_beacon.html" target="_self">NimBLEBeacon</a></td><td class="desc">Representation of a beacon. See: </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_characteristic.html" target="_self">NimBLECharacteristic</a></td><td class="desc">The model of a BLE Characteristic </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html" target="_self">NimBLECharacteristicCallbacks</a></td><td class="desc">Callbacks that can be associated with a BLE characteristic to inform of events </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_client.html" target="_self">NimBLEClient</a></td><td class="desc">A model of a BLE client </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_client_callbacks.html" target="_self">NimBLEClientCallbacks</a></td><td class="desc">Callbacks associated with a BLE client </td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_conn_info.html" target="_self">NimBLEConnInfo</a></td><td class="desc">Connection information </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_descriptor.html" target="_self">NimBLEDescriptor</a></td><td class="desc">A model of a BLE descriptor </td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html" target="_self">NimBLEDescriptorCallbacks</a></td><td class="desc">Callbacks that can be associated with a BLE descriptors to inform of events </td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_device.html" target="_self">NimBLEDevice</a></td><td class="desc">A model of a BLE Device from which all the BLE roles are created </td></tr>
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html" target="_self">NimBLEEddystoneTLM</a></td><td class="desc">Representation of a beacon. See: </td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html" target="_self">NimBLEEddystoneURL</a></td><td class="desc">Representation of a beacon. See: </td></tr>
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_h_i_d_device.html" target="_self">NimBLEHIDDevice</a></td><td class="desc">A model of a BLE Human Interface Device </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_remote_characteristic.html" target="_self">NimBLERemoteCharacteristic</a></td><td class="desc">A model of a remote BLE characteristic </td></tr>
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_remote_descriptor.html" target="_self">NimBLERemoteDescriptor</a></td><td class="desc">A model of remote BLE descriptor </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_remote_service.html" target="_self">NimBLERemoteService</a></td><td class="desc">A model of a remote BLE service </td></tr>
<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_scan.html" target="_self">NimBLEScan</a></td><td class="desc">Perform and manage BLE scans </td></tr>
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_scan_results.html" target="_self">NimBLEScanResults</a></td><td class="desc">A class that contains and operates on the results of a BLE scan </td></tr>
<tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_security.html" target="_self">NimBLESecurity</a></td><td class="desc">A class to handle BLE security operations. <b>Deprecated - provided for backward compatibility only.</b> </td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_security_callbacks.html" target="_self">NimBLESecurityCallbacks</a></td><td class="desc">Callbacks to handle GAP events related to authorization. <b>Deprecated - provided for backward compatibility only.</b> </td></tr>
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_server.html" target="_self">NimBLEServer</a></td><td class="desc">The model of a BLE server </td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_server_callbacks.html" target="_self">NimBLEServerCallbacks</a></td><td class="desc">Callbacks associated with the operation of a BLE server </td></tr>
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_service.html" target="_self">NimBLEService</a></td><td class="desc">The model of a BLE service </td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_utils.html" target="_self">NimBLEUtils</a></td><td class="desc">A BLE Utility class with methods for debugging and general purpose use </td></tr>
<tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_u_u_i_d.html" target="_self">NimBLEUUID</a></td><td class="desc">A model of a BLE UUID </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

33
annotated_dup.js Normal file
View File

@@ -0,0 +1,33 @@
var annotated_dup =
[
[ "NimBLE2904", "class_nim_b_l_e2904.html", "class_nim_b_l_e2904" ],
[ "NimBLEAddress", "class_nim_b_l_e_address.html", "class_nim_b_l_e_address" ],
[ "NimBLEAdvertisedDevice", "class_nim_b_l_e_advertised_device.html", "class_nim_b_l_e_advertised_device" ],
[ "NimBLEAdvertisedDeviceCallbacks", "class_nim_b_l_e_advertised_device_callbacks.html", "class_nim_b_l_e_advertised_device_callbacks" ],
[ "NimBLEAdvertisementData", "class_nim_b_l_e_advertisement_data.html", "class_nim_b_l_e_advertisement_data" ],
[ "NimBLEAdvertising", "class_nim_b_l_e_advertising.html", "class_nim_b_l_e_advertising" ],
[ "NimBLEBeacon", "class_nim_b_l_e_beacon.html", "class_nim_b_l_e_beacon" ],
[ "NimBLECharacteristic", "class_nim_b_l_e_characteristic.html", "class_nim_b_l_e_characteristic" ],
[ "NimBLECharacteristicCallbacks", "class_nim_b_l_e_characteristic_callbacks.html", "class_nim_b_l_e_characteristic_callbacks" ],
[ "NimBLEClient", "class_nim_b_l_e_client.html", "class_nim_b_l_e_client" ],
[ "NimBLEClientCallbacks", "class_nim_b_l_e_client_callbacks.html", "class_nim_b_l_e_client_callbacks" ],
[ "NimBLEConnInfo", "class_nim_b_l_e_conn_info.html", "class_nim_b_l_e_conn_info" ],
[ "NimBLEDescriptor", "class_nim_b_l_e_descriptor.html", "class_nim_b_l_e_descriptor" ],
[ "NimBLEDescriptorCallbacks", "class_nim_b_l_e_descriptor_callbacks.html", "class_nim_b_l_e_descriptor_callbacks" ],
[ "NimBLEDevice", "class_nim_b_l_e_device.html", null ],
[ "NimBLEEddystoneTLM", "class_nim_b_l_e_eddystone_t_l_m.html", "class_nim_b_l_e_eddystone_t_l_m" ],
[ "NimBLEEddystoneURL", "class_nim_b_l_e_eddystone_u_r_l.html", "class_nim_b_l_e_eddystone_u_r_l" ],
[ "NimBLEHIDDevice", "class_nim_b_l_e_h_i_d_device.html", "class_nim_b_l_e_h_i_d_device" ],
[ "NimBLERemoteCharacteristic", "class_nim_b_l_e_remote_characteristic.html", "class_nim_b_l_e_remote_characteristic" ],
[ "NimBLERemoteDescriptor", "class_nim_b_l_e_remote_descriptor.html", "class_nim_b_l_e_remote_descriptor" ],
[ "NimBLERemoteService", "class_nim_b_l_e_remote_service.html", "class_nim_b_l_e_remote_service" ],
[ "NimBLEScan", "class_nim_b_l_e_scan.html", "class_nim_b_l_e_scan" ],
[ "NimBLEScanResults", "class_nim_b_l_e_scan_results.html", "class_nim_b_l_e_scan_results" ],
[ "NimBLESecurity", "class_nim_b_l_e_security.html", "class_nim_b_l_e_security" ],
[ "NimBLESecurityCallbacks", "class_nim_b_l_e_security_callbacks.html", "class_nim_b_l_e_security_callbacks" ],
[ "NimBLEServer", "class_nim_b_l_e_server.html", "class_nim_b_l_e_server" ],
[ "NimBLEServerCallbacks", "class_nim_b_l_e_server_callbacks.html", "class_nim_b_l_e_server_callbacks" ],
[ "NimBLEService", "class_nim_b_l_e_service.html", "class_nim_b_l_e_service" ],
[ "NimBLEUtils", "class_nim_b_l_e_utils.html", null ],
[ "NimBLEUUID", "class_nim_b_l_e_u_u_i_d.html", "class_nim_b_l_e_u_u_i_d" ]
];

BIN
bc_s.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 676 B

BIN
bdwn.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 B

View File

@@ -0,0 +1,120 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e2904.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">NimBLE2904 Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">getCharacteristic</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">getHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">getLength</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">getStringValue</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">getValue</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor</a>(const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a7ecb634b7d6390677cad232bd6be6638">NimBLEDescriptor</a>(NimBLEUUID uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a>(NimBLEDescriptorCallbacks *pCallbacks)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c">setDescription</a>(uint16_t)</td><td class="entry"><a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d">setExponent</a>(int8_t exponent)</td><td class="entry"><a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1">setFormat</a>(uint8_t format)</td><td class="entry"><a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962">setNamespace</a>(uint8_t namespace_value)</td><td class="entry"><a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">setUnit</a>(uint16_t unit)</td><td class="entry"><a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a>(const uint8_t *data, size_t size)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51">setValue</a>(const std::string &amp;value)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">setValue</a>(const T &amp;s)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc">~NimBLEDescriptor</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

209
class_nim_b_l_e2904.html Normal file
View File

@@ -0,0 +1,209 @@
<!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: NimBLE2904 Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e2904.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e2904-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLE2904 Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Descriptor for Characteristic Presentation Format.
<a href="class_nim_b_l_e2904.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a498c863cb3fbf92eecc23f9f8856037c"><td class="memItemLeft" align="right" valign="top"><a id="a498c863cb3fbf92eecc23f9f8856037c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c">setDescription</a> (uint16_t)</td></tr>
<tr class="memdesc:a498c863cb3fbf92eecc23f9f8856037c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the description. <br /></td></tr>
<tr class="separator:a498c863cb3fbf92eecc23f9f8856037c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1c53f99246f67dca1d63b812bef631d"><td class="memItemLeft" align="right" valign="top"><a id="ab1c53f99246f67dca1d63b812bef631d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d">setExponent</a> (int8_t exponent)</td></tr>
<tr class="memdesc:ab1c53f99246f67dca1d63b812bef631d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the exponent. <br /></td></tr>
<tr class="separator:ab1c53f99246f67dca1d63b812bef631d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7f21651b4493fd3daaa0f1545032ff1"><td class="memItemLeft" align="right" valign="top"><a id="ab7f21651b4493fd3daaa0f1545032ff1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1">setFormat</a> (uint8_t format)</td></tr>
<tr class="memdesc:ab7f21651b4493fd3daaa0f1545032ff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the format. <br /></td></tr>
<tr class="separator:ab7f21651b4493fd3daaa0f1545032ff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2206274c217d43a8ba121e1d279f8962"><td class="memItemLeft" align="right" valign="top"><a id="a2206274c217d43a8ba121e1d279f8962"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962">setNamespace</a> (uint8_t namespace_value)</td></tr>
<tr class="memdesc:a2206274c217d43a8ba121e1d279f8962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the namespace. <br /></td></tr>
<tr class="separator:a2206274c217d43a8ba121e1d279f8962"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0cf78a2a1c3418be9a39beaa0c826ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">setUnit</a> (uint16_t unit)</td></tr>
<tr class="memdesc:ad0cf78a2a1c3418be9a39beaa0c826ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the units for this value. It should be one of the encoded values defined here: <a href="https://www.bluetooth.com/specifications/assigned-numbers/units">https://www.bluetooth.com/specifications/assigned-numbers/units</a>. <a href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">More...</a><br /></td></tr>
<tr class="separator:ad0cf78a2a1c3418be9a39beaa0c826ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_nim_b_l_e_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_nim_b_l_e_descriptor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td></tr>
<tr class="memitem:a3cf995352eb1b1c212a7911a05c33b25 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top"><a id="a3cf995352eb1b1c212a7911a05c33b25"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor</a> (const char *uuid, uint16_t properties, uint16_t max_len, <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic=nullptr)</td></tr>
<tr class="memdesc:a3cf995352eb1b1c212a7911a05c33b25 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nim_b_l_e_descriptor.html" title="A model of a BLE descriptor.">NimBLEDescriptor</a> constructor. <br /></td></tr>
<tr class="separator:a3cf995352eb1b1c212a7911a05c33b25 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ecb634b7d6390677cad232bd6be6638 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top"><a id="a7ecb634b7d6390677cad232bd6be6638"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a7ecb634b7d6390677cad232bd6be6638">NimBLEDescriptor</a> (<a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> uuid, uint16_t properties, uint16_t max_len, <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic=nullptr)</td></tr>
<tr class="memdesc:a7ecb634b7d6390677cad232bd6be6638 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nim_b_l_e_descriptor.html" title="A model of a BLE descriptor.">NimBLEDescriptor</a> constructor. <br /></td></tr>
<tr class="separator:a7ecb634b7d6390677cad232bd6be6638 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad110851335bc7b225f5bea9ac11bedcc inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top"><a id="ad110851335bc7b225f5bea9ac11bedcc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc">~NimBLEDescriptor</a> ()</td></tr>
<tr class="memdesc:ad110851335bc7b225f5bea9ac11bedcc inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nim_b_l_e_descriptor.html" title="A model of a BLE descriptor.">NimBLEDescriptor</a> destructor. <br /></td></tr>
<tr class="separator:ad110851335bc7b225f5bea9ac11bedcc inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a486af6799753dfa60b3faddfac2adbcd inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">getHandle</a> ()</td></tr>
<tr class="memdesc:a486af6799753dfa60b3faddfac2adbcd inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the BLE handle for this descriptor. <a href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">More...</a><br /></td></tr>
<tr class="separator:a486af6799753dfa60b3faddfac2adbcd inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc5398a570edc197fbadad3f5b45e186 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top"><a id="abc5398a570edc197fbadad3f5b45e186"></a>
<a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186">getUUID</a> ()</td></tr>
<tr class="memdesc:abc5398a570edc197fbadad3f5b45e186 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID of the descriptor. <br /></td></tr>
<tr class="separator:abc5398a570edc197fbadad3f5b45e186 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac15dc6c9c24d280c4b0eb766080497e5 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">toString</a> ()</td></tr>
<tr class="memdesc:ac15dc6c9c24d280c4b0eb766080497e5 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the descriptor. <a href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">More...</a><br /></td></tr>
<tr class="separator:ac15dc6c9c24d280c4b0eb766080497e5 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9cb8727f9e17cf8050cf619e5fe3096 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a> (<a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> *pCallbacks)</td></tr>
<tr class="memdesc:aa9cb8727f9e17cf8050cf619e5fe3096 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the callback handlers for this descriptor. <a href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">More...</a><br /></td></tr>
<tr class="separator:aa9cb8727f9e17cf8050cf619e5fe3096 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a378346f59afb706d4c1d961227b98c5d inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">getLength</a> ()</td></tr>
<tr class="memdesc:a378346f59afb706d4c1d961227b98c5d inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the length of the value of this descriptor. <a href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">More...</a><br /></td></tr>
<tr class="separator:a378346f59afb706d4c1d961227b98c5d inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac54fd0830ceb64b91037b623dbc427b5 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">getValue</a> ()</td></tr>
<tr class="memdesc:ac54fd0830ceb64b91037b623dbc427b5 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of this descriptor. <a href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">More...</a><br /></td></tr>
<tr class="separator:ac54fd0830ceb64b91037b623dbc427b5 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7153e051e5808469c23e2207fa6711db inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">getStringValue</a> ()</td></tr>
<tr class="memdesc:a7153e051e5808469c23e2207fa6711db inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of this descriptor as a string. <a href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">More...</a><br /></td></tr>
<tr class="separator:a7153e051e5808469c23e2207fa6711db inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9447cee9092dc516266f7764131ba923 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a> (const uint8_t *data, size_t size)</td></tr>
<tr class="memdesc:a9447cee9092dc516266f7764131ba923 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the descriptor. <a href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">More...</a><br /></td></tr>
<tr class="separator:a9447cee9092dc516266f7764131ba923 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad14bda7d046b5f814ed599c8157c7e51 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51">setValue</a> (const std::string &amp;value)</td></tr>
<tr class="memdesc:ad14bda7d046b5f814ed599c8157c7e51 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the descriptor. <a href="class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51">More...</a><br /></td></tr>
<tr class="separator:ad14bda7d046b5f814ed599c8157c7e51 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a412b3735186d94e9ddcf37a06c2055e1 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">getCharacteristic</a> ()</td></tr>
<tr class="memdesc:a412b3735186d94e9ddcf37a06c2055e1 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the characteristic this descriptor belongs to. <a href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">More...</a><br /></td></tr>
<tr class="separator:a412b3735186d94e9ddcf37a06c2055e1 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9136cc9e4b41110b3dd99d1c9553a477 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9136cc9e4b41110b3dd99d1c9553a477 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">setValue</a> (const T &amp;s)</td></tr>
<tr class="memdesc:a9136cc9e4b41110b3dd99d1c9553a477 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience template to set the descriptor value to &lt;type&gt;val. <a href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">More...</a><br /></td></tr>
<tr class="separator:a9136cc9e4b41110b3dd99d1c9553a477 inherit pub_methods_class_nim_b_l_e_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Descriptor for Characteristic Presentation Format. </p>
<p>This is a convenience descriptor for the Characteristic Presentation Format which has a UUID of 0x2904.</p>
<p>See also: <a href="https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml">https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad0cf78a2a1c3418be9a39beaa0c826ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0cf78a2a1c3418be9a39beaa0c826ee">&#9670;&nbsp;</a></span>setUnit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLE2904::setUnit </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>unit</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the units for this value. It should be one of the encoded values defined here: <a href="https://www.bluetooth.com/specifications/assigned-numbers/units">https://www.bluetooth.com/specifications/assigned-numbers/units</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">unit</td><td>The type of units of this characteristic as defined by assigned numbers. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

8
class_nim_b_l_e2904.js Normal file
View File

@@ -0,0 +1,8 @@
var class_nim_b_l_e2904 =
[
[ "setDescription", "class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c", null ],
[ "setExponent", "class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d", null ],
[ "setFormat", "class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1", null ],
[ "setNamespace", "class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962", null ],
[ "setUnit", "class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee", null ]
];

View File

@@ -0,0 +1,114 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_address.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">NimBLEAddress Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">equals</a>(const NimBLEAddress &amp;otherAddress) const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">getNative</a>() const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">getType</a>() const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#ab8c9105b825ed0be5d1bbab966f2a0cf">NimBLEAddress</a>(ble_addr_t address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a92637adc75c8010bcf34e2dd8f16cd94">NimBLEAddress</a>(uint8_t address[6], uint8_t type=BLE_ADDR_PUBLIC)</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#aeb6dafff197dc01e2713bbf43e21f1f3">NimBLEAddress</a>(const std::string &amp;stringAddress, uint8_t type=BLE_ADDR_PUBLIC)</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a139790cf03d8297e253e5353a0213bff">NimBLEAddress</a>(const uint64_t &amp;address, uint8_t type=BLE_ADDR_PUBLIC)</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a5398ed7c6d8e95a7527103095e07093a">operator std::string</a>() const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#aa7d5d8d323d2846bf2082b83381bd7c8">operator uint64_t</a>() const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce">operator!=</a>(const NimBLEAddress &amp;rhs) const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164">operator==</a>(const NimBLEAddress &amp;rhs) const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">toString</a>() const</td><td class="entry"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,408 @@
<!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: NimBLEAddress Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_address.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_address-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEAddress Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A BLE device address.
<a href="class_nim_b_l_e_address.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19058addb94417e2921cade37a79d04c"><td class="memItemLeft" align="right" valign="top"><a id="a19058addb94417e2921cade37a79d04c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c">NimBLEAddress</a> ()</td></tr>
<tr class="memdesc:a19058addb94417e2921cade37a79d04c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a blank address, i.e. 00:00:00:00:00:00, type 0. <br /></td></tr>
<tr class="separator:a19058addb94417e2921cade37a79d04c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8c9105b825ed0be5d1bbab966f2a0cf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#ab8c9105b825ed0be5d1bbab966f2a0cf">NimBLEAddress</a> (ble_addr_t address)</td></tr>
<tr class="memdesc:ab8c9105b825ed0be5d1bbab966f2a0cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an address from the native NimBLE representation. <a href="class_nim_b_l_e_address.html#ab8c9105b825ed0be5d1bbab966f2a0cf">More...</a><br /></td></tr>
<tr class="separator:ab8c9105b825ed0be5d1bbab966f2a0cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92637adc75c8010bcf34e2dd8f16cd94"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a92637adc75c8010bcf34e2dd8f16cd94">NimBLEAddress</a> (uint8_t address[6], uint8_t type=BLE_ADDR_PUBLIC)</td></tr>
<tr class="memdesc:a92637adc75c8010bcf34e2dd8f16cd94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for compatibility with bluedroid esp library using native ESP representation. <a href="class_nim_b_l_e_address.html#a92637adc75c8010bcf34e2dd8f16cd94">More...</a><br /></td></tr>
<tr class="separator:a92637adc75c8010bcf34e2dd8f16cd94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb6dafff197dc01e2713bbf43e21f1f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#aeb6dafff197dc01e2713bbf43e21f1f3">NimBLEAddress</a> (const std::string &amp;stringAddress, uint8_t type=BLE_ADDR_PUBLIC)</td></tr>
<tr class="memdesc:aeb6dafff197dc01e2713bbf43e21f1f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an address from a hex string. <a href="class_nim_b_l_e_address.html#aeb6dafff197dc01e2713bbf43e21f1f3">More...</a><br /></td></tr>
<tr class="separator:aeb6dafff197dc01e2713bbf43e21f1f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a139790cf03d8297e253e5353a0213bff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a139790cf03d8297e253e5353a0213bff">NimBLEAddress</a> (const uint64_t &amp;address, uint8_t type=BLE_ADDR_PUBLIC)</td></tr>
<tr class="memdesc:a139790cf03d8297e253e5353a0213bff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for address using a hex value.<br />
Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16". <a href="class_nim_b_l_e_address.html#a139790cf03d8297e253e5353a0213bff">More...</a><br /></td></tr>
<tr class="separator:a139790cf03d8297e253e5353a0213bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a826fe8850cbc7d54f0696b8af4637169"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">equals</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;otherAddress) const</td></tr>
<tr class="memdesc:a826fe8850cbc7d54f0696b8af4637169"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if this address equals another. <a href="class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169">More...</a><br /></td></tr>
<tr class="separator:a826fe8850cbc7d54f0696b8af4637169"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adef69a03a08303957d7e40eef07b4d80"><td class="memItemLeft" align="right" valign="top">const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">getNative</a> () const</td></tr>
<tr class="memdesc:adef69a03a08303957d7e40eef07b4d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the native representation of the address. <a href="class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80">More...</a><br /></td></tr>
<tr class="separator:adef69a03a08303957d7e40eef07b4d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac53b0cc945e1505d3e72d48164ad01d6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">toString</a> () const</td></tr>
<tr class="memdesc:ac53b0cc945e1505d3e72d48164ad01d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a BLE address to a string. <a href="class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6">More...</a><br /></td></tr>
<tr class="separator:ac53b0cc945e1505d3e72d48164ad01d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18f8361ed20146cbc374a246d87015eb"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">getType</a> () const</td></tr>
<tr class="memdesc:a18f8361ed20146cbc374a246d87015eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the address type. <a href="class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb">More...</a><br /></td></tr>
<tr class="separator:a18f8361ed20146cbc374a246d87015eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87e8ccc81c2d83bf0503166939319164"><td class="memItemLeft" align="right" valign="top"><a id="a87e8ccc81c2d83bf0503166939319164"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164">operator==</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;rhs) const</td></tr>
<tr class="memdesc:a87e8ccc81c2d83bf0503166939319164"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convienience operator to check if this address is equal to another. <br /></td></tr>
<tr class="separator:a87e8ccc81c2d83bf0503166939319164"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae243127c78af69b26dfa225effd806ce"><td class="memItemLeft" align="right" valign="top"><a id="ae243127c78af69b26dfa225effd806ce"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce">operator!=</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;rhs) const</td></tr>
<tr class="memdesc:ae243127c78af69b26dfa225effd806ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convienience operator to check if this address is not equal to another. <br /></td></tr>
<tr class="separator:ae243127c78af69b26dfa225effd806ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5398ed7c6d8e95a7527103095e07093a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#a5398ed7c6d8e95a7527103095e07093a">operator std::string</a> () const</td></tr>
<tr class="memdesc:a5398ed7c6d8e95a7527103095e07093a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convienience operator to convert this address to string representation. <a href="class_nim_b_l_e_address.html#a5398ed7c6d8e95a7527103095e07093a">More...</a><br /></td></tr>
<tr class="separator:a5398ed7c6d8e95a7527103095e07093a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7d5d8d323d2846bf2082b83381bd7c8"><td class="memItemLeft" align="right" valign="top"><a id="aa7d5d8d323d2846bf2082b83381bd7c8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_address.html#aa7d5d8d323d2846bf2082b83381bd7c8">operator uint64_t</a> () const</td></tr>
<tr class="memdesc:aa7d5d8d323d2846bf2082b83381bd7c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convienience operator to convert the native address representation to uint_64. <br /></td></tr>
<tr class="separator:aa7d5d8d323d2846bf2082b83381bd7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A BLE device address. </p>
<p>Every BLE device has a unique address which can be used to identify it and form connections. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab8c9105b825ed0be5d1bbab966f2a0cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8c9105b825ed0be5d1bbab966f2a0cf">&#9670;&nbsp;</a></span>NimBLEAddress() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLEAddress::NimBLEAddress </td>
<td>(</td>
<td class="paramtype">ble_addr_t&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an address from the native NimBLE representation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The native NimBLE address. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a92637adc75c8010bcf34e2dd8f16cd94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92637adc75c8010bcf34e2dd8f16cd94">&#9670;&nbsp;</a></span>NimBLEAddress() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLEAddress::NimBLEAddress </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>address</em>[6], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>type</em> = <code>BLE_ADDR_PUBLIC</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for compatibility with bluedroid esp library using native ESP representation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>A uint8_t[6] or esp_bd_addr_t containing the address. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the address. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeb6dafff197dc01e2713bbf43e21f1f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb6dafff197dc01e2713bbf43e21f1f3">&#9670;&nbsp;</a></span>NimBLEAddress() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLEAddress::NimBLEAddress </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>stringAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>type</em> = <code>BLE_ADDR_PUBLIC</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an address from a hex string. </p>
<p>A hex string is of the format: </p><div class="fragment"><div class="line">00:00:00:00:00:00</div>
</div><!-- fragment --><p> which is 17 characters in length.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stringAddress</td><td>The hex string representation of the address. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the address. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a139790cf03d8297e253e5353a0213bff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a139790cf03d8297e253e5353a0213bff">&#9670;&nbsp;</a></span>NimBLEAddress() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLEAddress::NimBLEAddress </td>
<td>(</td>
<td class="paramtype">const uint64_t &amp;&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>type</em> = <code>BLE_ADDR_PUBLIC</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for address using a hex value.<br />
Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16". </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>uint64_t containing the address. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the address. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a826fe8850cbc7d54f0696b8af4637169"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a826fe8850cbc7d54f0696b8af4637169">&#9670;&nbsp;</a></span>equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEAddress::equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;&#160;</td>
<td class="paramname"><em>otherAddress</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if this address equals another. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">otherAddress</td><td>The other address to compare against. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the addresses are equal. </dd></dl>
</div>
</div>
<a id="adef69a03a08303957d7e40eef07b4d80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adef69a03a08303957d7e40eef07b4d80">&#9670;&nbsp;</a></span>getNative()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t * NimBLEAddress::getNative </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the native representation of the address. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the uint8_t[6] array of the address. </dd></dl>
</div>
</div>
<a id="a18f8361ed20146cbc374a246d87015eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18f8361ed20146cbc374a246d87015eb">&#9670;&nbsp;</a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t NimBLEAddress::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the address type. </p>
<dl class="section return"><dt>Returns</dt><dd>The address type. </dd></dl>
</div>
</div>
<a id="a5398ed7c6d8e95a7527103095e07093a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5398ed7c6d8e95a7527103095e07093a">&#9670;&nbsp;</a></span>operator std::string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLEAddress::operator std::string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convienience operator to convert this address to string representation. </p>
<p>This allows passing <a class="el" href="class_nim_b_l_e_address.html" title="A BLE device address.">NimBLEAddress</a> to functions that accept std::string and/or or it's methods as a parameter. </p>
</div>
</div>
<a id="ac53b0cc945e1505d3e72d48164ad01d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac53b0cc945e1505d3e72d48164ad01d6">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEAddress::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a BLE address to a string. </p>
<p>A string representation of an address is in the format:</p>
<div class="fragment"><div class="line">xx:xx:xx:xx:xx:xx</div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The string representation of the address. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use std::string() operator instead. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,16 @@
var class_nim_b_l_e_address =
[
[ "NimBLEAddress", "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c", null ],
[ "NimBLEAddress", "class_nim_b_l_e_address.html#ab8c9105b825ed0be5d1bbab966f2a0cf", null ],
[ "NimBLEAddress", "class_nim_b_l_e_address.html#a92637adc75c8010bcf34e2dd8f16cd94", null ],
[ "NimBLEAddress", "class_nim_b_l_e_address.html#aeb6dafff197dc01e2713bbf43e21f1f3", null ],
[ "NimBLEAddress", "class_nim_b_l_e_address.html#a139790cf03d8297e253e5353a0213bff", null ],
[ "equals", "class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169", null ],
[ "getNative", "class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80", null ],
[ "getType", "class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb", null ],
[ "operator std::string", "class_nim_b_l_e_address.html#a5398ed7c6d8e95a7527103095e07093a", null ],
[ "operator uint64_t", "class_nim_b_l_e_address.html#aa7d5d8d323d2846bf2082b83381bd7c8", null ],
[ "operator!=", "class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce", null ],
[ "operator==", "class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164", null ],
[ "toString", "class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6", null ]
];

View File

@@ -0,0 +1,143 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertised_device.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">NimBLEAdvertisedDevice Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#aa60721a7b5b44a3bb66980f003517579">getAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#afc79cdc087c81b34643d70c8259eb9a3">getAddressType</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9a7a36e9937e16ffab4f1543ea54073f">getAdvInterval</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ae960e43434bf62ec83e9230d7bf7046c">getAdvLength</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9d07ee4c38de4170db24a5e01663ee6d">getAdvType</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a228afa5e43421b4d96d9c08241718309">getAppearance</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2">getManufacturerData</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295">getManufacturerData</a>(bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a450eca96c605f199d2786a044612db17">getMaxInterval</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a33fcdc3bf5107c157b10ad4519938c9f">getMinInterval</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ae6c6b48369d71a5998c1393c0d6a0179">getName</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#afacf7717a15b36af184cd957d397e384">getPayload</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ac7879f4aa0f2b069b1d3aff4809ae62c">getPayloadLength</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#acd42dfbc92a43fc90e933df975c029f3">getRSSI</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ad3931c72aaded3b594896c29b3691562">getScan</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb">getServiceData</a>(uint8_t index=0)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#acf4398ca81f800445092ccc77deaf00b">getServiceData</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70">getServiceData</a>(uint8_t index=0, bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009">getServiceData</a>(const NimBLEUUID &amp;uuid, bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a5fc9be9de9209622259f8d28b01825df">getServiceDataCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a4f89e99dffdfde45c1cafff74a20a95f">getServiceDataUUID</a>(uint8_t index=0)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ab53f862df15953d19ba7a45d4cf51b46">getServiceUUID</a>(uint8_t index=0)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a6dc4484bc89ea5560a51c349b5300049">getServiceUUIDCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a599cad9a3f3d535049c87a911bc1b14d">getTargetAddress</a>(uint8_t index=0)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a9352a7760d9e4af0561d7923fcbe2535">getTargetAddressCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a1855415f3c60bc88d62e9206fe6ed75a">getTimestamp</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#afee346437447173eed1b9edf1de70f34">getTXPower</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ad65f8040a142f8d6d0763d4876f0d22e">getURI</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#aa8b4660e5d123f16a07e0fefa3bcf4bc">haveAdvInterval</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#accc6713f85db6174cfe8436059aa8bf1">haveAppearance</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a3274624943c942f357c6f8d489481bc8">haveConnParams</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#abe58f5fde119d8c0a8fb85ba1e8cc5c9">haveManufacturerData</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a86805fecd4432335feecf77bb6a0f12e">haveName</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a611802e8898e422842d60486b60b8c42">haveRSSI</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#afba3425cfcfc12eca219a1abe5f6732c">haveServiceData</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a5c4aae7e27c27201846ba4e15448e557">haveServiceUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a1172d33a77bc018e314be78664b222b9">haveTargetAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#af5293030ef439856c195caa3aba86543">haveTXPower</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a83ebd08b512dc936b1059db7a69b9ead">haveURI</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#a37ad095c066aa231a52a7259734c9bce">isAdvertisingService</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ab8972714ecd578fca51fb63d9834a34e">NimBLEAdvertisedDevice</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html#ac1b8ff0f2897abda335743d55668fcd9">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,45 @@
var class_nim_b_l_e_advertised_device =
[
[ "NimBLEAdvertisedDevice", "class_nim_b_l_e_advertised_device.html#ab8972714ecd578fca51fb63d9834a34e", null ],
[ "getAddress", "class_nim_b_l_e_advertised_device.html#aa60721a7b5b44a3bb66980f003517579", null ],
[ "getAddressType", "class_nim_b_l_e_advertised_device.html#afc79cdc087c81b34643d70c8259eb9a3", null ],
[ "getAdvInterval", "class_nim_b_l_e_advertised_device.html#a9a7a36e9937e16ffab4f1543ea54073f", null ],
[ "getAdvLength", "class_nim_b_l_e_advertised_device.html#ae960e43434bf62ec83e9230d7bf7046c", null ],
[ "getAdvType", "class_nim_b_l_e_advertised_device.html#a9d07ee4c38de4170db24a5e01663ee6d", null ],
[ "getAppearance", "class_nim_b_l_e_advertised_device.html#a228afa5e43421b4d96d9c08241718309", null ],
[ "getManufacturerData", "class_nim_b_l_e_advertised_device.html#afa334006230601cc5c6429b18819a2e2", null ],
[ "getManufacturerData", "class_nim_b_l_e_advertised_device.html#ae9a586e46a555cf5fc817c9fe301b295", null ],
[ "getMaxInterval", "class_nim_b_l_e_advertised_device.html#a450eca96c605f199d2786a044612db17", null ],
[ "getMinInterval", "class_nim_b_l_e_advertised_device.html#a33fcdc3bf5107c157b10ad4519938c9f", null ],
[ "getName", "class_nim_b_l_e_advertised_device.html#ae6c6b48369d71a5998c1393c0d6a0179", null ],
[ "getPayload", "class_nim_b_l_e_advertised_device.html#afacf7717a15b36af184cd957d397e384", null ],
[ "getPayloadLength", "class_nim_b_l_e_advertised_device.html#ac7879f4aa0f2b069b1d3aff4809ae62c", null ],
[ "getRSSI", "class_nim_b_l_e_advertised_device.html#acd42dfbc92a43fc90e933df975c029f3", null ],
[ "getScan", "class_nim_b_l_e_advertised_device.html#ad3931c72aaded3b594896c29b3691562", null ],
[ "getServiceData", "class_nim_b_l_e_advertised_device.html#acf4398ca81f800445092ccc77deaf00b", null ],
[ "getServiceData", "class_nim_b_l_e_advertised_device.html#a9ca1c022e10764ec72850ff3a011b009", null ],
[ "getServiceData", "class_nim_b_l_e_advertised_device.html#aecb3e30a94abd59401cafb70a5903abb", null ],
[ "getServiceData", "class_nim_b_l_e_advertised_device.html#a9017ce5b59bdae3cebf33c54f28cee70", null ],
[ "getServiceDataCount", "class_nim_b_l_e_advertised_device.html#a5fc9be9de9209622259f8d28b01825df", null ],
[ "getServiceDataUUID", "class_nim_b_l_e_advertised_device.html#a4f89e99dffdfde45c1cafff74a20a95f", null ],
[ "getServiceUUID", "class_nim_b_l_e_advertised_device.html#ab53f862df15953d19ba7a45d4cf51b46", null ],
[ "getServiceUUIDCount", "class_nim_b_l_e_advertised_device.html#a6dc4484bc89ea5560a51c349b5300049", null ],
[ "getTargetAddress", "class_nim_b_l_e_advertised_device.html#a599cad9a3f3d535049c87a911bc1b14d", null ],
[ "getTargetAddressCount", "class_nim_b_l_e_advertised_device.html#a9352a7760d9e4af0561d7923fcbe2535", null ],
[ "getTimestamp", "class_nim_b_l_e_advertised_device.html#a1855415f3c60bc88d62e9206fe6ed75a", null ],
[ "getTXPower", "class_nim_b_l_e_advertised_device.html#afee346437447173eed1b9edf1de70f34", null ],
[ "getURI", "class_nim_b_l_e_advertised_device.html#ad65f8040a142f8d6d0763d4876f0d22e", null ],
[ "haveAdvInterval", "class_nim_b_l_e_advertised_device.html#aa8b4660e5d123f16a07e0fefa3bcf4bc", null ],
[ "haveAppearance", "class_nim_b_l_e_advertised_device.html#accc6713f85db6174cfe8436059aa8bf1", null ],
[ "haveConnParams", "class_nim_b_l_e_advertised_device.html#a3274624943c942f357c6f8d489481bc8", null ],
[ "haveManufacturerData", "class_nim_b_l_e_advertised_device.html#abe58f5fde119d8c0a8fb85ba1e8cc5c9", null ],
[ "haveName", "class_nim_b_l_e_advertised_device.html#a86805fecd4432335feecf77bb6a0f12e", null ],
[ "haveRSSI", "class_nim_b_l_e_advertised_device.html#a611802e8898e422842d60486b60b8c42", null ],
[ "haveServiceData", "class_nim_b_l_e_advertised_device.html#afba3425cfcfc12eca219a1abe5f6732c", null ],
[ "haveServiceUUID", "class_nim_b_l_e_advertised_device.html#a5c4aae7e27c27201846ba4e15448e557", null ],
[ "haveTargetAddress", "class_nim_b_l_e_advertised_device.html#a1172d33a77bc018e314be78664b222b9", null ],
[ "haveTXPower", "class_nim_b_l_e_advertised_device.html#af5293030ef439856c195caa3aba86543", null ],
[ "haveURI", "class_nim_b_l_e_advertised_device.html#a83ebd08b512dc936b1059db7a69b9ead", null ],
[ "isAdvertisingService", "class_nim_b_l_e_advertised_device.html#a37ad095c066aa231a52a7259734c9bce", null ],
[ "toString", "class_nim_b_l_e_advertised_device.html#ac1b8ff0f2897abda335743d55668fcd9", null ]
];

View File

@@ -0,0 +1,102 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertised_device_callbacks.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">NimBLEAdvertisedDeviceCallbacks Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606">onResult</a>(NimBLEAdvertisedDevice *advertisedDevice)=0</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,145 @@
<!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: NimBLEAdvertisedDeviceCallbacks Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertised_device_callbacks.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_advertised_device_callbacks-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEAdvertisedDeviceCallbacks Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A callback handler for callbacks associated device scanning.
<a href="class_nim_b_l_e_advertised_device_callbacks.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af6a25e1bb773a147536b1785b2aae606"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606">onResult</a> (<a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *advertisedDevice)=0</td></tr>
<tr class="memdesc:af6a25e1bb773a147536b1785b2aae606"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a new scan result is detected. <a href="class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606">More...</a><br /></td></tr>
<tr class="separator:af6a25e1bb773a147536b1785b2aae606"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A callback handler for callbacks associated device scanning. </p>
<p>When we are performing a scan as a BLE client, we may wish to know when a new device that is advertising has been found. This class can be sub-classed and registered such that when a scan is performed and a new advertised device has been found, we will be called back to be notified. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af6a25e1bb773a147536b1785b2aae606"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6a25e1bb773a147536b1785b2aae606">&#9670;&nbsp;</a></span>onResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void NimBLEAdvertisedDeviceCallbacks::onResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *&#160;</td>
<td class="paramname"><em>advertisedDevice</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a new scan result is detected. </p>
<p>As we are scanning, we will find new devices. When found, this call back is invoked with a reference to the device that was found. During any individual scan, a device will only be detected one time. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,4 @@
var class_nim_b_l_e_advertised_device_callbacks =
[
[ "onResult", "class_nim_b_l_e_advertised_device_callbacks.html#af6a25e1bb773a147536b1785b2aae606", null ]
];

View File

@@ -0,0 +1,119 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertisement_data.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">NimBLEAdvertisementData Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870">addData</a>(const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a2328f7df89a11d58818e98a6c889c8d4">addData</a>(char *data, size_t length)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a480ffc91f212e877ae31ab47190006c3">addTxPower</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1">getPayload</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32">setAppearance</a>(uint16_t appearance)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822">setCompleteServices</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb">setCompleteServices16</a>(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f">setCompleteServices32</a>(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2">setFlags</a>(uint8_t)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27">setManufacturerData</a>(const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf">setName</a>(const std::string &amp;name)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85">setPartialServices</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4">setPartialServices16</a>(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306">setPartialServices32</a>(const std::vector&lt; NimBLEUUID &gt; &amp;v_uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5">setPreferredParams</a>(uint16_t min, uint16_t max)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5">setServiceData</a>(const NimBLEUUID &amp;uuid, const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5">setShortName</a>(const std::string &amp;name)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36">setURI</a>(const std::string &amp;uri)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,642 @@
<!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: NimBLEAdvertisementData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertisement_data.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_advertisement_data-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEAdvertisementData Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Advertisement data set by the programmer to be published by the BLE server.
<a href="class_nim_b_l_e_advertisement_data.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0f209913ef9f3dfb5be8db39567b4f32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32">setAppearance</a> (uint16_t appearance)</td></tr>
<tr class="memdesc:a0f209913ef9f3dfb5be8db39567b4f32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the appearance. <a href="class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32">More...</a><br /></td></tr>
<tr class="separator:a0f209913ef9f3dfb5be8db39567b4f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67fd95e586559b73964d5739051f3822"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822">setCompleteServices</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:a67fd95e586559b73964d5739051f3822"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a single service to advertise as a complete list of services. <a href="class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822">More...</a><br /></td></tr>
<tr class="separator:a67fd95e586559b73964d5739051f3822"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50a2584346208ef28274eeecc5befffb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb">setCompleteServices16</a> (const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;v_uuid)</td></tr>
<tr class="memdesc:a50a2584346208ef28274eeecc5befffb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the complete list of 16 bit services to advertise. <a href="class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb">More...</a><br /></td></tr>
<tr class="separator:a50a2584346208ef28274eeecc5befffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a712aa09a4d7f2b3cae9b2f1f1be6372f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f">setCompleteServices32</a> (const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;v_uuid)</td></tr>
<tr class="memdesc:a712aa09a4d7f2b3cae9b2f1f1be6372f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the complete list of 32 bit services to advertise. <a href="class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f">More...</a><br /></td></tr>
<tr class="separator:a712aa09a4d7f2b3cae9b2f1f1be6372f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73766a872477512bd750c773d96ca4e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2">setFlags</a> (uint8_t)</td></tr>
<tr class="memdesc:a73766a872477512bd750c773d96ca4e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisement flags. <a href="class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2">More...</a><br /></td></tr>
<tr class="separator:a73766a872477512bd750c773d96ca4e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4df88b578782cda2bd77368b50f2d27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27">setManufacturerData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:aa4df88b578782cda2bd77368b50f2d27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set manufacturer specific data. <a href="class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27">More...</a><br /></td></tr>
<tr class="separator:aa4df88b578782cda2bd77368b50f2d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa003bc4cf9bff2b2bcac9b742ec97a36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36">setURI</a> (const std::string &amp;uri)</td></tr>
<tr class="memdesc:aa003bc4cf9bff2b2bcac9b742ec97a36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the URI to advertise. <a href="class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36">More...</a><br /></td></tr>
<tr class="separator:aa003bc4cf9bff2b2bcac9b742ec97a36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a885b4ed75dd71c4c19b86048c16350bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf">setName</a> (const std::string &amp;name)</td></tr>
<tr class="memdesc:a885b4ed75dd71c4c19b86048c16350bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the complete name of this device. <a href="class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf">More...</a><br /></td></tr>
<tr class="separator:a885b4ed75dd71c4c19b86048c16350bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af52546d7c3b733a831f6232a845bef85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85">setPartialServices</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:af52546d7c3b733a831f6232a845bef85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a single service to advertise as a partial list of services. <a href="class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85">More...</a><br /></td></tr>
<tr class="separator:af52546d7c3b733a831f6232a845bef85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50063c7ffa24f0f0407366a450e23ae4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4">setPartialServices16</a> (const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;v_uuid)</td></tr>
<tr class="memdesc:a50063c7ffa24f0f0407366a450e23ae4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the partial list of services to advertise. <a href="class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4">More...</a><br /></td></tr>
<tr class="separator:a50063c7ffa24f0f0407366a450e23ae4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ff5a72bccd349e551270ceadf528306"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306">setPartialServices32</a> (const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;v_uuid)</td></tr>
<tr class="memdesc:a0ff5a72bccd349e551270ceadf528306"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the partial list of services to advertise. <a href="class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306">More...</a><br /></td></tr>
<tr class="separator:a0ff5a72bccd349e551270ceadf528306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee4fdb5af06fcda9cab9fad3f5bf80d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5">setServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, const std::string &amp;data)</td></tr>
<tr class="memdesc:aee4fdb5af06fcda9cab9fad3f5bf80d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the service data (UUID + data) <a href="class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5">More...</a><br /></td></tr>
<tr class="separator:aee4fdb5af06fcda9cab9fad3f5bf80d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5b514ad9be6552727f1c7a744a29ae5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5">setShortName</a> (const std::string &amp;name)</td></tr>
<tr class="memdesc:ae5b514ad9be6552727f1c7a744a29ae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the short name. <a href="class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5">More...</a><br /></td></tr>
<tr class="separator:ae5b514ad9be6552727f1c7a744a29ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec5f567059c4b4fd0f6b5fc74a0ce870"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870">addData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:aec5f567059c4b4fd0f6b5fc74a0ce870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add data to the payload to be advertised. <a href="class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870">More...</a><br /></td></tr>
<tr class="separator:aec5f567059c4b4fd0f6b5fc74a0ce870"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2328f7df89a11d58818e98a6c889c8d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a2328f7df89a11d58818e98a6c889c8d4">addData</a> (char *data, size_t length)</td></tr>
<tr class="memdesc:a2328f7df89a11d58818e98a6c889c8d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add data to the payload to be advertised. <a href="class_nim_b_l_e_advertisement_data.html#a2328f7df89a11d58818e98a6c889c8d4">More...</a><br /></td></tr>
<tr class="separator:a2328f7df89a11d58818e98a6c889c8d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a480ffc91f212e877ae31ab47190006c3"><td class="memItemLeft" align="right" valign="top"><a id="a480ffc91f212e877ae31ab47190006c3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a480ffc91f212e877ae31ab47190006c3">addTxPower</a> ()</td></tr>
<tr class="memdesc:a480ffc91f212e877ae31ab47190006c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds Tx power level to the advertisement data. <br /></td></tr>
<tr class="separator:a480ffc91f212e877ae31ab47190006c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58ba06eb062a47cc58ba2829af8aafa5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5">setPreferredParams</a> (uint16_t min, uint16_t max)</td></tr>
<tr class="memdesc:a58ba06eb062a47cc58ba2829af8aafa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the preferred connection interval parameters. <a href="class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5">More...</a><br /></td></tr>
<tr class="separator:a58ba06eb062a47cc58ba2829af8aafa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbd638708c8b8b4663c09107bc38feb1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1">getPayload</a> ()</td></tr>
<tr class="memdesc:acbd638708c8b8b4663c09107bc38feb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the payload that is to be advertised. <a href="class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1">More...</a><br /></td></tr>
<tr class="separator:acbd638708c8b8b4663c09107bc38feb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Advertisement data set by the programmer to be published by the BLE server. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2328f7df89a11d58818e98a6c889c8d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2328f7df89a11d58818e98a6c889c8d4">&#9670;&nbsp;</a></span>addData() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::addData </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add data to the payload to be advertised. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be added to the payload. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The size of data to be added to the payload. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aec5f567059c4b4fd0f6b5fc74a0ce870"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec5f567059c4b4fd0f6b5fc74a0ce870">&#9670;&nbsp;</a></span>addData() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::addData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add data to the payload to be advertised. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be added to the payload. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acbd638708c8b8b4663c09107bc38feb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbd638708c8b8b4663c09107bc38feb1">&#9670;&nbsp;</a></span>getPayload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEAdvertisementData::getPayload </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the payload that is to be advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The payload that is to be advertised. </dd></dl>
</div>
</div>
<a id="a0f209913ef9f3dfb5be8db39567b4f32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f209913ef9f3dfb5be8db39567b4f32">&#9670;&nbsp;</a></span>setAppearance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setAppearance </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>appearance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the appearance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">appearance</td><td>The appearance code value.</td></tr>
</table>
</dd>
</dl>
<p>See also: <a href="https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml">https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml</a> </p>
</div>
</div>
<a id="a67fd95e586559b73964d5739051f3822"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67fd95e586559b73964d5739051f3822">&#9670;&nbsp;</a></span>setCompleteServices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setCompleteServices </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a single service to advertise as a complete list of services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The service to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a50a2584346208ef28274eeecc5befffb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50a2584346208ef28274eeecc5befffb">&#9670;&nbsp;</a></span>setCompleteServices16()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setCompleteServices16 </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>v_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the complete list of 16 bit services to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 16 bit UUID's to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a712aa09a4d7f2b3cae9b2f1f1be6372f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a712aa09a4d7f2b3cae9b2f1f1be6372f">&#9670;&nbsp;</a></span>setCompleteServices32()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setCompleteServices32 </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>v_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the complete list of 32 bit services to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 32 bit UUID's to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a73766a872477512bd750c773d96ca4e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73766a872477512bd750c773d96ca4e2">&#9670;&nbsp;</a></span>setFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setFlags </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertisement flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">flag</td><td>The flags to be set in the advertisement.<ul>
<li>BLE_HS_ADV_F_DISC_LTD</li>
<li>BLE_HS_ADV_F_DISC_GEN</li>
<li>BLE_HS_ADV_F_BREDR_UNSUP - must always use with NimBLE </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa4df88b578782cda2bd77368b50f2d27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4df88b578782cda2bd77368b50f2d27">&#9670;&nbsp;</a></span>setManufacturerData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setManufacturerData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set manufacturer specific data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The manufacturer data to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a885b4ed75dd71c4c19b86048c16350bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a885b4ed75dd71c4c19b86048c16350bf">&#9670;&nbsp;</a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setName </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the complete name of this device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af52546d7c3b733a831f6232a845bef85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af52546d7c3b733a831f6232a845bef85">&#9670;&nbsp;</a></span>setPartialServices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setPartialServices </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a single service to advertise as a partial list of services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The service to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a50063c7ffa24f0f0407366a450e23ae4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50063c7ffa24f0f0407366a450e23ae4">&#9670;&nbsp;</a></span>setPartialServices16()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setPartialServices16 </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>v_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the partial list of services to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 16 bit UUID's to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0ff5a72bccd349e551270ceadf528306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ff5a72bccd349e551270ceadf528306">&#9670;&nbsp;</a></span>setPartialServices32()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setPartialServices32 </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>v_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the partial list of services to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">v_uuid</td><td>A vector of 32 bit UUID's to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a58ba06eb062a47cc58ba2829af8aafa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58ba06eb062a47cc58ba2829af8aafa5">&#9670;&nbsp;</a></span>setPreferredParams()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setPreferredParams </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>max</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the preferred connection interval parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">min</td><td>The minimum interval desired. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max</td><td>The maximum interval desired. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aee4fdb5af06fcda9cab9fad3f5bf80d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee4fdb5af06fcda9cab9fad3f5bf80d5">&#9670;&nbsp;</a></span>setServiceData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setServiceData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the service data (UUID + data) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID to set with the service data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to be associated with the service data advertised. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5b514ad9be6552727f1c7a744a29ae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5b514ad9be6552727f1c7a744a29ae5">&#9670;&nbsp;</a></span>setShortName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setShortName </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the short name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The short name of the device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa003bc4cf9bff2b2bcac9b742ec97a36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa003bc4cf9bff2b2bcac9b742ec97a36">&#9670;&nbsp;</a></span>setURI()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertisementData::setURI </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>uri</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the URI to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uri</td><td>The uri to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,21 @@
var class_nim_b_l_e_advertisement_data =
[
[ "addData", "class_nim_b_l_e_advertisement_data.html#a2328f7df89a11d58818e98a6c889c8d4", null ],
[ "addData", "class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870", null ],
[ "addTxPower", "class_nim_b_l_e_advertisement_data.html#a480ffc91f212e877ae31ab47190006c3", null ],
[ "getPayload", "class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1", null ],
[ "setAppearance", "class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32", null ],
[ "setCompleteServices", "class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822", null ],
[ "setCompleteServices16", "class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb", null ],
[ "setCompleteServices32", "class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f", null ],
[ "setFlags", "class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2", null ],
[ "setManufacturerData", "class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27", null ],
[ "setName", "class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf", null ],
[ "setPartialServices", "class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85", null ],
[ "setPartialServices16", "class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4", null ],
[ "setPartialServices32", "class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306", null ],
[ "setPreferredParams", "class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5", null ],
[ "setServiceData", "class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5", null ],
[ "setShortName", "class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5", null ],
[ "setURI", "class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36", null ]
];

View File

@@ -0,0 +1,125 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertising.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">NimBLEAdvertising Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69">addServiceUUID</a>(const NimBLEUUID &amp;serviceUUID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a5e596e8dfa9268554a5b189380405d5c">addServiceUUID</a>(const char *serviceUUID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#ac4ff0af45d1f7ed5bc208612852bc43a">addTxPower</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2">advCompleteCB</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#ac257ab68520a244cb6494d793f9b6c2a">isAdvertising</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#abe6258a917243a4567c3d6eece2ddcdd">NimBLEAdvertising</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a725437c00152ff57ef1e21bdf7be980d">removeServiceUUID</a>(const NimBLEUUID &amp;serviceUUID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a545b505ea76396c33133d41a78fad5b8">reset</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#af7083f58717b7e76d90d367f00a0ef08">setAdvertisementData</a>(NimBLEAdvertisementData &amp;advertisementData)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a68d54f11b47b9993322efec1d07c3519">setAdvertisementType</a>(uint8_t adv_type)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#aa0d30dfb57670cc8180e17dffddad416">setAppearance</a>(uint16_t appearance)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a1eff592870a47b0f62b0f0894efadbd4">setManufacturerData</a>(const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#aab512576d8873fbbb631bac8ada19530">setMaxInterval</a>(uint16_t maxinterval)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a3382cdf80f5ae46a52e3b9159f8e1b66">setMaxPreferred</a>(uint16_t)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a16bd135cab3f06bc0ba81c2aec19cbbc">setMinInterval</a>(uint16_t mininterval)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a3bc158da1f732361df69cf16ca1cfd42">setMinPreferred</a>(uint16_t)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#add2ecd09877d7e4548b11ec7cb8c7a47">setName</a>(const std::string &amp;name)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#aa3da80c7d17a7824484ee254076e4790">setScanFilter</a>(bool scanRequestWhitelistOnly, bool connectWhitelistOnly)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a6fb4d9ad3949928ac83d3e74857ab91f">setScanResponse</a>(bool)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a04a51a0c639a70295a9b671f73b34358">setScanResponseData</a>(NimBLEAdvertisementData &amp;advertisementData)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a994e43e9e4ace6ce64c57e57d0575781">setServiceData</a>(const NimBLEUUID &amp;uuid, const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#a6495d7c9ad80a8c2a5edf974705f8103">setURI</a>(const std::string &amp;uri)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#aeeee5a131b42a4f76010751f4c182e4f">start</a>(uint32_t duration=0, void(*advCompleteCB)(NimBLEAdvertising *pAdv)=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html#ab19c9e9015e812055e3cad29d52ed2ff">stop</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,729 @@
<!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: NimBLEAdvertising Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_advertising.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_advertising-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEAdvertising Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Perform and manage BLE advertising.
<a href="class_nim_b_l_e_advertising.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abe6258a917243a4567c3d6eece2ddcdd"><td class="memItemLeft" align="right" valign="top"><a id="abe6258a917243a4567c3d6eece2ddcdd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#abe6258a917243a4567c3d6eece2ddcdd">NimBLEAdvertising</a> ()</td></tr>
<tr class="memdesc:abe6258a917243a4567c3d6eece2ddcdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a default advertising object. <br /></td></tr>
<tr class="separator:abe6258a917243a4567c3d6eece2ddcdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f334752ea04223185292fe9ab524b69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69">addServiceUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID)</td></tr>
<tr class="memdesc:a4f334752ea04223185292fe9ab524b69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a service uuid to exposed list of services. <a href="class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69">More...</a><br /></td></tr>
<tr class="separator:a4f334752ea04223185292fe9ab524b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e596e8dfa9268554a5b189380405d5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a5e596e8dfa9268554a5b189380405d5c">addServiceUUID</a> (const char *serviceUUID)</td></tr>
<tr class="memdesc:a5e596e8dfa9268554a5b189380405d5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a service uuid to exposed list of services. <a href="class_nim_b_l_e_advertising.html#a5e596e8dfa9268554a5b189380405d5c">More...</a><br /></td></tr>
<tr class="separator:a5e596e8dfa9268554a5b189380405d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a725437c00152ff57ef1e21bdf7be980d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a725437c00152ff57ef1e21bdf7be980d">removeServiceUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID)</td></tr>
<tr class="memdesc:a725437c00152ff57ef1e21bdf7be980d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a service uuid to exposed list of services. <a href="class_nim_b_l_e_advertising.html#a725437c00152ff57ef1e21bdf7be980d">More...</a><br /></td></tr>
<tr class="separator:a725437c00152ff57ef1e21bdf7be980d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeeee5a131b42a4f76010751f4c182e4f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#aeeee5a131b42a4f76010751f4c182e4f">start</a> (uint32_t duration=0, void(*<a class="el" href="class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2">advCompleteCB</a>)(<a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> *pAdv)=nullptr)</td></tr>
<tr class="memdesc:aeeee5a131b42a4f76010751f4c182e4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start advertising. <a href="class_nim_b_l_e_advertising.html#aeeee5a131b42a4f76010751f4c182e4f">More...</a><br /></td></tr>
<tr class="separator:aeeee5a131b42a4f76010751f4c182e4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab19c9e9015e812055e3cad29d52ed2ff"><td class="memItemLeft" align="right" valign="top"><a id="ab19c9e9015e812055e3cad29d52ed2ff"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#ab19c9e9015e812055e3cad29d52ed2ff">stop</a> ()</td></tr>
<tr class="memdesc:ab19c9e9015e812055e3cad29d52ed2ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop advertising. <br /></td></tr>
<tr class="separator:ab19c9e9015e812055e3cad29d52ed2ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0d30dfb57670cc8180e17dffddad416"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#aa0d30dfb57670cc8180e17dffddad416">setAppearance</a> (uint16_t appearance)</td></tr>
<tr class="memdesc:aa0d30dfb57670cc8180e17dffddad416"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the device appearance in the advertising data. The codes for distinct appearances can be found here:<br />
<a href="https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml">https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml</a>. <a href="class_nim_b_l_e_advertising.html#aa0d30dfb57670cc8180e17dffddad416">More...</a><br /></td></tr>
<tr class="separator:aa0d30dfb57670cc8180e17dffddad416"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add2ecd09877d7e4548b11ec7cb8c7a47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#add2ecd09877d7e4548b11ec7cb8c7a47">setName</a> (const std::string &amp;name)</td></tr>
<tr class="memdesc:add2ecd09877d7e4548b11ec7cb8c7a47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertised name of the device. <a href="class_nim_b_l_e_advertising.html#add2ecd09877d7e4548b11ec7cb8c7a47">More...</a><br /></td></tr>
<tr class="separator:add2ecd09877d7e4548b11ec7cb8c7a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eff592870a47b0f62b0f0894efadbd4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a1eff592870a47b0f62b0f0894efadbd4">setManufacturerData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:a1eff592870a47b0f62b0f0894efadbd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertised manufacturer data. <a href="class_nim_b_l_e_advertising.html#a1eff592870a47b0f62b0f0894efadbd4">More...</a><br /></td></tr>
<tr class="separator:a1eff592870a47b0f62b0f0894efadbd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6495d7c9ad80a8c2a5edf974705f8103"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a6495d7c9ad80a8c2a5edf974705f8103">setURI</a> (const std::string &amp;uri)</td></tr>
<tr class="memdesc:a6495d7c9ad80a8c2a5edf974705f8103"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertised URI. <a href="class_nim_b_l_e_advertising.html#a6495d7c9ad80a8c2a5edf974705f8103">More...</a><br /></td></tr>
<tr class="separator:a6495d7c9ad80a8c2a5edf974705f8103"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a994e43e9e4ace6ce64c57e57d0575781"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a994e43e9e4ace6ce64c57e57d0575781">setServiceData</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, const std::string &amp;data)</td></tr>
<tr class="memdesc:a994e43e9e4ace6ce64c57e57d0575781"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the service data advertised for the UUID. <a href="class_nim_b_l_e_advertising.html#a994e43e9e4ace6ce64c57e57d0575781">More...</a><br /></td></tr>
<tr class="separator:a994e43e9e4ace6ce64c57e57d0575781"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68d54f11b47b9993322efec1d07c3519"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a68d54f11b47b9993322efec1d07c3519">setAdvertisementType</a> (uint8_t adv_type)</td></tr>
<tr class="memdesc:a68d54f11b47b9993322efec1d07c3519"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the type of advertisment to use. <a href="class_nim_b_l_e_advertising.html#a68d54f11b47b9993322efec1d07c3519">More...</a><br /></td></tr>
<tr class="separator:a68d54f11b47b9993322efec1d07c3519"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab512576d8873fbbb631bac8ada19530"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#aab512576d8873fbbb631bac8ada19530">setMaxInterval</a> (uint16_t maxinterval)</td></tr>
<tr class="memdesc:aab512576d8873fbbb631bac8ada19530"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the maximum advertising interval. <a href="class_nim_b_l_e_advertising.html#aab512576d8873fbbb631bac8ada19530">More...</a><br /></td></tr>
<tr class="separator:aab512576d8873fbbb631bac8ada19530"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16bd135cab3f06bc0ba81c2aec19cbbc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a16bd135cab3f06bc0ba81c2aec19cbbc">setMinInterval</a> (uint16_t mininterval)</td></tr>
<tr class="memdesc:a16bd135cab3f06bc0ba81c2aec19cbbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the minimum advertising interval. <a href="class_nim_b_l_e_advertising.html#a16bd135cab3f06bc0ba81c2aec19cbbc">More...</a><br /></td></tr>
<tr class="separator:a16bd135cab3f06bc0ba81c2aec19cbbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7083f58717b7e76d90d367f00a0ef08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#af7083f58717b7e76d90d367f00a0ef08">setAdvertisementData</a> (<a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a> &amp;advertisementData)</td></tr>
<tr class="memdesc:af7083f58717b7e76d90d367f00a0ef08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisement data that is to be published in a regular advertisement. <a href="class_nim_b_l_e_advertising.html#af7083f58717b7e76d90d367f00a0ef08">More...</a><br /></td></tr>
<tr class="separator:af7083f58717b7e76d90d367f00a0ef08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3da80c7d17a7824484ee254076e4790"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#aa3da80c7d17a7824484ee254076e4790">setScanFilter</a> (bool scanRequestWhitelistOnly, bool connectWhitelistOnly)</td></tr>
<tr class="memdesc:aa3da80c7d17a7824484ee254076e4790"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the filtering for the scan filter. <a href="class_nim_b_l_e_advertising.html#aa3da80c7d17a7824484ee254076e4790">More...</a><br /></td></tr>
<tr class="separator:aa3da80c7d17a7824484ee254076e4790"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04a51a0c639a70295a9b671f73b34358"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a04a51a0c639a70295a9b671f73b34358">setScanResponseData</a> (<a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a> &amp;advertisementData)</td></tr>
<tr class="memdesc:a04a51a0c639a70295a9b671f73b34358"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisement data that is to be published in a scan response. <a href="class_nim_b_l_e_advertising.html#a04a51a0c639a70295a9b671f73b34358">More...</a><br /></td></tr>
<tr class="separator:a04a51a0c639a70295a9b671f73b34358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fb4d9ad3949928ac83d3e74857ab91f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a6fb4d9ad3949928ac83d3e74857ab91f">setScanResponse</a> (bool)</td></tr>
<tr class="memdesc:a6fb4d9ad3949928ac83d3e74857ab91f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set if scan response is available. <a href="class_nim_b_l_e_advertising.html#a6fb4d9ad3949928ac83d3e74857ab91f">More...</a><br /></td></tr>
<tr class="separator:a6fb4d9ad3949928ac83d3e74857ab91f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bc158da1f732361df69cf16ca1cfd42"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a3bc158da1f732361df69cf16ca1cfd42">setMinPreferred</a> (uint16_t)</td></tr>
<tr class="memdesc:a3bc158da1f732361df69cf16ca1cfd42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertised min connection interval preferred by this device. <a href="class_nim_b_l_e_advertising.html#a3bc158da1f732361df69cf16ca1cfd42">More...</a><br /></td></tr>
<tr class="separator:a3bc158da1f732361df69cf16ca1cfd42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3382cdf80f5ae46a52e3b9159f8e1b66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a3382cdf80f5ae46a52e3b9159f8e1b66">setMaxPreferred</a> (uint16_t)</td></tr>
<tr class="memdesc:a3382cdf80f5ae46a52e3b9159f8e1b66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertised max connection interval preferred by this device. <a href="class_nim_b_l_e_advertising.html#a3382cdf80f5ae46a52e3b9159f8e1b66">More...</a><br /></td></tr>
<tr class="separator:a3382cdf80f5ae46a52e3b9159f8e1b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4ff0af45d1f7ed5bc208612852bc43a"><td class="memItemLeft" align="right" valign="top"><a id="ac4ff0af45d1f7ed5bc208612852bc43a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#ac4ff0af45d1f7ed5bc208612852bc43a">addTxPower</a> ()</td></tr>
<tr class="memdesc:ac4ff0af45d1f7ed5bc208612852bc43a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the transmission power level to the advertisement packet. <br /></td></tr>
<tr class="separator:ac4ff0af45d1f7ed5bc208612852bc43a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a545b505ea76396c33133d41a78fad5b8"><td class="memItemLeft" align="right" valign="top"><a id="a545b505ea76396c33133d41a78fad5b8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a545b505ea76396c33133d41a78fad5b8">reset</a> ()</td></tr>
<tr class="memdesc:a545b505ea76396c33133d41a78fad5b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the current advertising and resets the advertising data to the default values. <br /></td></tr>
<tr class="separator:a545b505ea76396c33133d41a78fad5b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4de7bf016a086a2d3f6f14ae134678f2"><td class="memItemLeft" align="right" valign="top"><a id="a4de7bf016a086a2d3f6f14ae134678f2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2">advCompleteCB</a> ()</td></tr>
<tr class="memdesc:a4de7bf016a086a2d3f6f14ae134678f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles the callback when advertising stops. <br /></td></tr>
<tr class="separator:a4de7bf016a086a2d3f6f14ae134678f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac257ab68520a244cb6494d793f9b6c2a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_advertising.html#ac257ab68520a244cb6494d793f9b6c2a">isAdvertising</a> ()</td></tr>
<tr class="memdesc:ac257ab68520a244cb6494d793f9b6c2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if currently advertising. <a href="class_nim_b_l_e_advertising.html#ac257ab68520a244cb6494d793f9b6c2a">More...</a><br /></td></tr>
<tr class="separator:ac257ab68520a244cb6494d793f9b6c2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Perform and manage BLE advertising. </p>
<p>A BLE server will want to perform advertising in order to make itself known to BLE clients. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5e596e8dfa9268554a5b189380405d5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e596e8dfa9268554a5b189380405d5c">&#9670;&nbsp;</a></span>addServiceUUID() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::addServiceUUID </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>serviceUUID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a service uuid to exposed list of services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The string representation of the service to expose. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4f334752ea04223185292fe9ab524b69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f334752ea04223185292fe9ab524b69">&#9670;&nbsp;</a></span>addServiceUUID() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::addServiceUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>serviceUUID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a service uuid to exposed list of services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The UUID of the service to expose. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac257ab68520a244cb6494d793f9b6c2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac257ab68520a244cb6494d793f9b6c2a">&#9670;&nbsp;</a></span>isAdvertising()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEAdvertising::isAdvertising </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if currently advertising. </p>
<dl class="section return"><dt>Returns</dt><dd>true if advertising is active. </dd></dl>
</div>
</div>
<a id="a725437c00152ff57ef1e21bdf7be980d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a725437c00152ff57ef1e21bdf7be980d">&#9670;&nbsp;</a></span>removeServiceUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::removeServiceUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>serviceUUID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a service uuid to exposed list of services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The UUID of the service to expose. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af7083f58717b7e76d90d367f00a0ef08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7083f58717b7e76d90d367f00a0ef08">&#9670;&nbsp;</a></span>setAdvertisementData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setAdvertisementData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a> &amp;&#160;</td>
<td class="paramname"><em>advertisementData</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertisement data that is to be published in a regular advertisement. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advertisementData</td><td>The data to be advertised.</td></tr>
</table>
</dd>
</dl>
<p>The use of this function will replace any data set with addServiceUUID<br />
or setAppearance. If you wish for these to be advertised you must include them<br />
in the advertisementData parameter sent. </p>
</div>
</div>
<a id="a68d54f11b47b9993322efec1d07c3519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68d54f11b47b9993322efec1d07c3519">&#9670;&nbsp;</a></span>setAdvertisementType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setAdvertisementType </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>adv_type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the type of advertisment to use. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">adv_type</td><td><ul>
<li>BLE_GAP_CONN_MODE_NON (0) - not connectable advertising</li>
<li>BLE_GAP_CONN_MODE_DIR (1) - directed connectable advertising</li>
<li>BLE_GAP_CONN_MODE_UND (2) - undirected connectable advertising </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa0d30dfb57670cc8180e17dffddad416"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0d30dfb57670cc8180e17dffddad416">&#9670;&nbsp;</a></span>setAppearance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setAppearance </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>appearance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the device appearance in the advertising data. The codes for distinct appearances can be found here:<br />
<a href="https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml">https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">appearance</td><td>The appearance of the device in the advertising data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1eff592870a47b0f62b0f0894efadbd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eff592870a47b0f62b0f0894efadbd4">&#9670;&nbsp;</a></span>setManufacturerData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setManufacturerData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertised manufacturer data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aab512576d8873fbbb631bac8ada19530"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab512576d8873fbbb631bac8ada19530">&#9670;&nbsp;</a></span>setMaxInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setMaxInterval </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>maxinterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum advertising interval. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">maxinterval</td><td>Maximum value for advertising interval in 0.625ms units, 0 = use default. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3382cdf80f5ae46a52e3b9159f8e1b66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3382cdf80f5ae46a52e3b9159f8e1b66">&#9670;&nbsp;</a></span>setMaxPreferred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setMaxPreferred </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>maxinterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertised max connection interval preferred by this device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">maxinterval</td><td>the max interval value. Range = 0x0006 to 0x0C80.</td></tr>
</table>
</dd>
</dl>
<p>Values not within the range will cancel advertising of this data.<br />
Consumes 6 bytes of advertising space (combined with min interval). </p>
</div>
</div>
<a id="a16bd135cab3f06bc0ba81c2aec19cbbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16bd135cab3f06bc0ba81c2aec19cbbc">&#9670;&nbsp;</a></span>setMinInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setMinInterval </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>mininterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the minimum advertising interval. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mininterval</td><td>Minimum value for advertising interval in 0.625ms units, 0 = use default. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3bc158da1f732361df69cf16ca1cfd42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bc158da1f732361df69cf16ca1cfd42">&#9670;&nbsp;</a></span>setMinPreferred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setMinPreferred </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>mininterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertised min connection interval preferred by this device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mininterval</td><td>the max interval value. Range = 0x0006 to 0x0C80.</td></tr>
</table>
</dd>
</dl>
<p>Values not within the range will cancel advertising of this data.<br />
Consumes 6 bytes of advertising space (combined with max interval). </p>
</div>
</div>
<a id="add2ecd09877d7e4548b11ec7cb8c7a47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add2ecd09877d7e4548b11ec7cb8c7a47">&#9670;&nbsp;</a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setName </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertised name of the device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa3da80c7d17a7824484ee254076e4790"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3da80c7d17a7824484ee254076e4790">&#9670;&nbsp;</a></span>setScanFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setScanFilter </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>scanRequestWhitelistOnly</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>connectWhitelistOnly</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the filtering for the scan filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">scanRequestWhitelistOnly</td><td>If true, only allow scan requests from those on the white list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">connectWhitelistOnly</td><td>If true, only allow connections from those on the white list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6fb4d9ad3949928ac83d3e74857ab91f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fb4d9ad3949928ac83d3e74857ab91f">&#9670;&nbsp;</a></span>setScanResponse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setScanResponse </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>set</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set if scan response is available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">set</td><td>true = scan response available. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a04a51a0c639a70295a9b671f73b34358"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04a51a0c639a70295a9b671f73b34358">&#9670;&nbsp;</a></span>setScanResponseData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setScanResponseData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_advertisement_data.html">NimBLEAdvertisementData</a> &amp;&#160;</td>
<td class="paramname"><em>advertisementData</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertisement data that is to be published in a scan response. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advertisementData</td><td>The data to be advertised.</td></tr>
</table>
</dd>
</dl>
<p>Calling this without also using setAdvertisementData will have no effect.<br />
When using custom scan response data you must also use custom advertisement data. </p>
</div>
</div>
<a id="a994e43e9e4ace6ce64c57e57d0575781"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a994e43e9e4ace6ce64c57e57d0575781">&#9670;&nbsp;</a></span>setServiceData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setServiceData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the service data advertised for the UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID the service data belongs to. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to advertise. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If data length is 0 the service data will not be advertised. </dd></dl>
</div>
</div>
<a id="a6495d7c9ad80a8c2a5edf974705f8103"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6495d7c9ad80a8c2a5edf974705f8103">&#9670;&nbsp;</a></span>setURI()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEAdvertising::setURI </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>uri</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertised URI. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uri</td><td>The URI to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeeee5a131b42a4f76010751f4c182e4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeeee5a131b42a4f76010751f4c182e4f">&#9670;&nbsp;</a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEAdvertising::start </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(<a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> *pAdv)&#160;</td>
<td class="paramname"><em>advCompleteCB</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start advertising. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>The duration, in seconds, to advertise, 0 == advertise forever. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">advCompleteCB</td><td>A pointer to a callback to be invoked when advertising ends. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising started successfully. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,27 @@
var class_nim_b_l_e_advertising =
[
[ "NimBLEAdvertising", "class_nim_b_l_e_advertising.html#abe6258a917243a4567c3d6eece2ddcdd", null ],
[ "addServiceUUID", "class_nim_b_l_e_advertising.html#a5e596e8dfa9268554a5b189380405d5c", null ],
[ "addServiceUUID", "class_nim_b_l_e_advertising.html#a4f334752ea04223185292fe9ab524b69", null ],
[ "addTxPower", "class_nim_b_l_e_advertising.html#ac4ff0af45d1f7ed5bc208612852bc43a", null ],
[ "advCompleteCB", "class_nim_b_l_e_advertising.html#a4de7bf016a086a2d3f6f14ae134678f2", null ],
[ "isAdvertising", "class_nim_b_l_e_advertising.html#ac257ab68520a244cb6494d793f9b6c2a", null ],
[ "removeServiceUUID", "class_nim_b_l_e_advertising.html#a725437c00152ff57ef1e21bdf7be980d", null ],
[ "reset", "class_nim_b_l_e_advertising.html#a545b505ea76396c33133d41a78fad5b8", null ],
[ "setAdvertisementData", "class_nim_b_l_e_advertising.html#af7083f58717b7e76d90d367f00a0ef08", null ],
[ "setAdvertisementType", "class_nim_b_l_e_advertising.html#a68d54f11b47b9993322efec1d07c3519", null ],
[ "setAppearance", "class_nim_b_l_e_advertising.html#aa0d30dfb57670cc8180e17dffddad416", null ],
[ "setManufacturerData", "class_nim_b_l_e_advertising.html#a1eff592870a47b0f62b0f0894efadbd4", null ],
[ "setMaxInterval", "class_nim_b_l_e_advertising.html#aab512576d8873fbbb631bac8ada19530", null ],
[ "setMaxPreferred", "class_nim_b_l_e_advertising.html#a3382cdf80f5ae46a52e3b9159f8e1b66", null ],
[ "setMinInterval", "class_nim_b_l_e_advertising.html#a16bd135cab3f06bc0ba81c2aec19cbbc", null ],
[ "setMinPreferred", "class_nim_b_l_e_advertising.html#a3bc158da1f732361df69cf16ca1cfd42", null ],
[ "setName", "class_nim_b_l_e_advertising.html#add2ecd09877d7e4548b11ec7cb8c7a47", null ],
[ "setScanFilter", "class_nim_b_l_e_advertising.html#aa3da80c7d17a7824484ee254076e4790", null ],
[ "setScanResponse", "class_nim_b_l_e_advertising.html#a6fb4d9ad3949928ac83d3e74857ab91f", null ],
[ "setScanResponseData", "class_nim_b_l_e_advertising.html#a04a51a0c639a70295a9b671f73b34358", null ],
[ "setServiceData", "class_nim_b_l_e_advertising.html#a994e43e9e4ace6ce64c57e57d0575781", null ],
[ "setURI", "class_nim_b_l_e_advertising.html#a6495d7c9ad80a8c2a5edf974705f8103", null ],
[ "start", "class_nim_b_l_e_advertising.html#aeeee5a131b42a4f76010751f4c182e4f", null ],
[ "stop", "class_nim_b_l_e_advertising.html#ab19c9e9015e812055e3cad29d52ed2ff", null ]
];

View File

@@ -0,0 +1,114 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_beacon.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">NimBLEBeacon Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">getData</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">getMajor</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">getManufacturerId</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">getMinor</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">getProximityUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">getSignalPower</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37">NimBLEBeacon</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">setData</a>(const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">setMajor</a>(uint16_t major)</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">setManufacturerId</a>(uint16_t manufacturerId)</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">setMinor</a>(uint16_t minor)</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">setProximityUUID</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">setSignalPower</a>(int8_t signalPower)</td><td class="entry"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

431
class_nim_b_l_e_beacon.html Normal file
View File

@@ -0,0 +1,431 @@
<!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: NimBLEBeacon Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_beacon.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_beacon-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEBeacon Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Representation of a beacon. See:
<a href="class_nim_b_l_e_beacon.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac99e1fb4ef4795785a655b117dabdd37"><td class="memItemLeft" align="right" valign="top"><a id="ac99e1fb4ef4795785a655b117dabdd37"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37">NimBLEBeacon</a> ()</td></tr>
<tr class="memdesc:ac99e1fb4ef4795785a655b117dabdd37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a default beacon object. <br /></td></tr>
<tr class="separator:ac99e1fb4ef4795785a655b117dabdd37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2458f7db169b696e6368802d5ece0d9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">getData</a> ()</td></tr>
<tr class="memdesc:ae2458f7db169b696e6368802d5ece0d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the data that is being advertised. <a href="class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9">More...</a><br /></td></tr>
<tr class="separator:ae2458f7db169b696e6368802d5ece0d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac32b7f86c73221152909528c8dbad3c"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">getMajor</a> ()</td></tr>
<tr class="memdesc:aac32b7f86c73221152909528c8dbad3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the major value being advertised. <a href="class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c">More...</a><br /></td></tr>
<tr class="separator:aac32b7f86c73221152909528c8dbad3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc9fd3a68b4b1772dc4d102573c6788"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">getMinor</a> ()</td></tr>
<tr class="memdesc:a4bc9fd3a68b4b1772dc4d102573c6788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minor value being advertised. <a href="class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788">More...</a><br /></td></tr>
<tr class="separator:a4bc9fd3a68b4b1772dc4d102573c6788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8803d70e8c238ccb98edcf31af0ead40"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">getManufacturerId</a> ()</td></tr>
<tr class="memdesc:a8803d70e8c238ccb98edcf31af0ead40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the manufacturer ID being advertised. <a href="class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40">More...</a><br /></td></tr>
<tr class="separator:a8803d70e8c238ccb98edcf31af0ead40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a999ade63059620d619609676d85186ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">getProximityUUID</a> ()</td></tr>
<tr class="memdesc:a999ade63059620d619609676d85186ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the proximity UUID being advertised. <a href="class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad">More...</a><br /></td></tr>
<tr class="separator:a999ade63059620d619609676d85186ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4eb27b3e447f8f0b44128f77933be668"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">getSignalPower</a> ()</td></tr>
<tr class="memdesc:a4eb27b3e447f8f0b44128f77933be668"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the signal power being advertised. <a href="class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668">More...</a><br /></td></tr>
<tr class="separator:a4eb27b3e447f8f0b44128f77933be668"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92292c8b1f5ba0097f063ff6e60934ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">setData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:a92292c8b1f5ba0097f063ff6e60934ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the raw data for the beacon record. <a href="class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff">More...</a><br /></td></tr>
<tr class="separator:a92292c8b1f5ba0097f063ff6e60934ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abef1334108f8049832da7fffb56f6eea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">setMajor</a> (uint16_t major)</td></tr>
<tr class="memdesc:abef1334108f8049832da7fffb56f6eea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the major value. <a href="class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea">More...</a><br /></td></tr>
<tr class="separator:abef1334108f8049832da7fffb56f6eea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44d03b0c2b1bea3bee8f15feeb73fb8e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">setMinor</a> (uint16_t minor)</td></tr>
<tr class="memdesc:a44d03b0c2b1bea3bee8f15feeb73fb8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the minor value. <a href="class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e">More...</a><br /></td></tr>
<tr class="separator:a44d03b0c2b1bea3bee8f15feeb73fb8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec99fe7684181e7b899cd763f9b44d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">setManufacturerId</a> (uint16_t manufacturerId)</td></tr>
<tr class="memdesc:a1ec99fe7684181e7b899cd763f9b44d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the manufacturer ID. <a href="class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9">More...</a><br /></td></tr>
<tr class="separator:a1ec99fe7684181e7b899cd763f9b44d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f33ffc298285d1ab02088b2584f2256"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">setProximityUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:a7f33ffc298285d1ab02088b2584f2256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the proximity UUID. <a href="class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256">More...</a><br /></td></tr>
<tr class="separator:a7f33ffc298285d1ab02088b2584f2256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2dd8cd367260dd8374309576457cec0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">setSignalPower</a> (int8_t signalPower)</td></tr>
<tr class="memdesc:ae2dd8cd367260dd8374309576457cec0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the signal power. <a href="class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0">More...</a><br /></td></tr>
<tr class="separator:ae2dd8cd367260dd8374309576457cec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of a beacon. See: </p>
<ul>
<li><a href="https://en.wikipedia.org/wiki/IBeacon">https://en.wikipedia.org/wiki/IBeacon</a> </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae2458f7db169b696e6368802d5ece0d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2458f7db169b696e6368802d5ece0d9">&#9670;&nbsp;</a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEBeacon::getData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the data that is being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The advertised data. </dd></dl>
</div>
</div>
<a id="aac32b7f86c73221152909528c8dbad3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac32b7f86c73221152909528c8dbad3c">&#9670;&nbsp;</a></span>getMajor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEBeacon::getMajor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the major value being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The major value advertised. </dd></dl>
</div>
</div>
<a id="a8803d70e8c238ccb98edcf31af0ead40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8803d70e8c238ccb98edcf31af0ead40">&#9670;&nbsp;</a></span>getManufacturerId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEBeacon::getManufacturerId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the manufacturer ID being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The manufacturer ID value advertised. </dd></dl>
</div>
</div>
<a id="a4bc9fd3a68b4b1772dc4d102573c6788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc9fd3a68b4b1772dc4d102573c6788">&#9670;&nbsp;</a></span>getMinor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEBeacon::getMinor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the minor value being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>minor value advertised. </dd></dl>
</div>
</div>
<a id="a999ade63059620d619609676d85186ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a999ade63059620d619609676d85186ad">&#9670;&nbsp;</a></span>getProximityUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLEBeacon::getProximityUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the proximity UUID being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The UUID advertised. </dd></dl>
</div>
</div>
<a id="a4eb27b3e447f8f0b44128f77933be668"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eb27b3e447f8f0b44128f77933be668">&#9670;&nbsp;</a></span>getSignalPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t NimBLEBeacon::getSignalPower </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the signal power being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>signal power level advertised. </dd></dl>
</div>
</div>
<a id="a92292c8b1f5ba0097f063ff6e60934ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92292c8b1f5ba0097f063ff6e60934ff">&#9670;&nbsp;</a></span>setData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEBeacon::setData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the raw data for the beacon record. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The raw beacon data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abef1334108f8049832da7fffb56f6eea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abef1334108f8049832da7fffb56f6eea">&#9670;&nbsp;</a></span>setMajor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEBeacon::setMajor </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>major</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the major value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">major</td><td>The major value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1ec99fe7684181e7b899cd763f9b44d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ec99fe7684181e7b899cd763f9b44d9">&#9670;&nbsp;</a></span>setManufacturerId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEBeacon::setManufacturerId </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>manufacturerId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the manufacturer ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">manufacturerId</td><td>The manufacturer ID value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a44d03b0c2b1bea3bee8f15feeb73fb8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44d03b0c2b1bea3bee8f15feeb73fb8e">&#9670;&nbsp;</a></span>setMinor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEBeacon::setMinor </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>minor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the minor value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">minor</td><td>The minor value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7f33ffc298285d1ab02088b2584f2256"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f33ffc298285d1ab02088b2584f2256">&#9670;&nbsp;</a></span>setProximityUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEBeacon::setProximityUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the proximity UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The proximity UUID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae2dd8cd367260dd8374309576457cec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2dd8cd367260dd8374309576457cec0">&#9670;&nbsp;</a></span>setSignalPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEBeacon::setSignalPower </td>
<td>(</td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>signalPower</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the signal power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">signalPower</td><td>The signal power value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_beacon.html">NimBLEBeacon</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

16
class_nim_b_l_e_beacon.js Normal file
View File

@@ -0,0 +1,16 @@
var class_nim_b_l_e_beacon =
[
[ "NimBLEBeacon", "class_nim_b_l_e_beacon.html#ac99e1fb4ef4795785a655b117dabdd37", null ],
[ "getData", "class_nim_b_l_e_beacon.html#ae2458f7db169b696e6368802d5ece0d9", null ],
[ "getMajor", "class_nim_b_l_e_beacon.html#aac32b7f86c73221152909528c8dbad3c", null ],
[ "getManufacturerId", "class_nim_b_l_e_beacon.html#a8803d70e8c238ccb98edcf31af0ead40", null ],
[ "getMinor", "class_nim_b_l_e_beacon.html#a4bc9fd3a68b4b1772dc4d102573c6788", null ],
[ "getProximityUUID", "class_nim_b_l_e_beacon.html#a999ade63059620d619609676d85186ad", null ],
[ "getSignalPower", "class_nim_b_l_e_beacon.html#a4eb27b3e447f8f0b44128f77933be668", null ],
[ "setData", "class_nim_b_l_e_beacon.html#a92292c8b1f5ba0097f063ff6e60934ff", null ],
[ "setMajor", "class_nim_b_l_e_beacon.html#abef1334108f8049832da7fffb56f6eea", null ],
[ "setManufacturerId", "class_nim_b_l_e_beacon.html#a1ec99fe7684181e7b899cd763f9b44d9", null ],
[ "setMinor", "class_nim_b_l_e_beacon.html#a44d03b0c2b1bea3bee8f15feeb73fb8e", null ],
[ "setProximityUUID", "class_nim_b_l_e_beacon.html#a7f33ffc298285d1ab02088b2584f2256", null ],
[ "setSignalPower", "class_nim_b_l_e_beacon.html#ae2dd8cd367260dd8374309576457cec0", null ]
];

View File

@@ -0,0 +1,127 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_characteristic.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">NimBLECharacteristic Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#aed4b2241c89ad2a8f49117e2b9433e5b">addDescriptor</a>(NimBLEDescriptor *pDescriptor)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda">createDescriptor</a>(const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=100)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a6523266a751a778a2c04fea19fed4de5">createDescriptor</a>(const NimBLEUUID &amp;uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=100)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a1747ac4889c7adbb93a2d88a10327a47">getCallbacks</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a580ad0133fd82a673027c91cbb1c74fa">getDataLength</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a062f52918f13c49a37ce8e58b9e7382a">getDescriptorByHandle</a>(uint16_t handle)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189">getDescriptorByUUID</a>(const char *uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#ae310b081d2d7d2a52ab2ddc11d5dbd99">getDescriptorByUUID</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#acc3ea122771cd447103adfce22537379">getHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a79759a98d9bdb761cb12c1ea6f601afc">getProperties</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a84aa251a612810ec8d07e77ab03cb483">getService</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">getSubscribedCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a28b03617fe753133582ba4e58c60e52e">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54">getValue</a>(time_t *timestamp=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4">getValue</a>(time_t *timestamp=nullptr, bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a2ce9f62ecc3d1644ef4d58efe7a3c434">indicate</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da">NimBLECharacteristic</a>(const char *uuid, uint16_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, NimBLEService *pService=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#acdbd57f7e97646403e520edc35c34c8b">NimBLECharacteristic</a>(const NimBLEUUID &amp;uuid, uint16_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, NimBLEService *pService=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813">notify</a>(bool is_notification=true)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a2c0ed8932ee257a8632e3d72e353489b">removeDescriptor</a>(NimBLEDescriptor *pDescriptor, bool deleteDsc=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a29dc2505e1d3b4a7d6800d1547965d17">setCallbacks</a>(NimBLECharacteristicCallbacks *pCallbacks)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">setValue</a>(const uint8_t *data, size_t size)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a3e77647e4c9bd02c96b761639c4d206f">setValue</a>(const std::string &amp;value)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730">setValue</a>(const T &amp;s)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a4fa6b8ed011d12e2b1f16e92a02b9a89">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html#a7fe29c5ec571d0513c51b8cbac942f4a">~NimBLECharacteristic</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,876 @@
<!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: NimBLECharacteristic Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_characteristic.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_characteristic-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLECharacteristic Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The model of a BLE Characteristic.
<a href="class_nim_b_l_e_characteristic.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a942b2d29d77fcef233549d0c4fd798da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da">NimBLECharacteristic</a> (const char *uuid, uint16_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, <a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *pService=nullptr)</td></tr>
<tr class="memdesc:a942b2d29d77fcef233549d0c4fd798da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a characteristic. <a href="class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da">More...</a><br /></td></tr>
<tr class="separator:a942b2d29d77fcef233549d0c4fd798da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdbd57f7e97646403e520edc35c34c8b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#acdbd57f7e97646403e520edc35c34c8b">NimBLECharacteristic</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint16_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, <a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *pService=nullptr)</td></tr>
<tr class="memdesc:acdbd57f7e97646403e520edc35c34c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a characteristic. <a href="class_nim_b_l_e_characteristic.html#acdbd57f7e97646403e520edc35c34c8b">More...</a><br /></td></tr>
<tr class="separator:acdbd57f7e97646403e520edc35c34c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fe29c5ec571d0513c51b8cbac942f4a"><td class="memItemLeft" align="right" valign="top"><a id="a7fe29c5ec571d0513c51b8cbac942f4a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a7fe29c5ec571d0513c51b8cbac942f4a">~NimBLECharacteristic</a> ()</td></tr>
<tr class="memdesc:a7fe29c5ec571d0513c51b8cbac942f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a7fe29c5ec571d0513c51b8cbac942f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc3ea122771cd447103adfce22537379"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#acc3ea122771cd447103adfce22537379">getHandle</a> ()</td></tr>
<tr class="memdesc:acc3ea122771cd447103adfce22537379"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the handle of the characteristic. <a href="class_nim_b_l_e_characteristic.html#acc3ea122771cd447103adfce22537379">More...</a><br /></td></tr>
<tr class="separator:acc3ea122771cd447103adfce22537379"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28b03617fe753133582ba4e58c60e52e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a28b03617fe753133582ba4e58c60e52e">getUUID</a> ()</td></tr>
<tr class="memdesc:a28b03617fe753133582ba4e58c60e52e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID of the characteristic. <a href="class_nim_b_l_e_characteristic.html#a28b03617fe753133582ba4e58c60e52e">More...</a><br /></td></tr>
<tr class="separator:a28b03617fe753133582ba4e58c60e52e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fa6b8ed011d12e2b1f16e92a02b9a89"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a4fa6b8ed011d12e2b1f16e92a02b9a89">toString</a> ()</td></tr>
<tr class="memdesc:a4fa6b8ed011d12e2b1f16e92a02b9a89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the characteristic. <a href="class_nim_b_l_e_characteristic.html#a4fa6b8ed011d12e2b1f16e92a02b9a89">More...</a><br /></td></tr>
<tr class="separator:a4fa6b8ed011d12e2b1f16e92a02b9a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29dc2505e1d3b4a7d6800d1547965d17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a29dc2505e1d3b4a7d6800d1547965d17">setCallbacks</a> (<a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a> *pCallbacks)</td></tr>
<tr class="memdesc:a29dc2505e1d3b4a7d6800d1547965d17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the callback handlers for this characteristic. <a href="class_nim_b_l_e_characteristic.html#a29dc2505e1d3b4a7d6800d1547965d17">More...</a><br /></td></tr>
<tr class="separator:a29dc2505e1d3b4a7d6800d1547965d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1747ac4889c7adbb93a2d88a10327a47"><td class="memItemLeft" align="right" valign="top"><a id="a1747ac4889c7adbb93a2d88a10327a47"></a>
<a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a1747ac4889c7adbb93a2d88a10327a47">getCallbacks</a> ()</td></tr>
<tr class="memdesc:a1747ac4889c7adbb93a2d88a10327a47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the callback handlers for this characteristic. <br /></td></tr>
<tr class="separator:a1747ac4889c7adbb93a2d88a10327a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ce9f62ecc3d1644ef4d58efe7a3c434"><td class="memItemLeft" align="right" valign="top"><a id="a2ce9f62ecc3d1644ef4d58efe7a3c434"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a2ce9f62ecc3d1644ef4d58efe7a3c434">indicate</a> ()</td></tr>
<tr class="memdesc:a2ce9f62ecc3d1644ef4d58efe7a3c434"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send an indication.<br />
An indication is a transmission of up to the first 20 bytes of the characteristic value.<br />
An indication will block waiting for a positive confirmation from the client. <br /></td></tr>
<tr class="separator:a2ce9f62ecc3d1644ef4d58efe7a3c434"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa45461059e1992c816e32c371d17e813"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813">notify</a> (bool is_notification=true)</td></tr>
<tr class="memdesc:aa45461059e1992c816e32c371d17e813"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a notification.<br />
A notification is a transmission of up to the first 20 bytes of the characteristic value.<br />
A notification will not block; it is a fire and forget. <a href="class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813">More...</a><br /></td></tr>
<tr class="separator:aa45461059e1992c816e32c371d17e813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aced225d46153b6969f6ded30c0190e39"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">getSubscribedCount</a> ()</td></tr>
<tr class="memdesc:aced225d46153b6969f6ded30c0190e39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of clients subscribed to the characteristic. <a href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">More...</a><br /></td></tr>
<tr class="separator:aced225d46153b6969f6ded30c0190e39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae014669e9ce1ad01520d68fe0cc0fda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda">createDescriptor</a> (const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=100)</td></tr>
<tr class="memdesc:aae014669e9ce1ad01520d68fe0cc0fda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new BLE Descriptor associated with this characteristic. <a href="class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda">More...</a><br /></td></tr>
<tr class="separator:aae014669e9ce1ad01520d68fe0cc0fda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6523266a751a778a2c04fea19fed4de5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a6523266a751a778a2c04fea19fed4de5">createDescriptor</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=100)</td></tr>
<tr class="memdesc:a6523266a751a778a2c04fea19fed4de5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new BLE Descriptor associated with this characteristic. <a href="class_nim_b_l_e_characteristic.html#a6523266a751a778a2c04fea19fed4de5">More...</a><br /></td></tr>
<tr class="separator:a6523266a751a778a2c04fea19fed4de5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed4b2241c89ad2a8f49117e2b9433e5b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#aed4b2241c89ad2a8f49117e2b9433e5b">addDescriptor</a> (<a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *pDescriptor)</td></tr>
<tr class="memdesc:aed4b2241c89ad2a8f49117e2b9433e5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a descriptor to the characteristic. <a href="class_nim_b_l_e_characteristic.html#aed4b2241c89ad2a8f49117e2b9433e5b">More...</a><br /></td></tr>
<tr class="separator:aed4b2241c89ad2a8f49117e2b9433e5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc5f4819e4d2c0956857ddd7a1064189"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189">getDescriptorByUUID</a> (const char *uuid)</td></tr>
<tr class="memdesc:abc5f4819e4d2c0956857ddd7a1064189"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the BLE Descriptor for the given UUID. <a href="class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189">More...</a><br /></td></tr>
<tr class="separator:abc5f4819e4d2c0956857ddd7a1064189"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae310b081d2d7d2a52ab2ddc11d5dbd99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#ae310b081d2d7d2a52ab2ddc11d5dbd99">getDescriptorByUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:ae310b081d2d7d2a52ab2ddc11d5dbd99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the BLE Descriptor for the given UUID. <a href="class_nim_b_l_e_characteristic.html#ae310b081d2d7d2a52ab2ddc11d5dbd99">More...</a><br /></td></tr>
<tr class="separator:ae310b081d2d7d2a52ab2ddc11d5dbd99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a062f52918f13c49a37ce8e58b9e7382a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a062f52918f13c49a37ce8e58b9e7382a">getDescriptorByHandle</a> (uint16_t handle)</td></tr>
<tr class="memdesc:a062f52918f13c49a37ce8e58b9e7382a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the BLE Descriptor for the given handle. <a href="class_nim_b_l_e_characteristic.html#a062f52918f13c49a37ce8e58b9e7382a">More...</a><br /></td></tr>
<tr class="separator:a062f52918f13c49a37ce8e58b9e7382a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c0ed8932ee257a8632e3d72e353489b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a2c0ed8932ee257a8632e3d72e353489b">removeDescriptor</a> (<a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *pDescriptor, bool deleteDsc=false)</td></tr>
<tr class="memdesc:a2c0ed8932ee257a8632e3d72e353489b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a descriptor from the characterisitc. <a href="class_nim_b_l_e_characteristic.html#a2c0ed8932ee257a8632e3d72e353489b">More...</a><br /></td></tr>
<tr class="separator:a2c0ed8932ee257a8632e3d72e353489b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37e908d114f6ad2b4bf19c7cc4db9c54"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54">getValue</a> (time_t *timestamp=nullptr)</td></tr>
<tr class="memdesc:a37e908d114f6ad2b4bf19c7cc4db9c54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the current value of the characteristic. <a href="class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54">More...</a><br /></td></tr>
<tr class="separator:a37e908d114f6ad2b4bf19c7cc4db9c54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a580ad0133fd82a673027c91cbb1c74fa"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a580ad0133fd82a673027c91cbb1c74fa">getDataLength</a> ()</td></tr>
<tr class="memdesc:a580ad0133fd82a673027c91cbb1c74fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the the current data length of the characteristic. <a href="class_nim_b_l_e_characteristic.html#a580ad0133fd82a673027c91cbb1c74fa">More...</a><br /></td></tr>
<tr class="separator:a580ad0133fd82a673027c91cbb1c74fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d09c29b26362f6ddcaf51a9c9dc8be4"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a7d09c29b26362f6ddcaf51a9c9dc8be4"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4">getValue</a> (time_t *timestamp=nullptr, bool skipSizeCheck=false)</td></tr>
<tr class="memdesc:a7d09c29b26362f6ddcaf51a9c9dc8be4"><td class="mdescLeft">&#160;</td><td class="mdescRight">A template to convert the characteristic data to &lt;type&gt;. <a href="class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4">More...</a><br /></td></tr>
<tr class="separator:a7d09c29b26362f6ddcaf51a9c9dc8be4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cd211a8bb9a0c2ffaed57f2af273677"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">setValue</a> (const uint8_t *data, size_t size)</td></tr>
<tr class="memdesc:a7cd211a8bb9a0c2ffaed57f2af273677"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the characteristic. <a href="class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677">More...</a><br /></td></tr>
<tr class="separator:a7cd211a8bb9a0c2ffaed57f2af273677"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e77647e4c9bd02c96b761639c4d206f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a3e77647e4c9bd02c96b761639c4d206f">setValue</a> (const std::string &amp;value)</td></tr>
<tr class="memdesc:a3e77647e4c9bd02c96b761639c4d206f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the characteristic from string data.<br />
We set the value of the characteristic from the bytes contained in the string. <a href="class_nim_b_l_e_characteristic.html#a3e77647e4c9bd02c96b761639c4d206f">More...</a><br /></td></tr>
<tr class="separator:a3e77647e4c9bd02c96b761639c4d206f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba05898f446e31222fbe509fa357c730"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:aba05898f446e31222fbe509fa357c730"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730">setValue</a> (const T &amp;s)</td></tr>
<tr class="memdesc:aba05898f446e31222fbe509fa357c730"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience template to set the characteristic value to &lt;type&gt;val. <a href="class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730">More...</a><br /></td></tr>
<tr class="separator:aba05898f446e31222fbe509fa357c730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84aa251a612810ec8d07e77ab03cb483"><td class="memItemLeft" align="right" valign="top"><a id="a84aa251a612810ec8d07e77ab03cb483"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a84aa251a612810ec8d07e77ab03cb483">getService</a> ()</td></tr>
<tr class="memdesc:a84aa251a612810ec8d07e77ab03cb483"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the service associated with this characteristic. <br /></td></tr>
<tr class="separator:a84aa251a612810ec8d07e77ab03cb483"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79759a98d9bdb761cb12c1ea6f601afc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#a79759a98d9bdb761cb12c1ea6f601afc">getProperties</a> ()</td></tr>
<tr class="memdesc:a79759a98d9bdb761cb12c1ea6f601afc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the properties of the characteristic. <a href="class_nim_b_l_e_characteristic.html#a79759a98d9bdb761cb12c1ea6f601afc">More...</a><br /></td></tr>
<tr class="separator:a79759a98d9bdb761cb12c1ea6f601afc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The model of a BLE Characteristic. </p>
<p>A BLE Characteristic is an identified value container that manages a value. It is exposed by a BLE server and can be read and written to by a BLE client. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a942b2d29d77fcef233549d0c4fd798da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a942b2d29d77fcef233549d0c4fd798da">&#9670;&nbsp;</a></span>NimBLECharacteristic() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLECharacteristic::NimBLECharacteristic </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>properties</em> = <code>NIMBLE_PROPERTY::READ&#160;|&#160;NIMBLE_PROPERTY::WRITE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td>
<td class="paramname"><em>pService</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>- UUID (const char*) for the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">properties</td><td>- Properties for the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pService</td><td>- pointer to the service instance this characteristic belongs to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acdbd57f7e97646403e520edc35c34c8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdbd57f7e97646403e520edc35c34c8b">&#9670;&nbsp;</a></span>NimBLECharacteristic() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLECharacteristic::NimBLECharacteristic </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>properties</em> = <code>NIMBLE_PROPERTY::READ&#160;|&#160;NIMBLE_PROPERTY::WRITE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td>
<td class="paramname"><em>pService</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>- UUID for the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">properties</td><td>- Properties for the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pService</td><td>- pointer to the service instance this characteristic belongs to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aed4b2241c89ad2a8f49117e2b9433e5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed4b2241c89ad2a8f49117e2b9433e5b">&#9670;&nbsp;</a></span>addDescriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::addDescriptor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td>
<td class="paramname"><em>pDescriptor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a descriptor to the characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pDescriptor</td><td>A pointer to the descriptor to add. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aae014669e9ce1ad01520d68fe0cc0fda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae014669e9ce1ad01520d68fe0cc0fda">&#9670;&nbsp;</a></span>createDescriptor() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> * NimBLECharacteristic::createDescriptor </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>properties</em> = <code>NIMBLE_PROPERTY::READ&#160;|&#160;NIMBLE_PROPERTY::WRITE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>max_len</em> = <code>100</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new BLE Descriptor associated with this characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>- The UUID of the descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">properties</td><td>- The properties of the descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>- The max length in bytes of the descriptor value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new BLE descriptor. </dd></dl>
</div>
</div>
<a id="a6523266a751a778a2c04fea19fed4de5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6523266a751a778a2c04fea19fed4de5">&#9670;&nbsp;</a></span>createDescriptor() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> * NimBLECharacteristic::createDescriptor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>properties</em> = <code>NIMBLE_PROPERTY::READ&#160;|&#160;NIMBLE_PROPERTY::WRITE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>max_len</em> = <code>100</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new BLE Descriptor associated with this characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>- The UUID of the descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">properties</td><td>- The properties of the descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>- The max length in bytes of the descriptor value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new BLE descriptor. </dd></dl>
</div>
</div>
<a id="a580ad0133fd82a673027c91cbb1c74fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a580ad0133fd82a673027c91cbb1c74fa">&#9670;&nbsp;</a></span>getDataLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t NimBLECharacteristic::getDataLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the the current data length of the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>The length of the current characteristic data. </dd></dl>
</div>
</div>
<a id="a062f52918f13c49a37ce8e58b9e7382a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a062f52918f13c49a37ce8e58b9e7382a">&#9670;&nbsp;</a></span>getDescriptorByHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> * NimBLECharacteristic::getDescriptorByHandle </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the BLE Descriptor for the given handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>The handle of the descriptor. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the descriptor object or nullptr if not found. </dd></dl>
</div>
</div>
<a id="abc5f4819e4d2c0956857ddd7a1064189"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc5f4819e4d2c0956857ddd7a1064189">&#9670;&nbsp;</a></span>getDescriptorByUUID() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> * NimBLECharacteristic::getDescriptorByUUID </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the BLE Descriptor for the given UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the descriptor. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the descriptor object or nullptr if not found. </dd></dl>
</div>
</div>
<a id="ae310b081d2d7d2a52ab2ddc11d5dbd99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae310b081d2d7d2a52ab2ddc11d5dbd99">&#9670;&nbsp;</a></span>getDescriptorByUUID() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> * NimBLECharacteristic::getDescriptorByUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the BLE Descriptor for the given UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the descriptor. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the descriptor object or nullptr if not found. </dd></dl>
</div>
</div>
<a id="acc3ea122771cd447103adfce22537379"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc3ea122771cd447103adfce22537379">&#9670;&nbsp;</a></span>getHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLECharacteristic::getHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the handle of the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>The handle of the characteristic. </dd></dl>
</div>
</div>
<a id="a79759a98d9bdb761cb12c1ea6f601afc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79759a98d9bdb761cb12c1ea6f601afc">&#9670;&nbsp;</a></span>getProperties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLECharacteristic::getProperties </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the properties of the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>The properties of the characteristic. </dd></dl>
</div>
</div>
<a id="aced225d46153b6969f6ded30c0190e39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aced225d46153b6969f6ded30c0190e39">&#9670;&nbsp;</a></span>getSubscribedCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t NimBLECharacteristic::getSubscribedCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of clients subscribed to the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of clients subscribed to notifications / indications. </dd></dl>
</div>
</div>
<a id="a28b03617fe753133582ba4e58c60e52e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28b03617fe753133582ba4e58c60e52e">&#9670;&nbsp;</a></span>getUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLECharacteristic::getUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the UUID of the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>The UUID of the characteristic. </dd></dl>
</div>
</div>
<a id="a37e908d114f6ad2b4bf19c7cc4db9c54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37e908d114f6ad2b4bf19c7cc4db9c54">&#9670;&nbsp;</a></span>getValue() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLECharacteristic::getValue </td>
<td>(</td>
<td class="paramtype">time_t *&#160;</td>
<td class="paramname"><em>timestamp</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current value of the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>A std::string containing the current characteristic value. </dd></dl>
</div>
</div>
<a id="a7d09c29b26362f6ddcaf51a9c9dc8be4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d09c29b26362f6ddcaf51a9c9dc8be4">&#9670;&nbsp;</a></span>getValue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T NimBLECharacteristic::getValue </td>
<td>(</td>
<td class="paramtype">time_t *&#160;</td>
<td class="paramname"><em>timestamp</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A template to convert the characteristic data to &lt;type&gt;. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type to convert the data to. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timestamp</td><td>A pointer to a time_t struct to store the time the value was read. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">skipSizeCheck</td><td>If true it will skip checking if the data size is less than <code>sizeof(&lt;type&gt;)</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The data converted to &lt;type&gt; or NULL if skipSizeCheck is false and the data is less than <code>sizeof(&lt;type&gt;)</code>.</dd></dl>
<p><b>Use:</b> <code>getValue&lt;type&gt;(&amp;timestamp, skipSizeCheck);</code> </p>
</div>
</div>
<a id="aa45461059e1992c816e32c371d17e813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa45461059e1992c816e32c371d17e813">&#9670;&nbsp;</a></span>notify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::notify </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_notification</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a notification.<br />
A notification is a transmission of up to the first 20 bytes of the characteristic value.<br />
A notification will not block; it is a fire and forget. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">is_notification</td><td>if true sends a notification, false sends an indication. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2c0ed8932ee257a8632e3d72e353489b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c0ed8932ee257a8632e3d72e353489b">&#9670;&nbsp;</a></span>removeDescriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::removeDescriptor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td>
<td class="paramname"><em>pDescriptor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteDsc</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a descriptor from the characterisitc. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pDescriptor</td><td>A pointer to the descriptor instance to remove from the characterisitc. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">deleteDsc</td><td>If true it will delete the descriptor instance and free it's resources. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a29dc2505e1d3b4a7d6800d1547965d17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29dc2505e1d3b4a7d6800d1547965d17">&#9670;&nbsp;</a></span>setCallbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::setCallbacks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a> *&#160;</td>
<td class="paramname"><em>pCallbacks</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the callback handlers for this characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCallbacks</td><td>An instance of a <a class="el" href="class_nim_b_l_e_characteristic_callbacks.html" title="Callbacks that can be associated with a BLE characteristic to inform of events.">NimBLECharacteristicCallbacks</a> class<br />
used to define any callbacks for the characteristic. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3e77647e4c9bd02c96b761639c4d206f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e77647e4c9bd02c96b761639c4d206f">&#9670;&nbsp;</a></span>setValue() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::setValue </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of the characteristic from string data.<br />
We set the value of the characteristic from the bytes contained in the string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>the std::string value of the characteristic. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aba05898f446e31222fbe509fa357c730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba05898f446e31222fbe509fa357c730">&#9670;&nbsp;</a></span>setValue() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::setValue </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience template to set the characteristic value to &lt;type&gt;val. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The value to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7cd211a8bb9a0c2ffaed57f2af273677"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cd211a8bb9a0c2ffaed57f2af273677">&#9670;&nbsp;</a></span>setValue() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::setValue </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of the characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to set for the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4fa6b8ed011d12e2b1f16e92a02b9a89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fa6b8ed011d12e2b1f16e92a02b9a89">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLECharacteristic::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string representation of the characteristic. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of the characteristic. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,29 @@
var class_nim_b_l_e_characteristic =
[
[ "NimBLECharacteristic", "class_nim_b_l_e_characteristic.html#a942b2d29d77fcef233549d0c4fd798da", null ],
[ "NimBLECharacteristic", "class_nim_b_l_e_characteristic.html#acdbd57f7e97646403e520edc35c34c8b", null ],
[ "~NimBLECharacteristic", "class_nim_b_l_e_characteristic.html#a7fe29c5ec571d0513c51b8cbac942f4a", null ],
[ "addDescriptor", "class_nim_b_l_e_characteristic.html#aed4b2241c89ad2a8f49117e2b9433e5b", null ],
[ "createDescriptor", "class_nim_b_l_e_characteristic.html#aae014669e9ce1ad01520d68fe0cc0fda", null ],
[ "createDescriptor", "class_nim_b_l_e_characteristic.html#a6523266a751a778a2c04fea19fed4de5", null ],
[ "getCallbacks", "class_nim_b_l_e_characteristic.html#a1747ac4889c7adbb93a2d88a10327a47", null ],
[ "getDataLength", "class_nim_b_l_e_characteristic.html#a580ad0133fd82a673027c91cbb1c74fa", null ],
[ "getDescriptorByHandle", "class_nim_b_l_e_characteristic.html#a062f52918f13c49a37ce8e58b9e7382a", null ],
[ "getDescriptorByUUID", "class_nim_b_l_e_characteristic.html#abc5f4819e4d2c0956857ddd7a1064189", null ],
[ "getDescriptorByUUID", "class_nim_b_l_e_characteristic.html#ae310b081d2d7d2a52ab2ddc11d5dbd99", null ],
[ "getHandle", "class_nim_b_l_e_characteristic.html#acc3ea122771cd447103adfce22537379", null ],
[ "getProperties", "class_nim_b_l_e_characteristic.html#a79759a98d9bdb761cb12c1ea6f601afc", null ],
[ "getService", "class_nim_b_l_e_characteristic.html#a84aa251a612810ec8d07e77ab03cb483", null ],
[ "getSubscribedCount", "class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39", null ],
[ "getUUID", "class_nim_b_l_e_characteristic.html#a28b03617fe753133582ba4e58c60e52e", null ],
[ "getValue", "class_nim_b_l_e_characteristic.html#a37e908d114f6ad2b4bf19c7cc4db9c54", null ],
[ "getValue", "class_nim_b_l_e_characteristic.html#a7d09c29b26362f6ddcaf51a9c9dc8be4", null ],
[ "indicate", "class_nim_b_l_e_characteristic.html#a2ce9f62ecc3d1644ef4d58efe7a3c434", null ],
[ "notify", "class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813", null ],
[ "removeDescriptor", "class_nim_b_l_e_characteristic.html#a2c0ed8932ee257a8632e3d72e353489b", null ],
[ "setCallbacks", "class_nim_b_l_e_characteristic.html#a29dc2505e1d3b4a7d6800d1547965d17", null ],
[ "setValue", "class_nim_b_l_e_characteristic.html#a3e77647e4c9bd02c96b761639c4d206f", null ],
[ "setValue", "class_nim_b_l_e_characteristic.html#aba05898f446e31222fbe509fa357c730", null ],
[ "setValue", "class_nim_b_l_e_characteristic.html#a7cd211a8bb9a0c2ffaed57f2af273677", null ],
[ "toString", "class_nim_b_l_e_characteristic.html#a4fa6b8ed011d12e2b1f16e92a02b9a89", null ]
];

View File

@@ -0,0 +1,109 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_characteristic_callbacks.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">NimBLECharacteristicCallbacks Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a185eb5298cc042f1aceeba21caf0dcc9">onNotify</a>(NimBLECharacteristic *pCharacteristic)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93">onRead</a>(NimBLECharacteristic *pCharacteristic)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#acae83420ae378277c225ce465f979f88">onRead</a>(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#ab17e7c61723a33cd3c922e3ca9c20f1e">onStatus</a>(NimBLECharacteristic *pCharacteristic, Status s, int code)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a3c0c0f524bc0d00d24a7c5ea92c5cb7e">onSubscribe</a>(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc, uint16_t subValue)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3">onWrite</a>(NimBLECharacteristic *pCharacteristic)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a303a44a2efad76d54d67955fcb7b05d7">onWrite</a>(NimBLECharacteristic *pCharacteristic, ble_gap_conn_desc *desc)</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">Status</a> enum name</td><td class="entry"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,461 @@
<!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: NimBLECharacteristicCallbacks Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_characteristic_callbacks.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_characteristic_callbacks-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLECharacteristicCallbacks Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Callbacks that can be associated with a BLE characteristic to inform of events.
<a href="class_nim_b_l_e_characteristic_callbacks.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a104baba3c4bbdee7aa28273d265e4c6f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">Status</a> </td></tr>
<tr class="memdesc:a104baba3c4bbdee7aa28273d265e4c6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enum to provide the callback the status of the notification/indication, implemented for backward compatibility. <a href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">More...</a><br /></td></tr>
<tr class="separator:a104baba3c4bbdee7aa28273d265e4c6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a523904b8d39e364db094f623403bad93"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93">onRead</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic)</td></tr>
<tr class="memdesc:a523904b8d39e364db094f623403bad93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a read request. <a href="class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93">More...</a><br /></td></tr>
<tr class="separator:a523904b8d39e364db094f623403bad93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acae83420ae378277c225ce465f979f88"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#acae83420ae378277c225ce465f979f88">onRead</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic, ble_gap_conn_desc *desc)</td></tr>
<tr class="memdesc:acae83420ae378277c225ce465f979f88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a read request. <a href="class_nim_b_l_e_characteristic_callbacks.html#acae83420ae378277c225ce465f979f88">More...</a><br /></td></tr>
<tr class="separator:acae83420ae378277c225ce465f979f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac7caf4a80da061b5beda5ebcd214fc3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3">onWrite</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic)</td></tr>
<tr class="memdesc:aac7caf4a80da061b5beda5ebcd214fc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a write request. <a href="class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3">More...</a><br /></td></tr>
<tr class="separator:aac7caf4a80da061b5beda5ebcd214fc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a303a44a2efad76d54d67955fcb7b05d7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a303a44a2efad76d54d67955fcb7b05d7">onWrite</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic, ble_gap_conn_desc *desc)</td></tr>
<tr class="memdesc:a303a44a2efad76d54d67955fcb7b05d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a write request. <a href="class_nim_b_l_e_characteristic_callbacks.html#a303a44a2efad76d54d67955fcb7b05d7">More...</a><br /></td></tr>
<tr class="separator:a303a44a2efad76d54d67955fcb7b05d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a185eb5298cc042f1aceeba21caf0dcc9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a185eb5298cc042f1aceeba21caf0dcc9">onNotify</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic)</td></tr>
<tr class="memdesc:a185eb5298cc042f1aceeba21caf0dcc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a Notify request. <a href="class_nim_b_l_e_characteristic_callbacks.html#a185eb5298cc042f1aceeba21caf0dcc9">More...</a><br /></td></tr>
<tr class="separator:a185eb5298cc042f1aceeba21caf0dcc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab17e7c61723a33cd3c922e3ca9c20f1e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#ab17e7c61723a33cd3c922e3ca9c20f1e">onStatus</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic, <a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">Status</a> s, int code)</td></tr>
<tr class="memdesc:ab17e7c61723a33cd3c922e3ca9c20f1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a Notify/Indicate Status report. <a href="class_nim_b_l_e_characteristic_callbacks.html#ab17e7c61723a33cd3c922e3ca9c20f1e">More...</a><br /></td></tr>
<tr class="separator:ab17e7c61723a33cd3c922e3ca9c20f1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c0c0f524bc0d00d24a7c5ea92c5cb7e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a3c0c0f524bc0d00d24a7c5ea92c5cb7e">onSubscribe</a> (<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic, ble_gap_conn_desc *desc, uint16_t subValue)</td></tr>
<tr class="memdesc:a3c0c0f524bc0d00d24a7c5ea92c5cb7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function called when a client changes subscription status. <a href="class_nim_b_l_e_characteristic_callbacks.html#a3c0c0f524bc0d00d24a7c5ea92c5cb7e">More...</a><br /></td></tr>
<tr class="separator:a3c0c0f524bc0d00d24a7c5ea92c5cb7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Callbacks that can be associated with a BLE characteristic to inform of events. </p>
<p>When a server application creates a BLE characteristic, we may wish to be informed when there is either a read or write request to the characteristic's value. An application can register a sub-classed instance of this class and will be notified when such an event happens. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a104baba3c4bbdee7aa28273d265e4c6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a104baba3c4bbdee7aa28273d265e4c6f">&#9670;&nbsp;</a></span>Status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">NimBLECharacteristicCallbacks::Status</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum to provide the callback the status of the notification/indication, implemented for backward compatibility. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>To be removed in the future as the NimBLE stack return code is also provided. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a185eb5298cc042f1aceeba21caf0dcc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a185eb5298cc042f1aceeba21caf0dcc9">&#9670;&nbsp;</a></span>onNotify()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onNotify </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a Notify request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a523904b8d39e364db094f623403bad93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a523904b8d39e364db094f623403bad93">&#9670;&nbsp;</a></span>onRead() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onRead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a read request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acae83420ae378277c225ce465f979f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acae83420ae378277c225ce465f979f88">&#9670;&nbsp;</a></span>onRead() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onRead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a read request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>The connection description struct that is associated with the peer that performed the read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab17e7c61723a33cd3c922e3ca9c20f1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab17e7c61723a33cd3c922e3ca9c20f1e">&#9670;&nbsp;</a></span>onStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f">Status</a>&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>code</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a Notify/Indicate Status report. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>Status of the notification/indication. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>Additional return code from the NimBLE stack. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3c0c0f524bc0d00d24a7c5ea92c5cb7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c0c0f524bc0d00d24a7c5ea92c5cb7e">&#9670;&nbsp;</a></span>onSubscribe()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onSubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>subValue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function called when a client changes subscription status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>The connection description struct that is associated with the client. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">subValue</td><td>The subscription status:<ul>
<li>0 = Un-Subscribed</li>
<li>1 = Notifications</li>
<li>2 = Indications</li>
<li>3 = Notifications and Indications </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aac7caf4a80da061b5beda5ebcd214fc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac7caf4a80da061b5beda5ebcd214fc3">&#9670;&nbsp;</a></span>onWrite() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a write request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a303a44a2efad76d54d67955fcb7b05d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a303a44a2efad76d54d67955fcb7b05d7">&#9670;&nbsp;</a></span>onWrite() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristicCallbacks::onWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
<td class="paramname"><em>pCharacteristic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a write request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>The characteristic that is the source of the event. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>The connection description struct that is associated with the peer that performed the write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html">NimBLECharacteristicCallbacks</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,14 @@
var class_nim_b_l_e_characteristic_callbacks =
[
[ "Status", "class_nim_b_l_e_characteristic_callbacks.html#a104baba3c4bbdee7aa28273d265e4c6f", [
[ "Example", "md_docs__migration_guide.html#autotoc_md51", null ],
[ "Example", "md_docs__migration_guide.html#autotoc_md52", null ]
] ],
[ "onNotify", "class_nim_b_l_e_characteristic_callbacks.html#a185eb5298cc042f1aceeba21caf0dcc9", null ],
[ "onRead", "class_nim_b_l_e_characteristic_callbacks.html#a523904b8d39e364db094f623403bad93", null ],
[ "onRead", "class_nim_b_l_e_characteristic_callbacks.html#acae83420ae378277c225ce465f979f88", null ],
[ "onStatus", "class_nim_b_l_e_characteristic_callbacks.html#ab17e7c61723a33cd3c922e3ca9c20f1e", null ],
[ "onSubscribe", "class_nim_b_l_e_characteristic_callbacks.html#a3c0c0f524bc0d00d24a7c5ea92c5cb7e", null ],
[ "onWrite", "class_nim_b_l_e_characteristic_callbacks.html#aac7caf4a80da061b5beda5ebcd214fc3", null ],
[ "onWrite", "class_nim_b_l_e_characteristic_callbacks.html#a303a44a2efad76d54d67955fcb7b05d7", null ]
];

View File

@@ -0,0 +1,129 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_client.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">NimBLEClient Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#ab09639b499fdcd0021a2432b2b8203f5">begin</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">connect</a>(NimBLEAdvertisedDevice *device, bool deleteAttibutes=true)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a9188741bf29d58d5ff1352383c959b7b">connect</a>(const NimBLEAddress &amp;address, bool deleteAttibutes=true)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a836438fc9d5c2001207249661ad10e01">connect</a>(bool deleteAttibutes=true)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a0f940c51807469db1f1802b742180beb">deleteService</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a668d476de250055a106a9f46bb7719f3">deleteServices</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a5f77999664cc8a83f3cdb603ba4a5c8c">disconnect</a>(uint8_t reason=BLE_ERR_REM_USER_CONN_TERM)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a3d8cbf51caf8b3b8a0ec6ce2074ba71d">discoverAttributes</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a0accd665926ea77d85ecb483b2b853fe">end</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a2fc46f43a71dd0df63a377961baf8009">getCharacteristic</a>(const uint16_t handle)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#aa09466a7050bf08bab2390da66007896">getConnId</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a566207f548c6b799792fc092f1748267">getConnInfo</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#ab971537eec4e53d621598eb1c760af3a">getMTU</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a0477ba593f0b7c0cfc4697efdba703eb">getPeerAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#ae216993cf4eeb5780a104a8b14044f78">getRssi</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366">getService</a>(const char *uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#ad8ba10522d79af1136019606802f0978">getService</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#acb9007569b3bb13b3b49f3c4cb47b21a">getServices</a>(bool refresh=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#afd7b5c40f3c190a542f25b0b9e4afaf3">getValue</a>(const NimBLEUUID &amp;serviceUUID, const NimBLEUUID &amp;characteristicUUID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#af1603da59b829f75b162ac4a65ce181c">isConnected</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a79935ecbe94f2a41e0106d011edafac4">secureConnection</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#aeede4deef7421b9121387a786c07820c">setClientCallbacks</a>(NimBLEClientCallbacks *pClientCallbacks, bool deleteCallbacks=true)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a17718339f76eb621db0d7919c73b9267">setConnectionParams</a>(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a4068b29a9bd12e3110465908864dd20e">setConnectTimeout</a>(uint8_t timeout)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a93b5b7c01e58a95dcea335f837d81d07">setPeerAddress</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#a0910bbe298a68e9122a169ab229bf767">setValue</a>(const NimBLEUUID &amp;serviceUUID, const NimBLEUUID &amp;characteristicUUID, const std::string &amp;value, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#aba9ae035357776514b61c2b6286ce1ab">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">updateConnParams</a>(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

924
class_nim_b_l_e_client.html Normal file
View File

@@ -0,0 +1,924 @@
<!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: NimBLEClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_client.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_client-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A model of a BLE client.
<a href="class_nim_b_l_e_client.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aab311f0a8af21fb63f78e7fbac29951a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">connect</a> (<a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *device, bool deleteAttibutes=true)</td></tr>
<tr class="memdesc:aab311f0a8af21fb63f78e7fbac29951a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to an advertising device. <a href="class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a">More...</a><br /></td></tr>
<tr class="separator:aab311f0a8af21fb63f78e7fbac29951a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9188741bf29d58d5ff1352383c959b7b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a9188741bf29d58d5ff1352383c959b7b">connect</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address, bool deleteAttibutes=true)</td></tr>
<tr class="memdesc:a9188741bf29d58d5ff1352383c959b7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to the BLE Server. <a href="class_nim_b_l_e_client.html#a9188741bf29d58d5ff1352383c959b7b">More...</a><br /></td></tr>
<tr class="separator:a9188741bf29d58d5ff1352383c959b7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836438fc9d5c2001207249661ad10e01"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a836438fc9d5c2001207249661ad10e01">connect</a> (bool deleteAttibutes=true)</td></tr>
<tr class="memdesc:a836438fc9d5c2001207249661ad10e01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to the BLE Server. <a href="class_nim_b_l_e_client.html#a836438fc9d5c2001207249661ad10e01">More...</a><br /></td></tr>
<tr class="separator:a836438fc9d5c2001207249661ad10e01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f77999664cc8a83f3cdb603ba4a5c8c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a5f77999664cc8a83f3cdb603ba4a5c8c">disconnect</a> (uint8_t reason=BLE_ERR_REM_USER_CONN_TERM)</td></tr>
<tr class="memdesc:a5f77999664cc8a83f3cdb603ba4a5c8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect from the peer. <a href="class_nim_b_l_e_client.html#a5f77999664cc8a83f3cdb603ba4a5c8c">More...</a><br /></td></tr>
<tr class="separator:a5f77999664cc8a83f3cdb603ba4a5c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0477ba593f0b7c0cfc4697efdba703eb"><td class="memItemLeft" align="right" valign="top"><a id="a0477ba593f0b7c0cfc4697efdba703eb"></a>
<a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a0477ba593f0b7c0cfc4697efdba703eb">getPeerAddress</a> ()</td></tr>
<tr class="memdesc:a0477ba593f0b7c0cfc4697efdba703eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the address of the peer. <br /></td></tr>
<tr class="separator:a0477ba593f0b7c0cfc4697efdba703eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93b5b7c01e58a95dcea335f837d81d07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a93b5b7c01e58a95dcea335f837d81d07">setPeerAddress</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address)</td></tr>
<tr class="memdesc:a93b5b7c01e58a95dcea335f837d81d07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the peer address. <a href="class_nim_b_l_e_client.html#a93b5b7c01e58a95dcea335f837d81d07">More...</a><br /></td></tr>
<tr class="separator:a93b5b7c01e58a95dcea335f837d81d07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae216993cf4eeb5780a104a8b14044f78"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#ae216993cf4eeb5780a104a8b14044f78">getRssi</a> ()</td></tr>
<tr class="memdesc:ae216993cf4eeb5780a104a8b14044f78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ask the BLE server for the RSSI value. <a href="class_nim_b_l_e_client.html#ae216993cf4eeb5780a104a8b14044f78">More...</a><br /></td></tr>
<tr class="separator:ae216993cf4eeb5780a104a8b14044f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb9007569b3bb13b3b49f3c4cb47b21a"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#acb9007569b3bb13b3b49f3c4cb47b21a">getServices</a> (bool refresh=false)</td></tr>
<tr class="memdesc:acb9007569b3bb13b3b49f3c4cb47b21a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the vector of found services. <a href="class_nim_b_l_e_client.html#acb9007569b3bb13b3b49f3c4cb47b21a">More...</a><br /></td></tr>
<tr class="separator:acb9007569b3bb13b3b49f3c4cb47b21a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09639b499fdcd0021a2432b2b8203f5"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#ab09639b499fdcd0021a2432b2b8203f5">begin</a> ()</td></tr>
<tr class="memdesc:ab09639b499fdcd0021a2432b2b8203f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning of the vector of remote service pointers. <a href="class_nim_b_l_e_client.html#ab09639b499fdcd0021a2432b2b8203f5">More...</a><br /></td></tr>
<tr class="separator:ab09639b499fdcd0021a2432b2b8203f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0accd665926ea77d85ecb483b2b853fe"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a0accd665926ea77d85ecb483b2b853fe">end</a> ()</td></tr>
<tr class="memdesc:a0accd665926ea77d85ecb483b2b853fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end of the vector of remote service pointers. <a href="class_nim_b_l_e_client.html#a0accd665926ea77d85ecb483b2b853fe">More...</a><br /></td></tr>
<tr class="separator:a0accd665926ea77d85ecb483b2b853fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae22379ab10bd82932d2303fb3753c366"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366">getService</a> (const char *uuid)</td></tr>
<tr class="memdesc:ae22379ab10bd82932d2303fb3753c366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the service BLE Remote Service instance corresponding to the uuid. <a href="class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366">More...</a><br /></td></tr>
<tr class="separator:ae22379ab10bd82932d2303fb3753c366"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8ba10522d79af1136019606802f0978"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#ad8ba10522d79af1136019606802f0978">getService</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:ad8ba10522d79af1136019606802f0978"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the service object corresponding to the uuid. <a href="class_nim_b_l_e_client.html#ad8ba10522d79af1136019606802f0978">More...</a><br /></td></tr>
<tr class="separator:ad8ba10522d79af1136019606802f0978"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a668d476de250055a106a9f46bb7719f3"><td class="memItemLeft" align="right" valign="top"><a id="a668d476de250055a106a9f46bb7719f3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a668d476de250055a106a9f46bb7719f3">deleteServices</a> ()</td></tr>
<tr class="memdesc:a668d476de250055a106a9f46bb7719f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete all service objects created by this client and clear the vector. <br /></td></tr>
<tr class="separator:a668d476de250055a106a9f46bb7719f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f940c51807469db1f1802b742180beb"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a0f940c51807469db1f1802b742180beb">deleteService</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:a0f940c51807469db1f1802b742180beb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete service by UUID. <a href="class_nim_b_l_e_client.html#a0f940c51807469db1f1802b742180beb">More...</a><br /></td></tr>
<tr class="separator:a0f940c51807469db1f1802b742180beb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd7b5c40f3c190a542f25b0b9e4afaf3"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#afd7b5c40f3c190a542f25b0b9e4afaf3">getValue</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID, const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUUID)</td></tr>
<tr class="memdesc:afd7b5c40f3c190a542f25b0b9e4afaf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a specific characteristic associated with a specific service. <a href="class_nim_b_l_e_client.html#afd7b5c40f3c190a542f25b0b9e4afaf3">More...</a><br /></td></tr>
<tr class="separator:afd7b5c40f3c190a542f25b0b9e4afaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0910bbe298a68e9122a169ab229bf767"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a0910bbe298a68e9122a169ab229bf767">setValue</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;serviceUUID, const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUUID, const std::string &amp;value, bool response=false)</td></tr>
<tr class="memdesc:a0910bbe298a68e9122a169ab229bf767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of a specific characteristic associated with a specific service. <a href="class_nim_b_l_e_client.html#a0910bbe298a68e9122a169ab229bf767">More...</a><br /></td></tr>
<tr class="separator:a0910bbe298a68e9122a169ab229bf767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fc46f43a71dd0df63a377961baf8009"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a2fc46f43a71dd0df63a377961baf8009">getCharacteristic</a> (const uint16_t handle)</td></tr>
<tr class="memdesc:a2fc46f43a71dd0df63a377961baf8009"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the remote characteristic with the specified handle. <a href="class_nim_b_l_e_client.html#a2fc46f43a71dd0df63a377961baf8009">More...</a><br /></td></tr>
<tr class="separator:a2fc46f43a71dd0df63a377961baf8009"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1603da59b829f75b162ac4a65ce181c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#af1603da59b829f75b162ac4a65ce181c">isConnected</a> ()</td></tr>
<tr class="memdesc:af1603da59b829f75b162ac4a65ce181c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Are we connected to a server? <a href="class_nim_b_l_e_client.html#af1603da59b829f75b162ac4a65ce181c">More...</a><br /></td></tr>
<tr class="separator:af1603da59b829f75b162ac4a65ce181c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeede4deef7421b9121387a786c07820c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#aeede4deef7421b9121387a786c07820c">setClientCallbacks</a> (<a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a> *pClientCallbacks, bool deleteCallbacks=true)</td></tr>
<tr class="memdesc:aeede4deef7421b9121387a786c07820c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the callbacks that will be invoked when events are received. <a href="class_nim_b_l_e_client.html#aeede4deef7421b9121387a786c07820c">More...</a><br /></td></tr>
<tr class="separator:aeede4deef7421b9121387a786c07820c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba9ae035357776514b61c2b6286ce1ab"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#aba9ae035357776514b61c2b6286ce1ab">toString</a> ()</td></tr>
<tr class="memdesc:aba9ae035357776514b61c2b6286ce1ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of this client. <a href="class_nim_b_l_e_client.html#aba9ae035357776514b61c2b6286ce1ab">More...</a><br /></td></tr>
<tr class="separator:aba9ae035357776514b61c2b6286ce1ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa09466a7050bf08bab2390da66007896"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#aa09466a7050bf08bab2390da66007896">getConnId</a> ()</td></tr>
<tr class="memdesc:aa09466a7050bf08bab2390da66007896"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the connection id for this client. <a href="class_nim_b_l_e_client.html#aa09466a7050bf08bab2390da66007896">More...</a><br /></td></tr>
<tr class="separator:aa09466a7050bf08bab2390da66007896"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab971537eec4e53d621598eb1c760af3a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#ab971537eec4e53d621598eb1c760af3a">getMTU</a> ()</td></tr>
<tr class="memdesc:ab971537eec4e53d621598eb1c760af3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current mtu of this connection. <a href="class_nim_b_l_e_client.html#ab971537eec4e53d621598eb1c760af3a">More...</a><br /></td></tr>
<tr class="separator:ab971537eec4e53d621598eb1c760af3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79935ecbe94f2a41e0106d011edafac4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a79935ecbe94f2a41e0106d011edafac4">secureConnection</a> ()</td></tr>
<tr class="memdesc:a79935ecbe94f2a41e0106d011edafac4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a secure connection (pair/bond) with the server.<br />
Called automatically when a characteristic or descriptor requires encryption or authentication to access it. <a href="class_nim_b_l_e_client.html#a79935ecbe94f2a41e0106d011edafac4">More...</a><br /></td></tr>
<tr class="separator:a79935ecbe94f2a41e0106d011edafac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4068b29a9bd12e3110465908864dd20e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a4068b29a9bd12e3110465908864dd20e">setConnectTimeout</a> (uint8_t timeout)</td></tr>
<tr class="memdesc:a4068b29a9bd12e3110465908864dd20e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the timeout to wait for connection attempt to complete. <a href="class_nim_b_l_e_client.html#a4068b29a9bd12e3110465908864dd20e">More...</a><br /></td></tr>
<tr class="separator:a4068b29a9bd12e3110465908864dd20e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17718339f76eb621db0d7919c73b9267"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a17718339f76eb621db0d7919c73b9267">setConnectionParams</a> (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout, uint16_t scanInterval=16, uint16_t scanWindow=16)</td></tr>
<tr class="memdesc:a17718339f76eb621db0d7919c73b9267"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the connection paramaters to use when connecting to a server. <a href="class_nim_b_l_e_client.html#a17718339f76eb621db0d7919c73b9267">More...</a><br /></td></tr>
<tr class="separator:a17718339f76eb621db0d7919c73b9267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff7d389ec48567286ea732c54d320526"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">updateConnParams</a> (uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</td></tr>
<tr class="memdesc:aff7d389ec48567286ea732c54d320526"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the connection parameters: <a href="class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526">More...</a><br /></td></tr>
<tr class="separator:aff7d389ec48567286ea732c54d320526"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8cbf51caf8b3b8a0ec6ce2074ba71d"><td class="memItemLeft" align="right" valign="top"><a id="a3d8cbf51caf8b3b8a0ec6ce2074ba71d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a3d8cbf51caf8b3b8a0ec6ce2074ba71d">discoverAttributes</a> ()</td></tr>
<tr class="memdesc:a3d8cbf51caf8b3b8a0ec6ce2074ba71d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the full database of attributes that the peripheral has available. <br /></td></tr>
<tr class="separator:a3d8cbf51caf8b3b8a0ec6ce2074ba71d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a566207f548c6b799792fc092f1748267"><td class="memItemLeft" align="right" valign="top"><a id="a566207f548c6b799792fc092f1748267"></a>
<a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client.html#a566207f548c6b799792fc092f1748267">getConnInfo</a> ()</td></tr>
<tr class="memdesc:a566207f548c6b799792fc092f1748267"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get detailed information about the current peer connection. <br /></td></tr>
<tr class="separator:a566207f548c6b799792fc092f1748267"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of a BLE client. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab09639b499fdcd0021a2432b2b8203f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab09639b499fdcd0021a2432b2b8203f5">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * &gt;::iterator NimBLEClient::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the beginning of the vector of remote service pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the beginning of the vector of remote service pointers. </dd></dl>
</div>
</div>
<a id="a836438fc9d5c2001207249661ad10e01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a836438fc9d5c2001207249661ad10e01">&#9670;&nbsp;</a></span>connect() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClient::connect </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteAttibutes</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect to the BLE Server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">deleteAttibutes</td><td>If true this will delete any attribute objects this client may already<br />
have created and clears the vectors after successful connection. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>
</div>
</div>
<a id="a9188741bf29d58d5ff1352383c959b7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9188741bf29d58d5ff1352383c959b7b">&#9670;&nbsp;</a></span>connect() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClient::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteAttibutes</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect to the BLE Server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address of the server. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">deleteAttibutes</td><td>If true this will delete any attribute objects this client may already<br />
have created and clears the vectors after successful connection. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>
</div>
</div>
<a id="aab311f0a8af21fb63f78e7fbac29951a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab311f0a8af21fb63f78e7fbac29951a">&#9670;&nbsp;</a></span>connect() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClient::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *&#160;</td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteAttibutes</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect to an advertising device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>The device to connect to. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">deleteAttibutes</td><td>If true this will delete any attribute objects this client may already<br />
have created and clears the vectors after successful connection. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>
</div>
</div>
<a id="a0f940c51807469db1f1802b742180beb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f940c51807469db1f1802b742180beb">&#9670;&nbsp;</a></span>deleteService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t NimBLEClient::deleteService </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete service by UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the service to be deleted from the local database. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of services left. </dd></dl>
</div>
</div>
<a id="a5f77999664cc8a83f3cdb603ba4a5c8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f77999664cc8a83f3cdb603ba4a5c8c">&#9670;&nbsp;</a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NimBLEClient::disconnect </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reason</em> = <code>BLE_ERR_REM_USER_CONN_TERM</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnect from the peer. </p>
<dl class="section return"><dt>Returns</dt><dd>Error code from NimBLE stack, 0 = success. </dd></dl>
</div>
</div>
<a id="a0accd665926ea77d85ecb483b2b853fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0accd665926ea77d85ecb483b2b853fe">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * &gt;::iterator NimBLEClient::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the end of the vector of remote service pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the end of the vector of remote service pointers. </dd></dl>
</div>
</div>
<a id="a2fc46f43a71dd0df63a377961baf8009"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fc46f43a71dd0df63a377961baf8009">&#9670;&nbsp;</a></span>getCharacteristic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLEClient::getCharacteristic </td>
<td>(</td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the remote characteristic with the specified handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>The handle of the desired characteristic. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The matching remote characteristic, nullptr otherwise. </dd></dl>
</div>
</div>
<a id="aa09466a7050bf08bab2390da66007896"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa09466a7050bf08bab2390da66007896">&#9670;&nbsp;</a></span>getConnId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEClient::getConnId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the connection id for this client. </p>
<dl class="section return"><dt>Returns</dt><dd>The connection id. </dd></dl>
</div>
</div>
<a id="ab971537eec4e53d621598eb1c760af3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab971537eec4e53d621598eb1c760af3a">&#9670;&nbsp;</a></span>getMTU()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEClient::getMTU </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current mtu of this connection. </p>
<dl class="section return"><dt>Returns</dt><dd>The MTU value. </dd></dl>
</div>
</div>
<a id="ae216993cf4eeb5780a104a8b14044f78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae216993cf4eeb5780a104a8b14044f78">&#9670;&nbsp;</a></span>getRssi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NimBLEClient::getRssi </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ask the BLE server for the RSSI value. </p>
<dl class="section return"><dt>Returns</dt><dd>The RSSI value. </dd></dl>
</div>
</div>
<a id="ae22379ab10bd82932d2303fb3753c366"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae22379ab10bd82932d2303fb3753c366">&#9670;&nbsp;</a></span>getService() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * NimBLEClient::getService </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the service BLE Remote Service instance corresponding to the uuid. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the service being sought. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the service or nullptr if not found. </dd></dl>
</div>
</div>
<a id="ad8ba10522d79af1136019606802f0978"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8ba10522d79af1136019606802f0978">&#9670;&nbsp;</a></span>getService() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * NimBLEClient::getService </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the service object corresponding to the uuid. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the service being sought. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the service or nullptr if not found. </dd></dl>
</div>
</div>
<a id="acb9007569b3bb13b3b49f3c4cb47b21a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb9007569b3bb13b3b49f3c4cb47b21a">&#9670;&nbsp;</a></span>getServices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * &gt; * NimBLEClient::getServices </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>refresh</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the vector of found services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">refresh</td><td>If true the current services vector will be cleared and<br />
all services will be retrieved from the peripheral.<br />
If false the vector will be returned with the currently stored services. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the vector of available services. </dd></dl>
</div>
</div>
<a id="afd7b5c40f3c190a542f25b0b9e4afaf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd7b5c40f3c190a542f25b0b9e4afaf3">&#9670;&nbsp;</a></span>getValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEClient::getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>serviceUUID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>characteristicUUID</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of a specific characteristic associated with a specific service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The service that owns the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">characteristicUUID</td><td>The characteristic whose value we wish to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>characteristic value or an empty string if not found </dd></dl>
</div>
</div>
<a id="af1603da59b829f75b162ac4a65ce181c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1603da59b829f75b162ac4a65ce181c">&#9670;&nbsp;</a></span>isConnected()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClient::isConnected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Are we connected to a server? </p>
<dl class="section return"><dt>Returns</dt><dd>True if we are connected and false if we are not connected. </dd></dl>
</div>
</div>
<a id="a79935ecbe94f2a41e0106d011edafac4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79935ecbe94f2a41e0106d011edafac4">&#9670;&nbsp;</a></span>secureConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClient::secureConnection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initiate a secure connection (pair/bond) with the server.<br />
Called automatically when a characteristic or descriptor requires encryption or authentication to access it. </p>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>
</div>
</div>
<a id="aeede4deef7421b9121387a786c07820c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeede4deef7421b9121387a786c07820c">&#9670;&nbsp;</a></span>setClientCallbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEClient::setClientCallbacks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a> *&#160;</td>
<td class="paramname"><em>pClientCallbacks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteCallbacks</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the callbacks that will be invoked when events are received. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClientCallbacks</td><td>A pointer to a class to receive the event callbacks. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">deleteCallbacks</td><td>If true this will delete the callback class sent when the client is destructed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17718339f76eb621db0d7919c73b9267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17718339f76eb621db0d7919c73b9267">&#9670;&nbsp;</a></span>setConnectionParams()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEClient::setConnectionParams </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>minInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>maxInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>latency</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>scanInterval</em> = <code>16</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>scanWindow</em> = <code>16</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the connection paramaters to use when connecting to a server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">minInterval</td><td>The minimum connection interval in 1.25ms units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maxInterval</td><td>The maximum connection interval in 1.25ms units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">latency</td><td>The number of packets allowed to skip (extends max interval). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>The timeout time in 10ms units before disconnecting. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">scanInterval</td><td>The scan interval to use when attempting to connect in 0.625ms units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">scanWindow</td><td>The scan window to use when attempting to connect in 0.625ms units. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4068b29a9bd12e3110465908864dd20e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4068b29a9bd12e3110465908864dd20e">&#9670;&nbsp;</a></span>setConnectTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEClient::setConnectTimeout </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the timeout to wait for connection attempt to complete. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>The number of seconds before timeout. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a93b5b7c01e58a95dcea335f837d81d07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93b5b7c01e58a95dcea335f837d81d07">&#9670;&nbsp;</a></span>setPeerAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEClient::setPeerAddress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the peer address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address of the peer that this client is connected or should connect to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0910bbe298a68e9122a169ab229bf767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0910bbe298a68e9122a169ab229bf767">&#9670;&nbsp;</a></span>setValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClient::setValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>serviceUUID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>characteristicUUID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>response</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of a specific characteristic associated with a specific service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">serviceUUID</td><td>The service that owns the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">characteristicUUID</td><td>The characteristic whose value we wish to write. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to write to the characteristic. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>If true, uses write with response operation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful otherwise false </dd></dl>
</div>
</div>
<a id="aba9ae035357776514b61c2b6286ce1ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba9ae035357776514b61c2b6286ce1ab">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEClient::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string representation of this client. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of this client. </dd></dl>
</div>
</div>
<a id="aff7d389ec48567286ea732c54d320526"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff7d389ec48567286ea732c54d320526">&#9670;&nbsp;</a></span>updateConnParams()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEClient::updateConnParams </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>minInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>maxInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>latency</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the connection parameters: </p>
<ul>
<li>Can only be used after a connection has been established. <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">minInterval</td><td>The minimum connection interval in 1.25ms units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maxInterval</td><td>The maximum connection interval in 1.25ms units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">latency</td><td>The number of packets allowed to skip (extends max interval). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>The timeout time in 10ms units before disconnecting. </td></tr>
</table>
</dd>
</dl>
</li>
</ul>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

31
class_nim_b_l_e_client.js Normal file
View File

@@ -0,0 +1,31 @@
var class_nim_b_l_e_client =
[
[ "begin", "class_nim_b_l_e_client.html#ab09639b499fdcd0021a2432b2b8203f5", null ],
[ "connect", "class_nim_b_l_e_client.html#a836438fc9d5c2001207249661ad10e01", null ],
[ "connect", "class_nim_b_l_e_client.html#a9188741bf29d58d5ff1352383c959b7b", null ],
[ "connect", "class_nim_b_l_e_client.html#aab311f0a8af21fb63f78e7fbac29951a", null ],
[ "deleteService", "class_nim_b_l_e_client.html#a0f940c51807469db1f1802b742180beb", null ],
[ "deleteServices", "class_nim_b_l_e_client.html#a668d476de250055a106a9f46bb7719f3", null ],
[ "disconnect", "class_nim_b_l_e_client.html#a5f77999664cc8a83f3cdb603ba4a5c8c", null ],
[ "discoverAttributes", "class_nim_b_l_e_client.html#a3d8cbf51caf8b3b8a0ec6ce2074ba71d", null ],
[ "end", "class_nim_b_l_e_client.html#a0accd665926ea77d85ecb483b2b853fe", null ],
[ "getCharacteristic", "class_nim_b_l_e_client.html#a2fc46f43a71dd0df63a377961baf8009", null ],
[ "getConnId", "class_nim_b_l_e_client.html#aa09466a7050bf08bab2390da66007896", null ],
[ "getConnInfo", "class_nim_b_l_e_client.html#a566207f548c6b799792fc092f1748267", null ],
[ "getMTU", "class_nim_b_l_e_client.html#ab971537eec4e53d621598eb1c760af3a", null ],
[ "getPeerAddress", "class_nim_b_l_e_client.html#a0477ba593f0b7c0cfc4697efdba703eb", null ],
[ "getRssi", "class_nim_b_l_e_client.html#ae216993cf4eeb5780a104a8b14044f78", null ],
[ "getService", "class_nim_b_l_e_client.html#ae22379ab10bd82932d2303fb3753c366", null ],
[ "getService", "class_nim_b_l_e_client.html#ad8ba10522d79af1136019606802f0978", null ],
[ "getServices", "class_nim_b_l_e_client.html#acb9007569b3bb13b3b49f3c4cb47b21a", null ],
[ "getValue", "class_nim_b_l_e_client.html#afd7b5c40f3c190a542f25b0b9e4afaf3", null ],
[ "isConnected", "class_nim_b_l_e_client.html#af1603da59b829f75b162ac4a65ce181c", null ],
[ "secureConnection", "class_nim_b_l_e_client.html#a79935ecbe94f2a41e0106d011edafac4", null ],
[ "setClientCallbacks", "class_nim_b_l_e_client.html#aeede4deef7421b9121387a786c07820c", null ],
[ "setConnectionParams", "class_nim_b_l_e_client.html#a17718339f76eb621db0d7919c73b9267", null ],
[ "setConnectTimeout", "class_nim_b_l_e_client.html#a4068b29a9bd12e3110465908864dd20e", null ],
[ "setPeerAddress", "class_nim_b_l_e_client.html#a93b5b7c01e58a95dcea335f837d81d07", null ],
[ "setValue", "class_nim_b_l_e_client.html#a0910bbe298a68e9122a169ab229bf767", null ],
[ "toString", "class_nim_b_l_e_client.html#aba9ae035357776514b61c2b6286ce1ab", null ],
[ "updateConnParams", "class_nim_b_l_e_client.html#aff7d389ec48567286ea732c54d320526", null ]
];

View File

@@ -0,0 +1,107 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_client_callbacks.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">NimBLEClientCallbacks Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a40fb2013fc4ebe51f770699377922065">onAuthenticationComplete</a>(ble_gap_conn_desc *desc)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html#ace39ee838319e415bd0fc5c72a653ff0">onConfirmPIN</a>(uint32_t pin)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae">onConnect</a>(NimBLEClient *pClient)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6">onConnParamsUpdateRequest</a>(NimBLEClient *pClient, const ble_gap_upd_params *params)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a3e5571e4d5ee53c5c4b25ceaac66b808">onDisconnect</a>(NimBLEClient *pClient)</td><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a9850764aec546747537c6baa2a4622f5">onPassKeyRequest</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,342 @@
<!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: NimBLEClientCallbacks Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_client_callbacks.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_client_callbacks-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEClientCallbacks Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Callbacks associated with a BLE client.
<a href="class_nim_b_l_e_client_callbacks.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a96de53d9745f243d544cd89498f979ae"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae">onConnect</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient)</td></tr>
<tr class="memdesc:a96de53d9745f243d544cd89498f979ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after client connects. <a href="class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae">More...</a><br /></td></tr>
<tr class="separator:a96de53d9745f243d544cd89498f979ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5571e4d5ee53c5c4b25ceaac66b808"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a3e5571e4d5ee53c5c4b25ceaac66b808">onDisconnect</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient)</td></tr>
<tr class="memdesc:a3e5571e4d5ee53c5c4b25ceaac66b808"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when disconnected from the server. <a href="class_nim_b_l_e_client_callbacks.html#a3e5571e4d5ee53c5c4b25ceaac66b808">More...</a><br /></td></tr>
<tr class="separator:a3e5571e4d5ee53c5c4b25ceaac66b808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc6a072e1cc974ef084eb2cad18dac6"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6">onConnParamsUpdateRequest</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient, const ble_gap_upd_params *params)</td></tr>
<tr class="memdesc:a8bc6a072e1cc974ef084eb2cad18dac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when server requests to update the connection parameters. <a href="class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6">More...</a><br /></td></tr>
<tr class="separator:a8bc6a072e1cc974ef084eb2cad18dac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9850764aec546747537c6baa2a4622f5"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a9850764aec546747537c6baa2a4622f5">onPassKeyRequest</a> ()</td></tr>
<tr class="memdesc:a9850764aec546747537c6baa2a4622f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when server requests a passkey for pairing. <a href="class_nim_b_l_e_client_callbacks.html#a9850764aec546747537c6baa2a4622f5">More...</a><br /></td></tr>
<tr class="separator:a9850764aec546747537c6baa2a4622f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40fb2013fc4ebe51f770699377922065"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a40fb2013fc4ebe51f770699377922065">onAuthenticationComplete</a> (ble_gap_conn_desc *desc)</td></tr>
<tr class="memdesc:a40fb2013fc4ebe51f770699377922065"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the pairing procedure is complete. <a href="class_nim_b_l_e_client_callbacks.html#a40fb2013fc4ebe51f770699377922065">More...</a><br /></td></tr>
<tr class="separator:a40fb2013fc4ebe51f770699377922065"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace39ee838319e415bd0fc5c72a653ff0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#ace39ee838319e415bd0fc5c72a653ff0">onConfirmPIN</a> (uint32_t pin)</td></tr>
<tr class="memdesc:ace39ee838319e415bd0fc5c72a653ff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when using numeric comparision for pairing. <a href="class_nim_b_l_e_client_callbacks.html#ace39ee838319e415bd0fc5c72a653ff0">More...</a><br /></td></tr>
<tr class="separator:ace39ee838319e415bd0fc5c72a653ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Callbacks associated with a BLE client. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a40fb2013fc4ebe51f770699377922065"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40fb2013fc4ebe51f770699377922065">&#9670;&nbsp;</a></span>onAuthenticationComplete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onAuthenticationComplete </td>
<td>(</td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when the pairing procedure is complete. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>A pointer to the struct containing the connection information.<br />
This can be used to check the status of the connection encryption/pairing. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ace39ee838319e415bd0fc5c72a653ff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace39ee838319e415bd0fc5c72a653ff0">&#9670;&nbsp;</a></span>onConfirmPIN()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClientCallbacks::onConfirmPIN </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>pin</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when using numeric comparision for pairing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>The pin to compare with the server. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True to accept the pin. </dd></dl>
</div>
</div>
<a id="a96de53d9745f243d544cd89498f979ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96de53d9745f243d544cd89498f979ae">&#9670;&nbsp;</a></span>onConnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onConnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called after client connects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the calling client object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8bc6a072e1cc974ef084eb2cad18dac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bc6a072e1cc974ef084eb2cad18dac6">&#9670;&nbsp;</a></span>onConnParamsUpdateRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClientCallbacks::onConnParamsUpdateRequest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ble_gap_upd_params *&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when server requests to update the connection parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the calling client object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>A pointer to the struct containing the connection parameters requested. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True to accept the parmeters. </dd></dl>
</div>
</div>
<a id="a3e5571e4d5ee53c5c4b25ceaac66b808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e5571e4d5ee53c5c4b25ceaac66b808">&#9670;&nbsp;</a></span>onDisconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onDisconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when disconnected from the server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the calling client object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9850764aec546747537c6baa2a4622f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9850764aec546747537c6baa2a4622f5">&#9670;&nbsp;</a></span>onPassKeyRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t NimBLEClientCallbacks::onPassKeyRequest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when server requests a passkey for pairing. </p>
<dl class="section return"><dt>Returns</dt><dd>The passkey to be sent to the server. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_client_callbacks.html">NimBLEClientCallbacks</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,9 @@
var class_nim_b_l_e_client_callbacks =
[
[ "onAuthenticationComplete", "class_nim_b_l_e_client_callbacks.html#a40fb2013fc4ebe51f770699377922065", null ],
[ "onConfirmPIN", "class_nim_b_l_e_client_callbacks.html#ace39ee838319e415bd0fc5c72a653ff0", null ],
[ "onConnect", "class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae", null ],
[ "onConnParamsUpdateRequest", "class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6", null ],
[ "onDisconnect", "class_nim_b_l_e_client_callbacks.html#a3e5571e4d5ee53c5c4b25ceaac66b808", null ],
[ "onPassKeyRequest", "class_nim_b_l_e_client_callbacks.html#a9850764aec546747537c6baa2a4622f5", null ]
];

View File

@@ -0,0 +1,114 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_conn_info.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">NimBLEConnInfo Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847">getAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4">getConnHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049">getConnInterval</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430">getConnLatency</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082">getConnTimeout</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a">getIdAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462">getMTU</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782">getSecKeySize</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89">isAuthenticated</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125">isBonded</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744">isEncrypted</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4">isMaster</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af">isSlave</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,163 @@
<!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: NimBLEConnInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_conn_info.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_conn_info-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEConnInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Connection information.
<a href="class_nim_b_l_e_conn_info.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af17023ca06c3d1b9e142dcd5f8c54847"><td class="memItemLeft" align="right" valign="top"><a id="af17023ca06c3d1b9e142dcd5f8c54847"></a>
<a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847">getAddress</a> ()</td></tr>
<tr class="memdesc:af17023ca06c3d1b9e142dcd5f8c54847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the over-the-air address of the connected peer. <br /></td></tr>
<tr class="separator:af17023ca06c3d1b9e142dcd5f8c54847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bc23f09eb7dd53be902cb67d2ba745a"><td class="memItemLeft" align="right" valign="top"><a id="a7bc23f09eb7dd53be902cb67d2ba745a"></a>
<a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a">getIdAddress</a> ()</td></tr>
<tr class="memdesc:a7bc23f09eb7dd53be902cb67d2ba745a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the ID address of the connected peer. <br /></td></tr>
<tr class="separator:a7bc23f09eb7dd53be902cb67d2ba745a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77e212f3e236b05da0978ea482e3efb4"><td class="memItemLeft" align="right" valign="top"><a id="a77e212f3e236b05da0978ea482e3efb4"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4">getConnHandle</a> ()</td></tr>
<tr class="memdesc:a77e212f3e236b05da0978ea482e3efb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the connection handle of the connected peer. <br /></td></tr>
<tr class="separator:a77e212f3e236b05da0978ea482e3efb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa43374d84b7564f6d187fd0c637b1049"><td class="memItemLeft" align="right" valign="top"><a id="aa43374d84b7564f6d187fd0c637b1049"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049">getConnInterval</a> ()</td></tr>
<tr class="memdesc:aa43374d84b7564f6d187fd0c637b1049"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the connection interval for this connection (in 1.25ms units) <br /></td></tr>
<tr class="separator:aa43374d84b7564f6d187fd0c637b1049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e885d340f1ab4e477c69ed7ea99b082"><td class="memItemLeft" align="right" valign="top"><a id="a8e885d340f1ab4e477c69ed7ea99b082"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082">getConnTimeout</a> ()</td></tr>
<tr class="memdesc:a8e885d340f1ab4e477c69ed7ea99b082"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the supervision timeout for this connection (in 10ms units) <br /></td></tr>
<tr class="separator:a8e885d340f1ab4e477c69ed7ea99b082"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10c6093ca2f92ea61b82815909106430"><td class="memItemLeft" align="right" valign="top"><a id="a10c6093ca2f92ea61b82815909106430"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430">getConnLatency</a> ()</td></tr>
<tr class="memdesc:a10c6093ca2f92ea61b82815909106430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the allowable latency for this connection (unit = number of intervals) <br /></td></tr>
<tr class="separator:a10c6093ca2f92ea61b82815909106430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94796b6446ef40c0ae0d1f8af1ff9462"><td class="memItemLeft" align="right" valign="top"><a id="a94796b6446ef40c0ae0d1f8af1ff9462"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462">getMTU</a> ()</td></tr>
<tr class="memdesc:a94796b6446ef40c0ae0d1f8af1ff9462"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the maximum transmission unit size for this connection (in bytes) <br /></td></tr>
<tr class="separator:a94796b6446ef40c0ae0d1f8af1ff9462"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63ff245a8848bf1cc5839adee7aa41c4"><td class="memItemLeft" align="right" valign="top"><a id="a63ff245a8848bf1cc5839adee7aa41c4"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4">isMaster</a> ()</td></tr>
<tr class="memdesc:a63ff245a8848bf1cc5839adee7aa41c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we are in the master role in this connection. <br /></td></tr>
<tr class="separator:a63ff245a8848bf1cc5839adee7aa41c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfb91b833cb200f795bc63d5affff6af"><td class="memItemLeft" align="right" valign="top"><a id="abfb91b833cb200f795bc63d5affff6af"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af">isSlave</a> ()</td></tr>
<tr class="memdesc:abfb91b833cb200f795bc63d5affff6af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we are in the slave role in this connection. <br /></td></tr>
<tr class="separator:abfb91b833cb200f795bc63d5affff6af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af281a25921d36dc75cf1e37561940125"><td class="memItemLeft" align="right" valign="top"><a id="af281a25921d36dc75cf1e37561940125"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125">isBonded</a> ()</td></tr>
<tr class="memdesc:af281a25921d36dc75cf1e37561940125"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we are connected to a bonded peer. <br /></td></tr>
<tr class="separator:af281a25921d36dc75cf1e37561940125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ecf3c58da6ffb529215ce6f13c96744"><td class="memItemLeft" align="right" valign="top"><a id="a8ecf3c58da6ffb529215ce6f13c96744"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744">isEncrypted</a> ()</td></tr>
<tr class="memdesc:a8ecf3c58da6ffb529215ce6f13c96744"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the connection in encrypted. <br /></td></tr>
<tr class="separator:a8ecf3c58da6ffb529215ce6f13c96744"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7229e53d21c9c6b5b9fb5bd232862c89"><td class="memItemLeft" align="right" valign="top"><a id="a7229e53d21c9c6b5b9fb5bd232862c89"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89">isAuthenticated</a> ()</td></tr>
<tr class="memdesc:a7229e53d21c9c6b5b9fb5bd232862c89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the the connection has been authenticated. <br /></td></tr>
<tr class="separator:a7229e53d21c9c6b5b9fb5bd232862c89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a278a8456f9d7df9cea7d776e61b36782"><td class="memItemLeft" align="right" valign="top"><a id="a278a8456f9d7df9cea7d776e61b36782"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782">getSecKeySize</a> ()</td></tr>
<tr class="memdesc:a278a8456f9d7df9cea7d776e61b36782"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the key size used to encrypt the connection. <br /></td></tr>
<tr class="separator:a278a8456f9d7df9cea7d776e61b36782"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Connection information. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,16 @@
var class_nim_b_l_e_conn_info =
[
[ "getAddress", "class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847", null ],
[ "getConnHandle", "class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4", null ],
[ "getConnInterval", "class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049", null ],
[ "getConnLatency", "class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430", null ],
[ "getConnTimeout", "class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082", null ],
[ "getIdAddress", "class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a", null ],
[ "getMTU", "class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462", null ],
[ "getSecKeySize", "class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782", null ],
[ "isAuthenticated", "class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89", null ],
[ "isBonded", "class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125", null ],
[ "isEncrypted", "class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744", null ],
[ "isMaster", "class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4", null ],
[ "isSlave", "class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af", null ]
];

View File

@@ -0,0 +1,115 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_descriptor.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">NimBLEDescriptor Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">getCharacteristic</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">getHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">getLength</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">getStringValue</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">getValue</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor</a>(const char *uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a7ecb634b7d6390677cad232bd6be6638">NimBLEDescriptor</a>(NimBLEUUID uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic *pCharacteristic=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a>(NimBLEDescriptorCallbacks *pCallbacks)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a>(const uint8_t *data, size_t size)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51">setValue</a>(const std::string &amp;value)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">setValue</a>(const T &amp;s)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc">~NimBLEDescriptor</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,406 @@
<!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: NimBLEDescriptor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_descriptor.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_descriptor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEDescriptor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A model of a BLE descriptor.
<a href="class_nim_b_l_e_descriptor.html#details">More...</a></p>
<p>Inherited by <a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3cf995352eb1b1c212a7911a05c33b25"><td class="memItemLeft" align="right" valign="top"><a id="a3cf995352eb1b1c212a7911a05c33b25"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25">NimBLEDescriptor</a> (const char *uuid, uint16_t properties, uint16_t max_len, <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic=nullptr)</td></tr>
<tr class="memdesc:a3cf995352eb1b1c212a7911a05c33b25"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nim_b_l_e_descriptor.html" title="A model of a BLE descriptor.">NimBLEDescriptor</a> constructor. <br /></td></tr>
<tr class="separator:a3cf995352eb1b1c212a7911a05c33b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ecb634b7d6390677cad232bd6be6638"><td class="memItemLeft" align="right" valign="top"><a id="a7ecb634b7d6390677cad232bd6be6638"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a7ecb634b7d6390677cad232bd6be6638">NimBLEDescriptor</a> (<a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> uuid, uint16_t properties, uint16_t max_len, <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic=nullptr)</td></tr>
<tr class="memdesc:a7ecb634b7d6390677cad232bd6be6638"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nim_b_l_e_descriptor.html" title="A model of a BLE descriptor.">NimBLEDescriptor</a> constructor. <br /></td></tr>
<tr class="separator:a7ecb634b7d6390677cad232bd6be6638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad110851335bc7b225f5bea9ac11bedcc"><td class="memItemLeft" align="right" valign="top"><a id="ad110851335bc7b225f5bea9ac11bedcc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc">~NimBLEDescriptor</a> ()</td></tr>
<tr class="memdesc:ad110851335bc7b225f5bea9ac11bedcc"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nim_b_l_e_descriptor.html" title="A model of a BLE descriptor.">NimBLEDescriptor</a> destructor. <br /></td></tr>
<tr class="separator:ad110851335bc7b225f5bea9ac11bedcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a486af6799753dfa60b3faddfac2adbcd"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">getHandle</a> ()</td></tr>
<tr class="memdesc:a486af6799753dfa60b3faddfac2adbcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the BLE handle for this descriptor. <a href="class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd">More...</a><br /></td></tr>
<tr class="separator:a486af6799753dfa60b3faddfac2adbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc5398a570edc197fbadad3f5b45e186"><td class="memItemLeft" align="right" valign="top"><a id="abc5398a570edc197fbadad3f5b45e186"></a>
<a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186">getUUID</a> ()</td></tr>
<tr class="memdesc:abc5398a570edc197fbadad3f5b45e186"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID of the descriptor. <br /></td></tr>
<tr class="separator:abc5398a570edc197fbadad3f5b45e186"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac15dc6c9c24d280c4b0eb766080497e5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">toString</a> ()</td></tr>
<tr class="memdesc:ac15dc6c9c24d280c4b0eb766080497e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the descriptor. <a href="class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5">More...</a><br /></td></tr>
<tr class="separator:ac15dc6c9c24d280c4b0eb766080497e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9cb8727f9e17cf8050cf619e5fe3096"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a> (<a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> *pCallbacks)</td></tr>
<tr class="memdesc:aa9cb8727f9e17cf8050cf619e5fe3096"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the callback handlers for this descriptor. <a href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">More...</a><br /></td></tr>
<tr class="separator:aa9cb8727f9e17cf8050cf619e5fe3096"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a378346f59afb706d4c1d961227b98c5d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">getLength</a> ()</td></tr>
<tr class="memdesc:a378346f59afb706d4c1d961227b98c5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the length of the value of this descriptor. <a href="class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d">More...</a><br /></td></tr>
<tr class="separator:a378346f59afb706d4c1d961227b98c5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac54fd0830ceb64b91037b623dbc427b5"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">getValue</a> ()</td></tr>
<tr class="memdesc:ac54fd0830ceb64b91037b623dbc427b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of this descriptor. <a href="class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5">More...</a><br /></td></tr>
<tr class="separator:ac54fd0830ceb64b91037b623dbc427b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7153e051e5808469c23e2207fa6711db"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">getStringValue</a> ()</td></tr>
<tr class="memdesc:a7153e051e5808469c23e2207fa6711db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of this descriptor as a string. <a href="class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db">More...</a><br /></td></tr>
<tr class="separator:a7153e051e5808469c23e2207fa6711db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9447cee9092dc516266f7764131ba923"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">setValue</a> (const uint8_t *data, size_t size)</td></tr>
<tr class="memdesc:a9447cee9092dc516266f7764131ba923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the descriptor. <a href="class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923">More...</a><br /></td></tr>
<tr class="separator:a9447cee9092dc516266f7764131ba923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad14bda7d046b5f814ed599c8157c7e51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51">setValue</a> (const std::string &amp;value)</td></tr>
<tr class="memdesc:ad14bda7d046b5f814ed599c8157c7e51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the descriptor. <a href="class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51">More...</a><br /></td></tr>
<tr class="separator:ad14bda7d046b5f814ed599c8157c7e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a412b3735186d94e9ddcf37a06c2055e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">getCharacteristic</a> ()</td></tr>
<tr class="memdesc:a412b3735186d94e9ddcf37a06c2055e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the characteristic this descriptor belongs to. <a href="class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1">More...</a><br /></td></tr>
<tr class="separator:a412b3735186d94e9ddcf37a06c2055e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9136cc9e4b41110b3dd99d1c9553a477"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9136cc9e4b41110b3dd99d1c9553a477"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">setValue</a> (const T &amp;s)</td></tr>
<tr class="memdesc:a9136cc9e4b41110b3dd99d1c9553a477"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience template to set the descriptor value to &lt;type&gt;val. <a href="class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477">More...</a><br /></td></tr>
<tr class="separator:a9136cc9e4b41110b3dd99d1c9553a477"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of a BLE descriptor. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a412b3735186d94e9ddcf37a06c2055e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a412b3735186d94e9ddcf37a06c2055e1">&#9670;&nbsp;</a></span>getCharacteristic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> * NimBLEDescriptor::getCharacteristic </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the characteristic this descriptor belongs to. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the characteristic this descriptor belongs to. </dd></dl>
</div>
</div>
<a id="a486af6799753dfa60b3faddfac2adbcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a486af6799753dfa60b3faddfac2adbcd">&#9670;&nbsp;</a></span>getHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEDescriptor::getHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the BLE handle for this descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>The handle for this descriptor. </dd></dl>
</div>
</div>
<a id="a378346f59afb706d4c1d961227b98c5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a378346f59afb706d4c1d961227b98c5d">&#9670;&nbsp;</a></span>getLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t NimBLEDescriptor::getLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the length of the value of this descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>The length (in bytes) of the value of this descriptor. </dd></dl>
</div>
</div>
<a id="a7153e051e5808469c23e2207fa6711db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7153e051e5808469c23e2207fa6711db">&#9670;&nbsp;</a></span>getStringValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEDescriptor::getStringValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of this descriptor as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>A std::string instance containing a copy of the descriptor's value. </dd></dl>
</div>
</div>
<a id="ac54fd0830ceb64b91037b623dbc427b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac54fd0830ceb64b91037b623dbc427b5">&#9670;&nbsp;</a></span>getValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t * NimBLEDescriptor::getValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of this descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the value of this descriptor. </dd></dl>
</div>
</div>
<a id="aa9cb8727f9e17cf8050cf619e5fe3096"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9cb8727f9e17cf8050cf619e5fe3096">&#9670;&nbsp;</a></span>setCallbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEDescriptor::setCallbacks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> *&#160;</td>
<td class="paramname"><em>pCallbacks</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the callback handlers for this descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCallbacks</td><td>An instance of a callback structure used to define any callbacks for the descriptor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad14bda7d046b5f814ed599c8157c7e51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad14bda7d046b5f814ed599c8157c7e51">&#9670;&nbsp;</a></span>setValue() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEDescriptor::setValue </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of the descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value of the descriptor in string form. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9136cc9e4b41110b3dd99d1c9553a477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9136cc9e4b41110b3dd99d1c9553a477">&#9670;&nbsp;</a></span>setValue() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDescriptor::setValue </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience template to set the descriptor value to &lt;type&gt;val. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The value to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9447cee9092dc516266f7764131ba923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9447cee9092dc516266f7764131ba923">&#9670;&nbsp;</a></span>setValue() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEDescriptor::setValue </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of the descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to set for the descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac15dc6c9c24d280c4b0eb766080497e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac15dc6c9c24d280c4b0eb766080497e5">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEDescriptor::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string representation of the descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of the descriptor. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,17 @@
var class_nim_b_l_e_descriptor =
[
[ "NimBLEDescriptor", "class_nim_b_l_e_descriptor.html#a3cf995352eb1b1c212a7911a05c33b25", null ],
[ "NimBLEDescriptor", "class_nim_b_l_e_descriptor.html#a7ecb634b7d6390677cad232bd6be6638", null ],
[ "~NimBLEDescriptor", "class_nim_b_l_e_descriptor.html#ad110851335bc7b225f5bea9ac11bedcc", null ],
[ "getCharacteristic", "class_nim_b_l_e_descriptor.html#a412b3735186d94e9ddcf37a06c2055e1", null ],
[ "getHandle", "class_nim_b_l_e_descriptor.html#a486af6799753dfa60b3faddfac2adbcd", null ],
[ "getLength", "class_nim_b_l_e_descriptor.html#a378346f59afb706d4c1d961227b98c5d", null ],
[ "getStringValue", "class_nim_b_l_e_descriptor.html#a7153e051e5808469c23e2207fa6711db", null ],
[ "getUUID", "class_nim_b_l_e_descriptor.html#abc5398a570edc197fbadad3f5b45e186", null ],
[ "getValue", "class_nim_b_l_e_descriptor.html#ac54fd0830ceb64b91037b623dbc427b5", null ],
[ "setCallbacks", "class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096", null ],
[ "setValue", "class_nim_b_l_e_descriptor.html#ad14bda7d046b5f814ed599c8157c7e51", null ],
[ "setValue", "class_nim_b_l_e_descriptor.html#a9136cc9e4b41110b3dd99d1c9553a477", null ],
[ "setValue", "class_nim_b_l_e_descriptor.html#a9447cee9092dc516266f7764131ba923", null ],
[ "toString", "class_nim_b_l_e_descriptor.html#ac15dc6c9c24d280c4b0eb766080497e5", null ]
];

View File

@@ -0,0 +1,103 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_descriptor_callbacks.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">NimBLEDescriptorCallbacks Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html#a6b13d2a8447f50a089b869cea9fcdcbc">onRead</a>(NimBLEDescriptor *pDescriptor)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html#a7081bf2c4f22225c4715e09762be40ed">onWrite</a>(NimBLEDescriptor *pDescriptor)</td><td class="entry"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,187 @@
<!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: NimBLEDescriptorCallbacks Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_descriptor_callbacks.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_descriptor_callbacks-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEDescriptorCallbacks Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Callbacks that can be associated with a BLE descriptors to inform of events.
<a href="class_nim_b_l_e_descriptor_callbacks.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6b13d2a8447f50a089b869cea9fcdcbc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html#a6b13d2a8447f50a089b869cea9fcdcbc">onRead</a> (<a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *pDescriptor)</td></tr>
<tr class="memdesc:a6b13d2a8447f50a089b869cea9fcdcbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a read request. <a href="class_nim_b_l_e_descriptor_callbacks.html#a6b13d2a8447f50a089b869cea9fcdcbc">More...</a><br /></td></tr>
<tr class="separator:a6b13d2a8447f50a089b869cea9fcdcbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7081bf2c4f22225c4715e09762be40ed"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html#a7081bf2c4f22225c4715e09762be40ed">onWrite</a> (<a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *pDescriptor)</td></tr>
<tr class="memdesc:a7081bf2c4f22225c4715e09762be40ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to support a write request. <a href="class_nim_b_l_e_descriptor_callbacks.html#a7081bf2c4f22225c4715e09762be40ed">More...</a><br /></td></tr>
<tr class="separator:a7081bf2c4f22225c4715e09762be40ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Callbacks that can be associated with a BLE descriptors to inform of events. </p>
<p>When a server application creates a BLE descriptor, we may wish to be informed when there is either a read or write request to the descriptors value. An application can register a sub-classed instance of this class and will be notified when such an event happens. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6b13d2a8447f50a089b869cea9fcdcbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b13d2a8447f50a089b869cea9fcdcbc">&#9670;&nbsp;</a></span>onRead()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDescriptorCallbacks::onRead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td>
<td class="paramname"><em>pDescriptor</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a read request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pDescriptor</td><td>The descriptor that is the source of the event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7081bf2c4f22225c4715e09762be40ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7081bf2c4f22225c4715e09762be40ed">&#9670;&nbsp;</a></span>onWrite()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEDescriptorCallbacks::onWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> *&#160;</td>
<td class="paramname"><em>pDescriptor</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function to support a write request. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pDescriptor</td><td>The descriptor that is the source of the event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,5 @@
var class_nim_b_l_e_descriptor_callbacks =
[
[ "onRead", "class_nim_b_l_e_descriptor_callbacks.html#a6b13d2a8447f50a089b869cea9fcdcbc", null ],
[ "onWrite", "class_nim_b_l_e_descriptor_callbacks.html#a7081bf2c4f22225c4715e09762be40ed", null ]
];

View File

@@ -0,0 +1,149 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_device.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">NimBLEDevice Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a732425c5c5f5b5b4730c1689700346c0">addIgnored</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#af8142995252f486916dbb9de2a5b0c9e">createClient</a>(NimBLEAddress peerAddress=NimBLEAddress(&quot;&quot;))</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a4d9780d0b5fafc279483822af802a508">createServer</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ae95693ce0f5b8e784ea8e10834dd624c">deinit</a>(bool clearAll=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ab436502ecd044f8b3480ec3e824e1418">deleteAllBonds</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a20fc979ec9dbad5cce7f73e41b2e422e">deleteBond</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a83aa0a3d9d57358d35082a442edf8549">deleteClient</a>(NimBLEClient *pClient)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a77f9f343143d4f074ffb545dd14cbb2b">getAddress</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#aa994b01b2b5bb9f677f3cffb2f05d140">getAdvertising</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ac7f090f4b1a2d593f38b20859e071f0c">getBondedAddress</a>(int index)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ac7adcd510eef2b9546bcde9a253e56a9">getClientByID</a>(uint16_t conn_id)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ac4dbadc7fc170993e41532f675786504">getClientByPeerAddress</a>(const NimBLEAddress &amp;peer_addr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a1a6fb5e8f0e2cdc012ebae4fb4d12fd0">getClientList</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#abe21dcac43493689a06bc6ddb91b6faf">getClientListSize</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a10aec48b56ef404f42ade96d6244b312">getDisconnectedClient</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ad6eda512195c7cbe249a1edbb99510cd">getInitialized</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a5520cf3f544d571636eed162de394ec2">getMTU</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a7fe0f568c17130150660e6307851be48">getNumBonds</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a34b50f12dc40ed47bdbb2b5ce4387a8c">getPower</a>(esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#af93d92316454b051125460056368baec">getScan</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#aa03937eadda020643b536c5d08174d3a">getSecurityPasskey</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a41d4cc7c85cba0721c6649b001b31b4d">getServer</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a4a2229e9e517b84773e65c75124b0789">getWhiteListAddress</a>(size_t index)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ab28cc2ec59fc9e62d05826633f53d2a0">getWhiteListCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a674d2e68d4ba0e3f84d7993f9da7d15b">init</a>(const std::string &amp;deviceName)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a16bf4f5394735ed8d7f0bb32ca5d269a">isBonded</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a14ebc6070a261d7a6518ad435b673962">isIgnored</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ae51e2d4d6169a61133178a1b0d6b5b45">onWhiteList</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a0374ab8e323277bd8498609559966924">removeIgnored</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a8d4e1013815e7b021029f447f1702833">setCustomGapHandler</a>(gap_event_handler handler)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a7d8203040611e3f82bf4848a9b371e98">setMTU</a>(uint16_t mtu)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#aa95f75d0a4325335ed0165f566d3a27d">setOwnAddrType</a>(uint8_t own_addr_type, bool useNRPA=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ac81f123fc1345596eb147c4fad125b1c">setPower</a>(esp_power_level_t powerLevel, esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a9fdc368b81152a55599e2041181cef08">setScanDuplicateCacheSize</a>(uint16_t cacheSize)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#aba7ad0c41541428243d5c5e94b512c93">setScanFilterMode</a>(uint8_t type)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#aa8e340c02418771ce72dec758d560938">setSecurityAuth</a>(bool bonding, bool mitm, bool sc)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a2f10da171794581870d678fc947a5d1f">setSecurityAuth</a>(uint8_t auth_req)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a7d44bb960c0bb1bec02a33369c693085">setSecurityCallbacks</a>(NimBLESecurityCallbacks *pCallbacks)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a92d36c3a34d9474fa1d7f66c0e477d1e">setSecurityInitKey</a>(uint8_t init_key)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ab9fee9e810d5fa18bc8a37053eb9b5d0">setSecurityIOCap</a>(uint8_t iocap)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a84631f6d657fb6bd39722560fa229d35">setSecurityPasskey</a>(uint32_t pin)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a57f0d4db1cc564176b23e860fce13f6a">setSecurityRespKey</a>(uint8_t init_key)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#ad0bc1019facfd79291b5353ff970473d">startAdvertising</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a339157bf3d8fc712fa838e9a5127cc62">startSecurity</a>(uint16_t conn_id)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a8b23c6ade03a69048f0568eb9ad3b034">stopAdvertising</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#abf8c494b54d9f0c9466c80f25dbdd961">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#aabc68166b6dd4a744a98f94e569f37db">whiteListAdd</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_device.html#a81abbad5e371fe1cdd91c002b42cc654">whiteListRemove</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_device.html">NimBLEDevice</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

1824
class_nim_b_l_e_device.html Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,117 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_eddystone_t_l_m.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">NimBLEEddystoneTLM Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">getCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">getData</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">getTemp</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">getTime</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">getVersion</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">getVolt</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a4d87d0b11420af2ae04bc4e6ce2f8607">NimBLEEddystoneTLM</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">setCount</a>(uint32_t advCount)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">setData</a>(const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">setTemp</a>(float temp)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">setTime</a>(uint32_t tmil)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">setUUID</a>(const NimBLEUUID &amp;l_uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">setVersion</a>(uint8_t version)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206">setVolt</a>(uint16_t volt)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,506 @@
<!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: NimBLEEddystoneTLM Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_eddystone_t_l_m.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_eddystone_t_l_m-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEEddystoneTLM Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Representation of a beacon. See:
<a href="class_nim_b_l_e_eddystone_t_l_m.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4d87d0b11420af2ae04bc4e6ce2f8607"><td class="memItemLeft" align="right" valign="top"><a id="a4d87d0b11420af2ae04bc4e6ce2f8607"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a4d87d0b11420af2ae04bc4e6ce2f8607">NimBLEEddystoneTLM</a> ()</td></tr>
<tr class="memdesc:a4d87d0b11420af2ae04bc4e6ce2f8607"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a default EddystoneTLM beacon object. <br /></td></tr>
<tr class="separator:a4d87d0b11420af2ae04bc4e6ce2f8607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae146a8f066ef3fc6994070654ec5d7ea"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">getData</a> ()</td></tr>
<tr class="memdesc:ae146a8f066ef3fc6994070654ec5d7ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the data that is being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea">More...</a><br /></td></tr>
<tr class="separator:ae146a8f066ef3fc6994070654ec5d7ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa511375f22952c0f5846a51e6c2511c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">getUUID</a> ()</td></tr>
<tr class="memdesc:aa511375f22952c0f5846a51e6c2511c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5">More...</a><br /></td></tr>
<tr class="separator:aa511375f22952c0f5846a51e6c2511c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9f17d2c1e4150775881babb73f0b10c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">getVersion</a> ()</td></tr>
<tr class="memdesc:ae9f17d2c1e4150775881babb73f0b10c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c">More...</a><br /></td></tr>
<tr class="separator:ae9f17d2c1e4150775881babb73f0b10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9862f983df6f48a96220e936d13d17b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">getVolt</a> ()</td></tr>
<tr class="memdesc:af9862f983df6f48a96220e936d13d17b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the battery voltage. <a href="class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b">More...</a><br /></td></tr>
<tr class="separator:af9862f983df6f48a96220e936d13d17b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abda56940f7d9f7ccef2629b75880dd5f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">getTemp</a> ()</td></tr>
<tr class="memdesc:abda56940f7d9f7ccef2629b75880dd5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the temperature being advertised. <a href="class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f">More...</a><br /></td></tr>
<tr class="separator:abda56940f7d9f7ccef2629b75880dd5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a556a6b6a75693997390f3bacf6e5ca5e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">getCount</a> ()</td></tr>
<tr class="memdesc:a556a6b6a75693997390f3bacf6e5ca5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the count of advertisments sent. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e">More...</a><br /></td></tr>
<tr class="separator:a556a6b6a75693997390f3bacf6e5ca5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">getTime</a> ()</td></tr>
<tr class="memdesc:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the advertisment time. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3">More...</a><br /></td></tr>
<tr class="separator:ab1c4a13c2f57a6e0293810dd09be3db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a970ba10424567d17c961ed3b3ef83d8e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">toString</a> ()</td></tr>
<tr class="memdesc:a970ba10424567d17c961ed3b3ef83d8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string representation of the beacon. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e">More...</a><br /></td></tr>
<tr class="separator:a970ba10424567d17c961ed3b3ef83d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a160e33218dc7fb33f678cda1605da52e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">setData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:a160e33218dc7fb33f678cda1605da52e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the raw data for the beacon advertisment. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e">More...</a><br /></td></tr>
<tr class="separator:a160e33218dc7fb33f678cda1605da52e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">setUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;l_uuid)</td></tr>
<tr class="memdesc:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the UUID to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291">More...</a><br /></td></tr>
<tr class="separator:a49fdfb7c2edf2ae92f69856ec0ce4291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a205e0e2efc09c4c5043f11aeddee4d63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">setVersion</a> (uint8_t version)</td></tr>
<tr class="memdesc:a205e0e2efc09c4c5043f11aeddee4d63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the version to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63">More...</a><br /></td></tr>
<tr class="separator:a205e0e2efc09c4c5043f11aeddee4d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad69af8fe47502d922203916357f6c206"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206">setVolt</a> (uint16_t volt)</td></tr>
<tr class="memdesc:ad69af8fe47502d922203916357f6c206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the battery voltage to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206">More...</a><br /></td></tr>
<tr class="separator:ad69af8fe47502d922203916357f6c206"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e8ee8fff10730089a370f9da7b6a691"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">setTemp</a> (float temp)</td></tr>
<tr class="memdesc:a8e8ee8fff10730089a370f9da7b6a691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the temperature to advertise. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691">More...</a><br /></td></tr>
<tr class="separator:a8e8ee8fff10730089a370f9da7b6a691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d033c09a513b2dfdad6f1b962b906a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">setCount</a> (uint32_t advCount)</td></tr>
<tr class="memdesc:a6d033c09a513b2dfdad6f1b962b906a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisment count. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8">More...</a><br /></td></tr>
<tr class="separator:a6d033c09a513b2dfdad6f1b962b906a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a999d53f4bad59c2ebc688403f66474b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">setTime</a> (uint32_t tmil)</td></tr>
<tr class="memdesc:a999d53f4bad59c2ebc688403f66474b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the advertisment time. <a href="class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1">More...</a><br /></td></tr>
<tr class="separator:a999d53f4bad59c2ebc688403f66474b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of a beacon. See: </p>
<ul>
<li><a href="https://github.com/google/eddystone">https://github.com/google/eddystone</a> </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a556a6b6a75693997390f3bacf6e5ca5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a556a6b6a75693997390f3bacf6e5ca5e">&#9670;&nbsp;</a></span>getCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t NimBLEEddystoneTLM::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the count of advertisments sent. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of advertisments. </dd></dl>
</div>
</div>
<a id="ae146a8f066ef3fc6994070654ec5d7ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae146a8f066ef3fc6994070654ec5d7ea">&#9670;&nbsp;</a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneTLM::getData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the data that is being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The advertised data. </dd></dl>
</div>
</div>
<a id="abda56940f7d9f7ccef2629b75880dd5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abda56940f7d9f7ccef2629b75880dd5f">&#9670;&nbsp;</a></span>getTemp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float NimBLEEddystoneTLM::getTemp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the temperature being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The temperature value. </dd></dl>
</div>
</div>
<a id="ab1c4a13c2f57a6e0293810dd09be3db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1c4a13c2f57a6e0293810dd09be3db3">&#9670;&nbsp;</a></span>getTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t NimBLEEddystoneTLM::getTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the advertisment time. </p>
<dl class="section return"><dt>Returns</dt><dd>The advertisment time. </dd></dl>
</div>
</div>
<a id="aa511375f22952c0f5846a51e6c2511c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa511375f22952c0f5846a51e6c2511c5">&#9670;&nbsp;</a></span>getUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLEEddystoneTLM::getUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the UUID being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The UUID advertised. </dd></dl>
</div>
</div>
<a id="ae9f17d2c1e4150775881babb73f0b10c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9f17d2c1e4150775881babb73f0b10c">&#9670;&nbsp;</a></span>getVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t NimBLEEddystoneTLM::getVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The version number. </dd></dl>
</div>
</div>
<a id="af9862f983df6f48a96220e936d13d17b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9862f983df6f48a96220e936d13d17b">&#9670;&nbsp;</a></span>getVolt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLEEddystoneTLM::getVolt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the battery voltage. </p>
<dl class="section return"><dt>Returns</dt><dd>The battery voltage. </dd></dl>
</div>
</div>
<a id="a6d033c09a513b2dfdad6f1b962b906a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d033c09a513b2dfdad6f1b962b906a8">&#9670;&nbsp;</a></span>setCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setCount </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>advCount</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertisment count. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advCount</td><td>The advertisment number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a160e33218dc7fb33f678cda1605da52e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a160e33218dc7fb33f678cda1605da52e">&#9670;&nbsp;</a></span>setData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the raw data for the beacon advertisment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The raw data to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8e8ee8fff10730089a370f9da7b6a691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e8ee8fff10730089a370f9da7b6a691">&#9670;&nbsp;</a></span>setTemp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setTemp </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>temp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the temperature to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">temp</td><td>The temperature value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a999d53f4bad59c2ebc688403f66474b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a999d53f4bad59c2ebc688403f66474b1">&#9670;&nbsp;</a></span>setTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setTime </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>tmil</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the advertisment time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">tmil</td><td>The advertisment time in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a49fdfb7c2edf2ae92f69856ec0ce4291"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49fdfb7c2edf2ae92f69856ec0ce4291">&#9670;&nbsp;</a></span>setUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>l_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the UUID to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">l_uuid</td><td>The UUID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a205e0e2efc09c4c5043f11aeddee4d63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a205e0e2efc09c4c5043f11aeddee4d63">&#9670;&nbsp;</a></span>setVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setVersion </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>version</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the version to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>The version number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad69af8fe47502d922203916357f6c206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad69af8fe47502d922203916357f6c206">&#9670;&nbsp;</a></span>setVolt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneTLM::setVolt </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>volt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the battery voltage to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">volt</td><td>The voltage in millivolts. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a970ba10424567d17c961ed3b3ef83d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a970ba10424567d17c961ed3b3ef83d8e">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneTLM::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a string representation of the beacon. </p>
<dl class="section return"><dt>Returns</dt><dd>The string representation. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html">NimBLEEddystoneTLM</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,19 @@
var class_nim_b_l_e_eddystone_t_l_m =
[
[ "NimBLEEddystoneTLM", "class_nim_b_l_e_eddystone_t_l_m.html#a4d87d0b11420af2ae04bc4e6ce2f8607", null ],
[ "getCount", "class_nim_b_l_e_eddystone_t_l_m.html#a556a6b6a75693997390f3bacf6e5ca5e", null ],
[ "getData", "class_nim_b_l_e_eddystone_t_l_m.html#ae146a8f066ef3fc6994070654ec5d7ea", null ],
[ "getTemp", "class_nim_b_l_e_eddystone_t_l_m.html#abda56940f7d9f7ccef2629b75880dd5f", null ],
[ "getTime", "class_nim_b_l_e_eddystone_t_l_m.html#ab1c4a13c2f57a6e0293810dd09be3db3", null ],
[ "getUUID", "class_nim_b_l_e_eddystone_t_l_m.html#aa511375f22952c0f5846a51e6c2511c5", null ],
[ "getVersion", "class_nim_b_l_e_eddystone_t_l_m.html#ae9f17d2c1e4150775881babb73f0b10c", null ],
[ "getVolt", "class_nim_b_l_e_eddystone_t_l_m.html#af9862f983df6f48a96220e936d13d17b", null ],
[ "setCount", "class_nim_b_l_e_eddystone_t_l_m.html#a6d033c09a513b2dfdad6f1b962b906a8", null ],
[ "setData", "class_nim_b_l_e_eddystone_t_l_m.html#a160e33218dc7fb33f678cda1605da52e", null ],
[ "setTemp", "class_nim_b_l_e_eddystone_t_l_m.html#a8e8ee8fff10730089a370f9da7b6a691", null ],
[ "setTime", "class_nim_b_l_e_eddystone_t_l_m.html#a999d53f4bad59c2ebc688403f66474b1", null ],
[ "setUUID", "class_nim_b_l_e_eddystone_t_l_m.html#a49fdfb7c2edf2ae92f69856ec0ce4291", null ],
[ "setVersion", "class_nim_b_l_e_eddystone_t_l_m.html#a205e0e2efc09c4c5043f11aeddee4d63", null ],
[ "setVolt", "class_nim_b_l_e_eddystone_t_l_m.html#ad69af8fe47502d922203916357f6c206", null ],
[ "toString", "class_nim_b_l_e_eddystone_t_l_m.html#a970ba10424567d17c961ed3b3ef83d8e", null ]
];

View File

@@ -0,0 +1,111 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_eddystone_u_r_l.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">NimBLEEddystoneURL Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">getData</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">getDecodedURL</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">getPower</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">getURL</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ae102214d20e32e31c9c84d723f67df15">NimBLEEddystoneURL</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">setData</a>(const std::string &amp;data)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">setPower</a>(int8_t advertisedTxPower)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">setURL</a>(const std::string &amp;url)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">setUUID</a>(const NimBLEUUID &amp;l_uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,350 @@
<!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: NimBLEEddystoneURL Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_eddystone_u_r_l.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_eddystone_u_r_l-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEEddystoneURL Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Representation of a beacon. See:
<a href="class_nim_b_l_e_eddystone_u_r_l.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae102214d20e32e31c9c84d723f67df15"><td class="memItemLeft" align="right" valign="top"><a id="ae102214d20e32e31c9c84d723f67df15"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ae102214d20e32e31c9c84d723f67df15">NimBLEEddystoneURL</a> ()</td></tr>
<tr class="memdesc:ae102214d20e32e31c9c84d723f67df15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a default EddystoneURL beacon object. <br /></td></tr>
<tr class="separator:ae102214d20e32e31c9c84d723f67df15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac32c7066ce1ee8d495a35ec870f0e7bf"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">getData</a> ()</td></tr>
<tr class="memdesc:ac32c7066ce1ee8d495a35ec870f0e7bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the data that is being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf">More...</a><br /></td></tr>
<tr class="separator:ac32c7066ce1ee8d495a35ec870f0e7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fde0fcf7d90f79e0eb718967518247a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">getUUID</a> ()</td></tr>
<tr class="memdesc:a1fde0fcf7d90f79e0eb718967518247a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a">More...</a><br /></td></tr>
<tr class="separator:a1fde0fcf7d90f79e0eb718967518247a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42583c740bbdb9591422e8770f8bd0d5"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">getPower</a> ()</td></tr>
<tr class="memdesc:a42583c740bbdb9591422e8770f8bd0d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the transmit power being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5">More...</a><br /></td></tr>
<tr class="separator:a42583c740bbdb9591422e8770f8bd0d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0109874399f3e70a72ee9f4a909710e1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">getURL</a> ()</td></tr>
<tr class="memdesc:a0109874399f3e70a72ee9f4a909710e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the raw URL being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1">More...</a><br /></td></tr>
<tr class="separator:a0109874399f3e70a72ee9f4a909710e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b68cc96a84da85e20d8583ba375c2ff"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">getDecodedURL</a> ()</td></tr>
<tr class="memdesc:a8b68cc96a84da85e20d8583ba375c2ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the full URL being advertised. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff">More...</a><br /></td></tr>
<tr class="separator:a8b68cc96a84da85e20d8583ba375c2ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada3ac4a544b8565635871f39f1593811"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">setData</a> (const std::string &amp;data)</td></tr>
<tr class="memdesc:ada3ac4a544b8565635871f39f1593811"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the raw data for the beacon advertisment. <a href="class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811">More...</a><br /></td></tr>
<tr class="separator:ada3ac4a544b8565635871f39f1593811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af183e8483ae81fff65d909e67986fcad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">setUUID</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;l_uuid)</td></tr>
<tr class="memdesc:af183e8483ae81fff65d909e67986fcad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the UUID to advertise. <a href="class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad">More...</a><br /></td></tr>
<tr class="separator:af183e8483ae81fff65d909e67986fcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8038c895e8da7c7ac861557ea0a9d91b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">setPower</a> (int8_t advertisedTxPower)</td></tr>
<tr class="memdesc:a8038c895e8da7c7ac861557ea0a9d91b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the transmit power to advertise. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b">More...</a><br /></td></tr>
<tr class="separator:a8038c895e8da7c7ac861557ea0a9d91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8102533ff1e7b6527ea744279f8f64ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">setURL</a> (const std::string &amp;url)</td></tr>
<tr class="memdesc:a8102533ff1e7b6527ea744279f8f64ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the URL to advertise. <a href="class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca">More...</a><br /></td></tr>
<tr class="separator:a8102533ff1e7b6527ea744279f8f64ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of a beacon. See: </p>
<ul>
<li><a href="https://github.com/google/eddystone">https://github.com/google/eddystone</a> </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac32c7066ce1ee8d495a35ec870f0e7bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac32c7066ce1ee8d495a35ec870f0e7bf">&#9670;&nbsp;</a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneURL::getData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the data that is being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The advertised data. </dd></dl>
</div>
</div>
<a id="a8b68cc96a84da85e20d8583ba375c2ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b68cc96a84da85e20d8583ba375c2ff">&#9670;&nbsp;</a></span>getDecodedURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneURL::getDecodedURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the full URL being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The full URL. </dd></dl>
</div>
</div>
<a id="a42583c740bbdb9591422e8770f8bd0d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42583c740bbdb9591422e8770f8bd0d5">&#9670;&nbsp;</a></span>getPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t NimBLEEddystoneURL::getPower </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the transmit power being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The transmit power. </dd></dl>
</div>
</div>
<a id="a0109874399f3e70a72ee9f4a909710e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0109874399f3e70a72ee9f4a909710e1">&#9670;&nbsp;</a></span>getURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLEEddystoneURL::getURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the raw URL being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The raw URL. </dd></dl>
</div>
</div>
<a id="a1fde0fcf7d90f79e0eb718967518247a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fde0fcf7d90f79e0eb718967518247a">&#9670;&nbsp;</a></span>getUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLEEddystoneURL::getUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the UUID being advertised. </p>
<dl class="section return"><dt>Returns</dt><dd>The UUID advertised. </dd></dl>
</div>
</div>
<a id="ada3ac4a544b8565635871f39f1593811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada3ac4a544b8565635871f39f1593811">&#9670;&nbsp;</a></span>setData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the raw data for the beacon advertisment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The raw data to advertise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8038c895e8da7c7ac861557ea0a9d91b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8038c895e8da7c7ac861557ea0a9d91b">&#9670;&nbsp;</a></span>setPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setPower </td>
<td>(</td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>advertisedTxPower</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the transmit power to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advertisedTxPower</td><td>The transmit power level. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8102533ff1e7b6527ea744279f8f64ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8102533ff1e7b6527ea744279f8f64ca">&#9670;&nbsp;</a></span>setURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setURL </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the URL to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>The URL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af183e8483ae81fff65d909e67986fcad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af183e8483ae81fff65d909e67986fcad">&#9670;&nbsp;</a></span>setUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEEddystoneURL::setUUID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>l_uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the UUID to advertise. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">l_uuid</td><td>The UUID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_eddystone_u_r_l.html">NimBLEEddystoneURL</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,13 @@
var class_nim_b_l_e_eddystone_u_r_l =
[
[ "NimBLEEddystoneURL", "class_nim_b_l_e_eddystone_u_r_l.html#ae102214d20e32e31c9c84d723f67df15", null ],
[ "getData", "class_nim_b_l_e_eddystone_u_r_l.html#ac32c7066ce1ee8d495a35ec870f0e7bf", null ],
[ "getDecodedURL", "class_nim_b_l_e_eddystone_u_r_l.html#a8b68cc96a84da85e20d8583ba375c2ff", null ],
[ "getPower", "class_nim_b_l_e_eddystone_u_r_l.html#a42583c740bbdb9591422e8770f8bd0d5", null ],
[ "getURL", "class_nim_b_l_e_eddystone_u_r_l.html#a0109874399f3e70a72ee9f4a909710e1", null ],
[ "getUUID", "class_nim_b_l_e_eddystone_u_r_l.html#a1fde0fcf7d90f79e0eb718967518247a", null ],
[ "setData", "class_nim_b_l_e_eddystone_u_r_l.html#ada3ac4a544b8565635871f39f1593811", null ],
[ "setPower", "class_nim_b_l_e_eddystone_u_r_l.html#a8038c895e8da7c7ac861557ea0a9d91b", null ],
[ "setURL", "class_nim_b_l_e_eddystone_u_r_l.html#a8102533ff1e7b6527ea744279f8f64ca", null ],
[ "setUUID", "class_nim_b_l_e_eddystone_u_r_l.html#af183e8483ae81fff65d909e67986fcad", null ]
];

View File

@@ -0,0 +1,119 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_h_i_d_device.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">NimBLEHIDDevice Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a24498f7b714574ab4a90288f7e4d58b7">batteryService</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a45ca7d4547dfea9a64987065d83653bd">bootInput</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ace0141db690f1afec1b266f9ac9aa0f0">bootOutput</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a033c4ad91f1bc165ac6a322b4dcc1699">deviceInfo</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">featureReport</a>(uint8_t reportID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5c42da43e0b8dfcd1d045e8a86d0b5a2">hidControl</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">hidInfo</a>(uint8_t country, uint8_t flags)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ae80cf58c481c25bd6d7392a43b6fa48b">hidService</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">inputReport</a>(uint8_t reportID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c">manufacturer</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ac04ed297cf6adbec210873739d2dc74d">manufacturer</a>(std::string name)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">NimBLEHIDDevice</a>(NimBLEServer *)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">outputReport</a>(uint8_t reportID)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">pnp</a>(uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a1118c1e730f38b8b17795c8eb41a0861">protocolMode</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">reportMap</a>(uint8_t *map, uint16_t)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">setBatteryLevel</a>(uint8_t level)</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5984042cd05ea4ead895f5577133a235">startServices</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,461 @@
<!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: NimBLEHIDDevice Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_h_i_d_device.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_h_i_d_device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEHIDDevice Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A model of a BLE Human Interface Device.
<a href="class_nim_b_l_e_h_i_d_device.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a95b4935280494ffa24bfae89753f199a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">NimBLEHIDDevice</a> (<a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *)</td></tr>
<tr class="memdesc:a95b4935280494ffa24bfae89753f199a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a default <a class="el" href="class_nim_b_l_e_h_i_d_device.html" title="A model of a BLE Human Interface Device.">NimBLEHIDDevice</a> object. <a href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">More...</a><br /></td></tr>
<tr class="separator:a95b4935280494ffa24bfae89753f199a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e996a1668785f7a978f9874b4ff3b3e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">reportMap</a> (uint8_t *map, uint16_t)</td></tr>
<tr class="memdesc:a5e996a1668785f7a978f9874b4ff3b3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the report map data formatting information. <a href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">More...</a><br /></td></tr>
<tr class="separator:a5e996a1668785f7a978f9874b4ff3b3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5984042cd05ea4ead895f5577133a235"><td class="memItemLeft" align="right" valign="top"><a id="a5984042cd05ea4ead895f5577133a235"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5984042cd05ea4ead895f5577133a235">startServices</a> ()</td></tr>
<tr class="memdesc:a5984042cd05ea4ead895f5577133a235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the HID device services.<br />
This function called when all the services have been created. <br /></td></tr>
<tr class="separator:a5984042cd05ea4ead895f5577133a235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a033c4ad91f1bc165ac6a322b4dcc1699"><td class="memItemLeft" align="right" valign="top"><a id="a033c4ad91f1bc165ac6a322b4dcc1699"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a033c4ad91f1bc165ac6a322b4dcc1699">deviceInfo</a> ()</td></tr>
<tr class="memdesc:a033c4ad91f1bc165ac6a322b4dcc1699"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the device information service. <br /></td></tr>
<tr class="separator:a033c4ad91f1bc165ac6a322b4dcc1699"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae80cf58c481c25bd6d7392a43b6fa48b"><td class="memItemLeft" align="right" valign="top"><a id="ae80cf58c481c25bd6d7392a43b6fa48b"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ae80cf58c481c25bd6d7392a43b6fa48b">hidService</a> ()</td></tr>
<tr class="memdesc:ae80cf58c481c25bd6d7392a43b6fa48b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the HID service. <br /></td></tr>
<tr class="separator:ae80cf58c481c25bd6d7392a43b6fa48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24498f7b714574ab4a90288f7e4d58b7"><td class="memItemLeft" align="right" valign="top"><a id="a24498f7b714574ab4a90288f7e4d58b7"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a24498f7b714574ab4a90288f7e4d58b7">batteryService</a> ()</td></tr>
<tr class="memdesc:a24498f7b714574ab4a90288f7e4d58b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the battery service. <br /></td></tr>
<tr class="separator:a24498f7b714574ab4a90288f7e4d58b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5b8291ca88d85a352429415abaec9c"><td class="memItemLeft" align="right" valign="top"><a id="a3e5b8291ca88d85a352429415abaec9c"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c">manufacturer</a> ()</td></tr>
<tr class="memdesc:a3e5b8291ca88d85a352429415abaec9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a manufacturer characteristic (this characteristic is optional). <br /></td></tr>
<tr class="separator:a3e5b8291ca88d85a352429415abaec9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac04ed297cf6adbec210873739d2dc74d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ac04ed297cf6adbec210873739d2dc74d">manufacturer</a> (std::string name)</td></tr>
<tr class="memdesc:ac04ed297cf6adbec210873739d2dc74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set manufacturer name. <a href="class_nim_b_l_e_h_i_d_device.html#ac04ed297cf6adbec210873739d2dc74d">More...</a><br /></td></tr>
<tr class="separator:ac04ed297cf6adbec210873739d2dc74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5309df317aa42de7ced2e34219b6666a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">pnp</a> (uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)</td></tr>
<tr class="memdesc:a5309df317aa42de7ced2e34219b6666a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Plug n Play characterisc value. <a href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">More...</a><br /></td></tr>
<tr class="separator:a5309df317aa42de7ced2e34219b6666a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fc2bfc990ecd250859ca8f34a4314e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">hidInfo</a> (uint8_t country, uint8_t flags)</td></tr>
<tr class="memdesc:a33fc2bfc990ecd250859ca8f34a4314e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the HID Information characteristic value. <a href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">More...</a><br /></td></tr>
<tr class="separator:a33fc2bfc990ecd250859ca8f34a4314e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84e3127a05f7e6a44761ec4a9e7668e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">setBatteryLevel</a> (uint8_t level)</td></tr>
<tr class="memdesc:a84e3127a05f7e6a44761ec4a9e7668e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the battery level characteristic value. <a href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">More...</a><br /></td></tr>
<tr class="separator:a84e3127a05f7e6a44761ec4a9e7668e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c42da43e0b8dfcd1d045e8a86d0b5a2"><td class="memItemLeft" align="right" valign="top"><a id="a5c42da43e0b8dfcd1d045e8a86d0b5a2"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5c42da43e0b8dfcd1d045e8a86d0b5a2">hidControl</a> ()</td></tr>
<tr class="memdesc:a5c42da43e0b8dfcd1d045e8a86d0b5a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the HID control point characteristic. <br /></td></tr>
<tr class="separator:a5c42da43e0b8dfcd1d045e8a86d0b5a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91cfe81b47cea229e9bbe3c55be33701"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">inputReport</a> (uint8_t reportID)</td></tr>
<tr class="memdesc:a91cfe81b47cea229e9bbe3c55be33701"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create input report characteristic. <a href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">More...</a><br /></td></tr>
<tr class="separator:a91cfe81b47cea229e9bbe3c55be33701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1e63972c6a77665a6bbc76f9ff4a717"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">outputReport</a> (uint8_t reportID)</td></tr>
<tr class="memdesc:ac1e63972c6a77665a6bbc76f9ff4a717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create output report characteristic. <a href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">More...</a><br /></td></tr>
<tr class="separator:ac1e63972c6a77665a6bbc76f9ff4a717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a468e599c7d75e691f8d34e1b24db8a38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">featureReport</a> (uint8_t reportID)</td></tr>
<tr class="memdesc:a468e599c7d75e691f8d34e1b24db8a38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create feature report characteristic. <a href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">More...</a><br /></td></tr>
<tr class="separator:a468e599c7d75e691f8d34e1b24db8a38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1118c1e730f38b8b17795c8eb41a0861"><td class="memItemLeft" align="right" valign="top"><a id="a1118c1e730f38b8b17795c8eb41a0861"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a1118c1e730f38b8b17795c8eb41a0861">protocolMode</a> ()</td></tr>
<tr class="memdesc:a1118c1e730f38b8b17795c8eb41a0861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the protocol mode characteristic. <br /></td></tr>
<tr class="separator:a1118c1e730f38b8b17795c8eb41a0861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45ca7d4547dfea9a64987065d83653bd"><td class="memItemLeft" align="right" valign="top"><a id="a45ca7d4547dfea9a64987065d83653bd"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a45ca7d4547dfea9a64987065d83653bd">bootInput</a> ()</td></tr>
<tr class="memdesc:a45ca7d4547dfea9a64987065d83653bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a keyboard boot input report characteristic. <br /></td></tr>
<tr class="separator:a45ca7d4547dfea9a64987065d83653bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace0141db690f1afec1b266f9ac9aa0f0"><td class="memItemLeft" align="right" valign="top"><a id="ace0141db690f1afec1b266f9ac9aa0f0"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ace0141db690f1afec1b266f9ac9aa0f0">bootOutput</a> ()</td></tr>
<tr class="memdesc:ace0141db690f1afec1b266f9ac9aa0f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a keyboard boot output report characteristic. <br /></td></tr>
<tr class="separator:ace0141db690f1afec1b266f9ac9aa0f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of a BLE Human Interface Device. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a95b4935280494ffa24bfae89753f199a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95b4935280494ffa24bfae89753f199a">&#9670;&nbsp;</a></span>NimBLEHIDDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLEHIDDevice::NimBLEHIDDevice </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *&#160;</td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a default <a class="el" href="class_nim_b_l_e_h_i_d_device.html" title="A model of a BLE Human Interface Device.">NimBLEHIDDevice</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">server</td><td>A pointer to the server instance this HID Device will use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a468e599c7d75e691f8d34e1b24db8a38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a468e599c7d75e691f8d34e1b24db8a38">&#9670;&nbsp;</a></span>featureReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> * NimBLEHIDDevice::featureReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create feature report characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">reportID</td><td>Feature report ID, the same as in report map for feature object related to the characteristic </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to new feature report characteristic </dd></dl>
</div>
</div>
<a id="a33fc2bfc990ecd250859ca8f34a4314e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33fc2bfc990ecd250859ca8f34a4314e">&#9670;&nbsp;</a></span>hidInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::hidInfo </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>country</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the HID Information characteristic value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">country</td><td>The country code for the device. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The HID Class Specification release number to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a91cfe81b47cea229e9bbe3c55be33701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91cfe81b47cea229e9bbe3c55be33701">&#9670;&nbsp;</a></span>inputReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> * NimBLEHIDDevice::inputReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create input report characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">reportID</td><td>input report ID, the same as in report map for input object related to the characteristic </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to new input report characteristic </dd></dl>
</div>
</div>
<a id="ac04ed297cf6adbec210873739d2dc74d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac04ed297cf6adbec210873739d2dc74d">&#9670;&nbsp;</a></span>manufacturer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::manufacturer </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set manufacturer name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The manufacturer name of this HID device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac1e63972c6a77665a6bbc76f9ff4a717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1e63972c6a77665a6bbc76f9ff4a717">&#9670;&nbsp;</a></span>outputReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> * NimBLEHIDDevice::outputReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create output report characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">reportID</td><td>Output report ID, the same as in report map for output object related to the characteristic </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to new output report characteristic </dd></dl>
</div>
</div>
<a id="a5309df317aa42de7ced2e34219b6666a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5309df317aa42de7ced2e34219b6666a">&#9670;&nbsp;</a></span>pnp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::pnp </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>sig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>vid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>pid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>version</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the Plug n Play characterisc value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sig</td><td>The vendor ID source number. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">vid</td><td>The vendor ID number. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>The product ID number. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>The produce version number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5e996a1668785f7a978f9874b4ff3b3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e996a1668785f7a978f9874b4ff3b3e">&#9670;&nbsp;</a></span>reportMap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::reportMap </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the report map data formatting information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">map</td><td>A pointer to an array with the values to set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The number of values in the array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a84e3127a05f7e6a44761ec4a9e7668e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84e3127a05f7e6a44761ec4a9e7668e3">&#9670;&nbsp;</a></span>setBatteryLevel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::setBatteryLevel </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>level</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the battery level characteristic value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The battery level value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_h_i_d_device.html">NimBLEHIDDevice</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,21 @@
var class_nim_b_l_e_h_i_d_device =
[
[ "NimBLEHIDDevice", "class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a", null ],
[ "batteryService", "class_nim_b_l_e_h_i_d_device.html#a24498f7b714574ab4a90288f7e4d58b7", null ],
[ "bootInput", "class_nim_b_l_e_h_i_d_device.html#a45ca7d4547dfea9a64987065d83653bd", null ],
[ "bootOutput", "class_nim_b_l_e_h_i_d_device.html#ace0141db690f1afec1b266f9ac9aa0f0", null ],
[ "deviceInfo", "class_nim_b_l_e_h_i_d_device.html#a033c4ad91f1bc165ac6a322b4dcc1699", null ],
[ "featureReport", "class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38", null ],
[ "hidControl", "class_nim_b_l_e_h_i_d_device.html#a5c42da43e0b8dfcd1d045e8a86d0b5a2", null ],
[ "hidInfo", "class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e", null ],
[ "hidService", "class_nim_b_l_e_h_i_d_device.html#ae80cf58c481c25bd6d7392a43b6fa48b", null ],
[ "inputReport", "class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701", null ],
[ "manufacturer", "class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c", null ],
[ "manufacturer", "class_nim_b_l_e_h_i_d_device.html#ac04ed297cf6adbec210873739d2dc74d", null ],
[ "outputReport", "class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717", null ],
[ "pnp", "class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a", null ],
[ "protocolMode", "class_nim_b_l_e_h_i_d_device.html#a1118c1e730f38b8b17795c8eb41a0861", null ],
[ "reportMap", "class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e", null ],
[ "setBatteryLevel", "class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3", null ],
[ "startServices", "class_nim_b_l_e_h_i_d_device.html#a5984042cd05ea4ead895f5577133a235", null ]
];

View File

@@ -0,0 +1,133 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_characteristic.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">NimBLERemoteCharacteristic Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442">begin</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7163009a9f0ff718b5856d19cb4a3568">canBroadcast</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a53322384b295a2548b3399e2c63d76f4">canIndicate</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a9c41acdbf23dc036f321d4f0a66d40d1">canNotify</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a0eb6655635394268a76c68e845d14135">canRead</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aae71c20d300ead52770e66fb8a1a47ea">canWrite</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a2614c7f437b52f385fc4fd29abe358eb">canWriteNoResponse</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aad0ba99cad9779b33ea7cd4e94349099">deleteDescriptor</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a5f0a51b4a7fb2244d236dcb96fcf5205">deleteDescriptors</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873">end</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380">getDefHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a6178e1c58361b957be3c48548c1c4366">getDescriptor</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#acf11d225fe5a25327742349e9d6061f9">getDescriptors</a>(bool refresh=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6">getHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a943183a55b020de9e09ac2cfaebcde32">getRemoteService</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">getValue</a>(time_t *timestamp=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b">getValue</a>(time_t *timestamp=nullptr, bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef">readFloat</a>() __attribute__((deprecated(&quot;Use template readValue&lt;float&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d">readUInt16</a>() __attribute__((deprecated(&quot;Use template readValue&lt;uint16_t&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d">readUInt32</a>() __attribute__((deprecated(&quot;Use template readValue&lt;uint32_t&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080">readUInt8</a>() __attribute__((deprecated(&quot;Use template readValue&lt;uint8_t&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a>(time_t *timestamp=nullptr)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0">readValue</a>(time_t *timestamp=nullptr, bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ab4f54eabe90a416546b7b3fc3477f49c">registerForNotify</a>(notify_callback notifyCallback, bool notifications=true, bool response=true) __attribute__((deprecated(&quot;Use subscribe()/unsubscribe()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">subscribe</a>(bool notifications=true, notify_callback notifyCallback=nullptr, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a">toString</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">unsubscribe</a>(bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(const uint8_t *data, size_t length, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a2cfc2e8d2e281dd61e578eb5e860fc02">writeValue</a>(const std::string &amp;newValue, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">writeValue</a>(const T &amp;s, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a855d591de111b09013ae83c4043d06ed">~NimBLERemoteCharacteristic</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,35 @@
var class_nim_b_l_e_remote_characteristic =
[
[ "~NimBLERemoteCharacteristic", "class_nim_b_l_e_remote_characteristic.html#a855d591de111b09013ae83c4043d06ed", null ],
[ "begin", "class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442", null ],
[ "canBroadcast", "class_nim_b_l_e_remote_characteristic.html#a7163009a9f0ff718b5856d19cb4a3568", null ],
[ "canIndicate", "class_nim_b_l_e_remote_characteristic.html#a53322384b295a2548b3399e2c63d76f4", null ],
[ "canNotify", "class_nim_b_l_e_remote_characteristic.html#a9c41acdbf23dc036f321d4f0a66d40d1", null ],
[ "canRead", "class_nim_b_l_e_remote_characteristic.html#a0eb6655635394268a76c68e845d14135", null ],
[ "canWrite", "class_nim_b_l_e_remote_characteristic.html#aae71c20d300ead52770e66fb8a1a47ea", null ],
[ "canWriteNoResponse", "class_nim_b_l_e_remote_characteristic.html#a2614c7f437b52f385fc4fd29abe358eb", null ],
[ "deleteDescriptor", "class_nim_b_l_e_remote_characteristic.html#aad0ba99cad9779b33ea7cd4e94349099", null ],
[ "deleteDescriptors", "class_nim_b_l_e_remote_characteristic.html#a5f0a51b4a7fb2244d236dcb96fcf5205", null ],
[ "end", "class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873", null ],
[ "getDefHandle", "class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380", null ],
[ "getDescriptor", "class_nim_b_l_e_remote_characteristic.html#a6178e1c58361b957be3c48548c1c4366", null ],
[ "getDescriptors", "class_nim_b_l_e_remote_characteristic.html#acf11d225fe5a25327742349e9d6061f9", null ],
[ "getHandle", "class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6", null ],
[ "getRemoteService", "class_nim_b_l_e_remote_characteristic.html#a943183a55b020de9e09ac2cfaebcde32", null ],
[ "getUUID", "class_nim_b_l_e_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb", null ],
[ "getValue", "class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257", null ],
[ "getValue", "class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b", null ],
[ "readFloat", "class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef", null ],
[ "readUInt16", "class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d", null ],
[ "readUInt32", "class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d", null ],
[ "readUInt8", "class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080", null ],
[ "readValue", "class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67", null ],
[ "readValue", "class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0", null ],
[ "registerForNotify", "class_nim_b_l_e_remote_characteristic.html#ab4f54eabe90a416546b7b3fc3477f49c", null ],
[ "subscribe", "class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7", null ],
[ "toString", "class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a", null ],
[ "unsubscribe", "class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa", null ],
[ "writeValue", "class_nim_b_l_e_remote_characteristic.html#a2cfc2e8d2e281dd61e578eb5e860fc02", null ],
[ "writeValue", "class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae", null ],
[ "writeValue", "class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3", null ]
];

View File

@@ -0,0 +1,113 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_descriptor.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">NimBLERemoteDescriptor Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">getHandle</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">getRemoteCharacteristic</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">getUUID</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53">readUInt16</a>() __attribute__((deprecated(&quot;Use template readValue&lt;uint16_t&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204">readUInt32</a>() __attribute__((deprecated(&quot;Use template readValue&lt;uint32_t&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b">readUInt8</a>() __attribute__((deprecated(&quot;Use template readValue&lt;uint8_t&gt;()&quot;)))</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">readValue</a>(bool skipSizeCheck=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">toString</a>(void)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a>(const uint8_t *data, size_t length, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a30bc16403ed53d3b4417c0a01cc4a40f">writeValue</a>(const std::string &amp;newValue, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">writeValue</a>(const T &amp;s, bool response=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,488 @@
<!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: NimBLERemoteDescriptor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_descriptor.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_remote_descriptor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLERemoteDescriptor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A model of remote BLE descriptor.
<a href="class_nim_b_l_e_remote_descriptor.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab8a774ebc69c0fb7ea17f926a82dba21"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">getHandle</a> ()</td></tr>
<tr class="memdesc:ab8a774ebc69c0fb7ea17f926a82dba21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the handle associated with this remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">More...</a><br /></td></tr>
<tr class="separator:ab8a774ebc69c0fb7ea17f926a82dba21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a529e80c6731f68f3598e015df7618cfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">getRemoteCharacteristic</a> ()</td></tr>
<tr class="memdesc:a529e80c6731f68f3598e015df7618cfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the characteristic that owns this descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">More...</a><br /></td></tr>
<tr class="separator:a529e80c6731f68f3598e015df7618cfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace6b19cd3d9aa8226b4c17371616ad58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">getUUID</a> ()</td></tr>
<tr class="memdesc:ace6b19cd3d9aa8226b4c17371616ad58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the UUID associated this remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">More...</a><br /></td></tr>
<tr class="separator:ace6b19cd3d9aa8226b4c17371616ad58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b6952aa46b3541fb0a8247e4e542257"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a> ()</td></tr>
<tr class="memdesc:a3b6952aa46b3541fb0a8247e4e542257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the value of the remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">More...</a><br /></td></tr>
<tr class="separator:a3b6952aa46b3541fb0a8247e4e542257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4e3a21818903b69ace41c36a58d3c46"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ac4e3a21818903b69ace41c36a58d3c46"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">readValue</a> (bool skipSizeCheck=false)</td></tr>
<tr class="memdesc:ac4e3a21818903b69ace41c36a58d3c46"><td class="mdescLeft">&#160;</td><td class="mdescRight">A template to convert the remote descriptor data to &lt;type&gt;. <a href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">More...</a><br /></td></tr>
<tr class="separator:ac4e3a21818903b69ace41c36a58d3c46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab07e86707a91e48f68e9de55686e939b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b">readUInt8</a> () __attribute__((deprecated(&quot;Use template <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>&lt;uint8_t&gt;()&quot;)))</td></tr>
<tr class="memdesc:ab07e86707a91e48f68e9de55686e939b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a byte value. <a href="class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b">More...</a><br /></td></tr>
<tr class="separator:ab07e86707a91e48f68e9de55686e939b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14351ea51b7b04f91b71e388881edd53"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53">readUInt16</a> () __attribute__((deprecated(&quot;Use template <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>&lt;uint16_t&gt;()&quot;)))</td></tr>
<tr class="memdesc:a14351ea51b7b04f91b71e388881edd53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an unsigned 16 bit value. <a href="class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53">More...</a><br /></td></tr>
<tr class="separator:a14351ea51b7b04f91b71e388881edd53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a219606f84d63bc02f093051d66f05204"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204">readUInt32</a> () __attribute__((deprecated(&quot;Use template <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257">readValue</a>&lt;uint32_t&gt;()&quot;)))</td></tr>
<tr class="memdesc:a219606f84d63bc02f093051d66f05204"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an unsigned 32 bit value. <a href="class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204">More...</a><br /></td></tr>
<tr class="separator:a219606f84d63bc02f093051d66f05204"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a008795a09d1fbe8533c2e9d0e8deb33a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">toString</a> (void)</td></tr>
<tr class="memdesc:a008795a09d1fbe8533c2e9d0e8deb33a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of this Remote Descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">More...</a><br /></td></tr>
<tr class="separator:a008795a09d1fbe8533c2e9d0e8deb33a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d3fb6424b2c86730e1a292281cd836e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a> (const uint8_t *data, size_t length, bool response=false)</td></tr>
<tr class="memdesc:a0d3fb6424b2c86730e1a292281cd836e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write data to the BLE Remote Descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">More...</a><br /></td></tr>
<tr class="separator:a0d3fb6424b2c86730e1a292281cd836e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30bc16403ed53d3b4417c0a01cc4a40f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a30bc16403ed53d3b4417c0a01cc4a40f">writeValue</a> (const std::string &amp;newValue, bool response=false)</td></tr>
<tr class="memdesc:a30bc16403ed53d3b4417c0a01cc4a40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write data represented as a string to the BLE Remote Descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a30bc16403ed53d3b4417c0a01cc4a40f">More...</a><br /></td></tr>
<tr class="separator:a30bc16403ed53d3b4417c0a01cc4a40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1abc84a09001537dffd13c810a503b9c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a1abc84a09001537dffd13c810a503b9c"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">writeValue</a> (const T &amp;s, bool response=false)</td></tr>
<tr class="memdesc:a1abc84a09001537dffd13c810a503b9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience template to set the remote descriptor value to &lt;type&gt;val. <a href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">More...</a><br /></td></tr>
<tr class="separator:a1abc84a09001537dffd13c810a503b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of remote BLE descriptor. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab8a774ebc69c0fb7ea17f926a82dba21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8a774ebc69c0fb7ea17f926a82dba21">&#9670;&nbsp;</a></span>getHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLERemoteDescriptor::getHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the handle associated with this remote descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>The handle associated with this remote descriptor. </dd></dl>
</div>
</div>
<a id="a529e80c6731f68f3598e015df7618cfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a529e80c6731f68f3598e015df7618cfe">&#9670;&nbsp;</a></span>getRemoteCharacteristic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLERemoteDescriptor::getRemoteCharacteristic </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the characteristic that owns this descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>The characteristic that owns this descriptor. </dd></dl>
</div>
</div>
<a id="ace6b19cd3d9aa8226b4c17371616ad58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace6b19cd3d9aa8226b4c17371616ad58">&#9670;&nbsp;</a></span>getUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLERemoteDescriptor::getUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the UUID associated this remote descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>The UUID associated this remote descriptor. </dd></dl>
</div>
</div>
<a id="a14351ea51b7b04f91b71e388881edd53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14351ea51b7b04f91b71e388881edd53">&#9670;&nbsp;</a></span>readUInt16()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NimBLERemoteDescriptor::readUInt16 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read an unsigned 16 bit value. </p>
<dl class="section return"><dt>Returns</dt><dd>The unsigned 16 bit value. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257" title="Read the value of the remote descriptor.">readValue&lt;uint16_t&gt;()</a>. </dd></dl>
</div>
</div>
<a id="a219606f84d63bc02f093051d66f05204"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a219606f84d63bc02f093051d66f05204">&#9670;&nbsp;</a></span>readUInt32()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t NimBLERemoteDescriptor::readUInt32 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read an unsigned 32 bit value. </p>
<dl class="section return"><dt>Returns</dt><dd>the unsigned 32 bit value. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257" title="Read the value of the remote descriptor.">readValue&lt;uint32_t&gt;()</a>. </dd></dl>
</div>
</div>
<a id="ab07e86707a91e48f68e9de55686e939b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab07e86707a91e48f68e9de55686e939b">&#9670;&nbsp;</a></span>readUInt8()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t NimBLERemoteDescriptor::readUInt8 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a byte value. </p>
<dl class="section return"><dt>Returns</dt><dd>The value as a byte </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257" title="Read the value of the remote descriptor.">readValue&lt;uint8_t&gt;()</a>. </dd></dl>
</div>
</div>
<a id="a3b6952aa46b3541fb0a8247e4e542257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b6952aa46b3541fb0a8247e4e542257">&#9670;&nbsp;</a></span>readValue() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLERemoteDescriptor::readValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the value of the remote descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>The value of the remote descriptor. </dd></dl>
</div>
</div>
<a id="ac4e3a21818903b69ace41c36a58d3c46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4e3a21818903b69ace41c36a58d3c46">&#9670;&nbsp;</a></span>readValue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T NimBLERemoteDescriptor::readValue </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A template to convert the remote descriptor data to &lt;type&gt;. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type to convert the data to. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">skipSizeCheck</td><td>If true it will skip checking if the data size is less than <code>sizeof(&lt;type&gt;)</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The data converted to &lt;type&gt; or NULL if skipSizeCheck is false and the data is less than <code>sizeof(&lt;type&gt;)</code>.</dd></dl>
<p><b>Use:</b> <code>readValue&lt;type&gt;(skipSizeCheck);</code> </p>
</div>
</div>
<a id="a008795a09d1fbe8533c2e9d0e8deb33a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a008795a09d1fbe8533c2e9d0e8deb33a">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLERemoteDescriptor::toString </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string representation of this Remote Descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of this Remote Descriptor. </dd></dl>
</div>
</div>
<a id="a30bc16403ed53d3b4417c0a01cc4a40f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30bc16403ed53d3b4417c0a01cc4a40f">&#9670;&nbsp;</a></span>writeValue() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLERemoteDescriptor::writeValue </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>newValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>response</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data represented as a string to the BLE Remote Descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">newValue</td><td>The data to send to the remote descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>True if we expect a response. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful </dd></dl>
</div>
</div>
<a id="a1abc84a09001537dffd13c810a503b9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1abc84a09001537dffd13c810a503b9c">&#9670;&nbsp;</a></span>writeValue() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLERemoteDescriptor::writeValue </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>response</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience template to set the remote descriptor value to &lt;type&gt;val. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The value to write. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>True == request write response. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0d3fb6424b2c86730e1a292281cd836e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d3fb6424b2c86730e1a292281cd836e">&#9670;&nbsp;</a></span>writeValue() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLERemoteDescriptor::writeValue </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>response</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data to the BLE Remote Descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to send to the remote descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data to send. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>True if we expect a write response. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,15 @@
var class_nim_b_l_e_remote_descriptor =
[
[ "getHandle", "class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21", null ],
[ "getRemoteCharacteristic", "class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe", null ],
[ "getUUID", "class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58", null ],
[ "readUInt16", "class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53", null ],
[ "readUInt32", "class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204", null ],
[ "readUInt8", "class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b", null ],
[ "readValue", "class_nim_b_l_e_remote_descriptor.html#a3b6952aa46b3541fb0a8247e4e542257", null ],
[ "readValue", "class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46", null ],
[ "toString", "class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a", null ],
[ "writeValue", "class_nim_b_l_e_remote_descriptor.html#a30bc16403ed53d3b4417c0a01cc4a40f", null ],
[ "writeValue", "class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c", null ],
[ "writeValue", "class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e", null ]
];

View File

@@ -0,0 +1,114 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_service.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">NimBLERemoteService Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a49bb3134b570db877fac67e6ed077aa2">begin</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a15b3b750b073f334c3be680a99ce2e02">deleteCharacteristic</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a221069047193f8d25f7112b44bbcb28f">deleteCharacteristics</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a10fe635fe9a0661d26c33021faaec53b">end</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487">getCharacteristic</a>(const char *uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a7ff4fc7bfb77adc33003dd6eb8e16957">getCharacteristic</a>(const NimBLEUUID &amp;uuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a2c9e91c842598a6a9576c7b87af0863a">getCharacteristics</a>(bool refresh=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a3d1e7db457a9f3774eaa5e641dcc716e">getClient</a>(void)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a565ed7d306645772d4e03ca65a07f7e5">getUUID</a>(void)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a4a9b63b4e5cedb51a7748a88daeb518b">getValue</a>(const NimBLEUUID &amp;characteristicUuid)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a4bb8c7c85580d86fd9ab7be5c3933b72">setValue</a>(const NimBLEUUID &amp;characteristicUuid, const std::string &amp;value)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#aaf106a37f24a51b967dd0984c973750f">toString</a>(void)</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html#a2803aa5cdfdb622ae8fe255dc939cb1d">~NimBLERemoteService</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,428 @@
<!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: NimBLERemoteService Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_service.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_remote_service-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLERemoteService Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A model of a remote BLE service.
<a href="class_nim_b_l_e_remote_service.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2803aa5cdfdb622ae8fe255dc939cb1d"><td class="memItemLeft" align="right" valign="top"><a id="a2803aa5cdfdb622ae8fe255dc939cb1d"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a2803aa5cdfdb622ae8fe255dc939cb1d">~NimBLERemoteService</a> ()</td></tr>
<tr class="memdesc:a2803aa5cdfdb622ae8fe255dc939cb1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">When deleting the service make sure we delete all characteristics and descriptors. <br /></td></tr>
<tr class="separator:a2803aa5cdfdb622ae8fe255dc939cb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49bb3134b570db877fac67e6ed077aa2"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a49bb3134b570db877fac67e6ed077aa2">begin</a> ()</td></tr>
<tr class="memdesc:a49bb3134b570db877fac67e6ed077aa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning of the vector of remote characteristic pointers. <a href="class_nim_b_l_e_remote_service.html#a49bb3134b570db877fac67e6ed077aa2">More...</a><br /></td></tr>
<tr class="separator:a49bb3134b570db877fac67e6ed077aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10fe635fe9a0661d26c33021faaec53b"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a10fe635fe9a0661d26c33021faaec53b">end</a> ()</td></tr>
<tr class="memdesc:a10fe635fe9a0661d26c33021faaec53b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end of the vector of remote characteristic pointers. <a href="class_nim_b_l_e_remote_service.html#a10fe635fe9a0661d26c33021faaec53b">More...</a><br /></td></tr>
<tr class="separator:a10fe635fe9a0661d26c33021faaec53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab12d195a2239a3808d60457184f0c487"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487">getCharacteristic</a> (const char *uuid)</td></tr>
<tr class="memdesc:ab12d195a2239a3808d60457184f0c487"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the remote characteristic object for the characteristic UUID. <a href="class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487">More...</a><br /></td></tr>
<tr class="separator:ab12d195a2239a3808d60457184f0c487"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ff4fc7bfb77adc33003dd6eb8e16957"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a7ff4fc7bfb77adc33003dd6eb8e16957">getCharacteristic</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:a7ff4fc7bfb77adc33003dd6eb8e16957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the characteristic object for the UUID. <a href="class_nim_b_l_e_remote_service.html#a7ff4fc7bfb77adc33003dd6eb8e16957">More...</a><br /></td></tr>
<tr class="separator:a7ff4fc7bfb77adc33003dd6eb8e16957"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a221069047193f8d25f7112b44bbcb28f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a221069047193f8d25f7112b44bbcb28f">deleteCharacteristics</a> ()</td></tr>
<tr class="memdesc:a221069047193f8d25f7112b44bbcb28f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the characteristics in the characteristics vector. <a href="class_nim_b_l_e_remote_service.html#a221069047193f8d25f7112b44bbcb28f">More...</a><br /></td></tr>
<tr class="separator:a221069047193f8d25f7112b44bbcb28f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15b3b750b073f334c3be680a99ce2e02"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a15b3b750b073f334c3be680a99ce2e02">deleteCharacteristic</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:a15b3b750b073f334c3be680a99ce2e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete characteristic by UUID. <a href="class_nim_b_l_e_remote_service.html#a15b3b750b073f334c3be680a99ce2e02">More...</a><br /></td></tr>
<tr class="separator:a15b3b750b073f334c3be680a99ce2e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d1e7db457a9f3774eaa5e641dcc716e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a3d1e7db457a9f3774eaa5e641dcc716e">getClient</a> (void)</td></tr>
<tr class="memdesc:a3d1e7db457a9f3774eaa5e641dcc716e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the client associated with this service. <a href="class_nim_b_l_e_remote_service.html#a3d1e7db457a9f3774eaa5e641dcc716e">More...</a><br /></td></tr>
<tr class="separator:a3d1e7db457a9f3774eaa5e641dcc716e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a565ed7d306645772d4e03ca65a07f7e5"><td class="memItemLeft" align="right" valign="top"><a id="a565ed7d306645772d4e03ca65a07f7e5"></a>
<a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a565ed7d306645772d4e03ca65a07f7e5">getUUID</a> (void)</td></tr>
<tr class="memdesc:a565ed7d306645772d4e03ca65a07f7e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the service UUID. <br /></td></tr>
<tr class="separator:a565ed7d306645772d4e03ca65a07f7e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a9b63b4e5cedb51a7748a88daeb518b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a4a9b63b4e5cedb51a7748a88daeb518b">getValue</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUuid)</td></tr>
<tr class="memdesc:a4a9b63b4e5cedb51a7748a88daeb518b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the value of a characteristic associated with this service. <a href="class_nim_b_l_e_remote_service.html#a4a9b63b4e5cedb51a7748a88daeb518b">More...</a><br /></td></tr>
<tr class="separator:a4a9b63b4e5cedb51a7748a88daeb518b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb8c7c85580d86fd9ab7be5c3933b72"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a4bb8c7c85580d86fd9ab7be5c3933b72">setValue</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUuid, const std::string &amp;value)</td></tr>
<tr class="memdesc:a4bb8c7c85580d86fd9ab7be5c3933b72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of a characteristic. <a href="class_nim_b_l_e_remote_service.html#a4bb8c7c85580d86fd9ab7be5c3933b72">More...</a><br /></td></tr>
<tr class="separator:a4bb8c7c85580d86fd9ab7be5c3933b72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf106a37f24a51b967dd0984c973750f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#aaf106a37f24a51b967dd0984c973750f">toString</a> (void)</td></tr>
<tr class="memdesc:aaf106a37f24a51b967dd0984c973750f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a string representation of this remote service. <a href="class_nim_b_l_e_remote_service.html#aaf106a37f24a51b967dd0984c973750f">More...</a><br /></td></tr>
<tr class="separator:aaf106a37f24a51b967dd0984c973750f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c9e91c842598a6a9576c7b87af0863a"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a2c9e91c842598a6a9576c7b87af0863a">getCharacteristics</a> (bool refresh=false)</td></tr>
<tr class="memdesc:a2c9e91c842598a6a9576c7b87af0863a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the vector of found characteristics. <a href="class_nim_b_l_e_remote_service.html#a2c9e91c842598a6a9576c7b87af0863a">More...</a><br /></td></tr>
<tr class="separator:a2c9e91c842598a6a9576c7b87af0863a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of a remote BLE service. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a49bb3134b570db877fac67e6ed077aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49bb3134b570db877fac67e6ed077aa2">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator NimBLERemoteService::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the beginning of the vector of remote characteristic pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the beginning of the vector of remote characteristic pointers. </dd></dl>
</div>
</div>
<a id="a15b3b750b073f334c3be680a99ce2e02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15b3b750b073f334c3be680a99ce2e02">&#9670;&nbsp;</a></span>deleteCharacteristic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t NimBLERemoteService::deleteCharacteristic </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete characteristic by UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the characteristic to be removed from the local database. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of characteristics left. </dd></dl>
</div>
</div>
<a id="a221069047193f8d25f7112b44bbcb28f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a221069047193f8d25f7112b44bbcb28f">&#9670;&nbsp;</a></span>deleteCharacteristics()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLERemoteService::deleteCharacteristics </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete the characteristics in the characteristics vector. </p>
<p>We maintain a vector called m_characteristicsVector that contains pointers to BLERemoteCharacteristic object references. Since we allocated these in this class, we are also responsible for deleting them. This method does just that. </p>
</div>
</div>
<a id="a10fe635fe9a0661d26c33021faaec53b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10fe635fe9a0661d26c33021faaec53b">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator NimBLERemoteService::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the end of the vector of remote characteristic pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the end of the vector of remote characteristic pointers. </dd></dl>
</div>
</div>
<a id="ab12d195a2239a3808d60457184f0c487"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab12d195a2239a3808d60457184f0c487">&#9670;&nbsp;</a></span>getCharacteristic() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLERemoteService::getCharacteristic </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the remote characteristic object for the characteristic UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>Remote characteristic uuid. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the remote characteristic object. </dd></dl>
</div>
</div>
<a id="a7ff4fc7bfb77adc33003dd6eb8e16957"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ff4fc7bfb77adc33003dd6eb8e16957">&#9670;&nbsp;</a></span>getCharacteristic() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLERemoteService::getCharacteristic </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the characteristic object for the UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>Characteristic uuid. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the characteristic object, or nullptr if not found. </dd></dl>
</div>
</div>
<a id="a2c9e91c842598a6a9576c7b87af0863a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c9e91c842598a6a9576c7b87af0863a">&#9670;&nbsp;</a></span>getCharacteristics()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt; * NimBLERemoteService::getCharacteristics </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>refresh</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the vector of found characteristics. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">refresh</td><td>If true the current characteristics vector will cleared and all characteristics for this service retrieved from the peripheral. If false the vector will be returned with the currently stored characteristics of this service. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the vector of descriptors for this characteristic. </dd></dl>
</div>
</div>
<a id="a3d1e7db457a9f3774eaa5e641dcc716e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d1e7db457a9f3774eaa5e641dcc716e">&#9670;&nbsp;</a></span>getClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> * NimBLERemoteService::getClient </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the client associated with this service. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the client associated with this service. </dd></dl>
</div>
</div>
<a id="a4a9b63b4e5cedb51a7748a88daeb518b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a9b63b4e5cedb51a7748a88daeb518b">&#9670;&nbsp;</a></span>getValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLERemoteService::getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>characteristicUuid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the value of a characteristic associated with this service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">characteristicUuid</td><td>The characteristic to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string containing the value or an empty string if not found or error. </dd></dl>
</div>
</div>
<a id="a4bb8c7c85580d86fd9ab7be5c3933b72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb8c7c85580d86fd9ab7be5c3933b72">&#9670;&nbsp;</a></span>setValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLERemoteService::setValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>characteristicUuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of a characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">characteristicUuid</td><td>The characteristic to set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false if not found or error </dd></dl>
</div>
</div>
<a id="aaf106a37f24a51b967dd0984c973750f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf106a37f24a51b967dd0984c973750f">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLERemoteService::toString </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string representation of this remote service. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of this remote service. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,16 @@
var class_nim_b_l_e_remote_service =
[
[ "~NimBLERemoteService", "class_nim_b_l_e_remote_service.html#a2803aa5cdfdb622ae8fe255dc939cb1d", null ],
[ "begin", "class_nim_b_l_e_remote_service.html#a49bb3134b570db877fac67e6ed077aa2", null ],
[ "deleteCharacteristic", "class_nim_b_l_e_remote_service.html#a15b3b750b073f334c3be680a99ce2e02", null ],
[ "deleteCharacteristics", "class_nim_b_l_e_remote_service.html#a221069047193f8d25f7112b44bbcb28f", null ],
[ "end", "class_nim_b_l_e_remote_service.html#a10fe635fe9a0661d26c33021faaec53b", null ],
[ "getCharacteristic", "class_nim_b_l_e_remote_service.html#ab12d195a2239a3808d60457184f0c487", null ],
[ "getCharacteristic", "class_nim_b_l_e_remote_service.html#a7ff4fc7bfb77adc33003dd6eb8e16957", null ],
[ "getCharacteristics", "class_nim_b_l_e_remote_service.html#a2c9e91c842598a6a9576c7b87af0863a", null ],
[ "getClient", "class_nim_b_l_e_remote_service.html#a3d1e7db457a9f3774eaa5e641dcc716e", null ],
[ "getUUID", "class_nim_b_l_e_remote_service.html#a565ed7d306645772d4e03ca65a07f7e5", null ],
[ "getValue", "class_nim_b_l_e_remote_service.html#a4a9b63b4e5cedb51a7748a88daeb518b", null ],
[ "setValue", "class_nim_b_l_e_remote_service.html#a4bb8c7c85580d86fd9ab7be5c3933b72", null ],
[ "toString", "class_nim_b_l_e_remote_service.html#aaf106a37f24a51b967dd0984c973750f", null ]
];

View File

@@ -0,0 +1,117 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_scan.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 Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a6a97fd1c7f16fccd7f19994592b6dfe6">clearDuplicateCache</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b">clearResults</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">erase</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">getResults</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016">isScanning</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910">setActiveScan</a>(bool active)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#ab275a9fec35c8957acf47689056d94af">setAdvertisedDeviceCallbacks</a>(NimBLEAdvertisedDeviceCallbacks *pAdvertisedDeviceCallbacks, bool wantDuplicates=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#ac40563af803f3b9ab88398c7f30e21bb">setDuplicateFilter</a>(bool enabled)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967">setFilterPolicy</a>(uint8_t filter)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a3f3e30d8b79aeb4d64af10d5f9d33788">setInterval</a>(uint16_t intervalMSecs)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1">setLimitedOnly</a>(bool enabled)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81">setMaxResults</a>(uint8_t maxResults)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#ac2e8c921413f1ad217f45fecf63c0d22">setWindow</a>(uint16_t windowMSecs)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820">start</a>(uint32_t duration, void(*scanCompleteCB)(NimBLEScanResults), bool is_continue=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a8459a1c69476fcdfd6370a1d10e0e159">start</a>(uint32_t duration, bool is_continue=false)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1">stop</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

564
class_nim_b_l_e_scan.html Normal file
View File

@@ -0,0 +1,564 @@
<!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: NimBLEScan Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_scan.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_scan-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEScan Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Perform and manage BLE scans.
<a href="class_nim_b_l_e_scan.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a21b1e27816717b77533755f31dfaa820"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820">start</a> (uint32_t duration, void(*scanCompleteCB)(<a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>), bool is_continue=false)</td></tr>
<tr class="memdesc:a21b1e27816717b77533755f31dfaa820"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start scanning. <a href="class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820">More...</a><br /></td></tr>
<tr class="separator:a21b1e27816717b77533755f31dfaa820"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8459a1c69476fcdfd6370a1d10e0e159"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a8459a1c69476fcdfd6370a1d10e0e159">start</a> (uint32_t duration, bool is_continue=false)</td></tr>
<tr class="memdesc:a8459a1c69476fcdfd6370a1d10e0e159"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start scanning and block until scanning has been completed. <a href="class_nim_b_l_e_scan.html#a8459a1c69476fcdfd6370a1d10e0e159">More...</a><br /></td></tr>
<tr class="separator:a8459a1c69476fcdfd6370a1d10e0e159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab788ad282fdbf4467302f6ad2d4d6016"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016">isScanning</a> ()</td></tr>
<tr class="memdesc:ab788ad282fdbf4467302f6ad2d4d6016"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the status of the scanner. <a href="class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016">More...</a><br /></td></tr>
<tr class="separator:ab788ad282fdbf4467302f6ad2d4d6016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab275a9fec35c8957acf47689056d94af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#ab275a9fec35c8957acf47689056d94af">setAdvertisedDeviceCallbacks</a> (<a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a> *pAdvertisedDeviceCallbacks, bool wantDuplicates=false)</td></tr>
<tr class="memdesc:ab275a9fec35c8957acf47689056d94af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the call backs to be invoked. <a href="class_nim_b_l_e_scan.html#ab275a9fec35c8957acf47689056d94af">More...</a><br /></td></tr>
<tr class="separator:ab275a9fec35c8957acf47689056d94af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d24e77d6b339552b6ac16effdb54910"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910">setActiveScan</a> (bool active)</td></tr>
<tr class="memdesc:a7d24e77d6b339552b6ac16effdb54910"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should we perform an active or passive scan? The default is a passive scan. An active scan means that we will request a scan response. <a href="class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910">More...</a><br /></td></tr>
<tr class="separator:a7d24e77d6b339552b6ac16effdb54910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f3e30d8b79aeb4d64af10d5f9d33788"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a3f3e30d8b79aeb4d64af10d5f9d33788">setInterval</a> (uint16_t intervalMSecs)</td></tr>
<tr class="memdesc:a3f3e30d8b79aeb4d64af10d5f9d33788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the interval to scan. <a href="class_nim_b_l_e_scan.html#a3f3e30d8b79aeb4d64af10d5f9d33788">More...</a><br /></td></tr>
<tr class="separator:a3f3e30d8b79aeb4d64af10d5f9d33788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2e8c921413f1ad217f45fecf63c0d22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#ac2e8c921413f1ad217f45fecf63c0d22">setWindow</a> (uint16_t windowMSecs)</td></tr>
<tr class="memdesc:ac2e8c921413f1ad217f45fecf63c0d22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the window to actively scan. <a href="class_nim_b_l_e_scan.html#ac2e8c921413f1ad217f45fecf63c0d22">More...</a><br /></td></tr>
<tr class="separator:ac2e8c921413f1ad217f45fecf63c0d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac40563af803f3b9ab88398c7f30e21bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#ac40563af803f3b9ab88398c7f30e21bb">setDuplicateFilter</a> (bool enabled)</td></tr>
<tr class="memdesc:ac40563af803f3b9ab88398c7f30e21bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether or not the BLE controller should only report results from devices it has not already seen. <a href="class_nim_b_l_e_scan.html#ac40563af803f3b9ab88398c7f30e21bb">More...</a><br /></td></tr>
<tr class="separator:ac40563af803f3b9ab88398c7f30e21bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77483be2bd9dad08322cc64f4e7012c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1">setLimitedOnly</a> (bool enabled)</td></tr>
<tr class="memdesc:a77483be2bd9dad08322cc64f4e7012c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether or not the BLE controller only report scan results from devices advertising in limited discovery mode, i.e. directed advertising. <a href="class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1">More...</a><br /></td></tr>
<tr class="separator:a77483be2bd9dad08322cc64f4e7012c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4248aabb5da67953eadab2a6f834d967"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967">setFilterPolicy</a> (uint8_t filter)</td></tr>
<tr class="memdesc:a4248aabb5da67953eadab2a6f834d967"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the scan filter policy. <a href="class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967">More...</a><br /></td></tr>
<tr class="separator:a4248aabb5da67953eadab2a6f834d967"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a97fd1c7f16fccd7f19994592b6dfe6"><td class="memItemLeft" align="right" valign="top"><a id="a6a97fd1c7f16fccd7f19994592b6dfe6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a6a97fd1c7f16fccd7f19994592b6dfe6">clearDuplicateCache</a> ()</td></tr>
<tr class="memdesc:a6a97fd1c7f16fccd7f19994592b6dfe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the duplicate scan filter cache. <br /></td></tr>
<tr class="separator:a6a97fd1c7f16fccd7f19994592b6dfe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68fa5cc715f62a9a97ac0dccfb8557c1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1">stop</a> ()</td></tr>
<tr class="memdesc:a68fa5cc715f62a9a97ac0dccfb8557c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop an in progress scan. <a href="class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1">More...</a><br /></td></tr>
<tr class="separator:a68fa5cc715f62a9a97ac0dccfb8557c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad421a09eeb021755b193a7a5e01f183b"><td class="memItemLeft" align="right" valign="top"><a id="ad421a09eeb021755b193a7a5e01f183b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b">clearResults</a> ()</td></tr>
<tr class="memdesc:ad421a09eeb021755b193a7a5e01f183b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the results of the scan. <br /></td></tr>
<tr class="separator:ad421a09eeb021755b193a7a5e01f183b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ae53719546e2d410c816e12c56aad61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">getResults</a> ()</td></tr>
<tr class="memdesc:a2ae53719546e2d410c816e12c56aad61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the results of the scan. <a href="class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61">More...</a><br /></td></tr>
<tr class="separator:a2ae53719546e2d410c816e12c56aad61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad9cd2462d00d7c0fa39d095aa2d8e81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81">setMaxResults</a> (uint8_t maxResults)</td></tr>
<tr class="memdesc:aad9cd2462d00d7c0fa39d095aa2d8e81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the max number of results to store. <a href="class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81">More...</a><br /></td></tr>
<tr class="separator:aad9cd2462d00d7c0fa39d095aa2d8e81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a566a9ef25b04e946ac23402bb760cda1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">erase</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address)</td></tr>
<tr class="memdesc:a566a9ef25b04e946ac23402bb760cda1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete peer device from the scan results vector. <a href="class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1">More...</a><br /></td></tr>
<tr class="separator:a566a9ef25b04e946ac23402bb760cda1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Perform and manage BLE scans. </p>
<p>Scanning is associated with a BLE client that is attempting to locate BLE servers. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a566a9ef25b04e946ac23402bb760cda1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a566a9ef25b04e946ac23402bb760cda1">&#9670;&nbsp;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::erase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete peer device from the scan results vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address of the device to delete from the results.</td></tr>
</table>
</dd>
</dl>
<p>After disconnecting, it may be required in the case we were connected to a device without a public address. </p>
</div>
</div>
<a id="a2ae53719546e2d410c816e12c56aad61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ae53719546e2d410c816e12c56aad61">&#9670;&nbsp;</a></span>getResults()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> NimBLEScan::getResults </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the results of the scan. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_nim_b_l_e_scan_results.html" title="A class that contains and operates on the results of a BLE scan.">NimBLEScanResults</a> object. </dd></dl>
</div>
</div>
<a id="ab788ad282fdbf4467302f6ad2d4d6016"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab788ad282fdbf4467302f6ad2d4d6016">&#9670;&nbsp;</a></span>isScanning()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEScan::isScanning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the status of the scanner. </p>
<dl class="section return"><dt>Returns</dt><dd>true if scanning or scan starting. </dd></dl>
</div>
</div>
<a id="a7d24e77d6b339552b6ac16effdb54910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d24e77d6b339552b6ac16effdb54910">&#9670;&nbsp;</a></span>setActiveScan()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setActiveScan </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>active</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Should we perform an active or passive scan? The default is a passive scan. An active scan means that we will request a scan response. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">active</td><td>If true, we perform an active scan otherwise a passive scan. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab275a9fec35c8957acf47689056d94af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab275a9fec35c8957acf47689056d94af">&#9670;&nbsp;</a></span>setAdvertisedDeviceCallbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setAdvertisedDeviceCallbacks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_advertised_device_callbacks.html">NimBLEAdvertisedDeviceCallbacks</a> *&#160;</td>
<td class="paramname"><em>pAdvertisedDeviceCallbacks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>wantDuplicates</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the call backs to be invoked. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pAdvertisedDeviceCallbacks</td><td>Call backs to be invoked. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">wantDuplicates</td><td>True if we wish to be called back with duplicates. Default is false. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac40563af803f3b9ab88398c7f30e21bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac40563af803f3b9ab88398c7f30e21bb">&#9670;&nbsp;</a></span>setDuplicateFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setDuplicateFilter </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether or not the BLE controller should only report results from devices it has not already seen. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enabled</td><td>If true, scanned devices will only be reported once.</td></tr>
</table>
</dd>
</dl>
<p>The controller has a limited buffer and will start reporting dupicate devices once the limit is reached. </p>
</div>
</div>
<a id="a4248aabb5da67953eadab2a6f834d967"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4248aabb5da67953eadab2a6f834d967">&#9670;&nbsp;</a></span>setFilterPolicy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setFilterPolicy </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>filter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the scan filter policy. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td>Can be one of:<ul>
<li>BLE_HCI_SCAN_FILT_NO_WL (0) Scanner processes all advertising packets (white list not used) except<br />
directed, connectable advertising packets not sent to the scanner.</li>
<li>BLE_HCI_SCAN_FILT_USE_WL (1) Scanner processes advertisements from white list only. A connectable,<br />
directed advertisment is ignored unless it contains scanners address.</li>
<li>BLE_HCI_SCAN_FILT_NO_WL_INITA (2) Scanner process all advertising packets (white list not used). A<br />
connectable, directed advertisement shall not be ignored if the InitA is a resolvable private address.</li>
<li>BLE_HCI_SCAN_FILT_USE_WL_INITA (3) Scanner process advertisements from white list only. A connectable,<br />
directed advertisement shall not be ignored if the InitA is a resolvable private address. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3f3e30d8b79aeb4d64af10d5f9d33788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f3e30d8b79aeb4d64af10d5f9d33788">&#9670;&nbsp;</a></span>setInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setInterval </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>intervalMSecs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the interval to scan. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">intervalMSecs</td><td>The scan interval (how often) in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a77483be2bd9dad08322cc64f4e7012c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77483be2bd9dad08322cc64f4e7012c1">&#9670;&nbsp;</a></span>setLimitedOnly()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setLimitedOnly </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether or not the BLE controller only report scan results from devices advertising in limited discovery mode, i.e. directed advertising. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enabled</td><td>If true, only limited discovery devices will be in scan results. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aad9cd2462d00d7c0fa39d095aa2d8e81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad9cd2462d00d7c0fa39d095aa2d8e81">&#9670;&nbsp;</a></span>setMaxResults()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setMaxResults </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>maxResults</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the max number of results to store. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">maxResults</td><td>The number of results to limit storage to<br />
0 == none (callbacks only) 0xFF == unlimited, any other value is the limit. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac2e8c921413f1ad217f45fecf63c0d22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2e8c921413f1ad217f45fecf63c0d22">&#9670;&nbsp;</a></span>setWindow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEScan::setWindow </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>windowMSecs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the window to actively scan. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">windowMSecs</td><td>How long to actively scan. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8459a1c69476fcdfd6370a1d10e0e159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8459a1c69476fcdfd6370a1d10e0e159">&#9670;&nbsp;</a></span>start() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> NimBLEScan::start </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_continue</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start scanning and block until scanning has been completed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>The duration in seconds for which to scan. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_continue</td><td>Set to true to save previous scan results, false to clear them. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_nim_b_l_e_scan_results.html" title="A class that contains and operates on the results of a BLE scan.">NimBLEScanResults</a>. </dd></dl>
</div>
</div>
<a id="a21b1e27816717b77533755f31dfaa820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21b1e27816717b77533755f31dfaa820">&#9670;&nbsp;</a></span>start() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEScan::start </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(<a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>)&#160;</td>
<td class="paramname"><em>scanCompleteCB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_continue</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start scanning. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>The duration in seconds for which to scan. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">scanCompleteCB</td><td>A function to be called when scanning has completed. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_continue</td><td>Set to true to save previous scan results, false to clear them. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if scan started or false if there was an error. </dd></dl>
</div>
</div>
<a id="a68fa5cc715f62a9a97ac0dccfb8557c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68fa5cc715f62a9a97ac0dccfb8557c1">&#9670;&nbsp;</a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEScan::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop an in progress scan. </p>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_scan.html">NimBLEScan</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

19
class_nim_b_l_e_scan.js Normal file
View File

@@ -0,0 +1,19 @@
var class_nim_b_l_e_scan =
[
[ "clearDuplicateCache", "class_nim_b_l_e_scan.html#a6a97fd1c7f16fccd7f19994592b6dfe6", null ],
[ "clearResults", "class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b", null ],
[ "erase", "class_nim_b_l_e_scan.html#a566a9ef25b04e946ac23402bb760cda1", null ],
[ "getResults", "class_nim_b_l_e_scan.html#a2ae53719546e2d410c816e12c56aad61", null ],
[ "isScanning", "class_nim_b_l_e_scan.html#ab788ad282fdbf4467302f6ad2d4d6016", null ],
[ "setActiveScan", "class_nim_b_l_e_scan.html#a7d24e77d6b339552b6ac16effdb54910", null ],
[ "setAdvertisedDeviceCallbacks", "class_nim_b_l_e_scan.html#ab275a9fec35c8957acf47689056d94af", null ],
[ "setDuplicateFilter", "class_nim_b_l_e_scan.html#ac40563af803f3b9ab88398c7f30e21bb", null ],
[ "setFilterPolicy", "class_nim_b_l_e_scan.html#a4248aabb5da67953eadab2a6f834d967", null ],
[ "setInterval", "class_nim_b_l_e_scan.html#a3f3e30d8b79aeb4d64af10d5f9d33788", null ],
[ "setLimitedOnly", "class_nim_b_l_e_scan.html#a77483be2bd9dad08322cc64f4e7012c1", null ],
[ "setMaxResults", "class_nim_b_l_e_scan.html#aad9cd2462d00d7c0fa39d095aa2d8e81", null ],
[ "setWindow", "class_nim_b_l_e_scan.html#ac2e8c921413f1ad217f45fecf63c0d22", null ],
[ "start", "class_nim_b_l_e_scan.html#a8459a1c69476fcdfd6370a1d10e0e159", null ],
[ "start", "class_nim_b_l_e_scan.html#a21b1e27816717b77533755f31dfaa820", null ],
[ "stop", "class_nim_b_l_e_scan.html#a68fa5cc715f62a9a97ac0dccfb8557c1", null ]
];

View File

@@ -0,0 +1,107 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_scan_results.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">NimBLEScanResults Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">begin</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4">dump</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">end</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">getCount</a>()</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">getDevice</a>(uint32_t i)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html#ac2356f6c1b8384ebc061d4b7953a9374">getDevice</a>(const NimBLEAddress &amp;address)</td><td class="entry"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,246 @@
<!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: NimBLEScanResults Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_scan_results.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_scan_results-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEScanResults Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that contains and operates on the results of a BLE scan.
<a href="class_nim_b_l_e_scan_results.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2bbead75105733d04796b69e10c56cd4"><td class="memItemLeft" align="right" valign="top"><a id="a2bbead75105733d04796b69e10c56cd4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4">dump</a> ()</td></tr>
<tr class="memdesc:a2bbead75105733d04796b69e10c56cd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump the scan results to the log. <br /></td></tr>
<tr class="separator:a2bbead75105733d04796b69e10c56cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4796dd6ce1845c46f66bc1a36ad746a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">getCount</a> ()</td></tr>
<tr class="memdesc:ae4796dd6ce1845c46f66bc1a36ad746a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the count of devices found in the last scan. <a href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">More...</a><br /></td></tr>
<tr class="separator:ae4796dd6ce1845c46f66bc1a36ad746a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68aa3ebffb1be785497f228c1d11e500"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">getDevice</a> (uint32_t i)</td></tr>
<tr class="memdesc:a68aa3ebffb1be785497f228c1d11e500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the specified device at the given index. The index should be between 0 and <a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a" title="Get the count of devices found in the last scan.">getCount()</a>-1. <a href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">More...</a><br /></td></tr>
<tr class="separator:a68aa3ebffb1be785497f228c1d11e500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad426f221e8c18c0c3f5784786710e8f0"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">begin</a> ()</td></tr>
<tr class="memdesc:ad426f221e8c18c0c3f5784786710e8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning of the vector of advertised device pointers. <a href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">More...</a><br /></td></tr>
<tr class="separator:ad426f221e8c18c0c3f5784786710e8f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44e183a7ce0c9fb587d11910ce5ef200"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">end</a> ()</td></tr>
<tr class="memdesc:a44e183a7ce0c9fb587d11910ce5ef200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end of the vector of advertised device pointers. <a href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">More...</a><br /></td></tr>
<tr class="separator:a44e183a7ce0c9fb587d11910ce5ef200"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2356f6c1b8384ebc061d4b7953a9374"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#ac2356f6c1b8384ebc061d4b7953a9374">getDevice</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address)</td></tr>
<tr class="memdesc:ac2356f6c1b8384ebc061d4b7953a9374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the specified device at the given address. If the address is not found a nullptr is returned. <a href="class_nim_b_l_e_scan_results.html#ac2356f6c1b8384ebc061d4b7953a9374">More...</a><br /></td></tr>
<tr class="separator:ac2356f6c1b8384ebc061d4b7953a9374"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that contains and operates on the results of a BLE scan. </p>
<p>When a scan completes, we have a set of found devices. Each device is described by a <a class="el" href="class_nim_b_l_e_advertised_device.html" title="A representation of a BLE advertised device found by a scan.">NimBLEAdvertisedDevice</a> object. The number of items in the set is given by <a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a" title="Get the count of devices found in the last scan.">getCount()</a>. We can retrieve a device by calling <a class="el" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500" title="Return the specified device at the given index. The index should be between 0 and getCount()-1.">getDevice()</a> passing in the index (starting at 0) of the desired device. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad426f221e8c18c0c3f5784786710e8f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad426f221e8c18c0c3f5784786710e8f0">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator NimBLEScanResults::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the beginning of the vector of advertised device pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the beginning of the vector of advertised device pointers. </dd></dl>
</div>
</div>
<a id="a44e183a7ce0c9fb587d11910ce5ef200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44e183a7ce0c9fb587d11910ce5ef200">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator NimBLEScanResults::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the end of the vector of advertised device pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the end of the vector of advertised device pointers. </dd></dl>
</div>
</div>
<a id="ae4796dd6ce1845c46f66bc1a36ad746a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4796dd6ce1845c46f66bc1a36ad746a">&#9670;&nbsp;</a></span>getCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NimBLEScanResults::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the count of devices found in the last scan. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of devices found in the last scan. </dd></dl>
</div>
</div>
<a id="ac2356f6c1b8384ebc061d4b7953a9374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2356f6c1b8384ebc061d4b7953a9374">&#9670;&nbsp;</a></span>getDevice() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * NimBLEScanResults::getDevice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the specified device at the given address. If the address is not found a nullptr is returned. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the device at the specified address. </dd></dl>
</div>
</div>
<a id="a68aa3ebffb1be785497f228c1d11e500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68aa3ebffb1be785497f228c1d11e500">&#9670;&nbsp;</a></span>getDevice() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> NimBLEScanResults::getDevice </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the specified device at the given index. The index should be between 0 and <a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a" title="Get the count of devices found in the last scan.">getCount()</a>-1. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>The index of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The device at the specified index. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,9 @@
var class_nim_b_l_e_scan_results =
[
[ "begin", "class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0", null ],
[ "dump", "class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4", null ],
[ "end", "class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200", null ],
[ "getCount", "class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a", null ],
[ "getDevice", "class_nim_b_l_e_scan_results.html#ac2356f6c1b8384ebc061d4b7953a9374", null ],
[ "getDevice", "class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500", null ]
];

View File

@@ -0,0 +1,107 @@
<!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: Member List</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_security.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">NimBLESecurity Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">setAuthenticationMode</a>(esp_ble_auth_req_t auth_req)</td><td class="entry"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">setCapability</a>(esp_ble_io_cap_t iocap)</td><td class="entry"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">setInitEncryptionKey</a>(uint8_t init_key)</td><td class="entry"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b">setKeySize</a>(uint8_t key_size=16)</td><td class="entry"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">setRespEncryptionKey</a>(uint8_t resp_key)</td><td class="entry"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">setStaticPIN</a>(uint32_t pin)</td><td class="entry"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>

View File

@@ -0,0 +1,311 @@
<!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: NimBLESecurity Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_security.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_security-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLESecurity Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class to handle BLE security operations. <b>Deprecated - provided for backward compatibility only.</b>
<a href="class_nim_b_l_e_security.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5cf0d3672a16f557032bcbf39a9e22f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">setAuthenticationMode</a> (esp_ble_auth_req_t auth_req)</td></tr>
<tr class="memdesc:a5cf0d3672a16f557032bcbf39a9e22f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set requested authentication mode. <a href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">More...</a><br /></td></tr>
<tr class="separator:a5cf0d3672a16f557032bcbf39a9e22f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bb7902d5ceffaca86bd7638a74e35e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">setCapability</a> (esp_ble_io_cap_t iocap)</td></tr>
<tr class="memdesc:a1bb7902d5ceffaca86bd7638a74e35e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set our device IO capability to let end user perform authorization either by displaying or entering generated 6-digit pin code or use "just works". <a href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">More...</a><br /></td></tr>
<tr class="separator:a1bb7902d5ceffaca86bd7638a74e35e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc3caa3e1a5aedc3be5c0f1dc5c99ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">setInitEncryptionKey</a> (uint8_t init_key)</td></tr>
<tr class="memdesc:adfc3caa3e1a5aedc3be5c0f1dc5c99ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the keys we will distibute during encryption. <a href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">More...</a><br /></td></tr>
<tr class="separator:adfc3caa3e1a5aedc3be5c0f1dc5c99ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac8434faa02a6813b7efd87224e04714"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">setRespEncryptionKey</a> (uint8_t resp_key)</td></tr>
<tr class="memdesc:aac8434faa02a6813b7efd87224e04714"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the keys we will accept during encryption. <a href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">More...</a><br /></td></tr>
<tr class="separator:aac8434faa02a6813b7efd87224e04714"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2be50284a325ec8937abdab0baafd4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b">setKeySize</a> (uint8_t key_size=16)</td></tr>
<tr class="separator:ab2be50284a325ec8937abdab0baafd4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bb1535e1b0d48566c17f681b7539f82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">setStaticPIN</a> (uint32_t pin)</td></tr>
<tr class="memdesc:a0bb1535e1b0d48566c17f681b7539f82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a static PIN used to authenticate/encrypt the connection. <a href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">More...</a><br /></td></tr>
<tr class="separator:a0bb1535e1b0d48566c17f681b7539f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class to handle BLE security operations. <b>Deprecated - provided for backward compatibility only.</b> </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Use the security methods provided in <a class="el" href="class_nim_b_l_e_device.html" title="A model of a BLE Device from which all the BLE roles are created.">NimBLEDevice</a> instead. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5cf0d3672a16f557032bcbf39a9e22f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cf0d3672a16f557032bcbf39a9e22f2">&#9670;&nbsp;</a></span>setAuthenticationMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLESecurity::setAuthenticationMode </td>
<td>(</td>
<td class="paramtype">esp_ble_auth_req_t&#160;</td>
<td class="paramname"><em>auth_req</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set requested authentication mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">auth_req</td><td>A bitmask containing one or more of:<ul>
<li>ESP_LE_AUTH_NO_BOND 0x00</li>
<li>ESP_LE_AUTH_BOND 0x01</li>
<li>ESP_LE_AUTH_REQ_MITM (1 &lt;&lt; 2)</li>
<li>ESP_LE_AUTH_REQ_BOND_MITM (ESP_LE_AUTH_BOND | ESP_LE_AUTH_REQ_MITM)</li>
<li>ESP_LE_AUTH_REQ_SC_ONLY (1 &lt;&lt; 3)</li>
<li>ESP_LE_AUTH_REQ_SC_BOND (ESP_LE_AUTH_BOND | ESP_LE_AUTH_REQ_SC_ONLY)</li>
<li>ESP_LE_AUTH_REQ_SC_MITM (ESP_LE_AUTH_REQ_MITM | ESP_LE_AUTH_REQ_SC_ONLY)</li>
<li>ESP_LE_AUTH_REQ_SC_MITM_BOND (ESP_LE_AUTH_REQ_MITM | ESP_LE_AUTH_REQ_SC_ONLY | ESP_LE_AUTH_BOND) </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1bb7902d5ceffaca86bd7638a74e35e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bb7902d5ceffaca86bd7638a74e35e3">&#9670;&nbsp;</a></span>setCapability()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLESecurity::setCapability </td>
<td>(</td>
<td class="paramtype">esp_ble_io_cap_t&#160;</td>
<td class="paramname"><em>iocap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set our device IO capability to let end user perform authorization either by displaying or entering generated 6-digit pin code or use "just works". </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">iocap</td><td>The IO capabilites our device has.<br />
Can be set to one of:<ul>
<li>ESP_IO_CAP_OUT 0</li>
<li>ESP_IO_CAP_IO 1</li>
<li>ESP_IO_CAP_IN 2</li>
<li>ESP_IO_CAP_NONE 3</li>
<li>ESP_IO_CAP_KBDISP 4 </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adfc3caa3e1a5aedc3be5c0f1dc5c99ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">&#9670;&nbsp;</a></span>setInitEncryptionKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLESecurity::setInitEncryptionKey </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>init_key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the keys we will distibute during encryption. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">init_key</td><td>A bitmask of the keys we will distibute.<br />
Can be one or more of:<ul>
<li>ESP_BLE_ENC_KEY_MASK (1 &lt;&lt; 0)</li>
<li>ESP_BLE_ID_KEY_MASK (1 &lt;&lt; 1)</li>
<li>ESP_BLE_CSR_KEY_MASK (1 &lt;&lt; 2)</li>
<li>ESP_BLE_LINK_KEY_MASK (1 &lt;&lt; 3) </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab2be50284a325ec8937abdab0baafd4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2be50284a325ec8937abdab0baafd4b">&#9670;&nbsp;</a></span>setKeySize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLESecurity::setKeySize </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>key_size</em> = <code>16</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Requires implementation </dd></dl>
</div>
</div>
<a id="aac8434faa02a6813b7efd87224e04714"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac8434faa02a6813b7efd87224e04714">&#9670;&nbsp;</a></span>setRespEncryptionKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLESecurity::setRespEncryptionKey </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>resp_key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the keys we will accept during encryption. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">resp_key</td><td>A bitmask of the keys we will accept.<br />
Can be one or more of:<ul>
<li>ESP_BLE_ENC_KEY_MASK (1 &lt;&lt; 0)</li>
<li>ESP_BLE_ID_KEY_MASK (1 &lt;&lt; 1)</li>
<li>ESP_BLE_CSR_KEY_MASK (1 &lt;&lt; 2)</li>
<li>ESP_BLE_LINK_KEY_MASK (1 &lt;&lt; 3) </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0bb1535e1b0d48566c17f681b7539f82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bb1535e1b0d48566c17f681b7539f82">&#9670;&nbsp;</a></span>setStaticPIN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLESecurity::setStaticPIN </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>pin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a static PIN used to authenticate/encrypt the connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>The 6 digit pin code to accept. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_security.html">NimBLESecurity</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>

View File

@@ -0,0 +1,9 @@
var class_nim_b_l_e_security =
[
[ "setAuthenticationMode", "class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2", null ],
[ "setCapability", "class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3", null ],
[ "setInitEncryptionKey", "class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac", null ],
[ "setKeySize", "class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b", null ],
[ "setRespEncryptionKey", "class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714", null ],
[ "setStaticPIN", "class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82", null ]
];

Some files were not shown because too many files have changed in this diff Show More