2021-08-05 03:02:30 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2024-12-15 01:45:58 +01:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-08-05 03:02:30 +02:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
2024-12-15 01:45:58 +01:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.9.8" / >
2021-08-05 03:02:30 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2022-01-15 23:23:57 +01:00
< title > esp-nimble-cpp: NimBLEHIDDevice Class Reference< / title >
2021-08-05 03:02:30 +02: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 01:45:58 +01:00
< tr id = "projectrow" >
< td id = "projectalign" >
2024-12-22 01:10:12 +01:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.0.2< / span >
2021-08-05 03:02:30 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2024-12-15 01:45:58 +01:00
<!-- Generated by Doxygen 1.9.8 -->
2021-08-05 03:02:30 +02:00
< script type = "text/javascript" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
2021-08-05 03:02:30 +02: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 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2021-08-05 03:02:30 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2024-12-15 01:45:58 +01:00
/* @license-end */
< / script >
2021-08-05 03:02:30 +02: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 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2021-08-05 03:02:30 +02:00
$(document).ready(function(){initNavTree('class_nim_b_l_e_h_i_d_device.html',''); initResizable(); });
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
2024-12-15 01:45:58 +01: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 03:02:30 +02:00
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "class_nim_b_l_e_h_i_d_device-members.html" > List of all members< / a > < / div >
2024-12-15 01:45:58 +01:00
< div class = "headertitle" > < div class = "title" > NimBLEHIDDevice Class Reference< / div > < / div >
2021-08-05 03:02:30 +02:00
< / div > <!-- header -->
< div class = "contents" >
< p > A model of a BLE Human Interface Device.
< a href = "class_nim_b_l_e_h_i_d_device.html#details" > More...< / a > < / p >
2024-12-15 01:45:58 +01:00
< p > < code > #include < < a class = "el" href = "_nim_b_l_e_h_i_d_device_8h_source.html" > NimBLEHIDDevice.h< / a > > < / code > < / p >
2021-08-05 03:02:30 +02:00
< table class = "memberdecls" >
2024-12-15 01:45:58 +01:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-methods" name = "pub-methods" > < / a >
2021-08-05 03:02:30 +02:00
Public Member Functions< / h2 > < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a33821f02034b8ed47f3cd0555ac9e949" id = "r_a33821f02034b8ed47f3cd0555ac9e949" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#a33821f02034b8ed47f3cd0555ac9e949" > NimBLEHIDDevice< / a > (< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer< / a > *server)< / td > < / tr >
< tr class = "memdesc:a33821f02034b8ed47f3cd0555ac9e949" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Construct a default < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html" title = "A model of a BLE Human Interface Device." > NimBLEHIDDevice< / a > object. < br / > < / td > < / tr >
< tr class = "separator:a33821f02034b8ed47f3cd0555ac9e949" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abdc7efa80e3a1cc9c35bcce012c1d37c" id = "r_abdc7efa80e3a1cc9c35bcce012c1d37c" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#abdc7efa80e3a1cc9c35bcce012c1d37c" > setReportMap< / a > (uint8_t *map, uint16_t)< / td > < / tr >
< tr class = "memdesc:abdc7efa80e3a1cc9c35bcce012c1d37c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the report map data formatting information. < br / > < / td > < / tr >
< tr class = "separator:abdc7efa80e3a1cc9c35bcce012c1d37c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a5984042cd05ea4ead895f5577133a235" id = "r_a5984042cd05ea4ead895f5577133a235" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a5984042cd05ea4ead895f5577133a235" name = "a5984042cd05ea4ead895f5577133a235" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > startServices< / b > ()< / td > < / tr >
< tr class = "memdesc:a5984042cd05ea4ead895f5577133a235" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Start the HID device services. This function called when all the services have been created. < br / > < / td > < / tr >
2021-08-05 03:02:30 +02:00
< tr class = "separator:a5984042cd05ea4ead895f5577133a235" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a35c42432a5a8f5b3286293bea1b9f397" id = "r_a35c42432a5a8f5b3286293bea1b9f397" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#a35c42432a5a8f5b3286293bea1b9f397" > setManufacturer< / a > (const std::string & name)< / td > < / tr >
< tr class = "memdesc:a35c42432a5a8f5b3286293bea1b9f397" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the manufacturer characteristic (this characteristic is optional). < br / > < / td > < / tr >
< tr class = "separator:a35c42432a5a8f5b3286293bea1b9f397" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab0495fb5fbee85277a14a0b9476a0239" id = "r_ab0495fb5fbee85277a14a0b9476a0239" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#ab0495fb5fbee85277a14a0b9476a0239" > setPnp< / a > (uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)< / td > < / tr >
< tr class = "memdesc:ab0495fb5fbee85277a14a0b9476a0239" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets the Plug n Play characteristic value. < br / > < / td > < / tr >
< tr class = "separator:ab0495fb5fbee85277a14a0b9476a0239" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aea007674892608877cdbf9122208ba28" id = "r_aea007674892608877cdbf9122208ba28" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#aea007674892608877cdbf9122208ba28" > setHidInfo< / a > (uint8_t country, uint8_t flags)< / td > < / tr >
< tr class = "memdesc:aea007674892608877cdbf9122208ba28" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets the HID Information characteristic value. < br / > < / td > < / tr >
< tr class = "separator:aea007674892608877cdbf9122208ba28" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab24968002ba94c2029e9d55364e1ec2b" id = "r_ab24968002ba94c2029e9d55364e1ec2b" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#ab24968002ba94c2029e9d55364e1ec2b" > setBatteryLevel< / a > (uint8_t level, bool notify=false)< / td > < / tr >
< tr class = "memdesc:ab24968002ba94c2029e9d55364e1ec2b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the battery level characteristic value. < br / > < / td > < / tr >
< tr class = "separator:ab24968002ba94c2029e9d55364e1ec2b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a323892b69461ac6fc081432f633eda3e" id = "r_a323892b69461ac6fc081432f633eda3e" > < 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_h_i_d_device.html#a323892b69461ac6fc081432f633eda3e" > getBatteryLevel< / a > ()< / td > < / tr >
< tr class = "memdesc:a323892b69461ac6fc081432f633eda3e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the battery level characteristic. < br / > < / td > < / tr >
< tr class = "separator:a323892b69461ac6fc081432f633eda3e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:afe75c42779aef757cd3ba84ec281efb5" id = "r_afe75c42779aef757cd3ba84ec281efb5" > < 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_h_i_d_device.html#afe75c42779aef757cd3ba84ec281efb5" > getReportMap< / a > ()< / td > < / tr >
< tr class = "memdesc:afe75c42779aef757cd3ba84ec281efb5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the report map characteristic. < br / > < / td > < / tr >
< tr class = "separator:afe75c42779aef757cd3ba84ec281efb5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab29c3d71cd592aa867b8c6655d586f24" id = "r_ab29c3d71cd592aa867b8c6655d586f24" > < 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_h_i_d_device.html#ab29c3d71cd592aa867b8c6655d586f24" > getHidControl< / a > ()< / td > < / tr >
< tr class = "memdesc:ab29c3d71cd592aa867b8c6655d586f24" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the HID control point characteristic. < br / > < / td > < / tr >
< tr class = "separator:ab29c3d71cd592aa867b8c6655d586f24" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af2f973843304c2d513963a9dbbc48714" id = "r_af2f973843304c2d513963a9dbbc48714" > < 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_h_i_d_device.html#af2f973843304c2d513963a9dbbc48714" > getInputReport< / a > (uint8_t reportId)< / td > < / tr >
< tr class = "memdesc:af2f973843304c2d513963a9dbbc48714" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the input report characteristic. < br / > < / td > < / tr >
< tr class = "separator:af2f973843304c2d513963a9dbbc48714" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ace0ea997b5c986bb8a56cd8673163203" id = "r_ace0ea997b5c986bb8a56cd8673163203" > < 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_h_i_d_device.html#ace0ea997b5c986bb8a56cd8673163203" > getOutputReport< / a > (uint8_t reportId)< / td > < / tr >
< tr class = "memdesc:ace0ea997b5c986bb8a56cd8673163203" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the output report characteristic. < br / > < / td > < / tr >
< tr class = "separator:ace0ea997b5c986bb8a56cd8673163203" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac34cb2703dc655220270604e2a28cf41" id = "r_ac34cb2703dc655220270604e2a28cf41" > < 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_h_i_d_device.html#ac34cb2703dc655220270604e2a28cf41" > getFeatureReport< / a > (uint8_t reportId)< / td > < / tr >
< tr class = "memdesc:ac34cb2703dc655220270604e2a28cf41" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the feature report characteristic. < br / > < / td > < / tr >
< tr class = "separator:ac34cb2703dc655220270604e2a28cf41" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1bdd21f3cc61d0128b06cdfd9588d6f5" id = "r_a1bdd21f3cc61d0128b06cdfd9588d6f5" > < 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_h_i_d_device.html#a1bdd21f3cc61d0128b06cdfd9588d6f5" > getProtocolMode< / a > ()< / td > < / tr >
< tr class = "memdesc:a1bdd21f3cc61d0128b06cdfd9588d6f5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the HID protocol mode characteristic. < br / > < / td > < / tr >
< tr class = "separator:a1bdd21f3cc61d0128b06cdfd9588d6f5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a956ea4caa4f5bac7cda3bdb152ac1176" id = "r_a956ea4caa4f5bac7cda3bdb152ac1176" > < 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_h_i_d_device.html#a956ea4caa4f5bac7cda3bdb152ac1176" > getBootInput< / a > ()< / td > < / tr >
< tr class = "memdesc:a956ea4caa4f5bac7cda3bdb152ac1176" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get a keyboard boot input report characteristic. < br / > < / td > < / tr >
< tr class = "separator:a956ea4caa4f5bac7cda3bdb152ac1176" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad2584be6dfe497dc83686a51ff0194f6" id = "r_ad2584be6dfe497dc83686a51ff0194f6" > < 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_h_i_d_device.html#ad2584be6dfe497dc83686a51ff0194f6" > getBootOutput< / a > ()< / td > < / tr >
< tr class = "memdesc:ad2584be6dfe497dc83686a51ff0194f6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Create a keyboard boot output report characteristic. < br / > < / td > < / tr >
< tr class = "separator:ad2584be6dfe497dc83686a51ff0194f6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abda5099d23c7111e99d8d755565be84a" id = "r_abda5099d23c7111e99d8d755565be84a" > < 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_h_i_d_device.html#abda5099d23c7111e99d8d755565be84a" > getPnp< / a > ()< / td > < / tr >
< tr class = "memdesc:abda5099d23c7111e99d8d755565be84a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the PnP characteristic. < br / > < / td > < / tr >
< tr class = "separator:abda5099d23c7111e99d8d755565be84a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a21aa774e08a344fc98e217c79c9ddf12" id = "r_a21aa774e08a344fc98e217c79c9ddf12" > < 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_h_i_d_device.html#a21aa774e08a344fc98e217c79c9ddf12" > getHidInfo< / a > ()< / td > < / tr >
< tr class = "memdesc:a21aa774e08a344fc98e217c79c9ddf12" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the HID information characteristic. < br / > < / td > < / tr >
< tr class = "separator:a21aa774e08a344fc98e217c79c9ddf12" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7d6592bba748b4be7ed1e4fb9275d346" id = "r_a7d6592bba748b4be7ed1e4fb9275d346" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "class_nim_b_l_e_service.html" > NimBLEService< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#a7d6592bba748b4be7ed1e4fb9275d346" > getDeviceInfoService< / a > ()< / td > < / tr >
< tr class = "memdesc:a7d6592bba748b4be7ed1e4fb9275d346" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the manufacturer characteristic. < br / > < / td > < / tr >
< tr class = "separator:a7d6592bba748b4be7ed1e4fb9275d346" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2aea1e924f327152db713834bc2ad5a6" id = "r_a2aea1e924f327152db713834bc2ad5a6" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "class_nim_b_l_e_service.html" > NimBLEService< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#a2aea1e924f327152db713834bc2ad5a6" > getHidService< / a > ()< / td > < / tr >
< tr class = "memdesc:a2aea1e924f327152db713834bc2ad5a6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the HID service. < br / > < / td > < / tr >
< tr class = "separator:a2aea1e924f327152db713834bc2ad5a6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:adce27e45dc04de669c512f6550efadc7" id = "r_adce27e45dc04de669c512f6550efadc7" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "class_nim_b_l_e_service.html" > NimBLEService< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html#adce27e45dc04de669c512f6550efadc7" > getBatteryService< / a > ()< / td > < / tr >
< tr class = "memdesc:adce27e45dc04de669c512f6550efadc7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the battery service. < br / > < / td > < / tr >
< tr class = "separator:adce27e45dc04de669c512f6550efadc7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > A model of a BLE Human Interface Device. < / p >
< / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
2024-12-15 01:45:58 +01:00
< a id = "a33821f02034b8ed47f3cd0555ac9e949" name = "a33821f02034b8ed47f3cd0555ac9e949" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a33821f02034b8ed47f3cd0555ac9e949" > ◆   < / a > < / span > NimBLEHIDDevice()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > NimBLEHIDDevice::NimBLEHIDDevice < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer< / a > *  < / td >
< td class = "paramname" > < em > server< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Construct a default < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html" title = "A model of a BLE Human Interface Device." > NimBLEHIDDevice< / a > object. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > server< / td > < td > A pointer to the server instance this HID Device will use. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2024-12-15 01:45:58 +01:00
< a id = "a323892b69461ac6fc081432f633eda3e" name = "a323892b69461ac6fc081432f633eda3e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a323892b69461ac6fc081432f633eda3e" > ◆   < / a > < / span > getBatteryLevel()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getBatteryLevel < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the battery level characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the battery level characteristic < / dd > < / dl >
< / div >
< / div >
< a id = "adce27e45dc04de669c512f6550efadc7" name = "adce27e45dc04de669c512f6550efadc7" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#adce27e45dc04de669c512f6550efadc7" > ◆   < / a > < / span > getBatteryService()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_service.html" > NimBLEService< / a > * NimBLEHIDDevice::getBatteryService < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the battery service. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the battery service. < / dd > < / dl >
< / div >
< / div >
< a id = "a956ea4caa4f5bac7cda3bdb152ac1176" name = "a956ea4caa4f5bac7cda3bdb152ac1176" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a956ea4caa4f5bac7cda3bdb152ac1176" > ◆   < / a > < / span > getBootInput()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getBootInput < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get a keyboard boot input report characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the boot input report characteristic, or nullptr on error.< / dd > < / dl >
< p > This will create the characteristic if not already created. < / p >
< / div >
< / div >
< a id = "ad2584be6dfe497dc83686a51ff0194f6" name = "ad2584be6dfe497dc83686a51ff0194f6" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad2584be6dfe497dc83686a51ff0194f6" > ◆   < / a > < / span > getBootOutput()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getBootOutput < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Create a keyboard boot output report characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the boot output report characteristic, or nullptr on error.< / dd > < / dl >
< p > This will create the characteristic if not already created. < / p >
< / div >
< / div >
< a id = "a7d6592bba748b4be7ed1e4fb9275d346" name = "a7d6592bba748b4be7ed1e4fb9275d346" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a7d6592bba748b4be7ed1e4fb9275d346" > ◆   < / a > < / span > getDeviceInfoService()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_service.html" > NimBLEService< / a > * NimBLEHIDDevice::getDeviceInfoService < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the manufacturer characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the manufacturer characteristic. < / dd > < / dl >
< / div >
< / div >
< a id = "ac34cb2703dc655220270604e2a28cf41" name = "ac34cb2703dc655220270604e2a28cf41" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ac34cb2703dc655220270604e2a28cf41" > ◆   < / a > < / span > getFeatureReport()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getFeatureReport < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > reportId< / em > < / td > < td > )< / td >
2021-08-05 03:02:30 +02:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-12-15 01:45:58 +01:00
< p > Get the feature report characteristic. < / p >
2021-08-05 03:02:30 +02:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > reportId< / td > < td > Feature report ID, the same as in report map for feature object related to the characteristic. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
2024-12-22 01:10:12 +01:00
< dl class = "section return" > < dt > Returns< / dt > < dd > NimBLECharacteristic* A pointer to feature report characteristic. Store this value to avoid computational overhead. < / dd >
< dd >
nullptr If the report is already created as an input or output report.< / dd > < / dl >
2024-12-15 01:45:58 +01:00
< p > This will create the characteristic if not already created. < / p >
2021-08-05 03:02:30 +02:00
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "ab29c3d71cd592aa867b8c6655d586f24" name = "ab29c3d71cd592aa867b8c6655d586f24" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab29c3d71cd592aa867b8c6655d586f24" > ◆   < / a > < / span > getHidControl()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getHidControl < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
2021-08-05 03:02:30 +02:00
< / tr >
2024-12-15 01:45:58 +01:00
< / table >
< / div > < div class = "memdoc" >
< p > Get the HID control point characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the HID control point characteristic. < / dd > < / dl >
< / div >
< / div >
< a id = "a21aa774e08a344fc98e217c79c9ddf12" name = "a21aa774e08a344fc98e217c79c9ddf12" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a21aa774e08a344fc98e217c79c9ddf12" > ◆   < / a > < / span > getHidInfo()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2021-08-05 03:02:30 +02:00
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getHidInfo < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
2021-08-05 03:02:30 +02:00
< td > < / td >
< / tr >
2024-12-15 01:45:58 +01:00
< / table >
< / div > < div class = "memdoc" >
< p > Get the HID information characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the HID information characteristic. < / dd > < / dl >
< / div >
< / div >
< a id = "a2aea1e924f327152db713834bc2ad5a6" name = "a2aea1e924f327152db713834bc2ad5a6" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2aea1e924f327152db713834bc2ad5a6" > ◆   < / a > < / span > getHidService()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2021-08-05 03:02:30 +02:00
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_service.html" > NimBLEService< / a > * NimBLEHIDDevice::getHidService < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
2021-08-05 03:02:30 +02:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-12-15 01:45:58 +01:00
< p > Get the HID service. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the HID service. < / dd > < / dl >
< / div >
< / div >
< a id = "af2f973843304c2d513963a9dbbc48714" name = "af2f973843304c2d513963a9dbbc48714" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af2f973843304c2d513963a9dbbc48714" > ◆   < / a > < / span > getInputReport()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getInputReport < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > reportId< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the input report characteristic. < / p >
2021-08-05 03:02:30 +02:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-12-22 01:10:12 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > reportId< / td > < td > Input report ID, the same as in report map for input object related to the characteristic. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
2024-12-22 01:10:12 +01:00
< dl class = "section return" > < dt > Returns< / dt > < dd > NimBLECharacteristic* A pointer to the input report characteristic. Store this value to avoid computational overhead. < / dd >
< dd >
nullptr If the report is already created as an output or feature report.< / dd > < / dl >
2024-12-15 01:45:58 +01:00
< p > This will create the characteristic if not already created. < / p >
2021-08-05 03:02:30 +02:00
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "ace0ea997b5c986bb8a56cd8673163203" name = "ace0ea997b5c986bb8a56cd8673163203" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ace0ea997b5c986bb8a56cd8673163203" > ◆   < / a > < / span > getOutputReport()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getOutputReport < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > reportId< / em > < / td > < td > )< / td >
2021-08-05 03:02:30 +02:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-12-15 01:45:58 +01:00
< p > Get the output report characteristic. < / p >
2021-08-05 03:02:30 +02:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > reportId< / td > < td > Output report ID, the same as in report map for output object related to the characteristic. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
2024-12-22 01:10:12 +01:00
< dl class = "section return" > < dt > Returns< / dt > < dd > NimBLECharacteristic* A pointer to the output report characteristic. Store this value to avoid computational overhead. < / dd >
< dd >
nullptr If the report is already created as an input or feature report.< / dd > < / dl >
< p > This will create the characteristic if not already created. < / p >
2021-08-05 03:02:30 +02:00
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "abda5099d23c7111e99d8d755565be84a" name = "abda5099d23c7111e99d8d755565be84a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#abda5099d23c7111e99d8d755565be84a" > ◆   < / a > < / span > getPnp()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getPnp < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the PnP characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the PnP characteristic. < / dd > < / dl >
< / div >
< / div >
< a id = "a1bdd21f3cc61d0128b06cdfd9588d6f5" name = "a1bdd21f3cc61d0128b06cdfd9588d6f5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1bdd21f3cc61d0128b06cdfd9588d6f5" > ◆   < / a > < / span > getProtocolMode()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getProtocolMode < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the HID protocol mode characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > a pointer to the protocol mode characteristic. < / dd > < / dl >
< / div >
< / div >
< a id = "afe75c42779aef757cd3ba84ec281efb5" name = "afe75c42779aef757cd3ba84ec281efb5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#afe75c42779aef757cd3ba84ec281efb5" > ◆   < / a > < / span > getReportMap()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > * NimBLEHIDDevice::getReportMap < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
2021-08-05 03:02:30 +02:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-12-15 01:45:58 +01:00
< p > Get the report map characteristic. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A pointer to the report map characteristic. < / dd > < / dl >
< / div >
< / div >
< a id = "ab24968002ba94c2029e9d55364e1ec2b" name = "ab24968002ba94c2029e9d55364e1ec2b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab24968002ba94c2029e9d55364e1ec2b" > ◆   < / a > < / span > setBatteryLevel()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEHIDDevice::setBatteryLevel < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > level< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > notify< / em > = < code > false< / code >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Set the battery level characteristic value. < / p >
2021-08-05 03:02:30 +02:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > level< / td > < td > The battery level value. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > notify< / td > < td > If true sends a notification to the peer device, otherwise not. default = false < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "aea007674892608877cdbf9122208ba28" name = "aea007674892608877cdbf9122208ba28" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aea007674892608877cdbf9122208ba28" > ◆   < / a > < / span > setHidInfo()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > void NimBLEHIDDevice::setHidInfo < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > country< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
2021-08-05 03:02:30 +02:00
< td > < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > flags< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
2021-08-05 03:02:30 +02:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-12-15 01:45:58 +01:00
< p > Sets the HID Information characteristic value. < / p >
2021-08-05 03:02:30 +02:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > country< / td > < td > The country code for the device. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > flags< / td > < td > The HID Class Specification release number to use. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "a35c42432a5a8f5b3286293bea1b9f397" name = "a35c42432a5a8f5b3286293bea1b9f397" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a35c42432a5a8f5b3286293bea1b9f397" > ◆   < / a > < / span > setManufacturer()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > bool NimBLEHIDDevice::setManufacturer < / td >
< td > (< / td >
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > name< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the manufacturer characteristic (this characteristic is optional). < / p >
< p > The characteristic will be created if not already existing. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > True if the name was set and/or the characteristic created. < / dd > < / dl >
< / div >
< / div >
< a id = "ab0495fb5fbee85277a14a0b9476a0239" name = "ab0495fb5fbee85277a14a0b9476a0239" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab0495fb5fbee85277a14a0b9476a0239" > ◆   < / a > < / span > setPnp()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEHIDDevice::setPnp < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > sig< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > vid< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > pid< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > version< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2022-07-31 19:38:16 +02:00
< p > Sets the Plug n Play characteristic value. < / p >
2021-08-05 03:02:30 +02:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > sig< / td > < td > The vendor ID source number. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > vid< / td > < td > The vendor ID number. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pid< / td > < td > The product ID number. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > version< / td > < td > The produce version number. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "abdc7efa80e3a1cc9c35bcce012c1d37c" name = "abdc7efa80e3a1cc9c35bcce012c1d37c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#abdc7efa80e3a1cc9c35bcce012c1d37c" > ◆   < / a > < / span > setReportMap()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 01:45:58 +01:00
< td class = "memname" > void NimBLEHIDDevice::setReportMap < / td >
2021-08-05 03:02:30 +02:00
< td > (< / td >
< td class = "paramtype" > uint8_t *  < / td >
< td class = "paramname" > < em > map< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > size< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Set the report map data formatting information. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > map< / td > < td > A pointer to an array with the values to set. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > size< / td > < td > The number of values in the array. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a class = "el" href = "class_nim_b_l_e_h_i_d_device.html" > NimBLEHIDDevice< / a > < / li >
2024-12-15 01:45:58 +01: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 03:02:30 +02:00
< / ul >
< / div >
< / body >
< / html >
