USB_Host_Shield_2.0/class_x_b_o_x_r_e_c_v.html

940 lines
49 KiB
HTML
Raw Normal View History

2013-01-30 22:00:18 +01:00
<!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"/>
2013-06-17 20:33:24 +02:00
<meta name="generator" content="Doxygen 1.8.4"/>
<title>USB Host Shield 2.0: XBOXRECV Class Reference</title>
2013-01-30 22:00:18 +01:00
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
2013-01-30 22:00:18 +01:00
</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
2013-01-30 22:00:18 +01:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2013-06-17 20:33:24 +02:00
<!-- Generated by Doxygen 1.8.4 -->
2013-01-30 22:00:18 +01:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#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" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,91,27"/></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" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,77,91,99"/><area shape="rect" id="node3" href="class_u_s_b.html" title="USB" alt="" coords="115,77,153,99"/><area shape="rect" id="node4" href="class_m_a_x3421e.html" title="MAX3421E" alt="" coords="103,5,165,27"/><area shape="rect" id="node5" href="struct_ep_info.html" title="EpInfo" alt="" coords="179,77,224,99"/></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>
2013-02-05 20:02:12 +01:00
<tr><td colspan="2"><div class="groupHeader">USBDeviceConfig implementation</div></td></tr>
2013-01-30 22:00:18 +01:00
<tr class="memitem:a07de216bf16a83501d74463c00bf1fc8"><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#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">virtual 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">virtual 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>
2013-02-05 20:02:12 +01:00
<tr><td colspan="2"><div class="groupHeader">Xbox Controller functions</div></td></tr>
2013-06-17 20:33:24 +02:00
<tr class="memitem:a14f355acaf2cfad072c0c7c139a3e1b2"><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#a14f355acaf2cfad072c0c7c139a3e1b2">getButtonPress</a> (<a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a> b, uint8_t controller=0)</td></tr>
<tr class="separator:a14f355acaf2cfad072c0c7c139a3e1b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a163310ab5d09b8192bebf57b4db9131f"><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#a163310ab5d09b8192bebf57b4db9131f">getButtonClick</a> (<a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a> b, uint8_t controller=0)</td></tr>
<tr class="separator:a163310ab5d09b8192bebf57b4db9131f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef2c97b6f1d6eba631477f2d6c9f6de5"><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#aef2c97b6f1d6eba631477f2d6c9f6de5">getAnalogHat</a> (<a class="el" href="controller_enums_8h.html#aaaabdefc068fd57ec2bef2b62ea4ba92">AnalogHat</a> a, uint8_t controller=0)</td></tr>
<tr class="separator:aef2c97b6f1d6eba631477f2d6c9f6de5"><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:a4ab056654c97c054aebb683cac95e21b"><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#a4ab056654c97c054aebb683cac95e21b">setLedOn</a> (<a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> l, uint8_t controller=0)</td></tr>
<tr class="separator:a4ab056654c97c054aebb683cac95e21b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad66796b66d332bfa1cb57b4ba76cb0fc"><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#ad66796b66d332bfa1cb57b4ba76cb0fc">setLedBlink</a> (<a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> l, uint8_t controller=0)</td></tr>
<tr class="separator:ad66796b66d332bfa1cb57b4ba76cb0fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb75b732b431a29b6fef0fd7c895f41b"><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#abb75b732b431a29b6fef0fd7c895f41b">setLedMode</a> (<a class="el" href="xbox_enums_8h.html#a57effb96f46e458675a2653d4c543ca2">LEDMode</a> lm, uint8_t controller=0)</td></tr>
<tr class="separator:abb75b732b431a29b6fef0fd7c895f41b"><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="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:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</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">&#160;</td></tr>
2013-01-30 22:00:18 +01:00
</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>
2013-01-30 22:00:18 +01:00
<tr class="separator:af97c8d0efc945fa4ba1d120c8a5a9cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
2013-02-05 20:02:12 +01:00
<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>
2013-02-05 20:02:12 +01:00
<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>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00063">63</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-02-05 20:02:12 +01:00
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
2013-01-30 22:00:18 +01:00
<a class="anchor" id="ac856259af28db351f85302b5eddabf1d"></a>
<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>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>pUsb</em>)</td><td></td>
2013-01-30 22:00:18 +01:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2013-02-05 20:02:12 +01:00
<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>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>
2013-01-30 22:00:18 +01:00
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a07de216bf16a83501d74463c00bf1fc8"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
2013-01-30 22:00:18 +01:00
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Init </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
2013-01-30 22:00:18 +01:00
</div><div class="memdoc">
<p>Initialize the Xbox wireless receiver. </p>
2013-02-05 20:02:12 +01:00
<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>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
2013-02-05 20:02:12 +01:00
<p>Implements <a class="el" href="class_u_s_b_device_config.html#a391dc824a3271671890cebeb829b35ed">USBDeviceConfig</a>.</p>
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00040">40</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="ad0e6b53a818516b7d6af0beaa8cebc7a"></a>
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramname">)</td><td></td>
2013-01-30 22:00:18 +01:00
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
2013-01-30 22:00:18 +01:00
</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>
2013-01-30 22:00:18 +01:00
<p>Implements <a class="el" href="class_u_s_b_device_config.html#a74c06c5fe641b20faeeebd39e33248b3">USBDeviceConfig</a>.</p>
2013-01-30 22:00:18 +01:00
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00254">254</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-02-05 20:02:12 +01:00
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="aafe1688ba3dc9b9ac425ebbbf001a1cc"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
2013-01-30 22:00:18 +01:00
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Poll </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramname">)</td><td></td>
2013-01-30 22:00:18 +01:00
<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>Implements <a class="el" href="class_u_s_b_device_config.html#a4961e92df3e75c38e6953fb08b11f8b6">USBDeviceConfig</a>.</p>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00264">264</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 class="anchor" id="a2d58b0a20eb804d853713ade83d01631"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
2013-01-30 22:00:18 +01:00
<tr>
<td class="memname">virtual uint8_t XBOXRECV::GetAddress </td>
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramname">)</td><td></td>
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
</div><div class="memdoc">
<p>Get the device address. </p>
<dl class="section return"><dt>Returns</dt><dd>The device address. </dd></dl>
2013-02-05 20:02:12 +01:00
<p>Implements <a class="el" href="class_u_s_b_device_config.html#aae3130517514c902bad5f153849b3811">USBDeviceConfig</a>.</p>
2013-04-01 22:52:24 +02:00
<p>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>
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="a570568108edafee8d060aad8fe40db57"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
2013-01-30 22:00:18 +01:00
<table class="memname">
<tr>
<td class="memname">virtual bool XBOXRECV::isReady </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramname">)</td><td></td>
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
</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>
2013-02-05 20:02:12 +01:00
2013-04-01 22:52:24 +02:00
<p>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>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="a14f355acaf2cfad072c0c7c139a3e1b2"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::getButtonPress </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a>&#160;</td>
<td class="paramname"><em>b</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-06-17 20:33:24 +02:00
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2013-06-17 20:33:24 +02:00
<p>getButtonPress(uint8_t controller, Button b) will return true as long as the button is held down.</p>
<p>While getButtonClick(uint8_t controller, Button 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, Button b), but if you need to drive a robot forward you would use getButtonPress(uint8_t controller, Button b). </p>
2013-02-05 20:02:12 +01:00
<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#a03bfec859eac87be20f8952c1eb89de0">Button</a> to read. </td></tr>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<dl class="section return"><dt>Returns</dt><dd>getButtonClick(uint8_t controller, Button b) will return a bool, but getButtonPress(uint8_t controller, Button b) will return a byte if reading <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
2013-02-05 20:02:12 +01:00
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00392">392</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="a163310ab5d09b8192bebf57b4db9131f"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXRECV::getButtonClick </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a>&#160;</td>
<td class="paramname"><em>b</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-06-17 20:33:24 +02:00
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2013-06-17 20:33:24 +02:00
<p>getButtonPress(uint8_t controller, Button b) will return true as long as the button is held down.</p>
<p>While getButtonClick(uint8_t controller, Button 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, Button b), but if you need to drive a robot forward you would use getButtonPress(uint8_t controller, Button b). </p>
2013-02-05 20:02:12 +01:00
<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#a03bfec859eac87be20f8952c1eb89de0">Button</a> to read. </td></tr>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<dl class="section return"><dt>Returns</dt><dd>getButtonClick(uint8_t controller, Button b) will return a bool, but getButtonPress(uint8_t controller, Button b) will return a byte if reading <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
2013-02-05 20:02:12 +01:00
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00400">400</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="aef2c97b6f1d6eba631477f2d6c9f6de5"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t XBOXRECV::getAnalogHat </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramtype"><a class="el" href="controller_enums_8h.html#aaaabdefc068fd57ec2bef2b62ea4ba92">AnalogHat</a>&#160;</td>
<td class="paramname"><em>a</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-06-17 20:33:24 +02:00
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</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>
2013-02-05 20:02:12 +01:00
<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#aaaabdefc068fd57ec2bef2b62ea4ba92a383cb8895dd296b7f69ce845ed16b0ca">LeftHatX</a>, <a class="el" href="controller_enums_8h.html#aaaabdefc068fd57ec2bef2b62ea4ba92af3f3925efa9762c4e9e71ac7da7a94a3">LeftHatY</a>, <a class="el" href="controller_enums_8h.html#aaaabdefc068fd57ec2bef2b62ea4ba92aaeb027a0ae5bbc6ba25e1c78a6486c7b">RightHatX</a> or <a class="el" href="controller_enums_8h.html#aaaabdefc068fd57ec2bef2b62ea4ba92a7f1fb2db5381286691f4dec179ed5d5a">RightHatY</a>. </td></tr>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a signed 16-bit integer. </dd></dl>
2013-01-30 22:00:18 +01:00
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00420">420</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-02-05 20:02:12 +01:00
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="ad045d22c1e2f0657f72786539f418751"></a>
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>)</td><td></td>
2013-01-30 22:00:18 +01:00
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
2013-01-30 22:00:18 +01:00
</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">
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
</table>
</dd>
</dl>
2013-01-30 22:00:18 +01:00
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00138">138</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-02-05 20:02:12 +01:00
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="a2931e13960cde2c20adbcaf34cee84c5"></a>
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>)</td><td></td>
2013-01-30 22:00:18 +01:00
<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>
2013-02-05 20:02:12 +01:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00147">147</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="addf7c0dcfbdb025f2283dcd118b5ab76"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setRumbleOn </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>lValue</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>rValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn rumble on. </p>
2013-02-05 20:02:12 +01:00
<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>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00521">521</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="a7986a3cf050bd91c7fed44a7e7eac125"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedRaw </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>value</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</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#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> or <a class="el" href="xbox_enums_8h.html#a57effb96f46e458675a2653d4c543ca2">LEDMode</a> enum. </p>
2013-02-05 20:02:12 +01:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
2013-06-17 20:33:24 +02:00
<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>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00473">473</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="a741fda8096331cf86cf8534b04373b4a"></a>
2013-01-30 22:00:18 +01:00
<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>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>)</td><td></td>
2013-01-30 22:00:18 +01:00
<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">
2013-02-05 20:02:12 +01:00
<p>Turn all LEDs off the specific controller. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00170">170</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="a4ab056654c97c054aebb683cac95e21b"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedOn </td>
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramtype"><a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a>&#160;</td>
<td class="paramname"><em>l</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-06-17 20:33:24 +02:00
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2013-02-05 20:02:12 +01:00
<p>Turn on a LED by using the <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> enum. </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#aadcb6002d2b42fdfe01490f730ab00a6adac6477842247cab1a8c02c65f431b44">LED1</a>, <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6a8379bbaa96d151e6adac488b2a147b7a">LED2</a>, <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6a5dec293e081e0fc78369c842fab8452b">LED3</a> and <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6ad60e39b8d1701d30aa64f80343217342">LED4</a> is supported by the Xbox controller. </td></tr>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00482">482</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="ad66796b66d332bfa1cb57b4ba76cb0fc"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedBlink </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramtype"><a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a>&#160;</td>
<td class="paramname"><em>l</em>, </td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-06-17 20:33:24 +02:00
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>controller</em> = <code>0</code>&#160;</td>
2013-01-30 22:00:18 +01:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn on a LED by using the <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> enum. </p>
2013-02-05 20:02:12 +01:00
<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#aadcb6002d2b42fdfe01490f730ab00a6ab1d5eac4b1dca480c8056eaea7663b7a">ALL</a>, <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6adac6477842247cab1a8c02c65f431b44">LED1</a>, <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6a8379bbaa96d151e6adac488b2a147b7a">LED2</a>, <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6a5dec293e081e0fc78369c842fab8452b">LED3</a> and <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6ad60e39b8d1701d30aa64f80343217342">LED4</a> is supported by the Xbox controller. </td></tr>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00487">487</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="abb75b732b431a29b6fef0fd7c895f41b"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXRECV::setLedMode </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
2013-06-17 20:33:24 +02:00
<td class="paramtype"><a class="el" href="xbox_enums_8h.html#a57effb96f46e458675a2653d4c543ca2">LEDMode</a>&#160;</td>
<td class="paramname"><em>lm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
2013-01-30 22:00:18 +01:00
<td></td>
2013-06-17 20:33:24 +02:00
<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>
2013-01-30 22:00:18 +01:00
</tr>
</table>
</div><div class="memdoc">
<p>Used to set special LED modes supported by the Xbox controller. </p>
2013-02-05 20:02:12 +01:00
<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#a57effb96f46e458675a2653d4c543ca2">LEDMode</a>. </td></tr>
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to write to. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00491">491</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="aaa7a0d0861b8303a4b1654684d185b4f"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::getBatteryLevel </td>
2013-01-30 22:00:18 +01:00
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>)</td><td></td>
2013-01-30 22:00:18 +01:00
<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">
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
</table>
</dd>
</dl>
2013-04-01 22:52:24 +02:00
<dl class="section return"><dt>Returns</dt><dd>Returns the battery level as an integer in the range of 0-3. </dd></dl>
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00449">449</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
</div>
</div>
2013-06-17 20:33:24 +02:00
<a class="anchor" id="ae78ddfff307d26b0ed35dfb75173adf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
2013-01-30 22:00:18 +01:00
<tr>
<td class="memname">bool XBOXRECV::buttonChanged </td>
<td>(</td>
2013-01-30 22:00:18 +01:00
<td class="paramtype">uint8_t&#160;</td>
2013-06-17 20:33:24 +02:00
<td class="paramname"><em>controller</em> = <code>0</code>)</td><td></td>
2013-01-30 22:00:18 +01:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to check if a button has changed. </p>
2013-02-05 20:02:12 +01:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
2013-06-17 20:33:24 +02:00
<tr><td class="paramname">controller</td><td>The controller to read from. Default to 0. </td></tr>
2013-02-05 20:02:12 +01:00
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if a button has changed. </dd></dl>
2013-02-05 20:02:12 +01:00
2013-06-17 20:33:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html#l00424">424</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8cpp_source.html">XBOXRECV.cpp</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a5ff16bba78f05af3023f395a342b625c"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXRECV::XboxReceiverConnected</td>
2013-01-30 22:00:18 +01:00
</tr>
</table>
</div><div class="memdoc">
<p>True if a wireless receiver is connected. </p>
2013-02-05 20:02:12 +01:00
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00206">206</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="ac07faada38e159f1e7831d90863ebe3a"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::Xbox360Connected[4]</td>
2013-01-30 22:00:18 +01:00
</tr>
</table>
</div><div class="memdoc">
<p>Variable used to indicate if the XBOX 360 controller is successfully connected. </p>
2013-02-05 20:02:12 +01:00
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00208">208</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="a53047c86c8c2f625916af62238d50fc8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_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">
2013-02-05 20:02:12 +01:00
<p>Pointer to <a class="el" href="class_u_s_b.html">USB</a> class instance. </p>
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00212">212</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="a1d4bdb1b740c87fd51aca3969e67c730"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
2013-01-30 22:00:18 +01:00
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXRECV::bAddress</td>
2013-01-30 22:00:18 +01:00
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
2013-01-30 22:00:18 +01:00
</div><div class="memdoc">
<p>Device address. </p>
2013-02-05 20:02:12 +01:00
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00214">214</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</div>
</div>
<a class="anchor" id="af97c8d0efc945fa4ba1d120c8a5a9cbb"></a>
2013-01-30 22:00:18 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
2013-01-30 22:00:18 +01:00
<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>
2013-01-30 22:00:18 +01:00
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
2013-01-30 22:00:18 +01:00
</div><div class="memdoc">
<p>Endpoint info structure. </p>
2013-02-05 20:02:12 +01:00
2013-04-01 22:52:24 +02:00
<p>Definition at line <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html#l00216">216</a> of file <a class="el" href="_x_b_o_x_r_e_c_v_8h_source.html">XBOXRECV.h</a>.</p>
2013-01-30 22:00:18 +01:00
</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>
2013-01-30 22:00:18 +01:00
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
2013-01-30 22:00:18 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
2013-06-17 20:33:24 +02:00
</a> 1.8.4
2013-01-30 22:00:18 +01:00
</small></address>
</body>
</html>