mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
765 lines
53 KiB
HTML
765 lines
53 KiB
HTML
<!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.9.1"/>
|
|
<title>USB Host Shield 2.0: PSBuzz 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/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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.9.1 -->
|
|
<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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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)">
|
|
</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> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="class_p_s_buzz-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PSBuzz Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PSBuzz:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_p_s_buzz__inherit__graph.png" border="0" usemap="#_p_s_buzz_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_p_s_buzz_inherit__map" id="_p_s_buzz_inherit__map">
|
|
<area shape="rect" id="node2" href="class_h_i_d_universal.html" title="HIDUniversal" alt="" coords="95,152,195,177"/><area shape="rect" id="node3" href="class_h_i_d.html" title="HID" alt="" coords="123,79,168,104"/><area shape="rect" id="node4" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,133,31"/><area shape="rect" id="node5" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="158,5,288,31"/></map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for PSBuzz:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_p_s_buzz__coll__graph.png" border="0" usemap="#_p_s_buzz_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="_p_s_buzz_coll__map" id="_p_s_buzz_coll__map">
|
|
<area shape="rect" id="node2" href="class_h_i_d_universal.html" title="HIDUniversal" alt="" coords="249,253,349,279"/><area shape="rect" id="node3" href="class_h_i_d.html" title="HID" alt="" coords="201,167,245,192"/><area shape="rect" id="node4" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,80,133,105"/><area shape="rect" id="node5" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="158,80,288,105"/><area shape="rect" id="node6" href="class_u_s_b.html" title="USB" alt="" coords="312,80,360,105"/><area shape="rect" id="node7" href="class_m_a_x3421e.html" title="MAX3421E" alt="" coords="292,5,380,31"/><area shape="rect" id="node8" href="struct_ep_info.html" title="EpInfo" alt="" coords="269,167,329,192"/></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:a0b70e832e6a9cfdc3a906719aa54147c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a0b70e832e6a9cfdc3a906719aa54147c">PSBuzz</a> (<a class="el" href="class_u_s_b.html">USB</a> *p)</td></tr>
|
|
<tr class="separator:a0b70e832e6a9cfdc3a906719aa54147c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c791bf7745baae8359d3dcb1d5b86d3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a7c791bf7745baae8359d3dcb1d5b86d3">connected</a> ()</td></tr>
|
|
<tr class="separator:a7c791bf7745baae8359d3dcb1d5b86d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d4c401b742605d251a840646bd58112"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a0d4c401b742605d251a840646bd58112">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
|
|
<tr class="separator:a0d4c401b742605d251a840646bd58112"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">PS Buzzer Controller functions</div></td></tr>
|
|
<tr class="memitem:a521ac2cada2aded05417033c6ae9c8ea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a521ac2cada2aded05417033c6ae9c8ea">getButtonPress</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b, uint8_t controller=0)</td></tr>
|
|
<tr class="separator:a521ac2cada2aded05417033c6ae9c8ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8c77db1fb29395bda463fb558e7e651"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#ab8c77db1fb29395bda463fb558e7e651">getButtonClick</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b, uint8_t controller=0)</td></tr>
|
|
<tr class="separator:ab8c77db1fb29395bda463fb558e7e651"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef2921259c5df33128d2a19bba87838b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#aef2921259c5df33128d2a19bba87838b">setLedRaw</a> (bool value, uint8_t controller=0)</td></tr>
|
|
<tr class="separator:aef2921259c5df33128d2a19bba87838b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fd9d3e984c024959139deea92769ec4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a3fd9d3e984c024959139deea92769ec4">setLedOffAll</a> ()</td></tr>
|
|
<tr class="separator:a3fd9d3e984c024959139deea92769ec4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ac254a17e3a3dca070df3428ece6ed3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a0ac254a17e3a3dca070df3428ece6ed3">setLedOff</a> (uint8_t controller=0)</td></tr>
|
|
<tr class="separator:a0ac254a17e3a3dca070df3428ece6ed3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa21ebc0620730ae2d96a31f405368d31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#aa21ebc0620730ae2d96a31f405368d31">setLedOnAll</a> ()</td></tr>
|
|
<tr class="separator:aa21ebc0620730ae2d96a31f405368d31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a689d8e384a770a2dd13cd436a514a6dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a689d8e384a770a2dd13cd436a514a6dc">setLedOn</a> (uint8_t controller=0)</td></tr>
|
|
<tr class="separator:a689d8e384a770a2dd13cd436a514a6dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ae0c597286749247d7c24c5143e45c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a8ae0c597286749247d7c24c5143e45c7">setLedToggle</a> (uint8_t controller=0)</td></tr>
|
|
<tr class="separator:a8ae0c597286749247d7c24c5143e45c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_h_i_d_universal"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_h_i_d_universal')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_h_i_d_universal.html">HIDUniversal</a></td></tr>
|
|
<tr class="memitem:abdbac688c7e4b682055cebd82e13a595 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595">HIDUniversal</a> (<a class="el" href="class_u_s_b.html">USB</a> *p)</td></tr>
|
|
<tr class="separator:abdbac688c7e4b682055cebd82e13a595 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbd599879e9c3cdea382e87afd6ab29a inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#afbd599879e9c3cdea382e87afd6ab29a">SetReportParser</a> (uint8_t id, <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *prs)</td></tr>
|
|
<tr class="separator:afbd599879e9c3cdea382e87afd6ab29a inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a384b0e219f763e2d6407636bfd4ccea7 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a384b0e219f763e2d6407636bfd4ccea7">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:a384b0e219f763e2d6407636bfd4ccea7 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af999fc50ef4b5dec0391bda79ec83bda inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#af999fc50ef4b5dec0391bda79ec83bda">Release</a> ()</td></tr>
|
|
<tr class="separator:af999fc50ef4b5dec0391bda79ec83bda inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac27e857a0d9619c8abc31be0b690c83c inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#ac27e857a0d9619c8abc31be0b690c83c">Poll</a> ()</td></tr>
|
|
<tr class="separator:ac27e857a0d9619c8abc31be0b690c83c inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcc6921b7beaf0aac2acbcdddd535626 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#abcc6921b7beaf0aac2acbcdddd535626">GetAddress</a> ()</td></tr>
|
|
<tr class="separator:abcc6921b7beaf0aac2acbcdddd535626 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4be95e8f5164393ea4766f68c5b0ea8 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#aa4be95e8f5164393ea4766f68c5b0ea8">isReady</a> ()</td></tr>
|
|
<tr class="separator:aa4be95e8f5164393ea4766f68c5b0ea8 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9b13f27eca16e0accc14fff9bd318e2 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#ab9b13f27eca16e0accc14fff9bd318e2">EndpointXtract</a> (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep)</td></tr>
|
|
<tr class="separator:ab9b13f27eca16e0accc14fff9bd318e2 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac88d9588f4adb6060627c3afca477fe3 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#ac88d9588f4adb6060627c3afca477fe3">SndRpt</a> (uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:ac88d9588f4adb6060627c3afca477fe3 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_h_i_d')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:acea6b13146dc6fb351a912382ce806fd inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#acea6b13146dc6fb351a912382ce806fd">HID</a> (<a class="el" href="class_u_s_b.html">USB</a> *pusb)</td></tr>
|
|
<tr class="separator:acea6b13146dc6fb351a912382ce806fd inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd4bcb073a263f662dd5433139d6ebf3 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#afd4bcb073a263f662dd5433139d6ebf3">GetUsb</a> ()</td></tr>
|
|
<tr class="separator:afd4bcb073a263f662dd5433139d6ebf3 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a276ec67d360b59c3144d7ea2e2f5149e inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a276ec67d360b59c3144d7ea2e2f5149e">SetProtocol</a> (uint8_t iface, uint8_t protocol)</td></tr>
|
|
<tr class="separator:a276ec67d360b59c3144d7ea2e2f5149e inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70be6b7ad992954b8648d7d06e2d4e2b inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a70be6b7ad992954b8648d7d06e2d4e2b">GetProtocol</a> (uint8_t iface, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a70be6b7ad992954b8648d7d06e2d4e2b inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52f9c963ffe4715829ff1b84a9eac24c inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a52f9c963ffe4715829ff1b84a9eac24c">GetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a52f9c963ffe4715829ff1b84a9eac24c inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b27ed48d16c6ab09a5ea9a97a628149 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a6b27ed48d16c6ab09a5ea9a97a628149">SetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t duration)</td></tr>
|
|
<tr class="separator:a6b27ed48d16c6ab09a5ea9a97a628149 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abecb44a94d722becd9b95788e46d90c3 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#abecb44a94d722becd9b95788e46d90c3">GetReportDescr</a> (uint16_t wIndex, <a class="el" href="class_u_s_b_read_parser.html">USBReadParser</a> *parser=NULL)</td></tr>
|
|
<tr class="separator:abecb44a94d722becd9b95788e46d90c3 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13dccfb3aa8144626ba587969e3ef3b0 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a13dccfb3aa8144626ba587969e3ef3b0">GetHidDescr</a> (uint8_t ep, uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a13dccfb3aa8144626ba587969e3ef3b0 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b59be9ba5dbdc09d2e47cf734c02fdc inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a4b59be9ba5dbdc09d2e47cf734c02fdc">GetReport</a> (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a4b59be9ba5dbdc09d2e47cf734c02fdc inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58ca963ba0f12d2a457cb247595f38e9 inherit pub_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a58ca963ba0f12d2a457cb247595f38e9">SetReport</a> (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a58ca963ba0f12d2a457cb247595f38e9 inherit pub_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_u_s_b_device_config"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_device_config')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
|
|
<tr class="memitem:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e">ConfigureDevice</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a12bb63558ded5bb6661bb173b07ff391">ResetHubPort</a> (uint8_t port)</td></tr>
|
|
<tr class="separator:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a2bb3e09cf128c8ecd04ea0dfce2126e1">DEVCLASSOK</a> (uint8_t klass)</td></tr>
|
|
<tr class="separator:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#ad2d535af92d0b97e4445a6bd51d35c57">DEVSUBCLASSOK</a> (uint8_t subklass)</td></tr>
|
|
<tr class="separator:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </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 class="memitem:a5bb4f2ee80ca9d10d87031b57bd09268"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a5bb4f2ee80ca9d10d87031b57bd09268">Reset</a> ()</td></tr>
|
|
<tr class="separator:a5bb4f2ee80ca9d10d87031b57bd09268"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">HIDUniversal implementation</div></td></tr>
|
|
<tr class="memitem:a69e6f9478a2fb40d4bc606ad0128daf7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#a69e6f9478a2fb40d4bc606ad0128daf7">ParseHIDData</a> (<a class="el" href="class_h_i_d.html">HID</a> *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)</td></tr>
|
|
<tr class="separator:a69e6f9478a2fb40d4bc606ad0128daf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcd889f795e4ffaf8d5981432ddcb01b"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#abcd889f795e4ffaf8d5981432ddcb01b">OnInitSuccessful</a> ()</td></tr>
|
|
<tr class="separator:abcd889f795e4ffaf8d5981432ddcb01b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">USBDeviceConfig implementation</div></td></tr>
|
|
<tr class="memitem:ae94840ce88d873664d1f1d8e46928acb"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_s_buzz.html#ae94840ce88d873664d1f1d8e46928acb">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
|
|
<tr class="separator:ae94840ce88d873664d1f1d8e46928acb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_class_h_i_d_universal"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_h_i_d_universal')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_h_i_d_universal.html">HIDUniversal</a></td></tr>
|
|
<tr class="memitem:aff53de37b98aa1e4a6e45be701ddcc65 inherit pro_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#aff53de37b98aa1e4a6e45be701ddcc65">GetReportParser</a> (uint8_t id)</td></tr>
|
|
<tr class="separator:aff53de37b98aa1e4a6e45be701ddcc65 inherit pro_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_h_i_d')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:a9e2e57ffd2701ebd171842fa9a3f54bd inherit pro_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a9e2e57ffd2701ebd171842fa9a3f54bd">PrintEndpointDescriptor</a> (const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep_ptr)</td></tr>
|
|
<tr class="separator:a9e2e57ffd2701ebd171842fa9a3f54bd inherit pro_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a733e3944b51dced26ef257f047c227dc inherit pro_methods_class_h_i_d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a733e3944b51dced26ef257f047c227dc">PrintHidDescriptor</a> (const <a class="el" href="struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r.html">USB_HID_DESCRIPTOR</a> *pDesc)</td></tr>
|
|
<tr class="separator:a733e3944b51dced26ef257f047c227dc inherit pro_methods_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_class_h_i_d_universal"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_h_i_d_universal')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_h_i_d_universal.html">HIDUniversal</a></td></tr>
|
|
<tr class="memitem:ad26d2e63130abac2059154bf5afbf152 inherit pro_attribs_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ep_info.html">EpInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#ad26d2e63130abac2059154bf5afbf152">epInfo</a> [<a class="el" href="class_h_i_d.html#a884aa67312324e7d23a052a6dc80337e">totalEndpoints</a>]</td></tr>
|
|
<tr class="separator:ad26d2e63130abac2059154bf5afbf152 inherit pro_attribs_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a542ee234ff63c01eb3dff607fb3b0def inherit pro_attribs_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">HIDInterface </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a542ee234ff63c01eb3dff607fb3b0def">hidInterfaces</a> [<a class="el" href="class_h_i_d.html#afe5186f46ac7b580bb3dc289e3f237b2">maxHidInterfaces</a>]</td></tr>
|
|
<tr class="separator:a542ee234ff63c01eb3dff607fb3b0def inherit pro_attribs_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c333e67c1bd0e69db565d6976d063b1 inherit pro_attribs_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a1c333e67c1bd0e69db565d6976d063b1">bHasReportId</a></td></tr>
|
|
<tr class="separator:a1c333e67c1bd0e69db565d6976d063b1 inherit pro_attribs_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc609e49d66fa6260e7cdcd2c4ff0a5a inherit pro_attribs_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#abc609e49d66fa6260e7cdcd2c4ff0a5a">PID</a></td></tr>
|
|
<tr class="separator:abc609e49d66fa6260e7cdcd2c4ff0a5a inherit pro_attribs_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f2123d1f20327600bb9e49a1ef5b0c7 inherit pro_attribs_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a7f2123d1f20327600bb9e49a1ef5b0c7">VID</a></td></tr>
|
|
<tr class="separator:a7f2123d1f20327600bb9e49a1ef5b0c7 inherit pro_attribs_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_h_i_d')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:a1583e665c2b930e8683c10dc271f013f inherit pro_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a1583e665c2b930e8683c10dc271f013f">pUsb</a></td></tr>
|
|
<tr class="separator:a1583e665c2b930e8683c10dc271f013f inherit pro_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a525edb36c2cd8470eae703d3b236e4a7 inherit pro_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a525edb36c2cd8470eae703d3b236e4a7">bAddress</a></td></tr>
|
|
<tr class="separator:a525edb36c2cd8470eae703d3b236e4a7 inherit pro_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_static_attribs_class_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_class_h_i_d')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_h_i_d.html">HID</a></td></tr>
|
|
<tr class="memitem:a845b9961830a6778c296e8571759dd38 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a845b9961830a6778c296e8571759dd38">epInterruptInIndex</a> = 1</td></tr>
|
|
<tr class="separator:a845b9961830a6778c296e8571759dd38 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb7fc07fe6dbc98d518967fdbc441ab3 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#aeb7fc07fe6dbc98d518967fdbc441ab3">epInterruptOutIndex</a> = 2</td></tr>
|
|
<tr class="separator:aeb7fc07fe6dbc98d518967fdbc441ab3 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe5186f46ac7b580bb3dc289e3f237b2 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#afe5186f46ac7b580bb3dc289e3f237b2">maxHidInterfaces</a> = 3</td></tr>
|
|
<tr class="separator:afe5186f46ac7b580bb3dc289e3f237b2 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd92969682030cd5cac310dd7746c7c7 inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#acd92969682030cd5cac310dd7746c7c7">maxEpPerInterface</a> = 2</td></tr>
|
|
<tr class="separator:acd92969682030cd5cac310dd7746c7c7 inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a884aa67312324e7d23a052a6dc80337e inherit pro_static_attribs_class_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d.html#a884aa67312324e7d23a052a6dc80337e">totalEndpoints</a> = (<a class="el" href="class_h_i_d.html#afe5186f46ac7b580bb3dc289e3f237b2">maxHidInterfaces</a> * <a class="el" href="class_h_i_d.html#acd92969682030cd5cac310dd7746c7c7">maxEpPerInterface</a> + 1)</td></tr>
|
|
<tr class="separator:a884aa67312324e7d23a052a6dc80337e inherit pro_static_attribs_class_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This class implements support for the PS Buzz controllers via <a class="el" href="class_u_s_b.html">USB</a>. It uses the <a class="el" href="class_h_i_d_universal.html">HIDUniversal</a> class for all the <a class="el" href="class_u_s_b.html">USB</a> communication. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00043">43</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a0b70e832e6a9cfdc3a906719aa54147c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PSBuzz::PSBuzz </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> * </td>
|
|
<td class="paramname"><em>p</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>Constructor for the <a class="el" href="class_p_s_buzz.html">PSBuzz</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_u_s_b.html">USB</a> class instance. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00049">49</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a7c791bf7745baae8359d3dcb1d5b86d3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PSBuzz::connected </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to check if a PS Buzz controller is connected. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if it is connected. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00058">58</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0d4c401b742605d251a840646bd58112"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::attachOnInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </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="_p_s_buzz_8h_source.html#l00066">66</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a521ac2cada2aded05417033c6ae9c8ea"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PSBuzz::getButtonPress </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> </td>
|
|
<td class="paramname"><em>b</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controller</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>getButtonPress(ButtonEnum b) will return true as long as the button is held down.</p>
|
|
<p>While getButtonClick(ButtonEnum b) will only return it once.</p>
|
|
<p>So you instance if you need to increase a variable once you would use getButtonClick(ButtonEnum b), but if you need to drive a robot forward you would use getButtonPress(ButtonEnum b). </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> to read. </td></tr>
|
|
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>getButtonPress(ButtonEnum b) will return a true as long as a button is held down, while getButtonClick(ButtonEnum b) will return true once for each button press. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8cpp_source.html#l00052">52</a> of file <a class="el" href="_p_s_buzz_8cpp_source.html">PSBuzz.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab8c77db1fb29395bda463fb558e7e651"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PSBuzz::getButtonClick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> </td>
|
|
<td class="paramname"><em>b</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controller</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>getButtonPress(ButtonEnum b) will return true as long as the button is held down.</p>
|
|
<p>While getButtonClick(ButtonEnum b) will only return it once.</p>
|
|
<p>So you instance if you need to increase a variable once you would use getButtonClick(ButtonEnum b), but if you need to drive a robot forward you would use getButtonPress(ButtonEnum b). </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> to read. </td></tr>
|
|
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>getButtonPress(ButtonEnum b) will return a true as long as a button is held down, while getButtonClick(ButtonEnum b) will return true once for each button press. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8cpp_source.html#l00056">56</a> of file <a class="el" href="_p_s_buzz_8cpp_source.html">PSBuzz.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aef2921259c5df33128d2a19bba87838b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::setLedRaw </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controller</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set LED value without using <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a>. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>See: <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a>. Set LED values directly. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Used to set whenever the LED should be on or off </td></tr>
|
|
<tr><td class="paramname">controller</td><td>The controller to control. Defaults to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8cpp_source.html#l00064">64</a> of file <a class="el" href="_p_s_buzz_8cpp_source.html">PSBuzz.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3fd9d3e984c024959139deea92769ec4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::setLedOffAll </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Turn all LEDs off. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00098">98</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0ac254a17e3a3dca070df3428ece6ed3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::setLedOff </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controller</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Turn the LED off on a specific controller. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">controller</td><td>The controller to turn off. Defaults to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00108">108</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa21ebc0620730ae2d96a31f405368d31"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::setLedOnAll </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Turn all LEDs on. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00114">114</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a689d8e384a770a2dd13cd436a514a6dc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::setLedOn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controller</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Turn the LED on on a specific controller. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">controller</td><td>The controller to turn off. Defaults to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00124">124</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8ae0c597286749247d7c24c5143e45c7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::setLedToggle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controller</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Toggle the LED on a specific controller. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">controller</td><td>The controller to turn off. Defaults to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00132">132</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a69e6f9478a2fb40d4bc606ad0128daf7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::ParseHIDData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_h_i_d.html">HID</a> * </td>
|
|
<td class="paramname"><em>hid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>is_rpt_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to parse <a class="el" href="class_u_s_b.html">USB</a> <a class="el" href="class_h_i_d.html">HID</a> data. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hid</td><td>Pointer to the <a class="el" href="class_h_i_d.html">HID</a> class. </td></tr>
|
|
<tr><td class="paramname">is_rpt_id</td><td>Only used for Hubs. </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 from <a class="el" href="class_h_i_d_universal.html#abac95ce57e678236993d85cbbf0c6c32">HIDUniversal</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8cpp_source.html#l00023">23</a> of file <a class="el" href="_p_s_buzz_8cpp_source.html">PSBuzz.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abcd889f795e4ffaf8d5981432ddcb01b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t PSBuzz::OnInitSuccessful </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Called when a device is successfully initialized. Use attachOnInit(void (*funcOnInit)(void)) to call your own function. This is useful for instance if you want to set the LEDs in a specific way. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_h_i_d_universal.html#a60f06d86767b4b2c973d08383c7a0048">HIDUniversal</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8cpp_source.html#l00041">41</a> of file <a class="el" href="_p_s_buzz_8cpp_source.html">PSBuzz.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5bb4f2ee80ca9d10d87031b57bd09268"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PSBuzz::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">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to reset the different buffers to their default values </p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00157">157</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae94840ce88d873664d1f1d8e46928acb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool PSBuzz::VIDPIDOK </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></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 by the <a class="el" href="class_u_s_b.html">USB</a> core to check what this driver support. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vid</td><td>The device's VID. </td></tr>
|
|
<tr><td class="paramname">pid</td><td>The device's PID. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the device's VID and PID matches this driver. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#af920743379d8c133dda4335d11601141">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="_p_s_buzz_8h_source.html#l00172">172</a> of file <a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_p_s_buzz_8h_source.html">PSBuzz.h</a></li>
|
|
<li><a class="el" href="_p_s_buzz_8cpp_source.html">PSBuzz.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|