mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
296 lines
53 KiB
HTML
296 lines
53 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>esp-nimble-cpp: /github/workspace/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
|
|
 <span id="projectnumber">1.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_nim_b_l_e_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> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * NimBLERemoteCharacteristic.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Created: on Jan 27 2020</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author H2zero</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Originally:</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * BLERemoteCharacteristic.h</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Created on: Jul 8, 2017</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Author: kolban</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef COMPONENTS_NIMBLEREMOTECHARACTERISTIC_H_</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define COMPONENTS_NIMBLEREMOTECHARACTERISTIC_H_</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="nimconfig_8h.html">nimconfig.h</a>"</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "NimBLERemoteService.h"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "NimBLERemoteDescriptor.h"</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "NimBLELog.h"</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</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="l00029"></a><span class="lineno"> 29</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="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">typedef</span> std::function<void (<a class="code" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* pBLERemoteCharacteristic,</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  uint8_t* pData, <span class="keywordtype">size_t</span> length, <span class="keywordtype">bool</span> isNotify)> notify_callback;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <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="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> *task_data;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> } desc_filter_t;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html"> 44</a></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="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a855d591de111b09013ae83c4043d06ed">~NimBLERemoteCharacteristic</a>();</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Public member functions</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <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="l00050"></a><span class="lineno"> 50</span>  <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="l00051"></a><span class="lineno"> 51</span>  <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="l00052"></a><span class="lineno"> 52</span>  <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="l00053"></a><span class="lineno"> 53</span>  <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="l00054"></a><span class="lineno"> 54</span>  <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="l00055"></a><span class="lineno"> 55</span>  std::vector<NimBLERemoteDescriptor*>::iterator <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442">begin</a>();</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::vector<NimBLERemoteDescriptor*>::iterator <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873">end</a>();</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <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> &uuid);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::vector<NimBLERemoteDescriptor*>* <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="l00059"></a><span class="lineno"> 59</span>  <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="l00060"></a><span class="lineno"> 60</span>  <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> &uuid);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  uint16_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6">getHandle</a>();</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uint16_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380">getDefHandle</a>();</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</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_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb">getUUID</a>();</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a417bb44d000758535253488f4d77774a">readValue</a>(time_t *timestamp = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::string <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a">toString</a>();</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <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="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  uint8_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080">readUInt8</a>() __attribute__ ((deprecated(<span class="stringliteral">"Use template readValue<uint8_t>()"</span>)));</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  uint16_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d">readUInt16</a>() __attribute__ ((deprecated(<span class="stringliteral">"Use template readValue<uint16_t>()"</span>)));</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  uint32_t <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d">readUInt32</a>() __attribute__ ((deprecated(<span class="stringliteral">"Use template readValue<uint32_t>()"</span>)));</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">float</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef">readFloat</a>() __attribute__ ((deprecated(<span class="stringliteral">"Use template readValue<float>()"</span>)));</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a6d0779ffe7e89449121428e7fd6083d8">getValue</a>(time_t *timestamp = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">subscribe</a>(<span class="keywordtype">bool</span> notifications = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  notify_callback notifyCallback = <span class="keyword">nullptr</span>,</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <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="l00078"></a><span class="lineno"> 78</span>  <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="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> notifications = <span class="keyword">true</span>,</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> response = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  __attribute__ ((deprecated(<span class="stringliteral">"Use subscribe()/unsubscribe()"</span>)));</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(<span class="keyword">const</span> uint8_t* data,</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">size_t</span> length,</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(<span class="keyword">const</span> std::vector<uint8_t>& v, <span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* s, <span class="keywordtype">bool</span> response = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /*********************** Template Functions ************************/</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#ifdef _DOXYGEN_</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">typename</span> std::enable_if<!std::is_array<T>::value && !Has_c_str_len<T>::value, <span class="keywordtype">bool</span>>::type</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae"> 103</a></span>  <a class="code" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">writeValue</a>(<span class="keyword">const</span> T& s, <span class="keywordtype">bool</span> response = <span class="keyword">false</span>) {</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">return</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>((uint8_t*)&s, <span class="keyword">sizeof</span>(T), response);</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#ifdef _DOXYGEN_</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">typename</span> std::enable_if<Has_c_str_len<T>::value, <span class="keywordtype">bool</span>>::type</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae"> 119</a></span>  <a class="code" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">writeValue</a>(<span class="keyword">const</span> T& s, <span class="keywordtype">bool</span> response = <span class="keyword">false</span>) {</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">writeValue</a>((uint8_t*)s.c_str(), s.length(), response);</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b"> 133</a></span>  T <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b">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="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">if</span>(!skipSizeCheck && m_value.<a class="code" href="class_nim_b_l_e_att_value.html#aa8c75101d9898c3ff4646d84521ed61c">size</a>() < <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">return</span> *((T *)m_value.<a class="code" href="class_nim_b_l_e_att_value.html#a60fb3dc7057d4ec800c3ef6fd2480a69">getValue</a>(timestamp));</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0"> 148</a></span>  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="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> value = <a class="code" href="class_nim_b_l_e_remote_characteristic.html#a417bb44d000758535253488f4d77774a">readValue</a>();</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">if</span>(!skipSizeCheck && value.<a class="code" href="class_nim_b_l_e_att_value.html#aa8c75101d9898c3ff4646d84521ed61c">size</a>() < <span class="keyword">sizeof</span>(T)) <span class="keywordflow">return</span> T();</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">return</span> *((T *)value.<a class="code" href="class_nim_b_l_e_att_value.html#a60fb3dc7057d4ec800c3ef6fd2480a69">getValue</a>(timestamp));</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  }</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <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="l00157"></a><span class="lineno"> 157</span>  </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <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="l00159"></a><span class="lineno"> 159</span>  <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="l00160"></a><span class="lineno"> 160</span>  <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="l00161"></a><span class="lineno"> 161</span>  </div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="comment">// Private member functions</span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <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="l00164"></a><span class="lineno"> 164</span>  <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="l00165"></a><span class="lineno"> 165</span>  <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="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">struct</span> ble_gatt_attr *attr, <span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <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="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">struct</span> ble_gatt_attr *attr, <span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <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="l00170"></a><span class="lineno"> 170</span>  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="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <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="l00173"></a><span class="lineno"> 173</span>  <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="l00174"></a><span class="lineno"> 174</span>  </div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="comment">// Private properties</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid;</div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  uint8_t m_charProp;</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  uint16_t m_handle;</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  uint16_t m_defHandle;</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  uint16_t m_endHandle;</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <a class="code" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* m_pRemoteService;</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <a class="code" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> m_value;</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  notify_callback m_notifyCallback;</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  </div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="comment">// We maintain a vector of descriptors owned by this characteristic.</span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  std::vector<NimBLERemoteDescriptor*> m_descriptorVector;</div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> }; <span class="comment">// NimBLERemoteCharacteristic</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  </div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_CENTRAL */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <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_att_value_html"><div class="ttname"><a href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a></div><div class="ttdoc">A specialized container class to hold BLE attribute values.</div><div class="ttdef"><b>Definition:</b> NimBLEAttValue.h:61</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_att_value_html_a60fb3dc7057d4ec800c3ef6fd2480a69"><div class="ttname"><a href="class_nim_b_l_e_att_value.html#a60fb3dc7057d4ec800c3ef6fd2480a69">NimBLEAttValue::getValue</a></div><div class="ttdeci">const uint8_t * getValue(time_t *timestamp)</div><div class="ttdoc">Get a pointer to the value buffer with timestamp.</div><div class="ttdef"><b>Definition:</b> NimBLEAttValue.h:369</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_att_value_html_aa8c75101d9898c3ff4646d84521ed61c"><div class="ttname"><a href="class_nim_b_l_e_att_value.html#aa8c75101d9898c3ff4646d84521ed61c">NimBLEAttValue::size</a></div><div class="ttdeci">uint16_t size() const</div><div class="ttdoc">Returns the current size of the value in bytes.</div><div class="ttdef"><b>Definition:</b> NimBLEAttValue.h:151</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:39</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:44</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:115</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("Use template readValue<uint16_t>()")))</div><div class="ttdoc">Read an unsigned 16 bit value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:451</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:133</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< NimBLERemoteDescriptor * >::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:392</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 a new value to the remote characteristic from a data buffer.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:764</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a417bb44d000758535253488f4d77774a"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a417bb44d000758535253488f4d77774a">NimBLERemoteCharacteristic::readValue</a></div><div class="ttdeci">NimBLEAttValue 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:490</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">Template to convert the remote characteristic data to <type>.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:148</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:713</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:97</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:676</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 &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:307</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a6d0779ffe7e89449121428e7fd6083d8"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a6d0779ffe7e89449121428e7fd6083d8">NimBLERemoteCharacteristic::getValue</a></div><div class="ttdeci">NimBLEAttValue 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:437</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:645</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:88</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("Use template readValue<uint32_t>()")))</div><div class="ttdoc">Read an unsigned 32 bit value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:461</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a74ad8484cbc88d8eb36d4684233c538b"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b">NimBLERemoteCharacteristic::getValue</a></div><div class="ttdeci">T getValue(time_t *timestamp=nullptr, bool skipSizeCheck=false)</div><div class="ttdoc">Template to convert the remote characteristic data to <type>.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:133</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< NimBLERemoteDescriptor * >::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:383</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("Use template readValue<float>()")))</div><div class="ttdoc">Read a float value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:480</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:69</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:418</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:106</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:631</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 &uuid)</div><div class="ttdoc">Delete descriptor by UUID.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:692</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:124</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:401</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("Use subscribe()/unsubscribe()")))</div><div class="ttdoc">backward-compatibility method for subscribe/unsubscribe notifications/indications</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:659</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< NimBLERemoteDescriptor * > * 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:364</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_acf8bcf2cf94ca8bd8cf0c7c39f9883ae"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">NimBLERemoteCharacteristic::writeValue</a></div><div class="ttdeci">bool writeValue(const T &s, bool response=false)</div><div class="ttdoc">Template to set the remote characteristic value to <type>val.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.h:103</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:427</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("Use template readValue<uint8_t>()")))</div><div class="ttdoc">Read a byte value.</div><div class="ttdef"><b>Definition:</b> NimBLERemoteCharacteristic.cpp:471</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:409</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:27</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:34</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a></div><div class="ttdoc">A model of a BLE UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.h:37</div></div>
|
|
<div 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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|