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

322 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>USB Host Shield 2.0: XBOXONESParser 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 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.11 -->
<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="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_x_b_o_x_o_n_e_s_parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XBOXONESParser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_x_b_o_x_o_n_e_s_parser_8h_source.html">XBOXONESParser.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XBOXONESParser:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_o_n_e_s_parser__inherit__graph.png" border="0" usemap="#_x_b_o_x_o_n_e_s_parser_inherit__map" alt="Inheritance graph"/></div>
<map name="_x_b_o_x_o_n_e_s_parser_inherit__map" id="_x_b_o_x_o_n_e_s_parser_inherit__map">
<area shape="rect" id="node2" href="class_x_b_o_x_o_n_e_s_b_t.html" title="XBOXONESBT" alt="" coords="17,80,125,107"/>
</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:a7b19a947208d70e6ad822e02674956c0"><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_s_parser.html#a7b19a947208d70e6ad822e02674956c0">XBOXONESParser</a> ()</td></tr>
<tr class="separator:a7b19a947208d70e6ad822e02674956c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9d2ab519ae22786e4218c96539925d6"><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_s_parser.html#aa9d2ab519ae22786e4218c96539925d6">getAnalogHat</a> (<a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093">AnalogHatEnum</a> a)</td></tr>
<tr class="separator:aa9d2ab519ae22786e4218c96539925d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Xbox One S Controller functions</div></td></tr>
<tr class="memitem:acede7059d30d10f7276336be8d2dec63"><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_s_parser.html#acede7059d30d10f7276336be8d2dec63">getButtonPress</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:acede7059d30d10f7276336be8d2dec63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec1240938df5c0f3415d3e81eb12b4b7"><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_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">getButtonClick</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:aec1240938df5c0f3415d3e81eb12b4b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab738326926b13d4f40d5bbed34640054"><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_s_parser.html#ab738326926b13d4f40d5bbed34640054">Parse</a> (uint8_t len, uint8_t *buf)</td></tr>
<tr class="separator:ab738326926b13d4f40d5bbed34640054"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71c0a2e5e6e61f3bb57409c991c7bcb"><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_s_parser.html#ac71c0a2e5e6e61f3bb57409c991c7bcb">Reset</a> ()</td></tr>
<tr class="separator:ac71c0a2e5e6e61f3bb57409c991c7bcb"><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 parses all the data sent by the Xbox One S controller </p>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8h_source.html#l00054">54</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8h_source.html">XBOXONESParser.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7b19a947208d70e6ad822e02674956c0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XBOXONESParser::XBOXONESParser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="class_x_b_o_x_o_n_e_s_parser.html">XBOXONESParser</a> class. </p>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8h_source.html#l00057">57</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8h_source.html">XBOXONESParser.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acede7059d30d10f7276336be8d2dec63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t XBOXONESParser::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_s_parser.html#acede7059d30d10f7276336be8d2dec63">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_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">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_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">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_s_parser.html#acede7059d30d10f7276336be8d2dec63">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_s_parser.html#acede7059d30d10f7276336be8d2dec63">getButtonPress(ButtonEnum b)</a> will return a true as long as a button is held down, while <a class="el" href="class_x_b_o_x_o_n_e_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">getButtonClick(ButtonEnum b)</a> will return true once for each button press. </dd></dl>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html#l00072">72</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html">XBOXONESParser.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aec1240938df5c0f3415d3e81eb12b4b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXONESParser::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_s_parser.html#acede7059d30d10f7276336be8d2dec63">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_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">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_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">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_s_parser.html#acede7059d30d10f7276336be8d2dec63">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_s_parser.html#acede7059d30d10f7276336be8d2dec63">getButtonPress(ButtonEnum b)</a> will return a true as long as a button is held down, while <a class="el" href="class_x_b_o_x_o_n_e_s_parser.html#aec1240938df5c0f3415d3e81eb12b4b7">getButtonClick(ButtonEnum b)</a> will return true once for each button press. </dd></dl>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html#l00084">84</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html">XBOXONESParser.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa9d2ab519ae22786e4218c96539925d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t XBOXONESParser::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>Used to read the analog joystick. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td><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>, and <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093a7f1fb2db5381286691f4dec179ed5d5a">RightHatY</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return the analog value as a 16-bit signed integer. </dd></dl>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html#l00108">108</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html">XBOXONESParser.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab738326926b13d4f40d5bbed34640054"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXONESParser::Parse </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to set the rumble off. Used to turn on rumble continuously. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">leftTrigger</td><td>Left trigger force. </td></tr>
<tr><td class="paramname">rightTrigger</td><td>Right trigger force. </td></tr>
<tr><td class="paramname">leftMotor</td><td>Left motor force. </td></tr>
<tr><td class="paramname">rightMotor</td><td>Right motor force. Used to parse data sent from the Xbox One S controller. </td></tr>
<tr><td class="paramname">len</td><td>Length of the data. </td></tr>
<tr><td class="paramname">buf</td><td>Pointer to the data buffer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html#l00112">112</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html">XBOXONESParser.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac71c0a2e5e6e61f3bb57409c991c7bcb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXONESParser::Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to reset the different buffers to their default values </p>
<p>Definition at line <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html#l00171">171</a> of file <a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html">XBOXONESParser.cpp</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_s_parser_8h_source.html">XBOXONESParser.h</a></li>
<li><a class="el" href="_x_b_o_x_o_n_e_s_parser_8cpp_source.html">XBOXONESParser.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.11
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink