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_o_n_e.html

611 lines
33 KiB
HTML
Raw Normal View History

Updated documentation
2015-04-07 16:07:33 +02: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"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>USB Host Shield 2.0: XBOXONE Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#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)">
</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_o_n_e-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XBOXONE Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XBOXONE:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_o_n_e__inherit__graph.png" border="0" usemap="#_x_b_o_x_o_n_e_inherit__map" alt="Inheritance graph"/></div>
<map name="_x_b_o_x_o_n_e_inherit__map" id="_x_b_o_x_o_n_e_inherit__map">
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,133,31"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for XBOXONE:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_o_n_e__coll__graph.png" border="0" usemap="#_x_b_o_x_o_n_e_coll__map" alt="Collaboration graph"/></div>
<map name="_x_b_o_x_o_n_e_coll__map" id="_x_b_o_x_o_n_e_coll__map">
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,80,133,105"/><area shape="rect" id="node3" href="class_u_s_b.html" title="USB" alt="" coords="157,80,206,105"/><area shape="rect" id="node4" href="class_m_a_x3421e.html" title="MAX3421E" alt="" coords="137,5,226,31"/><area shape="rect" id="node5" href="struct_ep_info.html" title="EpInfo" alt="" coords="230,80,290,105"/></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:a3b9466f31de5c4f4e46a47440eea2bfc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a3b9466f31de5c4f4e46a47440eea2bfc">XBOXONE</a> (<a class="el" href="class_u_s_b.html">USB</a> *<a class="el" href="class_x_b_o_x_o_n_e.html#a5b4e45cdd8695439d9772f55bb8ece6f">pUsb</a>)</td></tr>
<tr class="separator:a3b9466f31de5c4f4e46a47440eea2bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">USBDeviceConfig implementation</div></td></tr>
<tr class="memitem:aeb2d90a3d77fc252a12f5ed54c3f370e"><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_o_n_e.html#aeb2d90a3d77fc252a12f5ed54c3f370e">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:aeb2d90a3d77fc252a12f5ed54c3f370e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab836f2e18a00ef89054d66fb2023ba64"><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_o_n_e.html#ab836f2e18a00ef89054d66fb2023ba64">Release</a> ()</td></tr>
<tr class="separator:ab836f2e18a00ef89054d66fb2023ba64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac645e477bde4c2c2674ad8916f749651"><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_o_n_e.html#ac645e477bde4c2c2674ad8916f749651">Poll</a> ()</td></tr>
<tr class="separator:ac645e477bde4c2c2674ad8916f749651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05332491fe28b71c6d7c9a9827370bdf"><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_o_n_e.html#a05332491fe28b71c6d7c9a9827370bdf">GetAddress</a> ()</td></tr>
<tr class="separator:a05332491fe28b71c6d7c9a9827370bdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23112f12ed914d1b0128675b1f59aace"><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_o_n_e.html#a23112f12ed914d1b0128675b1f59aace">isReady</a> ()</td></tr>
<tr class="separator:a23112f12ed914d1b0128675b1f59aace"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5d73e3bba66b8668d37479ed926d94c"><td class="memItemLeft" align="right" valign="top">virtual boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ac5d73e3bba66b8668d37479ed926d94c">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
<tr class="separator:ac5d73e3bba66b8668d37479ed926d94c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Xbox Controller functions</div></td></tr>
<tr class="memitem:ae197d34a4c2138d1889afe2c2e3345c4"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:ae197d34a4c2138d1889afe2c2e3345c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd03dd0f2abde83f34635ab72564811"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:a9bd03dd0f2abde83f34635ab72564811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af49b526b57d3a3148537bdada9fb69bc"><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_o_n_e.html#af49b526b57d3a3148537bdada9fb69bc">getAnalogHat</a> (<a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093">AnalogHatEnum</a> a)</td></tr>
<tr class="separator:af49b526b57d3a3148537bdada9fb69bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b2434ed7197361d229340773b0c3bda"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a0b2434ed7197361d229340773b0c3bda">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
<tr class="separator:a0b2434ed7197361d229340773b0c3bda"><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>
<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:ac055f7c7156ef515fe362e751fe1bae3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ac055f7c7156ef515fe362e751fe1bae3">XboxOneConnected</a></td></tr>
<tr class="separator:ac055f7c7156ef515fe362e751fe1bae3"><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:a5b4e45cdd8695439d9772f55bb8ece6f"><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_o_n_e.html#a5b4e45cdd8695439d9772f55bb8ece6f">pUsb</a></td></tr>
<tr class="separator:a5b4e45cdd8695439d9772f55bb8ece6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a800dd3559813c0f1771e8fdd30c4105b"><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_o_n_e.html#a800dd3559813c0f1771e8fdd30c4105b">bAddress</a></td></tr>
<tr class="separator:a800dd3559813c0f1771e8fdd30c4105b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d2fe54c2e3d0471aa4fa2a12bae6931"><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_o_n_e.html#a1d2fe54c2e3d0471aa4fa2a12bae6931">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:a1d2fe54c2e3d0471aa4fa2a12bae6931"><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 ONE controller connected via <a class="el" href="class_u_s_b.html">USB</a>. </p>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00046">46</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3b9466f31de5c4f4e46a47440eea2bfc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XBOXONE::XBOXONE </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_o_n_e.html">XBOXONE</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_o_n_e_8cpp_source.html#l00027">27</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aeb2d90a3d77fc252a12f5ed54c3f370e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::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 Controller. </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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00042">42</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab836f2e18a00ef89054d66fb2023ba64"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00225">225</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac645e477bde4c2c2674ad8916f749651"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00236">236</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a05332491fe28b71c6d7c9a9827370bdf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00078">78</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<a class="anchor" id="a23112f12ed914d1b0128675b1f59aace"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00086">86</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac5d73e3bba66b8668d37479ed926d94c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boolean XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00096">96</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae197d34a4c2138d1889afe2c2e3345c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t XBOXONE::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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return true as long as the button is held down.</p>
<p>While <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a>, but if you need to drive a robot forward you would use <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a>. </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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will return a bool, while <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return a word 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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00315">315</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9bd03dd0f2abde83f34635ab72564811"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXONE::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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return true as long as the button is held down.</p>
<p>While <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a>, but if you need to drive a robot forward you would use <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a>. </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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will return a bool, while <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return a word 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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00323">323</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af49b526b57d3a3148537bdada9fb69bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t XBOXONE::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><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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a signed 16-bit integer. </dd></dl>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00343">343</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0b2434ed7197361d229340773b0c3bda"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00126">126</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac055f7c7156ef515fe362e751fe1bae3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXONE::XboxOneConnected</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if a Xbox ONE controller is connected. </p>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00128">128</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5b4e45cdd8695439d9772f55bb8ece6f"></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>* XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00136">136</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<a class="anchor" id="a800dd3559813c0f1771e8fdd30c4105b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00138">138</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1d2fe54c2e3d0471aa4fa2a12bae6931"></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="struct_ep_info.html">EpInfo</a> XBOXONE::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>Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00140">140</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.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_o_n_e_8h_source.html">XBOXONE.h</a></li>
<li><a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.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.9.1
</small></address>
</body>
</html>
Reference in a new issue Copy permalink