ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-23 13:40:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/class_nim_b_l_e_h_i_d_device.html
Deployment Bot (from Travis CI) c51c0f2cf5 Deploy h2zero/esp-nimble-cpp to github.com/h2zero/esp-nimble-cpp.git:gh-pages
2021-08-05 01:02:30 +00:00

461 lines
27 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp / NimBLE-Arduino: NimBLEHIDDevice Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<span id="projectnumber">1.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_h_i_d_device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEHIDDevice Class Reference</div> </div>
</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>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a95b4935280494ffa24bfae89753f199a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">NimBLEHIDDevice</a> (<a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *)</td></tr>
<tr class="memdesc:a95b4935280494ffa24bfae89753f199a"><td class="mdescLeft">&#160;</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. <a href="class_nim_b_l_e_h_i_d_device.html#a95b4935280494ffa24bfae89753f199a">More...</a><br /></td></tr>
<tr class="separator:a95b4935280494ffa24bfae89753f199a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e996a1668785f7a978f9874b4ff3b3e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">reportMap</a> (uint8_t *map, uint16_t)</td></tr>
<tr class="memdesc:a5e996a1668785f7a978f9874b4ff3b3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the report map data formatting information. <a href="class_nim_b_l_e_h_i_d_device.html#a5e996a1668785f7a978f9874b4ff3b3e">More...</a><br /></td></tr>
<tr class="separator:a5e996a1668785f7a978f9874b4ff3b3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5984042cd05ea4ead895f5577133a235"><td class="memItemLeft" align="right" valign="top"><a id="a5984042cd05ea4ead895f5577133a235"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5984042cd05ea4ead895f5577133a235">startServices</a> ()</td></tr>
<tr class="memdesc:a5984042cd05ea4ead895f5577133a235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the HID device services.<br />
This function called when all the services have been created. <br /></td></tr>
<tr class="separator:a5984042cd05ea4ead895f5577133a235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a033c4ad91f1bc165ac6a322b4dcc1699"><td class="memItemLeft" align="right" valign="top"><a id="a033c4ad91f1bc165ac6a322b4dcc1699"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a033c4ad91f1bc165ac6a322b4dcc1699">deviceInfo</a> ()</td></tr>
<tr class="memdesc:a033c4ad91f1bc165ac6a322b4dcc1699"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the device information service. <br /></td></tr>
<tr class="separator:a033c4ad91f1bc165ac6a322b4dcc1699"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae80cf58c481c25bd6d7392a43b6fa48b"><td class="memItemLeft" align="right" valign="top"><a id="ae80cf58c481c25bd6d7392a43b6fa48b"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ae80cf58c481c25bd6d7392a43b6fa48b">hidService</a> ()</td></tr>
<tr class="memdesc:ae80cf58c481c25bd6d7392a43b6fa48b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the HID service. <br /></td></tr>
<tr class="separator:ae80cf58c481c25bd6d7392a43b6fa48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24498f7b714574ab4a90288f7e4d58b7"><td class="memItemLeft" align="right" valign="top"><a id="a24498f7b714574ab4a90288f7e4d58b7"></a>
<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a24498f7b714574ab4a90288f7e4d58b7">batteryService</a> ()</td></tr>
<tr class="memdesc:a24498f7b714574ab4a90288f7e4d58b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the battery service. <br /></td></tr>
<tr class="separator:a24498f7b714574ab4a90288f7e4d58b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5b8291ca88d85a352429415abaec9c"><td class="memItemLeft" align="right" valign="top"><a id="a3e5b8291ca88d85a352429415abaec9c"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a3e5b8291ca88d85a352429415abaec9c">manufacturer</a> ()</td></tr>
<tr class="memdesc:a3e5b8291ca88d85a352429415abaec9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a manufacturer characteristic (this characteristic is optional). <br /></td></tr>
<tr class="separator:a3e5b8291ca88d85a352429415abaec9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac04ed297cf6adbec210873739d2dc74d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ac04ed297cf6adbec210873739d2dc74d">manufacturer</a> (std::string name)</td></tr>
<tr class="memdesc:ac04ed297cf6adbec210873739d2dc74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set manufacturer name. <a href="class_nim_b_l_e_h_i_d_device.html#ac04ed297cf6adbec210873739d2dc74d">More...</a><br /></td></tr>
<tr class="separator:ac04ed297cf6adbec210873739d2dc74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5309df317aa42de7ced2e34219b6666a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">pnp</a> (uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)</td></tr>
<tr class="memdesc:a5309df317aa42de7ced2e34219b6666a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Plug n Play characterisc value. <a href="class_nim_b_l_e_h_i_d_device.html#a5309df317aa42de7ced2e34219b6666a">More...</a><br /></td></tr>
<tr class="separator:a5309df317aa42de7ced2e34219b6666a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fc2bfc990ecd250859ca8f34a4314e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">hidInfo</a> (uint8_t country, uint8_t flags)</td></tr>
<tr class="memdesc:a33fc2bfc990ecd250859ca8f34a4314e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the HID Information characteristic value. <a href="class_nim_b_l_e_h_i_d_device.html#a33fc2bfc990ecd250859ca8f34a4314e">More...</a><br /></td></tr>
<tr class="separator:a33fc2bfc990ecd250859ca8f34a4314e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84e3127a05f7e6a44761ec4a9e7668e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">setBatteryLevel</a> (uint8_t level)</td></tr>
<tr class="memdesc:a84e3127a05f7e6a44761ec4a9e7668e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the battery level characteristic value. <a href="class_nim_b_l_e_h_i_d_device.html#a84e3127a05f7e6a44761ec4a9e7668e3">More...</a><br /></td></tr>
<tr class="separator:a84e3127a05f7e6a44761ec4a9e7668e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c42da43e0b8dfcd1d045e8a86d0b5a2"><td class="memItemLeft" align="right" valign="top"><a id="a5c42da43e0b8dfcd1d045e8a86d0b5a2"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a5c42da43e0b8dfcd1d045e8a86d0b5a2">hidControl</a> ()</td></tr>
<tr class="memdesc:a5c42da43e0b8dfcd1d045e8a86d0b5a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the HID control point characteristic. <br /></td></tr>
<tr class="separator:a5c42da43e0b8dfcd1d045e8a86d0b5a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91cfe81b47cea229e9bbe3c55be33701"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">inputReport</a> (uint8_t reportID)</td></tr>
<tr class="memdesc:a91cfe81b47cea229e9bbe3c55be33701"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create input report characteristic. <a href="class_nim_b_l_e_h_i_d_device.html#a91cfe81b47cea229e9bbe3c55be33701">More...</a><br /></td></tr>
<tr class="separator:a91cfe81b47cea229e9bbe3c55be33701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1e63972c6a77665a6bbc76f9ff4a717"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">outputReport</a> (uint8_t reportID)</td></tr>
<tr class="memdesc:ac1e63972c6a77665a6bbc76f9ff4a717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create output report characteristic. <a href="class_nim_b_l_e_h_i_d_device.html#ac1e63972c6a77665a6bbc76f9ff4a717">More...</a><br /></td></tr>
<tr class="separator:ac1e63972c6a77665a6bbc76f9ff4a717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a468e599c7d75e691f8d34e1b24db8a38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">featureReport</a> (uint8_t reportID)</td></tr>
<tr class="memdesc:a468e599c7d75e691f8d34e1b24db8a38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create feature report characteristic. <a href="class_nim_b_l_e_h_i_d_device.html#a468e599c7d75e691f8d34e1b24db8a38">More...</a><br /></td></tr>
<tr class="separator:a468e599c7d75e691f8d34e1b24db8a38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1118c1e730f38b8b17795c8eb41a0861"><td class="memItemLeft" align="right" valign="top"><a id="a1118c1e730f38b8b17795c8eb41a0861"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a1118c1e730f38b8b17795c8eb41a0861">protocolMode</a> ()</td></tr>
<tr class="memdesc:a1118c1e730f38b8b17795c8eb41a0861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the protocol mode characteristic. <br /></td></tr>
<tr class="separator:a1118c1e730f38b8b17795c8eb41a0861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45ca7d4547dfea9a64987065d83653bd"><td class="memItemLeft" align="right" valign="top"><a id="a45ca7d4547dfea9a64987065d83653bd"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#a45ca7d4547dfea9a64987065d83653bd">bootInput</a> ()</td></tr>
<tr class="memdesc:a45ca7d4547dfea9a64987065d83653bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a keyboard boot input report characteristic. <br /></td></tr>
<tr class="separator:a45ca7d4547dfea9a64987065d83653bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace0141db690f1afec1b266f9ac9aa0f0"><td class="memItemLeft" align="right" valign="top"><a id="ace0141db690f1afec1b266f9ac9aa0f0"></a>
<a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_h_i_d_device.html#ace0141db690f1afec1b266f9ac9aa0f0">bootOutput</a> ()</td></tr>
<tr class="memdesc:ace0141db690f1afec1b266f9ac9aa0f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a keyboard boot output report characteristic. <br /></td></tr>
<tr class="separator:ace0141db690f1afec1b266f9ac9aa0f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</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 &amp; Destructor Documentation</h2>
<a id="a95b4935280494ffa24bfae89753f199a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95b4935280494ffa24bfae89753f199a">&#9670;&nbsp;</a></span>NimBLEHIDDevice()</h2>
<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> *&#160;</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>
<a id="a468e599c7d75e691f8d34e1b24db8a38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a468e599c7d75e691f8d34e1b24db8a38">&#9670;&nbsp;</a></span>featureReport()</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::featureReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create feature report characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to new feature report characteristic </dd></dl>
</div>
</div>
<a id="a33fc2bfc990ecd250859ca8f34a4314e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33fc2bfc990ecd250859ca8f34a4314e">&#9670;&nbsp;</a></span>hidInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::hidInfo </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>country</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the HID Information characteristic value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
</div>
</div>
<a id="a91cfe81b47cea229e9bbe3c55be33701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91cfe81b47cea229e9bbe3c55be33701">&#9670;&nbsp;</a></span>inputReport()</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::inputReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create input report characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to new input report characteristic </dd></dl>
</div>
</div>
<a id="ac04ed297cf6adbec210873739d2dc74d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac04ed297cf6adbec210873739d2dc74d">&#9670;&nbsp;</a></span>manufacturer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::manufacturer </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set manufacturer name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The manufacturer name of this HID device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac1e63972c6a77665a6bbc76f9ff4a717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1e63972c6a77665a6bbc76f9ff4a717">&#9670;&nbsp;</a></span>outputReport()</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::outputReport </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create output report characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to new output report characteristic </dd></dl>
</div>
</div>
<a id="a5309df317aa42de7ced2e34219b6666a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5309df317aa42de7ced2e34219b6666a">&#9670;&nbsp;</a></span>pnp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::pnp </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>sig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>vid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>pid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>version</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the Plug n Play characterisc value. </p>
<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>
<a id="a5e996a1668785f7a978f9874b4ff3b3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e996a1668785f7a978f9874b4ff3b3e">&#9670;&nbsp;</a></span>reportMap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEHIDDevice::reportMap </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</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>
<a id="a84e3127a05f7e6a44761ec4a9e7668e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84e3127a05f7e6a44761ec4a9e7668e3">&#9670;&nbsp;</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&#160;</td>
<td class="paramname"><em>level</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the battery level characteristic value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The battery level value. </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>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink