2021-08-05 01:02:30 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2024-12-15 00:45:58 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-08-05 01:02:30 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" />
2024-12-15 00:45:58 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" />
< meta name = "generator" content = "Doxygen 1.9.8" />
2021-08-05 01:02:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
2022-01-15 15:23:57 -07:00
< title > esp-nimble-cpp: NimBLE2904 Class Reference</ title >
2021-08-05 01:02:30 +00:00
< 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 >
2024-12-15 00:45:58 +00:00
< tr id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.0.0</ span >
2021-08-05 01:02:30 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
2024-12-15 00:45:58 +00:00
<!-- Generated by Doxygen 1.9.8 -->
2021-08-05 01:02:30 +00:00
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox ( "searchBox" , "search/" , '.html' );
2021-08-05 01:02:30 +00:00
/* @license-end */
</ script >
< script type = "text/javascript" src = "menudata.js" ></ script >
< script type = "text/javascript" src = "menu.js" ></ script >
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( function () {
initMenu ( '' , true , false , 'search.php' , 'Search' );
$ ( document ). ready ( function () { init_search (); });
});
2024-12-15 00:45:58 +00:00
/* @license-end */
</ script >
2021-08-05 01:02:30 +00:00
< 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" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( document ). ready ( function (){ initNavTree ( 'class_nim_b_l_e2904.html' , '' ); initResizable (); });
/* @license-end */
</ script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover = "return searchBox.OnSearchSelectShow()"
onmouseout = "return searchBox.OnSearchSelectHide()"
onkeydown = "return searchBox.OnSearchSelectKey(event)" >
</ div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
2024-12-15 00:45:58 +00:00
< 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 >
2021-08-05 01:02:30 +00:00
</ div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "class_nim_b_l_e2904-members.html" > List of all members</ a > </ div >
2024-12-15 00:45:58 +00:00
< div class = "headertitle" >< div class = "title" > NimBLE2904 Class Reference</ div ></ div >
2021-08-05 01:02:30 +00:00
</ div > <!--header-->
< div class = "contents" >
< p > Descriptor for Characteristic Presentation Format.
< a href = "class_nim_b_l_e2904.html#details" > More...</ a ></ p >
2024-12-15 00:45:58 +00:00
< p >< code > #include < < a class = "el" href = "_nim_b_l_e2904_8h_source.html" > NimBLE2904.h</ a > > </ code ></ p >
2021-08-05 01:02:30 +00:00
< p > Inherits < a class = "el" href = "class_nim_b_l_e_descriptor.html" > NimBLEDescriptor</ a > .</ p >
< table class = "memberdecls" >
2024-12-15 00:45:58 +00:00
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-methods" name = "pub-methods" ></ a >
2021-08-05 01:02:30 +00:00
Public Member Functions</ h2 ></ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a498c863cb3fbf92eecc23f9f8856037c" id = "r_a498c863cb3fbf92eecc23f9f8856037c" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c" > setDescription</ a > (uint16_t)</ td ></ tr >
< tr class = "memdesc:a498c863cb3fbf92eecc23f9f8856037c" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the description. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:a498c863cb3fbf92eecc23f9f8856037c" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:ab1c53f99246f67dca1d63b812bef631d" id = "r_ab1c53f99246f67dca1d63b812bef631d" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d" > setExponent</ a > (int8_t exponent)</ td ></ tr >
< tr class = "memdesc:ab1c53f99246f67dca1d63b812bef631d" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the exponent. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:ab1c53f99246f67dca1d63b812bef631d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:ab7f21651b4493fd3daaa0f1545032ff1" id = "r_ab7f21651b4493fd3daaa0f1545032ff1" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1" > setFormat</ a > (uint8_t format)</ td ></ tr >
< tr class = "memdesc:ab7f21651b4493fd3daaa0f1545032ff1" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the format. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:ab7f21651b4493fd3daaa0f1545032ff1" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a2206274c217d43a8ba121e1d279f8962" id = "r_a2206274c217d43a8ba121e1d279f8962" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962" > setNamespace</ a > (uint8_t namespace_value)</ td ></ tr >
< tr class = "memdesc:a2206274c217d43a8ba121e1d279f8962" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the namespace. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:a2206274c217d43a8ba121e1d279f8962" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:ad0cf78a2a1c3418be9a39beaa0c826ee" id = "r_ad0cf78a2a1c3418be9a39beaa0c826ee" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee" > setUnit</ a > (uint16_t unit)</ td ></ tr >
< tr class = "memdesc:ad0cf78a2a1c3418be9a39beaa0c826ee" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the units for this value. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:ad0cf78a2a1c3418be9a39beaa0c826ee" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_methods_class_nim_b_l_e_descriptor" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_class_nim_b_l_e_descriptor')" >< img src = "closed.png" alt = "-" />   Public Member Functions inherited from < a class = "el" href = "class_nim_b_l_e_descriptor.html" > NimBLEDescriptor</ a ></ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:acdae256772e6ba433df5ff3217335a1b inherit pub_methods_class_nim_b_l_e_descriptor" id = "r_acdae256772e6ba433df5ff3217335a1b" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_descriptor.html#acdae256772e6ba433df5ff3217335a1b" > NimBLEDescriptor</ a > (const char *uuid, uint16_t properties, uint16_t maxLen, < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *pCharacteristic=nullptr)</ td ></ tr >
< tr class = "memdesc:acdae256772e6ba433df5ff3217335a1b inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct a descriptor. < br /></ td ></ tr >
< tr class = "separator:acdae256772e6ba433df5ff3217335a1b inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a9b371ae4807648762cad1346ba6fd3c3 inherit pub_methods_class_nim_b_l_e_descriptor" id = "r_a9b371ae4807648762cad1346ba6fd3c3" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_descriptor.html#a9b371ae4807648762cad1346ba6fd3c3" > NimBLEDescriptor</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, uint16_t properties, uint16_t maxLen, < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *pCharacteristic=nullptr)</ td ></ tr >
< tr class = "memdesc:a9b371ae4807648762cad1346ba6fd3c3 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct a descriptor. < br /></ td ></ tr >
< tr class = "separator:a9b371ae4807648762cad1346ba6fd3c3 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a83b589a2022bbd86743b0ee4c3670a37 inherit pub_methods_class_nim_b_l_e_descriptor" id = "r_a83b589a2022bbd86743b0ee4c3670a37" >< td class = "memItemLeft" align = "right" valign = "top" > std::string  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_descriptor.html#a83b589a2022bbd86743b0ee4c3670a37" > toString</ a > () const</ td ></ tr >
< tr class = "memdesc:a83b589a2022bbd86743b0ee4c3670a37 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Return a string representation of the descriptor. < br /></ td ></ tr >
< tr class = "separator:a83b589a2022bbd86743b0ee4c3670a37 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa9cb8727f9e17cf8050cf619e5fe3096 inherit pub_methods_class_nim_b_l_e_descriptor" id = "r_aa9cb8727f9e17cf8050cf619e5fe3096" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096" > setCallbacks</ a > (< a class = "el" href = "class_nim_b_l_e_descriptor_callbacks.html" > NimBLEDescriptorCallbacks</ a > *pCallbacks)</ td ></ tr >
< tr class = "memdesc:aa9cb8727f9e17cf8050cf619e5fe3096 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the callback handlers for this descriptor. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:aa9cb8727f9e17cf8050cf619e5fe3096 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:aa61b5f14156e9f378688ec875cf48309 inherit pub_methods_class_nim_b_l_e_descriptor" id = "r_aa61b5f14156e9f378688ec875cf48309" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_descriptor.html#aa61b5f14156e9f378688ec875cf48309" > getCharacteristic</ a > () const</ td ></ tr >
< tr class = "memdesc:aa61b5f14156e9f378688ec875cf48309 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the characteristic this descriptor belongs to. < br /></ td ></ tr >
< tr class = "separator:aa61b5f14156e9f378688ec875cf48309 inherit pub_methods_class_nim_b_l_e_descriptor" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > Descriptor for Characteristic Presentation Format. </ p >
2024-12-15 00:45:58 +00:00
< p > This is a convenience descriptor for the Characteristic Presentation Format which has a UUID of 0x2904. </ p >
2021-08-05 01:02:30 +00:00
</ div >< h2 class = "groupheader" > Member Function Documentation</ h2 >
2024-12-15 00:45:58 +00:00
< a id = "a498c863cb3fbf92eecc23f9f8856037c" name = "a498c863cb3fbf92eecc23f9f8856037c" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a498c863cb3fbf92eecc23f9f8856037c" > ◆  </ a ></ span > setDescription()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLE2904::setDescription </ td >
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > description</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the description. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > description</ td >< td > The description value to set. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "ab1c53f99246f67dca1d63b812bef631d" name = "ab1c53f99246f67dca1d63b812bef631d" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ab1c53f99246f67dca1d63b812bef631d" > ◆  </ a ></ span > setExponent()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLE2904::setExponent </ td >
< td > (</ td >
< td class = "paramtype" > int8_t  </ td >
< td class = "paramname" >< em > exponent</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the exponent. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > exponent</ td >< td > The exponent value to set. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "ab7f21651b4493fd3daaa0f1545032ff1" name = "ab7f21651b4493fd3daaa0f1545032ff1" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ab7f21651b4493fd3daaa0f1545032ff1" > ◆  </ a ></ span > setFormat()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLE2904::setFormat </ td >
< td > (</ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > format</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the format. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > format</ td >< td > The format value to set. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a2206274c217d43a8ba121e1d279f8962" name = "a2206274c217d43a8ba121e1d279f8962" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a2206274c217d43a8ba121e1d279f8962" > ◆  </ a ></ span > setNamespace()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLE2904::setNamespace </ td >
< td > (</ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > namespace_value</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the namespace. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > namespace_value</ td >< td > The namespace value toset. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "ad0cf78a2a1c3418be9a39beaa0c826ee" name = "ad0cf78a2a1c3418be9a39beaa0c826ee" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ad0cf78a2a1c3418be9a39beaa0c826ee" > ◆  </ a ></ span > setUnit()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLE2904::setUnit </ td >
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > unit</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2024-12-15 00:45:58 +00:00
< p > Set the units for this value. </ p >
2021-08-05 01:02:30 +00:00
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > unit</ td >< td > The type of units of this characteristic as defined by assigned numbers.</ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< p > See < a href = "https://www.bluetooth.com/specifications/assigned-numbers/units" > https://www.bluetooth.com/specifications/assigned-numbers/units</ a > </ p >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
</ div > <!-- contents -->
</ div > <!-- doc-content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" >< a class = "el" href = "class_nim_b_l_e2904.html" > NimBLE2904</ a ></ li >
2024-12-15 00:45:58 +00:00
< 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 >
2021-08-05 01:02:30 +00:00
</ ul >
</ div >
</ body >
</ html >
