specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_b_t_h_i_d.html
Kristian Lauszus 2b2d492fed Updated documentation
2014-01-19 17:17:06 +01:00

655 lines
30 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.6"/>
<title>USB Host Shield 2.0: BTHID 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.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 style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_b_t_h_i_d-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BTHID Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BTHID:</div>
<div class="dyncontent">
<div class="center"><img src="class_b_t_h_i_d__inherit__graph.png" border="0" usemap="#_b_t_h_i_d_inherit__map" alt="Inheritance graph"/></div>
<map name="_b_t_h_i_d_inherit__map" id="_b_t_h_i_d_inherit__map">
<area shape="rect" id="node3" href="class_p_s4_b_t.html" title="PS4BT" alt="" coords="34,161,96,189"/><area shape="rect" id="node2" href="class_bluetooth_service.html" title="BluetoothService" alt="" coords="4,6,125,34"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for BTHID:</div>
<div class="dyncontent">
<div class="center"><img src="class_b_t_h_i_d__coll__graph.png" border="0" usemap="#_b_t_h_i_d_coll__map" alt="Collaboration graph"/></div>
<map name="_b_t_h_i_d_coll__map" id="_b_t_h_i_d_coll__map">
<area shape="rect" id="node2" href="class_bluetooth_service.html" title="BluetoothService" alt="" coords="4,6,125,34"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a5ee874513852b83d6a04b991ab892f54"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#a5ee874513852b83d6a04b991ab892f54">BTHID</a> (<a class="el" href="class_b_t_d.html">BTD</a> *p, bool <a class="el" href="class_b_t_h_i_d.html#afb19720b65cda69d910416c7a689dd45">pair</a>=false, const char *pin=&quot;0000&quot;)</td></tr>
<tr class="separator:a5ee874513852b83d6a04b991ab892f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade1924514bc9c9cd71f54a1f37529575"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#ade1924514bc9c9cd71f54a1f37529575">GetReportParser</a> (uint8_t id)</td></tr>
<tr class="separator:ade1924514bc9c9cd71f54a1f37529575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e903f0b5040f3561e5de6c4431027b1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#a0e903f0b5040f3561e5de6c4431027b1">SetReportParser</a> (uint8_t id, <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *prs)</td></tr>
<tr class="separator:a0e903f0b5040f3561e5de6c4431027b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afceaafc89581441da40b141170b98595"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#afceaafc89581441da40b141170b98595">setProtocolMode</a> (uint8_t mode)</td></tr>
<tr class="separator:afceaafc89581441da40b141170b98595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae222e33ac617620c4cab5c1b23b89310"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#ae222e33ac617620c4cab5c1b23b89310">setLeds</a> (uint8_t data)</td></tr>
<tr class="separator:ae222e33ac617620c4cab5c1b23b89310"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb19720b65cda69d910416c7a689dd45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#afb19720b65cda69d910416c7a689dd45">pair</a> (void)</td></tr>
<tr class="separator:afb19720b65cda69d910416c7a689dd45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2d67e173774e344bca86fbd0ed5a10c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#ac2d67e173774e344bca86fbd0ed5a10c">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
<tr class="separator:ac2d67e173774e344bca86fbd0ed5a10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">BluetoothService implementation</div></td></tr>
<tr class="memitem:a84eb1b910027f2d78741f65225c14e54"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#a84eb1b910027f2d78741f65225c14e54">ACLData</a> (uint8_t *ACLData)</td></tr>
<tr class="separator:a84eb1b910027f2d78741f65225c14e54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a938eab04e406a29cc9324dad3ccb52cc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#a938eab04e406a29cc9324dad3ccb52cc">Run</a> ()</td></tr>
<tr class="separator:a938eab04e406a29cc9324dad3ccb52cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4c58b81414a037910dd6fb78f97b96e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#af4c58b81414a037910dd6fb78f97b96e">Reset</a> ()</td></tr>
<tr class="separator:af4c58b81414a037910dd6fb78f97b96e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1ee62d7b9951ec7960f122c9fc2d2d0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#ae1ee62d7b9951ec7960f122c9fc2d2d0">disconnect</a> ()</td></tr>
<tr class="separator:ae1ee62d7b9951ec7960f122c9fc2d2d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab3a81823a1d8805383146a6baad6ccc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#ab3a81823a1d8805383146a6baad6ccc4">connected</a></td></tr>
<tr class="separator:ab3a81823a1d8805383146a6baad6ccc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Overridable functions</div></td></tr>
<tr class="memitem:af9a13ab2a8c9c10fc74b3ed7dde1ff52"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#af9a13ab2a8c9c10fc74b3ed7dde1ff52">ParseBTHID</a> (<a class="el" href="class_b_t_h_i_d.html">BTHID</a> *bthid, uint8_t len, uint8_t *buf)</td></tr>
<tr class="separator:af9a13ab2a8c9c10fc74b3ed7dde1ff52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d92c1771d643172094fcd084f418421"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#a6d92c1771d643172094fcd084f418421">OnInitBTHID</a> ()</td></tr>
<tr class="separator:a6d92c1771d643172094fcd084f418421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc22bf5baaa096fe09b72c812c1134f0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_t_h_i_d.html#acc22bf5baaa096fe09b72c812c1134f0">ResetBTHID</a> ()</td></tr>
<tr class="separator:acc22bf5baaa096fe09b72c812c1134f0"><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>This <a class="el" href="class_bluetooth_service.html">BluetoothService</a> class implements support for Bluetooth <a class="el" href="class_h_i_d.html">HID</a> devices. </p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00029">29</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5ee874513852b83d6a04b991ab892f54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BTHID::BTHID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_b_t_d.html">BTD</a> *&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>pair</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pin</em> = <code>&quot;0000&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="class_b_t_h_i_d.html">BTHID</a> class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>Pointer to the <a class="el" href="class_b_t_d.html">BTD</a> class instance. </td></tr>
<tr><td class="paramname">pair</td><td>Set this to true in order to pair with the device. If the argument is omitted then it will not pair with it. One can use <a class="el" href="_b_t_d_8h.html#a8f0b5b0dedaf5c25c4887f03ebfdd425">PAIR</a> to set it to true. </td></tr>
<tr><td class="paramname">pin</td><td>Write the pin to <a class="el" href="class_b_t_d.html#a215cb939c01ed3ff56db37841224546c">BTD::btdPin</a>. If argument is omitted, then "0000" will be used. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8cpp_source.html#l00023">23</a> of file <a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a84eb1b910027f2d78741f65225c14e54"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::ACLData </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>ACLData</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to pass acldata to the services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ACLData</td><td>Incoming acldata. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="class_bluetooth_service.html#a8dc98310fe481357eaa86c53e49af113">BluetoothService</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8cpp_source.html#l00059">59</a> of file <a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a938eab04e406a29cc9324dad3ccb52cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::Run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to run part of the state machine. </p>
<p>Reimplemented from <a class="el" href="class_bluetooth_service.html#a680692ff13cb37eb81ddbb74bc9e0383">BluetoothService</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8cpp_source.html#l00347">347</a> of file <a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af4c58b81414a037910dd6fb78f97b96e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this to reset the service. </p>
<p>Reimplemented from <a class="el" href="class_bluetooth_service.html#a1dff7caf251f1d8a5f358b368445cb48">BluetoothService</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8cpp_source.html#l00044">44</a> of file <a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae1ee62d7b9951ec7960f122c9fc2d2d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used this to disconnect the devices. </p>
<p>Reimplemented from <a class="el" href="class_bluetooth_service.html#a66ee2f09c6087b82e3920c3d652a99b2">BluetoothService</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8cpp_source.html#l00052">52</a> of file <a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ade1924514bc9c9cd71f54a1f37529575"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a>* BTHID::GetReportParser </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>ID of parser. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the corresponding <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a>. Returns NULL if id is not valid. </dd></dl>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00058">58</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0e903f0b5040f3561e5de6c4431027b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BTHID::SetReportParser </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *&#160;</td>
<td class="paramname"><em>prs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> to be used. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Id of parser. </td></tr>
<tr><td class="paramname">prs</td><td>Pointer to <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> is set. False otherwise. </dd></dl>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00070">70</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="afceaafc89581441da40b141170b98595"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::setProtocolMode </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set <a class="el" href="class_h_i_d.html">HID</a> protocol mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td><a class="el" href="class_h_i_d.html">HID</a> protocol to use. Either HID_BOOT_PROTOCOL or HID_RPT_PROTOCOL. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00081">81</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae222e33ac617620c4cab5c1b23b89310"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BTHID::setLeds </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to set the leds on a keyboard. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>See <a class="el" href="struct_k_b_d_l_e_d_s.html">KBDLEDS</a> in <a class="el" href="hidboot_8h.html">hidboot.h</a> </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8cpp_source.html#l00396">396</a> of file <a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afb19720b65cda69d910416c7a689dd45"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::pair </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this to start the paring sequence with a device </p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00095">95</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac2d67e173774e344bca86fbd0ed5a10c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BTHID::attachOnInit </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>funcOnInit</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to call your own function when the device is successfully initialized. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">funcOnInit</td><td>Function to call. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00104">104</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="af9a13ab2a8c9c10fc74b3ed7dde1ff52"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void BTHID::ParseBTHID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_b_t_h_i_d.html">BTHID</a> *&#160;</td>
<td class="paramname"><em>bthid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to parse Bluetooth <a class="el" href="class_h_i_d.html">HID</a> data to any class that inherits this class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bthid</td><td>Pointer to this class. </td></tr>
<tr><td class="paramname">len</td><td>The length of the incoming data. </td></tr>
<tr><td class="paramname">buf</td><td>Pointer to the data buffer. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="class_p_s4_b_t.html#a9f9e18bee9e7d9cf6538681e0370193f">PS4BT</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00116">116</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6d92c1771d643172094fcd084f418421"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void BTHID::OnInitBTHID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a device is connected </p>
<p>Reimplemented in <a class="el" href="class_p_s4_b_t.html#a91088a6ed093d3cebb82d8f5e208304b">PS4BT</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00120">120</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<a class="anchor" id="acc22bf5baaa096fe09b72c812c1134f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void BTHID::ResetBTHID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to reset any buffers in the class that inherits this </p>
<p>Reimplemented in <a class="el" href="class_p_s4_b_t.html#a4b1c9e15ccdc7ab24f7fb42fc9b5d827">PS4BT</a>.</p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00124">124</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ab3a81823a1d8805383146a6baad6ccc4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BTHID::connected</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if a device is connected </p>
<p>Definition at line <a class="el" href="_b_t_h_i_d_8h_source.html#l00092">92</a> of file <a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_b_t_h_i_d_8h_source.html">BTHID.h</a></li>
<li><a class="el" href="_b_t_h_i_d_8cpp_source.html">BTHID.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink