forked from h2zero/esp-nimble-cpp
deploy: a6ed1933bc
This commit is contained in:
1 parent
73d39b0a88
commit
c47dd827c7
378 files changed
+23543
-22876
No files matched your search
@@ -1,9 +1,9 @@
|
||||
<!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">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.9.1"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>esp-nimble-cpp: NimBLERemoteDescriptor Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -23,10 +23,9 @@
|
||||
<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>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">esp-nimble-cpp<span id="projectnumber"> 2.0.0</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -34,21 +33,22 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.1 -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<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 magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */</script>
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
@@ -62,7 +62,7 @@ $(function() {
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_descriptor.html',''); initResizable(); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
@@ -76,96 +76,47 @@ $(document).ready(function(){initNavTree('class_nim_b_l_e_remote_descriptor.html
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_nim_b_l_e_remote_descriptor-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">NimBLERemoteDescriptor Class Reference</div> </div>
|
||||
<div class="headertitle"><div class="title">NimBLERemoteDescriptor Class Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>A model of remote BLE descriptor.
|
||||
<a href="class_nim_b_l_e_remote_descriptor.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_nim_b_l_e_remote_descriptor_8h_source.html">NimBLERemoteDescriptor.h</a>></code></p>
|
||||
|
||||
<p>Inherits NimBLERemoteValueAttribute.</p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ab8a774ebc69c0fb7ea17f926a82dba21"><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_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">getHandle</a> ()</td></tr>
|
||||
<tr class="memdesc:ab8a774ebc69c0fb7ea17f926a82dba21"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the handle associated with this remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#ab8a774ebc69c0fb7ea17f926a82dba21">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab8a774ebc69c0fb7ea17f926a82dba21"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a529e80c6731f68f3598e015df7618cfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">getRemoteCharacteristic</a> ()</td></tr>
|
||||
<tr class="memdesc:a529e80c6731f68f3598e015df7618cfe"><td class="mdescLeft"> </td><td class="mdescRight">Get the characteristic that owns this descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a529e80c6731f68f3598e015df7618cfe">More...</a><br /></td></tr>
|
||||
<tr class="separator:a529e80c6731f68f3598e015df7618cfe"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ace6b19cd3d9aa8226b4c17371616ad58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">getUUID</a> ()</td></tr>
|
||||
<tr class="memdesc:ace6b19cd3d9aa8226b4c17371616ad58"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the UUID associated this remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#ace6b19cd3d9aa8226b4c17371616ad58">More...</a><br /></td></tr>
|
||||
<tr class="separator:ace6b19cd3d9aa8226b4c17371616ad58"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7c7c07e6ccd969de568b5bda72ec52d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7">readValue</a> ()</td></tr>
|
||||
<tr class="memdesc:a7c7c07e6ccd969de568b5bda72ec52d7"><td class="mdescLeft"> </td><td class="mdescRight">Read the value of the remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7">More...</a><br /></td></tr>
|
||||
<tr class="separator:a7c7c07e6ccd969de568b5bda72ec52d7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab07e86707a91e48f68e9de55686e939b"><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_descriptor.html#ab07e86707a91e48f68e9de55686e939b">readUInt8</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7">readValue</a><uint8_t>()")))</td></tr>
|
||||
<tr class="memdesc:ab07e86707a91e48f68e9de55686e939b"><td class="mdescLeft"> </td><td class="mdescRight">Read a byte value. <a href="class_nim_b_l_e_remote_descriptor.html#ab07e86707a91e48f68e9de55686e939b">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab07e86707a91e48f68e9de55686e939b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a14351ea51b7b04f91b71e388881edd53"><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_descriptor.html#a14351ea51b7b04f91b71e388881edd53">readUInt16</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7">readValue</a><uint16_t>()")))</td></tr>
|
||||
<tr class="memdesc:a14351ea51b7b04f91b71e388881edd53"><td class="mdescLeft"> </td><td class="mdescRight">Read an unsigned 16 bit value. <a href="class_nim_b_l_e_remote_descriptor.html#a14351ea51b7b04f91b71e388881edd53">More...</a><br /></td></tr>
|
||||
<tr class="separator:a14351ea51b7b04f91b71e388881edd53"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a219606f84d63bc02f093051d66f05204"><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_descriptor.html#a219606f84d63bc02f093051d66f05204">readUInt32</a> () __attribute__((deprecated("Use template <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7">readValue</a><uint32_t>()")))</td></tr>
|
||||
<tr class="memdesc:a219606f84d63bc02f093051d66f05204"><td class="mdescLeft"> </td><td class="mdescRight">Read an unsigned 32 bit value. <a href="class_nim_b_l_e_remote_descriptor.html#a219606f84d63bc02f093051d66f05204">More...</a><br /></td></tr>
|
||||
<tr class="separator:a219606f84d63bc02f093051d66f05204"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a008795a09d1fbe8533c2e9d0e8deb33a"><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_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">toString</a> (void)</td></tr>
|
||||
<tr class="memdesc:a008795a09d1fbe8533c2e9d0e8deb33a"><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of this Remote Descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a008795a09d1fbe8533c2e9d0e8deb33a">More...</a><br /></td></tr>
|
||||
<tr class="separator:a008795a09d1fbe8533c2e9d0e8deb33a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0d3fb6424b2c86730e1a292281cd836e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">writeValue</a> (const uint8_t *data, size_t length, bool response=false)</td></tr>
|
||||
<tr class="memdesc:a0d3fb6424b2c86730e1a292281cd836e"><td class="mdescLeft"> </td><td class="mdescRight">Write a new value to a remote descriptor. <a href="class_nim_b_l_e_remote_descriptor.html#a0d3fb6424b2c86730e1a292281cd836e">More...</a><br /></td></tr>
|
||||
<tr class="separator:a0d3fb6424b2c86730e1a292281cd836e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab1654a0b1dc86fe042b3d5b983fbd08c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ab1654a0b1dc86fe042b3d5b983fbd08c">writeValue</a> (const std::vector< uint8_t > &v, bool response=false)</td></tr>
|
||||
<tr class="memdesc:ab1654a0b1dc86fe042b3d5b983fbd08c"><td class="mdescLeft"> </td><td class="mdescRight">Write a new value to a remote descriptor from a std::vector<uint8_t>. <a href="class_nim_b_l_e_remote_descriptor.html#ab1654a0b1dc86fe042b3d5b983fbd08c">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab1654a0b1dc86fe042b3d5b983fbd08c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab7cab188f311f44d06638434117938e7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ab7cab188f311f44d06638434117938e7">writeValue</a> (const char *s, bool response=false)</td></tr>
|
||||
<tr class="memdesc:ab7cab188f311f44d06638434117938e7"><td class="mdescLeft"> </td><td class="mdescRight">Write a new value to the remote descriptor from a const char*. <a href="class_nim_b_l_e_remote_descriptor.html#ab7cab188f311f44d06638434117938e7">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab7cab188f311f44d06638434117938e7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1abc84a09001537dffd13c810a503b9c"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:a1abc84a09001537dffd13c810a503b9c"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">writeValue</a> (const T &s, bool response=false)</td></tr>
|
||||
<tr class="memdesc:a1abc84a09001537dffd13c810a503b9c"><td class="mdescLeft"> </td><td class="mdescRight">Template to set the remote descriptor value to <type>val. <a href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">More...</a><br /></td></tr>
|
||||
<tr class="separator:a1abc84a09001537dffd13c810a503b9c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1abc84a09001537dffd13c810a503b9c"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:a1abc84a09001537dffd13c810a503b9c"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">writeValue</a> (const T &s, bool response=false)</td></tr>
|
||||
<tr class="memdesc:a1abc84a09001537dffd13c810a503b9c"><td class="mdescLeft"> </td><td class="mdescRight">Template to set the remote descriptor value to <type>val. <a href="class_nim_b_l_e_remote_descriptor.html#a1abc84a09001537dffd13c810a503b9c">More...</a><br /></td></tr>
|
||||
<tr class="separator:a1abc84a09001537dffd13c810a503b9c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac4e3a21818903b69ace41c36a58d3c46"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ac4e3a21818903b69ace41c36a58d3c46"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">readValue</a> (bool skipSizeCheck=false)</td></tr>
|
||||
<tr class="memdesc:ac4e3a21818903b69ace41c36a58d3c46"><td class="mdescLeft"> </td><td class="mdescRight">Template to convert the remote descriptor data to <type>. <a href="class_nim_b_l_e_remote_descriptor.html#ac4e3a21818903b69ace41c36a58d3c46">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac4e3a21818903b69ace41c36a58d3c46"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a05befb3c020c14f6b49439fd784a868c" id="r_a05befb3c020c14f6b49439fd784a868c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_descriptor.html#a05befb3c020c14f6b49439fd784a868c">getRemoteCharacteristic</a> () const</td></tr>
|
||||
<tr class="memdesc:a05befb3c020c14f6b49439fd784a868c"><td class="mdescLeft"> </td><td class="mdescRight">Get the characteristic that owns this descriptor. <br /></td></tr>
|
||||
<tr class="separator:a05befb3c020c14f6b49439fd784a868c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aeea50cff665118bfa5ac755934755735" id="r_aeea50cff665118bfa5ac755934755735"><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_descriptor.html#aeea50cff665118bfa5ac755934755735">toString</a> (void) const</td></tr>
|
||||
<tr class="memdesc:aeea50cff665118bfa5ac755934755735"><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of this Remote Descriptor. <br /></td></tr>
|
||||
<tr class="separator:aeea50cff665118bfa5ac755934755735"><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 remote BLE descriptor. </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="ab8a774ebc69c0fb7ea17f926a82dba21"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab8a774ebc69c0fb7ea17f926a82dba21">◆ </a></span>getHandle()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint16_t NimBLERemoteDescriptor::getHandle </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Retrieve the handle associated with this remote descriptor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The handle associated with this remote descriptor. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a529e80c6731f68f3598e015df7618cfe"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a529e80c6731f68f3598e015df7618cfe">◆ </a></span>getRemoteCharacteristic()</h2>
|
||||
<a id="a05befb3c020c14f6b49439fd784a868c" name="a05befb3c020c14f6b49439fd784a868c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a05befb3c020c14f6b49439fd784a868c">◆ </a></span>getRemoteCharacteristic()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -174,7 +125,7 @@ Public Member Functions</h2></td></tr>
|
||||
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLERemoteDescriptor::getRemoteCharacteristic </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
@@ -184,155 +135,8 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ace6b19cd3d9aa8226b4c17371616ad58"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ace6b19cd3d9aa8226b4c17371616ad58">◆ </a></span>getUUID()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> NimBLERemoteDescriptor::getUUID </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Retrieve the UUID associated this remote descriptor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The UUID associated this remote descriptor. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a14351ea51b7b04f91b71e388881edd53"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a14351ea51b7b04f91b71e388881edd53">◆ </a></span>readUInt16()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint16_t NimBLERemoteDescriptor::readUInt16 </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Read an unsigned 16 bit value. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The unsigned 16 bit value. </dd></dl>
|
||||
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7" title="Read the value of the remote descriptor.">readValue<uint16_t>()</a>. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a219606f84d63bc02f093051d66f05204"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a219606f84d63bc02f093051d66f05204">◆ </a></span>readUInt32()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t NimBLERemoteDescriptor::readUInt32 </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Read an unsigned 32 bit value. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>the unsigned 32 bit value. </dd></dl>
|
||||
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7" title="Read the value of the remote descriptor.">readValue<uint32_t>()</a>. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab07e86707a91e48f68e9de55686e939b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab07e86707a91e48f68e9de55686e939b">◆ </a></span>readUInt8()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint8_t NimBLERemoteDescriptor::readUInt8 </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Read a byte value. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The value as a byte </dd></dl>
|
||||
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_nim_b_l_e_remote_descriptor.html#a7c7c07e6ccd969de568b5bda72ec52d7" title="Read the value of the remote descriptor.">readValue<uint8_t>()</a>. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a7c7c07e6ccd969de568b5bda72ec52d7"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7c7c07e6ccd969de568b5bda72ec52d7">◆ </a></span>readValue() <span class="overload">[1/2]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> NimBLERemoteDescriptor::readValue </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Read the value of the remote descriptor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The value of the remote descriptor. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac4e3a21818903b69ace41c36a58d3c46"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac4e3a21818903b69ace41c36a58d3c46">◆ </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 NimBLERemoteDescriptor::readValue </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Template to convert the remote descriptor 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">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>(skipSizeCheck);</code> </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a008795a09d1fbe8533c2e9d0e8deb33a"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a008795a09d1fbe8533c2e9d0e8deb33a">◆ </a></span>toString()</h2>
|
||||
<a id="aeea50cff665118bfa5ac755934755735" name="aeea50cff665118bfa5ac755934755735"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aeea50cff665118bfa5ac755934755735">◆ </a></span>toString()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -342,7 +146,7 @@ template<typename T > </div>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
@@ -350,223 +154,6 @@ template<typename T > </div>
|
||||
<p>Return a string representation of this Remote Descriptor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A string representation of this Remote Descriptor. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab7cab188f311f44d06638434117938e7"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab7cab188f311f44d06638434117938e7">◆ </a></span>writeValue() <span class="overload">[1/5]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool NimBLERemoteDescriptor::writeValue </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>char_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>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Write a new value to the remote descriptor from a const char*. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">char_s</td><td>A character string to write to the remote descriptor. </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 otherwise cannot perform write. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab1654a0b1dc86fe042b3d5b983fbd08c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab1654a0b1dc86fe042b3d5b983fbd08c">◆ </a></span>writeValue() <span class="overload">[2/5]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool NimBLERemoteDescriptor::writeValue </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const std::vector< uint8_t > & </td>
|
||||
<td class="paramname"><em>vec</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 a new value to a remote descriptor from a std::vector<uint8_t>. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">vec</td><td>A std::vector<uint8_t> value to write to the remote descriptor. </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 otherwise cannot perform write. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1abc84a09001537dffd13c810a503b9c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1abc84a09001537dffd13c810a503b9c">◆ </a></span>writeValue() <span class="overload">[3/5]</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 NimBLERemoteDescriptor::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>Template to set the remote descriptor 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>
|
||||
<p>Only used for non-arrays and types without a <code>c_str()</code> method. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1abc84a09001537dffd13c810a503b9c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1abc84a09001537dffd13c810a503b9c">◆ </a></span>writeValue() <span class="overload">[4/5]</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 NimBLERemoteDescriptor::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>Template to set the remote descriptor 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>
|
||||
<p>Only used if the <type> has a <code>c_str()</code> method. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a0d3fb6424b2c86730e1a292281cd836e"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a0d3fb6424b2c86730e1a292281cd836e">◆ </a></span>writeValue() <span class="overload">[5/5]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool NimBLERemoteDescriptor::writeValue </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const uint8_t * </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 a new value to a remote descriptor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data to send to the remote descriptor. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the data to send. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>True if we expect a write response. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>false if not connected or otherwise cannot perform write. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
@@ -575,7 +162,7 @@ template<typename T > </div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in new issue
Block a user