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_x_b_o_x_r_e_c_v.html
Lauszus d4710bb19d deploy: b435996557
2021-03-23 11:43:48 +00:00

1130 lines
58 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: XBOXRECV 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>
<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 id="projectalign" 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.17 -->
<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');
/* @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>
<!-- 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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_x_b_o_x_r_e_c_v-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XBOXRECV Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XBOXRECV:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_r_e_c_v__inherit__graph.png" border="0" usemap="#_x_b_o_x_r_e_c_v_inherit__map" alt="Inheritance graph"/></div>
<map name="_x_b_o_x_r_e_c_v_inherit__map" id="_x_b_o_x_r_e_c_v_inherit__map">
<area shape="rect" title=" " alt="" coords="25,80,120,107"/>
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="5,5,140,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for XBOXRECV:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_r_e_c_v__coll__graph.png" border="0" usemap="#_x_b_o_x_r_e_c_v_coll__map" alt="Collaboration graph"/></div>
<map name="_x_b_o_x_r_e_c_v_coll__map" id="_x_b_o_x_r_e_c_v_coll__map">
<area shape="rect" title=" " alt="" coords="141,171,236,197"/>
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="5,81,140,108"/>
<area shape="rect" href="class_u_s_b.html" title=" " alt="" coords="164,81,213,108"/>
<area shape="rect" href="class_m_a_x3421e.html" title=" " alt="" coords="143,5,235,32"/>
<area shape="rect" href="struct_ep_info.html" title=" " alt="" coords="237,81,300,108"/>
</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:ac856259af28db351f85302b5eddabf1d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#ac856259af28db351f85302b5eddabf1d">XBOXRECV</a> (<a class="el" href="class_u_s_b.html">USB</a> *<a class="el" href="class_x_b_o_x_r_e_c_v.html#a53047c86c8c2f625916af62238d50fc8">pUsb</a>)</td></tr>
<tr class="separator:ac856259af28db351f85302b5eddabf1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">USBDeviceConfig implementation</div></td></tr>
<tr class="memitem:a3dd42b9a1351f172fc6e39df2fe99398"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a3dd42b9a1351f172fc6e39df2fe99398">ConfigureDevice</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:a3dd42b9a1351f172fc6e39df2fe99398"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07de216bf16a83501d74463c00bf1fc8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a07de216bf16a83501d74463c00bf1fc8">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:a07de216bf16a83501d74463c00bf1fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0e6b53a818516b7d6af0beaa8cebc7a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#ad0e6b53a818516b7d6af0beaa8cebc7a">Release</a> ()</td></tr>
<tr class="separator:ad0e6b53a818516b7d6af0beaa8cebc7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafe1688ba3dc9b9ac425ebbbf001a1cc"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#aafe1688ba3dc9b9ac425ebbbf001a1cc">Poll</a> ()</td></tr>
<tr class="separator:aafe1688ba3dc9b9ac425ebbbf001a1cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d58b0a20eb804d853713ade83d01631"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a2d58b0a20eb804d853713ade83d01631">GetAddress</a> ()</td></tr>
<tr class="separator:a2d58b0a20eb804d853713ade83d01631"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a570568108edafee8d060aad8fe40db57"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a570568108edafee8d060aad8fe40db57">isReady</a> ()</td></tr>
<tr class="separator:a570568108edafee8d060aad8fe40db57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a119cff07be751ce16d7854fab6dc898c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a119cff07be751ce16d7854fab6dc898c">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
<tr class="separator:a119cff07be751ce16d7854fab6dc898c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Xbox Controller functions</div></td></tr>
<tr class="memitem:a7c3aadc230ee4f8622a4d27dd716254d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a7c3aadc230ee4f8622a4d27dd716254d">getButtonPress</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b, uint8_t controller=0)</td></tr>
<tr class="separator:a7c3aadc230ee4f8622a4d27dd716254d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af27740a22386f55ba48ae1a67587eb19"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#af27740a22386f55ba48ae1a67587eb19">getButtonClick</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b, uint8_t controller=0)</td></tr>
<tr class="separator:af27740a22386f55ba48ae1a67587eb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a286c2fa2aa7f6e80108868bbb66c177b"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a286c2fa2aa7f6e80108868bbb66c177b">getAnalogHat</a> (<a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093">AnalogHatEnum</a> a, uint8_t controller=0)</td></tr>
<tr class="separator:a286c2fa2aa7f6e80108868bbb66c177b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb95505bebd1a9a3aee37097e39187f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#acb95505bebd1a9a3aee37097e39187f4">disconnect</a> (uint8_t controller=0)</td></tr>
<tr class="separator:acb95505bebd1a9a3aee37097e39187f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad045d22c1e2f0657f72786539f418751"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#ad045d22c1e2f0657f72786539f418751">setAllOff</a> (uint8_t controller=0)</td></tr>
<tr class="separator:ad045d22c1e2f0657f72786539f418751"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2931e13960cde2c20adbcaf34cee84c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a2931e13960cde2c20adbcaf34cee84c5">setRumbleOff</a> (uint8_t controller=0)</td></tr>
<tr class="separator:a2931e13960cde2c20adbcaf34cee84c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addf7c0dcfbdb025f2283dcd118b5ab76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#addf7c0dcfbdb025f2283dcd118b5ab76">setRumbleOn</a> (uint8_t lValue, uint8_t rValue, uint8_t controller=0)</td></tr>
<tr class="separator:addf7c0dcfbdb025f2283dcd118b5ab76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7986a3cf050bd91c7fed44a7e7eac125"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a7986a3cf050bd91c7fed44a7e7eac125">setLedRaw</a> (uint8_t value, uint8_t controller=0)</td></tr>
<tr class="separator:a7986a3cf050bd91c7fed44a7e7eac125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a741fda8096331cf86cf8534b04373b4a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a741fda8096331cf86cf8534b04373b4a">setLedOff</a> (uint8_t controller=0)</td></tr>
<tr class="separator:a741fda8096331cf86cf8534b04373b4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a816d81caa0bdbf8523acb69e7693a142"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a816d81caa0bdbf8523acb69e7693a142">setLedOn</a> (<a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a> l, uint8_t controller=0)</td></tr>
<tr class="separator:a816d81caa0bdbf8523acb69e7693a142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bff2ed2e08cfbd657b5731ae1abec68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a0bff2ed2e08cfbd657b5731ae1abec68">setLedBlink</a> (<a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a> l, uint8_t controller=0)</td></tr>
<tr class="separator:a0bff2ed2e08cfbd657b5731ae1abec68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f4bf40c7ab250c75b7d719c6464fca1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a4f4bf40c7ab250c75b7d719c6464fca1">setLedMode</a> (<a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a> lm, uint8_t controller=0)</td></tr>
<tr class="separator:a4f4bf40c7ab250c75b7d719c6464fca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa7a0d0861b8303a4b1654684d185b4f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#aaa7a0d0861b8303a4b1654684d185b4f">getBatteryLevel</a> (uint8_t controller=0)</td></tr>
<tr class="separator:aaa7a0d0861b8303a4b1654684d185b4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae78ddfff307d26b0ed35dfb75173adf7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#ae78ddfff307d26b0ed35dfb75173adf7">buttonChanged</a> (uint8_t controller=0)</td></tr>
<tr class="separator:ae78ddfff307d26b0ed35dfb75173adf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ababaa2f28de8bf6749fe649b4e93c583"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#ababaa2f28de8bf6749fe649b4e93c583">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
<tr class="separator:ababaa2f28de8bf6749fe649b4e93c583"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</td></tr>
<tr class="memitem:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</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">&#160;</td></tr>
<tr class="memitem:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</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">&#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:a5ff16bba78f05af3023f395a342b625c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a5ff16bba78f05af3023f395a342b625c">XboxReceiverConnected</a></td></tr>
<tr class="separator:a5ff16bba78f05af3023f395a342b625c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac07faada38e159f1e7831d90863ebe3a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#ac07faada38e159f1e7831d90863ebe3a">Xbox360Connected</a> [4]</td></tr>
<tr class="separator:ac07faada38e159f1e7831d90863ebe3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a53047c86c8c2f625916af62238d50fc8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a53047c86c8c2f625916af62238d50fc8">pUsb</a></td></tr>
<tr class="separator:a53047c86c8c2f625916af62238d50fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d4bdb1b740c87fd51aca3969e67c730"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#a1d4bdb1b740c87fd51aca3969e67c730">bAddress</a></td></tr>
<tr class="separator:a1d4bdb1b740c87fd51aca3969e67c730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af97c8d0efc945fa4ba1d120c8a5a9cbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ep_info.html">EpInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_r_e_c_v.html#af97c8d0efc945fa4ba1d120c8a5a9cbb">epInfo</a> [<a class="el" href="_x_b_o_x_u_s_b_8h.html#af35f872fc33e690571eb99de648e8e96">XBOX_MAX_ENDPOINTS</a>]</td></tr>
<tr class="separator:af97c8d0efc945fa4ba1d120c8a5a9cbb"><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 class implements support for a Xbox Wireless receiver.</p>
<p>Up to four controllers can connect to one receiver, if more is needed one can use a second receiver via the <a class="el" href="class_u_s_b_hub.html">USBHub</a> class. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00055">55</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac856259af28db351f85302b5eddabf1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac856259af28db351f85302b5eddabf1d">&#9670;&nbsp;</a></span>XBOXRECV()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XBOXRECV::XBOXRECV </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td>
<td class="paramname"><em>pUsb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="class_x_b_o_x_r_e_c_v.html">XBOXRECV</a> class. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pUsb</td><td>Pointer to <a class="el" href="class_u_s_b.html">USB</a> class instance. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00025">25</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3dd42b9a1351f172fc6e39df2fe99398"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dd42b9a1351f172fc6e39df2fe99398">&#9670;&nbsp;</a></span>ConfigureDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::ConfigureDevice </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>lowspeed</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Address assignment and basic initilization is done here. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>Hub number. </td></tr>
<tr><td class="paramname">port</td><td>Port number on the hub. </td></tr>
<tr><td class="paramname">lowspeed</td><td>Speed of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00041">41</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a07de216bf16a83501d74463c00bf1fc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07de216bf16a83501d74463c00bf1fc8">&#9670;&nbsp;</a></span>Init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Init </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>lowspeed</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the Xbox wireless receiver. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>Hub number. </td></tr>
<tr><td class="paramname">port</td><td>Port number on the hub. </td></tr>
<tr><td class="paramname">lowspeed</td><td>Speed of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a3706cf6b18785aff823171e280bab738">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00138">138</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="ad0e6b53a818516b7d6af0beaa8cebc7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0e6b53a818516b7d6af0beaa8cebc7a">&#9670;&nbsp;</a></span>Release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Release </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>Release the <a class="el" href="class_u_s_b.html">USB</a> device. </p><dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a61e301efedae55c6ac12c6cce154e432">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00283">283</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="aafe1688ba3dc9b9ac425ebbbf001a1cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafe1688ba3dc9b9ac425ebbbf001a1cc">&#9670;&nbsp;</a></span>Poll()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Poll </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>Poll the <a class="el" href="class_u_s_b.html">USB</a> Input endpoins and run the state machines. </p><dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a893ea73deab98be837c257201e7da25a">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00293">293</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a2d58b0a20eb804d853713ade83d01631"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d58b0a20eb804d853713ade83d01631">&#9670;&nbsp;</a></span>GetAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t XBOXRECV::GetAddress </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the device address. </p><dl class="section return"><dt>Returns</dt><dd>The device address. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a2bfde6c290d32888a6f4e97fa1e222f1">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00095">95</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a570568108edafee8d060aad8fe40db57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a570568108edafee8d060aad8fe40db57">&#9670;&nbsp;</a></span>isReady()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool XBOXRECV::isReady </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to check if the controller has been initialized. </p><dl class="section return"><dt>Returns</dt><dd>True if it's ready. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00103">103</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a119cff07be751ce16d7854fab6dc898c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a119cff07be751ce16d7854fab6dc898c">&#9670;&nbsp;</a></span>VIDPIDOK()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool XBOXRECV::VIDPIDOK </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>&#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">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 class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00113">113</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a7c3aadc230ee4f8622a4d27dd716254d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c3aadc230ee4f8622a4d27dd716254d">&#9670;&nbsp;</a></span>getButtonPress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::getButtonPress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a>&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>getButtonPress(uint8_t controller, ButtonEnum b) will return true as long as the button is held down.</p>
<p>While getButtonClick(uint8_t controller, ButtonEnum b) will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use getButtonClick(uint8_t controller, ButtonEnum b), but if you need to drive a robot forward you would use getButtonPress(uint8_t controller, 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>getButtonClick(uint8_t controller, ButtonEnum b) will return a bool, while getButtonPress(uint8_t controller, ButtonEnum b) will return a byte if reading <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00410">410</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="af27740a22386f55ba48ae1a67587eb19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af27740a22386f55ba48ae1a67587eb19">&#9670;&nbsp;</a></span>getButtonClick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXRECV::getButtonClick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a>&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>getButtonPress(uint8_t controller, ButtonEnum b) will return true as long as the button is held down.</p>
<p>While getButtonClick(uint8_t controller, ButtonEnum b) will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use getButtonClick(uint8_t controller, ButtonEnum b), but if you need to drive a robot forward you would use getButtonPress(uint8_t controller, 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>getButtonClick(uint8_t controller, ButtonEnum b) will return a bool, while getButtonPress(uint8_t controller, ButtonEnum b) will return a byte if reading <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00418">418</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a286c2fa2aa7f6e80108868bbb66c177b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a286c2fa2aa7f6e80108868bbb66c177b">&#9670;&nbsp;</a></span>getAnalogHat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t XBOXRECV::getAnalogHat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093">AnalogHatEnum</a>&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the analog value from the joysticks on the controller. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>Either <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093a383cb8895dd296b7f69ce845ed16b0ca">LeftHatX</a>, <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093af3f3925efa9762c4e9e71ac7da7a94a3">LeftHatY</a>, <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093aaeb027a0ae5bbc6ba25e1c78a6486c7b">RightHatX</a> or <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093a7f1fb2db5381286691f4dec179ed5d5a">RightHatY</a>. </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>Returns a signed 16-bit integer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00438">438</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="acb95505bebd1a9a3aee37097e39187f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb95505bebd1a9a3aee37097e39187f4">&#9670;&nbsp;</a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::disconnect </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to disconnect any of the controllers. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">controller</td><td>The controller to disconnect. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00498">498</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="ad045d22c1e2f0657f72786539f418751"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad045d22c1e2f0657f72786539f418751">&#9670;&nbsp;</a></span>setAllOff()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setAllOff </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</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 rumble off and all the LEDs on the specific controller. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00153">153</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a2931e13960cde2c20adbcaf34cee84c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2931e13960cde2c20adbcaf34cee84c5">&#9670;&nbsp;</a></span>setRumbleOff()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setRumbleOff </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</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 rumble off the specific controller. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00162">162</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="addf7c0dcfbdb025f2283dcd118b5ab76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addf7c0dcfbdb025f2283dcd118b5ab76">&#9670;&nbsp;</a></span>setRumbleOn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setRumbleOn </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>lValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn rumble on. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lValue</td><td>Left motor (big weight) inside the controller. </td></tr>
<tr><td class="paramname">rValue</td><td>Right motor (small weight) inside the controller. </td></tr>
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00557">557</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a7986a3cf050bd91c7fed44a7e7eac125"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7986a3cf050bd91c7fed44a7e7eac125">&#9670;&nbsp;</a></span>setLedRaw()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedRaw </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set LED value. Without using the <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a> or <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>See: <a class="el" href="class_x_b_o_x_r_e_c_v.html#a741fda8096331cf86cf8534b04373b4a">setLedOff(uint8_t controller)</a>, setLedOn(uint8_t controller, LED l), setLedBlink(uint8_t controller, LED l), and setLedMode(uint8_t controller, LEDMode lm). </td></tr>
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00507">507</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a741fda8096331cf86cf8534b04373b4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a741fda8096331cf86cf8534b04373b4a">&#9670;&nbsp;</a></span>setLedOff()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedOff </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</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 all LEDs off the specific controller. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00185">185</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a816d81caa0bdbf8523acb69e7693a142"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a816d81caa0bdbf8523acb69e7693a142">&#9670;&nbsp;</a></span>setLedOn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedOn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a>&#160;</td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn on a LED by 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">l</td><td><a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0aac132f2982b98bcaa3445e535a03ff75">OFF</a>, <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0adac6477842247cab1a8c02c65f431b44">LED1</a>, <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0a8379bbaa96d151e6adac488b2a147b7a">LED2</a>, <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0a5dec293e081e0fc78369c842fab8452b">LED3</a> and <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0ad60e39b8d1701d30aa64f80343217342">LED4</a> is supported by the Xbox controller. </td></tr>
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00516">516</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a0bff2ed2e08cfbd657b5731ae1abec68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bff2ed2e08cfbd657b5731ae1abec68">&#9670;&nbsp;</a></span>setLedBlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedBlink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0">LEDEnum</a>&#160;</td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn on a LED by 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">l</td><td><a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0ab1d5eac4b1dca480c8056eaea7663b7a">ALL</a>, <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0adac6477842247cab1a8c02c65f431b44">LED1</a>, <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0a8379bbaa96d151e6adac488b2a147b7a">LED2</a>, <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0a5dec293e081e0fc78369c842fab8452b">LED3</a> and <a class="el" href="controller_enums_8h.html#a70df64e026046bc352983127b7ae2cf0ad60e39b8d1701d30aa64f80343217342">LED4</a> is supported by the Xbox controller. </td></tr>
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00523">523</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="a4f4bf40c7ab250c75b7d719c6464fca1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f4bf40c7ab250c75b7d719c6464fca1">&#9670;&nbsp;</a></span>setLedMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a>&#160;</td>
<td class="paramname"><em>lm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to set special LED modes supported by the Xbox controller. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lm</td><td>See <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a>. </td></tr>
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00527">527</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="aaa7a0d0861b8303a4b1654684d185b4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa7a0d0861b8303a4b1654684d185b4f">&#9670;&nbsp;</a></span>getBatteryLevel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::getBatteryLevel </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to get the battery level from the controller. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>Returns the battery level as an integer in the range of 0-3. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00467">467</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="ae78ddfff307d26b0ed35dfb75173adf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae78ddfff307d26b0ed35dfb75173adf7">&#9670;&nbsp;</a></span>buttonChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXRECV::buttonChanged </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to check if a button has changed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>True if a button has changed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00442">442</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
<a id="ababaa2f28de8bf6749fe649b4e93c583"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ababaa2f28de8bf6749fe649b4e93c583">&#9670;&nbsp;</a></span>attachOnInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::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 controller 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 class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00223">223</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5ff16bba78f05af3023f395a342b625c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ff16bba78f05af3023f395a342b625c">&#9670;&nbsp;</a></span>XboxReceiverConnected</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXRECV::XboxReceiverConnected</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if a wireless receiver is connected. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00225">225</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="ac07faada38e159f1e7831d90863ebe3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac07faada38e159f1e7831d90863ebe3a">&#9670;&nbsp;</a></span>Xbox360Connected</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Xbox360Connected[4]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Variable used to indicate if the XBOX 360 controller is successfully connected. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00231">231</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a53047c86c8c2f625916af62238d50fc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53047c86c8c2f625916af62238d50fc8">&#9670;&nbsp;</a></span>pUsb</h2>
<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_u_s_b.html">USB</a>* XBOXRECV::pUsb</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="class_u_s_b.html">USB</a> class instance. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00235">235</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="a1d4bdb1b740c87fd51aca3969e67c730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d4bdb1b740c87fd51aca3969e67c730">&#9670;&nbsp;</a></span>bAddress</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::bAddress</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Device address. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00237">237</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<a id="af97c8d0efc945fa4ba1d120c8a5a9cbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af97c8d0efc945fa4ba1d120c8a5a9cbb">&#9670;&nbsp;</a></span>epInfo</h2>
<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="struct_ep_info.html">EpInfo</a> XBOXRECV::epInfo[<a class="el" href="_x_b_o_x_u_s_b_8h.html#af35f872fc33e690571eb99de648e8e96">XBOX_MAX_ENDPOINTS</a>]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Endpoint info structure. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00239">239</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a></li>
<li><a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.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.17
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink