mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
1071 lines
61 KiB
HTML
1071 lines
61 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.9.0"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>esp-nimble-cpp / NimBLE-Arduino: NimBLERemoteCharacteristic 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
|
||
|
|
 <span id="projectnumber">1.3.1</span>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.0 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(document).ready(function(){initNavTree('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="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="class_nim_b_l_e_remote_characteristic-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">NimBLERemoteCharacteristic Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>A model of a remote BLE characteristic.
|
||
|
|
<a href="class_nim_b_l_e_remote_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:a855d591de111b09013ae83c4043d06ed"><td class="memItemLeft" align="right" valign="top"><a id="a855d591de111b09013ae83c4043d06ed"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a855d591de111b09013ae83c4043d06ed">~NimBLERemoteCharacteristic</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a855d591de111b09013ae83c4043d06ed"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
||
|
|
<tr class="separator:a855d591de111b09013ae83c4043d06ed"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7163009a9f0ff718b5856d19cb4a3568"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7163009a9f0ff718b5856d19cb4a3568">canBroadcast</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a7163009a9f0ff718b5856d19cb4a3568"><td class="mdescLeft"> </td><td class="mdescRight">Does the characteristic support broadcasting? <a href="class_nim_b_l_e_remote_characteristic.html#a7163009a9f0ff718b5856d19cb4a3568">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a7163009a9f0ff718b5856d19cb4a3568"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a53322384b295a2548b3399e2c63d76f4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a53322384b295a2548b3399e2c63d76f4">canIndicate</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a53322384b295a2548b3399e2c63d76f4"><td class="mdescLeft"> </td><td class="mdescRight">Does the characteristic support indications? <a href="class_nim_b_l_e_remote_characteristic.html#a53322384b295a2548b3399e2c63d76f4">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a53322384b295a2548b3399e2c63d76f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9c41acdbf23dc036f321d4f0a66d40d1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a9c41acdbf23dc036f321d4f0a66d40d1">canNotify</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a9c41acdbf23dc036f321d4f0a66d40d1"><td class="mdescLeft"> </td><td class="mdescRight">Does the characteristic support notifications? <a href="class_nim_b_l_e_remote_characteristic.html#a9c41acdbf23dc036f321d4f0a66d40d1">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a9c41acdbf23dc036f321d4f0a66d40d1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0eb6655635394268a76c68e845d14135"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a0eb6655635394268a76c68e845d14135">canRead</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a0eb6655635394268a76c68e845d14135"><td class="mdescLeft"> </td><td class="mdescRight">Does the characteristic support reading? <a href="class_nim_b_l_e_remote_characteristic.html#a0eb6655635394268a76c68e845d14135">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a0eb6655635394268a76c68e845d14135"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aae71c20d300ead52770e66fb8a1a47ea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aae71c20d300ead52770e66fb8a1a47ea">canWrite</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:aae71c20d300ead52770e66fb8a1a47ea"><td class="mdescLeft"> </td><td class="mdescRight">Does the characteristic support writing? <a href="class_nim_b_l_e_remote_characteristic.html#aae71c20d300ead52770e66fb8a1a47ea">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aae71c20d300ead52770e66fb8a1a47ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2614c7f437b52f385fc4fd29abe358eb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a2614c7f437b52f385fc4fd29abe358eb">canWriteNoResponse</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a2614c7f437b52f385fc4fd29abe358eb"><td class="mdescLeft"> </td><td class="mdescRight">Does the characteristic support writing with no response? <a href="class_nim_b_l_e_remote_characteristic.html#a2614c7f437b52f385fc4fd29abe358eb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a2614c7f437b52f385fc4fd29abe358eb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a78ac88ca25d71dfe31b95898b79b0442"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442">begin</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a78ac88ca25d71dfe31b95898b79b0442"><td class="mdescLeft"> </td><td class="mdescRight">Get iterator to the beginning of the vector of remote descriptor pointers. <a href="class_nim_b_l_e_remote_characteristic.html#a78ac88ca25d71dfe31b95898b79b0442">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a78ac88ca25d71dfe31b95898b79b0442"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a333adea9c9f243774c6a2f13beabd873"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873">end</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a333adea9c9f243774c6a2f13beabd873"><td class="mdescLeft"> </td><td class="mdescRight">Get iterator to the end of the vector of remote descriptor pointers. <a href="class_nim_b_l_e_remote_characteristic.html#a333adea9c9f243774c6a2f13beabd873">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a333adea9c9f243774c6a2f13beabd873"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6178e1c58361b957be3c48548c1c4366"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a6178e1c58361b957be3c48548c1c4366">getDescriptor</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid)</td></tr>
|
||
|
|
<tr class="memdesc:a6178e1c58361b957be3c48548c1c4366"><td class="mdescLeft"> </td><td class="mdescRight">Get the descriptor instance with the given UUID that belongs to this characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#a6178e1c58361b957be3c48548c1c4366">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a6178e1c58361b957be3c48548c1c4366"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acf11d225fe5a25327742349e9d6061f9"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#acf11d225fe5a25327742349e9d6061f9">getDescriptors</a> (bool refresh=false)</td></tr>
|
||
|
|
<tr class="memdesc:acf11d225fe5a25327742349e9d6061f9"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the vector of found descriptors. <a href="class_nim_b_l_e_remote_characteristic.html#acf11d225fe5a25327742349e9d6061f9">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:acf11d225fe5a25327742349e9d6061f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5f0a51b4a7fb2244d236dcb96fcf5205"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a5f0a51b4a7fb2244d236dcb96fcf5205">deleteDescriptors</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a5f0a51b4a7fb2244d236dcb96fcf5205"><td class="mdescLeft"> </td><td class="mdescRight">Delete the descriptors in the descriptor vector. <a href="class_nim_b_l_e_remote_characteristic.html#a5f0a51b4a7fb2244d236dcb96fcf5205">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a5f0a51b4a7fb2244d236dcb96fcf5205"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aad0ba99cad9779b33ea7cd4e94349099"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aad0ba99cad9779b33ea7cd4e94349099">deleteDescriptor</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid)</td></tr>
|
||
|
|
<tr class="memdesc:aad0ba99cad9779b33ea7cd4e94349099"><td class="mdescLeft"> </td><td class="mdescRight">Delete descriptor by UUID. <a href="class_nim_b_l_e_remote_characteristic.html#aad0ba99cad9779b33ea7cd4e94349099">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aad0ba99cad9779b33ea7cd4e94349099"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab46121a8f5000c40d521e7ee5d92bee6"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6">getHandle</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ab46121a8f5000c40d521e7ee5d92bee6"><td class="mdescLeft"> </td><td class="mdescRight">Get the handle for this characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#ab46121a8f5000c40d521e7ee5d92bee6">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ab46121a8f5000c40d521e7ee5d92bee6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aebbcd36740e49d7e29eb5b21d6802380"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380">getDefHandle</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:aebbcd36740e49d7e29eb5b21d6802380"><td class="mdescLeft"> </td><td class="mdescRight">Get the handle for this characteristics definition. <a href="class_nim_b_l_e_remote_characteristic.html#aebbcd36740e49d7e29eb5b21d6802380">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aebbcd36740e49d7e29eb5b21d6802380"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad62c63468995a24d736c4176c9607eeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb">getUUID</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ad62c63468995a24d736c4176c9607eeb"><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID for this characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#ad62c63468995a24d736c4176c9607eeb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ad62c63468995a24d736c4176c9607eeb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7e10fa37095d7c80dc36c768fe783e67"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a> (time_t *timestamp=nullptr)</td></tr>
|
||
|
|
<tr class="memdesc:a7e10fa37095d7c80dc36c768fe783e67"><td class="mdescLeft"> </td><td class="mdescRight">Read the value of the remote characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a7e10fa37095d7c80dc36c768fe783e67"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a463760cabc9ca104a6fe094eb942fec0"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||
|
|
<tr class="memitem:a463760cabc9ca104a6fe094eb942fec0"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0">readValue</a> (time_t *timestamp=nullptr, bool skipSizeCheck=false)</td></tr>
|
||
|
|
<tr class="memdesc:a463760cabc9ca104a6fe094eb942fec0"><td class="mdescLeft"> </td><td class="mdescRight">A template to convert the remote characteristic data to <type>. <a href="class_nim_b_l_e_remote_characteristic.html#a463760cabc9ca104a6fe094eb942fec0">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a463760cabc9ca104a6fe094eb942fec0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ade5c6ae280c3cf36c9905be23df8f080"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080">readUInt8</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a><uint8_t>()")))</td></tr>
|
||
|
|
<tr class="memdesc:ade5c6ae280c3cf36c9905be23df8f080"><td class="mdescLeft"> </td><td class="mdescRight">Read a byte value. <a href="class_nim_b_l_e_remote_characteristic.html#ade5c6ae280c3cf36c9905be23df8f080">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ade5c6ae280c3cf36c9905be23df8f080"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a181c54862bc422d8ad0b326af675922d"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d">readUInt16</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a><uint16_t>()")))</td></tr>
|
||
|
|
<tr class="memdesc:a181c54862bc422d8ad0b326af675922d"><td class="mdescLeft"> </td><td class="mdescRight">Read an unsigned 16 bit value. <a href="class_nim_b_l_e_remote_characteristic.html#a181c54862bc422d8ad0b326af675922d">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a181c54862bc422d8ad0b326af675922d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a71793454ffab034f87af3a5e9677a63d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d">readUInt32</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a><uint32_t>()")))</td></tr>
|
||
|
|
<tr class="memdesc:a71793454ffab034f87af3a5e9677a63d"><td class="mdescLeft"> </td><td class="mdescRight">Read an unsigned 32 bit value. <a href="class_nim_b_l_e_remote_characteristic.html#a71793454ffab034f87af3a5e9677a63d">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a71793454ffab034f87af3a5e9677a63d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a81f39759d48a8fb792c94e4b3b455eef"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef">readFloat</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67">readValue</a><float>()")))</td></tr>
|
||
|
|
<tr class="memdesc:a81f39759d48a8fb792c94e4b3b455eef"><td class="mdescLeft"> </td><td class="mdescRight">Read a float value. <a href="class_nim_b_l_e_remote_characteristic.html#a81f39759d48a8fb792c94e4b3b455eef">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a81f39759d48a8fb792c94e4b3b455eef"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:add1a1daed14b5f3e729e284dbd369257"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">getValue</a> (time_t *timestamp=nullptr)</td></tr>
|
||
|
|
<tr class="memdesc:add1a1daed14b5f3e729e284dbd369257"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the remote characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#add1a1daed14b5f3e729e284dbd369257">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:add1a1daed14b5f3e729e284dbd369257"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a74ad8484cbc88d8eb36d4684233c538b"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||
|
|
<tr class="memitem:a74ad8484cbc88d8eb36d4684233c538b"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b">getValue</a> (time_t *timestamp=nullptr, bool skipSizeCheck=false)</td></tr>
|
||
|
|
<tr class="memdesc:a74ad8484cbc88d8eb36d4684233c538b"><td class="mdescLeft"> </td><td class="mdescRight">A template to convert the remote characteristic data to <type>. <a href="class_nim_b_l_e_remote_characteristic.html#a74ad8484cbc88d8eb36d4684233c538b">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a74ad8484cbc88d8eb36d4684233c538b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa08b2f62376568e1fc833e4ff91e8aa7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><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></tr>
|
||
|
|
<tr class="memdesc:aa08b2f62376568e1fc833e4ff91e8aa7"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe for notifications or indications. <a href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aa08b2f62376568e1fc833e4ff91e8aa7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6e331afdbdbc32bf461c9866236a97aa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">unsubscribe</a> (bool response=false)</td></tr>
|
||
|
|
<tr class="memdesc:a6e331afdbdbc32bf461c9866236a97aa"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe for notifications or indications. <a href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a6e331afdbdbc32bf461c9866236a97aa"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab4f54eabe90a416546b7b3fc3477f49c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><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("Use <a class="el" href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7">subscribe</a>()/<a class="el" href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa">unsubscribe</a>()")))</td></tr>
|
||
|
|
<tr class="memdesc:ab4f54eabe90a416546b7b3fc3477f49c"><td class="mdescLeft"> </td><td class="mdescRight">backward-compatibility method for subscribe/unsubscribe notifications/indications <a href="class_nim_b_l_e_remote_characteristic.html#ab4f54eabe90a416546b7b3fc3477f49c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ab4f54eabe90a416546b7b3fc3477f49c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3c8d1fd77dd074df866c091c614eafb3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><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></tr>
|
||
|
|
<tr class="memdesc:a3c8d1fd77dd074df866c091c614eafb3"><td class="mdescLeft"> </td><td class="mdescRight">Write the new value for the characteristic from a data buffer. <a href="class_nim_b_l_e_remote_characteristic.html#a3c8d1fd77dd074df866c091c614eafb3">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a3c8d1fd77dd074df866c091c614eafb3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2cfc2e8d2e281dd61e578eb5e860fc02"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a2cfc2e8d2e281dd61e578eb5e860fc02">writeValue</a> (const std::string &newValue, bool response=false)</td></tr>
|
||
|
|
<tr class="memdesc:a2cfc2e8d2e281dd61e578eb5e860fc02"><td class="mdescLeft"> </td><td class="mdescRight">Write the new value for the characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#a2cfc2e8d2e281dd61e578eb5e860fc02">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a2cfc2e8d2e281dd61e578eb5e860fc02"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acf8bcf2cf94ca8bd8cf0c7c39f9883ae"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||
|
|
<tr class="memitem:acf8bcf2cf94ca8bd8cf0c7c39f9883ae"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">writeValue</a> (const T &s, bool response=false)</td></tr>
|
||
|
|
<tr class="memdesc:acf8bcf2cf94ca8bd8cf0c7c39f9883ae"><td class="mdescLeft"> </td><td class="mdescRight">Convenience template to set the remote characteristic value to <type>val. <a href="class_nim_b_l_e_remote_characteristic.html#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:acf8bcf2cf94ca8bd8cf0c7c39f9883ae"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4b86a1f600a61036487f5161f1f1726a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a">toString</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a4b86a1f600a61036487f5161f1f1726a"><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="class_nim_b_l_e_remote_characteristic.html" title="A model of a remote BLE characteristic.">NimBLERemoteCharacteristic</a> to a string representation;. <a href="class_nim_b_l_e_remote_characteristic.html#a4b86a1f600a61036487f5161f1f1726a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a4b86a1f600a61036487f5161f1f1726a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a943183a55b020de9e09ac2cfaebcde32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_characteristic.html#a943183a55b020de9e09ac2cfaebcde32">getRemoteService</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a943183a55b020de9e09ac2cfaebcde32"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote service associated with this characteristic. <a href="class_nim_b_l_e_remote_characteristic.html#a943183a55b020de9e09ac2cfaebcde32">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a943183a55b020de9e09ac2cfaebcde32"><td class="memSeparator" colspan="2"> </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 characteristic. </p>
|
||
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a78ac88ca25d71dfe31b95898b79b0442"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78ac88ca25d71dfe31b95898b79b0442">◆ </a></span>begin()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::vector< <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * >::iterator NimBLERemoteCharacteristic::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 descriptor pointers. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the beginning of the vector of remote descriptor pointers. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7163009a9f0ff718b5856d19cb4a3568"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7163009a9f0ff718b5856d19cb4a3568">◆ </a></span>canBroadcast()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::canBroadcast </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Does the characteristic support broadcasting? </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the characteristic supports broadcasting. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a53322384b295a2548b3399e2c63d76f4"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53322384b295a2548b3399e2c63d76f4">◆ </a></span>canIndicate()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::canIndicate </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Does the characteristic support indications? </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the characteristic supports indications. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9c41acdbf23dc036f321d4f0a66d40d1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c41acdbf23dc036f321d4f0a66d40d1">◆ </a></span>canNotify()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::canNotify </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Does the characteristic support notifications? </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the characteristic supports notifications. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a0eb6655635394268a76c68e845d14135"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0eb6655635394268a76c68e845d14135">◆ </a></span>canRead()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::canRead </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Does the characteristic support reading? </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the characteristic supports reading. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aae71c20d300ead52770e66fb8a1a47ea"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae71c20d300ead52770e66fb8a1a47ea">◆ </a></span>canWrite()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::canWrite </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Does the characteristic support writing? </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the characteristic supports writing. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a2614c7f437b52f385fc4fd29abe358eb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2614c7f437b52f385fc4fd29abe358eb">◆ </a></span>canWriteNoResponse()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::canWriteNoResponse </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Does the characteristic support writing with no response? </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the characteristic supports writing with no response. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aad0ba99cad9779b33ea7cd4e94349099"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad0ba99cad9779b33ea7cd4e94349099">◆ </a></span>deleteDescriptor()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t NimBLERemoteCharacteristic::deleteDescriptor </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td>
|
||
|
|
<td class="paramname"><em>uuid</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Delete descriptor 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 descriptor to be deleted. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of descriptors left in the vector. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a5f0a51b4a7fb2244d236dcb96fcf5205"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f0a51b4a7fb2244d236dcb96fcf5205">◆ </a></span>deleteDescriptors()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void NimBLERemoteCharacteristic::deleteDescriptors </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Delete the descriptors in the descriptor vector. </p>
|
||
|
|
<p>We maintain a vector called m_descriptorVector that contains pointers to NimBLERemoteDescriptors 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="a333adea9c9f243774c6a2f13beabd873"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a333adea9c9f243774c6a2f13beabd873">◆ </a></span>end()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::vector< <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * >::iterator NimBLERemoteCharacteristic::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 descriptor pointers. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the end of the vector of remote descriptor pointers. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aebbcd36740e49d7e29eb5b21d6802380"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebbcd36740e49d7e29eb5b21d6802380">◆ </a></span>getDefHandle()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t NimBLERemoteCharacteristic::getDefHandle </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the handle for this characteristics definition. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The handle for this characteristic definition. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6178e1c58361b957be3c48548c1c4366"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6178e1c58361b957be3c48548c1c4366">◆ </a></span>getDescriptor()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * NimBLERemoteCharacteristic::getDescriptor </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td>
|
||
|
|
<td class="paramname"><em>uuid</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the descriptor instance with the given UUID that belongs to 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 to find. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The Remote descriptor (if present) or null if not present. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="acf11d225fe5a25327742349e9d6061f9"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf11d225fe5a25327742349e9d6061f9">◆ </a></span>getDescriptors()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::vector< <a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a> * > * NimBLERemoteCharacteristic::getDescriptors </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">bool </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 descriptors. </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 descriptor vector will be cleared and<br />
|
||
|
|
all descriptors for this characteristic retrieved from the peripheral.<br />
|
||
|
|
If false the vector will be returned with the currently stored descriptors of this characteristic. </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="ab46121a8f5000c40d521e7ee5d92bee6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab46121a8f5000c40d521e7ee5d92bee6">◆ </a></span>getHandle()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t NimBLERemoteCharacteristic::getHandle </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the handle for this characteristic. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The handle for this characteristic. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a943183a55b020de9e09ac2cfaebcde32"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a943183a55b020de9e09ac2cfaebcde32">◆ </a></span>getRemoteService()</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> * NimBLERemoteCharacteristic::getRemoteService </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the remote service associated with this characteristic. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The remote service associated with this characteristic. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad62c63468995a24d736c4176c9607eeb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad62c63468995a24d736c4176c9607eeb">◆ </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> NimBLERemoteCharacteristic::getUUID </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the UUID for this characteristic. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The UUID for this characteristic. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="add1a1daed14b5f3e729e284dbd369257"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add1a1daed14b5f3e729e284dbd369257">◆ </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 NimBLERemoteCharacteristic::getValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">time_t * </td>
|
||
|
|
<td class="paramname"><em>timestamp</em> = <code>nullptr</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the value of the remote characteristic. </p>
|
||
|
|
<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>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value of the remote characteristic. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a74ad8484cbc88d8eb36d4684233c538b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74ad8484cbc88d8eb36d4684233c538b">◆ </a></span>getValue() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<div class="memtemplate">
|
||
|
|
template<typename T > </div>
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">T NimBLERemoteCharacteristic::getValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">time_t * </td>
|
||
|
|
<td class="paramname"><em>timestamp</em> = <code>nullptr</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code> </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 remote characteristic data to <type>. </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(<type>)</code>. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The data converted to <type> or NULL if skipSizeCheck is false and the data is less than <code>sizeof(<type>)</code>.</dd></dl>
|
||
|
|
<p><b>Use:</b> <code>getValue<type>(&timestamp, skipSizeCheck);</code> </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a81f39759d48a8fb792c94e4b3b455eef"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81f39759d48a8fb792c94e4b3b455eef">◆ </a></span>readFloat()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float NimBLERemoteCharacteristic::readFloat </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Read a float value. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>the float value. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a181c54862bc422d8ad0b326af675922d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a181c54862bc422d8ad0b326af675922d">◆ </a></span>readUInt16()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t NimBLERemoteCharacteristic::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#_deprecated000004">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67" title="Read the value of the remote characteristic.">readValue<uint16_t>()</a>. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a71793454ffab034f87af3a5e9677a63d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71793454ffab034f87af3a5e9677a63d">◆ </a></span>readUInt32()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint32_t NimBLERemoteCharacteristic::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#_deprecated000005">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67" title="Read the value of the remote characteristic.">readValue<uint32_t>()</a>. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ade5c6ae280c3cf36c9905be23df8f080"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade5c6ae280c3cf36c9905be23df8f080">◆ </a></span>readUInt8()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t NimBLERemoteCharacteristic::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#_deprecated000006">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a7e10fa37095d7c80dc36c768fe783e67" title="Read the value of the remote characteristic.">readValue<uint8_t>()</a>. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7e10fa37095d7c80dc36c768fe783e67"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e10fa37095d7c80dc36c768fe783e67">◆ </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 NimBLERemoteCharacteristic::readValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">time_t * </td>
|
||
|
|
<td class="paramname"><em>timestamp</em> = <code>nullptr</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Read the value of the remote characteristic. </p>
|
||
|
|
<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>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value of the remote characteristic. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a463760cabc9ca104a6fe094eb942fec0"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a463760cabc9ca104a6fe094eb942fec0">◆ </a></span>readValue() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<div class="memtemplate">
|
||
|
|
template<typename T > </div>
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">T NimBLERemoteCharacteristic::readValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">time_t * </td>
|
||
|
|
<td class="paramname"><em>timestamp</em> = <code>nullptr</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code> </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 remote characteristic data to <type>. </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(<type>)</code>. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The data converted to <type> or NULL if skipSizeCheck is false and the data is less than <code>sizeof(<type>)</code>.</dd></dl>
|
||
|
|
<p><b>Use:</b> <code>readValue<type>(&timestamp, skipSizeCheck);</code> </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ab4f54eabe90a416546b7b3fc3477f49c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4f54eabe90a416546b7b3fc3477f49c">◆ </a></span>registerForNotify()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::registerForNotify </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">notify_callback </td>
|
||
|
|
<td class="paramname"><em>notifyCallback</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>notifications</em> = <code>true</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>response</em> = <code>true</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>backward-compatibility method for subscribe/unsubscribe notifications/indications </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">notifyCallback</td><td>A callback to be invoked for a notification. If NULL is provided then we will unregister for notifications. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">notifications</td><td>If true, register for notifications, false register for indications. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>If true, require a write response from the descriptor write operation. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>true if successful. </dd></dl>
|
||
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_characteristic.html#aa08b2f62376568e1fc833e4ff91e8aa7" title="Subscribe for notifications or indications.">subscribe()</a> / <a class="el" href="class_nim_b_l_e_remote_characteristic.html#a6e331afdbdbc32bf461c9866236a97aa" title="Unsubscribe for notifications or indications.">unsubscribe()</a> instead. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aa08b2f62376568e1fc833e4ff91e8aa7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa08b2f62376568e1fc833e4ff91e8aa7">◆ </a></span>subscribe()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::subscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>notifications</em> = <code>true</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">notify_callback </td>
|
||
|
|
<td class="paramname"><em>notifyCallback</em> = <code>nullptr</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>response</em> = <code>false</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Subscribe for notifications or indications. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">notifications</td><td>If true, subscribe for notifications, false subscribe for indications. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">notifyCallback</td><td>A callback to be invoked for a notification. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>If true, require a write response from the descriptor write operation. If NULL is provided then no callback is performed. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>false if writing to the descriptor failed. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a4b86a1f600a61036487f5161f1f1726a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b86a1f600a61036487f5161f1f1726a">◆ </a></span>toString()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::string NimBLERemoteCharacteristic::toString </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Convert a <a class="el" href="class_nim_b_l_e_remote_characteristic.html" title="A model of a remote BLE characteristic.">NimBLERemoteCharacteristic</a> to a string representation;. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>a String representation. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6e331afdbdbc32bf461c9866236a97aa"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e331afdbdbc32bf461c9866236a97aa">◆ </a></span>unsubscribe()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::unsubscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>response</em> = <code>false</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unsubscribe for notifications or indications. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>bool if true, require a write response from the descriptor write operation. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>false if writing to the descriptor failed. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a2cfc2e8d2e281dd61e578eb5e860fc02"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2cfc2e8d2e281dd61e578eb5e860fc02">◆ </a></span>writeValue() <span class="overload">[1/3]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::writeValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::string & </td>
|
||
|
|
<td class="paramname"><em>newValue</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>response</em> = <code>false</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Write the new value for the characteristic. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">newValue</td><td>The new value to write. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>Do we expect a response? </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>false if not connected or cant perform write for some reason. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="acf8bcf2cf94ca8bd8cf0c7c39f9883ae"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf8bcf2cf94ca8bd8cf0c7c39f9883ae">◆ </a></span>writeValue() <span class="overload">[2/3]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<div class="memtemplate">
|
||
|
|
template<typename T > </div>
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::writeValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const T & </td>
|
||
|
|
<td class="paramname"><em>s</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>response</em> = <code>false</code> </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 characteristic value to <type>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="a3c8d1fd77dd074df866c091c614eafb3"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c8d1fd77dd074df866c091c614eafb3">◆ </a></span>writeValue() <span class="overload">[3/3]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool NimBLERemoteCharacteristic::writeValue </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const uint8_t * </td>
|
||
|
|
<td class="paramname"><em>data</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>length</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>response</em> = <code>false</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Write the new value for the characteristic from a data buffer. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to a data buffer. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data in the data buffer. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>Whether we require a response from the write. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>false if not connected or cant perform write for some reason. </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_characteristic.html">NimBLERemoteCharacteristic</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>
|